Skip to content

Commit

Permalink
gh #46 Remove ODM specific apis - phase1
Browse files Browse the repository at this point in the history
  • Loading branch information
@arjunbinu @arjunbinusky
arjunbinu authored and arjunbinusky committed Nov 25, 2024
1 parent edf12e6 commit 974f0b1
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 281 deletions.
2 changes: 1 addition & 1 deletion include/tvSettings.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ tvError_t GetCurrentVideoFrameRate(tvVideoFrameRate_t *format);
*
* @pre TvInit() should be called before calling this API
*/
tvError_t GetCurrentVideoSource(int *currentSource);
tvError_t GetCurrentVideoSource(tvVideoSrcType_t *currentSource);

/**
* @brief Gets supported video sources of the system.
Expand Down
27 changes: 0 additions & 27 deletions include/tvSettingsExtODM.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,33 +59,6 @@ extern "C"
{
#endif

/**
* @brief Reads PQ capability information sections PQ capability configuration 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 PQ capability configuration file. @n
* The file format is predefined and a template file is supplied by RDK.
*
* @param[in] param - Heading of the section in PQ capability configuration file.
* @param[out] rangeInfo - Range information for the specified section to be returned.
* @param[out] pqmodeInfo - Picture mode information for the specified section to be returned.
* @param[out] formatInfo - Video format information for the specified section to be returned.
* @param[out] sourceInfo - Video source information for the specified section to be returned.
* @param[out] platformsupport - Platform support information for the specified section to be returned.
* @param[out] index - Index information for the specified section to be returned.
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*/
int ReadCapablitiesFromConfODM(std::string &rangeInfo,std::string &pqmodeInfo,std::string &formatInfo,std::string &sourceInfo,
std::string param, std::string & platformsupport, std::string & index);

/**
* @brief Gets the current white balance info. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
Expand Down
254 changes: 1 addition & 253 deletions include/tvSettingsODM.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,92 +56,6 @@ extern "C"
{
#endif

/**
* @brief Gets supported video formats of the system. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function returns all the supported content formats.
*
* @param[out] videoFormats - Bitwise ORed values of enum ::tvVideoHDRFormat_t
* @param[out] numberOfFormats - Count of supported video formats. Min should be 1
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*/
tvError_t GetSupportedVideoFormatsODM(unsigned int * videoFormats,unsigned short *numberOfFormats);

/**
* @brief 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
*
* @return tvVideoHDRFormat_t
*
* @retval tvVideoHDRFormat_SDR - SDR format
* @retval tvVideoHDRFormat_HLG - HLG Format
* @retval tvVideoHDRFormat_HDR10 - HDR10 format
* @retval tvVideoHDRFormat_HDR10PLUS - HDR10 plus format
* @retval tvVideoHDRFormat_DV - DV format.
*
* @pre tvInit() should be called before calling this API
*/
tvVideoHDRFormat_t GetCurrentVideoFormatODM(void);

/**
* @brief Gets supported backlight dimming modes of the system. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function returns all the supported backlight dimming modes.
*
* @param[out] dimmingModes - array of dimming modes names. Valid values are "fixed", "local" and "global"
* @param[out] numDimmingModes - Count of supported dimming modes. Min should be 1
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*/
tvError_t GetTVSupportedDimmingModesODM(char **dimmingModes,unsigned short *numDimmingModes);

/**
* @brief Returns ::tvhdr_type_t enum for given ::tvVideoHDRFormat_t enum. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function ::tvhdr_type_t enum for given ::tvVideoHDRFormat_t enum.
*
* @param[in] videoFormat - Video format. Valid values can be member of ::tvVideoHDRFormat_t
*
* @return int - Valid values can be member of ::tvhdr_type_t
*
* @pre tvInit() should be called before calling this API
*/
int ConvertVideoFormatToHDRFormatODM(tvVideoHDRFormat_t videoFormat);

/**
* @brief Returns ::tvVideoHDRFormat_t enum for given ::tvhdr_type_t enum. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function ::tvhdr_type_t enum for given ::tvhdr_type_t enum.
*
* @param[in] hdrFormat - hdr format. Valid values can be member of ::tvhdr_type_t
*
* @return int - Valid values can be member of ::tvVideoHDRFormat_t
*
* @pre tvInit() should be called before calling this API
*/
int ConvertHDRFormatToContentFormatODM(tvhdr_type_t hdrFormat);

/**
* @brief Stores the new gamma test points in non volatile area. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
Expand Down Expand Up @@ -235,134 +149,6 @@ tvError_t GetWBctrl(char *inputSrc, char *colortemp, char *color, char *ctrl, in
*/
tvError_t SaveColorTemperatureUser(tvRGBType_t rgbType, int value,int boost);

/**
* @brief Gets the current CMS default value. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function returns the default CMS value
*
* @param[out] component_type - Component type. Valid value will be a member of ::tvComponentType_t
*
* @return int
*
* @retval 15 - Luma default value
* @retval 50 - Hue or saturation default value
* @retval -1 - Input parameter is invalid
*
* @pre tvInit() should be called before calling this API
*/
int GetCMSDefault(tvComponentType_t component_type);


/**
* @brief 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.
*
* @param[out] panelid - Panel ID string to be returned.
*
* @return int - Valid values can be member of ::tvVideoHDRFormat_t
*
* @retval 0 - Success
* @retval -1 - General failure.
*
* @pre tvInit() should be called before calling this API
*/
int GetPanelIDODM(char* panelid);

/**
* @brief Reads the WB/Gamma/Peak brightness calibration info and passes it to the PQ drivers at bootup. To be deprecated soon.
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function reads the WB/Gamma/Peak brightness calibration info and passes it to the PQ drivers at bootup.
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*/
tvError_t TvSyncCalibrationInfoODM(); //Reading from Serialisation area calib values (gamma/wb/peak brightness) and update drivers.


/**
* @brief 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.
*
* @param[in] file - The name of the file from which PQ capability information sections need to be read.
* @param[out] cpybuffer - The return buffer (max size 512 bytes), where PQ capability information sections are copied to.
* @param[in] searchstring - Heading of the section.
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*/
tvError_t ReadAllModeConfigfileODM(const char *file, char *cpybuffer, const char *searchstring);


/**
* @brief Gets the supported DV 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 Dolby Vision modes and their count
*
* @param[out] dvModes[] - List of available DV modes. Refer ::pic_modes_t and ::tvDolbyMode_t @n
* Valid values are "dark" and & "bright" for ::pic_modes_t.name @n
* Valid values are member of ::tvDolbyMode_t tvDolbyMode_Dark and ::tvDolbyMode_t tvDolbyMode_Bright @n
* for ::pic_modes_t.value.
* @param[out] count - Count of supported DV modes. Max and min is 2
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_OPERATION_NOT_SUPPORTED - Operation is not supported
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*/
tvError_t GetTVSupportedDolbyVisionModesODM(pic_modes_t *dvModes[],unsigned short *count);


/**
* @brief 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.
*
* @param[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
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
*
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_OPERATION_NOT_SUPPORTED - Operation is not supported
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre tvInit() should be called before calling this API
*
* @see GetTVDolbyVisionMode()
*/
tvError_t SetTVDolbyVisionModeODM(const char * dolbyMode);


/**
* @brief Gets the supported HLG modes and their count. To be deprecated soon.
Expand Down Expand Up @@ -460,44 +246,6 @@ tvError_t GetTVSupportedHDR10ModesODM(pic_modes_t *dvModes[],unsigned short *cou
*/
tvError_t SetTVHDR10ModeODM(const char * hdr10Mode);

/**
* @brief Gets current video Source
* @note SOC vendors can stub these ODM functions and mark it as weak
*
* This function gets the video Source
*
* @param[out] currentSource - Current video source. Valid value will be a member of ::tvVideoSrcType_t
*
* @return tvError_t
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, etc
*
* @pre TvInit() should be called before calling this API
*/
tvError_t GetCurrentSource(tvVideoSrcType_t *currentSource);

/**
* @brief 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
*
* @param[in] src_type - Wakeup source type. Valid value will be a member of ::tvWakeupSrcType_t
* @param[in] value - Enable/disable wakeup source to be set ( 0 for @a disable and 1 for @a enable )
*
* @return tvError_t
*
* @retval tvERROR_NONE - Success
* @retval tvERROR_INVALID_PARAM - Input parameter is invalid
* @retval tvERROR_INVALID_STATE - Interface is not initialized
* @retval tvERROR_GENERAL - Underlying failures - SoC, memory, write failure, etc
*
* @pre TvInit() should be called before calling this API
*/
tvError_t SetWakeupConfig(const tvWakeupSrcType_t src_type, const bool value);

#ifdef __cplusplus
}
#endif
Expand All @@ -507,4 +255,4 @@ tvError_t SetWakeupConfig(const tvWakeupSrcType_t src_type, const bool value);
/** @} */ // End of TV_SETTINGS_ODM_H
/** @} */ // End of TV_Settings_HAL
/** @} */ // End of TV_Settings
/** @} */ // End of HPK
/** @} */ // End of HPK

0 comments on commit 974f0b1

Please sign in to comment.