Collaboration diagram for Audio OutputMix API:

Files
file	audio_outputmix_api.h
	CXD5602 Audio OutputMix API.

Classes
struct	AsOutputMixMsgQueId_t

struct	AsOutputMixPoolId_t

struct	AsOutputMixPoolId_old_t

struct	AsCreateOutputMixParam_t

struct	AsCreateOutputMixParams_t

struct	AsOutputMixDoneParam

struct	AsActivateOutputMixer

struct	AsInitOutputMixer

struct	AsDeactivateOutputMixer

struct	AsSendDataOutputMixer

struct	AsFrameTermFineControl

struct	AsInitPostProc

struct	OutputMixerCommand

Macros
#define	AS_FEATURE_OUTPUTMIX_ENABLE

#define	LENGTH_INIT_OUTPUTMIXER 4
	InitOutputMixer command (AUDCMD_INIT_OUTPUTMIXER) packet length.

#define	LENGTH_INITMPP 5
	InitMPP command (AUDCMD_INITMPP) packet length.

#define	LENGTH_SUB_SETMPP_COMMON 4
	SetMPP command (AUDCMD_SETMPPPARAM) packet length.

#define	LENGTH_SUB_SETMPP_XLOUD 4
	SetMPP command (AUDCMD_SETMPPPARAM) packet length.

#define	AS_POSTPROC_FILE_PATH_LEN (AS_AUDIO_DSP_PATH_LEN)
	Length of Recognizer dsp file name and path.

#define	PF_COMMAND_PACKET_SIZE_MAX (32)

Typedefs
typedef void(*	OutputMixerCallback) (MsgQueId requester_dtq, MsgType msgtype, AsOutputMixDoneParam *param)

typedef void(*	OutputMixerErrorCallback) (uint8_t handle)

typedef AsInitPostProc	AsSetPostProc

Enumerations
enum	AsOutputMixerHandle { OutputMixer0 = 0 , OutputMixer1 }

enum	AsOutputMixDevice { HPOutputDevice = 0 , I2SOutputDevice , A2dpSrcOutputDevice , OutputMixDeviceNum }

enum	AsOutputMixerType { MainOnly = 0 , SoundEffectOnly , MainSoundEffectMix , OutputMixerTypeNum }

enum	AsOutputMixerPostFilter { PostFilterDisable = 0 , PostFilterEnable }

enum	AsOutputMixDoneCmdType { OutputMixActDone = 0 , OutputMixInitDone , OutputMixDeactDone , OutputMixSetClkRcvDone , OutputMixInitPostDone , OutputMixSetPostDone , OutputMixDoneCmdTypeNum }

enum	AsClkRecoveryDirection { OutputMixAdvance = -1 , OutputMixNoAdjust = 0 , OutputMixDelay = 1 }

enum	AsPostprocType { AsPostprocTypeThrough = 0 , AsPostprocTypeUserCustom , AsPostprocTypeInvalid = 0xff }

Functions
bool	AS_CreateOutputMixer (FAR AsCreateOutputMixParam_t *param, AudioAttentionCb attcb)
	Create audio output mixer. More...

bool	AS_CreateOutputMixer (FAR AsCreateOutputMixParams_t *param, AudioAttentionCb attcb)

	__attribute__ ((deprecated("\n \ \n Deprecated create API is used. \ \n Use \"AS_CreateOutputMixer(AsCreateOutputMixParam_t * \ \n AudioAttentionCb)\". \ \n \ \n"))) bool AS_CreateOutputMixer(FAR AsCreateOutputMixParam_t *param)

bool	AS_CreateOutputMixer (FAR AsCreateOutputMixParams_t *param)

bool	AS_ActivateOutputMixer (uint8_t handle, FAR AsActivateOutputMixer *actparam)
	Activate audio output mixer. More...

bool	AS_InitOutputMixer (uint8_t handle, FAR AsInitOutputMixer *initparam)
	Init audio output mixer. More...

bool	AS_SendDataOutputMixer (FAR AsSendDataOutputMixer *sendparam)
	Send audio data via outputmixer. More...

bool	AS_FrameTermFineControlOutputMixer (uint8_t handle, FAR AsFrameTermFineControl *ftermparam)
	Set clock recovery parameters. More...

bool	AS_InitPostprocOutputMixer (uint8_t handle, FAR AsInitPostProc *initppparam)
	Init Postproces DSP. More...

bool	AS_SetPostprocOutputMixer (uint8_t handle, FAR AsSetPostProc *setppparam)
	Set parameters Postproces DSP. More...

bool	AS_DeactivateOutputMixer (uint8_t handle, FAR AsDeactivateOutputMixer *deactparam)
	Deactivate audio output mixer. More...

bool	AS_DeleteOutputMix (void)
	Delete output mixer. More...

bool	AS_checkAvailabilityOutputMixer (void)
	Check availability of OutputMixer. More...

Detailed Description

Enumeration Type Documentation

◆ AsOutputMixerHandle

enum AsOutputMixerHandle

Enumerator
OutputMixer0	OutputMixer No.0.
OutputMixer1	OutputMixer No.1.

◆ AsOutputMixDevice

enum AsOutputMixDevice

Enumerator
HPOutputDevice	Speaker out.
I2SOutputDevice	I2S out.
A2dpSrcOutputDevice	A2DP out.

◆ AsOutputMixerType

enum AsOutputMixerType

Enumerator
MainOnly	Main.
SoundEffectOnly	SoundEffet.
MainSoundEffectMix	Main & SoundEffet.

◆ AsOutputMixerPostFilter

enum AsOutputMixerPostFilter

Enumerator
PostFilterDisable	Disable
PostFilterEnable	Enable

◆ AsOutputMixDoneCmdType

enum AsOutputMixDoneCmdType

Enumerator
OutputMixActDone	Activation done.
OutputMixInitDone	Init done.
OutputMixDeactDone	Deactivation done.
OutputMixSetClkRcvDone	Set Clock recovery done.
OutputMixInitPostDone	Init Postproc command done.
OutputMixSetPostDone	Set Postproc command done.

◆ AsClkRecoveryDirection

enum AsClkRecoveryDirection

Enumerator
OutputMixAdvance	Adjust to the + direction.
OutputMixNoAdjust	No adjust.
OutputMixDelay	Adjust to the - direction.

◆ AsPostprocType

enum AsPostprocType

Enumerator
AsPostprocTypeThrough	brief Post Process through
AsPostprocTypeUserCustom	brief Post Process user customized

Function Documentation

◆ AS_CreateOutputMixer()

bool AS_CreateOutputMixer	(	FAR AsCreateOutputMixParam_t *	param,
		AudioAttentionCb	attcb
	)

Create audio output mixer.

Parameters

[in]	param	Parameters of resources used by output mixer
[in]	attcb	Attention callback of OutputMixer. NULL means no callback.

Return values

true	: success
false	: failure

◆ AS_ActivateOutputMixer()

bool AS_ActivateOutputMixer	(	uint8_t	handle,
		FAR AsActivateOutputMixer *	actparam
	)

Activate audio output mixer.

Parameters

[in] actparam Activation parameters

Return values

true	: success
false	: failure

◆ AS_InitOutputMixer()

bool AS_InitOutputMixer	(	uint8_t	handle,
		FAR AsInitOutputMixer *	initparam
	)

Init audio output mixer.

Parameters

[in] initparam Initialization parameters

Return values

true	: success
false	: failure

◆ AS_SendDataOutputMixer()

bool AS_SendDataOutputMixer ( FAR AsSendDataOutputMixer * sendparam )

Send audio data via outputmixer.

Parameters

[in] sendparam Send data parameters

Return values

true	: success
false	: failure

◆ AS_FrameTermFineControlOutputMixer()

bool AS_FrameTermFineControlOutputMixer	(	uint8_t	handle,
		FAR AsFrameTermFineControl *	ftermparam
	)

Set clock recovery parameters.

Parameters

[in] ftermparam clock recovery parameters

Return values

true	: success
false	: failure

◆ AS_InitPostprocOutputMixer()

bool AS_InitPostprocOutputMixer	(	uint8_t	handle,
		FAR AsInitPostProc *	initppparam
	)

Init Postproces DSP.

Parameters

[in] initppparam command parameters

Return values

true	: success
false	: failure

◆ AS_SetPostprocOutputMixer()

bool AS_SetPostprocOutputMixer	(	uint8_t	handle,
		FAR AsSetPostProc *	setppparam
	)

Set parameters Postproces DSP.

Parameters

[in] setppparam command parameters

Return values

true	: success
false	: failure

◆ AS_DeactivateOutputMixer()

bool AS_DeactivateOutputMixer	(	uint8_t	handle,
		FAR AsDeactivateOutputMixer *	deactparam
	)

Deactivate audio output mixer.

Parameters

[in] deactparam Deactivation parameters

Return values

true	: success
false	: failure

◆ AS_DeleteOutputMix()

bool AS_DeleteOutputMix ( void )

Delete output mixer.

Return values

true	: success
false	: failure

◆ AS_checkAvailabilityOutputMixer()

bool AS_checkAvailabilityOutputMixer ( void )

Check availability of OutputMixer.

Return values

true	: avaliable
false	: Not available

Files

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ AsOutputMixerHandle

◆ AsOutputMixDevice

◆ AsOutputMixerType

◆ AsOutputMixerPostFilter

◆ AsOutputMixDoneCmdType

◆ AsClkRecoveryDirection

◆ AsPostprocType

Function Documentation

◆ AS_CreateOutputMixer()

◆ AS_ActivateOutputMixer()

◆ AS_InitOutputMixer()

◆ AS_SendDataOutputMixer()

◆ AS_FrameTermFineControlOutputMixer()

◆ AS_InitPostprocOutputMixer()

◆ AS_SetPostprocOutputMixer()

◆ AS_DeactivateOutputMixer()

◆ AS_DeleteOutputMix()

◆ AS_checkAvailabilityOutputMixer()