Add GateMP for Decoder Output Circular Buffer
[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / pasdk / test_dsp / framework / aspDecOpCircBuf_master.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_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_INIT_INV_SOURCE_SEL    ( ASP_DECOP_CB_ERR_START-1 )  // error: invalid source selection on init
44 #define ASP_DECOP_CB_READ_UNDERFLOW         ( ASP_DECOP_CB_ERR_START-2 )  // error: read underflow
45 #define ASP_DECOP_CB_READ_INVSTATE          ( ASP_DECOP_CB_ERR_START-3 )  // error: circular buffer invalid state on read
48 // Initialize circular buffer
49 Int cbInit(
50     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
51     Int8 cbIdx,                         // decoder output circular buffer index
52     Int8 sourceSelect,                  // source select (PCM, DDP, etc.)
53     Int16 decOpFrameLen,                // decoder output frame length (PCM samples)
54     Int16 strFrameLen,                  // stream frame length (PCM samples)
55     Int8 resetRwFlags                   // whether to reset reader, writer, and empty flags
56 );
58 // Start reads from circular buffer
59 Int cbReadStart(
60     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
61     Int8 cbIdx                          // decoder output circular buffer index
62 );
64 // Stop reads from circular buffer
65 Int cbReadStop(
66     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
67     Int8 cbIdx                          // decoder output circular buffer index
68 );
70 // Read audio frame from circular buffer
71 Int cbReadAf(
72     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
73     Int8 cbIdx,                         // decoder output circular buffer index
74     PAF_AudioFrame *pAfRd               // audio frame into which to read
75 );
77 // Write audio frame to circular buffer
78 Int cbWriteAf(
79     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
80     Int8 cbIdx,                         // decoder output circular buffer index
81     PAF_AudioFrame *pAfWrt              // audio frame from which to write
82 );
84 #endif /* _ASP_DECOP_CB_MASTER_H_ */