audio_synthesizer_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_synthesizer_api.h
 *
 *   Copyright 2020 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_SYNTHESIZER_API_H
#define __MODULES_INCLUDE_AUDIO_SYNTHESIZER_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_SYNTHESIZER_ENABLE
 
#define LENGTH_INIT_SYNTHESIZER    10
 
#define LENGTH_START_SYNTHESIZER    2
 
#define LENGTH_STOP_SYNTHESIZER     2
 
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef enum
{
  AsSynthesizerEventAct = 0,
 
  AsSynthesizerEventInit,
 
  AsSynthesizerEventStart,
 
  AsSynthesizerEventStop,
 
  AsSynthesizerEventDeact,
 
  AsSynthesizerEventSet,
 
  AsSynthesizerEventNum
 
} AsSynthesizerEvent;
 
typedef enum
{
  InvalidWave          = 0xffffffff,
 
  AsSynthesizerSinWave = 0,
  AsSynthesizerRectWave, /* 1 */
  AsSynthesizerSawWave,  /* 2 */
 
  AsSynthesizerWaveModeNum
 
} AsSynthesizerWaveMode;
 
typedef enum
{
  AsSynthesizerMaxChannelNum = 8,
 
} AsSynthesizerChannelNum;
 
typedef enum
{
  AsSynthesizerDataPathCallback = 0,
 
  AsSynthesizerDataPathMessage,
 
} AsSynthesizerDataPath;
 
/* SetSynthesizerStatus */
 
/* InitSynthesizer */
 
typedef bool (*SynthesizerCallback)(AsSynthesizerEvent evtype, uint32_t result, void *param);
 
typedef struct
{
  SynthesizerCallback cb;
 
  void               *param;
 
} AsActivateSynthesizer;
 
typedef void (*SynthesizerDoneCallback)(AsPcmDataParam param);
 
union AsSynthesizerDataDest
{
  SynthesizerDoneCallback cb;
 
  struct __st_tunnel
  {
    MsgQueId id;
    uint32_t identifier;
  } msg;
};
 
typedef struct
{
  AsSynthesizerWaveMode type;
 
  uint8_t               channel_num;
 
  uint8_t               bit_width;
 
  uint16_t              sample_size;
 
  uint32_t              sampling_rate;
 
  uint16_t              attack;
  uint16_t              decay;
  uint16_t              sustain;
 
  uint16_t              release;
 
  char                  dsp_path[AS_AUDIO_DSP_PATH_LEN];
 
  AsSynthesizerDataPath data_path;
 
  AsSynthesizerDataDest dest;
 
} AsInitSynthesizerParam;
 
typedef struct
{
  uint8_t               channel_no;
 
  uint32_t              frequency;
 
  uint16_t              attack;
  uint16_t              decay;
  uint16_t              sustain;
 
  uint16_t              release;
 
} AsSetSynthesizer;
 
typedef struct
{
  uint8_t synthesizer;
 
  uint8_t mng;
 
  uint8_t dsp;
 
} AsSynthesizerMsgQueId_t;
 
typedef struct
{
  MemMgrLite::PoolId output;
 
  MemMgrLite::PoolId dsp;
 
} AsSynthesizerPoolId_t;
 
typedef struct
{
  AsSynthesizerMsgQueId_t msgq_id;
 
  AsSynthesizerPoolId_t   pool_id;
 
} AsCreateSynthesizerParam_t;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
bool AS_CreateMediaSynthesizer(FAR AsCreateSynthesizerParam_t *param,
                                   AudioAttentionCb            attcb);
 
__attribute__((deprecated(
                 "\n \
                  \n Deprecated create API is used. \
                  \n Use \"AS_CreateMediaSynthesizer(AsCreateSynthesizerParam_t, \
                  \n                                 AudioAttentionCb)\". \
                  \n \
                  \n")))
bool AS_CreateMediaSynthesizer(FAR AsCreateSynthesizerParam_t *param);
 
bool AS_ActivateMediaSynthesizer(FAR AsActivateSynthesizer *actparam);
 
bool AS_InitMediaSynthesizer(FAR AsInitSynthesizerParam *initparam);
 
bool AS_StartMediaSynthesizer(void);
 
bool AS_StopMediaSynthesizer(void);
 
bool AS_SetFrequencyMediaSynthesizer(FAR AsSetSynthesizer *set_param);
 
bool AS_SetEnvelopeMediaSynthesizer(FAR AsSetSynthesizer *set_param);
 
bool AS_SetMediaSynthesizer(FAR AsSetSynthesizer *set_param);
 
bool AS_DeactivateMediaSynthesizer(void);
 
bool AS_DeleteMediaSynthesizer(void);
 
bool AS_ReleaseMediaSynthesizer(bool is_end);
 
#endif  /* __MODULES_INCLUDE_AUDIO_SYNTHESIZER_API_H */