audio_recognizer_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_recognizer_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_RECOGNIZER_API_H
#define __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_RECOGNIZER_API_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define AS_FEATURE_RECOGNIZER_ENABLE
 
#define LENGTH_INIT_RECOGNIZER 3
 
#define LENGTH_START_RECOGNIZER 2 
 
#define LENGTH_STOP_RECOGNIZER  2
 
#define LENGTH_INIT_RECOGNIZER_DSP 4 
 
#define LENGTH_SET_RECOGNIZER_DSP 4 
 
#define AS_RECOGNIZER_FILE_PATH_LEN (AS_AUDIO_DSP_PATH_LEN)
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
typedef enum
{
  AsRecognizerEventAct = 0,
 
  AsRecognizerEventDeact,
 
  AsRecognizerEventInit,
 
  AsRecognizerEventStart,
 
  AsRecognizerEventExec,
 
  AsRecognizerEventStop,
 
  AsRecognizerEventInitRecognizerProc,
 
  AsRecognizerEventSetRecognizerProc,
 
} AsRecognizerEvent;
 
typedef enum
{
  AsRecognizerTypeUserCustom = 0,
 
  AsRecognizerTypeInvalid = 0xff
 
} AsRecognizerType;
 
typedef enum
{
  AsNotifyPathCallback = 0,
 
  AsNotifyPathMessage,
 
} AsRecognizerNotifyPath;
 
typedef struct
{
  uint32_t result_code;
 
  uint32_t command_id;
 
  AsRecognizerEvent event;
 
} RecognizerResultHeader;
 
typedef struct
{
  RecognizerResultHeader header;
 
} RecognizerResult;
 
typedef void (*RecognizerCallback)(RecognizerResult *result);
 
typedef struct
{
  RecognizerCallback cb;
 
} AsActivateRecognizerParam;
 
typedef void (*RecognizerNotifyCallback)(AsRecognitionInfo info);
 
union AsNotifyDest
{
  RecognizerNotifyCallback cb;
 
  struct __st_tunnel
  {
    uint8_t msgqid;
    uint32_t msgtype;
  } msg;
};
 
typedef struct
{
  uint8_t type;
 
  char dsp_path[AS_RECOGNIZER_FILE_PATH_LEN];
 
  uint8_t  notify_path;
 
  AsNotifyDest dest;
 
} AsInitRecognizerParam;
 
typedef struct
{
  uint32_t reserve;
 
} AsStartRecognizerParam;
 
typedef struct
{
  uint32_t reserve; 
 
} AsStopRecognizerParam;
 
typedef struct
{
  uint32_t reserve; 
 
} AsDeactivateRecognizerParam;
 
typedef struct
{
  uint8_t  *packet_addr;
 
  uint32_t packet_size;
 
} AsInitRecognizerProcParam, AsSetRecognizerProcParam;
 
typedef struct
{
  uint32_t command_id;
 
} RecognizerCommandHeader;
 
typedef struct
{
  /* Command Header */
 
  RecognizerCommandHeader header;
 
  /* Command Parameters */
 
  union
  {
    /* Activate Paramters */
 
    AsActivateRecognizerParam act_param;
 
    /* Init Paramters */
 
    AsInitRecognizerParam init_param;
 
    /* Start Paramters */
 
    AsStartRecognizerParam start_param;
 
    /* Stop Paramters */
 
    AsStopRecognizerParam stop_param;
 
    /* Init Rcgproc Paramters */
 
    AsInitRecognizerProcParam initrcgproc_param;
 
    /* Set Rcgproc Paramters */
 
    AsSetRecognizerProcParam setrcgproc_param;
 
    /* Deactivate Paramters */
 
    AsDeactivateRecognizerParam deact_param;
  };
 
} RecognizerCommand;
 
typedef struct
{
  uint8_t recognizer;
 
  uint8_t mng;
 
  uint8_t dsp;
 
} AsRecognizerMsgQueId_t;
 
typedef struct
{
  MemMgrLite::PoolId out;
 
  MemMgrLite::PoolId dsp;
 
} AsRecognizerPoolId_t;
 
typedef struct
{
  AsRecognizerMsgQueId_t msgq_id;
 
  AsRecognizerPoolId_t   pool_id;
 
} AsCreateRecognizerParam_t;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
bool AS_CreateRecognizer(FAR AsCreateRecognizerParam_t *param,
                         AudioAttentionCb attcb);
 
__attribute__((deprecated(
                 "\n \
                  \n Deprecated create API is used. \
                  \n Use \"AS_CreateRecognizer(AsCreateRecognizerParam_t * \
                  \n                          AudioAttentionCb)\". \
                  \n \
                  \n")))
bool AS_CreateRecognizer(FAR AsCreateRecognizerParam_t *param);
 
bool AS_DeleteRecognizer(void);
 
bool AS_checkAvailabilityRecognizer(void);
 
#endif  /* AUDIO_RECOGNIZER_API_H */