audio_high_level_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_high_level_api.h
 *
 *   Copyright 2018 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __MODULES_INCLUDE_AUDIO_AUDIO_HIGH_LEVEL_API_H
#define __MODULES_INCLUDE_AUDIO_AUDIO_HIGH_LEVEL_API_H

 
/* API Documents creater with Doxgen */

 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <sdk/config.h>
 
#include "audio/audio_command_id.h"
#include "audio/audio_common_defs.h"
#ifdef CONFIG_AUDIOUTILS_PLAYER
#  include "audio/audio_player_api.h"
#  include "audio/audio_outputmix_api.h"
#  include "audio/audio_renderer_api.h"
#endif
#ifdef CONFIG_AUDIOUTILS_RECORDER
#  include "audio/audio_recorder_api.h"
#  include "audio/audio_frontend_api.h"
#  include "audio/audio_capture_api.h"
#endif
#ifdef CONFIG_AUDIOUTILS_SOUND_RECOGNIZER
#  include "audio/audio_frontend_api.h"
#  include "audio/audio_recognizer_api.h"
#  include "audio/audio_renderer_api.h"
#  include "audio/audio_capture_api.h"
#endif
#ifdef CONFIG_AUDIOUTILS_SYNTHESIZER
#  include "audio/audio_player_api.h"
#  include "audio/audio_synthesizer_api.h"
#  include "audio/audio_outputmix_api.h"
#  include "audio/audio_renderer_api.h"
#endif
 
#include <stdint.h>
#include <stdbool.h>
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/


 
#define LENGTH_AUDRLT  2

 
#define LENGTH_AUDRLT_ERRORRESPONSE_MAX  8

 
#define LENGTH_AUDRLT_ERRORRESPONSE_MIN  5



 
#define LENGTH_GETSTATUS            2

 
#define LENGTH_SET_PLAYER_STATUS    6 

 
#define LENGTH_SET_RECORDER_STATUS  4

 
#define LENGTH_SET_RECOGNIZER_STATUS  4

 
#define LENGTH_SET_BASEBAND_STATUS  9

 
#define LENGTH_SET_THROUGH_STATUS  3

 
#define LENGTH_SET_READY_STATUS     2

 
#define LENGTH_POWERON              2

 
#define LENGTH_SET_POWEROFF_STATUS  2

 
#define LENGTH_SETMICMAP            4

 
#define LENGTH_INITMICGAIN          5

 
#define LENGTH_INITI2SPARAM         3

 
#define LENGTH_INITDEQPARAM         8

 
#define LENGTH_INITOUTPUTSELECT     2

 
#define LENGTH_INITDNCPARAM         2

 
#define LENGTH_INITCLEARSTEREO      2

 
#define LENGTH_SETVOLUME            3

 
#define LENGTH_SETVOLUMEMUTE        2

 
#define LENGTH_SETBEEPPARAM         3

 
#define LENGTH_SETRENDERINGCLK      2

 
#define LENGTH_INIT_SOUNDEFFECT     3

 
#define LENGTH_START_SOUNDEFFECT    2

 
#define LENGTH_STOP_SOUNDEFFECT     2

 
#define LENGTH_SET_THROUGH_PATH     4

 
#define LENGTH_INITSPDRVMODE         2
#define LENGTH_SETSPDRVMODE          LENGTH_INITSPDRVMODE /* old command name */



 
#define AS_ECODE_OK                              0x00

 
#define AS_ECODE_STATE_VIOLATION                 0x01

 
#define AS_ECODE_PACKET_LENGTH_ERROR             0x02

 
#define AS_ECODE_COMMAND_CODE_ERROR              0x03

 
#define AS_ECODE_COMMAND_NOT_SUPPOT              0x04

 
#define AS_ECODE_AUDIO_POWER_ON_ERROR            0x05

 
#define AS_ECODE_AUDIO_POWER_OFF_ERROR           0x06

 
#define AS_ECODE_DSP_LOAD_ERROR                  0x07

 
#define AS_ECODE_DSP_UNLOAD_ERROR                0x08

 
#define AS_ECODE_DSP_VERSION_ERROR               0x09

 
#define AS_ECODE_DSP_EXEC_ERROR                  0x3b

 
#define AS_ECODE_DSP_STOP_ERROR                  0x3c

 
#define AS_ECODE_DSP_SET_ERROR                   0x3d

 
#define AS_ECODE_SET_AUDIO_DATA_PATH_ERROR       0x0A

 
#define AS_ECODE_CLEAR_AUDIO_DATA_PATH_ERROR     0x0B

 
#define AS_ECODE_NOT_AUDIO_DATA_PATH             0x0C

 
#define AS_ECODE_DECODER_LIB_INITIALIZE_ERROR    0x0D

 
#define AS_ECODE_ENCODER_LIB_INITIALIZE_ERROR    0x0E

 
#define AS_ECODE_FILTER_LIB_INITIALIZE_ERROR     0x0F

 
#define AS_ECODE_DUMP_INITIALIZE_ERROR           0x10

 
#define AS_ECODE_COMMAND_PARAM_CODEC_TYPE        0x11

 
#define AS_ECODE_COMMAND_PARAM_AREA_INSUFFICIENT 0x12

 
#define AS_ECODE_COMMAND_PARAM_CHANNEL_NUMBER    0x13

 
#define AS_ECODE_COMMAND_PARAM_SAMPLING_RATE     0x14

 
#define AS_ECODE_COMMAND_PARAM_BIT_RATE          0x15

 
#define AS_ECODE_COMMAND_PARAM_BIT_LENGTH        0x16

 
#define AS_ECODE_COMMAND_PARAM_COMPLEXITY        0x17

 
#define AS_ECODE_COMMAND_PARAM_ACTIVE_PLAYER     0x18

 
#define AS_ECODE_COMMAND_PARAM_INPUT_DEVICE      0x19

 
#define AS_ECODE_COMMAND_PARAM_OUTPUT_DEVICE     0x1A

 
#define AS_ECODE_COMMAND_PARAM_INPUT_HANDLER     0x1B

 
#define AS_ECODE_COMMAND_PARAM_OUTPUT_HANDLER    0x1C

 
#define AS_ECODE_COMMAND_PARAM_CALLBACK          0x1D

 
#define AS_ECODE_COMMAND_PARAM_FUNCTION_ENABLE   0x1E

 
#define AS_ECODE_COMMAND_PARAM_CONFIG_TABLE      0x1F

 
#define AS_ECODE_COMMAND_PARAM_WITH_MFE          0x20

 
#define AS_ECODE_COMMAND_PARAM_WITH_MPP          0x21

 
#define AS_ECODE_COMMAND_PARAM_OUTPUT_DATE       0x22

 
#define AS_ECODE_COMMAND_PARAM_SELECT_MIC        0x23

 
#define AS_ECODE_COMMAND_PARAM_MIC_GAIN          0x24

 
#define AS_ECODE_COMMAND_PARAM_I2S_ID            0x25

 
#define AS_ECODE_COMMAND_PARAM_BYPASS_MODE       0x26

 
#define AS_ECODE_COMMAND_PARAM_VOLLUME           0x27

 
#define AS_ECODE_COMMAND_PARAM_INPUT_DB          0x28

 
#define AS_ECODE_COMMAND_PARAM_MASTER_DB         0x29

 
#define AS_ECODE_COMMAND_PARAM_BEEP_FREQ         0x2A

 
#define AS_ECODE_DMAC_INITIALIZE_ERROR           0x2B

 
#define AS_ECODE_DMAC_READ_ERROR                 0x2C

 
#define AS_ECODE_DMAC_WRITE_ERROR                0x2D

 
#define AS_ECODE_CHECK_MEMORY_POOL_ERROR         0x2E

 
#define AS_ECODE_SIMPLE_FIFO_UNDERFLOW           0x2F

 
#define AS_ECODE_SET_MIC_GAIN_ERROR              0x30

 
#define AS_ECODE_SET_I2S_PARAM_ERROR             0x31

 
#define AS_ECODE_SET_OUTPUT_SELECT_ERROR         0x32

 
#define AS_ECODE_INIT_CLEAR_STEREO_ERROR         0x33

 
#define AS_ECODE_SET_VOLUME_ERROR                0x34

 
#define AS_ECODE_SET_VOLUME_MUTE_ERROR           0x35

 
#define AS_ECODE_SET_BEEP_ERROR                  0x36

 
#define AS_ECODE_QUEUE_OPERATION_ERROR           0x37

 
#define AS_ECODE_INTERNAL_COMMAND_CODE_ERROR     0x38

 
#define AS_ECODE_COMMAND_PARAM_RENDERINGCLK      0x39

 
#define AS_ECODE_SET_RENDERINGCLK_ERROR          0x3A

 
#define AS_ECODE_COMMAND_PARAM_INITSPDRVMODE      0x3B
#define AS_ECODE_COMMAND_PARAM_SETSPDRVMODE       AS_ECODE_COMMAND_PARAM_INITSPDRVMODE

 
#define AS_ECODE_SET_MICMAP_ERROR                0x3D

 
#define AS_ECODE_OBJECT_NOT_AVAILABLE_ERROR      0x3E

 
#define AS_ECODE_OSCILLATOR_LIB_INITIALIZE_ERROR 0x3F

 
/****************************************************************************
 * Public Types
 ****************************************************************************/

 
typedef struct
{
 
  uint8_t reserved;

 
  uint8_t sub_code;

 
  uint8_t command_code;

 
  uint8_t packet_length;
} AudioCommandHeader;

 
typedef struct
{
 
  uint8_t instance_id;

 
  uint8_t sub_code;

 
  uint8_t result_code;

 
  uint8_t packet_length;
} AudioResultHeader;

 
typedef struct
{
 
  uint8_t mic_map[AS_MIC_CHANNEL_MAX]; 
 
} SetMicMapParam;

 
typedef struct
{
 
  int16_t mic_gain[AS_MIC_CHANNEL_MAX];
} InitMicGainParam;

 
typedef enum
{
  AS_I2S1,
  AS_I2S2
} AsI2sId;
 
typedef enum
{
  AS_I2S_BYPASS_MODE_DISABLE,
  AS_I2S_BYPASS_MODE_ENABLE
} AsI2SBypassMode;
 
typedef struct
{
 
  uint8_t  i2s_id;

 
  uint8_t  bypass_mode_en;
  uint16_t reserved2;

 
  uint32_t rate;
} InitI2SParam;

 
typedef enum
{
 
  AS_OUT_OFF,

 
  AS_OUT_SP,

 
  AS_OUT_I2S
} AsOutDevice;
 
typedef struct
{
 
  uint8_t  output_device_sel;
  uint8_t  reserved1;
  uint16_t reserved2;
} InitOutputSelectParam;

 
typedef enum
{
  AS_DNC_MODE_A,
  AS_DNC_MODE_B,
  AS_DNC_MODE_C
} AsDncMode;
 
typedef struct
{
 
  uint8_t  mode;
  uint8_t  reserved1;
  uint16_t reserved2;
} InitDNCParam;

 
typedef struct {
 
  uint8_t cs_en;
  uint8_t reserved1;

 
  int16_t cs_vol;
} InitClearStereoParam;

 
typedef struct
{
 
  int16_t  master_db;
  uint16_t reserved1;

 
  int16_t  input1_db;

 
  int16_t  input2_db;
} SetVolumeParam;

 
typedef struct
{
 
  uint8_t  master_mute;

 
  uint8_t  input1_mute;

 
  uint8_t  input2_mute;
  uint8_t  reserved1;
} SetVolumeMuteParam;

 
typedef struct
{
 
  uint8_t  beep_en;
  uint8_t  reserved1;
  uint16_t reserved2;

 
  int16_t beep_vol;

 
  uint16_t beep_freq;
} SetBeepParam;

 
typedef struct
{
 
  uint8_t  enable_sound_effect;
  uint8_t  reserved1;
  uint8_t  reserved2;
  uint8_t  reserved3;
} PowerOnParam;

 
typedef struct
{
 
  uint8_t  clk_mode;
  uint8_t  reserved1;
  uint8_t  reserved2;
  uint8_t  reserved3;
} SetRenderingClkParam;

 
typedef struct
{
 
  uint8_t  mode;
  uint8_t  reserved1;
  uint8_t  reserved2;
  uint8_t  reserved3;
} InitSpDrvModeParam;
 
#define SetSpDrvModeParam InitSpDrvModeParam  /* old command name */

 
typedef enum
{
  AS_CLKMODE_NORMAL,
  AS_CLKMODE_HIRES
} AsClkMode;

 
typedef enum
{
 
  AS_DISABLE_SOUNDEFFECT = 0,

 
  AS_ENABLE_SOUNDEFFECT,
  AS_SOUNDEFFECT_NUM
} AsEnableSoundEffectFunc;

 
typedef enum
{
 
  AS_STARTSOUNDEFFECT_NORMAL = 0,

 
  AS_STARTSOUNDEFFECT_INFINITE,
  AS_STARTSOUNDEFFECT_MODE_NUM
} AsStartSoundEffectMode;

 
typedef enum
{
  AS_THROUGH_PATH_IN_MIC = 0,
  AS_THROUGH_PATH_IN_I2S1,
  AS_THROUGH_PATH_IN_I2S2,
  AS_THROUGH_PATH_IN_MIXER,
  AS_THROUGH_PATH_IN_NUM
} AsThroughPathIn;

 
typedef enum
{
  AS_THROUGH_PATH_OUT_MIXER1 = 0,
  AS_THROUGH_PATH_OUT_MIXER2,
  AS_THROUGH_PATH_OUT_I2S1,
  AS_THROUGH_PATH_OUT_I2S2,
  AS_THROUGH_PATH_OUT_NUM
} AsThroughPathOut;

 
typedef enum
{
  AS_SP_DRV_MODE_LINEOUT = 0,
  AS_SP_DRV_MODE_1DRIVER,
  AS_SP_DRV_MODE_2DRIVER,
  AS_SP_DRV_MODE_4DRIVER,
  AS_SP_DRV_MODE_NUM
} AsSpDrvMode;

 
typedef struct
{
 
  bool en;

 
  uint8_t in;

 
  uint8_t out;
 
} AsThroughPath;

 
typedef struct
{
 
  AsThroughPath  path1;

 
  AsThroughPath  path2;
 
} AsSetThroughPathParam;
 
#ifdef AS_FEATURE_OUTPUTMIX_ENABLE
 
/* Init OutputMixer Command (#AUDCMD_INIT_OUTPUTMIXER) */
 
typedef struct
{
  uint8_t  player_id;

 
  uint8_t postproc_type;

 
  char dsp_path[AS_POSTPROC_FILE_PATH_LEN];
 
} AsInitMixerParam;

 
typedef struct
{
 
  uint8_t  player_id;
 
  int8_t   direction;
 
  uint32_t times;
 
} AsPlayerClockRecovery;

 
typedef struct
{
  uint8_t  player_id;
 
  AsInitPostProc initpp_param;
 
} AsInitMediaPlayerPost;

 
typedef struct
{
  uint8_t  player_id;
 
  AsSetPostProc setpp_param;
 
} AsSetMediaPlayerPost;
 
#endif
 
#ifdef AS_FEATURE_FRONTEND_ENABLE
 
typedef enum
{
 
  AsMicFrontendDataToRecorder = 0,

 
  AsMicFrontendDataToRecognizer,
 
} AsFrontendDataDest;

 
typedef struct
{
 
  uint8_t  ch_num;

 
  uint8_t  bit_length;

 
  uint16_t samples;

 
  uint32_t out_fs;

 
  uint8_t  preproc_type;

 
  char preprocess_dsp_path[AS_PREPROCESS_FILE_PATH_LEN];

 
  uint8_t data_dest;
  
} AsInitMicFrontEnd;
 
#endif
 
#ifdef AS_FEATURE_RECOGNIZER_ENABLE

 
typedef struct
{
 
  uint8_t  input_device;
 
} AsSetRecognizerStatus;

 
typedef void (*RecognizerFindCallback)(AsRecognitionInfo info);
 
typedef struct
{
 
  uint8_t recognizer_type;

 
  char recognizer_dsp_path[AS_RECOGNIZER_FILE_PATH_LEN];

 
  RecognizerFindCallback fcb;
 
} AsInitRecognizer;

 
typedef struct
{
  uint32_t reserve;
 
} AsStartRecognizer;

 
typedef struct
{
  uint32_t reserve;
 
} AsStopRecognizer;
#endif /* AS_FEATURE_RECOGNIZER_ENABLE */

 
#if defined(__CC_ARM)
#pragma anon_unions
#endif
 
typedef struct
{
 
  AudioCommandHeader header;
  union
  {
#ifdef AS_FEATURE_EFFECTOR_ENABLE
 
    StartBBParam start_bb_param;

 
    StopBBParam stop_bb_param;

 
    SetBaseBandStatusParam set_baseband_status_param;
#endif
#ifdef AS_FEATURE_PLAYER_ENABLE
 
    SetPlayerStsParam set_player_sts_param;

 
    PlayerCommand player;
 
#endif
#ifdef AS_FEATURE_OUTPUTMIX_ENABLE
 
    AsInitMixerParam init_mixer_param;

 
    AsPlayerClockRecovery clk_recovery_param;

 
    AsInitMediaPlayerPost init_mpp_param;

 
    AsSetMediaPlayerPost set_mpp_param;
 
#endif
#ifdef AS_FEATURE_FRONTEND_ENABLE

 
    AsInitMicFrontEnd init_micfrontend_param;

 
    AsInitPreProcParam init_preproc_param;

 
    AsSetPreProcParam set_preproc_param;
 
#endif
#ifdef AS_FEATURE_RECORDER_ENABLE

 
    AsActivateRecorderParam set_recorder_status_param;

 
    RecorderCommand recorder;
 
#endif
#ifdef AS_FEATURE_RECOGNIZER_ENABLE

 
    AsSetRecognizerStatus set_recognizer_status_param;

 
    AsInitRecognizer init_recognizer;

 
    AsStartRecognizer start_recognizer;

 
    AsStopRecognizer stop_recognizer;

 
    AsInitRecognizerProcParam init_rcg_param;

 
    AsSetRecognizerProcParam set_rcg_param;
 
#endif

 
    SetMicMapParam set_mic_map_param;

 
    InitMicGainParam init_mic_gain_param;

 
    InitI2SParam init_i2s_param;

 
    InitOutputSelectParam init_output_select_param;

 
    InitDNCParam init_dnc_param;

 
    InitClearStereoParam init_clear_stereo_param;

 
    SetVolumeParam set_volume_param;

 
    SetVolumeMuteParam set_volume_mute_param;

 
    SetBeepParam set_beep_param;

 
    PowerOnParam power_on_param;

 
    AsSetThroughPathParam set_through_path;

 
    SetRenderingClkParam set_renderingclk_param;

 
    InitSpDrvModeParam init_sp_drv_mode;
    SetSpDrvModeParam  set_sp_drv_mode;
  };
 
#ifdef __cplusplus
  uint8_t getCode(void)
    {
      return header.command_code;
    }
  bool isStateChange(void)
    {
      return ((getCode() & 0x40) != 0);
    }
#endif
 
#if !defined(__CC_ARM)
} AudioCommand ;
#else
} AudioCommand __attribute__((transparent_union));
#endif
 
 
/* Result Structures */
 
/* NotifyStatus */

 
typedef enum
{
 
  AS_MNG_STATUS_READY = 0,

 
  AS_MNG_STATUS_BASEBAND,

 
  AS_MNG_STATUS_PLAYER,

 
  AS_MNG_STATUS_RECORDER,

 
  AS_MNG_STATUS_RECOGNIZER,

 
  AS_MNG_STATUS_POWEROFF,

 
  AS_MNG_STATUS_THROUGH,
 
  AS_MNG_STATUS_NUM
} AsMngStatus;

 
typedef enum
{
 
  AS_MNG_SUB_STATUS_NONE = 0,

 
  AS_MNG_SUB_STATUS_PLAYREADY,

 
  AS_MNG_SUB_STATUS_PLAYACTIVE,

 
  AS_MNG_SUB_STATUS_PLAYPAUSE,

 
  AS_MNG_SUB_STATUS_RECORDERREADY,

 
  AS_MNG_SUB_STATUS_RECORDERACTIVE,

 
  AS_MNG_SUB_STATUS_RECOGNIZERREADY,

 
  AS_MNG_SUB_STATUS_RECOGNIZERACTIVE,

 
  AS_MNG_SUB_STATUS_BASEBANDREADY,

 
  AS_MNG_SUB_STATUS_BASEBANDACTIVE,

 
  AS_MNG_SUB_STATUS_WAITCMDWORD,
  AS_MNG_SUB_STATUS_NUM
} AsMngSubStatus;

 
typedef enum
{
 
  AS_VAD_STATUS_OUT_OF_VOICE_SECTION = 0,

 
  AS_VAD_STATUS_INSIDE_VOICE_SECTION,
  AS_VAD_STATUS_NUM
} AsVadStatus;

 
typedef enum
{
 
  AS_STATUS_CHANGED_STS_READY = 0,

 
  AS_STATUS_CHANGED_STS_BASEBAND,

 
  AS_STATUS_CHANGED_STS_PLAYER,

 
  AS_STATUS_CHANGED_STS_RECODER,

 
  AS_STATUS_CHANGED_STS_POWEROFF,

 
  AS_STATUS_CHANGED_STS_THROUGH,
 
  AS_STATUS_CHANGED_STS_NUM
} AsStatusChangedSts;
 
 

 
typedef enum
{
  
  AS_ERR_CODE_OK = 0,
  
  
  AS_ERR_CODE_TASK_CREATE = -1,
  
  
  AS_ERR_CODE_ILLEGAL_STATE = -2
} AsErrorCode_e;

 
typedef enum
{
 
  AS_VOLUMEMUTE_HOLD,

 
  AS_VOLUMEMUTE_UNMUTE,

 
  AS_VOLUMEMUTE_MUTE,
  AS_VOLUMEMUTE_NUM
} AsVolumeMute;

 
typedef enum
{
 
  AS_BEEPEN_DISABLE,

 
  AS_BEEPEN_ENABLE,
  AS_BEEPEN_NUM
} asBeepEn;

 
typedef struct
{
 
  uint8_t  vad_status;

 
  uint8_t  reserved;

 
  uint8_t  sub_status_info;

 
  uint8_t  status_info;
} NotifyStatus;

 
typedef struct
{
 
  uint8_t  changed_status;

 
  uint8_t  reserved1;

 
  uint8_t  reserved2;

 
  uint8_t  reserved3;
} StatusChangedParam;

 
typedef struct
{
 
  uint32_t error_code;

 
  uint16_t reserved1;

 
  uint8_t  sub_module_id;

 
  uint8_t  module_id;

 
  uint32_t error_sub_code;

 
  uint32_t reserved2;

 
  uint32_t ErrorCommand[LENGTH_AUDRLT_ERRORRESPONSE_MAX-LENGTH_AUDRLT_ERRORRESPONSE_MIN];
} ErrorResponseParam;

#if defined(__CC_ARM)
#pragma anon_unions
#endif
 
typedef struct {
 
  AudioResultHeader header;
 
  union
  {
 
    NotifyStatus   notify_status;

 
    StatusChangedParam status_changed_param;

 
    ErrorResponseParam error_response_param;
  };
 
#if !defined(__CC_ARM)
} AudioResult ;
#else
} AudioResult __attribute__((transparent_union));
#endif
 
/* Error Code */
/* [T.B.D]
 *
 * no error = 0
 * state error
 * paramater error
 * timeout
 *
 */

 
typedef struct
{
 
  uint8_t app;

 
  uint8_t mng;

 
  uint8_t player_main;

 
  uint8_t player_sub;

 
  uint8_t micfrontend;

 
  uint8_t recorder;

 
  uint8_t mixer;

 
  uint8_t effector;

 
  uint8_t recognizer;
} AudioSubSystemIDs;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

 
int AS_SendAudioCommand(AudioCommand* packet);

 
int AS_ReceiveAudioResult(AudioResult* packet);

 
int AS_ReceiveAudioResult(FAR AudioResult *packet, uint8_t id, uint32_t tmo);

 
int AS_CreateAudioManager(AudioSubSystemIDs ids, AudioAttentionCb att_cb);

 
__attribute__((deprecated("\nDeprecated attention callback type is used. \
                           \nPlease use \"AudioAttentionCb\" as callback type. \
                           \n")))
int AS_CreateAudioManager(AudioSubSystemIDs ids, obs_AudioAttentionCb obs_att_cb);

 
int AS_DeleteAudioManager(void);

 
#endif /* __MODULES_INCLUDE_AUDIO_AUDIO_HIGH_LEVEL_API_H */