opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/amrdecode.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 ------------------------------------------------------------------------------
  31
  32
  33
  34  Filename: amrdecode.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the norm_s function.
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef ARMDECODE_H
  49 #define ARMDECODE_H
  50
  51 /*----------------------------------------------------------------------------
  52 ; INCLUDES
  53 ----------------------------------------------------------------------------*/
  54 #include    "typedef.h"
  55 #include    "mode.h"
  56 #include    "frame_type_3gpp.h"
  57 #include    "pvamrnbdecoder_api.h"
  58
  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 NUM_AMRSID_RXMODE_BITS   3
  75 #define AMRSID_RXMODE_BIT_OFFSET 36
  76 #define AMRSID_RXTYPE_BIT_OFFSET 35
  77
  78     /*----------------------------------------------------------------------------
  79     ; EXTERNAL VARIABLES REFERENCES
  80     ; Declare variables used in this module but defined elsewhere
  81     ----------------------------------------------------------------------------*/
  82     extern const Word16 WmfDecBytesPerFrame[];
  83     extern const Word16 If2DecBytesPerFrame[];
  84
  85     /*----------------------------------------------------------------------------
  86     ; SIMPLE TYPEDEF'S
  87     ----------------------------------------------------------------------------*/
  88
  89     /*----------------------------------------------------------------------------
  90     ; ENUMERATED TYPEDEF'S
  91     ----------------------------------------------------------------------------*/
  92
  93     /*----------------------------------------------------------------------------
  94     ; STRUCTURES TYPEDEF'S
  95     ----------------------------------------------------------------------------*/
  96
  97     /*----------------------------------------------------------------------------
  98     ; GLOBAL FUNCTION DEFINITIONS
  99     ; Function Prototype declaration
 100     ----------------------------------------------------------------------------*/
 101
 102     Word16 AMRDecode(
 103         void *state_data,
 104         enum Frame_Type_3GPP  frame_type,
 105         UWord8 *speech_bits_ptr,
 106         Word16 *raw_pcm_buffer,
 107         bitstream_format input_format
 108     );
 109
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114 #endif  /* _AMRDECODE_H_ */