pasdk/test_dsp/framework/aspDecOpCircBuf_master.h

   1
   2 /*
   3 Copyright (c) 2017, Texas Instruments Incorporated - http://www.ti.com/
   4 All rights reserved.
   5
   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 */
  35
  36 #ifndef _ASP_DECOP_CB_MASTER_H_
  37 #define _ASP_DECOP_CB_MASTER_H_
  38
  39 #include <xdc/std.h>
  40 #include "paftyp.h"
  41 #include "aspDecOpCircBuf_common.h"
  42
  43 #define ASP_DECOP_CB_AF_READ_UNDERFLOW      ( ASP_DECOP_CB_ERR_START-1 )    // error: read AF underflow
  44 #define ASP_DECOP_CB_PCM_READ_UNDERFLOW     ( ASP_DECOP_CB_ERR_START-2 )    // error: read PCM underflow
  45 #define ASP_DECOP_CB_READ_INVSTATE          ( ASP_DECOP_CB_ERR_START-3 )    // error: circular buffer invalid state on read
  46
  47 #define ASP_DECOP_CHECK_DRAINSTATE_ALL      ( -1 )                          // check circular buffer combined drain state
  48
  49 #define DEF_STR_FRAME_LEN                   ( PAF_SYS_FRAMELENGTH )         // default stream frame length
  50
  51 // Initialize circular buffer
  52 Int cbInit(
  53     PAF_AST_DecOpCircBuf *pCb
  54 );
  55
  56 #if 0 // FL: moved to ARM
  57 // Initialize circular buffer for selected source
  58 Int cbInitSourceSel(
  59     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  60     Int8 cbIdx,                         // decoder output circular buffer index
  61     Int8 sourceSelect,                  // source select (PCM, DDP, etc.)
  62     Int16 decOpFrameLen,                // decoder output frame length (PCM samples)
  63     Int16 strFrameLen,                  // stream frame length (PCM samples)
  64     Int8 resetRwFlags                   // whether to reset reader, writer, and drain flags
  65 );
  66 #endif
  67
  68 // Initialize circular buffer for Stream reads
  69 Int cbInitStreamRead(
  70     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  71     Int8 cbIdx                          // decoder output circular buffer index
  72 );
  73
  74 // Start reads from circular buffer
  75 Int cbReadStart(
  76     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  77     Int8 cbIdx                          // decoder output circular buffer index
  78 );
  79
  80 // Stop reads from circular buffer
  81 Int cbReadStop(
  82     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  83     Int8 cbIdx                          // decoder output circular buffer index
  84 );
  85
  86 // Read audio frame from circular buffer
  87 Int cbReadAf(
  88     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  89     Int8 cbIdx,                         // decoder output circular buffer index
  90     PAF_AudioFrame *pAfRd               // audio frame into which to read
  91 );
  92
  93 // Read CB stream frame length
  94 Int cbReadStrFrameLen(
  95     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  96     Int8 cbIdx,                         // decoder output circular buffer index, or indicator combined drain state desired
  97     Int16 *pStrFrameLen                 // stream frame length
  98 );
  99
 100 // Check circular buffer drain state
 101 Int cbCheckDrainState(
 102     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
 103     Int8 cbIdx,                         // decoder output circular buffer index, or indicator combined drain state desired
 104     Int8 *pDrainedFlag                  // output drain state indicator (combined or for selected circular buffer)
 105 );
 106
 107
 108 #endif /* _ASP_DECOP_CB_MASTER_H_ */