56d15396aa465b5ea229270e2d53b07d9072ccfb
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_MASTER_H_
37 #define _ASP_DECOP_CB_MASTER_H_
39 #include <xdc/std.h>
40 #include "paftyp.h"
41 #include "aspDecOpCircBuf_common.h"
43 #define ASP_DECOP_CB_READ_UNDERFLOW ( ASP_DECOP_CB_ERR_START-1 ) // error: read underflow
44 #define ASP_DECOP_CB_READ_INVSTATE ( ASP_DECOP_CB_ERR_START-2 ) // error: circular buffer invalid state on read
46 #define ASP_DECOP_CHECK_DRAINSTATE_ALL ( -1 ) // check circular buffer combined drain state
49 // Initialize circular buffer
50 Int cbInit(
51 PAF_AST_DecOpCircBuf *pCb
52 );
54 #if 0 // FL: moved to ARM
55 // Initialize circular buffer for selected source
56 Int cbInitSourceSel(
57 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
58 Int8 cbIdx, // decoder output circular buffer index
59 Int8 sourceSelect, // source select (PCM, DDP, etc.)
60 Int16 decOpFrameLen, // decoder output frame length (PCM samples)
61 Int16 strFrameLen, // stream frame length (PCM samples)
62 Int8 resetRwFlags // whether to reset reader, writer, and drain flags
63 );
64 #endif
66 // Start reads from circular buffer
67 Int cbReadStart(
68 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
69 Int8 cbIdx // decoder output circular buffer index
70 );
72 // Stop reads from circular buffer
73 Int cbReadStop(
74 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
75 Int8 cbIdx // decoder output circular buffer index
76 );
78 // Read audio frame from circular buffer
79 Int cbReadAf(
80 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
81 Int8 cbIdx, // decoder output circular buffer index
82 PAF_AudioFrame *pAfRd // audio frame into which to read
83 );
85 // Check circular buffer drain state
86 Int cbCheckDrainState(
87 PAF_AST_DecOpCircBufCtl *pCbCtl, // decoder output circular buffer control
88 Int8 cbIdx, // decoder output circular buffer index, or indicator combined drain state desired
89 Int8 *pDrainedFlag // output drain state indicator (combined or for selected circular buffer)
90 );
93 #endif /* _ASP_DECOP_CB_MASTER_H_ */