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

Device Settings HAL Video Port Public API. This API defines the HAL for the Device Settings Video Port interface. More...

#include "dsError.h"
#include "dsTypes.h"
Include dependency graph for dsVideoPort.h:

Go to the source code of this file.

Typedefs

typedef void(* dsVideoFormatUpdateCB_t) (dsHDRStandard_t videoFormat)
 Callback function used to notify applications of Video Format change.
 
typedef void(* dsHDCPStatusCallback_t) (intptr_t handle, dsHdcpStatus_t status)
 Callback function to notify the HDCP status change.
 

Functions

dsError_t dsVideoPortInit ()
 Initializes the underlying Video Port sub-system.
 
dsError_t dsGetVideoPort (dsVideoPortType_t type, int index, intptr_t *handle)
 Gets the handle for video port requested.
 
dsError_t dsIsVideoPortEnabled (intptr_t handle, bool *enabled)
 Checks whether a video port is enabled or not.
 
dsError_t dsIsDisplayConnected (intptr_t handle, bool *connected)
 Checks whether the specific video port is connected to display.
 
dsError_t dsIsDisplaySurround (intptr_t handle, bool *surround)
 Checks if the connected display supports the audio surround.
 
dsError_t dsGetSurroundMode (intptr_t handle, int *surround)
 Gets the surround mode of video port.
 
dsError_t dsIsVideoPortActive (intptr_t handle, bool *active)
 Checks whether a video port is active or not.
 
dsError_t dsEnableDTCP (intptr_t handle, bool contentProtect)
 Enables/Disables the DTCP of a video port.
 
dsError_t dsEnableHDCP (intptr_t handle, bool contentProtect, char *hdcpKey, size_t keySize)
 Enables/Disables the HDCP of a video port.
 
dsError_t dsIsDTCPEnabled (intptr_t handle, bool *pContentProtected)
 Indicates whether a video port is DTCP protected.
 
dsError_t dsIsHDCPEnabled (intptr_t handle, bool *pContentProtected)
 Indicates whether a video port is HDCP protected.
 
dsError_t dsEnableVideoPort (intptr_t handle, bool enabled)
 Enables/Disables a video port.
 
dsError_t dsSetResolution (intptr_t handle, dsVideoPortResolution_t *resolution, bool persist)
 Sets the display resolution of specified video port.
 
dsError_t dsGetResolution (intptr_t handle, dsVideoPortResolution_t *resolution)
 Gets the display resolution of specified video port.
 
dsError_t dsSetActiveSource (intptr_t handle)
 Sets the specified video port as active source.
 
dsError_t dsVideoPortTerm ()
 Terminates the underlying Video Port sub-system.
 
dsError_t dsInitResolution (dsVideoPortResolution_t *)
 Initialize the Video Resolution.
 
dsError_t dsRegisterHdcpStatusCallback (intptr_t handle, dsHDCPStatusCallback_t cb)
 Callback Registration for the HDCP status change event.
 
dsError_t dsGetHDCPStatus (intptr_t handle, dsHdcpStatus_t *status)
 Gets the current HDCP status of the specified video port.
 
dsError_t dsGetHDCPProtocol (intptr_t handle, dsHdcpProtocolVersion_t *protocolVersion)
 Gets the HDCP protocol version of the device.
 
dsError_t dsGetHDCPReceiverProtocol (intptr_t handle, dsHdcpProtocolVersion_t *protocolVersion)
 Gets the HDCP protocol version of the connected sink device.
 
dsError_t dsGetHDCPCurrentProtocol (intptr_t handle, dsHdcpProtocolVersion_t *protocolVersion)
 Gets the current negotiated HDCP protocol version.
 
dsError_t dsGetTVHDRCapabilities (intptr_t handle, int *capabilities)
 Gets the HDR capabilities of the TV/display device.
 
dsError_t dsSupportedTvResolutions (intptr_t handle, int *resolutions)
 Gets the supported resolutions of TV.
 
dsError_t dsSetForceDisable4KSupport (intptr_t handle, bool disable)
 Sets ForceDisable 4K support variable.
 
dsError_t dsGetForceDisable4KSupport (intptr_t handle, bool *disable)
 Gets ForceDisable 4K support variable.
 
dsError_t dsSetScartParameter (intptr_t handle, const char *parameter_str, const char *value_str)
 Sets various SCART parameters.
 
dsError_t dsGetVideoEOTF (intptr_t handle, dsHDRStandard_t *video_eotf)
 Gets the current video Electro-Optical Transfer Function (EOT) value.
 
dsError_t dsGetMatrixCoefficients (intptr_t handle, dsDisplayMatrixCoefficients_t *matrix_coefficients)
 Gets the current matrix coefficients value.
 
dsError_t dsGetColorDepth (intptr_t handle, unsigned int *color_depth)
 Gets the color depth value of specified video port.
 
dsError_t dsGetColorSpace (intptr_t handle, dsDisplayColorSpace_t *color_space)
 Gets the color space setting of specified video port.
 
dsError_t dsGetQuantizationRange (intptr_t handle, dsDisplayQuantizationRange_t *quantization_range)
 Gets the quantization range of specified video port.
 
dsError_t dsGetCurrentOutputSettings (intptr_t handle, dsHDRStandard_t *video_eotf, dsDisplayMatrixCoefficients_t *matrix_coefficients, dsDisplayColorSpace_t *color_space, unsigned int *color_depth, dsDisplayQuantizationRange_t *quantization_range)
 Gets current color space setting, color depth, matrix coefficients, video Electro-Optical Transfer Function (EOT) and quantization range in one call of the specified video port.
 
dsError_t dsIsOutputHDR (intptr_t handle, bool *hdr)
 Checks if video output is HDR or not.
 
dsError_t dsResetOutputToSDR ()
 Resets Video Output to SDR.
 
dsError_t dsSetHdmiPreference (intptr_t handle, dsHdcpProtocolVersion_t *hdcpCurrentProtocol)
 Sets the preferred HDMI Protocol of the specified video port.
 
dsError_t dsGetHdmiPreference (intptr_t handle, dsHdcpProtocolVersion_t *hdcpCurrentProtocol)
 Gets the preferred HDMI Protocol version of specified video port.
 
dsError_t dsGetIgnoreEDIDStatus (intptr_t handle, bool *status)
 Gets the IgnoreEDID status variable set in the device.
 
dsError_t dsSetBackgroundColor (intptr_t handle, dsVideoBackgroundColor_t color)
 Sets the background color of the specified video port.
 
dsError_t dsSetForceHDRMode (intptr_t handle, dsHDRStandard_t mode)
 Sets/Resets the force HDR mode.
 
dsError_t dsColorDepthCapabilities (intptr_t handle, unsigned int *colorDepthCapability)
 Gets the color depth capabilities of the specified video port.
 
dsError_t dsGetPreferredColorDepth (intptr_t handle, dsDisplayColorDepth_t *colorDepth, bool persist)
 Gets the preferred color depth values.
 
dsError_t dsSetPreferredColorDepth (intptr_t handle, dsDisplayColorDepth_t colorDepth, bool persist)
 Sets the preferred color depth for the specified video port.
 

Detailed Description

Device Settings HAL Video Port Public API. This API defines the HAL for the Device Settings Video Port interface.

Document
Document reference.
Open Issues (in no particular order)
  1. None
Assumptions
  1. None
Abbreviations
  • HAL: Hardware Abstraction Layer
  • API: Caller Programming Interface
  • Caller: Any user of the interface via the APIs
  • CPU: Central Processing Unit
  • DS: Device Settings
  • SoC: System on Chip
  • HDMI: High-Definition Multimedia Interface
  • DTCP: Digital Transmission Content Protection
  • HDCP: High-bandwidth Digital Content Protection
  • HDR: High Dynamic Range
  • SDR: Standard Dynamic Range
  • SCART: Syndicat des Constructeurs d'Appareils Radiorécepteurs et Téléviseurs - Radio and Television Receiver Manufacturers' Association
  • EDID: Extended Display Identification Data
Implementation Notes
  1. None