Device Settings HAL 0.2.0
 
Loading...
Searching...
No Matches

HAL types. More...

#include <sys/types.h>
#include <stdint.h>
#include <stdbool.h>
Include dependency graph for dsTypes.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _dsAudioSADList_t
 Structure that holds Short Audio Descriptors retrieved from connected ARC device. More...
 
struct  _dsAudioARCStatus_t
 Structure that holds ARC status for the HDMI ARC/EARC port. More...
 
struct  _dsMS12AudioProfileList_t
 
struct  _dsVolumeLeveller_t
 This defines the type of volume leveller mode. More...
 
struct  _dsSurroundVirtualizer_t
 This defines the type of surround virtualizer mode. More...
 
struct  _dsVideoConfig_t
 Structure that defines video device configuration for the output. More...
 
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...
 
struct  _dsDisplayEDID_t
 Structure for the EDID display. More...
 
struct  _dsHdmiInStatus_t
 Structure type for HDMI input status. More...
 
struct  _dsHdmiInCap_t
 Structure type for HDMI input ARC Capability. More...
 
struct  _dsCompositeInStatus_t
 Structure type for Composite input status. More...
 
struct  dsVideoCodecProfileSupport_t
 Structure type for HEVC profiles. More...
 
struct  dsVideoCodecInfo_t
 Structure type for Video codec info. More...
 
struct  dsSpd_infoframe_st
 Structure type for spd info frame. More...
 
struct  _dsSupportedGameFeatureList_t
 Structure that captures Supported Game Features list. More...
 

Macros

#define dsAUDIOPORT_TYPE_NUM_MAX   4
 
#define dsAudioPORT_NUM_MAX   4
 
#define dsAudioType_isValid(t)   (((t) >= dsAUDIOPORT_TYPE_ID_LR ) && ((t) < dsAUDIOPORT_TYPE_MAX))
 Audio output port type validation check.
 
#define dsAudioEncoding_isValid(t)   (((t) >= dsAUDIO_ENC_NONE ) && ((t) < dsAUDIO_ENC_MAX))
 Audio encoding type validation check.
 
#define MAX_SAD   15
 Max values for SADs.
 
#define MAX_PROFILE_LIST_BUFFER_LEN   1024
 Structure that captures MS12 Audio Profile list.
 
#define dsAudioCompression_isValid(t)   (((t) >= dsAUDIO_CMP_NONE ) && ((t) < dsAUDIO_CMP_MAX))
 Audio compression type validation check.
 
#define dsAudioStereoMode_isValid(t)   (((t) >= dsAUDIO_STEREO_UNKNOWN ) && ((t) < dsAUDIO_STEREO_MAX))
 Audio stereo mode type validation check.
 
#define dsHdcpStatus_isValid(t)   (((t) >= dsHDCP_STATUS_UNPOWERED ) && ((t) < dsHDCP_STATUS_MAX))
 HDCP status validation check.
 
#define dsVideoPortType_isValid(t)   (((t) >= dsVIDEOPORT_TYPE_RF ) && ((t) < dsVIDEOPORT_TYPE_MAX))
 Video output port type validation check.
 
#define dsVideoPortPixelResolution_isValid(t)   (((t) >= dsVIDEO_PIXELRES_720x480 ) && ((t) < dsVIDEO_PIXELRES_MAX))
 Video output resolutions type validation check.
 
#define dsVideoPortFrameRate_isValid(t)   (((t) >= dsVIDEO_FRAMERATE_UNKNOWN ) && ((t) < dsVIDEO_FRAMERATE_MAX))
 Video output framerate validation check.
 
#define dsVideoPortScanMode_isValid(t)   (((t) >= dsVIDEO_SCANMODE_INTERLACED ) && ((t) < dsVIDEO_SCANMODE_MAX))
 Video scan mode type validation check.
 
#define dsVideoPortAspectRatio_isValid(t)   (((t) >= dsVIDEO_ASPECT_RATIO_4x3 ) && ((t) < dsVIDEO_ASPECT_RATIO_MAX))
 Video aspect ratio type validation check.
 
#define dsVideoPortStereoScopicMode_isValid(t)   (((t) >= dsVIDEO_SSMODE_UNKNOWN ) && ((t) < dsVIDEO_SSMODE_MAX))
 Video Stereo Scopic modes type validation check.
 
#define dsVideoPortDFC_isValid(t)   (((t) >= dsVIDEO_ZOOM_NONE ) && ((t) < dsVIDEO_ZOOM_MAX))
 Video screen zoom validation check.
 
#define HDCP_KEY_MAX_SIZE   (4*1024)
 Max Key size.
 
#define MS12_CONFIG_BUF_SIZE   16
 defines the maximum size of buffer to hold ms12 config type details Ex: CONFIG_Z, CONFIG_X, CONFIG_Y etc.
 
#define MAX_LANGUAGE_LEN   10
 Max length of Language Code String.
 
#define dsFPDColor_Make(R8, G8, B8)   (((R8)<<16) | ((G8)<< 8) | ((B8) ))
 Defines the color values in RGB format.
 
#define dsFPDColor_R(RGB32)   (((RGB32) >> 16) & 0xFF)
 Extract Red value form RGB value.
 
#define dsFPDColor_G(RGB32)   (((RGB32) >> 8) & 0xFF)
 Extract Green value form RGB value.
 
#define dsFPDColor_B(RGB32)   (((RGB32) ) & 0xFF)
 Extract Blue value form RGB value.
 
#define dsFPD_COLOR_BLUE   dsFPDColor_Make(0, 0, 0xFF)
 Define a set of common colors, for backward compatibility .
 
#define dsFPD_COLOR_GREEN   dsFPDColor_Make(0, 0xFF, 0)
 Green color LED

 
#define dsFPD_COLOR_RED   dsFPDColor_Make(0xFF, 0, 0x0)
 Red color LED

 
#define dsFPD_COLOR_YELLOW   dsFPDColor_Make(0xFF, 0xFF, 0xE0)
 Yellow color LED

 
#define dsFPD_COLOR_ORANGE   dsFPDColor_Make(0xFF, 0x8C, 0x00)
 Orange color LED

 
#define dsFPD_COLOR_WHITE   dsFPDColor_Make(0xFF, 0xFF, 0xFF)
 White color LED

 
#define dsFPD_COLOR_MAX   6
 Out of range.
 
#define dsFPDColor_isValid(t)   (((t) & 0xFF000000) == 0)
 Front panel LED colors validation check.
 
#define dsFPD_INDICATOR_MESSAGE   0
 This enumeration pre-defines common front panel indicators. Implementation may not have to use these enumerators.
 
#define dsFPD_INDICATOR_POWER   1
 Power LED.
 
#define dsFPD_INDICATOR_RECORD   2
 Record LED.
 
#define dsFPD_INDICATOR_REMOTE   3
 Remote LED.
 
#define dsFPD_INDICATOR_RFBYPASS   4
 RF Bypass LED.
 
#define dsFPD_INDICATOR_MAX   5
 Out of range.
 
#define dsFPDIndicator_isValid(t)   (true)
 Front panel LED indicator type validation check.
 
#define dsFPDTextDisplay_isValid(t)   (((t) >= dsFPD_TEXTDISP_TEXT ) && ((t) < dsFPD_TEXTDISP_MAX))
 FPD text display type validation check.
 
#define dsFPD_BRIGHTNESS_MAX   100
 Maximum Value of FPD Led Brightness.
 
#define dsEEDID_MAX_VIDEO_CODE   64
 Maximum Value video modes are described in CEA specifictaion.
 
#define dsEEDID_MAX_MON_NAME_LENGTH   14
 Maximum length for for Connected Display Monitor names.
 
#define MAX_EDID_BYTES_LEN   (1024)
 Maximum length for EDID data.
 
#define dsSleepMode_isValid(t)   (((t) >= dsHOST_SLEEP_MODE_LIGHT) && ((t) < dsHOST_SLEEP_MODE_MAX))
 Sleep mode validation check.
 
#define MAX_FEATURE_LIST_BUFFER_LEN   1024
 Max buffer length for the feature list.
 
#define dsHAL_APIVER(major, minor)   (uint32_t)((major << 16) | (minor & 0xFFFF))
 HAL version number.
 
#define dsHAL_APIVER_MAJOR(x)   ((x) >> 16) & (0x7FFF)
 HAL Major version number.
 
#define dsHAL_APIVER_MINOR(x)   (x & 0xFFFF)
 HAL Minor version number.
 

Typedefs

typedef enum _dsAudioPortType_t dsAudioPortType_t
 This enumeration defines the audio port types.
 
typedef enum _dsAudioEncoding_t dsAudioEncoding_t
 This enumeration defines the audio encoding types.
 
typedef enum _dsAudioCompression_t dsAudioCompression_t
 This enumeration defines the type of audio compression.
 
typedef enum _dsAudioFormat_t dsAudioFormat_t
 This enumeration defines the type of audio format.
 
typedef enum _dsAudioDuckingAction_t dsAudioDuckingAction_t
 This enumeration defines the type of audio ducking action.
 
typedef enum _dsAudioDuckingType_t dsAudioDuckingType_t
 This enumeration defines the type of audio ducking type.
 
typedef int dsAudioCompressionValue_t
 This defines the type of audio compression that can be used.
 
typedef int dsDialogEnhancer_t
 This defines the type of dialog enhancer level that can be used.
 
typedef int dsIntelligentEqualizerMode_t
 This defines the type of dialog enhancer level that can be used.
 
typedef enum _dsAudioCapabilities_t dsAudioCapabilities_t
 Enumeration defines all of the supported Audio types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.
 
typedef enum _dsAudioARCTypes_t dsAudioARCTypes_t
 Enumeration defines all of the supported Arc types. Each bit of uint32_t represent an ARC support type. If a device multiple ARC types support, it's represented as bitwise OR of the types.
 
typedef struct _dsAudioSADList_t dsAudioSADList_t
 Structure that holds Short Audio Descriptors retrieved from connected ARC device.
 
typedef struct _dsAudioARCStatus_t dsAudioARCStatus_t
 Structure that holds ARC status for the HDMI ARC/EARC port.
 
typedef enum _dsMS12Capabilities_t dsMS12Capabilities_t
 Enumeration defines all of the supported MS12 types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.
 
typedef struct _dsMS12AudioProfileList_t dsMS12AudioProfileList_t
 
typedef struct _dsVolumeLeveller_t dsVolumeLeveller_t
 This defines the type of volume leveller mode.
 
typedef struct _dsSurroundVirtualizer_t dsSurroundVirtualizer_t
 This defines the type of surround virtualizer mode.
 
typedef enum StereoMode dsAudioStereoMode_t
 This enumeration defines the type of audio stereo mode.
 
typedef enum _dsATMOSCapability_t dsATMOSCapability_t
 This enumeration defines ATMOS protocol version types.
 
typedef enum _dsHdcpProtocolVersion_t dsHdcpProtocolVersion_t
 This enumeration defines HDCP protocol version types.
 
typedef enum _dsHdcpStatus_t dsHdcpStatus_t
 This enumeration defines all HDCP Authentication Status.
 
typedef enum _dsVideoPortType_t dsVideoPortType_t
 This enumeration defines all of the standard type of Video ports.
 
typedef enum _dsVideoResolution_t dsVideoResolution_t
 This enumeration defines all of the standard video port resolutions.
 
typedef enum _dsTVResolution_t dsTVResolution_t
 This enumeration defines all of the standard TV supported resolution with interlace information.
 
typedef enum _dsVideoFrameRate_t dsVideoFrameRate_t
 This enumeration defines all of the standard frame rates at which video may be played out of the video port.
 
typedef enum _dsVideoScanMode_t dsVideoScanMode_t
 This enumeration defines all of the standard video port scan modes.
 
typedef enum _dsVideoBackgroundColor_t dsVideoBackgroundColor_t
 This enumeration defines background color for video port.
 
typedef enum _dsVideoAspectRatio_t dsVideoAspectRatio_t
 This enumeration defines all of the standard video aspect ratios.
 
typedef enum _dsVideoStereoScopicMode_t dsVideoStereoScopicMode_t
 This enumeration defines all of the standard video Stereo Scopic modes.
 
typedef enum _dsVideoZoom_t dsVideoZoom_t
 This enumeration defines all of the standard screen zoom (format conversion) modes.
 
typedef struct _dsVideoConfig_t dsVideoConfig_t
 Structure that defines video device configuration for the output.
 
typedef struct _dsAudioTypeConfig_t dsAudioTypeConfig_t
 Structure that defines audio output device configuration.
 
typedef struct _dsVideoPortResolution_t dsVideoPortResolution_t
 Structure that defines video port resolution settings of output video device.
 
typedef struct _dsAudioPortId_t dsAudioPortId_t
 Structure that defines the audio port type and associated ID.
 
typedef struct _dsVideoPortPortId_t dsVideoPortPortId_t
 Structure that defines port id associated with video port.
 
typedef struct _dsVideoPortTypeConfig_t dsVideoPortTypeConfig_t
 Structure that defines the video output port configuration.
 
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.
 
typedef enum _dsSURROUNDMode_t dsSURROUNDMode_t
 Enumeration defines surround mode. Each bit of uint32_t represent supported surround mode.
 
typedef enum _dsMS12FEATURE_t dsMS12FEATURE_t
 Enumeration defines MS12 feature.
 
typedef struct _dsAudioPortConfig_t dsAudioPortConfig_t
 Structure that defines audio port configuration.
 
typedef struct _dsVideoPortPortConfig_t dsVideoPortPortConfig_t
 Structure that defines video port configuration settings.
 
typedef uint32_t dsFPDColor_t
 dsFPDColor_t is an 4-byte integer that is composed of RGB32 value in the following pattern:
 
typedef int32_t dsFPDIndicator_t
 dsFPDIndicator_t is an ID number that uniquely identifies a hardware LED entity on the front panel. Each MFR implementation is free to assign any number to its LEDs. The mapping of LED ID to its display name (such as "Record LED") is done outside MFR library.
 
typedef enum __dsFPDTextDisplay_t dsFPDTextDisplay_t
 This enumeration defines the FPD text display types.
 
typedef enum __dsFPDState_t dsFPDState_t
 This enumeration defines the front panel display state.
 
typedef enum __dsFPDLedState_t dsFPDLedState_t
 This enumeration defines the front panel display state.
 
typedef enum __dsFPDTimeFormat_t dsFPDTimeFormat_t
 This enumeration defines the time formats to be used in the front panel text display.
 
typedef uint32_t dsFPDBrightness_t
 Type definition for the brightness setting of a front panel indicator LED.
 
typedef enum __dsFPDMode_t dsFPDMode_t
 This enumeration defines the front panel display mode.
 
typedef struct _dsDisplayEDID_t dsDisplayEDID_t
 Structure for the EDID display.
 
typedef enum _dsSleepMode_t dsSleepMode_t
 
typedef enum _dsPowerState_t dsPowerState_t
 This enumeration defines the types of powerstate.
 
typedef enum _dsDisplayMatrixCoefficients_t dsDisplayMatrixCoefficients_t
 This enumeration defines the type of Matrix coefficients.
 
typedef enum _dsDisplayColorimetryInfo_t dsDisplayColorimetryInfo_t
 This enumeration defines the information of colorimetry.
 
typedef enum _dsDisplayColorSpace_t dsDisplayColorSpace_t
 This enumeration defines the type of display color spaces supported.
 
typedef enum _dsDisplayQuantizationRange_t dsDisplayQuantizationRange_t
 This enumeration defines the type of display quantization ranges.
 
typedef enum _dsDisplayColorDepth_t dsDisplayColorDepth_t
 This enumeration defines the type of display Color depth.
 
typedef enum _dsHdmiInPort_t dsHdmiInPort_t
 This enumeration defines the type of HDMI ports.
 
typedef enum _dsHdmiInSignalStatus_t dsHdmiInSignalStatus_t
 This enumeration defines the type of HDMI signal status.
 
typedef struct _dsHdmiInStatus_t dsHdmiInStatus_t
 Structure type for HDMI input status.
 
typedef struct _dsHdmiInCap_t dsHdmiInCap_t
 Structure type for HDMI input ARC Capability.
 
typedef enum _dsCompInSignalStatus_t dsCompInSignalStatus_t
 This enumeration defines the type composite signal status.
 
typedef enum _dsCompositeInPort_t dsCompositeInPort_t
 This enumeration defines the type of composite ports.
 
typedef struct _dsCompositeInStatus_t dsCompositeInStatus_t
 Structure type for Composite input status.
 
typedef enum tv_hdmi_edid_version_e tv_hdmi_edid_version_t
 Enum for EDID version.
 
typedef struct _dsSupportedGameFeatureList_t dsSupportedGameFeatureList_t
 Structure that captures Supported Game Features list.
 
typedef enum _dsAudioPortState dsAudioPortState_t
 This enumeration defines the Audio port state.
 
typedef enum dsAviContentType dsAviContentType_t
 This enumeration defines the AVI Content Types.
 

Enumerations

enum  _dsAudioPortType_t {
  dsAUDIOPORT_TYPE_ID_LR , dsAUDIOPORT_TYPE_HDMI , dsAUDIOPORT_TYPE_SPDIF , dsAUDIOPORT_TYPE_SPEAKER ,
  dsAUDIOPORT_TYPE_HDMI_ARC , dsAUDIOPORT_TYPE_HEADPHONE , dsAUDIOPORT_TYPE_MAX
}
 This enumeration defines the audio port types. More...
 
enum  _dsAudioEncoding_t {
  dsAUDIO_ENC_NONE = 0 , dsAUDIO_ENC_DISPLAY , dsAUDIO_ENC_PCM , dsAUDIO_ENC_AC3 ,
  dsAUDIO_ENC_EAC3 , dsAUDIO_ENC_MAX
}
 This enumeration defines the audio encoding types. More...
 
enum  _dsAudioCompression_t {
  dsAUDIO_CMP_NONE , dsAUDIO_CMP_LIGHT , dsAUDIO_CMP_MEDIUM , dsAUDIO_CMP_HEAVY ,
  dsAUDIO_CMP_MAX
}
 This enumeration defines the type of audio compression. More...
 
enum  _dsAudioFormat_t {
  dsAUDIO_FORMAT_NONE , dsAUDIO_FORMAT_PCM , dsAUDIO_FORMAT_DOLBY_AC3 , dsAUDIO_FORMAT_DOLBY_EAC3 ,
  dsAUDIO_FORMAT_DOLBY_AC4 , dsAUDIO_FORMAT_DOLBY_MAT , dsAUDIO_FORMAT_DOLBY_TRUEHD , dsAUDIO_FORMAT_DOLBY_EAC3_ATMOS ,
  dsAUDIO_FORMAT_DOLBY_TRUEHD_ATMOS , dsAUDIO_FORMAT_DOLBY_MAT_ATMOS , dsAUDIO_FORMAT_DOLBY_AC4_ATMOS , dsAUDIO_FORMAT_AAC ,
  dsAUDIO_FORMAT_VORBIS , dsAUDIO_FORMAT_WMA , dsAUDIO_FORMAT_UNKNOWN , dsAUDIO_FORMAT_MAX
}
 This enumeration defines the type of audio format. More...
 
enum  _dsAudioDuckingAction_t { dsAUDIO_DUCKINGACTION_START , dsAUDIO_DUCKINGACTION_STOP }
 This enumeration defines the type of audio ducking action. More...
 
enum  _dsAudioDuckingType_t { dsAUDIO_DUCKINGTYPE_ABSOLUTE , dsAUDIO_DUCKINGTYPE_RELATIVE }
 This enumeration defines the type of audio ducking type. More...
 
enum  _dsAudioCapabilities_t {
  dsAUDIOSUPPORT_NONE = 0x0 , dsAUDIOSUPPORT_ATMOS = 0x01 , dsAUDIOSUPPORT_DD = 0x02 , dsAUDIOSUPPORT_DDPLUS = 0x04 ,
  dsAUDIOSUPPORT_DAD = 0x08 , dsAUDIOSUPPORT_DAPv2 = 0x10 , dsAUDIOSUPPORT_MS12 = 0x20 , dsAUDIOSUPPORT_MS12V2 = 0x40 ,
  dsAUDIOSUPPORT_Invalid = 0x80
}
 Enumeration defines all of the supported Audio types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards. More...
 
enum  _dsAudioARCTypes_t { dsAUDIOARCSUPPORT_NONE = 0x0 , dsAUDIOARCSUPPORT_ARC = 0x01 , dsAUDIOARCSUPPORT_eARC = 0x02 }
 Enumeration defines all of the supported Arc types. Each bit of uint32_t represent an ARC support type. If a device multiple ARC types support, it's represented as bitwise OR of the types. More...
 
enum  _dsMS12Capabilities_t {
  dsMS12SUPPORT_NONE = 0x0 , dsMS12SUPPORT_DolbyVolume = 0x01 , dsMS12SUPPORT_InteligentEqualizer = 0x02 , dsMS12SUPPORT_DialogueEnhancer = 0x04 ,
  dsMS12SUPPORT_Invalid = 0x80
}
 Enumeration defines all of the supported MS12 types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards. More...
 
enum  StereoMode {
  dsAUDIO_STEREO_UNKNOWN , dsAUDIO_STEREO_MONO = 1 , dsAUDIO_STEREO_STEREO , dsAUDIO_STEREO_SURROUND ,
  dsAUDIO_STEREO_PASSTHRU , dsAUDIO_STEREO_DD , dsAUDIO_STEREO_DDPLUS , dsAUDIO_STEREO_MAX
}
 This enumeration defines the type of audio stereo mode. More...
 
enum  _dsATMOSCapability_t { dsAUDIO_ATMOS_NOTSUPPORTED = 0 , dsAUDIO_ATMOS_DDPLUSSTREAM , dsAUDIO_ATMOS_ATMOSMETADATA }
 This enumeration defines ATMOS protocol version types. More...
 
enum  _dsHdcpProtocolVersion_t { dsHDCP_VERSION_1X = 0 , dsHDCP_VERSION_2X , dsHDCP_VERSION_MAX }
 This enumeration defines HDCP protocol version types. More...
 
enum  _dsHdcpStatus_t {
  dsHDCP_STATUS_UNPOWERED = 0 , dsHDCP_STATUS_UNAUTHENTICATED , dsHDCP_STATUS_AUTHENTICATED , dsHDCP_STATUS_AUTHENTICATIONFAILURE ,
  dsHDCP_STATUS_INPROGRESS , dsHDCP_STATUS_PORTDISABLED , dsHDCP_STATUS_MAX
}
 This enumeration defines all HDCP Authentication Status. More...
 
enum  _dsVideoPortType_t {
  dsVIDEOPORT_TYPE_RF = 0 , dsVIDEOPORT_TYPE_BB , dsVIDEOPORT_TYPE_SVIDEO , dsVIDEOPORT_TYPE_1394 ,
  dsVIDEOPORT_TYPE_DVI , dsVIDEOPORT_TYPE_COMPONENT , dsVIDEOPORT_TYPE_HDMI , dsVIDEOPORT_TYPE_HDMI_INPUT ,
  dsVIDEOPORT_TYPE_INTERNAL , dsVIDEOPORT_TYPE_SCART , dsVIDEOPORT_TYPE_MAX
}
 This enumeration defines all of the standard type of Video ports. More...
 
enum  _dsVideoResolution_t {
  dsVIDEO_PIXELRES_720x480 , dsVIDEO_PIXELRES_720x576 , dsVIDEO_PIXELRES_1280x720 , dsVIDEO_PIXELRES_1920x1080 ,
  dsVIDEO_PIXELRES_3840x2160 , dsVIDEO_PIXELRES_4096x2160 , dsVIDEO_PIXELRES_MAX
}
 This enumeration defines all of the standard video port resolutions. More...
 
enum  _dsTVResolution_t {
  dsTV_RESOLUTION_480i = 0x00001 , dsTV_RESOLUTION_480p = 0x00002 , dsTV_RESOLUTION_576i = 0x00004 , dsTV_RESOLUTION_576p = 0x00008 ,
  dsTV_RESOLUTION_576p50 = 0x00010 , dsTV_RESOLUTION_720p = 0x00020 , dsTV_RESOLUTION_720p50 = 0x00040 , dsTV_RESOLUTION_1080i = 0x00080 ,
  dsTV_RESOLUTION_1080p = 0x00100 , dsTV_RESOLUTION_1080p24 = 0x00200 , dsTV_RESOLUTION_1080i25 = 0x00400 , dsTV_RESOLUTION_1080p30 = 0x00800 ,
  dsTV_RESOLUTION_1080i50 = 0x01000 , dsTV_RESOLUTION_1080p50 = 0x02000 , dsTV_RESOLUTION_1080p60 = 0x04000 , dsTV_RESOLUTION_2160p30 = 0x08000 ,
  dsTV_RESOLUTION_2160p50 = 0x10000 , dsTV_RESOLUTION_2160p60 = 0x20000
}
 This enumeration defines all of the standard TV supported resolution with interlace information. More...
 
enum  _dsVideoFrameRate_t {
  dsVIDEO_FRAMERATE_UNKNOWN , dsVIDEO_FRAMERATE_24 , dsVIDEO_FRAMERATE_25 , dsVIDEO_FRAMERATE_30 ,
  dsVIDEO_FRAMERATE_60 , dsVIDEO_FRAMERATE_23dot98 , dsVIDEO_FRAMERATE_29dot97 , dsVIDEO_FRAMERATE_50 ,
  dsVIDEO_FRAMERATE_59dot94 , dsVIDEO_FRAMERATE_MAX
}
 This enumeration defines all of the standard frame rates at which video may be played out of the video port. More...
 
enum  _dsVideoScanMode_t { dsVIDEO_SCANMODE_INTERLACED , dsVIDEO_SCANMODE_PROGRESSIVE , dsVIDEO_SCANMODE_MAX }
 This enumeration defines all of the standard video port scan modes. More...
 
enum  _dsVideoBackgroundColor_t { dsVIDEO_BGCOLOR_BLUE , dsVIDEO_BGCOLOR_BLACK , dsVIDEO_BGCOLOR_NONE , dsVIDEO_BGCOLOR_MAX }
 This enumeration defines background color for video port. More...
 
enum  _dsVideoAspectRatio_t { dsVIDEO_ASPECT_RATIO_4x3 , dsVIDEO_ASPECT_RATIO_16x9 , dsVIDEO_ASPECT_RATIO_MAX }
 This enumeration defines all of the standard video aspect ratios. More...
 
enum  _dsVideoStereoScopicMode_t {
  dsVIDEO_SSMODE_UNKNOWN = 0 , dsVIDEO_SSMODE_2D , dsVIDEO_SSMODE_3D_SIDE_BY_SIDE , dsVIDEO_SSMODE_3D_TOP_AND_BOTTOM ,
  dsVIDEO_SSMODE_MAX
}
 This enumeration defines all of the standard video Stereo Scopic modes. More...
 
enum  _dsVideoZoom_t {
  dsVIDEO_ZOOM_UNKNOWN = -1 , dsVIDEO_ZOOM_NONE = 0 , dsVIDEO_ZOOM_FULL , dsVIDEO_ZOOM_LB_16_9 ,
  dsVIDEO_ZOOM_LB_14_9 , dsVIDEO_ZOOM_CCO , dsVIDEO_ZOOM_PAN_SCAN , dsVIDEO_ZOOM_LB_2_21_1_ON_4_3 ,
  dsVIDEO_ZOOM_LB_2_21_1_ON_16_9 , dsVIDEO_ZOOM_PLATFORM , dsVIDEO_ZOOM_16_9_ZOOM , dsVIDEO_ZOOM_PILLARBOX_4_3 ,
  dsVIDEO_ZOOM_WIDE_4_3 , dsVIDEO_ZOOM_MAX
}
 This enumeration defines all of the standard screen zoom (format conversion) modes. More...
 
enum  _dsHDRStandard_t {
  dsHDRSTANDARD_NONE = 0x0 , dsHDRSTANDARD_HDR10 = 0x01 , dsHDRSTANDARD_HLG = 0x02 , dsHDRSTANDARD_DolbyVision = 0x04 ,
  dsHDRSTANDARD_TechnicolorPrime = 0x08 , dsHDRSTANDARD_HDR10PLUS = 0x10 , dsHDRSTANDARD_SDR = 0x20 , dsHDRSTANDARD_Invalid = 0x80
}
 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. More...
 
enum  _dsSURROUNDMode_t { dsSURROUNDMODE_NONE = 0x0 , dsSURROUNDMODE_DD = 0x1 , dsSURROUNDMODE_DDPLUS = 0x2 }
 Enumeration defines surround mode. Each bit of uint32_t represent supported surround mode. More...
 
enum  _dsMS12FEATURE_t { dsMS12FEATURE_DAPV2 = 0x0 , dsMS12FEATURE_DE = 0x1 , dsMS12FEATURE_MAX = 0x2 }
 Enumeration defines MS12 feature. More...
 
enum  __dsFPDTextDisplay_t { dsFPD_TEXTDISP_TEXT , dsFPD_TEXTDISP_MAX }
 This enumeration defines the FPD text display types. More...
 
enum  __dsFPDState_t { dsFPD_STATE_OFF =0 , dsFPD_STATE_ON }
 This enumeration defines the front panel display state. More...
 
enum  __dsFPDLedState_t {
  dsFPD_LED_DEVICE_NONE = 0 , dsFPD_LED_DEVICE_ACTIVE = 1 , dsFPD_LED_DEVICE_STANDBY = 2 , dsFPD_LED_DEVICE_WPS_CONNECTING = 3 ,
  dsFPD_LED_DEVICE_WPS_CONNECTED = 4 , dsFPD_LED_DEVICE_WPS_ERROR = 5 , dsFPD_LED_DEVICE_FACTORY_RESET = 6 , dsFPD_LED_DEVICE_USB_UPGRADE = 7 ,
  dsFPD_LED_DEVICE_SOFTWARE_DOWNLOAD_ERROR = 8 , dsFPD_LED_DEVICE_MAX
}
 This enumeration defines the front panel display state. More...
 
enum  __dsFPDTimeFormat_t { dsFPD_TIME_12_HOUR , dsFPD_TIME_24_HOUR , dsFPD_TIME_STRING }
 This enumeration defines the time formats to be used in the front panel text display. More...
 
enum  __dsFPDMode_t { dsFPD_MODE_ANY = 0 , dsFPD_MODE_TEXT , dsFPD_MODE_CLOCK }
 This enumeration defines the front panel display mode. More...
 
enum  _dsSleepMode_t { dsHOST_SLEEP_MODE_LIGHT , dsHOST_SLEEP_MODE_DEEP , dsHOST_SLEEP_MODE_MAX }
 
enum  _dsPowerState_t { dsPOWER_ON =1 , dsPOWER_STANDBY , dsPOWER_OFF }
 This enumeration defines the types of powerstate. More...
 
enum  _dsDisplayMatrixCoefficients_t {
  dsDISPLAY_MATRIXCOEFFICIENT_UNKNOWN = 0 , dsDISPLAY_MATRIXCOEFFICIENT_BT_709 , dsDISPLAY_MATRIXCOEFFICIENT_BT_470_2_BG , dsDISPLAY_MATRIXCOEFFICIENT_SMPTE_170M ,
  dsDISPLAY_MATRIXCOEFFICIENT_XvYCC_709 , dsDISPLAY_MATRIXCOEFFICIENT_eXvYCC_601 , dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_NCL , dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_CL ,
  dsDISPLAY_MATRIXCOEFFICIENT_eDVI_FR_RGB , dsDISPLAY_MATRIXCOEFFICIENT_eHDMI_RGB , dsDISPLAY_MATRIXCOEFFICIENT_eFCC , dsDISPLAY_MATRIXCOEFFICIENT_eSMPTE_240M ,
  dsDISPLAY_MATRIXCOEFFICIENT_eHDMI_FR_YCbCr
}
 This enumeration defines the type of Matrix coefficients. More...
 
enum  _dsDisplayColorimetryInfo_t {
  dsDISPLAY_COLORIMETRY_INFO_UNKNOWN = 0 , dsDISPLAY_COLORIMETRY_INFO_XVYCC601 = 0x01 , dsDISPLAY_COLORIMETRY_INFO_XVYCC709 = 0x02 , dsDISPLAY_COLORIMETRY_INFO_SYCC601 = 0x04 ,
  dsDISPLAY_COLORIMETRY_INFO_ADOBEYCC601 = 0x08 , dsDISPLAY_COLORIMETRY_INFO_ADOBERGB = 0x10 , dsDISPLAY_COLORIMETRY_INFO_BT2020CL = 0x20 , dsDISPLAY_COLORIMETRY_INFO_BT2020NCL = 0x40 ,
  dsDISPLAY_COLORIMETRY_INFO_BT2020RGB = 0x80 , dsDISPLAY_COLORIMETRY_INFO_DCI_P3 = 0x100
}
 This enumeration defines the information of colorimetry. More...
 
enum  _dsDisplayColorSpace_t {
  dsDISPLAY_COLORSPACE_UNKNOWN = 0 , dsDISPLAY_COLORSPACE_RGB = 1 , dsDISPLAY_COLORSPACE_YCbCr422 = 2 , dsDISPLAY_COLORSPACE_YCbCr444 = 3 ,
  dsDISPLAY_COLORSPACE_YCbCr420 = 4 , dsDISPLAY_COLORSPACE_AUTO = 5
}
 This enumeration defines the type of display color spaces supported. More...
 
enum  _dsDisplayQuantizationRange_t { dsDISPLAY_QUANTIZATIONRANGE_UNKNOWN = 0 , dsDISPLAY_QUANTIZATIONRANGE_LIMITED = 1 , dsDISPLAY_QUANTIZATIONRANGE_FULL = 2 }
 This enumeration defines the type of display quantization ranges. More...
 
enum  _dsDisplayColorDepth_t {
  dsDISPLAY_COLORDEPTH_UNKNOWN = 0x0 , dsDISPLAY_COLORDEPTH_8BIT = 0x01 , dsDISPLAY_COLORDEPTH_10BIT = 0x02 , dsDISPLAY_COLORDEPTH_12BIT = 0x04 ,
  dsDISPLAY_COLORDEPTH_AUTO = 0x08
}
 This enumeration defines the type of display Color depth. More...
 
enum  _dsHdmiInPort_t {
  dsHDMI_IN_PORT_NONE = -1 , dsHDMI_IN_PORT_0 , dsHDMI_IN_PORT_1 , dsHDMI_IN_PORT_2 ,
  dsHDMI_IN_PORT_MAX
}
 This enumeration defines the type of HDMI ports. More...
 
enum  _dsHdmiInSignalStatus_t {
  dsHDMI_IN_SIGNAL_STATUS_NONE = -1 , dsHDMI_IN_SIGNAL_STATUS_NOSIGNAL , dsHDMI_IN_SIGNAL_STATUS_UNSTABLE , dsHDMI_IN_SIGNAL_STATUS_NOTSUPPORTED ,
  dsHDMI_IN_SIGNAL_STATUS_STABLE , dsHDMI_IN_SIGNAL_STATUS_MAX
}
 This enumeration defines the type of HDMI signal status. More...
 
enum  _dsCompInSignalStatus_t {
  dsCOMP_IN_SIGNAL_STATUS_NONE = -1 , dsCOMP_IN_SIGNAL_STATUS_NOSIGNAL , dsCOMP_IN_SIGNAL_STATUS_UNSTABLE , dsCOMP_IN_SIGNAL_STATUS_NOTSUPPORTED ,
  dsCOMP_IN_SIGNAL_STATUS_STABLE , dsCOMP_IN_SIGNAL_STATUS_MAX
}
 This enumeration defines the type composite signal status. More...
 
enum  _dsCompositeInPort_t { dsCOMPOSITE_IN_PORT_NONE = -1 , dsCOMPOSITE_IN_PORT_0 , dsCOMPOSITE_IN_PORT_1 , dsCOMPOSITE_IN_PORT_MAX }
 This enumeration defines the type of composite ports. More...
 
enum  dsVideoCodingFormat_t { dsVIDEO_CODEC_MPEGHPART2 = (0x01 << 0) , dsVIDEO_CODEC_MPEG4PART10 = (0x01 << 1) , dsVIDEO_CODEC_MPEG2 = (0x01 << 2) }
 List of video compression formats that may be supported by the decoder. More...
 
enum  dsVideoCodecHevcProfiles_t { dsVIDEO_CODEC_HEVC_PROFILE_MAIN = (0x01 << 0) , dsVIDEO_CODEC_HEVC_PROFILE_MAIN10 = (0x01 << 1) , dsVIDEO_CODEC_HEVC_PROFILE_MAINSTILLPICTURE = (0x01 << 2) }
 List of HEVC Profiles. More...
 
enum  tv_hdmi_edid_version_e { HDMI_EDID_VER_14 = 0 , HDMI_EDID_VER_20 , HDMI_EDID_VER_MAX }
 Enum for EDID version. More...
 
enum  _dsAudioPortState { dsAUDIOPORT_STATE_UNINITIALIZED , dsAUDIOPORT_STATE_INITIALIZED , dsAUDIOPORT_STATE_MAX }
 This enumeration defines the Audio port state. More...
 
enum  dsAviContentType {
  dsAVICONTENT_TYPE_GRAPHICS , dsAVICONTENT_TYPE_PHOTO , dsAVICONTENT_TYPE_CINEMA , dsAVICONTENT_TYPE_GAME ,
  dsAVICONTENT_TYPE_INVALID
}
 This enumeration defines the AVI Content Types. More...
 

Detailed Description

HAL types.

This API defines common types used by the HAL.

Document
Document reference.
Open Issues (in no particular order)
  1. None
Assumptions
  1. None
Abbreviations
  • BE: Big-Endian.
  • cb: Callback function (suffix).
  • DS: Device Settings.
  • FPD: Front-Panel Display.
  • HAL: Hardware Abstraction Layer.
  • LE: Little-Endian.
  • LS: Least Significant.
  • MBZ: Must be zero.
  • MS: Most Significant.
  • RDK: Reference Design Kit.
  • _t: Type (suffix).
Implementation Notes
  1. None