processor_audio_sdk_1_00_00_00/pasdk/test_arm/framework/aspDecOpCircBuf_slave.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_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 #define ASP_DECOP_CB_WRITE_OVERFLOW         ( ASP_DECOP_CB_ERR_START-1 ) // error: write overflow
  44
  45 // Start writes to circular buffer
  46 Int cbWriteStart(
  47     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  48     Int8 cbIdx                          // decoder output circular buffer index
  49 );
  50
  51 // Stop writes to circular buffer
  52 Int cbWriteStop(
  53     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  54     Int8 cbIdx                          // decoder output circular buffer index
  55 );
  56
  57 // Write audio frame to circular buffer
  58 Int cbWriteAf(
  59     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  60     Int8 cbIdx,                         // decoder output circular buffer index
  61     PAF_AudioFrame *pAfWrt              // audio frame from which to write
  62 );
  63
  64 // Get next audio frame to write in circular buffer
  65 Int cbGetNextWriteAf(
  66     PAF_AST_DecOpCircBufCtl *pCbCtl,    // decoder output circular buffer control
  67     Int8 cbIdx,                         // decoder output circular buffer index
  68     PAF_AudioFrame **ppAfWrt            // audio frame next to be written
  69 );
  70
  71 #endif /* _ASP_DECOP_CB_SLAVE_H_ */