opencore/codecs_v2/audio/gsm_amr/amr_nb/common/include/qua_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  Filename: qua_gain.h
  32
  33 ------------------------------------------------------------------------------
  34  INCLUDE DESCRIPTION
  35
  36  This file contains all the constant definitions and prototype definitions
  37  needed by the file, qua_gain.c
  38
  39 ------------------------------------------------------------------------------
  40 */
  41
  42 /*----------------------------------------------------------------------------
  43 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  44 ----------------------------------------------------------------------------*/
  45 #ifndef qua_gain_h
  46 #define qua_gain_h "$Id $"
  47
  48 /*----------------------------------------------------------------------------
  49 ; INCLUDES
  50 ----------------------------------------------------------------------------*/
  51 #include "typedef.h"
  52 #include "gc_pred.h"
  53 #include "mode.h"
  54 #include "get_const_tbls.h"
  55
  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 #define VQ_SIZE_HIGHRATES 128
  73 #define VQ_SIZE_LOWRATES 64
  74
  75     /*----------------------------------------------------------------------------
  76     ; EXTERNAL VARIABLES REFERENCES
  77     ; Declare variables used in this module but defined elsewhere
  78     ----------------------------------------------------------------------------*/
  79
  80     /*----------------------------------------------------------------------------
  81     ; SIMPLE TYPEDEF'S
  82     ----------------------------------------------------------------------------*/
  83
  84     /*----------------------------------------------------------------------------
  85     ; ENUMERATED TYPEDEF'S
  86     ----------------------------------------------------------------------------*/
  87
  88     /*----------------------------------------------------------------------------
  89     ; STRUCTURES TYPEDEF'S
  90     ----------------------------------------------------------------------------*/
  91
  92     /*----------------------------------------------------------------------------
  93     ; GLOBAL FUNCTION DEFINITIONS
  94     ; Function Prototype declaration
  95     ----------------------------------------------------------------------------*/
  96
  97     Word16
  98     Qua_gain(                   /* o  : index of quantization.                 */
  99         enum Mode mode,         /* i  : AMR mode                               */
 100         Word16 exp_gcode0,      /* i  : predicted CB gain (exponent),      Q0  */
 101         Word16 frac_gcode0,     /* i  : predicted CB gain (fraction),      Q15 */
 102         Word16 frac_coeff[],    /* i  : energy coeff. (5), fraction part,  Q15 */
 103         Word16 exp_coeff[],     /* i  : energy coeff. (5), exponent part,  Q0  */
 104         /*      (frac_coeff and exp_coeff computed in  */
 105         /*       calc_filt_energies())                 */
 106         Word16 gp_limit,        /* i  : pitch gain limit                       */
 107         Word16 *gain_pit,       /* o  : Pitch gain,                        Q14 */
 108         Word16 *gain_cod,       /* o  : Code gain,                         Q1  */
 109         Word16 *qua_ener_MR122, /* o  : quantized energy error,            Q10 */
 110         /*      (for MR122 MA predictor update)        */
 111         Word16 *qua_ener,       /* o  : quantized energy error,            Q10 */
 112         /*      (for other MA predictor update)        */
 113         CommonAmrTbls* common_amr_tbls, /* i : ptr to struct of table ptrs     */
 114         Flag   *pOverflow       /* o  : overflow indicator                     */
 115     );
 116     /*----------------------------------------------------------------------------
 117     ; END
 118     ----------------------------------------------------------------------------*/
 119 #ifdef __cplusplus
 120 }
 121 #endif
 122
 123 #endif /* qua_gain_h */
 124
 125
 126