audio_outputmix_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_outputmix_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_OUTPUTMIX_API_H
#define __MODULES_INCLUDE_AUDIO_AUDIO_OUTPUTMIX_API_H

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include "audio/audio_common_defs.h"

#include "memutils/memory_manager/MemHandle.h"
#include "memutils/message/MsgPacket.h"

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

#define AS_FEATURE_OUTPUTMIX_ENABLE

#define  LENGTH_INIT_OUTPUTMIXER     4

#define  LENGTH_INITMPP             5

#define  LENGTH_SUB_SETMPP_COMMON   4

#define  LENGTH_SUB_SETMPP_XLOUD    4

#define AS_POSTPROC_FILE_PATH_LEN (AS_AUDIO_DSP_PATH_LEN)

#define PF_COMMAND_PACKET_SIZE_MAX (32)

/****************************************************************************
 * Public Types
 ****************************************************************************/
enum AsOutputMixerHandle
{
  OutputMixer0 = 0,

  OutputMixer1,
};

enum AsOutputMixDevice
{
  HPOutputDevice = 0,

  I2SOutputDevice,

  A2dpSrcOutputDevice,

  OutputMixDeviceNum
};

enum AsOutputMixerType
{
  MainOnly = 0,

  SoundEffectOnly,

  MainSoundEffectMix,

  OutputMixerTypeNum
};

enum AsOutputMixerPostFilter
{
  PostFilterDisable = 0,

  PostFilterEnable,
};

enum AsOutputMixDoneCmdType
{
  OutputMixActDone = 0,

  OutputMixInitDone,

  OutputMixDeactDone,

  OutputMixSetClkRcvDone,

  OutputMixInitPostDone,

  OutputMixSetPostDone,

  OutputMixDoneCmdTypeNum
};

typedef enum
{
  OutputMixAdvance = -1,

  OutputMixNoAdjust = 0,

  OutputMixDelay = 1,
} AsClkRecoveryDirection;

enum AsPostprocType
{
  AsPostprocTypeThrough = 0,

  AsPostprocTypeUserCustom,

  AsPostprocTypeInvalid = 0xff,
};

typedef struct
{
  uint8_t mixer;

  uint8_t mng;

  uint8_t render_path0_filter_dsp;
  uint8_t render_path1_filter_dsp;

} AsOutputMixMsgQueId_t;

typedef struct
{
  MemMgrLite::PoolId render_path0_filter_pcm;
  MemMgrLite::PoolId render_path1_filter_pcm;

  MemMgrLite::PoolId render_path0_filter_dsp;
  MemMgrLite::PoolId render_path1_filter_dsp;

} AsOutputMixPoolId_t;

typedef struct
{
  uint8_t render_path0_filter_pcm;
  uint8_t render_path1_filter_pcm;

  uint8_t render_path0_filter_dsp;
  uint8_t render_path1_filter_dsp;

} AsOutputMixPoolId_old_t;

typedef struct
{
  AsOutputMixMsgQueId_t msgq_id;

  AsOutputMixPoolId_old_t   pool_id;

} AsCreateOutputMixParam_t;

typedef struct
{
  AsOutputMixMsgQueId_t msgq_id;

  AsOutputMixPoolId_t   pool_id;

} AsCreateOutputMixParams_t;

struct AsOutputMixDoneParam
{
  int handle;

  AsOutputMixDoneCmdType done_type;

  bool result;

  uint32_t ecode;
};

typedef void (*OutputMixerCallback)(MsgQueId requester_dtq, MsgType msgtype, AsOutputMixDoneParam *param);
typedef void (*OutputMixerErrorCallback)(uint8_t handle);

typedef struct
{
  uint8_t output_device;

  uint8_t mixer_type;

  uint8_t post_enable;

  OutputMixerCallback cb;

  OutputMixerErrorCallback error_cb;

} AsActivateOutputMixer;

typedef struct
{
  uint8_t postproc_type;

  char dsp_path[AS_POSTPROC_FILE_PATH_LEN];

} AsInitOutputMixer;

typedef struct
{
  uint8_t reserve;

} AsDeactivateOutputMixer;

typedef struct
{
  uint8_t handle;

  PcmProcDoneCallback callback;

  AsPcmDataParam pcm;

} AsSendDataOutputMixer;

typedef struct
{
  int8_t   direction;

  uint32_t times;

} AsFrameTermFineControl;

typedef struct
{
  uint8_t  cmd_type;

  uint8_t  *addr;

  uint32_t size;

} AsInitPostProc;

typedef AsInitPostProc AsSetPostProc;

typedef struct
{
  uint8_t handle;

  union
  {
    AsActivateOutputMixer   act_param;
    AsInitOutputMixer       init_param;
    AsDeactivateOutputMixer deact_param;
    AsFrameTermFineControl  fterm_param;
    AsInitPostProc          initpp_param;
    AsSetPostProc           setpp_param;
  };
} OutputMixerCommand;

/****************************************************************************
 * Public Data
 ****************************************************************************/

/****************************************************************************
 * Inline Functions
 ****************************************************************************/

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

bool AS_CreateOutputMixer(FAR AsCreateOutputMixParam_t *param,
                          AudioAttentionCb attcb);

bool AS_CreateOutputMixer(FAR AsCreateOutputMixParams_t *param,
                          AudioAttentionCb attcb);

__attribute__((deprecated(
                 "\n \
                  \n Deprecated create API is used. \
                  \n Use \"AS_CreateOutputMixer(AsCreateOutputMixParam_t * \
                  \n                           AudioAttentionCb)\". \
                  \n \
                  \n")))
bool AS_CreateOutputMixer(FAR AsCreateOutputMixParam_t *param);

bool AS_CreateOutputMixer(FAR AsCreateOutputMixParams_t *param);

bool AS_ActivateOutputMixer(uint8_t handle, FAR AsActivateOutputMixer *actparam);

bool AS_InitOutputMixer(uint8_t handle, FAR AsInitOutputMixer *initparam);

bool AS_SendDataOutputMixer(FAR AsSendDataOutputMixer *sendparam);

bool AS_FrameTermFineControlOutputMixer(uint8_t handle, FAR AsFrameTermFineControl *ftermparam);

bool AS_InitPostprocOutputMixer(uint8_t handle, FAR AsInitPostProc *initppparam);

bool AS_SetPostprocOutputMixer(uint8_t handle, FAR AsSetPostProc *setppparam);

bool AS_DeactivateOutputMixer(uint8_t handle, FAR AsDeactivateOutputMixer *deactparam);

bool AS_DeleteOutputMix(void);

bool AS_checkAvailabilityOutputMixer(void);

#endif  /* __MODULES_INCLUDE_AUDIO_AUDIO_OUTPUTMIX_API_H */