Developer World
Spresense SDK Library v1.4.2-3df2e9d
audio_effector_api.h File Reference

CXD5602 Audio Effector API. More...

#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  InitMFEParam
 
struct  StartBBParam
 
struct  StopBBParam
 
struct  SetBaseBandStatusParam
 
struct  AsEffectorMsgQueId_t
 
struct  AsEffectorPoolId_t
 
struct  AsCreateEffectorParam_t
 

Macros

#define AS_FEATURE_EFFECTOR_ENABLE
 
#define CHECK_XLOUD_VOLUME_RANGE(vol)   (bool)(((0 <= (vol)) && ((vol) <= 59)) ? true : false)
 
sub code for SETMPPPARAM command(0x2C)
#define SUB_SETMPP_COMMON   0x00
 Sub Code: MPP common setting.
 
#define SUB_SETMPP_XLOUD   0x01
 Sub Code: MPP xLOUD setting.
 
Packet length of command
#define LENGTH_STARTBB   3
 StartBB command (AUDCMD_STARTBB) packet length.
 
#define LENGTH_STOPBB   3
 StopBB command (AUDCMD_STOPBB) packet length.
 

Enumerations

enum  AsOutputDevice { AS_OUTPUT_DEVICE_I2S2CH = 0x03, AS_OUTPUT_DEVICE_SP2CH = 0x30, AS_OUTPUT_DEVICE_SP2CH_I2S2CH = (AS_OUTPUT_DEVICE_I2S2CH | AS_OUTPUT_DEVICE_SP2CH) }
 
enum  AsInputDevice { AS_INPUT_DEVICE_I2S2CH = 0x0003, AS_INPUT_DEVICE_AMIC1CH = 0x0100, AS_INPUT_DEVICE_AMIC1CH_I2S2CH = (AS_INPUT_DEVICE_I2S2CH | AS_INPUT_DEVICE_AMIC1CH), AS_INPUT_DEVICE_AMIC4CH_I2S2CH = (AS_INPUT_DEVICE_I2S2CH | 0x0F00) }
 
enum  AsSpOutputData { AS_MPP_OUTPUT_I2SIN = 0, AS_SP_OUTPUT_DATA_NUM }
 
enum  AsI2sOutputData { AS_MFE_OUTPUT_MICSIN = 0, AS_MIC_THROUGH, AS_I2S_OUTPUT_DATA_NUM }
 
enum  AsSelectOutputMic { AS_SELECT_MIC1_OR_MIC2 = 0x06, AS_SELECT_MIC0_OR_MIC3 = 0x09 }
 
enum  AsMfeModeId { AS_MFE_MODE_RECOGNITION = 0, AS_MFE_MODE_SPEAKING, AS_MFE_MODE_NUM }
 
enum  AsMfeIncludeEchoCancel { AS_NOINCLUDE_ECHOCANCEL = 0, AS_INCLUDE_ECHOCANCEL, AS_MFE_INC_ECHOCANCEL_NUM }
 
enum  AsMfeEnableEchoCancel { AS_DISABLE_ECHOCANCEL = 0, AS_ENABLE_ECHOCANCEL, AS_MFE_ENBL_ECHOCANCEL_NUM }
 
enum  AsMppModeId { AS_MPP_MODE_XLOUD_ONLY = 0, AS_MPP_MODE_NUM }
 
enum  AsMppCoefModeId { AS_MPP_COEF_SPEAKER = 0, AS_MPP_COEF_HEADPHONE, AS_MPP_COEF_NUM }
 
enum  AsMppXloudModeId { AS_MPP_XLOUD_MODE_NORMAL = 0, AS_MPP_XLOUD_MODE_SPEAKING, AS_MPP_XLOUD_MODE_DISABLE, AS_MPP_XLOUD_MODE_NUM }
 
enum  AsMppEaxModeId { AS_MPP_EAX_DISABLE = 0, AS_MPP_EAX_ENABLE, AS_MPP_EAX_NUM }
 
enum  AsSetBBStsWithMfe { AS_SET_BBSTS_WITH_MFE_NONE = 0, AS_SET_BBSTS_WITH_MFE_ACTIVE, AS_SET_BBSTS_WITH_MFE_NUM }
 
enum  AsSetBBStsWithVoiceCommand { AS_SET_BBSTS_WITH_VCMD_NONE = 0, AS_SET_BBSTS_WITH_VCMD_ACTIVE, AS_SET_BBSTS_WITH_VCMD_NUM }
 
enum  AsSetBBStsWithMpp { AS_SET_BBSTS_WITH_MPP_NONE = 0, AS_SET_BBSTS_WITH_MPP_ACTIVE, AS_SET_BBSTS_WITH_MPP_NUM }
 

Functions

bool AS_CreateEffector (FAR AsCreateEffectorParam_t *param, AudioAttentionCb attcb)
 Activate sound effector feature. More...
 
 __attribute__ ((deprecated("\\ \Deprecated create API is used. \ \Use \S_CreateEffector(AsCreateEffectorParam_t * \ \ AudioAttentionCb)\ \ \\ \))) bool AS_CreateEffector(FAR AsCreateEffectorParam_t *param)
 
bool AS_DeleteEffector (void)
 Deactivate sound effector feature. More...
 

Detailed Description

CXD5602 Audio Effector API.

Author
CXD5602 Audio SW Team