2 /*
3 Copyright (c) 2017, Texas Instruments Incorporated - http://www.ti.com/
4 All rights reserved.
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 */
36 #ifndef _ASP_DECOP_CB_COMMON_H_
37 #define _ASP_DECOP_CB_COMMON_H_
39 #include <xdc/std.h>
40 #include <ti/ipc/GateMP.h>
41 #include "paftyp.h"
42 #include "pafdec.h"
44 #include "dbgBenchmark.h" // PCM high-sampling rate + SRC + CAR benchmarking
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
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
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_ERR_START ( ASP_DECOP_CB_CTL_INIT_INV_GATE ) // start error return ID for master & slave error return definitions
63 #define ASP_DECOP_CB_MAX_NUM_AF ( 30 ) // decoder output circular buffer maximum number audio frames
65 #define ASP_DECOP_CB_MAX_NUM_PCM_CH ( 16 ) // decoder output circular buffer maximum number audio PCM channels
66 #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.
67 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN ( 6*256 ) // decoder output circular buffer maximum PCM frame length
69 #define ASP_DECOP_CB_MAX_NUM_PCM_CH_DDP ( 16 ) // decoder output circular buffer maximum number audio PCM channels for DDP
70 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kDDP ( 6*256 ) // decoder output circular buffer maximum PCM frame length at 48kHz sampling rate
72 #define ASP_DECOP_CB_MAX_NUM_PCM_CH_MAT ( 32 ) // decoder output circular buffer maximum number audio PCM channels for MAT
73 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN_48kMAT ( 4*256 ) // decoder output circular buffer maximum PCM frame length at 48kHz sampling rate
75 #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 )
76 #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 )
78 #define ASP_DECOP_CB_MAX_NUM_AF_PCM ( 4 )
79 #if (ASP_DECOP_CB_MAX_NUM_AF_PCM > ASP_DECOP_CB_MAX_NUM_AF)
80 #error "CB Max AF PCM error"
81 #endif
82 #define ASP_DECOP_CB_INIT_WRTIDX_PCM ( 0 )
83 #define ASP_DECOP_CB_INIT_RDIDX_PCM ( 0 )
84 //#define ASP_DECOP_CB_INIT_LAG_PCM ( 2 )
85 #define ASP_DECOP_CB_TARGET_ND_SAMPS_48kPCM ( (4+1) * 256 ) // PCM target Nominal Delay in number of samples, fs=48 kHz
87 #define ASP_DECOP_CB_MAX_NUM_AF_DDP ( 2 )
88 #if (ASP_DECOP_CB_MAX_NUM_AF_DDP > ASP_DECOP_CB_MAX_NUM_AF)
89 #error "CB Max AF DDP error"
90 #endif
91 #define ASP_DECOP_CB_INIT_WRTIDX_DDP ( 0 )
92 #define ASP_DECOP_CB_INIT_RDIDX_DDP ( 0 )
93 //#define ASP_DECOP_CB_INIT_LAG_DDP ( 1 )
94 #define ASP_DECOP_CB_TARGET_ND_SAMPS_DDP ( (6+6) * 256 ) // DDP target Nominal Delay in number of samples
96 #define ASP_DECOP_CB_MAX_NUM_AF_THD ( 30 ) //( 15 )
97 #if (ASP_DECOP_CB_MAX_NUM_AF_THD > ASP_DECOP_CB_MAX_NUM_AF)
98 #error "CB Max AF THD error"
99 #endif
100 #define ASP_DECOP_CB_INIT_WRTIDX_THD ( 0 )
101 #define ASP_DECOP_CB_INIT_RDIDX_THD ( 0 )
102 //#define ASP_DECOP_CB_INIT_LAG_THD ( 5 ) // 5*20ms = 100 ms, For the worst case of 100 ms
103 #define ASP_DECOP_CB_TARGET_ND_SAMPS_48kTHD ( 3600 ) //( 3504 ) //( 2224 ) // THD target Nominal Delay in number of samples, fs=48 kHz
104 #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
105 #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
107 //#define DEF_SOURCE_SEL ( PAF_SOURCE_PCM ) // default source select
108 //#define DEF_DEC_OP_FRAME_LEN ( PAF_SYS_FRAMELENGTH ) // default decoder output frame length
109 //#define DEF_STR_FRAME_LEN ( PAF_SYS_FRAMELENGTH ) // default stream frame length
112 // Decoder output circular buffer
113 typedef struct PAF_AST_DecOpCircBuf
114 {
115 PAF_AudioFrame *afCb; // audio frame CB
116 PAF_AudioData *pcmBuf; // PCM buffer, contains PCM data associated with audio frames
117 UInt8 *metaBuf; // metadata buffer, contains metadata associated with audio frames
118 Int8 sourceSel; // selected source
119 Int8 primedFlag; // flag indicated whether CB is primed: FALSE - CB not primed, TRUE - CB primed
120 Int16 targetNDSamps; // target CB Nominal Delay number of samples
121 Int16 deltaSamps; // number of 256 (N) sample output frames to block reader
122 Int8 afRdIdx; // audio frame CB read index
123 Int8 afWrtIdx; // audio frame CB write index
124 //Int8 afLagIdx; // audio frame CB Lag idx,
125 //Int8 afInitialLag; // Initial delay/lag between CB write and read
126 Int16 pcmRdIdx; // pcm buffer read index
127 Int8 prvMdRdIdx; // private metadata read index
128 Int8 numAfCb; // current number frames in CB
129 Int8 maxNumAfCb; // maximum number of audio frames in CB
130 Int16 decOpFrameLen; // selected decoder output frame length (input transaction size)
131 Int16 strFrameLen; // stream frame length (output transaction size)
132 Int8 writerActiveFlag; // flag indicates whether CB writer is active: FALSE - writer not active, TRUE - writer active
133 Int8 readerActiveFlag; // flag indicates whether CB reader is active: FALSE - reader not active, TRUE - reader active
134 Int8 drainFlag; // flag indicates whether reader should drain (empty) remaining frames in CB: FALSE - reader should not drain, TRUE - reader should drain
135 Int32 readAfWriterInactiveCnt; // count of read audio frames with inactive writer & not draining
136 Int32 readAfNdCnt; // count of read audio frames for nominal delay
137 Int32 wrtAfReaderInactiveCnt; // count of write audio frames with inactive reader
138 Int32 wrtAfZeroSampsCnt; // count of write audio frames with zero samples
139 Int32 errUndCnt; // read error underflow count
140 Int32 errOvrCnt; // write error overflow count
141 PAF_AudioData *pcmBufEnd; // PCM buffer, contains PCM data associated with audio frames end
142 UInt8 *metaBufEnd; // metadata buffer, contains metadata associated with audio frames end
143 Int8 maxAFChanNum; // maximum number of audio data channels in audio frame
144 Int16 maxAFSampCount; // maximum number of sample counts in audio frame
145 PAF_AudioFrame lastAf; // used to store the last valid read out audio frame info to generate mute frame
146 #ifdef CB_RW_OP_CAP_PP // debug
147 UInt32 *cb_samples_op; // should be in shared memory, preferred NON cache
148 UInt8 *cb_op_owner; // should be in shared memory, preferred NON cache
149 UInt8 *cb_afRdIdx; // should be in shared memory, preferred NON cache
150 UInt8 *cb_afWrtIdx; // should be in shared memory, preferred NON cache
151 UInt8 *cb_numAfCb; // should be in shared memory, preferred NON cache
152 UInt32 cb_opCnt; // range (0 - CB_OP_COUNT_MAX)
153 #endif
154 } PAF_AST_DecOpCircBuf;
156 // Decoder output circular buffer statistics
157 typedef struct PAF_AST_DecOpCircBufStats
158 {
159 Int32 readAfWriterInactiveCnt; // count of read audio frames with inactive writer & not draining
160 Int32 readAfNdCnt; // count of read audio frames for nominal delay
161 Int32 wrtAfReaderInactiveCnt; // count of write audio frames with inactive reader
162 Int32 wrtAfZeroSampsCnt; // count of write audio frames with zero samples
163 Int32 errUndCnt; // read error underflow count
164 Int32 errOvrCnt; // write error overflow count
165 } PAF_AST_DecOpCircBufStats;
167 // Decoder output circular buffer control
168 typedef struct PAF_AST_DecOpCircBufCtl
169 {
170 GateMP_Handle gateHandle; // circular buffer gate handle
171 Int8 numDecOpCb; // number of circular buffers
172 PAF_AST_DecOpCircBuf **pXDecOpCb; // address of decoder output circular buffer base pointer
173 } PAF_AST_DecOpCircBufCtl;
175 // Initialize circular buffer control
176 Int cbCtlInit(
177 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
178 Int8 numDecOpCb, // number of circular buffers
179 PAF_AST_DecOpCircBuf **pXDecOpCb // address of decoder output circular buffer base pointer
180 );
182 // Reset circular buffer
183 Int cbReset(
184 PAF_AST_DecOpCircBufCtl *pCbCtl,
185 Int8 cbIdx
186 );
188 // Get circular buffer statistics
189 Int cbGetStats(
190 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
191 Int8 cbIdx, // decoder output circular buffer index
192 PAF_AST_DecOpCircBufStats *pCbStats // decoder output circular buffer statistics
194 );
196 // Output log of circular buffer control variables (debug)
197 Int cbLog(
198 PAF_AST_DecOpCircBufCtl *pCbCtl,
199 Int8 cbIdx,
200 Int8 fullLog,
201 char *locInfo
202 );
205 #endif /* _ASP_DECOP_CB_COMMON_H_ */