audio_frontend_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_frontend_api.h
 *
 *   Copyright 2019 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_FRONTEND_API_H
#define __MODULES_INCLUDE_AUDIO_AUDIO_FRONTEND_API_H


 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
 
#include "audio/audio_common_defs.h"
#include "audio/audio_object_common_api.h"
#include "memutils/simple_fifo/CMN_SimpleFifo.h"
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define AS_FEATURE_FRONTEND_ENABLE


 
#define  LENGTH_INIT_MICFRONTEND    4

 
#define  LENGTH_INIT_PREPROCESS_DSP  4

 
#define  LENGTH_SET_PREPROCESS_DSP   4


 
#define AS_PREPROCESS_FILE_PATH_LEN 22
 
/****************************************************************************
 * Public Types
 ****************************************************************************/

 
typedef enum
{
 
  AsMicFrontendEventAct = 0,

 
  AsMicFrontendEventDeact,

 
  AsMicFrontendEventInit,

 
  AsMicFrontendEventStart,

 
  AsMicFrontendEventStop,

 
  AsMicFrontendEventInitPreProc,

 
  AsMicFrontendEventSetPreProc,

 
  AsMicFrontendEventSetMicGain,
 
} AsMicFrontendEvent;
 
typedef enum
{
  AsMicFrontendDeviceMic = 0,
  AsMicFrontendDeviceI2S,
 
} AsMicFrontendInputDevice;

 
typedef enum
{
 
  AsMicFrontendPreProcThrough = 0,

 
  AsMicFrontendPreProcSrc,

 
  AsMicFrontendPreProcUserCustom,
 
  AsMicFrontendPreProcInvalid = 0xff,
 
} AsMicFrontendPreProcType;
 
typedef enum
{
 
  AsDataPathCallback = 0,

 
  AsDataPathMessage,

 
  AsDataPathSimpleFIFO,
 
} AsMicFrontendDataPath;

 
typedef struct
{
 
  uint8_t  input_device;
 
} AsActivateFrontendParam;
 
typedef bool (*MicFrontendCallback)(AsMicFrontendEvent evtype, uint32_t result, uint32_t sub_result);
 
typedef struct
{
  AsActivateFrontendParam param;
   
  MicFrontendCallback cb;
 
} AsActivateMicFrontend;

 
typedef struct
{
  uint32_t reserve;
 
} AsDeactivateMicFrontendParam;

 
typedef void (*FrontendDoneCallback)(AsPcmDataParam param);
 
union AsDataDest
{
  FrontendDoneCallback cb;
 
  CMN_SimpleFifoHandle *simple_fifo_handler;
 
  struct __st_tunnel
  {
    uint8_t msgqid;
    uint16_t msgtype;
  } msg;
};
 
typedef struct
{
 
  uint8_t  channel_number;

 
  uint8_t  bit_length;

 
  uint16_t samples_per_frame;

 
  uint32_t out_fs;

 
  uint8_t  preproc_type;

 
  char dsp_path[AS_PREPROCESS_FILE_PATH_LEN];

 
  uint8_t  data_path;

 
  AsDataDest dest;
 
} AsInitMicFrontendParam;

 
typedef struct
{
  uint32_t reserve;
 
} AsStartMicFrontendParam;

 
typedef struct
{
  uint32_t stop_mode;
 
} AsStopMicFrontendParam;

 
typedef struct
{
 
  uint8_t  *packet_addr;

 
  uint32_t packet_size;
 
} AsInitPreProcParam, AsSetPreProcParam;

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

 
typedef struct
{
 
  uint8_t command_code;

 
  uint8_t reserved0;
  uint8_t reserved1;
  uint8_t reserved2;
 
} MicFrontendCommandHeader;

 
typedef struct
{
 
  MicFrontendCommandHeader header;

 
  union
  {
 
    AsActivateMicFrontend act_param;

 
    AsDeactivateMicFrontendParam deact_param;

 
    AsInitMicFrontendParam init_param;

 
    AsStartMicFrontendParam start_param;

 
    AsStopMicFrontendParam stop_param;

 
    AsInitPreProcParam initpreproc_param;

 
    AsSetPreProcParam setpreproc_param;

 
    AsMicFrontendMicGainParam mic_gain_param;
  };
 
} MicFrontendCommand;

 
typedef struct
{
 
  uint8_t micfrontend;

 
  uint8_t mng;

 
  uint8_t dsp;
 
} AsMicFrontendMsgQueId_t;

 
typedef struct
{
 
  MemMgrLite::PoolId input;

 
  MemMgrLite::PoolId output;

 
  MemMgrLite::PoolId dsp;
 
} AsMicFrontendPoolId_t;
 
typedef struct
{
 
  uint8_t input;

 
  uint8_t output;

 
  uint8_t dsp;
 
} AsMicFrontendPoolId_old_t;

 
typedef struct
{
 
  AsMicFrontendMsgQueId_t   msgq_id;

 
  AsMicFrontendPoolId_old_t pool_id;
 
} AsCreateMicFrontendParam_t;
 
typedef struct
{
 
  AsMicFrontendMsgQueId_t msgq_id;

 
  AsMicFrontendPoolId_t   pool_id;
 
} AsCreateMicFrontendParams_t;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

 
bool AS_CreateMicFrontend(FAR AsCreateMicFrontendParam_t *param,
                          AudioAttentionCb attcb);
 
bool AS_CreateMicFrontend(FAR AsCreateMicFrontendParams_t *param,
                          AudioAttentionCb attcb);

 
bool AS_ActivateMicFrontend(FAR AsActivateMicFrontend *actparam);

 
bool AS_InitMicFrontend(FAR AsInitMicFrontendParam *initparam);

 
bool AS_StartMicFrontend(FAR AsStartMicFrontendParam *startparam);

 
bool AS_StopMicFrontend(FAR AsStopMicFrontendParam *stopparam);

 
bool AS_InitPreprocFrontend(FAR AsInitPreProcParam *param);

 
bool AS_SetPreprocMicFrontend(FAR AsSetPreProcParam *param);

 
bool AS_SetMicGainMicFrontend(FAR AsMicFrontendMicGainParam *micgain_param);

 
bool AS_DeactivateMicFrontend(FAR AsDeactivateMicFrontendParam *deactparam);

 
bool AS_DeleteMicFrontend(void);

 
bool AS_checkAvailabilityMicFrontend(void);
 
#endif  /* __MODULES_INCLUDE_AUDIO_AUDIO_FRONTEND_API_H */