Hal

Description

Modules
	Deep Sleep Manager (HAL Types and Public API)
	Deep sleep is a power saving mode which turns off STB subsystems such as A/V, HDMI, front panels, HDD etc. Provides API defines the structures and functions for the IARM-Bus Deep Sleep Manager interface.
	Device Settings HAL Audio Public API
	Device Settings HAL Audio Types
	Device Settings HAL COMPOSITE Input Public APIs
	Device Settings HAL Display Public API
	Device Settings HAL Display Type Definitions
	Device Settings HAL Error Codes
	Device Settings HAL Front Panel Display (FPD) Public API
	Device Settings HAL Front Panel Display (FPD) Type Definitions
	Device Settings HAL HDMI IN Type Definitions
	Device Settings HAL HDMI Input Public APIs
	Device Settings HAL Host Public API
	Device Settings HAL Utilities
	Device Settings HAL Video Device Public API
	Device Settings HAL Video Port Public API
	Device Settings HAL VideoDevice Type Definitions
	Device Settings HAL VideoPort Type Definitions
	IR Manager (HAL Types and Public API)
	Described here in are the IARM-Bus HAL types and functions that are part of the IR Manager application. The IR Manager application manages user input on the IR interface.
	Power Manager (HAL Types and Public API)
	Described herein are the IARM-Bus HAL types and functions that are part of the Power Manager application. This manager monitors Power IR key events and reacts to power state changes based on RDK Power Management Specification. It dispatches Power Mode Change events to IARM-Bus. All listeners should releases resources when entering POWER OFF/STANDBY state and re-acquire them when entering POWER ON state.

Data Structures
struct	_dsAudioTypeConfig_t
	Structure that defines audio output device configuration. More...
struct	_dsVideoPortResolution_t
	Structure that defines video port resolution settings of output video device. More...
struct	_dsAudioPortId_t
	Structure that defines the audio port type and associated ID. More...
struct	_dsVideoPortPortId_t
	Structure that defines port id associated with video port. More...
struct	_dsVideoPortTypeConfig_t
	Structure that defines the video output port configuration. More...
struct	_dsAudioPortConfig_t
	Structure that defines audio port configuration. More...
struct	_dsVideoPortPortConfig_t
	Structure that defines video port configuration settings. More...

Macros
#define	INFO_LEVEL   0
#define	WARN_LEVEL   1
#define	ERROR_LEVEL   2
#define	DEBUG_LEVEL   3
#define	INT_INFO(FORMAT, ...)   ds_hal_log(INFO_LEVEL ,FORMAT, ##__VA_ARGS__ )
#define	INT_WARN(FORMAT, ...)   ds_hal_log(WARN_LEVEL ,FORMAT, ##__VA_ARGS__ )
#define	INT_ERROR(FORMAT, ...)   ds_hal_log(ERROR_LEVEL ,FORMAT, ##__VA_ARGS__ )
#define	INT_DEBUG(FORMAT, ...)   ds_hal_log(DEBUG_LEVEL ,FORMAT, ##__VA_ARGS__ )
#define	EDID_DATA_SIZE   256
#define	EDID_MAX_DATA_SIZE   512
#define	dsHdcpStatus_isValid(t)   (((t) >= dsHDCP_STATUS_UNPOWERED ) && ((t) < dsHDCP_STATUS_MAX))
#define	HDCP_KEY_MAX_SIZE   (4*1024)
#define	MAX_LANGUAGE_LEN   10
#define	_INTERLACED   true
#define	_PROGRESSIVE   false
#define	dsVideoPortRESOLUTION_NUMMAX   32
#define	DELAY_REPEAT_MASK   0x00000001
#define	LANGUAGE_MASK   0x00000010
#define	MISSED_KEY_TIMEOUT_MASK   0x00000100
#define	REPEAT_KEY_ENABLED_MASK   0x00001000
#define	REPEAT_FREQUENCY_MASK   0x00010000
#define	REPORT_MODIFIERS_MASK   0x00100000
#define	NUM_OF_DEVICES_MASK   0x01000000
#define	KET_KEYDOWN   0x00008000UL
#define	KET_KEYUP   0x00008100UL
#define	KET_KEYREPEAT   0x00008200UL
#define	KED_DIGIT0   0x00000030UL
#define	KED_DIGIT1   0x00000031UL
#define	KED_DIGIT2   0x00000032UL
#define	KED_DIGIT3   0x00000033UL
#define	KED_DIGIT4   0x00000034UL
#define	KED_DIGIT5   0x00000035UL
#define	KED_DIGIT6   0x00000036UL
#define	KED_DIGIT7   0x00000037UL
#define	KED_DIGIT8   0x00000038UL
#define	KED_DIGIT9   0x00000039UL
#define	KED_PERIOD   0x00000040UL
#define	KED_DISCRETE_POWER_ON   0x00000050UL
#define	KED_DISCRETE_POWER_STANDBY   0x00000051UL
#define	KED_SEARCH   0x000000CFUL
#define	KED_SETUP   0x00000052UL
#define	KED_CLOSED_CAPTIONING   0x00000060UL
#define	KED_LANGUAGE   0x00000061UL
#define	KED_VOICE_GUIDANCE   0x00000062UL
#define	KED_HEARTBEAT   0x00000063UL
#define	KED_PUSH_TO_TALK   0x00000064UL
#define	KED_DESCRIPTIVE_AUDIO   0x00000065UL
#define	KED_VOLUME_OPTIMIZE   0x00000066UL
#define	KED_XR2V3   0x00000067UL
#define	KED_XR5V2   0x00000068UL
#define	KED_XR11V1   0x00000069UL
#define	KED_XR11V2   0x0000006AUL
#define	KED_XR13   0x0000006BUL
#define	KED_XR11_NOTIFY   0x0000006CUL
#define	KED_XR15V1_NOTIFY   0x00000070UL
#define	KED_XR15V1_SELECT   0x00000071UL
#define	KED_XR15V1_PUSH_TO_TALK   0x00000072UL
#define	KED_SCREEN_BIND_NOTIFY   0x00000073UL
#define	KED_XR16V1_NOTIFY   0x00000074UL
#define	KED_XR16V1_SELECT   0x00000075UL
#define	KED_XR16V1_PUSH_TO_TALK   0x00000076UL
#define	KED_RF_POWER   0x0000007FUL
#define	KED_POWER   0x00000080UL
#define	KED_FP_POWER   KED_POWER
#define	KED_ARROWUP   0x00000081UL
#define	KED_ARROWDOWN   0x00000082UL
#define	KED_ARROWLEFT   0x00000083UL
#define	KED_ARROWRIGHT   0x00000084UL
#define	KED_SELECT   0x00000085UL
#define	KED_ENTER   0x00000086UL
#define	KED_EXIT   0x00000087UL
#define	KED_CHANNELUP   0x00000088UL
#define	KED_CHANNELDOWN   0x00000089UL
#define	KED_VOLUMEUP   0x0000008AUL
#define	KED_VOLUMEDOWN   0x0000008BUL
#define	KED_MUTE   0x0000008CUL
#define	KED_GUIDE   0x0000008DUL
#define	KED_VIEWINGGUIDE   KED_GUIDE
#define	KED_INFO   0x0000008EUL
#define	KED_SETTINGS   0x0000008FUL
#define	KED_PAGEUP   0x00000090UL
#define	KED_PAGEDOWN   0x00000091UL
#define	KED_KEYA   0x00000092UL
#define	KED_KEYB   0x00000093UL
#define	KED_KEYC   0x00000094UL
#define	KED_KEYD   0x0000009FUL
#define	KED_KEY_RED_CIRCLE   KED_KEYC
#define	KED_KEY_GREEN_DIAMOND   KED_KEYD
#define	KED_KEY_BLUE_SQUARE   KED_KEYB
#define	KED_KEY_YELLOW_TRIANGLE   KED_KEYA
#define	KED_LAST   0x00000095UL
#define	KED_FAVORITE   0x00000096UL
#define	KED_REWIND   0x00000097UL
#define	KED_FASTFORWARD   0x00000098UL
#define	KED_PLAY   0x00000099UL
#define	KED_STOP   0x0000009AUL
#define	KED_PAUSE   0x0000009BUL
#define	KED_RECORD   0x0000009CUL
#define	KED_BYPASS   0x0000009DUL
#define	KED_TVVCR   0x0000009EUL
#define	KED_REPLAY   0x000000A0UL
#define	KED_HELP   0x000000A1UL
#define	KED_RECALL_FAVORITE_0   0x000000A2UL
#define	KED_CLEAR   0x000000A3UL
#define	KED_DELETE   0x000000A4UL
#define	KED_START   0x000000A5UL
#define	KED_POUND   0x000000A6UL
#define	KED_FRONTPANEL1   0x000000A7UL
#define	KED_FRONTPANEL2   0x000000A8UL
#define	KED_OK   0x000000A9UL
#define	KED_STAR   0x000000AAUL
#define	KED_PROGRAM   0x000000ABUL
#define	KED_TVPOWER   0x000000C1UL
#define	KED_PREVIOUS   0x000000C3UL
#define	KED_NEXT   0x000000C4UL
#define	KED_MENU   0x000000C0UL
#define	KED_INPUTKEY   0x000000D0UL
#define	KED_LIVE   0x000000D1UL
#define	KED_MYDVR   0x000000D2UL
#define	KED_ONDEMAND   0x000000D3UL
#define	KED_STB_MENU   0x000000D4UL
#define	KED_AUDIO   0x000000D5UL
#define	KED_FACTORY   0x000000D6UL
#define	KED_RFENABLE   0x000000D7UL
#define	KED_LIST   0x000000D8UL
#define	KED_RF_PAIR_GHOST   0x000000EFUL
#define	KED_WPS   0x000000F0UL
#define	KED_DEEPSLEEP_WAKEUP   0x000000F1UL
#define	KED_NEW_BATTERIES_INSERTED   0x000000F2UL
#define	KED_GRACEFUL_SHUTDOWN   0x000000F3UL
#define	KED_UNDEFINEDKEY   0x000000FEUL
#define	KED_BACK   0x100000FEUL
#define	KED_DISPLAY_SWAP   0x300000FEUL
#define	KED_PINP_MOVE   0x400000FEUL
#define	KED_PINP_TOGGLE   0x500000FEUL
#define	KED_PINP_CHDOWN   0x600000FEUL
#define	KED_PINP_CHUP   0x700000FEUL
#define	KED_DMC_ACTIVATE   0x800000FEUL
#define	KED_DMC_DEACTIVATE   0x900000FEUL
#define	KED_DMC_QUERY   0xA00000FEUL
#define	KED_OTR_START   0xB00000FEUL
#define	KED_OTR_STOP   0xC00000FEUL
#define	DELAY_REPEAT_MASK   0x00000001
#define	LANGUAGE_MASK   0x00000010
#define	MISSED_KEY_TIMEOUT_MASK   0x00000100
#define	REPEAT_KEY_ENABLED_MASK   0x00001000
#define	REPEAT_FREQUENCY_MASK   0x00010000
#define	REPORT_MODIFIERS_MASK   0x00100000
#define	NUM_OF_DEVICES_MASK   0x01000000
#define	KET_KEYDOWN   0x00008000UL
#define	KET_KEYUP   0x00008100UL
#define	KET_KEYREPEAT   0x00008200UL
#define	KED_DIGIT0   0x00000030UL
#define	KED_DIGIT1   0x00000031UL
#define	KED_DIGIT2   0x00000032UL
#define	KED_DIGIT3   0x00000033UL
#define	KED_DIGIT4   0x00000034UL
#define	KED_DIGIT5   0x00000035UL
#define	KED_DIGIT6   0x00000036UL
#define	KED_DIGIT7   0x00000037UL
#define	KED_DIGIT8   0x00000038UL
#define	KED_DIGIT9   0x00000039UL
#define	KED_PERIOD   0x00000040UL
#define	KED_DISCRETE_POWER_ON   0x00000050UL
#define	KED_DISCRETE_POWER_STANDBY   0x00000051UL
#define	KED_SEARCH   0x000000CFUL
#define	KED_SETUP   0x00000052UL
#define	KED_CLOSED_CAPTIONING   0x00000060UL
#define	KED_LANGUAGE   0x00000061UL
#define	KED_VOICE_GUIDANCE   0x00000062UL
#define	KED_HEARTBEAT   0x00000063UL
#define	KED_PUSH_TO_TALK   0x00000064UL
#define	KED_DESCRIPTIVE_AUDIO   0x00000065UL
#define	KED_VOLUME_OPTIMIZE   0x00000066UL
#define	KED_XR2V3   0x00000067UL
#define	KED_XR5V2   0x00000068UL
#define	KED_XR11V1   0x00000069UL
#define	KED_XR11V2   0x0000006AUL
#define	KED_XR13   0x0000006BUL
#define	KED_XR11_NOTIFY   0x0000006CUL
#define	KED_XR15V1_NOTIFY   0x00000070UL
#define	KED_XR15V1_SELECT   0x00000071UL
#define	KED_XR15V1_PUSH_TO_TALK   0x00000072UL
#define	KED_SCREEN_BIND_NOTIFY   0x00000073UL
#define	KED_XR16V1_NOTIFY   0x00000074UL
#define	KED_XR16V1_SELECT   0x00000075UL
#define	KED_XR16V1_PUSH_TO_TALK   0x00000076UL
#define	KED_RF_POWER   0x0000007FUL
#define	KED_POWER   0x00000080UL
#define	KED_FP_POWER   KED_POWER
#define	KED_ARROWUP   0x00000081UL
#define	KED_ARROWDOWN   0x00000082UL
#define	KED_ARROWLEFT   0x00000083UL
#define	KED_ARROWRIGHT   0x00000084UL
#define	KED_SELECT   0x00000085UL
#define	KED_ENTER   0x00000086UL
#define	KED_EXIT   0x00000087UL
#define	KED_CHANNELUP   0x00000088UL
#define	KED_CHANNELDOWN   0x00000089UL
#define	KED_VOLUMEUP   0x0000008AUL
#define	KED_VOLUMEDOWN   0x0000008BUL
#define	KED_MUTE   0x0000008CUL
#define	KED_GUIDE   0x0000008DUL
#define	KED_VIEWINGGUIDE   KED_GUIDE
#define	KED_INFO   0x0000008EUL
#define	KED_SETTINGS   0x0000008FUL
#define	KED_PAGEUP   0x00000090UL
#define	KED_PAGEDOWN   0x00000091UL
#define	KED_KEYA   0x00000092UL
#define	KED_KEYB   0x00000093UL
#define	KED_KEYC   0x00000094UL
#define	KED_KEYD   0x0000009FUL
#define	KED_KEY_RED_CIRCLE   KED_KEYC
#define	KED_KEY_GREEN_DIAMOND   KED_KEYD
#define	KED_KEY_BLUE_SQUARE   KED_KEYB
#define	KED_KEY_YELLOW_TRIANGLE   KED_KEYA
#define	KED_LAST   0x00000095UL
#define	KED_FAVORITE   0x00000096UL
#define	KED_REWIND   0x00000097UL
#define	KED_FASTFORWARD   0x00000098UL
#define	KED_PLAY   0x00000099UL
#define	KED_STOP   0x0000009AUL
#define	KED_PAUSE   0x0000009BUL
#define	KED_RECORD   0x0000009CUL
#define	KED_BYPASS   0x0000009DUL
#define	KED_TVVCR   0x0000009EUL
#define	KED_REPLAY   0x000000A0UL
#define	KED_HELP   0x000000A1UL
#define	KED_RECALL_FAVORITE_0   0x000000A2UL
#define	KED_CLEAR   0x000000A3UL
#define	KED_DELETE   0x000000A4UL
#define	KED_START   0x000000A5UL
#define	KED_POUND   0x000000A6UL
#define	KED_FRONTPANEL1   0x000000A7UL
#define	KED_FRONTPANEL2   0x000000A8UL
#define	KED_OK   0x000000A9UL
#define	KED_STAR   0x000000AAUL
#define	KED_PROGRAM   0x000000ABUL
#define	KED_TVPOWER   0x000000C1UL
#define	KED_PREVIOUS   0x000000C3UL
#define	KED_NEXT   0x000000C4UL
#define	KED_MENU   0x000000C0UL
#define	KED_INPUTKEY   0x000000D0UL
#define	KED_LIVE   0x000000D1UL
#define	KED_MYDVR   0x000000D2UL
#define	KED_ONDEMAND   0x000000D3UL
#define	KED_STB_MENU   0x000000D4UL
#define	KED_AUDIO   0x000000D5UL
#define	KED_FACTORY   0x000000D6UL
#define	KED_RFENABLE   0x000000D7UL
#define	KED_LIST   0x000000D8UL
#define	KED_RF_PAIR_GHOST   0x000000EFUL
#define	KED_WPS   0x000000F0UL
#define	KED_DEEPSLEEP_WAKEUP   0x000000F1UL
#define	KED_NEW_BATTERIES_INSERTED   0x000000F2UL
#define	KED_GRACEFUL_SHUTDOWN   0x000000F3UL
#define	KED_UNDEFINEDKEY   0x000000FEUL
#define	KED_BACK   0x100000FEUL
#define	KED_DISPLAY_SWAP   0x300000FEUL
#define	KED_PINP_MOVE   0x400000FEUL
#define	KED_PINP_TOGGLE   0x500000FEUL
#define	KED_PINP_CHDOWN   0x600000FEUL
#define	KED_PINP_CHUP   0x700000FEUL
#define	KED_DMC_ACTIVATE   0x800000FEUL
#define	KED_DMC_DEACTIVATE   0x900000FEUL
#define	KED_DMC_QUERY   0xA00000FEUL
#define	KED_OTR_START   0xB00000FEUL
#define	KED_OTR_STOP   0xC00000FEUL

Typedefs
typedef void(*	dsAudioOutPortConnectCB_t) (dsAudioPortType_t portType, unsigned int uiPortNo, bool isPortCon)
typedef void(*	dsAudioFormatUpdateCB_t) (dsAudioFormat_t audioFormat)
	Callback function used to notify applications of Audio Format change. More...
typedef enum _dsDisplayEvent_t	dsDisplayEvent_t
typedef void(*	DSHal_LogCb) (int priority, const char *)
typedef enum _dsHdcpProtocolVersion_t	dsHdcpProtocolVersion_t
typedef enum _dsHdcpStatus_t	dsHdcpStatus_t
typedef struct _dsAudioTypeConfig_t	dsAudioTypeConfig_t
	Structure that defines audio output device configuration.
typedef struct _dsAudioPortId_t	dsAudioPortId_t
	Structure that defines the audio port type and associated ID.
typedef enum _dsHDRStandard_t	dsHDRStandard_t
typedef enum _dsSURROUNDMode_t	dsSURROUNDMode_t
typedef enum _dsMS12FEATURE_t	dsMS12FEATURE_t
typedef struct _dsAudioPortConfig_t	dsAudioPortConfig_t
	Structure that defines audio port configuration.
typedef void(*	dsRegisterFrameratePreChangeCB_t) (unsigned int tSecond)
typedef void(*	dsRegisterFrameratePostChangeCB_t) (unsigned int tSecond)
typedef void(*	dsVideoFormatUpdateCB_t) (dsHDRStandard_t videoFormat)
	Callback function used to notify applications of Video Format change. More...

Enumerations
enum	_dsDisplayEvent_t
enum	_dsHdcpProtocolVersion_t
enum	_dsHdcpStatus_t
enum	_dsHDRStandard_t
enum	_dsSURROUNDMode_t
enum	_dsMS12FEATURE_t

Functions
int	ds_hal_log (int priority, const char *format,...)
void	DSHal_RegisterForLog (DSHal_LogCb cb)
dsError_t	dsSetFRFMode (intptr_t handle, int frfmode)
dsError_t	dsGetFRFMode (intptr_t handle, int *frfmode)
dsError_t	dsGetCurrentDisplayframerate (intptr_t handle, char *framerate)
dsError_t	dsSetDisplayframerate (intptr_t handle, char *framerate)
dsError_t	dsRegisterFrameratePreChangeCB (dsRegisterFrameratePreChangeCB_t CBFunc)
dsError_t	dsRegisterFrameratePostChangeCB (dsRegisterFrameratePostChangeCB_t CBFunc)

Variables
int	_dsAudioSADList_t::sad [15]
int	_dsAudioSADList_t::count
dsAudioARCTypes_t	_dsAudioARCStatus_t::type
bool	_dsAudioARCStatus_t::status
char	_dsMS12AudioProfileList_t::audioProfileList [1024]
int	_dsMS12AudioProfileList_t::audioProfileCount
int	_dsVolumeLeveller_t::mode
int	_dsVolumeLeveller_t::level
int	_dsSurroundVirtualizer_t::mode
int	_dsSurroundVirtualizer_t::boost
size_t	_dsVideoConfig_t::numSupportedDFCs
const dsVideoZoom_t *	_dsVideoConfig_t::supportedDFCs
dsVideoZoom_t	_dsVideoConfig_t::defaultDFC
int32_t	_dsAudioTypeConfig_t::typeId
const char *	_dsAudioTypeConfig_t::name
size_t	_dsAudioTypeConfig_t::numSupportedCompressions
const dsAudioCompression_t *	_dsAudioTypeConfig_t::compressions
size_t	_dsAudioTypeConfig_t::numSupportedEncodings
const dsAudioEncoding_t *	_dsAudioTypeConfig_t::encodings
size_t	_dsAudioTypeConfig_t::numSupportedStereoModes
const dsAudioStereoMode_t *	_dsAudioTypeConfig_t::stereoModes
char	_dsVideoPortResolution_t::name [32]
dsVideoResolution_t	_dsVideoPortResolution_t::pixelResolution
dsVideoAspectRatio_t	_dsVideoPortResolution_t::aspectRatio
dsVideoStereoScopicMode_t	_dsVideoPortResolution_t::stereoScopicMode
dsVideoFrameRate_t	_dsVideoPortResolution_t::frameRate
bool	_dsVideoPortResolution_t::interlaced
dsAudioPortType_t	_dsAudioPortId_t::type
int32_t	_dsAudioPortId_t::index
dsVideoPortType_t	_dsVideoPortPortId_t::type
int32_t	_dsVideoPortPortId_t::index
dsVideoPortType_t	_dsVideoPortTypeConfig_t::typeId
const char *	_dsVideoPortTypeConfig_t::name
bool	_dsVideoPortTypeConfig_t::dtcpSupported
bool	_dsVideoPortTypeConfig_t::hdcpSupported
int32_t	_dsVideoPortTypeConfig_t::restrictedResollution
size_t	_dsVideoPortTypeConfig_t::numSupportedResolutions
dsVideoPortResolution_t *	_dsVideoPortTypeConfig_t::supportedResolutions
dsAudioPortId_t	_dsAudioPortConfig_t::id
const dsVideoPortPortId_t *	_dsAudioPortConfig_t::connectedVOPs
dsVideoPortPortId_t	_dsVideoPortPortConfig_t::id
dsAudioPortId_t	_dsVideoPortPortConfig_t::connectedAOP
const char *	_dsVideoPortPortConfig_t::defaultResolution
int32_t	_dsDisplayEDID_t::productCode
int32_t	_dsDisplayEDID_t::serialNumber
int32_t	_dsDisplayEDID_t::manufactureYear
int32_t	_dsDisplayEDID_t::manufactureWeek
bool	_dsDisplayEDID_t::hdmiDeviceType
bool	_dsDisplayEDID_t::isRepeater
uint8_t	_dsDisplayEDID_t::physicalAddressA
uint8_t	_dsDisplayEDID_t::physicalAddressB
uint8_t	_dsDisplayEDID_t::physicalAddressC
uint8_t	_dsDisplayEDID_t::physicalAddressD
int32_t	_dsDisplayEDID_t::numOfSupportedResolution
dsVideoPortResolution_t	_dsDisplayEDID_t::suppResolutionList [64 *dsVIDEO_SSMODE_MAX]
char	_dsDisplayEDID_t::monitorName [14]
bool	_dsHdmiInStatus_t::isPresented
bool	_dsHdmiInStatus_t::isPortConnected [dsHDMI_IN_PORT_MAX]
dsHdmiInPort_t	_dsHdmiInStatus_t::activePort
bool	_dsHdmiInCap_t::isPortArcCapable [dsHDMI_IN_PORT_MAX]
bool	_dsCompositeInStatus_t::isPresented
bool	_dsCompositeInStatus_t::isPortConnected [dsCOMPOSITE_IN_PORT_MAX]
dsCompositeInPort_t	_dsCompositeInStatus_t::activePort
dsVideoCodecHevcProfiles_t	dsVideoCodecProfileSupport_t::profile
float	dsVideoCodecProfileSupport_t::level
unsigned int	dsVideoCodecInfo_t::num_entries
dsVideoCodecProfileSupport_t	dsVideoCodecInfo_t::entries [10]
uint8_t	dsSpd_infoframe_st::pkttype
uint8_t	dsSpd_infoframe_st::version
uint8_t	dsSpd_infoframe_st::length
uint8_t	dsSpd_infoframe_st::rsd
uint8_t	dsSpd_infoframe_st::checksum
uint8_t	dsSpd_infoframe_st::vendor_name [8]
uint8_t	dsSpd_infoframe_st::product_des [16]
uint8_t	dsSpd_infoframe_st::source_info
char	_dsSupportedGameFeatureList_t::gameFeatureList [1024]
int	_dsSupportedGameFeatureList_t::gameFeatureCount
static dsVideoPortResolution_t	kResolutions []
static const int	kDefaultResIndex = 3

---

Data Structure Documentation

_dsAudioTypeConfig_t

struct _dsAudioTypeConfig_t

Structure that defines audio output device configuration.

Definition at line 627 of file dsTypes.h.

Collaboration diagram for _dsAudioTypeConfig_t:

Data Fields
int32_t	typeId	The audio output type (dsAudioPortType_t).
const char *	name	Name of the audio output device (e.g. "HDMI").
size_t	numSupportedCompressions	Number of supported audio compression methods.
const dsAudioCompression_t *	compressions	List of audio compression methods supported.
size_t	numSupportedEncodings	Number of supported audio encodings.
const dsAudioEncoding_t *	encodings	List of audio encodings supported.
size_t	numSupportedStereoModes	Number of supported stereo modes.
const dsAudioStereoMode_t *	stereoModes	List of stereo modes supported.

_dsVideoPortResolution_t

struct _dsVideoPortResolution_t

Structure that defines video port resolution settings of output video device.

Definition at line 642 of file dsTypes.h.

Collaboration diagram for _dsVideoPortResolution_t:

Data Fields
char	name[32]	Name the resolution (e.g. 480i, 480p, 1080p24).
dsVideoResolution_t	pixelResolution	The resolution associated with the name.
dsVideoAspectRatio_t	aspectRatio	The associated aspect ratio.
dsVideoStereoScopicMode_t	stereoScopicMode	The associated stereoscopic mode.
dsVideoFrameRate_t	frameRate	The associated frame rate.
bool	interlaced	The associated scan mode(true if interlaced, false if progressive).

_dsAudioPortId_t

struct _dsAudioPortId_t

Structure that defines the audio port type and associated ID.

Definition at line 655 of file dsTypes.h.

Collaboration diagram for _dsAudioPortId_t:

Data Fields
dsAudioPortType_t	type	Audio port type.
int32_t	index	Port ID/number.

_dsVideoPortPortId_t

struct _dsVideoPortPortId_t

Structure that defines port id associated with video port.

Definition at line 664 of file dsTypes.h.

Collaboration diagram for _dsVideoPortPortId_t:

Data Fields
dsVideoPortType_t	type	Video port type.
int32_t	index	Port ID/number.

_dsVideoPortTypeConfig_t

struct _dsVideoPortTypeConfig_t

Structure that defines the video output port configuration.

Definition at line 673 of file dsTypes.h.

Collaboration diagram for _dsVideoPortTypeConfig_t:

Data Fields
dsVideoPortType_t	typeId	The video output type.
const char *	name	Name of the video output port.
bool	dtcpSupported	Is DTCP supported?
bool	hdcpSupported	Is HDCP supported?
int32_t	restrictedResollution	Any restricted resolution; -1 if no.
size_t	numSupportedResolutions	Number of supported resolutions.
dsVideoPortResolution_t *	supportedResolutions	List of supported resolutions.

_dsAudioPortConfig_t

struct _dsAudioPortConfig_t

Structure that defines audio port configuration.

Definition at line 726 of file dsTypes.h.

Collaboration diagram for _dsAudioPortConfig_t:

Data Fields
dsAudioPortId_t	id	Port ID.
const dsVideoPortPortId_t *	connectedVOPs	Connected video port.

_dsVideoPortPortConfig_t

struct _dsVideoPortPortConfig_t

Structure that defines video port configuration settings.

Definition at line 737 of file dsTypes.h.

Collaboration diagram for _dsVideoPortPortConfig_t:

Data Fields
dsVideoPortPortId_t	id	Port ID.
dsAudioPortId_t	connectedAOP	Connected audio port.
const char *	defaultResolution	Default resolution's name.

Typedef Documentation

dsAudioFormatUpdateCB_t

typedef void(* dsAudioFormatUpdateCB_t) (dsAudioFormat_t audioFormat)

Callback function used to notify applications of Audio Format change.

HAL Implementation should call this method to deliver updated Audio Format info to the application

Parameters

audioFormat

Current audio format of the content playing

Returns

None.

Definition at line 58 of file dsAudio.h.

dsHDRStandard_t

typedef enum _dsHDRStandard_t dsHDRStandard_t

Enumeration defines all of the standard HDR types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.

dsSURROUNDMode_t

typedef enum _dsSURROUNDMode_t dsSURROUNDMode_t

Enumeration defines surround mode. Each bit of uint32_t represent supported surround mode.

dsMS12FEATURE_t

typedef enum _dsMS12FEATURE_t dsMS12FEATURE_t

Enumeration defines MS12 feature.

dsVideoFormatUpdateCB_t

typedef void(* dsVideoFormatUpdateCB_t) (dsHDRStandard_t videoFormat)

Callback function used to notify applications of Video Format change.

HAL Implementation should call this method to deliver updated Video Format info to the application

Parameters

audioFormat

Current video format of the content playing

Returns

None.

Definition at line 56 of file dsVideoPort.h.

Enumeration Type Documentation

_dsDisplayEvent_t

enum _dsDisplayEvent_t

Enumerator
dsDISPLAY_EVENT_CONNECTED	Display connected event.
dsDISPLAY_EVENT_DISCONNECTED	Display disconnected event.
dsDISPLAY_RXSENSE_ON	Rx Sense ON event.
dsDISPLAY_RXSENSE_OFF	Rx Sense OFF event.
dsDISPLAY_HDCPPROTOCOL_CHANGE	HDCP Protocol Version Change event.

Definition at line 50 of file dsDisplay.h.

_dsHdcpProtocolVersion_t

enum _dsHdcpProtocolVersion_t

Enumerator
dsHDCP_VERSION_1X	HDCP Protocol version 1.x
dsHDCP_VERSION_2X	HDCP Protocol version 2.x
dsHDCP_VERSION_MAX	Maximum index for HDCP protocol.

Definition at line 404 of file dsTypes.h.

_dsHdcpStatus_t

enum _dsHdcpStatus_t

Enumerator
dsHDCP_STATUS_UNPOWERED	Connected Sink Device does not support HDCP
dsHDCP_STATUS_UNAUTHENTICATED	HDCP Authentication Process is not initiated
dsHDCP_STATUS_AUTHENTICATED	HDCP Authentication Process is initiated and Passed
dsHDCP_STATUS_AUTHENTICATIONFAILURE	HDCP Authentication Failure or Link Integroty Failure
dsHDCP_STATUS_INPROGRESS	HDCP Authentication in Progress
dsHDCP_STATUS_PORTDISABLED	HDMI output port disabled
dsHDCP_STATUS_MAX	Maximum index for HDCP status.

Definition at line 413 of file dsTypes.h.

_dsHDRStandard_t

enum _dsHDRStandard_t

Enumeration defines all of the standard HDR types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.

Enumerator
dsHDRSTANDARD_NONE	When No video in decoded
dsHDRSTANDARD_HDR10	Video Format HDR
dsHDRSTANDARD_HLG	Video Format HLG
dsHDRSTANDARD_DolbyVision	Video Format Dolby Vision
dsHDRSTANDARD_TechnicolorPrime	Video Format Techinicolor Prime
dsHDRSTANDARD_HDR10PLUS	Video Format HDRPlus
dsHDRSTANDARD_SDR	Video Format SDR
dsHDRSTANDARD_Invalid	When invalid value observed

Definition at line 692 of file dsTypes.h.

_dsSURROUNDMode_t

enum _dsSURROUNDMode_t

Enumeration defines surround mode. Each bit of uint32_t represent supported surround mode.

Definition at line 708 of file dsTypes.h.

_dsMS12FEATURE_t

enum _dsMS12FEATURE_t

Enumeration defines MS12 feature.

Definition at line 717 of file dsTypes.h.

Variable Documentation

sad

int _dsAudioSADList_t::sad[15]

Definition at line 300 of file dsTypes.h.

count

int _dsAudioSADList_t::count

Definition at line 301 of file dsTypes.h.

type [1/3]

dsAudioARCTypes_t _dsAudioARCStatus_t::type

Definition at line 308 of file dsTypes.h.

status

bool _dsAudioARCStatus_t::status

Definition at line 309 of file dsTypes.h.

audioProfileList

char _dsMS12AudioProfileList_t::audioProfileList[1024]

Definition at line 335 of file dsTypes.h.

audioProfileCount

int _dsMS12AudioProfileList_t::audioProfileCount

Definition at line 336 of file dsTypes.h.

mode [1/2]

int _dsVolumeLeveller_t::mode

Definition at line 353 of file dsTypes.h.

level [1/2]

int _dsVolumeLeveller_t::level

Definition at line 354 of file dsTypes.h.

mode [2/2]

int _dsSurroundVirtualizer_t::mode

Definition at line 361 of file dsTypes.h.

boost

int _dsSurroundVirtualizer_t::boost

Definition at line 362 of file dsTypes.h.

numSupportedDFCs

size_t _dsVideoConfig_t::numSupportedDFCs

Number of zoom modes supported.

Definition at line 613 of file dsTypes.h.

supportedDFCs

const dsVideoZoom_t* _dsVideoConfig_t::supportedDFCs

List of zoom modes supported.

Definition at line 614 of file dsTypes.h.

defaultDFC

dsVideoZoom_t _dsVideoConfig_t::defaultDFC

The default zoom mode.

Definition at line 615 of file dsTypes.h.

typeId [1/2]

int32_t _dsAudioTypeConfig_t::typeId

The audio output type (dsAudioPortType_t).

Definition at line 628 of file dsTypes.h.

name [1/3]

const char* _dsAudioTypeConfig_t::name

Name of the audio output device (e.g. "HDMI").

Definition at line 629 of file dsTypes.h.

numSupportedCompressions

size_t _dsAudioTypeConfig_t::numSupportedCompressions

Number of supported audio compression methods.

Definition at line 630 of file dsTypes.h.

compressions

const dsAudioCompression_t* _dsAudioTypeConfig_t::compressions

List of audio compression methods supported.

Definition at line 631 of file dsTypes.h.

numSupportedEncodings

size_t _dsAudioTypeConfig_t::numSupportedEncodings

Number of supported audio encodings.

Definition at line 632 of file dsTypes.h.

encodings

const dsAudioEncoding_t* _dsAudioTypeConfig_t::encodings

List of audio encodings supported.

Definition at line 633 of file dsTypes.h.

numSupportedStereoModes

size_t _dsAudioTypeConfig_t::numSupportedStereoModes

Number of supported stereo modes.

Definition at line 634 of file dsTypes.h.

stereoModes

const dsAudioStereoMode_t* _dsAudioTypeConfig_t::stereoModes

List of stereo modes supported.

Definition at line 635 of file dsTypes.h.

name [2/3]

char _dsVideoPortResolution_t::name[32]

Name the resolution (e.g. 480i, 480p, 1080p24).

Definition at line 643 of file dsTypes.h.

pixelResolution

dsVideoResolution_t _dsVideoPortResolution_t::pixelResolution

The resolution associated with the name.

Definition at line 644 of file dsTypes.h.

aspectRatio

dsVideoAspectRatio_t _dsVideoPortResolution_t::aspectRatio

The associated aspect ratio.

Definition at line 645 of file dsTypes.h.

stereoScopicMode

dsVideoStereoScopicMode_t _dsVideoPortResolution_t::stereoScopicMode

The associated stereoscopic mode.

Definition at line 646 of file dsTypes.h.

frameRate

dsVideoFrameRate_t _dsVideoPortResolution_t::frameRate

The associated frame rate.

Definition at line 647 of file dsTypes.h.

interlaced

bool _dsVideoPortResolution_t::interlaced

The associated scan mode(true if interlaced, false if progressive).

Definition at line 648 of file dsTypes.h.

type [2/3]

dsAudioPortType_t _dsAudioPortId_t::type

Audio port type.

Definition at line 656 of file dsTypes.h.

index [1/2]

int32_t _dsAudioPortId_t::index

Port ID/number.

Definition at line 657 of file dsTypes.h.

type [3/3]

dsVideoPortType_t _dsVideoPortPortId_t::type

Video port type.

Definition at line 665 of file dsTypes.h.

index [2/2]

int32_t _dsVideoPortPortId_t::index

Port ID/number.

Definition at line 666 of file dsTypes.h.

typeId [2/2]

dsVideoPortType_t _dsVideoPortTypeConfig_t::typeId

The video output type.

Definition at line 674 of file dsTypes.h.

name [3/3]

const char* _dsVideoPortTypeConfig_t::name

Name of the video output port.

Definition at line 675 of file dsTypes.h.

dtcpSupported

bool _dsVideoPortTypeConfig_t::dtcpSupported

Is DTCP supported?

Definition at line 676 of file dsTypes.h.

hdcpSupported

bool _dsVideoPortTypeConfig_t::hdcpSupported

Is HDCP supported?

Definition at line 677 of file dsTypes.h.

restrictedResollution

int32_t _dsVideoPortTypeConfig_t::restrictedResollution

Any restricted resolution; -1 if no.

Definition at line 678 of file dsTypes.h.

numSupportedResolutions

size_t _dsVideoPortTypeConfig_t::numSupportedResolutions

Number of supported resolutions.

Definition at line 679 of file dsTypes.h.

supportedResolutions

dsVideoPortResolution_t* _dsVideoPortTypeConfig_t::supportedResolutions

List of supported resolutions.

Definition at line 680 of file dsTypes.h.

id [1/2]

dsAudioPortId_t _dsAudioPortConfig_t::id

Port ID.

Definition at line 727 of file dsTypes.h.

connectedVOPs

const dsVideoPortPortId_t* _dsAudioPortConfig_t::connectedVOPs

Connected video port.

Definition at line 728 of file dsTypes.h.

id [2/2]

dsVideoPortPortId_t _dsVideoPortPortConfig_t::id

Port ID.

Definition at line 738 of file dsTypes.h.

connectedAOP

dsAudioPortId_t _dsVideoPortPortConfig_t::connectedAOP

Connected audio port.

Definition at line 739 of file dsTypes.h.

defaultResolution

const char* _dsVideoPortPortConfig_t::defaultResolution

Default resolution's name.

Definition at line 740 of file dsTypes.h.

productCode

int32_t _dsDisplayEDID_t::productCode

Product code of the display device.

Definition at line 902 of file dsTypes.h.

serialNumber

int32_t _dsDisplayEDID_t::serialNumber

Serial number of the display device.

Definition at line 903 of file dsTypes.h.

manufactureYear

int32_t _dsDisplayEDID_t::manufactureYear

Year of manufacture of the display device.

Definition at line 904 of file dsTypes.h.

manufactureWeek

int32_t _dsDisplayEDID_t::manufactureWeek

Week of manufacture of the display device.

Definition at line 905 of file dsTypes.h.

hdmiDeviceType

bool _dsDisplayEDID_t::hdmiDeviceType

Device type (@ true if HDMI, false if DVI).

Definition at line 906 of file dsTypes.h.

isRepeater

bool _dsDisplayEDID_t::isRepeater

Receiver is a repeater (@ true if Repeater, false if connected Receiver is not a repeater).

Definition at line 907 of file dsTypes.h.

physicalAddressA

uint8_t _dsDisplayEDID_t::physicalAddressA

Physical Address for HDMI node A

Definition at line 908 of file dsTypes.h.

physicalAddressB

uint8_t _dsDisplayEDID_t::physicalAddressB

Physical Address for HDMI node B

Definition at line 909 of file dsTypes.h.

physicalAddressC

uint8_t _dsDisplayEDID_t::physicalAddressC

Physical Address for HDMI node C -

Definition at line 910 of file dsTypes.h.

physicalAddressD

uint8_t _dsDisplayEDID_t::physicalAddressD

Physical Address for HDMI node D

Definition at line 911 of file dsTypes.h.

numOfSupportedResolution

int32_t _dsDisplayEDID_t::numOfSupportedResolution

Number of Supported Resolution

Definition at line 912 of file dsTypes.h.

suppResolutionList

dsVideoPortResolution_t _dsDisplayEDID_t::suppResolutionList[64 *dsVIDEO_SSMODE_MAX]

EDID Supported Resoultion List

Definition at line 913 of file dsTypes.h.

monitorName

char _dsDisplayEDID_t::monitorName[14]

Connected Display Monitor Name

Definition at line 914 of file dsTypes.h.

isPresented [1/2]

bool _dsHdmiInStatus_t::isPresented

Boolean flag indicating Hdmi Input is enabled for presentation by client

Definition at line 1031 of file dsTypes.h.

isPortConnected [1/2]

bool _dsHdmiInStatus_t::isPortConnected[dsHDMI_IN_PORT_MAX]

Boolean flag indicating Hdmi source connected to this Hdmi Input port

Definition at line 1032 of file dsTypes.h.

activePort [1/2]

dsHdmiInPort_t _dsHdmiInStatus_t::activePort

Hdmi Input Port selected as the currently active port (to the set-top)

• note that only one HDMI Input port can be active at a time

Definition at line 1033 of file dsTypes.h.

isPortArcCapable

bool _dsHdmiInCap_t::isPortArcCapable[dsHDMI_IN_PORT_MAX]

Boolean flag indicating Hdmi source is ARC capable

Definition at line 1039 of file dsTypes.h.

isPresented [2/2]

bool _dsCompositeInStatus_t::isPresented

Boolean flag indicating Composite Input is enabled for presentation by client

Definition at line 1078 of file dsTypes.h.

isPortConnected [2/2]

bool _dsCompositeInStatus_t::isPortConnected[dsCOMPOSITE_IN_PORT_MAX]

Boolean flag indicating Composite source connected to this Composite Input port

Definition at line 1079 of file dsTypes.h.

activePort [2/2]

dsCompositeInPort_t _dsCompositeInStatus_t::activePort

Composite Input Port selected as the currently active port (to the set-top)

• note that only one COMPOSITE Input port can be active at a time

Definition at line 1080 of file dsTypes.h.

profile

dsVideoCodecHevcProfiles_t dsVideoCodecProfileSupport_t::profile

Definition at line 1107 of file dsTypes.h.

level [2/2]

float dsVideoCodecProfileSupport_t::level

Definition at line 1108 of file dsTypes.h.

num_entries

unsigned int dsVideoCodecInfo_t::num_entries

Definition at line 1113 of file dsTypes.h.

entries

dsVideoCodecProfileSupport_t dsVideoCodecInfo_t::entries[10]

Definition at line 1114 of file dsTypes.h.

pkttype

uint8_t dsSpd_infoframe_st::pkttype

Definition at line 1118 of file dsTypes.h.

version

uint8_t dsSpd_infoframe_st::version

Definition at line 1119 of file dsTypes.h.

length

uint8_t dsSpd_infoframe_st::length

Definition at line 1120 of file dsTypes.h.

rsd

uint8_t dsSpd_infoframe_st::rsd

Definition at line 1121 of file dsTypes.h.

checksum

uint8_t dsSpd_infoframe_st::checksum

Definition at line 1122 of file dsTypes.h.

vendor_name

uint8_t dsSpd_infoframe_st::vendor_name[8]

Definition at line 1124 of file dsTypes.h.

product_des

uint8_t dsSpd_infoframe_st::product_des[16]

Definition at line 1126 of file dsTypes.h.

source_info

uint8_t dsSpd_infoframe_st::source_info

Definition at line 1128 of file dsTypes.h.

gameFeatureList

char _dsSupportedGameFeatureList_t::gameFeatureList[1024]

Definition at line 1142 of file dsTypes.h.

gameFeatureCount

int _dsSupportedGameFeatureList_t::gameFeatureCount

Definition at line 1143 of file dsTypes.h.