Skip to content

gh #62 Update HAL header descriptions with PQ capability information #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

gh #62 Update HAL header descriptions with PQ capability information #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e62642e
gh #62 Update HAL header descriptions with PQ capability information …
arjunbinu Mar 4, 2025
82fa05f
Merge branch 'develop' into feature/gh62_pqcapability_description_HAL…
arjunbinu Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions include/tvSettings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,8 @@ tvError_t SetBacklight(int backlight);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please get approval from one of our architects?

*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -577,6 +579,8 @@ tvError_t GetTVDimmingMode(char *dimmingMode);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -646,6 +650,8 @@ tvError_t GetLocalDimmingLevel(ldimStateLevel_t *ldimStateLevel);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -714,6 +720,8 @@ tvError_t GetBrightness(int *brightness);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -783,6 +791,8 @@ tvError_t GetContrast(int *contrast);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -850,6 +860,8 @@ tvError_t GetSharpness(int *sharpness);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -917,6 +929,8 @@ tvError_t GetSaturation(int *saturation);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -984,6 +998,8 @@ tvError_t GetHue(int *hue);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -1052,6 +1068,8 @@ tvError_t GetColorTemperature(tvColorTemp_t *colorTemp);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -1119,6 +1137,8 @@ tvError_t GetAspectRatio(tvDisplayMode_t *dispMode);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -1182,6 +1202,8 @@ tvError_t GetLowLatencyState(int *lowlatencystate);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -1369,6 +1391,8 @@ tvError_t GetTVDolbyVisionMode(tvDolbyMode_t *dolbyMode);
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pq_mode - Picture mode index. Valid value will be a member of ::tvPQModeIndex_t
Expand Down Expand Up @@ -1467,6 +1491,8 @@ tvError_t SetTVPictureMode(const char * pictureMode);
* This function saves the picturemode in picture profile database for the specific primary video format type
* and primary video source. The saved picture mode should be applied automatically whenever the
* specified specified primary video format is played and specified primary video source is selected.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value. Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pictureMode - Picture mode value to be saved. Valid values are as per values returned by
Expand Down Expand Up @@ -1885,6 +1911,8 @@ tvError_t GetGammaTable(unsigned short *pData_R, unsigned short *pData_G, unsign
* 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.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] colortemp - Color temperature. Valid value will be member of ::tvColorTemp_t
* @param[out] pData_R - Array of gamma red values. Valid range is (0 - 1023)
Expand Down Expand Up @@ -1950,6 +1978,8 @@ tvError_t SetDvTmaxValue(int value);
* This function saves the Dolby vision TMAX paramaeter in picture profile database for the specified LDIM state level.
* The saved TMAX value will be applied in Dolby Vision core whenever the specified ldim state level is selected
* as a result of picture mode change or primary video source change or primary vidoe format change.
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] state - LDIM state level. Refer ::ldimStateLevel_t
* @param[in] value - Value of the TMAX to be saved. Valid range is (0 to 10000)
Expand Down Expand Up @@ -2718,6 +2748,8 @@ tvError_t GetCustom2PointWhiteBalance(tvWBColor_t color, tvWBControl_t control,
* specified specified primary video format is played and specified primary video source is selected.
* Gain - Modifies the intensity of Red, Green, and Blue at the brighter level
* Offset - Modifies the intensity of Red, Green, and Blue at the darker level
* The supported formats, sources, and modes must be fetched from the configuration details of each specific feature in the
* PQ capability configuration file.
*
* @param[in] videoSrcType - Source input value.Valid value will be a member of ::tvVideoSrcType_t
* @param[in] pictureMode - Picture mode value to be saved.Valid values are as per values returned by
Expand Down