74e570a2021e3861f7fb4072e554bf4a0da8de2a
[processor-sdk/performance-audio-sr.git] / pasdk / common / aspDecOpCircBuf_common.c
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 #include <string.h> // for memset()
37 #include <xdc/std.h>
38 #include <xdc/runtime/Log.h>
39 #include <ti/sysbios/hal/Cache.h>
40 #include <ti/ipc/GateMP.h>
42 #include "aspDecOpCircBuf_common.h"
44 // Initialize circular buffer control
45 Int cbCtlInit(
46     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
47     Int8 numDecOpCb,                    // number of circular buffers
48     PAF_AST_DecOpCircBuf **pXDecOpCb    // address of decoder output circular buffer base pointer
49 )
50 {
51 #ifdef _TMS320C6X
52     GateMP_Params gateParams;
53     GateMP_Handle gateHandle;
54     
55     GateMP_Params_init(&gateParams);
56     gateParams.localProtect = GateMP_LocalProtect_THREAD;
57     gateParams.remoteProtect = GateMP_RemoteProtect_SYSTEM;
58     gateParams.name = ASP_DECODE_CB_GATE_NAME;
59     gateParams.regionId = ASP_DECODE_CB_GATE_REGION_ID;
60     gateHandle = GateMP_create(&gateParams);
61     if (gateHandle != NULL)
62     {
63         pCbCtl->gateHandle = gateHandle;
64     }
65     else
66     {
67         pCbCtl->gateHandle = NULL;
68         return ASP_DECOP_CB_CTL_INIT_INV_GATE;
69     }
70     
71     pCbCtl->numDecOpCb = numDecOpCb;    // init number of circular buffers
72     pCbCtl->pXDecOpCb = pXDecOpCb;      // init base address of circular buffers
73     
74     return ASP_DECOP_CB_SOK;    
76 #elif defined(ARMCOMPILE)
77     GateMP_Handle gateHandle;
78     Int status;
79     
80     do {
81         status = GateMP_open(ASP_DECODE_CB_GATE_NAME, &gateHandle);
82     } while (status == GateMP_E_NOTFOUND);
83     if (status == GateMP_S_SUCCESS)
84     {
85         pCbCtl->gateHandle = gateHandle;
86     }
87     else
88     {
89         pCbCtl->gateHandle = NULL;
90         return ASP_DECOP_CB_CTL_INIT_INV_GATE;
91     }
92     
93     pCbCtl->numDecOpCb = numDecOpCb;    // init number of circular buffers
94     pCbCtl->pXDecOpCb = pXDecOpCb;      // init base address of circular buffers
95     
96     return ASP_DECOP_CB_SOK;
98 #else
99     #error "Unsupported platform"
101 #endif
104 // Reset circular buffer
105 Int cbReset(
106     PAF_AST_DecOpCircBufCtl *pCbCtl,
107     Int8 cbIdx
110     IArg key;
111     GateMP_Handle gateHandle;
112     PAF_AST_DecOpCircBuf *pCb;
113     PAF_AudioFrame *pAfCb;
114     Int8 n;
115     Int8 i;
117     // Get gate handle
118     gateHandle = pCbCtl->gateHandle;
119     // Enter gate
120     key = GateMP_enter(gateHandle);
122     // Get circular buffer base pointer
123     pCb = &((*pCbCtl->pXDecOpCb)[cbIdx]);
124     
125     // Invalidate circular buffer configuration
126     Cache_inv(pCb, sizeof(PAF_AST_DecOpCircBuf), Cache_Type_ALLD, 0);
127     Cache_wait();
129     // Initialize CB primed flag
130     pCb->primedFlag = 0;
131     // Initialize delta samples
132     pCb->deltaSamps = 0;
133     
134     // Reset circular buffer:
135     //  - AF write, read indices
136     if (pCb->sourceSel == PAF_SOURCE_PCM)
137     {
138         pCb->afWrtIdx = ASP_DECOP_CB_INIT_WRTIDX_PCM;
139         pCb->afRdIdx = ASP_DECOP_CB_INIT_RDIDX_PCM;
140     }
141     else if (pCb->sourceSel == PAF_SOURCE_DDP)
142     {
143         pCb->afWrtIdx = ASP_DECOP_CB_INIT_WRTIDX_DDP;
144         pCb->afRdIdx = ASP_DECOP_CB_INIT_RDIDX_DDP;
145     }
146     else if (pCb->sourceSel == PAF_SOURCE_THD)
147     {
148         pCb->afWrtIdx = ASP_DECOP_CB_INIT_WRTIDX_THD;
149         pCb->afRdIdx = ASP_DECOP_CB_INIT_RDIDX_THD;
150     }
151     else if ((pCb->sourceSel == PAF_SOURCE_DTS)   ||
152              (pCb->sourceSel == PAF_SOURCE_DTSHD) ||
153              (pCb->sourceSel == PAF_SOURCE_DTS12) ||
154              (pCb->sourceSel == PAF_SOURCE_DTS13) ||
155              (pCb->sourceSel == PAF_SOURCE_DTS14) ||
156              (pCb->sourceSel == PAF_SOURCE_DTS16) ||
157              (pCb->sourceSel == PAF_SOURCE_DTSALL)
158             )
159     {
161         pCb->afWrtIdx = ASP_DECOP_CB_INIT_WRTIDX_DTS;
162         pCb->afRdIdx = ASP_DECOP_CB_INIT_RDIDX_DTS;
163         pCb->pcmRdIdx = pCb->decOpFrameLen - ASP_DECOP_CB_INIT_LAG_DTS*pCb->strFrameLen;
164     }
165     else
166     {
167         //
168         // Currently unsupported source select
169         //
170         return ASP_DECOP_CB_RESET_INV_SOURCE_SEL;
171     }
172         
173     // Reset circular buffer:
174     //  - PCM read index
175     //  - Private metadata read index
176     //  - number of PCM samples in CB
177     pCb->pcmRdIdx = 0;
178     pCb->prvMdRdIdx = 0;
179     pCb->numPcmSampsPerCh = 0;
181     // initialize circular buffer current number of frames
182     pCb->numAfCb = pCb->afWrtIdx - pCb->afRdIdx;
184     for (n=0; n<pCb->maxNumAfCb; n++)
185     {
186         pAfCb = &pCb->afCb[n];
187         
188         // Clear PCM data
189         for (i=0; i<pCb->maxAFChanNum; i++)
190         {
191             memset(pAfCb->data.sample[i], 0, pCb->maxAFSampCount);
192             pAfCb->data.samsiz[i] = 0;
193         }
194         
195         // Clear metadata
196         pAfCb->bsMetadata_type     = PAF_bsMetadata_none;           /* non zero if metadata is attached. */
197         pAfCb->pafBsMetadataUpdate = 0;                             /* indicates whether bit-stream metadata update */
198         pAfCb->numPrivateMetadata  = 0;                             /* number of valid private metadata (0 or 1 if metadata filtering enabled) */
199         pAfCb->bsMetadata_offset   = 0;                             /* offset into audio frame for change in bsMetadata_type field */
200         for (i=0; i<PAF_MAX_NUM_PRIVATE_MD; i++)
201         {
202             pAfCb->pafPrivateMetadata[i].offset = 0; 
203             pAfCb->pafPrivateMetadata[i].size   = 0;
204         }
205     }
206     
207     // reset stats
208     pCb->readAfWriterInactiveCnt = 0;
209     pCb->readAfNdCnt = 0;
210     pCb->wrtAfReaderInactiveCnt = 0;
211     pCb->wrtAfZeroSampsCnt = 0;
212     pCb->errAfUndCnt = 0;
213     pCb->errAfOvrCnt = 0;
214     pCb->errPcmUndCnt = 0;
215     pCb->errPcmOvrCnt = 0;
217     // Write back circular buffer configuration
218     Cache_wb(pCb, sizeof(PAF_AST_DecOpCircBuf), Cache_Type_ALLD, 0);
220     // Write back AF circular buffer
221     Cache_wb(pCb->afCb, pCb->maxNumAfCb*sizeof(PAF_AudioFrame), Cache_Type_ALLD, 0);
222     for (n=0; n<pCb->maxNumAfCb; n++)
223     {
224         pAfCb = &pCb->afCb[n];
225         for (i=0; i<pCb->maxAFChanNum; i++)
226         {
227             Cache_wb(pAfCb->data.sample[i], pCb->maxAFSampCount*sizeof(PAF_AudioData), Cache_Type_ALLD, 0);
228         }
229     }
230     Cache_wait();
232     // Leave the gate
233     GateMP_leave(gateHandle, key);
235     return ASP_DECOP_CB_SOK;
238 // Get circular buffer statistics
239 Int cbGetStats(
240     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
241     Int8 cbIdx,                         // decoder output circular buffer index
242     PAF_AST_DecOpCircBufStats *pCbStats // decoder output circular buffer statistics
243     
246     IArg key;
247     GateMP_Handle gateHandle;
248     PAF_AST_DecOpCircBuf *pCb;
249     
250     // Get gate handle
251     gateHandle = pCbCtl->gateHandle;
252     // Enter gate
253     key = GateMP_enter(gateHandle);
254     
255     // Get circular buffer base pointer
256     pCb = &(*pCbCtl->pXDecOpCb)[cbIdx];
258     // Invalidate circular buffer configuration.
259     Cache_inv(pCb, sizeof(PAF_AST_DecOpCircBuf), Cache_Type_ALLD, 0);
260     Cache_wait();
262     // Populate statistics
263     pCbStats->readAfWriterInactiveCnt = pCb->readAfWriterInactiveCnt;
264     pCbStats->readAfNdCnt = pCb->readAfNdCnt;
265     pCbStats->wrtAfReaderInactiveCnt = pCb->wrtAfReaderInactiveCnt;
266     pCbStats->wrtAfZeroSampsCnt = pCb->wrtAfZeroSampsCnt;
267     pCbStats->errAfUndCnt = pCb->errAfUndCnt;
268     pCbStats->errAfOvrCnt = pCb->errAfOvrCnt;
269     pCbStats->errPcmUndCnt = pCb->errPcmUndCnt;
270     pCbStats->errPcmOvrCnt = pCb->errPcmOvrCnt;
271     
272     // Leave the gate
273     GateMP_leave(gateHandle, key);
274     
275     return ASP_DECOP_CB_SOK;
279 // Output log of circular buffer control variables (debug)
280 Int cbLog(
281     PAF_AST_DecOpCircBufCtl *pCbCtl,
282     Int8 cbIdx, 
283     Int8 fullLog, 
284     char *locInfo
287     IArg key;
288     GateMP_Handle gateHandle;
289     PAF_AST_DecOpCircBuf *pCb;
290     
291     // Get gate handle
292     gateHandle = pCbCtl->gateHandle;
293     // Enter gate
294     key = GateMP_enter(gateHandle);
295     
296     // Get circular buffer base pointer
297     pCb = &(*pCbCtl->pXDecOpCb)[cbIdx];
298     
299     // Invalidate circular buffer configuration.
300     Cache_inv(pCb, sizeof(PAF_AST_DecOpCircBuf), Cache_Type_ALLD, 0);
301     Cache_wait();
303     Log_info1("CB: %s", (IArg)locInfo);
304     Log_info3("CB: readerActiveFlag=%d, writerActiveFlag=%d, drainFlag=%d", pCb->readerActiveFlag, pCb->writerActiveFlag, pCb->drainFlag);
305     Log_info5("CB: afRdIdx=%d, pcmRdIdx=%d, prvMdRdIdx=%d, afWrtIdx=%d, numAfCb=%d", pCb->afRdIdx, pCb->pcmRdIdx, pCb->prvMdRdIdx, pCb->afWrtIdx, pCb->numAfCb);
306     if (fullLog)
307     {
308         Log_info1("CB: maxNumAfCb=%d", pCb->maxNumAfCb);  
309         Log_info2("CB: decOpFrameLen=%d, strFrameLen=%d", pCb->decOpFrameLen, pCb->strFrameLen);
310         //Log_info1("cbWriteInit=%d", pCb->cbWriteAfInit);
311     }
313     // Leave the gate
314     GateMP_leave(gateHandle, key);
315     
316     return ASP_DECOP_CB_SOK;