opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/qgain795.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: qgain795.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the file, qgain795.c
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef qgain795_h
  49 #define qgain795_h "$Id $"
  50
  51 /*----------------------------------------------------------------------------
  52 ; INCLUDES
  53 ----------------------------------------------------------------------------*/
  54 #include "typedef.h"
  55 #include "g_adapt.h"
  56 #include "get_const_tbls.h"
  57
  58 /*--------------------------------------------------------------------------*/
  59 #ifdef __cplusplus
  60 extern "C"
  61 {
  62 #endif
  63
  64     /*----------------------------------------------------------------------------
  65     ; MACROS
  66     ; Define module specific macros here
  67     ----------------------------------------------------------------------------*/
  68
  69     /*----------------------------------------------------------------------------
  70     ; DEFINES
  71     ; Include all pre-processor statements here.
  72     ----------------------------------------------------------------------------*/
  73
  74     /*----------------------------------------------------------------------------
  75     ; EXTERNAL VARIABLES REFERENCES
  76     ; Declare variables used in this module but defined elsewhere
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; SIMPLE TYPEDEF'S
  81     ----------------------------------------------------------------------------*/
  82
  83     /*----------------------------------------------------------------------------
  84     ; ENUMERATED TYPEDEF'S
  85     ----------------------------------------------------------------------------*/
  86
  87     /*----------------------------------------------------------------------------
  88     ; STRUCTURES TYPEDEF'S
  89     ----------------------------------------------------------------------------*/
  90
  91     /*----------------------------------------------------------------------------
  92     ; GLOBAL FUNCTION DEFINITIONS
  93     ; Function Prototype declaration
  94     ----------------------------------------------------------------------------*/
  95     void
  96     MR795_gain_quant(
  97         GainAdaptState *adapt_st, /* i/o: gain adapter state structure       */
  98         Word16 res[],             /* i  : LP residual,                  Q0   */
  99         Word16 exc[],             /* i  : LTP excitation (unfiltered),  Q0   */
 100         Word16 code[],            /* i  : CB innovation (unfiltered),   Q13  */
 101         Word16 frac_coeff[],      /* i  : coefficients (5),             Q15  */
 102         Word16 exp_coeff[],       /* i  : energy coefficients (5),      Q0   */
 103         /*      coefficients from calc_filt_ener() */
 104         Word16 exp_code_en,       /* i  : innovation energy (exponent), Q0   */
 105         Word16 frac_code_en,      /* i  : innovation energy (fraction), Q15  */
 106         Word16 exp_gcode0,        /* i  : predicted CB gain (exponent), Q0   */
 107         Word16 frac_gcode0,       /* i  : predicted CB gain (fraction), Q15  */
 108         Word16 L_subfr,           /* i  : Subframe length                    */
 109         Word16 cod_gain_frac,     /* i  : opt. codebook gain (fraction),Q15  */
 110         Word16 cod_gain_exp,      /* i  : opt. codebook gain (exponent), Q0  */
 111         Word16 gp_limit,          /* i  : pitch gain limit                   */
 112         Word16 *gain_pit,         /* i/o: Pitch gain (unquant/quant),   Q14  */
 113         Word16 *gain_cod,         /* o  : Code gain,                    Q1   */
 114         Word16 *qua_ener_MR122,   /* o  : quantized energy error,       Q10  */
 115         /*      (for MR122 MA predictor update)    */
 116         Word16 *qua_ener,         /* o  : quantized energy error,       Q10  */
 117         /*      (for other MA predictor update)    */
 118         Word16 **anap,            /* o  : Index of quantization              */
 119         /*      (first gain pitch, then code pitch)*/
 120         CommonAmrTbls* common_amr_tbls, /* i : ptr to struct of table ptrs   */
 121         Flag   *pOverflow         /* o  : overflow indicator                 */
 122     );
 123
 124     /*----------------------------------------------------------------------------
 125     ; END
 126     ----------------------------------------------------------------------------*/
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif /* qgain795_H_ */
 132
 133