RDK Documentation (Open Sourced RDK Components)

Description

Described herein are the DeviceSettings HAL types and functions that are part of the Video Device subsystem. The Video Device subsystem manages video decoder hardware operations.

Functions

dsError_t dsVideoDeviceInit ()
 This function initialize all the video devices in the system. More...
 
dsError_t dsGetVideoDevice (int index, intptr_t *handle)
 This function gets the handle for the video device requested. More...
 
dsError_t dsSetDFC (intptr_t handle, dsVideoZoom_t dfc)
 This function is used to set the screen zoom mode (decoder format conversion). This function sets the screen zoom mode (Pan & Scan, LetterBox, PillarBox, etc.) for the specified video device. More...
 
dsError_t dsGetDFC (intptr_t handle, dsVideoZoom_t *dfc)
 This function is used to get the screen zoom mode (decoder format conversion). This function Gets the screen zoom mode (None,Full ,Pan & Scan, LetterBox, PillarBox, etc.) for the specified video device. More...
 
dsError_t dsVideoDeviceTerm ()
 This function deinitialize all the video devices in the system. It reset any data structures used within this module and release any handles specific to the video devices. More...
 
dsError_t dsGetHDRCapabilities (intptr_t handle, int *capabilities)
 To find the HDR capabilities of SoC. More...
 
dsError_t dsGetSupportedVideoCodingFormats (intptr_t handle, unsigned int *supported_formats)
 To find the Video formats supported by the SoC. More...
 
dsError_t dsGetVideoCodecInfo (intptr_t handle, dsVideoCodingFormat_t codec, dsVideoCodecInfo_t *info)
 This API is used to get the video codec information. More...
 
dsError_t dsForceDisableHDRSupport (intptr_t handle, bool disable)
 

Function Documentation

◆ dsVideoDeviceInit()

dsError_t dsVideoDeviceInit ( )

This function initialize all the video devices in the system.

Returns
dsError_t
Return values
dsERR_NONEIf sucessfully dsVideoDeviceInit api has been called using IARM support.
dsERR_GENERALGeneral failure.

Definition at line 46 of file dsVideoDevice.c.

◆ dsGetVideoDevice()

dsError_t dsGetVideoDevice ( int  index,
intptr_t *  handle 
)

This function gets the handle for the video device requested.

Parameters
[in]indexIndex of video device (0, 1, ...).
[out]handleThe address of a location to hold the video device handle on return.
Returns
dsError_t
Return values
dsERR_NONEIf sucessfully dsGetVideoDevice api has been called using IARM support.
dsERR_GENERALGeneral failure.

Definition at line 64 of file dsVideoDevice.c.

◆ dsSetDFC()

dsError_t dsSetDFC ( intptr_t  handle,
dsVideoZoom_t  dfc 
)

This function is used to set the screen zoom mode (decoder format conversion). This function sets the screen zoom mode (Pan & Scan, LetterBox, PillarBox, etc.) for the specified video device.

Parameters
[in]handleHandle of the video output port.
[in]dfcType of zoom mode to be used.
Returns
dsError_t
Return values
dsERR_NONEIf sucessfully dsSetDFC api has been called using IARM support.
dsERR_GENERALGeneral failure.

Definition at line 89 of file dsVideoDevice.c.

◆ dsGetDFC()

dsError_t dsGetDFC ( intptr_t  handle,
dsVideoZoom_t dfc 
)

This function is used to get the screen zoom mode (decoder format conversion). This function Gets the screen zoom mode (None,Full ,Pan & Scan, LetterBox, PillarBox, etc.) for the specified video device.

Parameters
[in]handleHandle of the video output port.
[in]dfcType of zoom mode to be used.
Returns
dsError_t
Return values
dsERR_NONEIf sucessfully dsGetDFC api has been called using IARM support.
dsERR_GENERALGeneral failure.

Definition at line 117 of file dsVideoDevice.c.

◆ dsVideoDeviceTerm()

dsError_t dsVideoDeviceTerm ( )

This function deinitialize all the video devices in the system. It reset any data structures used within this module and release any handles specific to the video devices.

Returns
dsError_t
Return values
dsERR_NONEIf sucessfully dsVideoDeviceTerm has been called using IARM support.
dsERR_GENERALGeneral failure.

Definition at line 144 of file dsVideoDevice.c.

◆ dsGetHDRCapabilities()

dsError_t dsGetHDRCapabilities ( intptr_t  handle,
int *  capabilities 
)

To find the HDR capabilities of SoC.

This function is used to check which HDR capabilities the SoC supports

Parameters
[in]handleHandle for the video device (video decoder)
[out]*capabilitiesOR-ed value of supported HDR standards.
Returns
dsError_t Error code.

Definition at line 162 of file dsVideoDevice.c.

◆ dsGetSupportedVideoCodingFormats()

dsError_t dsGetSupportedVideoCodingFormats ( intptr_t  handle,
unsigned int *  supported_formats 
)

To find the Video formats supported by the SoC.

This function is used to check which video formats the SoC supports

Parameters
[in]handleHandle for the video device (video decoder)
[out]supported_formatsOR-ed value of supported video codec formats.
Returns
dsError_t Error code.

Definition at line 183 of file dsVideoDevice.c.

◆ dsGetVideoCodecInfo()

dsError_t dsGetVideoCodecInfo ( intptr_t  handle,
dsVideoCodingFormat_t  codec,
dsVideoCodecInfo_t info 
)

This API is used to get the video codec information.

Parameters
[in]handleHandle for the video device (video decoder)
[in]codecOR-ed value of supported video codec formats.
[out]infoVideo codec information like profile, level etc.
Returns
dsError_t Error code.

Definition at line 203 of file dsVideoDevice.c.