Developer World
Spresense SDK Library v3.2.0-ebc0364
audio_outputmix_api.h File Reference

CXD5602 Audio OutputMix API. More...

#include "audio/audio_common_defs.h"
#include "memutils/memory_manager/MemHandle.h"
#include "memutils/message/MsgPacket.h"

Go to the source code of this file.

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

CXD5602 Audio OutputMix API.

Author
CXD5602 Audio SW Team