Collaboration diagram for TV Settings Header:

Data Structures
struct	pic_modes

struct	tvVideoFormatCallbackData

struct	tvVideoContentCallbackData

struct	getWBInfo

struct	bl_para_s

struct	tvBacklightInfo_s

struct	tvVideoResolutionCallbackData

struct	tvVideoFrameRateCallbackData

Macros
#define	MAX_STRING_SIZE (15)

#define	CONTROL_COUNT (2)

#define	PIC_MODES_SUPPORTED_MAX (15)

#define	PIC_MODE_NAME_MAX (25)

#define	DIMMING_MODE_NAME_SIZE (25)

#define	DIMMING_MODE_MAX (10)

#define	GAIN_MIN (0)

#define	GAIN_MAX (2047)

#define	OFFSET_MIN (-1024)

#define	OFFSET_MAX (1024)

#define	BACKLIGHT_CURVE_MAX_INDEX (101)

#define	EXPECTED_FILE_SIZE (512)

#define	GENERIC_MODE_CONFIG_FILE "/etc/tv/allmodes.conf"

#define	__BL_PARA__

Typedefs
typedef void(*	tvVideoFormatChangeCB) (tvVideoHDRFormat_t format, void *userData)

typedef void(*	tvVideoContentChangeCB) (tvContentType_t mode, void *userData)

typedef struct pic_modes	pic_modes_t

typedef enum input_source_offset_e	input_source_offset_t

typedef struct getWBInfo	getWBInfo_t

typedef struct bl_para_s	bl_para_t

typedef struct tvBacklightInfo_s	tvBacklightInfo_t

typedef void(*	tvVideoResolutionChangeCB) (tvResolutionParam_t resolutionStruct, void *userData)
	tv Video Resolution ChangeCB

typedef void(*	tvVideoFrameRateChangeCB) (tvVideoFrameRate_t frameRate, void *userData)
	tv Video FrameRate Change CB

Enumerations
enum	fp_mfrColorTemp_t { mfrColorTemp_STANDARD = 0 , mfrColorTemp_COLD , mfrColorTemp_WARM , mfrColorTemp_USER , mfrColorTemp_MAX }

enum	input_source_offset_e { HDMI_OFFSET_NEW = 0 , TV_OFFSET_NEW = 4 , AV_OFFSET_NEW = 8 , MAX_OFFSET_NEW }

Functions
tvError_t	tvInit ()
	Initialises TV Settings HAL.

tvError_t	tvSD3toCriSyncInit ()
	Sync the calibrated data to driver.

tvError_t	tvTerm ()
	De-initialises TV Settings HAL.

tvError_t	GetTVPictureMode (char *pictureMode)
	Gets the current selected picture Mode.

tvError_t	SetTVPictureMode (const char *pictureMode)
	Sets the Picture Mode.

tvError_t	GetBacklight (int *backlight)
	Gets the current backlight value.

tvError_t	SetBacklight (int backlight)
	Sets the backlight value in the backlight hardware.

tvError_t	SetBrightness (int brightness)
	Sets the brightness value to driver register(s)

tvError_t	GetBrightness (int *brightness)
	Gets the current brightness value.

tvError_t	SetContrast (int contrast)
	Sets the contrast value to driver register(s)

tvError_t	GetContrast (int *contrast)
	Gets the current contrast value.

tvError_t	SetSharpness (int sharpness)
	Sets the sharpness value to driver register(s)

tvError_t	GetSharpness (int *sharpness)
	Gets the current sharpness value.

tvError_t	SetSaturation (int saturation)
	Sets the saturation value to driver register(s)

tvError_t	GetSaturation (int *saturation)
	Gets the current saturation value.

tvError_t	SetHue (int hue)
	Sets the hue value to driver register(s)

tvError_t	GetHue (int *hue)
	Gets the current hue value.

tvError_t	SetColorTemperature (tvColorTemp_t colorTemp)
	Sets the color temperature to driver register(s)

tvError_t	GetColorTemperature (tvColorTemp_t *colorTemp)
	Gets the current color temperature.

tvError_t	SetAspectRatio (tvDisplayMode_t dispMode)
	Sets the aspect ratio.

tvError_t	GetAspectRatio (tvDisplayMode_t *dispMode)
	Gets the current aspect ratio.

tvError_t	GetTint (int *tint)
	Gets the current tint value.

tvError_t	SetTint (int tint)
	Sets the tint value to driver register(s)

tvError_t	GetSupportedBacklightModes (int *blModes)
	Gets the supported backlight modes.

tvError_t	GetCurrentBacklightMode (tvBacklightMode_t *blMode)
	Gets current blacklight mode.

tvError_t	SetCurrentBacklightMode (tvBacklightMode_t blMode)
	Sets the backlight mode.

tvError_t	GetCurrentVideoFormat (tvVideoHDRFormat_t *format)
	Gets current video format. To be deprecated soon.

tvError_t	GetVideoResolution (tvResolutionParam_t *res)
	Gets the current video resolution.

tvError_t	GetVideoFrameRate (tvVideoFrameRate_t *format)
	Gets current video framerate.

tvError_t	setWakeupConfig (const tvWakeupSrcType_t src_type, const bool value)
	Sets wake-up configuration.

tvError_t	SetRGBPattern (int r, int g, int b)
	Sets the RGB values of RGB pattern.

tvError_t	GetRGBPattern (int r, int g, int *b)
	Gets the current RGB values of the RGB pattern.

tvError_t	SetGrayPattern (int YUVValue)
	Sets the gray pattern value.

tvError_t	GetGrayPattern (int *YUVValue)
	Gets the current gray pattern value.

tvError_t	SetColorTemp_Rgain (tvColorTemp_t colorTemp, int rgain)
	Set the rgain value.

tvError_t	GetColorTemp_Rgain (tvColorTemp_t colorTemp, int *rgain)
	Get the ggain value.

tvError_t	SetColorTemp_Ggain (tvColorTemp_t colorTemp, int ggain)
	Set the ggain value.

tvError_t	GetColorTemp_Ggain (tvColorTemp_t colorTemp, int *ggain)
	Get the ggain value.

tvError_t	SetColorTemp_Bgain (tvColorTemp_t colorTemp, int bgain)
	Set the bgain value.

tvError_t	GetColorTemp_Bgain (tvColorTemp_t colorTemp, int *bgain)
	Get the bgain value.

tvError_t	SetColorTemp_R_post_offset (tvColorTemp_t colorTemp, int rpostoffset)
	Set the rpostoffset value.

tvError_t	GetColorTemp_R_post_offset (tvColorTemp_t colorTemp, int *rpostoffset)
	Get the rpostoffset value.

tvError_t	SetColorTemp_G_post_offset (tvColorTemp_t colorTemp, int gpostoffset)
	Set the gpostoffset value.

tvError_t	GetColorTemp_G_post_offset (tvColorTemp_t colorTemp, int *gpostoffset)
	Get the gpostoffset value.

tvError_t	SetColorTemp_B_post_offset (tvColorTemp_t colorTemp, int bpostoffset)
	Set the bpostoffset value.

tvError_t	GetColorTemp_B_post_offset (tvColorTemp_t colorTemp, int *bpostoffset)
	Get the gpostoffset value.

tvError_t	GetTVSupportedPictureModes (pic_modes_t pictureModes[], unsigned short count)
	Gets the supported picture modes and their count.

void	RegisterVideoFormatChangeCB (tvVideoFormatCallbackData &cbData)
	Registers the video format change callback.

void	RegisterVideoContentChangeCB (tvVideoContentCallbackData &cbData)
	Registers the VideoContent FMM change callback.

void	RegisterVideoResolutionChangeCB (tvVideoResolutionCallbackData &cbData)
	Registers the Video resolution change callback.

void	RegisterVideoFrameRateChangeCB (tvVideoFrameRateCallbackData &cbData)
	Registers the Video framerate change callback.

tvError_t	GetTVSupportedDVModes (pic_modes_t dvModes[], unsigned short count)
	Gets the supported DV modes and their count.

tvError_t	SetTVDolbyVisionMode (const char *dolbyMode)
	Sets dolby vision mode. To be deprecated soon.

tvError_t	GetTVDolbyVisionMode (char *dolbyMode)
	Gets the current current dolby vision mode.

tvError_t	SetTVHLGMode (const char *hlgMode)
	Sets the HLG mode. To be deprecated soon.

tvError_t	SetTVHDR10Mode (const char *hdr10Mode)
	Sets the HDR10 mode. To be deprecated soon.

tvError_t	GetTVHLGMode (char *hlgMode)
	Gets the current current HLG mode.

tvError_t	GetTVHDR10Mode (char *hdr10Mode)
	Gets the current current HDR10 mode.

tvError_t	GetTVSupportedHLGModes (pic_modes_t dvModes[], unsigned short count)
	Gets the supported HLG modes and their count. To be deprecated soon.

tvError_t	GetTVSupportedHDR10Modes (pic_modes_t dvModes[], unsigned short count)
	Gets the supported HDR10 modes and their count. To be deprecated soon.

tvError_t	SetDynamicContrast (const char *dynamicContrastEnable)
	Sets the dynamic contrast.

tvError_t	GetDynamicContrast (char *isDynamicContrastEnabled)
	Gets the current Dynamic contrast mode.

tvError_t	SetColorTemp_Rgain_onSource (tvColorTemp_t colorTemp, int rgain, int sourceId, int saveOnly)
	Sets or saves the rgain value.

tvError_t	GetColorTemp_Rgain_onSource (tvColorTemp_t colorTemp, int *rgain, int sourceId)
	Gets the current rgain value.

tvError_t	SetColorTemp_Ggain_onSource (tvColorTemp_t colorTemp, int ggain, int sourceId, int saveOnly)
	Sets or saves the ggain value.

tvError_t	GetColorTemp_Ggain_onSource (tvColorTemp_t colorTemp, int *ggain, int sourceId)
	Gets the current ggain value for a specfic color temperature and source.

tvError_t	SetColorTemp_Bgain_onSource (tvColorTemp_t colorTemp, int bgain, int sourceId, int saveOnly)
	Sets or saves the bgain value.

tvError_t	GetColorTemp_Bgain_onSource (tvColorTemp_t colorTemp, int *bgain, int sourceId)
	Gets the current bgain value for a specfic color temperature and source.

tvError_t	SetColorTemp_R_post_offset_onSource (tvColorTemp_t colorTemp, int rpostoffset, int sourceId, int saveOnly)
	Sets or saves the rpostoffset value.

tvError_t	GetColorTemp_R_post_offset_onSource (tvColorTemp_t colorTemp, int *rpostoffset, int sourceId)
	Gets the current rpostoffset value.

tvError_t	SetColorTemp_G_post_offset_onSource (tvColorTemp_t colorTemp, int gpostoffset, int sourceId, int saveOnly)
	Sets or saves the gpostoffset value.

tvError_t	GetColorTemp_G_post_offset_onSource (tvColorTemp_t colorTemp, int *gpostoffset, int sourceId)
	Gets the current gpostoffset value for a specfic color temperature and source.

tvError_t	SetColorTemp_B_post_offset_onSource (tvColorTemp_t colorTemp, int bpostoffset, int sourceId, int saveOnly)
	Sets or saves the bpostoffset value.

tvError_t	GetColorTemp_B_post_offset_onSource (tvColorTemp_t colorTemp, int *bpostoffset, int sourceId)
	Gets the current bpostoffset value for a specfic color temperature and source.

tvError_t	setWBctrl (char inputSrc, char colorTemp, char color, char ctrl, int value)
	Sets the white balance control. To be deprecated soon.

tvError_t	getWBctrl (char inputSrc, char colortemp, char color, char ctrl, int *value)
	Gets the current white balance control.

tvError_t	getWbInfo (getWBInfo_t *params, std::vector< std::string > &selector, std::vector< std::string > &colorTmp, std::vector< std::string > &input)
	Gets the current white balance info. To be deprecated soon.

tvError_t	enableWBmode (bool value)
	Enable/disable WB mode.

tvError_t	GetSupportedComponentColor (int *blComponentColor)
	Gets the supported Component colors.

tvError_t	SetCurrentComponentSaturation (tvDataComponentColor_t blSaturationColor, int saturation)
	Sets current component saturation.

tvError_t	GetCurrentComponentSaturation (tvDataComponentColor_t blSaturationColor, int *saturation)
	Gets current component saturation.

tvError_t	SetCurrentComponentHue (tvDataComponentColor_t blHueColor, int hue)
	Sets current component hue.

tvError_t	GetCurrentComponentHue (tvDataComponentColor_t blHueColor, int *hue)
	Gets current component hue.

tvError_t	SetCurrentComponentLuma (tvDataComponentColor_t blLumaColor, int Luma)
	Sets the current component luma value.

tvError_t	GetCurrentComponentLuma (tvDataComponentColor_t blLumaColor, int *Luma)
	Gets the current component luma.

tvError_t	GetTVSupportedDimmingModes (char *dimmingModes, unsigned short count)
	Gets supported backlight dimming modes of the system. To be deprecated soon.

tvError_t	SetTVDimmingMode (const char *dimmingMode)
	Sets the backlight dimming mode.

tvError_t	GetTVBacklightGlobalFactor (int *value)
	Get TV Backlight Global Factor.

tvError_t	SetTVBacklightGlobalFactor (int value, int rangeMidPointValue)
	Set TV Backlight Global Factor.

tvPictureMode_t	GetTVPictureModeIndex (const char *pictureMode)
	Get TV Picture Mode Index.

tvVideoHDRFormat_t	GetCurrentContentFormat (void)
	Get Current Content Format.

tvError_t	GetSupportedContentFormats (unsigned int contentFormats, unsigned short numberOfFormats)
	Get Supported Content Formats.

tvError_t	ResetBrightness (int defaultValue, bool resetForAllFormats)
	Reset Brightness.

tvError_t	ResetContrast (int defaultValue, bool resetForAllFormats)
	Reset Contrast.

tvError_t	ResetSharpness (int defaultValue, bool resetForAllFormats)
	Reset Sharpness.

tvError_t	ResetSaturation (int defaultValue, bool resetForAllFormats)
	Reset Saturation.

tvError_t	ResetHue (int defaultValue, bool resetForAllFormats)
	Reset Hue.

tvError_t	ResetBacklight (int defaultValue, bool resetForAllFormats)
	Reset Backlight.

tvError_t	ResetColorTemperature (int defaultValue, bool resetForAllFormats)
	Reset Color Tempearture.

tvError_t	ResetComponentSaturation (int color, int defaultValue)
	Reset Component Saturation.

tvError_t	ResetComponentLuma (int color, int defaultValue)
	Reset Component Luma.

tvError_t	ResetComponentHue (int color, int defaultValue)
	Reset Component hue.

bool	isCurrentHDRTypeIsSDR (void)
	Check if current format is SDR.

int	GetPanelID (char *panelid)
	Returns Panel ID information. To be deprecated soon.

void	GetDefaultPanelID (char *panelID)
	Get the default panel ID.

tvError_t	SaveColorTemperature (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the color temperature value.

tvError_t	SaveBacklight (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the backlight value.

tvError_t	SaveContrast (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the contrast value.

tvError_t	SaveSaturation (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the saturation value.

tvError_t	SaveSharpness (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the sharpness value.

tvError_t	SaveBrightness (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the brightness value.

tvError_t	SaveHue (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the hue value.

tvError_t	SaveDynamicBacklight (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the DynamicBacklight mode.

tvError_t	SaveDisplayMode (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the DisplayMode value.

tvError_t	SaveCMS (int sourceInput, int pq_mode, int hdr_type, int tunnel_type, int color_type, int value)
	Save the CMS value.

tvError_t	SaveDolbyMode (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the dolby mode value.

int	GetNumberOfModesupported (void)
	GetNumberOfModesupported.

int	GetCurrentPQIndex (void)
	Get current PQ Mode index.

void	GetAllSupportedPicModeIndex (int pic_mode_index[])
	Get All Supported PicMode Index.

int	GetCMSDefault (tvCMS_tunel_t color_tunel_type)
	Gets the current CMS default value. To be deprecated soon.

int	GetDolbyModeIndex (const char *dolbyMode)
	Get Dolby Mode Index.

int	ConvertVideoFormatToHDRFormat (tvVideoHDRFormat_t videoFormat)
	Returns tvhdr_type_t enum for given tvVideoHDRFormat_t enum. To be deprecated soon.

int	ConvertTVColorToVendorColor (tvDataComponentColor_t blComponentColor)
	Convert TV color to vendor color.

int	ConvertHDRFormatToContentFormat (tvhdr_type_t hdrFormat)
	Convert HDR to content format.

int	GetCustomPQModeIndex (void)
	Get Custom mode index.

tvError_t	SetCMSState (tvCMS_tunel_t tunelType, tvcomponent_color_type_t colorType, tvcomponent_state_t componentState)
	Sets and save's the CMS state.

bool	isWBUserDfault (tvDataColor_t wbvalue)
	Check the given WB values are default or not.

int	GetWBRgbType (const char color, const char ctrl)
	Get WB RGB type.

tvDataColor_t	GetUSerWBValueOnInit (void)
	Get WB values on init.

bool	areEqual (tvDataColor_t wbvalueThis, tvDataColor_t wbvalueThat)
	Check WB values are equal.

tvError_t	SetColorTemperatureUser (int rgbType, int value)
	Set Color Temperature User.

tvError_t	SaveColorTemperatureUser (int rgbType, int value)
	Saves the color temperature to driver cache. To be deprecated soon.

tvError_t	SetBacklightInfo (tvBacklightInfo_t *backlightDefaults)
	Set backlight info.

int	GetDriverEquivalentBLForCurrentFmt (int backlight)
	Get Driver BL value for current format.

int	GetHLGModeIndex (const char *hlgMode)
	Get HLG mode Index.

int	GetHDR10ModeIndex (const char *hdr10Mode)
	Get HDR10 mode index.

tvError_t	SetBacklightFade (int from, int to, int duration)
	Sets the backlight fade settings.

tvError_t	ReadAllModeConfigfile (const char file, char cpybuffer, const char *searchstring)
	Reads PQ capability information sections from the specified file. To be deprecated soon.

void	splitstringsfrombuffer (char buffer, char availableModes, unsigned short *totalcount)
	Parse buffer and return string values & total count.

void	splitstringsandvaluefrombuffer (char buffer, pic_modes_t availableModes[], unsigned short *totalcount)
	Parse buffer and return string values,index & total count.

tvError_t	SetGammaMode (int mode)
	Enable or disable gamma mode.

tvError_t	SetLocalDimmingLevel (int localDimmingLevel)
	Sets the local dimming level.

tvError_t	GetLocalDimmingLevel (int *localDimmingLevel)
	Gets the current dimming level.

tvError_t	SaveLocalDimmingLevel (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves local dimming level.

void	SwitchEDID (int pqmode)
	Switch EDID.

tvError_t	UpdateEDIDAndSetDimmingLevel (int dimmingLevel)
	Set the EDID and dimming level.

void	GetLDIMAndEDIDLevel (int dimmingMode, int format, int dimmingLevel, int edidLevel)
	Get LDIM and EDID level.

tvError_t	SaveLowLatencyState (int sourceInput, int pq_mode, int hdr_type, int value)
	Saves the low latency index.

tvError_t	SetLowLatencyState (int lowLatencyIndex)
	Sets the low latency state to driver register(s)

tvError_t	GetLowLatencyState (int *lowlatencystate)
	Gets the current low latency state.

tvError_t	SetGammaTable (unsigned short pData_R, unsigned short pData_G, unsigned short *pData_B, unsigned short size)
	Sets the gamma calibrated values to gamma HW for current selected colour temperature.

tvError_t	GetGammaTable (int colortemp, unsigned short pData_R, unsigned short pData_G, unsigned short *pData_B, unsigned short size)
	Gets the current gamma calibrated values from gamma HW for current selected colour temperature.

tvError_t	SaveGammaTable (int colortemp, unsigned short pData_R, unsigned short pData_G, unsigned short *pData_B, unsigned short size)
	Saves the gamma calibrated values.s.

tvError_t	SetGammaPattern (int is_10_bit, int R_Value, int G_Value, int B_Value)
	Sets the gamma pattern.

Detailed Description

Macro Definition Documentation

◆ __BL_PARA__

#define __BL_PARA__

◆ BACKLIGHT_CURVE_MAX_INDEX

#define BACKLIGHT_CURVE_MAX_INDEX (101)

◆ CONTROL_COUNT

#define CONTROL_COUNT (2)

◆ DIMMING_MODE_MAX

#define DIMMING_MODE_MAX (10)

◆ DIMMING_MODE_NAME_SIZE

#define DIMMING_MODE_NAME_SIZE (25)

◆ EXPECTED_FILE_SIZE

#define EXPECTED_FILE_SIZE (512)

◆ GAIN_MAX

#define GAIN_MAX (2047)

◆ GAIN_MIN

#define GAIN_MIN (0)

◆ GENERIC_MODE_CONFIG_FILE

#define GENERIC_MODE_CONFIG_FILE "/etc/tv/allmodes.conf"

◆ MAX_STRING_SIZE

#define MAX_STRING_SIZE (15)

◆ OFFSET_MAX

#define OFFSET_MAX (1024)

◆ OFFSET_MIN

#define OFFSET_MIN (-1024)

◆ PIC_MODE_NAME_MAX

#define PIC_MODE_NAME_MAX (25)

◆ PIC_MODES_SUPPORTED_MAX

#define PIC_MODES_SUPPORTED_MAX (15)

Typedef Documentation

◆ bl_para_t

typedef struct bl_para_s bl_para_t

◆ getWBInfo_t

typedef struct getWBInfo getWBInfo_t

◆ input_source_offset_t

typedef enum input_source_offset_e input_source_offset_t

◆ pic_modes_t

typedef struct pic_modes pic_modes_t

◆ tvBacklightInfo_t

typedef struct tvBacklightInfo_s tvBacklightInfo_t

◆ tvVideoContentChangeCB

typedef void(* tvVideoContentChangeCB) (tvContentType_t mode, void *userData)

◆ tvVideoFormatChangeCB

typedef void(* tvVideoFormatChangeCB) (tvVideoHDRFormat_t format, void *userData)

◆ tvVideoFrameRateChangeCB

typedef void(* tvVideoFrameRateChangeCB) (tvVideoFrameRate_t frameRate, void *userData)

tv Video FrameRate Change CB

Precondition: TvInit() should be called before calling this API

◆ tvVideoResolutionChangeCB

typedef void(* tvVideoResolutionChangeCB) (tvResolutionParam_t resolutionStruct, void *userData)

tv Video Resolution ChangeCB

Precondition: TvInit() should be called before calling this API

Enumeration Type Documentation

◆ fp_mfrColorTemp_t

enum fp_mfrColorTemp_t

Enumerator
mfrColorTemp_STANDARD
mfrColorTemp_COLD
mfrColorTemp_WARM
mfrColorTemp_USER
mfrColorTemp_MAX

◆ input_source_offset_e

enum input_source_offset_e

Enumerator
HDMI_OFFSET_NEW
TV_OFFSET_NEW
AV_OFFSET_NEW
MAX_OFFSET_NEW

Function Documentation

◆ areEqual()

bool areEqual	(	tvDataColor_t	wbvalueThis,
		tvDataColor_t	wbvalueThat )

Check WB values are equal.

This function checks if two white balance values are same.

Parameters

[in]	wbvalueThis	- value this
[in]	wbvalueThat	- value that

Returns: bool

Return values

True or False

Precondition: TvInit() should be called before calling this API

◆ ConvertHDRFormatToContentFormat()

int ConvertHDRFormatToContentFormat ( tvhdr_type_t hdrFormat )

Convert HDR to content format.

This function converts the vendor HDR format to tv format value.

Parameters

[in] hdrFormat - hdrformat

Returns: int

Return values

hdr format

Precondition: TvInit() should be called before calling this API

◆ ConvertTVColorToVendorColor()

int ConvertTVColorToVendorColor ( tvDataComponentColor_t blComponentColor )

Convert TV color to vendor color.

This function converts the TV color to Vendor color value

Parameters

[in] blComponentColor - blComponentColor

Returns: int

Return values

component color

Precondition: TvInit() should be called before calling this API

◆ ConvertVideoFormatToHDRFormat()

int ConvertVideoFormatToHDRFormat ( tvVideoHDRFormat_t videoFormat )

Returns tvhdr_type_t enum for given tvVideoHDRFormat_t enum. To be deprecated soon.

This function converts the video format to HDR format.

Parameters

[in] videoFormat - Video format. Valid values can be member of tvVideoHDRFormat_t

Returns: int - Valid values can be member of tvhdr_type_t

Precondition: tvInit() should be called before calling this API

◆ enableWBmode()

tvError_t enableWBmode ( bool value )

Enable/disable WB mode.

This function enables or disables white balance mode.

Parameters

[in] value - value

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetAllSupportedPicModeIndex()

void GetAllSupportedPicModeIndex ( int pic_mode_index[] )

Get All Supported PicMode Index.

This function gets all the supported picture mode index.

Parameters

[out] pic_mode_index

Precondition: TvInit() should be called before calling this API

◆ GetAspectRatio()

tvError_t GetAspectRatio ( tvDisplayMode_t * dispMode )

Gets the current aspect ratio.

This function gets the current aspect ratio for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] dispMode - Aspect ratio value. Valid value will be a member of tvDisplayMode_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetAspectRatio()

◆ GetBacklight()

tvError_t GetBacklight ( int * backlight )

Gets the current backlight value.

This function gets the current backlight value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] backlight - Current backlight value. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetBacklight()

◆ GetBrightness()

tvError_t GetBrightness ( int * brightness )

Gets the current brightness value.

This function gets the current brightness value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] brightness - Current brightness value. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetBrightness()

◆ GetCMSDefault()

int GetCMSDefault ( tvCMS_tunel_t color_tunel_type )

Gets the current CMS default value. To be deprecated soon.

This function returns the default CMS value

Parameters

[out] color_tunel_type - color_tunel_type.

Returns: int

Return values

15	- Luma default value
50	- Hue or saturation default value
-1	- Input parameter is invalid

Precondition: tvInit() should be called before calling this API

◆ GetColorTemp_B_post_offset()

tvError_t GetColorTemp_B_post_offset	(	tvColorTemp_t	colorTemp,
		int *	bpostoffset )

Get the gpostoffset value.

This function gets the gpostoffset value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[in]	bpostoffset	- bpostoffset

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_B_post_offset_onSource()

tvError_t GetColorTemp_B_post_offset_onSource	(	tvColorTemp_t	colorTemp,
		int *	bpostoffset,
		int	sourceId )

Gets the current bpostoffset value for a specfic color temperature and source.

This function gets the bpostoffset value for a specfic color temperature and source

Parameters

[in]	colorTemp	- Color temperature value. Valid value will be a member of tvColorTemp_t
[out]	bpostoffset	- Bpostoffset Value. Valid range is (-1024 to +1023)
[in]	sourceId	- SourceId value.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_Bgain()

tvError_t GetColorTemp_Bgain	(	tvColorTemp_t	colorTemp,
		int *	bgain )

Get the bgain value.

This function gets the bgain value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[out]	bgain	- bgain

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_Bgain_onSource()

tvError_t GetColorTemp_Bgain_onSource	(	tvColorTemp_t	colorTemp,
		int *	bgain,
		int	sourceId )

Gets the current bgain value for a specfic color temperature and source.

This function gets the bgain value for a specfic color temperature and source

Parameters

[in]	colorTemp	- Color temperature value. Valid value will be a member of tvColorTemp_t
[out]	bgain	- Bgain Value. Valid range is (0 - 2047)
[in]	sourceId	- SourceId value.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_G_post_offset()

tvError_t GetColorTemp_G_post_offset	(	tvColorTemp_t	colorTemp,
		int *	gpostoffset )

Get the gpostoffset value.

This function gets the gpostoffset value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[in]	gpostoffset	- gpostoffset

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_G_post_offset_onSource()

tvError_t GetColorTemp_G_post_offset_onSource	(	tvColorTemp_t	colorTemp,
		int *	gpostoffset,
		int	sourceId )

Gets the current gpostoffset value for a specfic color temperature and source.

This function gets the gpostoffset value for a specfic color temperature and source.

Parameters

[in]	colorTemp	- Color temperature value. Valid value will be a member of tvColorTemp_t
[out]	gpostoffset	- Gpostoffset Value. Valid range is (-1024 to +1023)
[in]	sourceId	- SourceId value.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_Ggain()

tvError_t GetColorTemp_Ggain	(	tvColorTemp_t	colorTemp,
		int *	ggain )

Get the ggain value.

This function gets the ggain value for specfic color temperature.

Parameters

[in]	colorTemp	- color temperature
[in]	ggain	- ggain

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_Ggain_onSource()

tvError_t GetColorTemp_Ggain_onSource	(	tvColorTemp_t	colorTemp,
		int *	ggain,
		int	sourceId )

Gets the current ggain value for a specfic color temperature and source.

This function gets the ggain value for a specfic color temperature and source.

Parameters

[in]	colorTemp	- Color temperature value. Valid value will be a member of tvColorTemp_t
[out]	ggain	- Ggain Value. Valid range is (0 - 2047)
[in]	sourceId	- SourceId value.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_R_post_offset()

tvError_t GetColorTemp_R_post_offset	(	tvColorTemp_t	colorTemp,
		int *	rpostoffset )

Get the rpostoffset value.

This function gets the rpostoffset value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[in]	rpostoffset	- rpostoffset

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_R_post_offset_onSource()

tvError_t GetColorTemp_R_post_offset_onSource	(	tvColorTemp_t	colorTemp,
		int *	rpostoffset,
		int	sourceId )

Gets the current rpostoffset value.

This function gets the current rpostoffset value for a specfic color temperature and source.

Parameters

[in]	colorTemp	- Color temperature value. Valid value will be a member of tvColorTemp_t
[out]	rpostoffset	- Rpostoffset Value. Valid range is (-1024 to +1023)
[in]	sourceId	- SourceId value.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_Rgain()

tvError_t GetColorTemp_Rgain	(	tvColorTemp_t	colorTemp,
		int *	rgain )

Get the ggain value.

This function gets the ggain value for specfic color temperature.

Parameters

[in]	colorTemp	- color temperature
[in]	rgain	- rgain

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemp_Rgain_onSource()

tvError_t GetColorTemp_Rgain_onSource	(	tvColorTemp_t	colorTemp,
		int *	rgain,
		int	sourceId )

Gets the current rgain value.

This function gets the current rgain value for a specific color temperature and source offset.

Parameters

[in]	colorTemp	- Color temperature value. Valid value will be a member of tvColorTemp_t
[out]	rgain	- Rgain Value. Valid range is (0 - 2047)
[in]	sourceId	- SourceId value.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetColorTemperature()

tvError_t GetColorTemperature ( tvColorTemp_t * colorTemp )

Gets the current color temperature.

This function gets the current colour temperature value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] colorTemp - Current color temperature. Valid value will be a member of tvColorTemp_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetColorTemperature()

◆ GetContrast()

tvError_t GetContrast ( int * contrast )

Gets the current contrast value.

This function gets the current contrast value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] contrast - Current contrast value. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetContrast()

◆ GetCurrentBacklightMode()

tvError_t GetCurrentBacklightMode ( tvBacklightMode_t * blMode )

Gets current blacklight mode.

This function gets the current backlight mode.

Parameters

[out] blMode - Current backlight mode. Valid value will be a member of tvBacklightMode_t If more than one value is received then INVALID_PARAM is returned.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetSupportedBacklightModes(),SetCurrentBacklightMode()

◆ GetCurrentComponentHue()

tvError_t GetCurrentComponentHue	(	tvDataComponentColor_t	blHueColor,
		int *	hue )

Gets current component hue.

This function returns the current component hue for the specific color, for the primary video source selected, primary video format played and picture mode selected.

Parameters

[in]	blHueColor	- Component color. Valid value will be a member of tvDataComponentColor_t
[out]	hue	- Hue value of the color. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetCurrentComponentLuma()

tvError_t GetCurrentComponentLuma	(	tvDataComponentColor_t	blLumaColor,
		int *	Luma )

Gets the current component luma.

This function returns the current component luma for the specific color, for the primary video source selected, primary video format played and picture mode selected.

Parameters

[in]	blLumaColor	- Component color. Valid value will be a member of tvDataComponentColor_t
[out]	Luma	- Luma value of the color. Valid range is (0 - 30)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetCurrentComponentSaturation()

tvError_t GetCurrentComponentSaturation	(	tvDataComponentColor_t	blSaturationColor,
		int *	saturation )

Gets current component saturation.

This function returns the current component saturation for the specific color, for the primary video source selected, primary video format played and picture mode selected.

Parameters

[in]	blSaturationColor	- Component color. Valid value will be a member of tvDataComponentColor_t
[out]	saturation	- Saturation value of the color. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetCurrentContentFormat()

tvVideoHDRFormat_t GetCurrentContentFormat ( void )

Get Current Content Format.

This function gets the video format value of the current primary video played on TV

Returns: tvVideoHDRFormat_t

Return values

HDR format

Precondition: TvInit() should be called before calling this API

◆ GetCurrentPQIndex()

int GetCurrentPQIndex ( void )

Get current PQ Mode index.

This function returns the current PQ index value.

Returns: int

Return values

picModeValue

Precondition: TvInit() should be called before calling this API

◆ GetCurrentVideoFormat()

tvError_t GetCurrentVideoFormat ( tvVideoHDRFormat_t * format )

Gets current video format. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function gets the video format value of the current primary video played on TV

Returns: tvVideoHDRFormat_t

Return values

tvVideoHDRFormat_SDR	- SDR format
tvVideoHDRFormat_HLG	- HLG Format
tvVideoHDRFormat_HDR10	- HDR10 format
tvVideoHDRFormat_HDR10PLUS	- HDR10 plus format
tvVideoHDRFormat_DV	- DV format.

Precondition: tvInit() should be called before calling this API

◆ GetCustomPQModeIndex()

int GetCustomPQModeIndex ( void )

Get Custom mode index.

This function return the custom pqmode index

Returns: int

Return values

pic	mode values

Precondition: TvInit() should be called before calling this API

◆ GetDefaultPanelID()

void GetDefaultPanelID ( char * panelID )

Get the default panel ID.

This function return the default panelid.

Parameters

[out] panelID - Panel ID

Precondition: TvInit() should be called before calling this API

◆ GetDolbyModeIndex()

int GetDolbyModeIndex ( const char * dolbyMode )

Get Dolby Mode Index.

This function returns the dolby mode index.

Parameters

[in] dolbyMode

Returns: int

Return values

Dolbymode value

Precondition: TvInit() should be called before calling this API

◆ GetDriverEquivalentBLForCurrentFmt()

int GetDriverEquivalentBLForCurrentFmt ( int backlight )

Get Driver BL value for current format.

This function returns the driver equivalent backlight for current backlight value.

Parameters

[in] backlight - Backlight

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetDynamicContrast()

tvError_t GetDynamicContrast ( char * isDynamicContrastEnabled )

Gets the current Dynamic contrast mode.

This function gets the current dynamic contrast value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] isDynamicContrastEnabled - Current dynamic contrast mode flag value. (valid values are "enabled" for enable and "disabled" for disable)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetDynamicContrast()

◆ GetGammaTable()

tvError_t GetGammaTable	(	int	colortemp,
		unsigned short *	pData_R,
		unsigned short *	pData_G,
		unsigned short *	pData_B,
		unsigned short	size )

Gets the current gamma calibrated values from gamma HW for current selected colour temperature.

This function gets the current gamma calibrated values(0 - 65535) for the primary colors for a current color temperature.

Parameters

[in]	colortemp	- Color temperature.
[out]	pData_R	- Array of gamma red values. Valid range is (0 - 1023)
[out]	pData_G	- Array of gamma green values. Valid range is (0 - 1023)
[out]	pData_B	- Array of gamma blue values. Valid range is (0 - 1023)
[in]	size	- Common size of each array. Valid range is (0 - 256)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetGrayPattern()

tvError_t GetGrayPattern ( int * YUVValue )

Gets the current gray pattern value.

This function gets the current gray pattern level

Parameters

[out] YUVValue - Gray level of input pattern. Valid range is (0 - 255)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetHDR10ModeIndex()

int GetHDR10ModeIndex ( const char * hdr10Mode )

Get HDR10 mode index.

This function returns HDR10 mode index.

Parameters

[in] hdr10Mode - hdr10mode

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetHLGModeIndex()

int GetHLGModeIndex ( const char * hlgMode )

Get HLG mode Index.

This function returns HLG mode index.

Parameters

[in] hlgMode - hlg mode

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetHue()

tvError_t GetHue ( int * hue )

Gets the current hue value.

This function gets the current hue value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] hue - Current hue value. Valid range (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetHue()

◆ GetLDIMAndEDIDLevel()

void GetLDIMAndEDIDLevel	(	int	dimmingMode,
		int	format,
		int *	dimmingLevel,
		int *	edidLevel )

Get LDIM and EDID level.

This function gets the LDIM and EDID level for given video format and dimmingMode

Parameters

[in]	dimmingMode	- Dimming mode
[in]	format	- Format
[out]	dimmingLevel	- Dimming Level
[out]	edidLevel	- EDID level

Precondition: TvInit() should be called before calling this API

◆ GetLocalDimmingLevel()

tvError_t GetLocalDimmingLevel ( int * localDimmingLevel )

Gets the current dimming level.

This function gets the current local dimming level for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] localDimmingLevel - Current Dimming level returned.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetLowLatencyState()

tvError_t GetLowLatencyState ( int * lowlatencystate )

Gets the current low latency state.

This function gets the current low latency value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] lowlatencystate - Current low latency index value. Valid values are ( 0, 1 )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetNumberOfModesupported()

int GetNumberOfModesupported ( void )

GetNumberOfModesupported.

This function returns the number of supported picture modes.

Returns: int

Return values

numberModesSupported

Precondition: TvInit() should be called before calling this API

◆ GetPanelID()

int GetPanelID ( char * panelid )

Returns Panel ID information. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function returns the panel ID string.

Parameters

[out] panelid - Panel ID string to be returned.

Returns: int - Valid values can be member of tvVideoHDRFormat_t

Return values

0	- Success
-1	- General failure.

Precondition: tvInit() should be called before calling this API

◆ GetRGBPattern()

tvError_t GetRGBPattern	(	int *	r,
		int *	g,
		int *	b )

Gets the current RGB values of the RGB pattern.

This function gets the current primary color level(0 - 255) of the RGB pattern.

Parameters

[out]	r	- Red level of input pattern. Valid range is (0 - 255)
[out]	g	- Green level of input pattern. Valid range is (0 - 255)
[out]	b	- Blue level of input pattern. Valid range is (0 - 255)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetSaturation()

tvError_t GetSaturation ( int * saturation )

Gets the current saturation value.

This function gets the current saturation value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] saturation - Current saturation value. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetSaturation()

◆ GetSharpness()

tvError_t GetSharpness ( int * sharpness )

Gets the current sharpness value.

This function gets the current sharpness value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] sharpness - Current sharpness value. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetSharpness()

◆ GetSupportedBacklightModes()

tvError_t GetSupportedBacklightModes ( int * blModes )

Gets the supported backlight modes.

This function returns all supported backlight modes for the TV The output has the bitwise OR-ed value of all the supported backlight modes (tvBacklightMode_t).

Parameters

[out] blModes - Supported backlight modes. Valid values will be members of tvBacklightMode_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetCurrentBacklightMode(),SetCurrentBacklightMode()

◆ GetSupportedComponentColor()

tvError_t GetSupportedComponentColor ( int * blComponentColor )

Gets the supported Component colors.

This function gets the supported component colors.
The output has the bitwise OR-ed value of all the supported colors (tvDataComponentColor_t).

Parameters

[out] blComponentColor - Bit wise OR-ed value for supported component colors. Please refer tvDataComponentColor_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetSupportedContentFormats()

tvError_t GetSupportedContentFormats	(	unsigned int *	contentFormats,
		unsigned short *	numberOfFormats )

Get Supported Content Formats.

This function returns all the supported content formats.

Parameters

[out]	contentFormats	- content formats
[out]	numberOfFormats	- number Of Formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTint()

tvError_t GetTint ( int * tint )

Gets the current tint value.

This function gets the current tint value for the primary video source selected,primary video format played and picture mode selected

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTVBacklightGlobalFactor()

tvError_t GetTVBacklightGlobalFactor ( int * value )

Get TV Backlight Global Factor.

This function get the current applied Backlight Global Factor

Parameters

[out] value - value

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTVDolbyVisionMode()

tvError_t GetTVDolbyVisionMode ( char * dolbyMode )

Gets the current current dolby vision mode.

This function gets the current Dolby vision mode value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] dolbyMode - Current Dolby vision mode. Valid values are member of tvDolbyMode_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetTVDolbyVisionMode()

◆ GetTVHDR10Mode()

tvError_t GetTVHDR10Mode ( char * hdr10Mode )

Gets the current current HDR10 mode.

This function gets the current HDR10 mode value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] hdr10Mode - HDR mode to get

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTVHLGMode()

tvError_t GetTVHLGMode ( char * hlgMode )

Gets the current current HLG mode.

This function gets the current HLG mode value for the primary video source selected, primary video format played and picture mode selected.

Parameters

[out] hlgMode - HLG mode to get

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTVPictureMode()

tvError_t GetTVPictureMode ( char * pictureMode )

Gets the current selected picture Mode.

This function will get the current selected picture mode for current pirmary video source and primary video format.

Parameters

[out] pictureMode - Current picture mode. Valid values are as per values returned by pic_modes_t.name parmaeter from GetTVSupportedPictureModes API. The size of string will be PIC_MODE_NAME_MAX.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: SetTVPictureMode()

◆ GetTVPictureModeIndex()

tvPictureMode_t GetTVPictureModeIndex ( const char * pictureMode )

Get TV Picture Mode Index.

This function returns the current selected picture mode index value.

Parameters

[in] pictureMode - Picture Mode

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTVSupportedDimmingModes()

tvError_t GetTVSupportedDimmingModes	(	char **	dimmingModes,
		unsigned short *	count )

Gets supported backlight dimming modes of the system. To be deprecated soon.

This function returns all the supported backlight dimming modes.

Parameters

[out]	dimmingModes	- array of dimming modes names. Valid values are "fixed", "local" and "global"
[out]	count	- Count of supported dimming modes. Min should be 1

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ GetTVSupportedDVModes()

tvError_t GetTVSupportedDVModes	(	pic_modes_t *	dvModes[],
		unsigned short *	count )

Gets the supported DV modes and their count.

This function returns the supported Dolby Vision modes and their count

Parameters

[out]	dvModes	- hdr 10 modes
[in]	count	- count

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetTVSupportedHDR10Modes()

tvError_t GetTVSupportedHDR10Modes	(	pic_modes_t *	dvModes[],
		unsigned short *	count )

Gets the supported HDR10 modes and their count. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function returns the supported HDR10 modes and their count

Parameters

[out]	dvModes[]	- List of available HDR10 modes. Refer pic_modes_t and tvDolbyMode_t Valid values are "dark" and & "bright" for pic_modes_t.name Valid values are member of tvDolbyMode_t tvHDR10Mode_Dark and tvDolbyMode_t tvHDR10Mode_Bright for pic_modes_t.value.
[out]	count	- Count of supported HDR10 modes. Max and min is 2

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ GetTVSupportedHLGModes()

tvError_t GetTVSupportedHLGModes	(	pic_modes_t *	dvModes[],
		unsigned short *	count )

Gets the supported HLG modes and their count. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function returns the supported HLG modes and their count

Parameters

[out]	dvModes[]	- List of available HLG modes. Refer pic_modes_t and tvDolbyMode_t Valid values are "dark" and & "bright" for pic_modes_t.name Valid values are member of tvDolbyMode_t tvHLGMode_Dark and tvDolbyMode_t tvHLGMode_Bright for pic_modes_t.value.
[out]	count	- Count of supported HLG modes. Max and min is 2

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ GetTVSupportedPictureModes()

tvError_t GetTVSupportedPictureModes	(	pic_modes_t *	pictureModes[],
		unsigned short *	count )

Gets the supported picture modes and their count.

This function get the array of picture modes supported and their count

Parameters

[out]	pictureModes	- List of available picture modes. Valid values are as per values returned by pic_modes_t.name and pic_modes_t.values parameter.
[out]	count	- Count of supported picture modes. Maximum possile value is PIC_MODES_SUPPORTED_MAX. Min is 1.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetUSerWBValueOnInit()

tvDataColor_t GetUSerWBValueOnInit ( void )

Get WB values on init.

This function gets the user white balance value on init.

Returns: tvDataColor_t

Return values

wb values

Precondition: TvInit() should be called before calling this API

◆ GetVideoFrameRate()

tvError_t GetVideoFrameRate ( tvVideoFrameRate_t * format )

Gets current video framerate.

This function gets the video frame rate of the current primary video played on TV

Parameters

[out] format - Format

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ GetVideoResolution()

tvError_t GetVideoResolution ( tvResolutionParam_t * res )

Gets the current video resolution.

This function gets the video resolution of the current primary video played on TV

Parameters

[out] res - Resolution

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ getWBctrl()

tvError_t getWBctrl	(	char *	inputSrc,
		char *	colortemp,
		char *	color,
		char *	ctrl,
		int *	value )

Gets the current white balance control.

This function gets the white balance for a specific source, color, color temperature and control.

Parameters

[in]	inputSrc	- Input source
[in]	colortemp	- color temperature value
[in]	color	- color values (red, blue or green)
[in]	ctrl	- control values (gain or offset)
[in]	value	- pointer to store value which will be returned by driver

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ getWbInfo()

tvError_t getWbInfo	(	getWBInfo_t *	params,
		std::vector< std::string > &	selector,
		std::vector< std::string > &	colorTmp,
		std::vector< std::string > &	input )

Gets the current white balance info. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function gets the White balance info into the vectors

Parameters

[out]	params	- WB info param. Valid values for : wbControls is ( "gain", "offset" ), wbGain is (0 to 2047), wbOffset is (-1024 to 1024))
[out]	selector	- Selector vector. Valid values are ( "color temp", "input" )
[out]	colorTmp	- Color temperature vector. Valid values are ( "custom", "normal", "cool", "warm" )
[out]	input	- Input source vector. Valid values are ( "TV", "HDMI", "AV" )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- When the input value is not valid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ GetWBRgbType()

int GetWBRgbType	(	const char *	color,
		const char *	ctrl )

Get WB RGB type.

This function gets the white balance RGB type for specific color and control value.

Parameters

[in]	color	- color
[in]	ctrl	- ctrl

Returns: int

Return values

rgb_type

Precondition: TvInit() should be called before calling this API

◆ isCurrentHDRTypeIsSDR()

bool isCurrentHDRTypeIsSDR ( void )

Check if current format is SDR.

This function checks whether the current content format is SDR or not.

Returns: bool

Return values

True or False

Precondition: TvInit() should be called before calling this API

◆ isWBUserDfault()

bool isWBUserDfault ( tvDataColor_t wbvalue )

Check the given WB values are default or not.

This function checks if the white balance parameters are equal to default value.

Parameters

[in] wbvalue - wb value

Returns: bool

Return values

True or false

Precondition: TvInit() should be called before calling this API

◆ ReadAllModeConfigfile()

tvError_t ReadAllModeConfigfile	(	const char *	file,
		char *	cpybuffer,
		const char *	searchstring )

Reads PQ capability information sections from the specified file. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function reads PQ capability information sections from the specified file. The file format is predefined and a template file is supplied by RDK.

Parameters

[in]	file	- The name of the file from which PQ capability information sections need to be read.
[out]	cpybuffer	- The return buffer (max size 512 bytes), where PQ capability information sections are copied to.
[in]	searchstring	- Heading of the section.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ RegisterVideoContentChangeCB()

void RegisterVideoContentChangeCB ( tvVideoContentCallbackData & cbData )

Registers the VideoContent FMM change callback.

This function registers a callback for the playback Filmmaker mode change event. Once registered, the callback function will be called by the TV Settings HAL implementation When the system detects SEI content_type 0x01 and content_subtype 0x00, the FMM enter event is raised. When the system detects SEI content_type is other than 0x01 or content_subtype is other than 0x00, the FMM exit event is raised. This applies only to IP video sources and Tuner video sources.

Parameters

[in] cbData - Callback data. Please refer::tvVideoContentCallbackData

Precondition: TvInit() should be called before calling this API

◆ RegisterVideoFormatChangeCB()

void RegisterVideoFormatChangeCB ( tvVideoFormatCallbackData & cbData )

Registers the video format change callback.

This function registers a callback for video format change event. Once registered, the callback function will be called by the TV Settings HAL implementation whenever the system detects a change in video format of the primary video currently played.

Parameters

[in] cbData - Callback data. Please refer tvVideoFormatCallbackData

Precondition: TvInit() should be called before calling this API

◆ RegisterVideoFrameRateChangeCB()

void RegisterVideoFrameRateChangeCB ( tvVideoFrameRateCallbackData & cbData )

Registers the Video framerate change callback.

This function registers a callback for playback content video frame rate change event. Once registered, the callback function will be called by the TV Settings HAL implementation whenever the system detects frame rate change for the primary video currently played.

Parameters

[in] cbData - Callback function. Please refer tvVideoFrameRateCallbackData

Precondition: TvInit() should be called before calling this API

◆ RegisterVideoResolutionChangeCB()

void RegisterVideoResolutionChangeCB ( tvVideoResolutionCallbackData & cbData )

Registers the Video resolution change callback.

This function registers a callback for playback content video resolution change event. Once registered, the callback function will be called by the TV Settings HAL implementation whenever the system detects resolution change for the primary video currently played.

Parameters

[in] cbData - Callback data. Please refer tvVideoResolutionCallbackData

Precondition: TvInit() should be called before calling this API

◆ ResetBacklight()

tvError_t ResetBacklight	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Backlight.

This function reset Backlight value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetBrightness()

tvError_t ResetBrightness	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Brightness.

This function reset Brightness value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetColorTemperature()

tvError_t ResetColorTemperature	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Color Tempearture.

This function reset Color Tempearture value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetComponentHue()

tvError_t ResetComponentHue	(	int	color,
		int	defaultValue )

Reset Component hue.

This function reset Component Hue value to default value for all formats (or) current format.

Parameters

[in]	color	- Hue color
[in]	defaultValue	- default value

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetComponentLuma()

tvError_t ResetComponentLuma	(	int	color,
		int	defaultValue )

Reset Component Luma.

This function reset Component luma value to default value for all formats (or) current format.

Parameters

[in]	color	- Luma color
[in]	defaultValue	- Default values

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetComponentSaturation()

tvError_t ResetComponentSaturation	(	int	color,
		int	defaultValue )

Reset Component Saturation.

This function reset Component Saturation value to default value for all formats (or) current format.

Parameters

[in]	color	- saturation color
[in]	defaultValue	- Default values

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetContrast()

tvError_t ResetContrast	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Contrast.

This function reset Contrast value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetHue()

tvError_t ResetHue	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Hue.

This function reset Hue value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetSaturation()

tvError_t ResetSaturation	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Saturation.

This function reset Saturation value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ ResetSharpness()

tvError_t ResetSharpness	(	int	defaultValue,
		bool	resetForAllFormats )

Reset Sharpness.

This function reset Sharpness value to default value for all formats (or) current format.

Parameters

[in]	defaultValue	- Default values
[in]	resetForAllFormats	- reset for all formats

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveBacklight()

tvError_t SaveBacklight	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the backlight value.

This function saves the backlight value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved backlight value should be applied automatically whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current backlight value in backlight HW.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr format type value.
[in]	value	- Value of the backlight to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveBrightness()

tvError_t SaveBrightness	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the brightness value.

This function saves the brightness value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved brightness value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current brightness value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr format type value.
[in]	value	- Value of the brightness to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveCMS()

tvError_t SaveCMS	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	tunnel_type,
		int	color_type,
		int	value )

Save the CMS value.

This function saves the CMS value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved hue value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played, specified primary video source is selected and the CMS state is enabled for that combination. There will be no change in current CMS value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr type value.
[in]	tunnel_type	- tunnel type value.
[in]	color_type	- Color type value.
[in]	value	- Value of the CMS to be set.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveColorTemperature()

tvError_t SaveColorTemperature	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the color temperature value.

This function saves the color temperature value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved color temperature value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current color temperature value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr format type value.
[in]	value	- Value of the color temperature to be set. Valid value will be member of tvColorTemp_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveColorTemperatureUser()

tvError_t SaveColorTemperatureUser	(	int	rgbType,
		int	value )

Saves the color temperature to driver cache. To be deprecated soon.

This function saves the color temperature for user to driver cache file

Parameters

[in]	rgbType	- RGB type. Valid value will be a member of tvRGBType_t
[in]	value	- Color temperature value to be set. Valid range : for gain (0 to 2047) , for offset (-1024 to 1024)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ SaveContrast()

tvError_t SaveContrast	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the contrast value.

This function saves the contrast value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved contrast value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current contrast value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr format type value.
[in]	value	- Value of the contrast to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveDisplayMode()

tvError_t SaveDisplayMode	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the DisplayMode value.

This function saves the aspect ratio(DisplayMode) value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved aspect ratio value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current aspect ratio value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr type value.
[in]	value	- Value of AspectRatio(tvDisplayMode_t)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveDolbyMode()

tvError_t SaveDolbyMode	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the dolby mode value.

This function saves the dolby mode value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved dolby mode value should be applied automatically by whenever the specified picture mode is selected, specified primary video format(if handled via Dolby core) is played and specified primary video source is selected. There will be no change in current dolby mode value in Dolby Vision core.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr type value.
[in]	value	- Value of the CMS to be set.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveDynamicBacklight()

tvError_t SaveDynamicBacklight	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the DynamicBacklight mode.

This function saves the backlight dimming mode(DynamicBacklight) in picture profile database for the specific picture mode, primary video format type and primary video source. The saved backlight dimming mode should be applied automatically whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current backlight dimming mode. If peak brightness capablity of the panel changes as a result of dimming mode change in future reload the edid accordingly to update VSVDB string if current video format is handled via Dolby Vision core.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr type value.
[in]	value	- Value of the DynamicBacklight(tvDimmingMode_t)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveGammaTable()

tvError_t SaveGammaTable	(	int	colortemp,
		unsigned short *	pData_R,
		unsigned short *	pData_G,
		unsigned short *	pData_B,
		unsigned short	size )

Saves the gamma calibrated values.s.

This function saves the gamma calibrated values in picture profile database for the primary colors for a specific color temperature. The saved gamma calibrated values will be automatically applied when the specified colour temperature choice is made as a result of picture mode change or primary video source change or primary vidoe format change.

Parameters

[in]	colortemp	- Color temperature. Valid value will be member of tvColorTemp_t
[out]	pData_R	- Array of gamma red values. Valid range is (0 - 1023)
[out]	pData_G	- Array of gamma green values. Valid range is (0 - 1023)
[out]	pData_B	- Array of gamma blue values. Valid range is (0 - 1023)
[out]	size	- Common size of each array. Valid range is (0 - 256)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveHue()

tvError_t SaveHue	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the hue value.

This function saves the hue value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved hue value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current hue value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr type value.
[in]	value	- Value of the hue to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveLocalDimmingLevel()

tvError_t SaveLocalDimmingLevel	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves local dimming level.

This function saves the local dimming level in picture profile database for the specific picture mode, primary video format type and primary video source. The saved local dimming level should be applied automatically whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current local dimming level applied in local dimming module. If peak brightness capablity of the panel changes as a result of local dimming level change in future reload the edid accordingly to update VSVDB string if current video format is handled via Dolby Vision core.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr type value.
[in]	value	- Value of the local dimming level to be set.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveLowLatencyState()

tvError_t SaveLowLatencyState	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the low latency index.

This function saves the low latency index in picture profile database for the specific picture mode, primary video format type and primary video source. The saved low latency index should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in low latency index value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr value.
[in]	value	- Value of the low latency index to be set. Valid values are ( 0, 1 )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveSaturation()

tvError_t SaveSaturation	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the saturation value.

This function saves the sharpness value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved saturation value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current saturation value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr format type value.
[in]	value	- Value of the saturation to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SaveSharpness()

tvError_t SaveSharpness	(	int	sourceInput,
		int	pq_mode,
		int	hdr_type,
		int	value )

Saves the sharpness value.

This function saves the sharpness value in picture profile database for the specific picture mode, primary video format type and primary video source. The saved sharpness value should be applied automatically by whenever the specified picture mode is selected, specified primary video format is played and specified primary video source is selected. There will be no change in current sharpness value applied in PQ module.

Parameters

[in]	sourceInput	- Source input value.
[in]	pq_mode	- Picture mode index.
[in]	hdr_type	- hdr format type value.
[in]	value	- Value of the sharpness to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetAspectRatio()

tvError_t SetAspectRatio ( tvDisplayMode_t dispMode )

Sets the aspect ratio.

This function updates the new aspect ratio value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] dispMode - Aspect ratio value to be set. Valid value will be a member of tvDisplayMode_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetAspectRatio()

◆ SetBacklight()

tvError_t SetBacklight ( int backlight )

Sets the backlight value in the backlight hardware.

This function updates the new backlight value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] backlight - Backlight value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetBacklight()

◆ SetBacklightFade()

tvError_t SetBacklightFade	(	int	from,
		int	to,
		int	duration )

Sets the backlight fade settings.

This function will fade the backlight between 2 different backlight values specified in a given duration. It will only set and does'nt save the value. The function call is asynchronous and expected to return immediately after initiating the fading process. If there is change in backlight value due to SetBacklight API call or a change initiated due to picture mode change or primary video source change or primary video format change, the fading stops instantly and system jumps to the new backlight value.

Parameters

[in]	from	- Percentage of current backlight value from where fade starts. Valid range is (0 - 100) If the value is <100 then before fade starts the backlight will jump to the from % of the currently set backlight value.
[in]	to	- Percentage of current backlight value where fade ends. Valid range is (0 - 100)
[in]	duration	- Time duration for which the backlight needs to be faded to reach new value. Valid range is (0 - 10000 ms)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetBacklightInfo()

tvError_t SetBacklightInfo ( tvBacklightInfo_t * backlightDefaults )

Set backlight info.

This function updates the backlight curve details to HAL

Parameters

[in] backlightDefaults - backlightDefaults to set

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetBrightness()

tvError_t SetBrightness ( int brightness )

Sets the brightness value to driver register(s)

This function updates the new brightness value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] brightness - Brightness value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetBrightness()

◆ SetCMSState()

tvError_t SetCMSState	(	tvCMS_tunel_t	tunelType,
		tvcomponent_color_type_t	colorType,
		tvcomponent_state_t	componentState )

Sets and save's the CMS state.

This function enable or disable the CMS state. The change is applied for current primary video source selected, video format played and picture mode selected and if successful will be saved in override picture profile database. The saved CMS state value should be applied automatically whenever the current picture mode, current primary video format

Parameters

[in]	tunelType	- Tunnel Type
[in]	colorType	- Color Type
[in]	componentState	- Component State

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_B_post_offset()

tvError_t SetColorTemp_B_post_offset	(	tvColorTemp_t	colorTemp,
		int	bpostoffset )

Set the bpostoffset value.

This function sets the bpostoffset value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[out]	bpostoffset	- bpostoffset

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_B_post_offset_onSource()

tvError_t SetColorTemp_B_post_offset_onSource	(	tvColorTemp_t	colorTemp,
		int	bpostoffset,
		int	sourceId,
		int	saveOnly )

Sets or saves the bpostoffset value.

This function sets or saves the bpostoffset value for a specfic color temperature and video source. If it is set operation (saveOnly=0)
the rgb gain and offset for the specified colour temperature will be loaded in white balance module and
the new bpostoffset gain value from this API will be updated, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes. If it is save operation (saveOnly =1) then the bpostoffset will be saved for the specific video source and colour temperature. The saved bpostoffset value should be automatically applied in white balance module when the colour temperaure choice is made as result of picture mode change or primary video format change or primary video source change.

Parameters

[in]	colorTemp	- Color temperature value to be save/set. Valid value will be a member of tvColorTemp_t
[in]	bpostoffset	- Bpostoffset Value to be set. Valid range is (-1024 to +1023)
[in]	sourceId	- SourceId value.
[in]	saveOnly	- Save=1 / Set=0 ( 0 for bpostoffset value will be applied to PQ HW. i.e changes can be visible immediately on screen 1 for bpostoffset value will be saved and applied later i.e changes not visible immediately for current video)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_Bgain()

tvError_t SetColorTemp_Bgain	(	tvColorTemp_t	colorTemp,
		int	bgain )

Set the bgain value.

This function sets the bgain value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[in]	bgain	- Bgain value

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_Bgain_onSource()

tvError_t SetColorTemp_Bgain_onSource	(	tvColorTemp_t	colorTemp,
		int	bgain,
		int	sourceId,
		int	saveOnly )

Sets or saves the bgain value.

This function sets or saves the bgain value for a specfic color temperature and video source. If it is set operation (saveOnly=0)
the rgb gain and offset for the specified colour temperature will be loaded in white balance module and
the new bgain gain value from this API will be updated, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes. If it is save operation (saveOnly =1) then the bgain will be saved for the specific video source and colour temperature. The saved bgain value will be automatically applied in white balance module when the colour temperaure choice is made as result of picture mode change or primary video format change or primary video source change.

Parameters

[in]	colorTemp	- Color temperature value to be save/set. Valid value will be a member of tvColorTemp_t
[in]	bgain	- Bgain Value to be set. Valid range is (0 - 2047)
[in]	sourceId	- SourceId value.
[in]	saveOnly	- Save=1 / Set=0 ( 0 for bgain value will be applied to PQ HW. i.e changes can be visible immediately on screen 1 for bgain value will be saved and applied later i.e changes not visible immediately for current video)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_G_post_offset()

tvError_t SetColorTemp_G_post_offset	(	tvColorTemp_t	colorTemp,
		int	gpostoffset )

Set the gpostoffset value.

This function sets the gpostoffset value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[out]	gpostoffset	- gpostoffset

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_G_post_offset_onSource()

tvError_t SetColorTemp_G_post_offset_onSource	(	tvColorTemp_t	colorTemp,
		int	gpostoffset,
		int	sourceId,
		int	saveOnly )

Sets or saves the gpostoffset value.

This function sets or saves the gpostoffset value for a specfic color temperature and video source. If it is set operation (saveOnly=0)
the rgb gain and offset for the specified colour temperature will be loaded in white balance module and
the new gpostoffset gain value from this API will be updated, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes. If it is save operation (saveOnly =1) then the gpostoffset will be saved for the specific video source and colour temperature. The saved gpostoffset value should be automatically applied in white balance module when the colour temperaure choice is made as result of picture mode change or primary video format change or primary video source change.

Parameters

[in]	colorTemp	- Color temperature value to be save/set. Valid value will be a member of tvColorTemp_t
[in]	gpostoffset	- Gpostoffset Value to be set. Valid range is (-1024 to +1023)
[in]	sourceId	- SourceId value.
[in]	saveOnly	- Save=1 / Set=0 ( 0 for gpostoffset value will be applied to PQ HW. i.e changes can be visible immediately on screen 1 for gpostoffset value will be saved and applied later i.e changes not visible immediately for current video)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_Ggain()

tvError_t SetColorTemp_Ggain	(	tvColorTemp_t	colorTemp,
		int	ggain )

Set the ggain value.

This function sets the ggain value for specfic color temperature.

Parameters

[in]	colorTemp	- color temperature
[in]	ggain	- ggain

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_Ggain_onSource()

tvError_t SetColorTemp_Ggain_onSource	(	tvColorTemp_t	colorTemp,
		int	ggain,
		int	sourceId,
		int	saveOnly )

Sets or saves the ggain value.

This function sets or saves the ggain value for a specfic color temperature and video source. If it is set operation (saveOnly=0)
the rgb gain and offset for the specified colour temperature will be loaded in white balance module and
the new green gain value from this API will be updated, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes. If it is save operation (saveOnly =1) then the ggain will be saved for the specific video source and colour temperature. The saved ggain value should be automatically applied in white balance module when the colour temperaure choice is made as result of picture mode change or primary video format change or primary video source change.

Parameters

[in]	colorTemp	- Color temperature value to be save/set. Valid value will be a member of tvColorTemp_t
[in]	ggain	- Ggain Value to be set. Valid range is (0 - 2047)
[in]	sourceId	- SourceId value.
[in]	saveOnly	- Save=1 / Set=0 ( 0 for ggain value will be applied to PQ HW. i.e changes can be visible immediately on screen 1 for ggain value will be saved and applied later i.e changes not visible immediately for current video)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_R_post_offset()

tvError_t SetColorTemp_R_post_offset	(	tvColorTemp_t	colorTemp,
		int	rpostoffset )

Set the rpostoffset value.

This function sets the rpostoffset value for specfic color temperature.

Parameters

[in]	colorTemp	- Color Temperature
[in]	rpostoffset	- rpostoffset

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_R_post_offset_onSource()

tvError_t SetColorTemp_R_post_offset_onSource	(	tvColorTemp_t	colorTemp,
		int	rpostoffset,
		int	sourceId,
		int	saveOnly )

Sets or saves the rpostoffset value.

This function sets or saves the rpostoffset value for a specfic color temperature and video source. If it is set operation (saveOnly=0)
the rgb gain and offset for the specified colour temperature will be loaded in white balance module and
the new rpostoffset gain value from this API will be updated, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes. If it is save operation (saveOnly =1) then the rpostoffset will be saved for the specific video source and colour temperature. The saved rpostoffset value should be automatically applied in white balance module when the colour temperaure choice is made as result of picture mode change or primary video format change or primary video source change.

Parameters

[in]	colorTemp	- Color temperature value to be save/set. Valid value will be a member of tvColorTemp_t
[in]	rpostoffset	- Rpostoffset Value to be set. Valid range is (-1024 to +1023)
[in]	sourceId	- SourceId value.
[in]	saveOnly	- Save=1 / Set=0 ( 0 for rpostoffset value will be applied to PQ HW. i.e changes can be visible immediately on screen 1 for rpostoffset value will be saved and applied later i.e changes not visible immediately for current video)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_Rgain()

tvError_t SetColorTemp_Rgain	(	tvColorTemp_t	colorTemp,
		int	rgain )

Set the rgain value.

This function sets the rgain value for specfic color temperature.

Parameters

[in]	colorTemp	- color temperature
[in]	rgain	- rgain

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemp_Rgain_onSource()

tvError_t SetColorTemp_Rgain_onSource	(	tvColorTemp_t	colorTemp,
		int	rgain,
		int	sourceId,
		int	saveOnly )

Sets or saves the rgain value.

This function sets or saves the rgain value for a specfic color temperature and video source. If it is set operation (saveOnly=0)
the rgb gain and offset for the specified colour temperature will be loaded in white balance module and
the new red gain value from this API will be updated, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes. If it is save operation (saveOnly =1) then the rgain will be saved for the specific video source and colour temperature. The saved rgain value will be automatically applied in white balance module when the colour temperaure choice is made as result of picture mode change or primary video format change or primary video source change.

Parameters

[in]	colorTemp	- Color temperature value to be save/set. Valid value will be a member of tvColorTemp_t
[in]	rgain	- Rgain Value to be set. Valid range is (0 - 2047)
[in]	sourceId	- SourceId value.
[in]	saveOnly	- Save=1 / Set=0 ( 0 for rgain value will be applied to PQ HW. i.e changes can be visible immediately on screen 1 for rgain value will be saved and applied later i.e changes not visible immediately for current video)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetColorTemperature()

tvError_t SetColorTemperature ( tvColorTemp_t colorTemp )

Sets the color temperature to driver register(s)

This function updates the new color temperature value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] colorTemp - Color temperature value to be set. Valid value will be a member of tvColorTemp_t

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetColorTemperature()

◆ SetColorTemperatureUser()

tvError_t SetColorTemperatureUser	(	int	rgbType,
		int	value )

Set Color Temperature User.

This function update RGB(WhiteBalance) values for user colortemperature

Parameters

[in]	rgbType	- rgb type
[in]	value	- value

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetContrast()

tvError_t SetContrast ( int contrast )

Sets the contrast value to driver register(s)

This function updates the new contrast value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected.

Parameters

[in] contrast - Contrast value to be set.Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetContrast()

◆ SetCurrentBacklightMode()

tvError_t SetCurrentBacklightMode ( tvBacklightMode_t blMode )

Sets the backlight mode.

This function sets the backlight mode.

Parameters

[in] blMode - Backlight mode to be set. Valid value can be one of the member of tvBacklightMode_t". If more than one value is bitwise OR-ed and passed then the function should return invalid param.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetSupportedBacklightModes(),GetCurrentBacklightMode()

◆ SetCurrentComponentHue()

tvError_t SetCurrentComponentHue	(	tvDataComponentColor_t	blHueColor,
		int	hue )

Sets current component hue.

This function updates the component hue value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in]	blHueColor	- Component color. Valid value will be a member of tvDataComponentColor_t
[in]	hue	- Hue value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() and SetCMSState() should be called before calling this API

See also: SetCMSState()

◆ SetCurrentComponentLuma()

tvError_t SetCurrentComponentLuma	(	tvDataComponentColor_t	blLumaColor,
		int	Luma )

Sets the current component luma value.

This function updates the component luma value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in]	blLumaColor	- Component color. Valid value will be a member of tvDataComponentColor_t
[in]	Luma	- Luma value to be set. Valid range is (0 - 30)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() and SetCMSState() should be called before calling this API

See also: SetCMSState()

◆ SetCurrentComponentSaturation()

tvError_t SetCurrentComponentSaturation	(	tvDataComponentColor_t	blSaturationColor,
		int	saturation )

Sets current component saturation.

This function updates the component saturation value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in]	blSaturationColor	- Component color. Valid value will be one of the member of tvDataComponentColor_t. If more than one value is bitwise OR-ed and passed then the function should return invalid param.
[in]	saturation	- Saturation value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() and SetCMSState() should be called before calling this API

See also: SetCMSState()

◆ SetDynamicContrast()

tvError_t SetDynamicContrast ( const char * dynamicContrastEnable )

Sets the dynamic contrast.

This function updates the dynamic contrast state to PQ module. The change takes effect for current primary video source selected, video format played and picture mode selected, but not saved in picture profile database. The value is discarded and default value from picture profile database is used when primary video format or primary video source or picture mode changes.

Parameters

[in] dynamicContrastEnable - Dynamic contrast enable flag value (valid values are "enabled" for enable and "disabled" for disable)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetDynamicContrast()

◆ SetGammaMode()

tvError_t SetGammaMode ( int mode )

Enable or disable gamma mode.

This function enables or disables the gamma mode.

Parameters

[in] mode - Mode

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetGammaPattern()

tvError_t SetGammaPattern	(	int	is_10_bit,
		int	R_Value,
		int	G_Value,
		int	B_Value )

Sets the gamma pattern.

This function sets the primary color level at 10bit resolution( 0 - 1023 ). Should bypass all PQ elements
and display the full screen pattern of the primary colour passed. This function will only set and does'nt save the value.

Parameters

[in]	is_10_bit	- Value to check if red/green/blue paramter is 10 bit resolution or 8 bit resolution. Valid values are ( 0 for is 10 bit, 1 for 8 bit). If 8 bit resolution is passed values should be converted to 10 bit by 2 bit left shift and then used.
[in]	R_Value	- Red level of input pattern. Valid range is ( 0 - 1023 for 10 bit and 0 to 255 for 8 bit )
[in]	G_Value	- Green level of input pattern. Valid range is ( 0 - 1023 for 10 bit and 0 to 255 for 8 bit )
[in]	B_Value	- Blue level of input pattern. Valid range is ( 0 - 1023 for 10 bit and 0 to 255 for 8 bit )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() and SetGammaPatternMode(true) should be called before calling this API

See also: SetGammaPatternMode()

◆ SetGammaTable()

tvError_t SetGammaTable	(	unsigned short *	pData_R,
		unsigned short *	pData_G,
		unsigned short *	pData_B,
		unsigned short	size )

Sets the gamma calibrated values to gamma HW for current selected colour temperature.

This function sets the gamma calibrated values(0 - 1023) for the primary colors to gamma Hardware for the current selected colour temperature, but they are not saved in picture profile database. The gamma values will be discarded and default value from picture profile database is used on colour temperature value change as a result of picture mode change or primary video source change or primary vidoe format change.

Parameters

[in]	pData_R	- Array of gamma red values. Valid range is (0 - 1023)
[in]	pData_G	- Array of gamma green values. Valid range is (0 - 1023)
[in]	pData_B	- Array of gamma blue values. Valid range is (0 - 1023)
[in]	size	- Common size of each array. Valid range is (0 - 256)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetGrayPattern()

tvError_t SetGrayPattern ( int YUVValue )

Sets the gray pattern value.

This function sets the various gray pattern levels. Should bypass all PQ elements
and display the full screen grey pattern.

Parameters

[in] YUVValue - Gray level of input pattern to be set. Valid range is (0 - 255)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() and SetGammaPatternMode(true) should be called before calling this API

See also: SetGammaPatternMode()

◆ SetHue()

tvError_t SetHue ( int hue )

Sets the hue value to driver register(s)

This function updates the new hue value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] hue - Hue value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetHue()

◆ SetLocalDimmingLevel()

tvError_t SetLocalDimmingLevel ( int localDimmingLevel )

Sets the local dimming level.

This function updates the new local dimming level to hardware. The change is applied for current primary video source selected, video format played and picture mode selected and if successful will be saved in override picture profile database. The saved local dimming level value should be applied automatically whenever the current picture mode, current primary video format If peak brightness capablity of the panel changes as a result of local dimming level change reload the edid accordingly to update VSVDB string if current video format is handled via Dolby Vision core.

Parameters

[in] localDimmingLevel - Dimming level to set.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetLowLatencyState()

tvError_t SetLowLatencyState ( int lowLatencyIndex )

Sets the low latency state to driver register(s)

This function updates the new low latency state value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected and if successful will be saved in override picture profile database. The saved low latency state value should be applied automatically whenever the current picture mode, current primary video format

Parameters

[in] lowLatencyIndex - Value of the low latency index to be set. Valid values are ( 0 for disable, 1 for enable)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetRGBPattern()

tvError_t SetRGBPattern	(	int	r,
		int	g,
		int	b )

Sets the RGB values of RGB pattern.

This function sets the primary color level at 8bit resolution(0 - 255). This pattern is processed via PQ pipeline @ elemennts before it reaches the panel.

Parameters

[in]	r	- Red level of input pattern to be set. Valid range is (0 - 255)
[in]	g	- Green level of input pattern to be set. Valid range is (0 - 255)
[in]	b	- Blue level of input pattern to be set. Valid range is (0 - 255)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetSaturation()

tvError_t SetSaturation ( int saturation )

Sets the saturation value to driver register(s)

This function updates the new saturation value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] saturation - Saturation value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetSaturation()

◆ SetSharpness()

tvError_t SetSharpness ( int sharpness )

Sets the sharpness value to driver register(s)

This function updates the new sharpness value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected

Parameters

[in] sharpness - Sharpness value to be set. Valid range is (0 - 100)

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetSharpness()

◆ SetTint()

tvError_t SetTint ( int tint )

Sets the tint value to driver register(s)

This function updates the new tint value to hardware. The change is applied for current primary video source selected, video format played and picture mode selected.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetTVBacklightGlobalFactor()

tvError_t SetTVBacklightGlobalFactor	(	int	value,
		int	rangeMidPointValue )

Set TV Backlight Global Factor.

This function controls the backlight through backlight global factor.

Parameters

[in]	value	- value
[in]	rangeMidPointValue	- Range Mid point value

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ SetTVDimmingMode()

tvError_t SetTVDimmingMode ( const char * dimmingMode )

Sets the backlight dimming mode.

This function updates the new dimming mode to hardware. The change is applied for current primary video source selected, video format played and picture mode selected. If peak brightness capablity of the panel changes as a result of dimming mode change reload the edid accordingly to update VSVDB string if video format currently playing is handled via Dolby Vision core.

Parameters

[in] dimmingMode - Dimming mode to be set. Valid values are ( "local", "fixed", "global" )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

Todo: : instead of char* use tvDimmingMode_t enum

◆ SetTVDolbyVisionMode()

tvError_t SetTVDolbyVisionMode ( const char * dolbyMode )

Sets dolby vision mode. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function sets the Dolby vision mode in Dolby vision core. The change takes effect for current primary video source selected, primary video format if handled via Dolby vision core and picture mode selected, but not saved for future use. The value is discarded if primary video format or primary video source or picture mode changes.

Parameters

[in] dolbyMode - Dolby vision mode to be set. Valid values can be one of the strings from pic_modes_t.name parameter returned by GetTVSupportedDolbyVisionModesODM

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

See also: GetTVDolbyVisionMode()

◆ SetTVHDR10Mode()

tvError_t SetTVHDR10Mode ( const char * hdr10Mode )

Sets the HDR10 mode. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function sets the HDR10 mode in Dolby vision core. The change takes effect for current primary video source selected, primary video format if handled via Dolby vision core and picture mode selected, but not saved for future use. The value is discarded if primary video format or primary video source or picture mode changes.

Parameters

[in] hdr10Mode - HDR10 mode to be set. Valid values can be one of the strings from pic_modes_t.name parameter returned by GetTVSupportedHDR10ModesODM

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ SetTVHLGMode()

tvError_t SetTVHLGMode ( const char * hlgMode )

Sets the HLG mode. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function sets the HLG mode in Dolby vision core. The change takes effect for current primary video source selected, primary video format if handled via Dolby vision core and picture mode selected, but not saved for future use. The value is discarded if primary video format or primary video source or picture mode changes.

Parameters

[in] hlgMode - HLG mode to be set. Valid values can be one of the strings from pic_modes_t.name parameter returned by GetTVSupportedHLGModesODM

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ SetTVPictureMode()

tvError_t SetTVPictureMode ( const char * pictureMode )

Sets the Picture Mode.

This function updates the picture mode and reloads all the associated picture properties for the picture mode. This applies to current selected primary video source and primary video format, if successful the association of picture mode to the current video source and current primary video format is saved in override picture profile database. The associated picture mode and all the associated picture properties will be reloaded again when the current video source and current primary video format are selected in future.

Parameters

[in] pictureMode - Picture mode to be set.Valid values are as per values returned by pic_modes_t.name parmaeter from GetTVSupportedPictureModes API. The size of string will be PIC_MODE_NAME_MAX.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

See also: GetTVPictureMode()

◆ setWakeupConfig()

tvError_t setWakeupConfig	(	const tvWakeupSrcType_t	src_type,
		const bool	value )

Sets wake-up configuration.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function enables/disables the specific deepsleep wake-up source

Parameters

[in]	src_type	- Wakeup source type. Valid value will be a member of tvWakeupSrcType_t
[in]	value	- Enable/disable wakeup source to be set ( 0 for disable and 1 for enable )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, write failure, etc

Precondition: TvInit() should be called before calling this API

◆ setWBctrl()

tvError_t setWBctrl	(	char *	inputSrc,
		char *	colorTemp,
		char *	color,
		char *	ctrl,
		int	value )

Sets the white balance control. To be deprecated soon.

Note: SOC vendors can stub these ODM functions and mark it as weak

This function sets the white balance for a specific source, color, color temperature and control.

Parameters

[in]	inputSrc	- Source of input to be set. Valid values are ( "HDMI", "TV", "AV" )
[in]	colorTemp	- Color temperature value to be set. Valid values are ( "custom", "normal", "cool", "warm" )
[in]	color	- Color to be set. Valid values are ( "red", "blue", "green" )
[in]	ctrl	- Control to be set. Valid values are ( "gain", "offset" )
[in]	value	- Values to be set for the specific control. Valid range : for gain is ( 0 to 2047 ), for offset is ( -1024 to 1024 )

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- When the input value is not valid
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: tvInit() should be called before calling this API

◆ splitstringsandvaluefrombuffer()

void splitstringsandvaluefrombuffer	(	char *	buffer,
		pic_modes_t *	availableModes[],
		unsigned short *	totalcount )

Parse buffer and return string values,index & total count.

This function parses the buffer returned through ReadAllModeConfigfile() and returns the string value,index and their count.

Parameters

[in]	buffer	- Buffer to split
[in]	availableModes	- avilable modes
[out]	totalcount	- total count

Precondition: TvInit() should be called before calling this API

◆ splitstringsfrombuffer()

void splitstringsfrombuffer	(	char *	buffer,
		char *	availableModes,
		unsigned short *	totalcount )

Parse buffer and return string values & total count.

This function parses the buffer returned through ReadAllModeConfigfile() and returns the string value and their count.

Parameters

[in]	buffer	- Buffer to split
[in]	availableModes	- avilable modes
[out]	totalcount	- total count

Precondition: TvInit() should be called before calling this API

◆ SwitchEDID()

void SwitchEDID ( int pqmode )

Switch EDID.

This Function updates the EDID for given picture mode

Parameters

[in] pqmode - picture quality mode

Precondition: TvInit() should be called before calling this API

◆ tvInit()

tvError_t tvInit ( )

Initialises TV Settings HAL.

This function is used to initialize the TV Setting HAL APIs. All dependent vendor specific driver modules for implementing TV Settings HAL are expected to be initialised when this call return successfully. Calling TvInit() API more than once without a TvTerm() API call should return failure. Any TV Settings HAL API called before TvInit() API should return failure.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is already initialized
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

See also: TvTerm()

◆ tvSD3toCriSyncInit()

tvError_t tvSD3toCriSyncInit ( )

Sync the calibrated data to driver.

This function is to read the calibration data from serialization area and sync to driver during init.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

◆ tvTerm()

tvError_t tvTerm ( )

De-initialises TV Settings HAL.

This function should terminate the TV Settings HAL APIs. All dependent vendor specific driver modules for implementing TV Settings HAL are expected to be terminated when this call return successfully. Calling TvTerm() API more than once without a TvInit() API call should return failure. Any TV Settings HAL API called after TvTerm() and before TvInit() API should return failure.

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_STATE	- Interface is already terminated
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

◆ UpdateEDIDAndSetDimmingLevel()

tvError_t UpdateEDIDAndSetDimmingLevel ( int dimmingLevel )

Set the EDID and dimming level.

This function Update EDID and set dimming level for current Picture mode

Parameters

[in] dimmingLevel - Dimming level

Returns: tvError_t

Return values

tvERROR_NONE	- Success
tvERROR_INVALID_PARAM	- Input parameter is invalid
tvERROR_INVALID_STATE	- Interface is not initialized
tvERROR_OPERATION_NOT_SUPPORTED	- Operation is not supported
tvERROR_GENERAL	- Underlying failures - SoC, memory, etc

Precondition: TvInit() should be called before calling this API

	TVSetting HAL 0.2.0

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ __BL_PARA__

◆ BACKLIGHT_CURVE_MAX_INDEX

◆ CONTROL_COUNT

◆ DIMMING_MODE_MAX

◆ DIMMING_MODE_NAME_SIZE

◆ EXPECTED_FILE_SIZE

◆ GAIN_MAX

◆ GAIN_MIN

◆ GENERIC_MODE_CONFIG_FILE

◆ MAX_STRING_SIZE

◆ OFFSET_MAX

◆ OFFSET_MIN

◆ PIC_MODE_NAME_MAX

◆ PIC_MODES_SUPPORTED_MAX

Typedef Documentation

◆ bl_para_t

◆ getWBInfo_t

◆ input_source_offset_t

◆ pic_modes_t

◆ tvBacklightInfo_t

◆ tvVideoContentChangeCB

◆ tvVideoFormatChangeCB

◆ tvVideoFrameRateChangeCB

◆ tvVideoResolutionChangeCB

Enumeration Type Documentation

◆ fp_mfrColorTemp_t

◆ input_source_offset_e

Function Documentation

◆ areEqual()

◆ ConvertHDRFormatToContentFormat()

◆ ConvertTVColorToVendorColor()

◆ ConvertVideoFormatToHDRFormat()

◆ enableWBmode()

◆ GetAllSupportedPicModeIndex()

◆ GetAspectRatio()

◆ GetBacklight()

◆ GetBrightness()

◆ GetCMSDefault()

◆ GetColorTemp_B_post_offset()

◆ GetColorTemp_B_post_offset_onSource()

◆ GetColorTemp_Bgain()

◆ GetColorTemp_Bgain_onSource()

◆ GetColorTemp_G_post_offset()

◆ GetColorTemp_G_post_offset_onSource()

◆ GetColorTemp_Ggain()

◆ GetColorTemp_Ggain_onSource()

◆ GetColorTemp_R_post_offset()

◆ GetColorTemp_R_post_offset_onSource()

◆ GetColorTemp_Rgain()

◆ GetColorTemp_Rgain_onSource()

◆ GetColorTemperature()

◆ GetContrast()

◆ GetCurrentBacklightMode()

◆ GetCurrentComponentHue()

◆ GetCurrentComponentLuma()

◆ GetCurrentComponentSaturation()

◆ GetCurrentContentFormat()

◆ GetCurrentPQIndex()

◆ GetCurrentVideoFormat()

◆ GetCustomPQModeIndex()

◆ GetDefaultPanelID()

◆ GetDolbyModeIndex()

◆ GetDriverEquivalentBLForCurrentFmt()

◆ GetDynamicContrast()

◆ GetGammaTable()

◆ GetGrayPattern()

◆ GetHDR10ModeIndex()

◆ GetHLGModeIndex()

◆ GetHue()

◆ GetLDIMAndEDIDLevel()

◆ GetLocalDimmingLevel()

◆ GetLowLatencyState()

◆ GetNumberOfModesupported()