opencore/codecs_v2/audio/gsm_amr/amr_nb/dec/src/d_gain_p.cpp

   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: d_gain_p.cpp
  35  Functions: d_gain_p
  36
  37  ------------------------------------------------------------------------------
  38  INPUT AND OUTPUT DEFINITIONS
  39
  40  Inputs:
  41     mode  -- enumerated type -- AMR mode
  42     index -- Word16          -- index of quantization
  43  Outputs:
  44     None
  45
  46  Returns:
  47     Word16 gain -- (Q14)
  48
  49  Global Variables Used:
  50     None
  51
  52  Local Variables Needed:
  53     None
  54
  55 ------------------------------------------------------------------------------
  56  FUNCTION DESCRIPTION
  57
  58  Function    : d_gain_pitch
  59  Purpose     : Decodes the pitch gain using the received index.
  60                output is in Q14
  61
  62 ------------------------------------------------------------------------------
  63  REQUIREMENTS
  64
  65
  66
  67 ------------------------------------------------------------------------------
  68  REFERENCES
  69
  70  d_gain_p.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001
  71
  72 ------------------------------------------------------------------------------
  73  PSEUDO-CODE
  74
  75
  76
  77 ------------------------------------------------------------------------------
  78 */
  79
  80
  81 /*----------------------------------------------------------------------------
  82 ; INCLUDES
  83 ----------------------------------------------------------------------------*/
  84 #include "d_gain_p.h"
  85 #include "typedef.h"
  86 #include "mode.h"
  87
  88 /*--------------------------------------------------------------------------*/
  89 #ifdef __cplusplus
  90 extern "C"
  91 {
  92 #endif
  93
  94     /*----------------------------------------------------------------------------
  95     ; MACROS
  96     ; Define module specific macros here
  97     ----------------------------------------------------------------------------*/
  98
  99
 100     /*----------------------------------------------------------------------------
 101     ; DEFINES
 102     ; Include all pre-processor statements here. Include conditional
 103     ; compile variables also.
 104     ----------------------------------------------------------------------------*/
 105
 106     /*----------------------------------------------------------------------------
 107     ; LOCAL FUNCTION DEFINITIONS
 108     ; Function Prototype declaration
 109     ----------------------------------------------------------------------------*/
 110
 111
 112     /*----------------------------------------------------------------------------
 113     ; LOCAL STORE/BUFFER/POINTER DEFINITIONS
 114     ; Variable declaration - defined here and used outside this module
 115     ----------------------------------------------------------------------------*/
 116
 117     /*----------------------------------------------------------------------------
 118     ; EXTERNAL FUNCTION REFERENCES
 119     ; Declare functions defined elsewhere and referenced in this module
 120     ----------------------------------------------------------------------------*/
 121
 122     /*----------------------------------------------------------------------------
 123     ; EXTERNAL GLOBAL STORE/BUFFER/POINTER REFERENCES
 124     ; Declare variables used in this module but defined elsewhere
 125     ----------------------------------------------------------------------------*/
 126
 127     /*--------------------------------------------------------------------------*/
 128 #ifdef __cplusplus
 129 }
 130 #endif
 131
 132 /*----------------------------------------------------------------------------
 133 ; FUNCTION CODE
 134 ----------------------------------------------------------------------------*/
 135
 136 Word16 d_gain_pitch(       /* return value: gain (Q14)                */
 137     enum Mode mode,        /* i   : AMR mode                          */
 138     Word16 index,          /* i   : index of quantization             */
 139     const Word16* qua_gain_pitch_ptr /* i : pointer to read-only tables   */
 140 )
 141 {
 142     Word16 gain;
 143
 144     gain = qua_gain_pitch_ptr[index];
 145
 146     if (mode == MR122)
 147     {
 148         /* clear 2 LSBits */
 149         gain &= 0xFFFC;
 150     }
 151
 152     return gain;
 153 }