pasrc/test_arm/framework/aspDecOpCircBuf_slave.h

   1
   2 /*
   3 Copyright (c) 2018, 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_SLAVE_H_
  37 #define _ASP_DECOP_CB_SLAVE_H_
  38
  39 #include <xdc/std.h>
  40 #include "paftyp.h"
  41 #include "aspDecOpCircBuf_common.h"
  42
  43 #include "dbgBenchmark.h" // PCM high-sampling rate + SRC + CAR benchmarking
  44
  45 #define ASP_DECOP_CB_INIT_INV_SOURCE_SEL    ( ASP_DECOP_CB_ERR_START-1 )    // error: invalid source selection on init
  46 #define ASP_DECOP_CB_AF_WRITE_OVERFLOW      ( ASP_DECOP_CB_ERR_START-2 )    // error: write audio frame overflow
  47 #define ASP_DECOP_CB_PCM_WRITE_OVERFLOW     ( ASP_DECOP_CB_ERR_START-3 )    // error: write PCM overflow
  48
  49 #define DEF_DEC_OP_FRAME_LEN                ( PAF_SYS_FRAMELENGTH )         // default decoder output frame length
  50
  51 // Initialize circular buffer for Decoder writes
  52 Int cbInitDecWrite(
  53     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  54     Int8 cbIdx,                         // decoder output circular buffer index
  55     Int8 sourceSelect,                  // source select (PCM, DDP, etc.)
  56     Int16 decOpFrameLen,                // decoder output frame length (PCM samples)
  57     Int8 resetRwFlags,                  // whether to reset reader, writer, and drain flags
  58     PAF_AudioFrame *pDecInitAf          // pointer to Dec output audio frame used for CB initialization
  59 );
  60
  61 // Start writes to circular buffer
  62 Int cbWriteStart(
  63     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  64     Int8 cbIdx                          // decoder output circular buffer index
  65 );
  66
  67 // Stop writes to circular buffer
  68 Int cbWriteStop(
  69     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  70     Int8 cbIdx                          // decoder output circular buffer index
  71 );
  72
  73 // Write audio frame to circular buffer
  74 Int cbWriteAf(
  75     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  76     Int8 cbIdx,                         // decoder output circular buffer index
  77     PAF_AudioFrame *pAfWrt              // audio frame from which to write
  78 );
  79
  80 #if 0
  81 // Get next audio frame to write in circular buffer
  82 Int cbGetNextWriteAf(
  83     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  84     Int8 cbIdx,                         // decoder output circular buffer index
  85     PAF_AudioFrame **ppAfWrt            // audio frame next to be written
  86 );
  87 #endif
  88
  89 #endif /* _ASP_DECOP_CB_SLAVE_H_ */