processor_audio_sdk_1_00_00_00/pasdk/test_dsp/framework/aspDecOpCircBuf_master.h

   1
   2 /*
   3 Copyright (c) 2016, 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_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
  46
  47
  48 // Initialize circular buffer
  49 Int cbInit(
  50     PAF_AST_DecOpCircBuf *pCb
  51 );
  52
  53 // Initialize circular buffer for selected source
  54 Int cbInitSoureSel(
  55     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  56     Int8 cbIdx,                         // decoder output circular buffer index
  57     Int8 sourceSelect,                  // source select (PCM, DDP, etc.)
  58     Int16 decOpFrameLen,                // decoder output frame length (PCM samples)
  59     Int16 strFrameLen,                  // stream frame length (PCM samples)
  60     Int8 resetRwFlags                   // whether to reset reader, writer, and empty flags
  61 );
  62
  63 // Start reads from circular buffer
  64 Int cbReadStart(
  65     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  66     Int8 cbIdx                          // decoder output circular buffer index
  67 );
  68
  69 // Stop reads from circular buffer
  70 Int cbReadStop(
  71     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  72     Int8 cbIdx                          // decoder output circular buffer index
  73 );
  74
  75 // Read audio frame from circular buffer
  76 Int cbReadAf(
  77     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  78     Int8 cbIdx,                         // decoder output circular buffer index
  79     PAF_AudioFrame *pAfRd               // audio frame into which to read
  80 );
  81
  82 // Write audio frame to circular buffer
  83 Int cbWriteAf(
  84     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  85     Int8 cbIdx,                         // decoder output circular buffer index
  86     PAF_AudioFrame *pAfWrt              // audio frame from which to write
  87 );
  88
  89 #endif /* _ASP_DECOP_CB_MASTER_H_ */