audio_recorder_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_recorder_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_RECORDER_API_H
#define __MODULES_INCLUDE_AUDIO_AUDIO_RECORDER_API_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
 
#include "audio/audio_common_defs.h"
#include "audio/audio_object_common_api.h"
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define AS_FEATURE_RECORDER_ENABLE
 
#define LENGTH_START_RECORDER    2
 
#define LENGTH_STOP_RECORDER     2
 
#define LENGTH_INIT_RECORDER    10 
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef enum
{
  AsRecorderEventAct = 0,
 
  AsRecorderEventDeact,
 
  AsRecorderEventInit,
 
  AsRecorderEventStart,
 
  AsRecorderEventReqEncode,
 
  AsRecorderEventStop
 
} AsRecorderEvent;
 
/* SetRecorderStatus */
 
typedef enum
{
  AS_SETRECDR_STS_INPUTDEVICE_MIC = 0,
 
  AS_SETRECDR_STS_INPUTDEVICE_I2S,
 
  /* Note:
   * Delete this definition with Ver 1.1.0
   */
 
  AS_SETRECDR_STS_INPUTDEVICE_MIC_A = AS_SETRECDR_STS_INPUTDEVICE_MIC,
  AS_SETRECDR_STS_INPUTDEVICE_MIC_D = AS_SETRECDR_STS_INPUTDEVICE_MIC,
  AS_SETRECDR_STS_INPUTDEVICE_I2S_IN = AS_SETRECDR_STS_INPUTDEVICE_I2S,
 
  AS_SETRECDR_STS_INPUTDEVICE_NUM
} AsSetRecorderStsInputDevice;
 
typedef enum
{
  AS_SETRECDR_STS_OUTPUTDEVICE_EMMC = 0,
 
  AS_SETRECDR_STS_OUTPUTDEVICE_RAM,
  AS_SETRECDR_STS_OUTPUTDEVICE_NUM
} AsSetRecorderStsOutputDevice;
 
/* InitRecorder */
 
typedef enum
{
  AS_INITREC_COMPLEXITY_0 = 0,
 
  AS_INITREC_COMPLEXITY_1,
 
  AS_INITREC_COMPLEXITY_2,
 
  AS_INITREC_COMPLEXITY_3,
 
  AS_INITREC_COMPLEXITY_4,
 
  AS_INITREC_COMPLEXITY_5,
 
  AS_INITREC_COMPLEXITY_6,
 
  AS_INITREC_COMPLEXITY_7,
 
  AS_INITREC_COMPLEXITY_8,
 
  AS_INITREC_COMPLEXITY_9,
 
  AS_INITREC_COMPLEXITY_10,
  AS_INITREC_COMPLEXITY_NUM
} AsInitRecorderComputationalComplexity;
 
/* for AsRecorderOutputDeviceHdlr */
 
typedef void (*AudioSimpleFifoWriteDoneCallbackFunction)(uint32_t size);
 
typedef struct
{
  void *simple_fifo_handler;
 
  AudioSimpleFifoWriteDoneCallbackFunction callback_function;
} AsRecorderOutputDeviceHdlr;
 
typedef struct
{
  uint8_t  input_device;
 
  uint8_t  output_device;
 
  uint8_t  reserved1;
 
  uint8_t  reserved2;
 
  uint32_t input_device_handler;
 
  AsRecorderOutputDeviceHdlr*  output_device_handler;
 
} AsActivateRecorderParam;
 
typedef bool (*MediaRecorderCallback)(AsRecorderEvent evtype, uint32_t result, uint32_t sub_result);
 
typedef struct
{
  AsActivateRecorderParam param;
   
  MediaRecorderCallback cb;
 
} AsActivateRecorder;
 
typedef struct
{
  uint32_t sampling_rate;
 
  uint8_t  channel_number;
 
  uint8_t  bit_length;
 
  uint8_t  codec_type;
 
  uint8_t  computational_complexity;
 
  uint32_t bitrate;
 
  char dsp_path[AS_AUDIO_DSP_PATH_LEN];
 
} AsInitRecorderParam;
 
typedef union
{
  AsActivateRecorder act_param;
 
 
  AsInitRecorderParam init_param;
 
} RecorderCommand;
 
typedef struct
{
  uint8_t recorder;
 
  uint8_t mng;
 
  uint8_t dsp;
} AsRecorderMsgQueId_t;
 
typedef struct
{
  MemMgrLite::PoolId input;
 
  MemMgrLite::PoolId output;
 
  MemMgrLite::PoolId dsp;
 
} AsRecorderPoolId_t;
 
typedef struct
{
  uint8_t input;
 
  uint8_t output;
 
  uint8_t dsp;
 
} AsRecorderPoolId_old_t;
 
typedef struct
{
  AsRecorderMsgQueId_t    msgq_id;
 
  AsRecorderPoolId_old_t  pool_id;
 
} AsCreateRecorderParam_t;
 
typedef struct
{
  AsRecorderMsgQueId_t msgq_id;
 
  AsRecorderPoolId_t   pool_id;
 
} AsCreateRecorderParams_t;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
bool AS_CreateMediaRecorder(FAR AsCreateRecorderParam_t *param,
                            AudioAttentionCb attcb);
 
bool AS_CreateMediaRecorder(FAR AsCreateRecorderParams_t *param,
                            AudioAttentionCb attcb);
 
__attribute__((deprecated(
                 "\n \
                  \n Deprecated create API is used. \
                  \n Use \"AS_CreateMediaRecorder(AsCreateRecorderParam_t, \
                  \n                             AudioAttentionCb)\". \
                  \n \
                  \n")))
bool AS_CreateMediaRecorder(FAR AsCreateRecorderParam_t *param);
 
bool AS_ActivateMediaRecorder(FAR AsActivateRecorder *actparam);
 
bool AS_InitMediaRecorder(FAR AsInitRecorderParam *initparam);
 
bool AS_ReqEncodeMediaRecorder(AsPcmDataParam *pcmparam);
 
bool AS_StartMediaRecorder(void);
 
bool AS_StopMediaRecorder(void);
 
bool AS_DeactivateMediaRecorder(void);
 
bool AS_DeleteMediaRecorder(void);
 
bool AS_checkAvailabilityMediaRecorder(void);
 
#endif  /* __MODULES_INCLUDE_AUDIO_AUDIO_RECORDER_API_H */