opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/dec_gain.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: dec_gain.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39       File             : dec_gain.h
  40       Purpose          : Decode the pitch and codebook gains
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 #ifndef _DEC_GAIN_H_
  46 #define _DEC_GAIN_H_
  47 #define dec_gain_h "$Id $"
  48
  49 /*----------------------------------------------------------------------------
  50 ; INCLUDES
  51 ----------------------------------------------------------------------------*/
  52 #include "typedef.h"
  53 #include "gc_pred.h"
  54 #include "mode.h"
  55 #include "get_const_tbls.h"
  56
  57 /*--------------------------------------------------------------------------*/
  58 #ifdef __cplusplus
  59 extern "C"
  60 {
  61 #endif
  62
  63     /*----------------------------------------------------------------------------
  64     ; MACROS
  65     ; [Define module specific macros here]
  66     ----------------------------------------------------------------------------*/
  67
  68     /*----------------------------------------------------------------------------
  69     ; DEFINES
  70     ; [Include all pre-processor statements here.]
  71     ----------------------------------------------------------------------------*/
  72
  73     /*----------------------------------------------------------------------------
  74     ; EXTERNAL VARIABLES REFERENCES
  75     ; [Declare variables used in this module but defined elsewhere]
  76     ----------------------------------------------------------------------------*/
  77
  78     /*----------------------------------------------------------------------------
  79     ; SIMPLE TYPEDEF'S
  80     ----------------------------------------------------------------------------*/
  81
  82     /*----------------------------------------------------------------------------
  83     ; ENUMERATED TYPEDEF'S
  84     ----------------------------------------------------------------------------*/
  85
  86     /*----------------------------------------------------------------------------
  87     ; STRUCTURES TYPEDEF'S
  88     ----------------------------------------------------------------------------*/
  89
  90     /*----------------------------------------------------------------------------
  91     ; GLOBAL FUNCTION DEFINITIONS
  92     ; [List function prototypes here]
  93     ----------------------------------------------------------------------------*/
  94
  95     /*
  96      *   FUNCTION:  Dec_gain()
  97      *   PURPOSE: Decode the pitch and codebook gains
  98      */
  99     void Dec_gain(
 100         gc_predState *pred_state, /* i/o: MA predictor state           */
 101         enum Mode mode,           /* i  : AMR mode                     */
 102         Word16 index,             /* i  : index of quantization.       */
 103         Word16 code[],            /* i  : Innovative vector.           */
 104         Word16 evenSubfr,         /* i  : Flag for even subframes      */
 105         Word16 * gain_pit,        /* o  : Pitch gain.                  */
 106         Word16 * gain_cod,        /* o  : Code gain.                   */
 107         CommonAmrTbls* common_amr_tbls, /* i : ptr to struct of tbls ptrs */
 108         Flag   * pOverflow
 109     );
 110
 111
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117 #endif  /* _DEC_GAIN_H_ */
 118
 119
 120