pasdk/common/aspDecOpCircBuf_common.h

   1
   2 /*
   3 Copyright (c) 2017, 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 #include "dbgBenchmark.h" // PCM high-sampling rate + SRC + CAR benchmarking
  45
  46 //#define CB_RW_OP_CAP_PP // debug
  47 #ifdef CB_RW_OP_CAP_PP
  48 #define CB_OP_NONE        0
  49 #define CB_OP_W           1     // ARM write
  50 #define CB_OP_R           2     // DSP read
  51 #define CB_OP_COUNT_MAX   10000
  52 #endif
  53
  54 // CB control
  55 #define ASP_DECODE_CB_GATE_NAME                 ( "AspDecOpCbGate" ) // name of GateMP used for circular buffer shared memory protection
  56 #define ASP_DECODE_CB_GATE_REGION_ID            ( 0 )                // IPC shared region ID used for CB gate allocation
  57
  58 // error return codes
  59 #define ASP_DECOP_CB_SOK                        ( 0 )                                       // ok
  60 #define ASP_DECOP_CB_CTL_INIT_INV_GATE          ( ASP_DECOP_CB_SOK-1 )                      // error: invalid gate handle
  61 #define ASP_DECOP_CB_RESET_INV_SOURCE_SEL       ( ASP_DECOP_CB_CTL_INIT_INV_GATE - 1 )      // error: invalid source selection on init
  62 #define ASP_DECOP_CB_ERR_START                  ( ASP_DECOP_CB_RESET_INV_SOURCE_SEL )       // start error return ID for master & slave error return definitions
  63
  64 #define ASP_DECOP_CB_MAX_NUM_AF                 ( 30 )      // decoder output circular buffer maximum number audio frames
  65
  66 #define ASP_DECOP_CB_MAX_NUM_PCM_CH             ( 16 )      // decoder output circular buffer maximum number audio PCM channels
  67 #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.
  68 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN          ( 6*256 )   // decoder output circular buffer maximum PCM frame length
  69
  70 #define ASP_DECOP_CB_MAX_NUM_PCM_CH_DDP         ( 16 )      // decoder output circular buffer maximum number audio PCM channels for DDP
  71 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kDDP   ( 6*256 )   // decoder output circular buffer maximum PCM frame length at 48kHz sampling rate
  72
  73 #define ASP_DECOP_CB_MAX_NUM_PCM_CH_MAT         ( 32 )      // decoder output circular buffer maximum number audio PCM channels for MAT
  74 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kMAT   ( 4*256 )   // decoder output circular buffer maximum PCM frame length at 48kHz sampling rate
  75
  76 // (***) FL: !!! REVISIT!!! THD 192 kHz "fudge factor" for CB PCM buffer size.
  77 // Using this factor in PCM buffer size definition, buffer large enough to execute 192 kHz w/o CB OVR/UND.
  78 // Need to define CB size in different terms than existing macros.
  79 // (***) FL: !!! REVISIT!!! Allocating memory for max # channels (e.g. 32 for THD).
  80 // GROSS over allocation for THD 192 kHz, 6ch max.
  81 #define THD_HSR_FUDGE_FACTOR                    ( 368640 + 240000 )
  82 #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 + THD_HSR_FUDGE_FACTOR)
  83 // FL: unused
  84 //#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 )
  85
  86 #define ASP_DECOP_CB_MAX_NUM_AF_PCM             ( 4 )
  87 #if (ASP_DECOP_CB_MAX_NUM_AF_PCM > ASP_DECOP_CB_MAX_NUM_AF)
  88     #error "CB Max AF PCM error"
  89 #endif
  90 #define ASP_DECOP_CB_INIT_WRTIDX_PCM            ( 0 )
  91 #define ASP_DECOP_CB_INIT_RDIDX_PCM             ( 0 )
  92 //#define ASP_DECOP_CB_INIT_LAG_PCM               ( 2 )
  93 #define ASP_DECOP_CB_TARGET_ND_SAMPS_48kPCM     ( (4+1) * 256 ) // PCM target Nominal Delay in number of samples, fs=48 kHz
  94
  95 #define ASP_DECOP_CB_MAX_NUM_AF_DDP             ( 3 )
  96 #if (ASP_DECOP_CB_MAX_NUM_AF_DDP > ASP_DECOP_CB_MAX_NUM_AF)
  97     #error "CB Max AF DDP error"
  98 #endif
  99 #define ASP_DECOP_CB_INIT_WRTIDX_DDP            ( 0 )
 100 #define ASP_DECOP_CB_INIT_RDIDX_DDP             ( 0 )
 101 //#define ASP_DECOP_CB_INIT_LAG_DDP               ( 1 )
 102 #define ASP_DECOP_CB_TARGET_ND_SAMPS_DDP        ( (6+6) * 256 ) // DDP target Nominal Delay in number of samples
 103
 104 #define ASP_DECOP_CB_MAX_NUM_AF_THD             ( 30 ) //( 15 )
 105 #if (ASP_DECOP_CB_MAX_NUM_AF_THD > ASP_DECOP_CB_MAX_NUM_AF)
 106     #error "CB Max AF THD error"
 107 #endif
 108 #define ASP_DECOP_CB_INIT_WRTIDX_THD            ( 0 )
 109 #define ASP_DECOP_CB_INIT_RDIDX_THD             ( 0 )
 110 //#define ASP_DECOP_CB_INIT_LAG_THD               ( 5 ) // 5*20ms = 100 ms, For the worst case of 100 ms
 111 #define ASP_DECOP_CB_TARGET_ND_SAMPS_48kTHD     ( 3600 ) //( 3504 ) //( 2224 ) // THD target Nominal Delay in number of samples, fs=48 kHz
 112 #define ASP_DECOP_CB_TARGET_ND_SAMPS_96kTHD     ( 2*ASP_DECOP_CB_TARGET_ND_SAMPS_48kTHD ) // THD target Nominal Delay in number of samples, fs=96 kHz
 113 #define ASP_DECOP_CB_TARGET_ND_SAMPS_192kTHD    ( 4*ASP_DECOP_CB_TARGET_ND_SAMPS_48kTHD ) // THD target Nominal Delay in number of samples, fs=192 kHz
 114
 115 //#define DEF_SOURCE_SEL                          ( PAF_SOURCE_PCM )          // default source select
 116 //#define DEF_DEC_OP_FRAME_LEN                    ( PAF_SYS_FRAMELENGTH )     // default decoder output frame length
 117 //#define DEF_STR_FRAME_LEN                       ( PAF_SYS_FRAMELENGTH )     // default stream frame length
 118
 119 // Decoder output circular buffer status
 120 typedef struct PAF_AST_DecOpCircBufStatus
 121 {
 122     Int size;
 123     Int16 strFrameLen;                      // stream frame length (output transaction size)
 124 } PAF_AST_DecOpCircBufStatus;
 125
 126 // Decoder output circular buffer
 127 typedef struct PAF_AST_DecOpCircBuf
 128 {
 129     PAF_AudioFrame *afCb;                   // audio frame CB
 130     PAF_AudioData *pcmBuf;                  // PCM buffer, contains PCM data associated with audio frames
 131     UInt8 *metaBuf;                         // metadata buffer, contains metadata associated with audio frames
 132     Int8 sourceSel;                         // selected source
 133     Int8 primedFlag;                        // flag indicated whether CB is primed: FALSE - CB not primed, TRUE - CB primed
 134     Int16 targetNDSamps;                    // target CB Nominal Delay number of samples
 135     Int16 deltaSamps;                       // number of 256 (N) sample output frames to block reader
 136     Int8 afRdIdx;                           // audio frame CB read index
 137     Int8 afWrtIdx;                          // audio frame CB write index
 138     //Int8 afLagIdx;                          // audio frame CB Lag idx,
 139     //Int8 afInitialLag;                      // Initial delay/lag between CB write and read
 140     Int16 pcmRdIdx;                         // pcm buffer read index
 141     Int8 prvMdRdIdx;                        // private metadata read index
 142     Int8 numAfCb;                           // current number frames in CB
 143     Int8 maxNumAfCb;                        // maximum number of audio frames in CB
 144     Int32 numPcmSampsPerCh;                 // current number of PCM samples per channel in CB
 145     Int32 maxNumPcmSampsPerCh;              // max number of PCM samples per channel in CB
 146     Int16 decOpFrameLen;                    // selected decoder output frame length (input transaction size)
 147     Int16 strFrameLen;                      // stream frame length (output transaction size)
 148     Int8 writerActiveFlag;                  // flag indicates whether CB writer is active: FALSE - writer not active, TRUE - writer active
 149     Int8 readerActiveFlag;                  // flag indicates whether CB reader is active: FALSE - reader not active, TRUE - reader active
 150     Int8 drainFlag;                         // flag indicates whether reader should drain (empty) remaining frames in CB: FALSE - reader should not drain, TRUE - reader should drain
 151     Int32 readAfWriterInactiveCnt;          // count of read audio frames with inactive writer & not draining
 152     Int32 readAfNdCnt;                      // count of read audio frames for nominal delay
 153     Int32 wrtAfReaderInactiveCnt;           // count of write audio frames with inactive reader
 154     Int32 wrtAfZeroSampsCnt;                // count of write audio frames with zero samples
 155     Int32 errAfUndCnt;                      // read error AF underflow count
 156     Int32 errAfOvrCnt;                      // write error AF overflow count
 157     Int32 errPcmUndCnt;                     // read error PCM underflow count
 158     Int32 errPcmOvrCnt;                     // write error PCM overflow count
 159     PAF_AudioData *pcmBufEnd;               // PCM buffer, contains PCM data associated with audio frames end
 160     UInt8 *metaBufEnd;                      // metadata buffer, contains metadata associated with audio frames end
 161     Int8 maxAFChanNum;                      // maximum number of audio data channels in audio frame
 162     Int16 maxAFSampCount;                   // maximum number of sample counts in audio frame
 163     PAF_AudioFrame lastAf;                  // used to store the last valid read out audio frame info to generate mute frame
 164     PAF_AST_DecOpCircBufStatus cbStatus;    // CB status
 165 #ifdef CB_RW_OP_CAP_PP // debug
 166     UInt32 *cb_samples_op;                  // should be in shared memory, preferred NON cache
 167     UInt8 *cb_op_owner;                     // should be in shared memory, preferred NON cache
 168     UInt8 *cb_afRdIdx;                      // should be in shared memory, preferred NON cache
 169     UInt8 *cb_afWrtIdx;                     // should be in shared memory, preferred NON cache
 170     UInt8 *cb_numAfCb;                      // should be in shared memory, preferred NON cache
 171     UInt32 cb_opCnt;                        // range (0 - CB_OP_COUNT_MAX)
 172 #endif
 173 } PAF_AST_DecOpCircBuf;
 174
 175 // Decoder output circular buffer statistics
 176 typedef struct PAF_AST_DecOpCircBufStats
 177 {
 178     Int32 readAfWriterInactiveCnt;  // count of read audio frames with inactive writer & not draining
 179     Int32 readAfNdCnt;              // count of read audio frames for nominal delay
 180     Int32 wrtAfReaderInactiveCnt;   // count of write audio frames with inactive reader
 181     Int32 wrtAfZeroSampsCnt;        // count of write audio frames with zero samples
 182     Int32 errAfUndCnt;              // read error AF underflow count
 183     Int32 errAfOvrCnt;              // write error AF overflow count
 184     Int32 errPcmUndCnt;             // read error PCM underflow count
 185     Int32 errPcmOvrCnt;             // write error PCM overflow count
 186 } PAF_AST_DecOpCircBufStats;
 187
 188 // Decoder output circular buffer control
 189 typedef struct PAF_AST_DecOpCircBufCtl
 190 {
 191     GateMP_Handle gateHandle;           // circular buffer gate handle
 192     Int8 numDecOpCb;                    // number of circular buffers
 193     PAF_AST_DecOpCircBuf **pXDecOpCb;   // address of decoder output circular buffer base pointer
 194 } PAF_AST_DecOpCircBufCtl;
 195
 196 // Initialize circular buffer control
 197 Int cbCtlInit(
 198     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
 199     Int8 numDecOpCb,                    // number of circular buffers
 200     PAF_AST_DecOpCircBuf **pXDecOpCb    // address of decoder output circular buffer base pointer
 201 );
 202
 203 // Reset circular buffer
 204 Int cbReset(
 205     PAF_AST_DecOpCircBufCtl *pCbCtl,
 206     Int8 cbIdx
 207 );
 208
 209 // Get circular buffer statistics
 210 Int cbGetStats(
 211     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
 212     Int8 cbIdx,                         // decoder output circular buffer index
 213     PAF_AST_DecOpCircBufStats *pCbStats // decoder output circular buffer statistics
 214
 215 );
 216
 217 // Output log of circular buffer control variables (debug)
 218 Int cbLog(
 219     PAF_AST_DecOpCircBufCtl *pCbCtl,
 220     Int8 cbIdx,
 221     Int8 fullLog,
 222     char *locInfo
 223 );
 224
 225
 226 #endif /* _ASP_DECOP_CB_COMMON_H_ */