opencore/codecs_v2/audio/gsm_amr/amr_nb/common/include/d_gain_p.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 *      GSM AMR-NB speech codec   R98   Version 7.5.0   March 2, 2001
  33 *                                R99   Version 3.2.0
  34 *                                REL-4 Version 4.0.0
  35 *
  36 ********************************************************************************
  37 *
  38 *      File             : d_gain_p.h
  39 *      Purpose          : Decodes the pitch gain using the received index.
  40 *
  41 ********************************************************************************
  42 */
  43 #ifndef d_gain_p_h
  44 #define d_gain_p_h "$Id $"
  45
  46 /*
  47 ********************************************************************************
  48 *                         INCLUDE FILES
  49 ********************************************************************************
  50 */
  51 #include "typedef.h"
  52 #include "mode.h"
  53
  54 #ifdef __cplusplus
  55 extern "C"
  56 {
  57 #endif
  58
  59     /*
  60     **************************************************************************
  61     *
  62     *  Function    : d_gain_pitch
  63     *  Purpose     : Decodes the pitch gain using the received index.
  64     *  Description : In case of no frame erasure, the gain is obtained
  65     *                from the quantization table at the given index;
  66     *                otherwise, a downscaled past gain is used.
  67     *  Returns     : Quantized pitch gain
  68     *
  69     **************************************************************************
  70     */
  71     Word16 d_gain_pitch(       /* return value: gain (Q14)                */
  72         enum Mode mode,        /* i : AMR mode                            */
  73         Word16 index,          /* i   : index of quantization             */
  74         const Word16* qua_gain_pitch_ptr /* i : pointer to read-only tables   */
  75     );
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif