audio_player_api.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_player_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_PLAYER_API_H
#define __MODULES_INCLUDE_AUDIO_AUDIO_PLAYER_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/memory_manager/MemHandle.h"
#include "memutils/message/MsgPacket.h"
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
/* Enable player feature. */
 
#define AS_FEATURE_PLAYER_ENABLE
 
/* Need to enable mixer feature when player feature is enabled.
 * Because player feature always use mixer feature.
 */
 
#define AS_FEATURE_OUTPUTMIX_ENABLE
  
#define LENGTH_INIT_PLAYER     (9)
 
#define LENGTH_INIT_SUBPLAYER  (LENGTH_INIT_PLAYER)
 
#define LENGTH_PLAY_PLAYER     (2)
 
#define LENGTH_PLAY_SUBPLAYER  (LENGTH_PLAY_PLAYER)
 
#define LENGTH_STOP_PLAYER     (2)
 
#define LENGTH_STOP_SUBPLAYER  (LENGTH_STOP_PLAYER)
 
#define LENGTH_CLK_RECOVERY  (2)
 
#define LENGTH_SET_GAIN (2)
 
#define LENGTH_SENDPOSTCMD (10)
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef enum
{
  AsPlayerEventAct = 0,
 
  AsPlayerEventInit,
 
  AsPlayerEventPlay,
 
  AsPlayerEventStop,
 
  AsPlayerEventDeact,
 
  AsPlayerEventSetGain,
 
} AsPlayerEvent;
 
typedef enum
{
  AS_PLAYER_ID_0 = 0,
 
  AS_PLAYER_ID_1,
 
  AS_PLAYER_ID_NUM,
 
} AsPlayerId;
 
typedef enum
{
  AS_ACTPLAYER_MAIN = 1,
 
  AS_ACTPLAYER_SUB,
 
  AS_ACTPLAYER_BOTH,
  AS_ACTPLAYER_NUM
} AsSetActivatePlayer;
 
typedef enum
{
  AS_SETPLAYER_INPUTDEVICE_EMMC = 0,
 
  AS_SETPLAYER_INPUTDEVICE_A2DPFIFO,
 
  AS_SETPLAYER_INPUTDEVICE_I2SINPUT,
 
  AS_SETPLAYER_INPUTDEVICE_RAM,
  AS_SETPLAYER_INPUTDEVICE_NUM
 
} AsSetPlayerInputDevice;
 
typedef enum
{
  AS_SETPLAYER_OUTPUTDEVICE_SPHP = 0,
 
  AS_SETPLAYER_OUTPUTDEVICE_I2SOUTPUT,
 
  AS_SETPLAYER_OUTPUTDEVICE_A2DPFIFO,
  AS_SETPLAYER_OUTPUTDEVICE_NUM
} AsSetPlayerOutputDevice;
 
typedef enum
{
  AS_STOPPLAYER_NORMAL = 0,
 
  AS_STOPPLAYER_ESEND,
 
  AS_STOPPLAYER_FORCIBLY = 0xFF
} AsStopPlayerStopMode;
 
typedef enum
{
  AsPcmDataReply = 0,
 
  AsPcmDataTunnel,
 
} AsPcmDataPath;
 
typedef enum
{
  AsNextNormalRequest = 0,
  AsNextStopResRequest,
 
} AsRequestNextType;
 
/* for AsPlayerInputDeviceHdlrForRAM */
 
typedef void (*AudioSimpleFifoReadDoneCallbackFunction)(uint32_t size);
 
typedef struct
{
  void *simple_fifo_handler;
 
  AudioSimpleFifoReadDoneCallbackFunction callback_function;
 
  uint32_t  notification_threshold_size;
} AsPlayerInputDeviceHdlrForRAM;
 
#if defined(__CC_ARM)
#pragma anon_unions
#endif
 
typedef struct
{
  uint8_t  input_device;
 
  uint8_t  output_device;
 
  uint8_t  reserved0;
 
  uint8_t  reserved1;
 
  AsPlayerInputDeviceHdlrForRAM* ram_handler;
 
} AsActivatePlayerParam;
 
typedef bool (*MediaPlayerCallback)(AsPlayerEvent evtype, uint32_t result, uint32_t sub_result);
 
typedef struct
{
  AsActivatePlayerParam param;
 
  MediaPlayerCallback cb;
 
} AsActivatePlayer;
 
typedef struct
{
  uint8_t  active_player;
 
  uint8_t  post0_enable;
 
  uint8_t  post1_enable;
 
  uint8_t  reserve0;
 
  AsActivatePlayerParam player0;
 
  AsActivatePlayerParam player1;
 
#if !defined(__CC_ARM)
} SetPlayerStsParam ;
#else
} SetPlayerStsParam __attribute__((transparent_union));
#endif
 
typedef struct
{
  uint32_t reserve0;
} AsDeactivatePlayer;
 
typedef void (*DecodeDoneCallback)(AsPcmDataParam param);
 
typedef struct
{
  uint8_t  channel_number;
 
  uint8_t  bit_length;
 
  uint8_t  codec_type;
 
  uint8_t  reserved1;
 
  uint32_t sampling_rate;
 
  char dsp_path[AS_AUDIO_DSP_PATH_LEN];
 
} AsInitPlayerParam;
 
typedef union
{
  DecodeDoneCallback callback;
 
  struct __st_pcm_msg 
  {
    MsgQueId id;
    uint32_t identifier;
  } msg;
 
} AsPcmDataDest;
 
typedef struct
{
  uint8_t pcm_path;
 
  AsPcmDataDest pcm_dest;
 
} AsPlayPlayerParam;
 
typedef struct
{
  uint8_t stop_mode;
} AsStopPlayerParam;
 
typedef struct
{
  uint8_t l_gain;
 
  uint8_t r_gain;
} AsSetGainParam;
 
typedef struct
{
  uint8_t type;
 
} AsRequestNextParam;
 
typedef struct
{
  uint8_t player_id;
 
  union
  {
    AsActivatePlayer act_param;
 
    AsInitPlayerParam init_param;
  
    AsPlayPlayerParam play_param;
  
    AsStopPlayerParam stop_param;
  
    AsRequestNextParam req_next_param;
 
    AsSetGainParam set_gain_param;
  
    AsDeactivatePlayer deact_param;
  };
} PlayerCommand;
 
typedef struct
{
  uint8_t player;
 
  uint8_t mng;
 
  uint8_t mixer;
 
  uint8_t dsp;
} AsPlayerMsgQueId_t;
 
typedef struct
{
  MemMgrLite::PoolId es;
 
  MemMgrLite::PoolId pcm;
 
  MemMgrLite::PoolId dsp;
 
  MemMgrLite::PoolId src_work;
} AsPlayerPoolId_t;
 
 
typedef struct{
  uint8_t es;
 
  uint8_t pcm;
 
  uint8_t dsp;
 
  uint8_t src_work;
} AsPlayerPoolId_old_t;
 
typedef struct
{
  AsPlayerMsgQueId_t msgq_id;
 
  AsPlayerPoolId_old_t   pool_id;
 
} AsCreatePlayerParam_t;
 
typedef struct
{
  AsPlayerMsgQueId_t msgq_id;
 
  AsPlayerPoolId_t   pool_id;
 
} AsCreatePlayerParams_t;
 
/****************************************************************************
 * Public Data
 ****************************************************************************/
 
/****************************************************************************
 * Inline Functions
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
bool AS_CreatePlayer(AsPlayerId id, FAR AsCreatePlayerParam_t *param);
 
bool AS_CreatePlayerMulti(AsPlayerId id,
                          FAR AsCreatePlayerParam_t *param,
                          AudioAttentionCb attcb);
 
bool AS_CreatePlayerMulti(AsPlayerId id,
                          FAR AsCreatePlayerParams_t *param,
                          AudioAttentionCb attcb);
 
__attribute__((deprecated(
                 "\n \
                  \n Deprecated create API is used. \
                  \n Use \"AS_CreatePlayerMulti(AsPlayerId, \
                  \n                           AsCreatePlayerParam_t *, \
                  \n                           AudioAttentionCb)\". \
                  \n \
                  \n")))
bool AS_CreatePlayerMulti(AsPlayerId id, FAR AsCreatePlayerParam_t *param);
 
bool AS_CreatePlayerMulti(AsPlayerId id, FAR AsCreatePlayerParams_t *param);
 
bool AS_ActivatePlayer(AsPlayerId id, FAR AsActivatePlayer *actparam);
 
bool AS_InitPlayer(AsPlayerId id, FAR AsInitPlayerParam *initparam);
 
bool AS_PlayPlayer(AsPlayerId id, FAR AsPlayPlayerParam *playparam);
 
bool AS_StopPlayer(AsPlayerId id, FAR AsStopPlayerParam *stopparam);
 
bool AS_SetPlayerGain(AsPlayerId id, FAR AsSetGainParam *gainparam);
 
bool AS_RequestNextPlayerProcess(AsPlayerId id, FAR AsRequestNextParam *nextparam);
 
bool AS_DeactivatePlayer(AsPlayerId id, FAR AsDeactivatePlayer *deactparam);
 
bool AS_DeletePlayer(AsPlayerId id);
 
bool AS_checkAvailabilityMediaPlayer(AsPlayerId id);
 
#endif  /* __MODULES_INCLUDE_AUDIO_AUDIO_PLAYER_API_H */