dsAudio.h File Reference

#include <sys/types.h>
#include "dsError.h"
#include "dsTypes.h"

Include dependency graph for dsAudio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	dsAudioOutPortConnectCB_t) (dsAudioPortType_t portType, unsigned int uiPortNo, bool isPortCon)
typedef void(*	dsAudioFormatUpdateCB_t) (dsAudioFormat_t audioFormat)
	Callback function used to notify applications of Audio Format change. More...

Functions
dsError_t	dsAudioPortInit ()
	Initialize the underlying Audio Port sub-system. More...
dsError_t	dsGetAudioPort (dsAudioPortType_t type, int index, intptr_t *handle)
	Get the audio port handle. More...
dsError_t	dsGetAudioEncoding (intptr_t handle, dsAudioEncoding_t *encoding)
	Get the encoding type of an audio port. More...
dsError_t	dsGetAudioFormat (intptr_t handle, dsAudioFormat_t *audioFormat)
	Get the current audio format. More...
dsError_t	dsGetAudioCompression (intptr_t handle, int *compression)
	Get the audio compressionof an audio port. More...
dsError_t	dsGetDialogEnhancement (intptr_t handle, int *level)
	Get the Dialog Enhancement level of an audio port. More...
dsError_t	dsGetDolbyVolumeMode (intptr_t handle, bool *mode)
	Get the dolby audio mode status. More...
dsError_t	dsGetIntelligentEqualizerMode (intptr_t handle, int *mode)
	Get the Intelligent Equalizer Mode. More...
dsError_t	dsGetVolumeLeveller (intptr_t handle, dsVolumeLeveller_t *volLeveller)
	To get the Dolby volume leveller. More...
dsError_t	dsGetBassEnhancer (intptr_t handle, int *boost)
	To get the audio Bass. More...
dsError_t	dsIsSurroundDecoderEnabled (intptr_t handle, bool *enabled)
	To get the audio Surround Decoder. More...
dsError_t	dsGetDRCMode (intptr_t handle, int *mode)
	To get the DRC Mode. More...
dsError_t	dsGetSurroundVirtualizer (intptr_t handle, dsSurroundVirtualizer_t *virtualizer)
	To get the audio Surround Virtualizer level. More...
dsError_t	dsGetMISteering (intptr_t handle, bool *enabled)
	To get the audio Media intelligent Steering. More...
dsError_t	dsGetGraphicEqualizerMode (intptr_t handle, int *mode)
	Get the Graphic Equalizer Mode. More...
dsError_t	dsGetMS12AudioProfileList (intptr_t handle, dsMS12AudioProfileList_t *profiles)
	To get the supported MS12 audio profiles. More...
dsError_t	dsGetMS12AudioProfile (intptr_t handle, char *profile)
	To get current audio profile selection. More...
dsError_t	dsGetSupportedARCTypes (intptr_t handle, int *types)
	Get the supported ARC types of the connected ARC/eARC device. More...
dsError_t	dsAudioSetSAD (intptr_t handle, dsAudioSADList_t sad_list)
	Set Short Audio Descriptor retrieved from CEC for the connected ARC device. More...
dsError_t	dsAudioEnableARC (intptr_t handle, dsAudioARCStatus_t arcStatus)
	enable/disable ARC/EARC and route audio to connected device More...
dsError_t	dsGetStereoMode (intptr_t handle, dsAudioStereoMode_t *stereoMode)
	Get the stereo mode of an audio port. More...
dsError_t	dsGetStereoAuto (intptr_t handle, int *autoMode)
	This function is used to get the current auto mode setting of the specified audio port. More...
dsError_t	dsGetAudioGain (intptr_t handle, float *gain)
	Get the audio gain of an audio port. More...
dsError_t	dsGetAudioDB (intptr_t handle, float *db)
	Get the current audio dB level of an audio port. More...
dsError_t	dsGetAudioLevel (intptr_t handle, float *level)
	Get the current audio volume level of an audio port. More...
dsError_t	dsGetAudioMaxDB (intptr_t handle, float *maxDb)
	Get the maximum audio dB level of an audio port. More...
dsError_t	dsGetAudioMinDB (intptr_t handle, float *minDb)
	Get the minimum audio dB level of an audio port. More...
dsError_t	dsGetAudioOptimalLevel (intptr_t handle, float *optimalLevel)
	Get the optimal audio level of an audio port. More...
dsError_t	dsGetAudioDelay (intptr_t handle, uint32_t *audioDelayMs)
	Get the audio delay in milliseconds. More...
dsError_t	dsGetAudioDelayOffset (intptr_t handle, uint32_t *audioDelayOffsetMs)
	Get the audio delay offset in milliseconds. More...
dsError_t	dsSetAudioAtmosOutputMode (intptr_t handle, bool enable)
	Set the audio ATMOS outout mode. More...
dsError_t	dsGetSinkDeviceAtmosCapability (intptr_t handle, dsATMOSCapability_t *capability)
	Get the sink device ATMOS capability. More...
dsError_t	dsIsAudioLoopThru (intptr_t handle, bool *loopThru)
	Get the loop-through mode of an audio port. More...
dsError_t	dsIsAudioMute (intptr_t handle, bool *muted)
	Get the audio mute status of an audio port. More...
dsError_t	dsIsAudioPortEnabled (intptr_t handle, bool *enabled)
	This function indicates whether the specified Audio port is enabled or not. More...
dsError_t	dsEnableAudioPort (intptr_t handle, bool enabled)
	This function is used to enable or disable the specified Audio port. More...
dsError_t	dsEnableMS12Config (intptr_t handle, dsMS12FEATURE_t feature, const bool enable)
	This function is used to enable or disable MS12 DAPV2 and DE feature. More...
dsError_t	dsEnableLEConfig (intptr_t handle, const bool enable)
	This function is used to enable or disable Loudness Equivalence feature. More...
dsError_t	dsGetLEConfig (intptr_t handle, bool *enable)
	To Get LE configuration. More...
dsError_t	dsSetAudioEncoding (intptr_t handle, dsAudioEncoding_t encoding)
	Set the encoding type of an audio port. More...
dsError_t	dsSetAudioCompression (intptr_t handle, int compression)
	Set the audio compression of an audio port. More...
dsError_t	dsSetDialogEnhancement (intptr_t handle, int level)
	Get the Dialog Enhancement level of an audio port. More...
dsError_t	dsSetDolbyVolumeMode (intptr_t handle, bool mode)
	Get the dolby audio mode status. More...
dsError_t	dsSetIntelligentEqualizerMode (intptr_t handle, int mode)
	Set the Intelligent Equalizer Mode. More...
dsError_t	dsSetVolumeLeveller (intptr_t handle, dsVolumeLeveller_t volLeveller)
	To set the Dolby volume leveller. More...
dsError_t	dsSetBassEnhancer (intptr_t handle, int boost)
	To set the audio Bass. More...
dsError_t	dsEnableSurroundDecoder (intptr_t handle, bool enabled)
	To set the audio Surround Decoder. More...
dsError_t	dsSetDRCMode (intptr_t handle, int mode)
	To set the DRC Mode. More...
dsError_t	dsSetSurroundVirtualizer (intptr_t handle, dsSurroundVirtualizer_t virtualizer)
	To set the audio Surround Virtualizer level. More...
dsError_t	dsSetMISteering (intptr_t handle, bool enabled)
	To set the audio Media intelligent Steering. More...
dsError_t	dsSetGraphicEqualizerMode (intptr_t handle, int mode)
	Get the Graphic Equalizer Mode. More...
dsError_t	dsSetMS12AudioProfile (intptr_t handle, const char *profile)
	To set the ms12 audio profile. More...
dsError_t	dsSetStereoMode (intptr_t handle, dsAudioStereoMode_t mode)
	Set the stereo mode of an audio port. More...
dsError_t	dsSetStereoAuto (intptr_t handle, int autoMode)
	This function sets the auto mode to be used on the specified audio port. More...
dsError_t	dsSetAudioGain (intptr_t handle, float gain)
	Set the audio gain of an audio port. More...
dsError_t	dsSetAudioDB (intptr_t handle, float db)
	This function sets the dB level to be used on the specified audio port. More...
dsError_t	dsSetAudioLevel (intptr_t handle, float level)
	This function sets the audio volume level to be used on the specified audio port. More...
dsError_t	dsSetAudioDucking (intptr_t handle, dsAudioDuckingAction_t action, dsAudioDuckingType_t, const unsigned char level)
	This function sets the audio ducking level to be used on the specified audio port based on the audio output mode. More...
dsError_t	dsEnableLoopThru (intptr_t handle, bool loopThru)
	Set loop-through mode of an audio port. More...
dsError_t	dsSetAudioMute (intptr_t handle, bool mute)
	Mute or un-mute an audio port. More...
dsError_t	dsIsAudioMSDecode (intptr_t handle, bool *HasMS11Decode)
	This function is used to check whether the audio port supports Dolby MS11 Multistream Decode. More...
dsError_t	dsIsAudioMS12Decode (intptr_t handle, bool *HasMS12Decode)
	This function is used to check whether the audio port supports Dolby MS12 Multistream Decode. More...
dsError_t	dsSetAudioDelay (intptr_t handle, const uint32_t audioDelayMs)
	Set the audio delay in milliseconds. More...
dsError_t	dsSetAudioDelayOffset (intptr_t handle, const uint32_t audioDelayOffsetMs)
	Set the audio delay offset in milliseconds. More...
dsError_t	dsAudioPortTerm ()
	Terminate the Audio Port sub-system. More...
dsError_t	dsAudioOutIsConnected (intptr_t handle, bool *pisCon)
dsError_t	dsAudioOutRegisterConnectCB (dsAudioOutPortConnectCB_t CBFunc)
dsError_t	dsAudioFormatUpdateRegisterCB (dsAudioFormatUpdateCB_t cbFun)
	Register for the Audio Format Update Event. More...
dsError_t	dsGetAudioCapabilities (intptr_t handle, int *capabilities)
	To find the HDR capabilities of SoC. More...
dsError_t	dsGetMS12Capabilities (intptr_t handle, int *capabilities)
	To find the HDR capabilities of SoC. More...
dsError_t	dsResetDialogEnhancement (intptr_t handle)
	to reset the Dialog Enhancement More...
dsError_t	dsResetBassEnhancer (intptr_t handle)
	to reset the reset the audio Bass More...
dsError_t	dsResetSurroundVirtualizer (intptr_t handle)
	to reset the audio Surround Virtualizer level More...
dsError_t	dsResetVolumeLeveller (intptr_t handle)
	to reset the Dolby volume leveller More...
dsError_t	dsSetMS12AudioProfileSetttingsOverride (intptr_t handle, const char *profileState, const char *profileName, const char *profileSettingsName, const char *profileSettingValue)
	To Set/override a specific audio setting in a specific profile. More...
dsError_t	dsSetAssociatedAudioMixing (intptr_t handle, bool mixing)
	Enable/Disable Associated Audio Mixing. More...
dsError_t	dsGetAssociatedAudioMixing (intptr_t handle, bool *mixing)
	To get the Associated Audio Mixing status - enabled/disabled. More...
dsError_t	dsSetFaderControl (intptr_t handle, int mixerbalance)
	To set the mixerbalance betweeen main and associated audio. More...
dsError_t	dsGetFaderControl (intptr_t handle, int *mixerbalance)
	To get the mixerbalance betweeen main and associated audio. More...
dsError_t	dsSetPrimaryLanguage (intptr_t handle, const char *pLang)
	To set AC4 Primary language. More...
dsError_t	dsGetPrimaryLanguage (intptr_t handle, char *pLang)
	To get AC4 Primary language. More...
dsError_t	dsSetSecondaryLanguage (intptr_t handle, const char *sLang)
	To set AC4 Secondary language. More...
dsError_t	dsGetSecondaryLanguage (intptr_t handle, char *sLang)
	To get AC4 Secondary language. More...
dsError_t	dsGetHDMIARCPortId (int *portId)
	Get the audio HDMI ARC port ID for each platform. More...