audio_common_defs.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_common_defs.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_COMMON_DEFS_H
#define __MODULES_INCLUDE_AUDIO_AUDIO_COMMON_DEFS_H
 
#include <arch/chip/audio.h>
 
/* API Documents creater with Doxgen */
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include "memutils/memory_manager/MemHandle.h"
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
/* const for baseband */
#define AS_VOLUME_DAC            -20
 
/* TODO:Be removed in future */
 
#define AS_AC_CODEC_VOL_DAC      -20
 
/* ---------------------------------*/
 
#define AS_MIC_CHANNEL_MAX        8
 
 
#define AS_MICGAIN_HOLD           215
 
#define AS_VOLUME_HOLD            255
 
#define AS_VOLUME_MUTE            -1025
 
#define AS_BEEP_VOL_HOLD          255
 
#define AS_BEEP_FREQ_HOLD         0
 
#define AS_MICGAIN_MUTE           -7855
 
#define AS_CODECTYPE_MP3    0
 
#define AS_CODECTYPE_WAV    1
 
#define AS_CODECTYPE_AAC    2
 
#define AS_CODECTYPE_OPUS   3
 
#define AS_CODECTYPE_MEDIA  4
 
#define AS_CODECTYPE_LPCM  5
 
#define AS_BITLENGTH_16  16
 
#define AS_BITLENGTH_24  24
 
#define AS_BITLENGTH_32  32
 
#define AS_CHANNEL_MONO    1
 
#define AS_CHANNEL_STEREO  2
 
#define AS_CHANNEL_4CH     4
 
#define AS_CHANNEL_6CH     6
 
#define AS_CHANNEL_8CH     8
 
/* Auto */
 
#define AS_SAMPLINGRATE_AUTO    0
 
#define AS_SAMPLINGRATE_8000    8000
 
#define AS_SAMPLINGRATE_11025   11025
 
#define AS_SAMPLINGRATE_12000   12000
 
#define AS_SAMPLINGRATE_16000   16000
 
#define AS_SAMPLINGRATE_22050   22050
 
#define AS_SAMPLINGRATE_24000   24000
 
#define AS_SAMPLINGRATE_32000   32000
 
#define AS_SAMPLINGRATE_44100   44100
 
#define AS_SAMPLINGRATE_48000   48000
 
#define AS_SAMPLINGRATE_64000   64000
 
#define AS_SAMPLINGRATE_88200   88200
 
#define AS_SAMPLINGRATE_96000   96000
 
#define AS_SAMPLINGRATE_128000  128000
 
#define AS_SAMPLINGRATE_176400  176400
 
#define AS_SAMPLINGRATE_192000  192000
 
#define AS_BITRATE_8000    8000
 
#define AS_BITRATE_16000   16000
 
#define AS_BITRATE_24000   24000
 
#define AS_BITRATE_32000   32000
 
#define AS_BITRATE_40000   40000
 
#define AS_BITRATE_48000   48000
 
#define AS_BITRATE_56000   56000
 
#define AS_BITRATE_64000   64000
 
#define AS_BITRATE_80000   80000
 
#define AS_BITRATE_96000   96000
 
#define AS_BITRATE_112000  112000
 
#define AS_BITRATE_128000  128000
 
#define AS_BITRATE_144000  144000
 
#define AS_BITRATE_160000  160000
 
#define AS_BITRATE_192000  192000
 
#define AS_BITRATE_224000  224000
 
#define AS_BITRATE_256000  256000
 
#define AS_BITRATE_320000  320000
 
#define AS_BITRATE_384000  384000
 
#define AS_BITRATE_448000  448000
 
#define AS_BITRATE_510000  510000
 
typedef enum
{
  AS_MODULE_ID_AUDIO_MANAGER = 0,
 
  AS_MODULE_ID_AUDIO_DRIVER,
 
  AS_MODULE_ID_MIC_FRONTEND_OBJ,
 
  AS_MODULE_ID_INPUT_DATA_MNG_OBJ,
 
  AS_MODULE_ID_MEDIA_RECORDER_OBJ,
 
  AS_MODULE_ID_OUTPUT_MIX_OBJ,
 
  AS_MODULE_ID_PLAYER_OBJ,
 
  AS_MODULE_ID_RECOGNITION_OBJ,
 
  AS_MODULE_ID_SOUND_EFFECT_OBJ,
 
  AS_MODULE_ID_SYNTHESIZER_OBJ,
 
  AS_MODULE_ID_CAPTURE_CMP,
 
  AS_MODULE_ID_DECODER_CMP,
 
  AS_MODULE_ID_ENCODER_CMP,
 
  AS_MODULE_ID_FILTER_CMP,
 
  AS_MODULE_ID_RECOGNITION_CMP,
 
  AS_MODULE_ID_RENDERER_CMP,
 
  AS_MODULE_ID_POSTPROC_CMP,
 
  AS_MODULE_ID_OSCILLATOR_CMP,
 
  AS_MODULE_ID_CUSTOM_CMP,
 
  AS_MODULE_ID_NUM,
} AsModuleId;
 
#define AS_ATTENTION_CODE_INFORMATION 0x00
 
#define AS_ATTENTION_CODE_WARNING     0x01
 
#define AS_ATTENTION_CODE_ERROR       0x02
 
#define AS_ATTENTION_CODE_FATAL       0x03
 
#define AS_ATTENTION_SUB_CODE_DMA_UNDERFLOW         0x01
 
#define AS_ATTENTION_SUB_CODE_DMA_OVERFLOW          0x02
 
#define AS_ATTENTION_SUB_CODE_DMA_ERROR             0x03
 
#define AS_ATTENTION_SUB_CODE_APU_QUEUE_FULL        0x04
 
#define AS_ATTENTION_SUB_CODE_SIMPLE_FIFO_UNDERFLOW 0x05
 
#define AS_ATTENTION_SUB_CODE_SIMPLE_FIFO_OVERFLOW  0x06
 
#define AS_ATTENTION_SUB_CODE_ILLEGAL_REQUEST       0x07
 
#define AS_ATTENTION_SUB_CODE_INTERNAL_STATE_ERROR  0x08
 
#define AS_ATTENTION_SUB_CODE_UNEXPECTED_PARAM      0x09
 
#define AS_ATTENTION_SUB_CODE_QUEUE_POP_ERROR       0x0A
 
#define AS_ATTENTION_SUB_CODE_QUEUE_PUSH_ERROR      0x0B
 
#define AS_ATTENTION_SUB_CODE_QUEUE_MISSING_ERROR   0x0C
 
#define AS_ATTENTION_SUB_CODE_MEMHANDLE_ALLOC_ERROR 0x0D
 
#define AS_ATTENTION_SUB_CODE_MEMHANDLE_FREE_ERROR  0x0E
 
#define AS_ATTENTION_SUB_CODE_TASK_CREATE_ERROR     0x0F
 
#define AS_ATTENTION_SUB_CODE_RESOURCE_ERROR        0x10
 
#define AS_ATTENTION_SUB_CODE_DECODED_SIZE_ZERO     0x11
 
#define AS_ATTENTION_SUB_CODE_DSP_LOAD_ERROR        0x12
 
#define AS_ATTENTION_SUB_CODE_DSP_UNLOAD_ERROR      0x13
 
#define AS_ATTENTION_SUB_CODE_DSP_EXEC_ERROR        0x14
 
#define AS_ATTENTION_SUB_CODE_DSP_RESULT_ERROR      0x15
 
#define AS_ATTENTION_SUB_CODE_DSP_ILLEGAL_REPLY     0x16
 
#define AS_ATTENTION_SUB_CODE_DSP_UNLOAD_DONE       0x17
 
#define AS_ATTENTION_SUB_CODE_DSP_VERSION_ERROR     0x18
 
#define AS_ATTENTION_SUB_CODE_BASEBAND_ERROR        0x19
 
#define AS_ATTENTION_SUB_CODE_STREAM_PARSER_ERROR   0x1A
 
#define AS_ATTENTION_SUB_CODE_DSP_LOAD_DONE         0x1B
 
#define AS_ATTENTION_SUB_CODE_RECSTART              0x1C
 
#define AS_ATTENTION_SUB_CODE_RECSTOP               0x1D
 
#define AS_ATTENTION_SUB_CODE_DSP_LOG_ALLOC_ERROR   0x1E
 
#define AS_ATTENTION_SUB_CODE_DSP_ASSETION_FAIL     0x1F
 
#define AS_ATTENTION_SUB_CODE_DSP_SEND_ERROR        0x20
 
#define AS_ATTENTION_SUB_CODE_ALLOC_HEAP_MEMORY     0x21
 
#define AS_ATTENTION_SUB_CODE_NUM   AS_ATTENTION_SUB_CODE_ALLOC_HEAP_MEMORY
 
#define AS_AUDIO_DSP_PATH_LEN 24 
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
typedef void (*PcmProcDoneCallback)(int32_t identifier, bool is_end);
 
typedef struct
{
  int32_t identifier;
 
  PcmProcDoneCallback callback;
 
  MemMgrLite::MemHandle mh;
 
  uint32_t sample;
 
  uint32_t size;
 
  bool is_end;
 
  bool is_valid;
 
  uint8_t bit_length;
 
} AsPcmDataParam;
 
typedef struct
{
  MemMgrLite::MemHandle mh;
 
  uint32_t size;
 
} AsRecognitionInfo;
 
#define ATTENTION_FILE_NAME_LEN 32
 
typedef struct
{
  uint32_t reserved1;
 
  uint8_t  error_code;
 
  uint8_t  cpu_id;
 
  uint8_t  sub_module_id;
 
  uint8_t  module_id;
 
  uint32_t error_att_sub_code;
 
  uint32_t reserved2;
 
  uint16_t line_number;
 
  uint8_t  task_id;
 
  uint8_t  reserved3;
 
  union
  {
    uint32_t align_dummy;
    char     error_filename[ATTENTION_FILE_NAME_LEN];
  };
 
} ErrorAttentionParam;
 
typedef void (*AudioAttentionCb)(const ErrorAttentionParam *attparam);
 
#ifndef ATTENTION_USE_FILENAME_LINE
typedef void (*obs_AudioAttentionCb)(uint8_t module_id,
                                     uint8_t error_code,
                                     uint8_t sub_code);
#else
typedef void (*obs_AudioAttentionCb)(uint8_t module_id,
                                     uint8_t error_code,
                                     uint8_t sub_code,
                                     FAR const char *file_name,
                                     uint32_t line);
#endif
 
#endif /* __MODULES_INCLUDE_AUDIO_AUDIO_COMMON_DEFS_H */