Add shared state for ASIT/ASOT. Add Decoder CB output control.
[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / pasdk / common / aspDecOpCircBuf_common.h
2 /*
3 Copyright (c) 2016, 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"
43 #define ASP_DECOP_CB_SOK                    (  0 )      // ok
45 #define ASP_DECOP_CB_MAX_NUM_AF             ( 4 )       // decoder output circular buffer maximum number audio frames
46 #define ASP_DECOP_CB_MAX_NUM_PCM_CH         ( 16 )      // decoder output circular buffer maximum number audio PCM channels
47 #define ASP_DECOP_CB_MAX_NUM_PCM_FRAMES     ( 2 )       // decoder output circular buffer maximum number PCM frames //Qin - Increased to prevent cb overflow for ddp.
48 #define ASP_DECOP_CB_MAX_PCM_FRAME_LEN      ( 6*256 )   // decoder output circular buffer maximum PCM frame length
49 #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 )
52 // Decoder output circular buffer
53 typedef struct PAF_AST_DecOpCircBuf 
54 {
55     PAF_AudioFrame *afCb;   // audio frame CB
56     PAF_AudioData *pcmBuf;  // PCM buffer, contains PCM data associated with audio frames
57     UInt8 *metaBuf;         // metadata buffer, contains metadata associated with audio frames //QIN
58     Int8 afRdIdx;           // audio frame CB read index
59     Int8 afWrtIdx;          // audio frame CB write index
60     Int16 pcmRdIdx;         // pcm buffer read index
61     Int8 numAfCb;           // current number frames in CB
62     Int8 maxNumAfCb;        // maximum number of audio frames in CB
63     Int16 decOpFrameLen;    // selected decoder output frame length (input transaction size)
64     Int16 strFrameLen;      // stream frame length (output transaction size)
65     Int8 writerActiveFlag;  // flag indicates whether CB writer is active
66     Int8 readerActiveFlag;  // flag indicates whether CB reader is active
67     Int8 emptyFlag;         // flag indicates whether reader should empty (drain) remaining frames in CB
68     Int8 errUndCnt;         // underflow count
69     Int8 errOvrCnt;         // overflow count
70 } PAF_AST_DecOpCircBuf;
72 // Decoder output circular buffer control
73 typedef struct PAF_AST_DecOpCircBufCtrl
74 {
75     GateMP_Handle *gateHandle;      // circular buffer gate handle
76     PAF_AST_DecOpCircBuf *xDecOpCb; // circular buffer base pointer
77 } PAF_AST_DecOpCircBufCtrl;
79 // Output log of circular buffer control variables (debug)
80 Int cbLog(
81     PAF_AST_DecOpCircBuf *pCb,
82     Int8 fullLog, 
83     char *locInfo
84 );
86 #endif /* _ASP_DECOP_CB_COMMON_H_ */