audio_effector_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_effector_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 __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_EFFECTOR_API_H
#define __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_EFFECTOR_API_H
 
/* API Documents creater with Doxgen */
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define AS_FEATURE_EFFECTOR_ENABLE
 
#define  SUB_SETMPP_COMMON    0x00
 
#define  SUB_SETMPP_XLOUD     0x01
 
#define  LENGTH_STARTBB             3
 
#define  LENGTH_STOPBB              3
 
#define CHECK_XLOUD_VOLUME_RANGE(vol)  \
            (bool)(((0 <= (vol)) && ((vol) <= 59)) ? true : false)
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
/* enum for baseband */
 
/* StartBB */
 
typedef enum
{
  AS_OUTPUT_DEVICE_I2S2CH = 0x03,
 
  AS_OUTPUT_DEVICE_SP2CH = 0x30,
 
  AS_OUTPUT_DEVICE_SP2CH_I2S2CH = (AS_OUTPUT_DEVICE_I2S2CH | AS_OUTPUT_DEVICE_SP2CH),
} AsOutputDevice;
 
typedef enum
{
  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)
} AsInputDevice;
 
typedef enum
{
  AS_MPP_OUTPUT_I2SIN = 0,
  AS_SP_OUTPUT_DATA_NUM
} AsSpOutputData;
 
typedef enum
{
  AS_MFE_OUTPUT_MICSIN = 0,
 
  AS_MIC_THROUGH,
  AS_I2S_OUTPUT_DATA_NUM
} AsI2sOutputData;
 
typedef enum
{
  AS_SELECT_MIC1_OR_MIC2 = 0x06,
 
  AS_SELECT_MIC0_OR_MIC3 = 0x09
} AsSelectOutputMic;
 
/* InitMFE */
 
typedef enum
{
  AS_MFE_MODE_RECOGNITION = 0,
 
  AS_MFE_MODE_SPEAKING,
  AS_MFE_MODE_NUM
} AsMfeModeId;
 
typedef enum
{
  AS_NOINCLUDE_ECHOCANCEL = 0,
 
  AS_INCLUDE_ECHOCANCEL,
  AS_MFE_INC_ECHOCANCEL_NUM
} AsMfeIncludeEchoCancel;
 
typedef enum
{
  AS_DISABLE_ECHOCANCEL = 0,
 
  AS_ENABLE_ECHOCANCEL,
  AS_MFE_ENBL_ECHOCANCEL_NUM
} AsMfeEnableEchoCancel;
 
/* InitMPP */
 
typedef enum
{
  AS_MPP_MODE_XLOUD_ONLY = 0,
  AS_MPP_MODE_NUM
} AsMppModeId;
 
typedef enum
{
  AS_MPP_COEF_SPEAKER = 0,
 
  AS_MPP_COEF_HEADPHONE,
  AS_MPP_COEF_NUM
} AsMppCoefModeId;
 
typedef enum
{
  AS_MPP_XLOUD_MODE_NORMAL = 0,
 
  AS_MPP_XLOUD_MODE_SPEAKING,
 
  AS_MPP_XLOUD_MODE_DISABLE,
  AS_MPP_XLOUD_MODE_NUM
} AsMppXloudModeId;
 
  typedef enum
{
  AS_MPP_EAX_DISABLE = 0,
 
  AS_MPP_EAX_ENABLE,
  AS_MPP_EAX_NUM
} AsMppEaxModeId;
 
/* SetBaseBandStatus */
 
typedef enum
{
  AS_SET_BBSTS_WITH_MFE_NONE = 0,
 
  AS_SET_BBSTS_WITH_MFE_ACTIVE,
  AS_SET_BBSTS_WITH_MFE_NUM
} AsSetBBStsWithMfe;
 
typedef enum
{
  AS_SET_BBSTS_WITH_VCMD_NONE = 0,
 
  AS_SET_BBSTS_WITH_VCMD_ACTIVE,
  AS_SET_BBSTS_WITH_VCMD_NUM
} AsSetBBStsWithVoiceCommand;
 
typedef enum
{
  AS_SET_BBSTS_WITH_MPP_NONE = 0,
 
  AS_SET_BBSTS_WITH_MPP_ACTIVE,
  AS_SET_BBSTS_WITH_MPP_NUM
} AsSetBBStsWithMpp;
 
typedef struct
{
  uint16_t input_fs;
 
  uint8_t  ref_channel_num;
 
  uint8_t  mic_channel_num;
 
  uint8_t  enable_echocancel;
 
  uint8_t  include_echocancel;
 
  uint8_t  reserved2;
 
  uint8_t  mfe_mode;
 
  uint32_t config_table;
} InitMFEParam;
 
typedef struct
{
  uint8_t  output_device;
 
  uint8_t  reserved1;
 
  uint16_t input_device;
 
  uint8_t  select_output_mic;
 
  uint8_t  reserved2;
 
  uint8_t  I2S_output_data;
 
  uint8_t  SP_output_data;
} StartBBParam;
 
typedef struct
{
  uint8_t  stop_device;
 
  uint8_t  reserved1;
 
  uint16_t reserved2;
 
  uint8_t  reserved3;
 
  uint8_t  reserved4;
 
  uint8_t  reserved5;
 
  uint8_t  reserved6;
} StopBBParam;
 
typedef struct
{
  uint8_t  reserved1;
 
  uint8_t  with_MPP;
 
  uint8_t  with_Voice_Command;
 
  uint8_t  with_MFE;
 
  uint16_t input_device;
 
  uint8_t  reserved2;
 
  uint8_t  output_device;
 
  char dsp_path[AS_AUDIO_DSP_PATH_LEN];
 
} SetBaseBandStatusParam;
 
typedef struct
{
  uint8_t effector;
 
  uint8_t mng;
 
  uint8_t recognizer;
 
  uint8_t dsp;
} AsEffectorMsgQueId_t;
 
typedef struct
{
  uint8_t mic_in;
 
  uint8_t i2s_in;
 
  uint8_t sphp_out;
 
  uint8_t i2s_out;
 
  uint8_t mfe_out;
} AsEffectorPoolId_t;
 
typedef struct
{
  AsEffectorMsgQueId_t msgq_id;
 
  AsEffectorPoolId_t   pool_id;
} AsCreateEffectorParam_t;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
bool AS_CreateEffector(FAR AsCreateEffectorParam_t *param,
                       AudioAttentionCb attcb);
 
__attribute__((deprecated(
                 "\n \
                  \n Deprecated create API is used. \
                  \n Use \"AS_CreateEffector(AsCreateEffectorParam_t * \
                  \n                        AudioAttentionCb)\". \
                  \n \
                  \n")))
bool AS_CreateEffector(FAR AsCreateEffectorParam_t *param);
 
bool AS_DeleteEffector(void);
 
#endif  /* __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_EFFECTOR_API_H */