opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/include/pvamrnbdecoder_api.h

   1 /* ------------------------------------------------------------------
   2  * Copyright (C) 1998-2009 PacketVideo
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  13  * express or implied.
  14  * See the License for the specific language governing permissions
  15  * and limitations under the License.
  16  * -------------------------------------------------------------------
  17  */
  18 /****************************************************************************************
  19 Portions of this file are derived from the following 3GPP standard:
  20
  21     3GPP TS 26.073
  22     ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
  23     Available from http://www.3gpp.org
  24
  25 (C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
  26 Permission to distribute, modify and use this file under the standard license
  27 terms listed above has been obtained from the copyright holder.
  28 ****************************************************************************************/
  29 /*
  30  Name: pvamrnbdecoder_api.h
  31
  32 ------------------------------------------------------------------------------
  33  INCLUDE DESCRIPTION
  34
  35  Main header file for the Packet Video AMR Narrow  Band  decoder library. The
  36  constants, structures, and functions defined within this file, along with
  37  a basic data types header file, is all that is needed to use and communicate
  38  with the library. The internal data structures within the library are
  39  purposely hidden.
  40
  41 ------------------------------------------------------------------------------
  42  REFERENCES
  43
  44 ------------------------------------------------------------------------------
  45 */
  46
  47 /*----------------------------------------------------------------------------
  48 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  49 ----------------------------------------------------------------------------*/
  50 #ifndef _PVAMRNBDECODER_API_H
  51 #define _PVAMRNBDECODER_API_H
  52
  53 #include    "oscl_base.h"    /* Basic data types used within the lib */
  54 #include    "pvgsmamrdecoderinterface.h"
  55
  56
  57 /*----------------------------------------------------------------------------
  58 ; INCLUDES
  59 ----------------------------------------------------------------------------*/
  60 #ifdef __cplusplus
  61 extern "C"
  62 {
  63 #endif
  64
  65     /*----------------------------------------------------------------------------
  66     ; MACROS
  67     ; Define module specific macros here
  68     ----------------------------------------------------------------------------*/
  69
  70     /*----------------------------------------------------------------------------
  71     ; DEFINES
  72     ; Include all pre-processor statements here.
  73     ----------------------------------------------------------------------------*/
  74 #define MAX_NUM_FRAMES_PER_PACKET 20 /* Max number of frames per packet */
  75
  76 #define MAX_NUM_PACKED_INPUT_BYTES 32 /* Max number of packed input bytes */
  77
  78 #define L_FRAME      160
  79
  80     /*----------------------------------------------------------------------------
  81     ; EXTERNAL VARIABLES REFERENCES
  82     ; Declare variables used in this module but defined elsewhere
  83     ----------------------------------------------------------------------------*/
  84
  85     /*----------------------------------------------------------------------------
  86     ; SIMPLE TYPEDEF'S
  87     ----------------------------------------------------------------------------*/
  88
  89     /*----------------------------------------------------------------------------
  90     ; ENUMERATED TYPEDEF'S
  91     ----------------------------------------------------------------------------*/
  92
  93     /*----------------------------------------------------------------------------
  94     ; STRUCTURES TYPEDEF'S
  95     ----------------------------------------------------------------------------*/
  96
  97
  98     /*----------------------------------------------------------------------------
  99     ; GLOBAL FUNCTION DEFINITIONS
 100     ; Function Prototype declaration
 101     ----------------------------------------------------------------------------*/
 102
 103
 104
 105     /*----------------------------------------------------------------------------
 106     ; END
 107     ----------------------------------------------------------------------------*/
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112
 113
 114 #endif  /* PVMP4AUDIODECODER_API_H */
 115
 116