dsAudio.h

Go to the documentation of this file.

/*
 * If not stated otherwise in this file or this component's Licenses.txt file the
 * following copyright and licenses apply:
 *
 * Copyright 2016 RDK Management
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
 
/**
 * @file dsAudio.h
 */
 
 
 
/**
* @defgroup devicesettings
* @{
* @defgroup hal
* @{
**/
 
 
#ifndef _DS_AUDIOOUTPORT_H_
#define _DS_AUDIOOUTPORT_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <sys/types.h>
#include "dsError.h"
#include "dsTypes.h"
 
typedef void (*dsAudioOutPortConnectCB_t)(dsAudioPortType_t portType, unsigned int uiPortNo, bool isPortCon);
 
/**
 * @brief Callback function used to notify applications of Audio Format change
 *
 * HAL Implementation should call this method to deliver updated Audio Format info
 * to the application
 *
 * @param audioFormat     Current audio format of the content playing
 *
 *
 * @return None.
 */
typedef void (*dsAudioFormatUpdateCB_t)(dsAudioFormat_t audioFormat);
 
/** @addtogroup DSHAL_AUDIO_API Device Settings HAL Audio Public API
 *  @ingroup devicesettingshalapi
 *
 *  Described herein are the DeviceSettings HAL types and functions that are part of the
 *  Audio subsystem. The Audio subsystem manages audio hardware operations.
 *
 *  @{
 */
 
/**
 * @brief Initialize the underlying Audio Port sub-system.
 * 
 * This function must initialize all the audio specific output ports. It must return
 * ::dsERR_OPERATION_NOT_SUPPORTED when no audio port is present in the device (e.g. a 
 * headless gateway device).
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsAudioPortInit API was successfully called using iarmbus call.
 * @retval dsERR_GENERAL Indicates error due to general failure.
 */
dsError_t  dsAudioPortInit();
 
/**
 * @brief Get the audio port handle.
 * 
 * This function returns the handle for the type of audio port requested. Must return
 * ::dsERR_OPERATION_NOT_SUPPORTED if an unavailable audio port is requested.
 *
 * @param[in] type      Indicates the type of audio port (HDMI, SPDIF and so on).
 * @param[in] index     Index of audio port (0, 1, ...).
 * @param[out] handle   Indicates pointer to hold the handle of the specified audio port.
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsGetAudioPort API was successfully called using iarmbus call.
 * @retval dsERR_GENERAL Indicates error due to general failure.
 */
dsError_t  dsGetAudioPort(dsAudioPortType_t type, int index, intptr_t *handle);
 
/**
 * @brief Get the encoding type of an audio port.
 *
 * This function returns the current audio encoding setting for the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] encoding Pointer to hold the encoding setting of the audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsGetAudioEncoding(intptr_t handle, dsAudioEncoding_t *encoding);
 
/**
 * @brief Get the current audio format.
 *
 * This function returns the current audio format..
 *
 * @param[in] handle:  Handle for the audio port
 * @param[out] audioFormat : Pointer to hold the audio format.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioFormat call is not implemented.
 */
dsError_t  dsGetAudioFormat(intptr_t handle, dsAudioFormat_t *audioFormat);
 
/**
 * @brief Get the audio compressionof an audio port.
 *
 * This function returns the audio compression setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] compression Pointer to hold the compression setting of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsGetAudioCompression(intptr_t handle, int *compression);
 
/**
 * @brief Get the Dialog Enhancement level of an audio port.
 *
 * This function returns the audio compression setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] Dialog Enhancement level.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsGetDialogEnhancement(intptr_t handle, int *level);
 
/**
 * @brief Get the dolby audio mode status.
 *
 * This function returns the dolby audio mode status used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] Dolby volume mode.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsGetDolbyVolumeMode(intptr_t handle, bool *mode);
 
/**
 * @brief Get the Intelligent Equalizer Mode.
 *
 * This function returns the Intelligent Equalizer Mode setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] *mode. Intelligent Equalizer mode: 0 = Off, 1 = Open, 2 = Rich, 3 = focused,
 * 4 = balanced, 5 = warm, 6 = detailed
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsGetIntelligentEqualizerMode(intptr_t handle, int *mode);
 
/**
 * @brief To get the Dolby volume leveller
 *
 * This function will get the Volume leveller value used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *volLeveller  Volume Leveller setting
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetVolumeLeveller(intptr_t handle, dsVolumeLeveller_t* volLeveller);
 
 
/**
 * @brief To get the audio Bass
 *
 * This function will get the Bass used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *boost   Bass Enhancer boost value
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetBassEnhancer(intptr_t handle, int *boost);
 
 
/**
 * @brief To get the audio Surround Decoder
 *
 * This function will get enable/disable status of surround decoder
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *enabled  Surround Decoder enable/disable
 * @return dsError_t Error code.
 */
 
dsError_t  dsIsSurroundDecoderEnabled(intptr_t handle, bool *enabled);
 
 
/**
 * @brief To get the DRC Mode
 *
 * This function will get the Dynamic Range Control used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *mode     line/RF mode
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetDRCMode(intptr_t handle, int *mode);
 
 
/**
 * @brief To get the audio Surround Virtualizer level
 *
 * This function will get the Surround Virtualizer level used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *virtualizer    Surround virtualizer setting
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetSurroundVirtualizer(intptr_t handle, dsSurroundVirtualizer_t *virtualizer);
 
 
/**
 * @brief To get the audio Media intelligent Steering
 *
 * This function will get the Media Intelligent Steerinf
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *enabled      enable/disable MI Steering
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetMISteering(intptr_t handle, bool *enabled);
 
 
/**
 * @brief Get the Graphic Equalizer Mode.
 *
 * This function returns the Graphic Equalizer Mode setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] .
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsGetGraphicEqualizerMode(intptr_t handle, int *mode);
 
 
/**
 * @brief To get the supported MS12 audio profiles
 *
 * This function will get the list of supported ms12 audio profiles
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *profiles      List of supported audio profiles
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetMS12AudioProfileList(intptr_t handle, dsMS12AudioProfileList_t* profiles);
 
/**
 * @brief To get current audio profile selection
 *
 * This function will get the current audio profile configured
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [out] *profile    Audio profile configured currently
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetMS12AudioProfile(intptr_t handle, char *profile);
 
 
/**
 * @brief Get the supported ARC types of the connected ARC/eARC device
 *
 * This function gets the supported ARC types of the connected device on ARC/eARC port.
 *
 * @param[in] handle Handle for the HDMI ARC/eARC port.
 * @param[out] *types OR-ed value of supported ARC types
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsGetSupportedARCTypes was successfully called using iarmbus.
 */
 
dsError_t dsGetSupportedARCTypes(intptr_t handle, int *types);
 
 
/**
 * @brief Set Short Audio Descriptor retrieved from CEC for the connected ARC device
 *
 * This function sets the Short Audio Descriptor based on best available options
 * of Audio capabilities supported by connected ARC device. Required when ARC output
 * mode is Auto
 *
 * @param[in] handle Handle for the HDMI ARC/eARC port.
 * @param[in] All SADs retrieved from connected ARC device
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsGetSupportedARCTypes was successfully called using iarmbus.
 */
 
dsError_t dsAudioSetSAD(intptr_t handle, dsAudioSADList_t sad_list);
 
/**
 * @brief enable/disable ARC/EARC and route audio to connected device
 *
 * This function enables/disables ARC/EARC and routes audio to connected device.
 *
 * @param[in] handle Handle for the HDMI ARC/eARC port.
 * @param[in] arcStatus to enable/disable ARC/eARC feature
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsAudioEnableARC was successfully called using iarmbus.
 */
 
dsError_t dsAudioEnableARC(intptr_t handle, dsAudioARCStatus_t arcStatus);
 
/**
 * @brief Get the stereo mode of an audio port.
 * 
 * This function gets the stereo mode setting for a specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] stereoMode Pointer to hold the stereo mode setting of the
 * specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsGetStereoMode was successfully called using iarmbus.
 */
dsError_t  dsGetStereoMode(intptr_t handle, dsAudioStereoMode_t *stereoMode);
 
/**
 * @brief This function is used to get the current auto mode setting of the specified
 * audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] autoMode Pointer to hold the auto mode setting of the
 * specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsGetStereoAuto was successfully called using iarmbus.
 */
dsError_t  dsGetStereoAuto(intptr_t handle, int *autoMode);
 
/**
 * @brief Get the audio gain of an audio port.
 * 
 * This function returns the current audio gain for the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] gain Pointer to hold the gain value of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioGain call is not implemented.
 */
dsError_t  dsGetAudioGain(intptr_t handle, float *gain);
 
/**
 * @brief Get the current audio dB level of an audio port.
 * 
 * This function returns the current audio dB level for the specified audio port. 
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] db Pointer to hold the dB value of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioGain call is not implemented.
 */
dsError_t  dsGetAudioDB(intptr_t handle, float *db);
 
/**
 * @brief Get the current audio volume level of an audio port.
 * 
 * This function returns the current audio volume level for the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] level Pointer to hold the audio level value of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioLevel call is not implemented.
 */
dsError_t  dsGetAudioLevel(intptr_t handle, float *level);
 
/**
 * @brief Get the maximum audio dB level of an audio port.
 * 
 * This function returns the maximum audio dB level supported by the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] maxDb Pointer to hold the maximum audio dB value supported by the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the call was successful.
 */
dsError_t  dsGetAudioMaxDB(intptr_t handle, float *maxDb);
 
/**
 * @brief Get the minimum audio dB level of an audio port.
 * 
 * This function returns the minimum audio dB level supported by the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] minDb Pointer to hold the minimum audio dB value supported by the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the call was successful.
 */
dsError_t  dsGetAudioMinDB(intptr_t handle, float *minDb);
 
/**
 * @brief Get the optimal audio level of an audio port.
 * 
 * This function returns the optimal audio level (dB) for the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] optimalLevel Pointer to hold the optimal level value of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioOptimalLevel call is not implemented.
 */
dsError_t  dsGetAudioOptimalLevel(intptr_t handle, float *optimalLevel);
 
/**
 * @brief Get the audio delay in milliseconds
 *
 * This function will get the audio delay in milliseconds.
 *
 * @param [in] handle        Handle for the Output Audio port
 * @param [out] *audioDelayMs Audio delay in milliseconds
 * @return dsError_t Error code.
 */
dsError_t dsGetAudioDelay(intptr_t handle, uint32_t *audioDelayMs);
 
/**
 * @brief Get the audio delay offset in milliseconds
 *
 * This function will get the audio delay offset in milliseconds.
 *
 * @param [in] handle        Handle for the Output Audio port
 * @param [out] *audioDelayOffsetMs Audio delay offset in milliseconds
 * @return dsError_t Error code.
 */
dsError_t dsGetAudioDelayOffset(intptr_t handle, uint32_t *audioDelayOffsetMs);
 
/**
 * @brief Set the audio ATMOS outout mode
 *
 * This function will set the Audio Atmos output mode 
 *
 * @param [in] handle        Handle for the Output Audio port
 * @param [in] enable set audio ATMOS output mode
 * @return dsError_t Error code.
 */
dsError_t dsSetAudioAtmosOutputMode(intptr_t handle, bool enable);
  
/**
 * @brief Get the sink device ATMOS capability
 *
 * This function will get the sink device ATMOS capability
 *
 * @param [in] handle        Handle for the Output Audio port
 * @param [out] *capability sink device ATMOS capability
 * @return dsError_t Error code.
 */
dsError_t dsGetSinkDeviceAtmosCapability(intptr_t handle, dsATMOSCapability_t *capability);
 
/**
 * @brief Get the loop-through mode of an audio port.
 * 
 * This function is used to check if the audio port is configured for loop-through.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] loopThru Pointer to hold the loop-through setting of the specified audio.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioLoopThru call is not implemented.
 */
dsError_t  dsIsAudioLoopThru(intptr_t handle, bool *loopThru);
 
/**
 * @brief Get the audio mute status of an audio port.
 * 
 * This function is used to check whether the audio on a specified port is muted or not.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] muted Pointer to hold the mute setting of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioMute call is not implemented.
 */
dsError_t  dsIsAudioMute(intptr_t handle, bool *muted);
 
 
/**
 * @brief This function indicates whether the specified Audio port is enabled or not.
 *
 * @param[in]  handle      Handle of the Audio port.
 * @param[out] enabled    The address of a location to hold the Audio port enable state
 *                          on return (@a true when port is enabled, @a false otherwise).
 * @return Device Settings error code
 * @retval dsERR_NONE If sucessfully dsIsAudioPortEnabled api has been called using IARM support.
 * @retval dsERR_GENERAL General failure .
 */
dsError_t  dsIsAudioPortEnabled(intptr_t handle, bool *enabled);
 
 
/**
 * @brief This function is used to enable or disable the specified Audio port.
 *
 * @param[in] handle      Handle of the Audio port.
 * @param[in] enabled     Flag to control the Audio port state
 *                         (@a true to enable, @a false to disable)
 * @return Device Settings error code
 * @retval dsERR_NONE If sucessfully dsEnableAudioPort api has been called using IARM support.
 * @retval dsERR_GENERAL General failure.
 */
dsError_t  dsEnableAudioPort(intptr_t handle, bool enabled);
 
/**
 * @brief This function is used to enable or disable MS12 DAPV2 and DE feature.
 *
 * @param[in] handle      Handle of the Audio port.
 * @param[in] feature     Enums for MS12 features
 * @param[in] enable     Flag to control the MS12 features
 *                         (@a true to enable, @a false to disable)
 * @return Device Settings error code
 * @retval dsERR_NONE If API executed successfully.
 * @retval dsERR_GENERAL General failure.
 */
dsError_t  dsEnableMS12Config(intptr_t handle, dsMS12FEATURE_t feature,const bool enable);
 
/**
 * @brief This function is used to enable or disable Loudness Equivalence feature.
 *
 * @param[in] handle      Handle of the Audio port.
 * @param[in] enable     Flag to control the LE features
 *                         (@a true to enable, @a false to disable)
 * @return Device Settings error code
 * @retval dsERR_NONE If API executed successfully.
 * @retval dsERR_GENERAL General failure.
 */
dsError_t  dsEnableLEConfig(intptr_t handle, const bool enable);
 
/**
 * @brief To Get LE configuration
 *
 * This function is used to Get LE features
 *
 * @param [in] handle   Handle for the Output Audio port
 * @param [in] *enable  true if LE is enabled else False
 * @return dsError_t Error code.
 */
dsError_t dsGetLEConfig(intptr_t handle, bool *enable);
 
/**
 * @brief Set the encoding type of an audio port.
 * 
 * This function sets the audio encoding type to be used on the specified audio port.
 *
 * @param [in] handle     Handle for the audio output port.
 * @param [in] encoding   The encoding type to be used on the audio port.
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the call was successful.
 */
dsError_t  dsSetAudioEncoding(intptr_t handle, dsAudioEncoding_t encoding);
 
/**
 * @brief Set the audio compression of an audio port.
 * 
 * This function sets the audio compression type to be used on the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[in] compression Indicates the compression type to be used on the audio port.
 *
 * @return dsERR_NONE Indicates the call was successful.
 */
dsError_t  dsSetAudioCompression(intptr_t handle, int compression);
 
/**
 * @brief Get the Dialog Enhancement level of an audio port.
 * 
 * This function returns the audio compression setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] Dialog Enhancement level.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsSetDialogEnhancement(intptr_t handle, int level);
 
/**
 * @brief Get the dolby audio mode status.
 * 
 * This function returns the dolby audio mode status used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] Dolby volume mode.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsSetDolbyVolumeMode(intptr_t handle, bool mode);
 
/**
 * @brief Set the Intelligent Equalizer Mode.
 * 
 * This function returns the Intelligent Equalizer Mode setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[in] mode. Intelligent Equalizer mode: 0 = Off, 1 = Open, 2 = Rich, 3 = focused,
 * 4 = balanced, 5 = warm, 6 = detailed
 * @param[out] .
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsSetIntelligentEqualizerMode(intptr_t handle, int mode);
 
/**
 * @brief To set the Dolby volume leveller
 *
 * This function will set the Volume leveller value used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] volLeveller  Volume Leveller setting
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetVolumeLeveller(intptr_t handle, dsVolumeLeveller_t volLeveller);
 
 
/**
 * @brief To set the audio Bass
 *
 * This function will set the Bass used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] boost   Bass Enhancer boost value
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetBassEnhancer(intptr_t handle, int boost);
 
 
/**
 * @brief To set the audio Surround Decoder
 *
 * This function will enable/disable surround decoder
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] enabled  Surround Decoder enable/disable
 * @return dsError_t Error code.
 */
 
dsError_t  dsEnableSurroundDecoder(intptr_t handle, bool enabled);
 
 
/**
 * @brief To set the DRC Mode
 *
 * This function will set the Dynamic Range Control used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] mode     line/RF mode
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetDRCMode(intptr_t handle, int mode);
 
 
/**
 * @brief To set the audio Surround Virtualizer level
 *
 * This function will set the Surround Virtualizer level used in a given audio port
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] virtualizer    Surround virtualizer setting
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetSurroundVirtualizer(intptr_t handle, dsSurroundVirtualizer_t virtualizer);
 
 
/**
 * @brief To set the audio Media intelligent Steering
 *
 * This function will set the Media Intelligent Steerinf
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] enabled      enable/disable MI Steering
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetMISteering(intptr_t handle, bool enabled);
 
 
/**
 * @brief Get the Graphic Equalizer Mode.
 *
 * This function returns the Graphic Equalizer Mode setting used in the specified audio port.
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] .
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.
 */
dsError_t  dsSetGraphicEqualizerMode(intptr_t handle, int mode);
 
 
/**
 * @brief To set the ms12 audio profile
 *
 * This function will configure the user selected ms12 audio profile
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] *profile      Audio profile name
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetMS12AudioProfile(intptr_t handle, const char* profile);
 
 
/**
 * @brief Set the stereo mode of an audio port.
 * 
 * This function sets the stereo mode to be used on the specified audio port.
 *
 * @param[in] handle Handle for the audio output port.
 * @param[in] mode Indicates the stereo mode to be used on audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the dsSetStereoMode API was successfully called using iarmbus call.
 * @retval dsERR_GENERAL Indicates error due to general failure.
 */
dsError_t  dsSetStereoMode(intptr_t handle, dsAudioStereoMode_t mode);
 
/**
 * @brief This function sets the auto mode to be used on the specified audio port.
 *
 * @param[in] handle Handle for the audio output port.
 * @param[in] autoMode Indicates the auto mode to be used on audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the dsSetStereoAuto API was successfully called using iarmbus call.
 * @retval dsERR_GENERAL Indicates error due to general failure.
 */
dsError_t  dsSetStereoAuto(intptr_t handle, int autoMode);
 
/**
 * @brief Set the audio gain of an audio port.
 * 
 * This function sets the gain to be used on the specified audio port.
 *
 * @param[in] handle Handle for the audio output port.
 * @param[in] gain The gain to be used on the audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the call was successful.
 */
dsError_t  dsSetAudioGain(intptr_t handle, float gain);
 
/**
 * @brief This function sets the dB level to be used on the specified audio port.
 *
 * @param [in] handle  Handle for the audio output port.
 * @param [in] db      The dB level to be used on the audio port.
 * @return    Error Code.
 * @retval    ::dsError_t
 */
dsError_t  dsSetAudioDB(intptr_t handle, float db);
 
/**
 * @brief This function sets the audio volume level to be used on the specified audio port.
 *
 * @param [in] handle   Handle for the audio output port.
 * @param [in] level    The volume level to be used on the audio port.
 * @return    Error Code.
 * @retval    ::dsError_t
 */
dsError_t  dsSetAudioLevel(intptr_t handle, float level);
 
/**
 * @brief This function sets the audio ducking level to be used on the specified audio port based on the audio output mode.
 *
 * @param [in] handle   Handle for the audio output port.
 * @param [in] action   action type to start or stop ducking.
 * @param [in] type     ducing type is absolute or relative to current volume level.
 * @param [in] level    The volume level to be used on the audio port if output mode is expoert mode this will mute the audio.
 * @return    Error Code.
 * @retval    ::dsError_t
 */
dsError_t  dsSetAudioDucking(intptr_t handle, dsAudioDuckingAction_t action, dsAudioDuckingType_t, const unsigned char level);
 
/**
 * @brief Set loop-through mode of an audio port.
 * 
 * This function enables/disables audio loop-through on the specified audio port.
 *
 * @param[in] handle Handle for the audio output port.
 * @param[in] loopThru Boolean flag to enable/disable loop-through.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates the call was successful.
 */
dsError_t  dsEnableLoopThru(intptr_t handle, bool loopThru);
 
/**
 * @brief Mute or un-mute an audio port.
 * 
 * This function mutes or unmutes the specified audio output port.
 *
 * @param[in] handle Handle for the audio output port.
 * @param[in] mute Boolean flag to mute/un-mute the audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsAudioPortInit API was successfully called using iarmbus call.
 * @retval dsERR_GENERAL Indicates error due to general failure.
 */
dsError_t  dsSetAudioMute(intptr_t handle, bool mute);
 
/**
 * @brief This function is used to check whether the audio port supports Dolby MS11 Multistream Decode
 *
 * @param[in] handle Handle for the audio port.
 * @param[out] Address to hold the MS11 Multistream Decode setting of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioMSDecode call is not implemented.
 */
dsError_t  dsIsAudioMSDecode(intptr_t handle, bool *HasMS11Decode);
 
/**
 * @brief This function is used to check whether the audio port supports Dolby MS12 Multistream Decode
 *
 * @param[out] Address to hold the MS12 Multistream Decode setting of the specified audio port.
 *
 * @return Device Settings error code
 * @retval dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioMS12Decode call is not implemented.
 */
dsError_t  dsIsAudioMS12Decode(intptr_t handle, bool *HasMS12Decode);
 
/**
 * @brief Set the audio delay in milliseconds
 * 
 * This function will set the audio delay in milliseconds
 *
 * @param [in] handle      Handle for the Output Audio port
 * @param [in] audioDelayMs  Amount of milliseconds of delay
 * @return dsError_t Error code.
 */
dsError_t dsSetAudioDelay(intptr_t handle, const uint32_t audioDelayMs);
 
/**
 * @brief Set the audio delay offset in milliseconds
 * 
 * This function will set the audio delay offset in milliseconds
 *
 * @param [in] handle      Handle for the Output Audio port
 * @param [in] audioDelayOffsetMs  Amount of milliseconds of delay offset
 * @return dsError_t Error code.
 */
dsError_t dsSetAudioDelayOffset(intptr_t handle, const uint32_t audioDelayOffsetMs);
 
/**
 * @brief Terminate the Audio Port sub-system.
 * 
 * This function will terminate the usage of audio output ports by resetting the data
 * structures used within this module and release the audio port specific handles.
 *
 * @return Device Settings error code
 * @retval dsERR_NONE Indicates dsAudioPortInit API was successfully called using iarmbus call.
 * @retval dsERR_GENERAL Indicates error due to general failure.
 */
dsError_t  dsAudioPortTerm();
 
 
dsError_t dsAudioOutIsConnected(intptr_t handle, bool* pisCon);
 
dsError_t dsAudioOutRegisterConnectCB(dsAudioOutPortConnectCB_t CBFunc);
 
/**
 * @brief Register for the Audio Format Update Event
 *
 * This function is used to register for the the Audio Format Update Event
 *
 * @param[in] cbFun Audio format update callback function.
 * @return Device Settings error code
 * @retval    ::dsError_t
 */
dsError_t dsAudioFormatUpdateRegisterCB (dsAudioFormatUpdateCB_t cbFun);
 
/**
 * @brief To find the HDR capabilities of SoC
 * 
 * This function is used to check which HDR capabilities the SoC supports
 *
 * @param [in] handle   Handle for the audio device (audio decoder)
 * @param [out] *capabilities OR-ed value of supported HDR standards.
 * @return dsError_t Error code.
 */
dsError_t dsGetAudioCapabilities(intptr_t handle, int *capabilities);
 
/**
 * @brief To find the HDR capabilities of SoC
 * 
 * This function is used to check which HDR capabilities the SoC supports
 *
 * @param [in] handle   Handle for the audio device (audio decoder)
 * @param [out] *capabilities OR-ed value of supported HDR standards.
 * @return dsError_t Error code.
 */
dsError_t dsGetMS12Capabilities(intptr_t handle, int *capabilities);
 
/**
 * @brief to reset the Dialog Enhancement 
 *
 * This function is used to reset the Dialog Enhancement
 *
 * @param [in] handle   Handle for the audio device (audio decoder)
 * @return dsError_t Error code.
 */
dsError_t dsResetDialogEnhancement(intptr_t handle);
 
/**
 * @brief to reset the reset the audio Bass
 *
 * This function is used to reset reset the audio Bass
 *
 * @param [in] handle   Handle for the audio device (audio decoder)
 * @return dsError_t Error code.
 */
dsError_t dsResetBassEnhancer(intptr_t handle);
 
/**
 * @brief to reset the audio Surround Virtualizer level
 *
 * This function is used to reset the audio Surround Virtualizer level
 *
 * @param [in] handle   Handle for the audio device (audio decoder)
 * @return dsError_t Error code.
 */
dsError_t dsResetSurroundVirtualizer(intptr_t handle);
 
/**
 * @brief to reset the Dolby volume leveller
 *
 * This function is used to reset the Dolby volume leveller
 *
 * @param [in] handle   Handle for the audio device (audio decoder)
 * @return dsError_t Error code.
 */
dsError_t dsResetVolumeLeveller(intptr_t handle);
 
/**
 * @brief To Set/override a specific audio setting in 
 *  a specific profile
 *
 * This function will override a specific audio setting in a
 * specific profile
 *
 * @param [in] handle       Handle for the Output Audio port
 * @param [in] *profileState possible values ADD and REMOVE setting from the persistence
 * @param [in] *profileName  ProfileName 
 * @param [in] *profileSettingsName MS12 property name
 * @param [in] *profileSettingValue MS12 property value 
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetMS12AudioProfileSetttingsOverride(intptr_t handle,const char* profileState,const char* profileName,
                                                   const char* profileSettingsName,const char* profileSettingValue);
 
 
/**
 * @brief Enable/Disable Associated Audio Mixing
 *
 * This function will Enable/Disable Associated Audio Mixing
 *
 * @param [in] handle      Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [in] mixing      mixing enable/disable
 * @return dsError_t Error code.
 */
dsError_t dsSetAssociatedAudioMixing(intptr_t handle, bool mixing);
 
 
/**
 * @brief To get the Associated Audio Mixing status - enabled/disabled
 *
 * This function will get the Associated Audio Mixing status
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [out] *mixing     Associated Audio Mixing status
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetAssociatedAudioMixing(intptr_t handle, bool *mixing);
 
 
/**
 * @brief To set the mixerbalance betweeen main and associated audio
 *
 * This function will set the mixerbalance betweeen main and associated audio
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [in] mixerbalance     int value -32(mute associated) to +32(mute main)
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetFaderControl(intptr_t handle, int mixerbalance);
 
 
/**
 * @brief To get the mixerbalance betweeen main and associated audio
 *
 * This function will get the mixerbalance betweeen main and associated audio
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [out] *mixerbalance     int value -32(mute associated) to +32(mute main)
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetFaderControl(intptr_t handle, int* mixerbalance);
 
 
 
/**
 * @brief To set AC4 Primary language
 *
 * This function will set AC4 Primary language
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [in] pLang        char* 3 letter lang code should be used as per ISO 639
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetPrimaryLanguage(intptr_t handle, const char* pLang);
 
 
/**
 * @brief To get AC4 Primary language
 *
 * This function will get AC4 Primary language
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [out] *pLang      char* 3 letter lang code should be used as per ISO 639
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetPrimaryLanguage(intptr_t handle, char* pLang);
 
 
/**
 * @brief To set AC4 Secondary language
 *
 * This function will set AC4 Secondary language
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [in] pLang        char* 3 letter lang code should be used as per ISO 639
 * @return dsError_t Error code.
 */
 
dsError_t  dsSetSecondaryLanguage(intptr_t handle, const char* sLang);
 
 
/**
 * @brief To get AC4 Secondary language
 *
 * This function will get AC4 Secondary language
 *
 * @param [in] handle       Handle for the Output Audio port (Not Used as setting is not port specific)
 * @param [out] *pLang      char* 3 letter lang code should be used as per ISO 639
 * @return dsError_t Error code.
 */
 
dsError_t  dsGetSecondaryLanguage(intptr_t handle, char* sLang);
 
/**
 * @brief Get the audio HDMI ARC port ID for each platform
 *
 * This function will get audio HDMI ARC port ID
 *
 * @param [in] portId get audio HDMI ARC port ID
 * @return dsError_t Error code.
 */
dsError_t dsGetHDMIARCPortId(int *portId);
 
 
/**
 * @}
 */
 
#ifdef __cplusplus
}
#endif
#endif /* _DS_AUDIOOUTPORT_H_ */
 
 
/** @} */
/** @} */