opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/q_gain_c.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: q_gain_c.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the file, q_gain.c
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef q_gain_c_h
  49 #define q_gain_c_h "$Id $"
  50
  51 /*----------------------------------------------------------------------------
  52 ; INCLUDES
  53 ----------------------------------------------------------------------------*/
  54 #include "typedef.h"
  55 #include "mode.h"
  56 #include "gc_pred.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
  96     /*--------------------------------------------------------------------------*
  97      * Function q_gain_code()                                                   *
  98      * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~                                  *
  99      * Scalar quantization of the innovative codebook gain.                     *
 100      *                                                                          *
 101      * gc_pred() is used for MA prediction of the innovation energy             *
 102      *--------------------------------------------------------------------------*/
 103     Word16 q_gain_code(         /* o  : quantization index,            Q0  */
 104         enum Mode mode,         /* i  : AMR mode                           */
 105         Word16 exp_gcode0,      /* i  : predicted CB gain (exponent),  Q0  */
 106         Word16 frac_gcode0,     /* i  : predicted CB gain (fraction),  Q15 */
 107         Word16 *gain,           /* i/o: quantized fixed codebook gain, Q1  */
 108         Word16 *qua_ener_MR122, /* o  : quantized energy error,        Q10 */
 109         /*      (for MR122 MA predictor update)    */
 110         Word16 *qua_ener,       /* o  : quantized energy error,        Q10 */
 111         /*      (for other MA predictor update)    */
 112         const Word16* qua_gain_code_ptr, /* i : ptr to read-only table           */
 113         Flag   *pOverflow
 114     );
 115
 116     /*----------------------------------------------------------------------------
 117     ; END
 118     ----------------------------------------------------------------------------*/
 119 #ifdef __cplusplus
 120 }
 121 #endif
 122
 123 #endif /* q_gain_c_h */
 124
 125