pasdk/common/aspDecOpCircBuf_common.h

   1
   2 /*
   3 Copyright (c) 2016, Texas Instruments Incorporated - http://www.ti.com/
   4 All rights reserved.
   5
   6 * Redistribution and use in source and binary forms, with or without
   7 * modification, are permitted provided that the following conditions
   8 * are met:
   9 *
  10 * Redistributions of source code must retain the above copyright
  11 * notice, this list of conditions and the following disclaimer.
  12 *
  13 * Redistributions in binary form must reproduce the above copyright
  14 * notice, this list of conditions and the following disclaimer in the
  15 * documentation and/or other materials provided with the
  16 * distribution.
  17 *
  18 * Neither the name of Texas Instruments Incorporated nor the names of
  19 * its contributors may be used to endorse or promote products derived
  20 * from this software without specific prior written permission.
  21 *
  22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 *
  34 */
  35
  36 #ifndef _ASP_DECOP_CB_COMMON_H_
  37 #define _ASP_DECOP_CB_COMMON_H_
  38
  39 #include <xdc/std.h>
  40 #include <ti/ipc/GateMP.h>
  41 #include "paftyp.h"
  42 #include "pafdec.h"
  43
  44 //#define CB_RW_OP_CAP_PP
  45
  46 #ifdef CB_RW_OP_CAP_PP
  47 #define CB_OP_NONE        0
  48 #define CB_OP_W           1     // ARM write
  49 #define CB_OP_R           2     // DSP read
  50 #define CB_OP_COUNT_MAX   10000
  51 #endif
  52
  53 #define ASP_DECOP_CB_SOK                    ( 0 )       // ok
  54 #define ASP_DECOP_CB_CTL_INIT_INV_GATE      ( ASP_DECOP_CB_SOK-1 )  // error: invalid gate handle
  55 #define ASP_DECOP_CB_ERR_START              ( ASP_DECOP_CB_CTL_INIT_INV_GATE )
  56 #define ASP_DECOP_CB_MAX_NUM_AF             ( 15 )       // decoder output circular buffer maximum number audio frames
  57 #define ASP_DECOP_CB_MAX_NUM_PCM_CH         ( 16 )      // decoder output circular buffer maximum number audio PCM channels
  58 #define ASP_DECOP_CB_MAX_NUM_PCM_FRAMES     ( 15 ) // decoder output circular buffer maximum number PCM frames //Qin - Increased to prevent cb overflow for ddp.
  59 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN      ( 6*256 )   // decoder output circular buffer maximum PCM frame length
  60
  61 #define ASP_DECOP_CB_MAX_NUM_PCM_CH_DDP        ( 16 )     // decoder output circular buffer maximum number audio PCM channels for DDP
  62 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kDDP  ( 6*256 )  // decoder output circular buffer maximum PCM frame length at 48kHz sampling rate
  63
  64 #define ASP_DECOP_CB_MAX_NUM_PCM_CH_MAT        ( 32 )     // decoder output circular buffer maximum number audio PCM channels for MAT
  65 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kMAT  ( 4*256 )  // decoder output circular buffer maximum PCM frame length at 48kHz sampling rate
  66
  67 #define ASP_DECOP_CB_PCM_BUF_SZ             ( ASP_DECOP_CB_MAX_NUM_PCM_CH * ASP_DECOP_CB_MAX_NUM_PCM_FRAMES * ASP_DECOP_CB_MAX_PCM_FRAME_LEN )
  68 #define ASP_DECOP_CB_PCM_BUF_SZ_32CH48kMAT  ( ASP_DECOP_CB_MAX_NUM_PCM_CH_MAT * ASP_DECOP_CB_MAX_NUM_PCM_FRAMES * ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kMAT )
  69
  70 #define ASP_DECOP_CB_MAX_NUM_AF_PCM         ( 4 )
  71 #define ASP_DECOP_CB_INIT_LAG_PCM           ( 2 ) // 1...3
  72 #define ASP_DECOP_CB_INIT_WRTIDX_PCM        ( 0 )
  73 #define ASP_DECOP_CB_INIT_RDIDX_PCM         ( 0 )
  74
  75 #define ASP_DECOP_CB_MAX_NUM_AF_DDP         ( 2 )
  76 #define ASP_DECOP_CB_INIT_LAG_DDP           ( 1 ) // 0...5
  77 #define ASP_DECOP_CB_INIT_WRTIDX_DDP        ( 0 )
  78 #define ASP_DECOP_CB_INIT_RDIDX_DDP         ( 0 )
  79
  80 #define ASP_DECOP_CB_MAX_NUM_AF_THD         ( 15 )
  81 #define ASP_DECOP_CB_INIT_LAG_THD           ( 5 )  // 5*20ms = 100 ms, For the worst case of 100 ms
  82 #define ASP_DECOP_CB_INIT_WRTIDX_THD        ( 0 ) //ASP_DECOP_CB_INIT_LAG_THD )
  83 #define ASP_DECOP_CB_INIT_RDIDX_THD         ( 0 )
  84 #define ASP_DECODE_CB_GATE_NAME             ( "AspDecOpCbGate" )
  85 #define ASP_DECODE_CB_GATE_REGION_ID        ( 0 )
  86
  87
  88 // Decoder output circular buffer
  89 typedef struct PAF_AST_DecOpCircBuf
  90 {
  91     PAF_AudioFrame *afCb;   // audio frame CB
  92     PAF_AudioData *pcmBuf;  // PCM buffer, contains PCM data associated with audio frames
  93     UInt8 *metaBuf;         // metadata buffer, contains metadata associated with audio frames
  94     Int8 sourceSel;         // selected source
  95     Int8 afRdIdx;           // audio frame CB read index
  96     Int8 afWrtIdx;          // audio frame CB write index
  97     Int8 afLagIdx;          // audio frame CB Lag idx,
  98     Int8 afInitialLag;      // Initial delay/lag between CB write and read
  99     Int16 pcmRdIdx;         // pcm buffer read index
 100     Int8 numAfCb;           // current number frames in CB
 101     Int8 maxNumAfCb;        // maximum number of audio frames in CB
 102     Int16 decOpFrameLen;    // selected decoder output frame length (input transaction size)
 103     Int16 strFrameLen;      // stream frame length (output transaction size)
 104     Int8 writerActiveFlag;  // flag indicates whether CB writer is active
 105     Int8 readerActiveFlag;  // flag indicates whether CB reader is active
 106     Int8 emptyFlag;         // flag indicates whether reader should empty (drain) remaining frames in CB
 107     Int8 errUndCnt;         // underflow count
 108     Int8 errOvrCnt;         // overflow count
 109     PAF_AudioData *pcmBufEnd;  // PCM buffer, contains PCM data associated with audio frames end
 110     UInt8 *metaBufEnd;         // metadata buffer, contains metadata associated with audio frames end
 111     Int8 maxAFChanNum;      // maximum number of audio data channels in audio frame
 112     Int16 maxAFSampCount;   // maximum number of sample counts in audio frame
 113     PAF_AudioFrame lastAf;  // used to store the last valid read out audio frame info to generate mute frame
 114     #ifdef CB_RW_OP_CAP_PP
 115     UInt32 *cb_samples_op;  // should be in shared memory, preferred NON cache
 116     UInt8 *cb_op_owner;     // should be in shared memory, preferred NON cache
 117     UInt8 *cb_afRdIdx;      // should be in shared memory, preferred NON cache
 118     UInt8 *cb_afWrtIdx;     // should be in shared memory, preferred NON cache
 119     UInt8 *cb_numAfCb;      // should be in shared memory, preferred NON cache
 120     UInt32 cb_opCnt;        // range (0 - CB_OP_COUNT_MAX)
 121     #endif
 122 } PAF_AST_DecOpCircBuf;
 123
 124 // Decoder output circular buffer control
 125 typedef struct PAF_AST_DecOpCircBufCtl
 126 {
 127     GateMP_Handle gateHandle;           // circular buffer gate handle
 128     PAF_AST_DecOpCircBuf **pXDecOpCb;   // address of decoder output circular buffer base pointer
 129 } PAF_AST_DecOpCircBufCtl;
 130
 131 // Initialize circular buffer control
 132 Int cbCtlInit(
 133     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
 134     PAF_AST_DecOpCircBuf **pXDecOpCb    // address of decoder output circular buffer base pointer
 135 );
 136
 137 // Reset circular buffer
 138 Int cbReset(
 139     PAF_AST_DecOpCircBufCtl *pCbCtl,
 140     Int8 cbIdx
 141 );
 142
 143 // Output log of circular buffer control variables (debug)
 144 Int cbLog(
 145     PAF_AST_DecOpCircBufCtl *pCbCtl,
 146     Int8 cbIdx,
 147     Int8 fullLog,
 148     char *locInfo
 149 );
 150
 151 #endif /* _ASP_DECOP_CB_COMMON_H_ */