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/****************************************************************************************
19Portions 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)
26Permission to distribute, modify and use this file under the standard license
27terms listed above has been obtained from the copyright holder.
28****************************************************************************************/
29/*
30------------------------------------------------------------------------------
31
32
33
34 Filename: /audio/gsm_amr/c/include/qgain795.h
35
36     Date: 02/05/2002
37
38------------------------------------------------------------------------------
39 REVISION HISTORY
40
41 Description: Placed header file in the proper template format.  Added
42 parameter pOverflow for the basic math ops.
43
44 Description: Moved _cplusplus #ifdef after Include section.
45
46 Description:
47
48------------------------------------------------------------------------------
49 INCLUDE DESCRIPTION
50
51 This file contains all the constant definitions and prototype definitions
52 needed by the file, qgain795.c
53
54------------------------------------------------------------------------------
55*/
56
57/*----------------------------------------------------------------------------
58; CONTINUE ONLY IF NOT ALREADY DEFINED
59----------------------------------------------------------------------------*/
60#ifndef qgain795_h
61#define qgain795_h "$Id $"
62
63/*----------------------------------------------------------------------------
64; INCLUDES
65----------------------------------------------------------------------------*/
66#include "typedef.h"
67#include "g_adapt.h"
68
69/*--------------------------------------------------------------------------*/
70#ifdef __cplusplus
71extern "C"
72{
73#endif
74
75    /*----------------------------------------------------------------------------
76    ; MACROS
77    ; Define module specific macros here
78    ----------------------------------------------------------------------------*/
79
80    /*----------------------------------------------------------------------------
81    ; DEFINES
82    ; Include all pre-processor statements here.
83    ----------------------------------------------------------------------------*/
84
85    /*----------------------------------------------------------------------------
86    ; EXTERNAL VARIABLES REFERENCES
87    ; Declare variables used in this module but defined elsewhere
88    ----------------------------------------------------------------------------*/
89
90    /*----------------------------------------------------------------------------
91    ; SIMPLE TYPEDEF'S
92    ----------------------------------------------------------------------------*/
93
94    /*----------------------------------------------------------------------------
95    ; ENUMERATED TYPEDEF'S
96    ----------------------------------------------------------------------------*/
97
98    /*----------------------------------------------------------------------------
99    ; STRUCTURES TYPEDEF'S
100    ----------------------------------------------------------------------------*/
101
102    /*----------------------------------------------------------------------------
103    ; GLOBAL FUNCTION DEFINITIONS
104    ; Function Prototype declaration
105    ----------------------------------------------------------------------------*/
106    void
107    MR795_gain_quant(
108        GainAdaptState *adapt_st, /* i/o: gain adapter state structure       */
109        Word16 res[],             /* i  : LP residual,                  Q0   */
110        Word16 exc[],             /* i  : LTP excitation (unfiltered),  Q0   */
111        Word16 code[],            /* i  : CB innovation (unfiltered),   Q13  */
112        Word16 frac_coeff[],      /* i  : coefficients (5),             Q15  */
113        Word16 exp_coeff[],       /* i  : energy coefficients (5),      Q0   */
114        /*      coefficients from calc_filt_ener() */
115        Word16 exp_code_en,       /* i  : innovation energy (exponent), Q0   */
116        Word16 frac_code_en,      /* i  : innovation energy (fraction), Q15  */
117        Word16 exp_gcode0,        /* i  : predicted CB gain (exponent), Q0   */
118        Word16 frac_gcode0,       /* i  : predicted CB gain (fraction), Q15  */
119        Word16 L_subfr,           /* i  : Subframe length                    */
120        Word16 cod_gain_frac,     /* i  : opt. codebook gain (fraction),Q15  */
121        Word16 cod_gain_exp,      /* i  : opt. codebook gain (exponent), Q0  */
122        Word16 gp_limit,          /* i  : pitch gain limit                   */
123        Word16 *gain_pit,         /* i/o: Pitch gain (unquant/quant),   Q14  */
124        Word16 *gain_cod,         /* o  : Code gain,                    Q1   */
125        Word16 *qua_ener_MR122,   /* o  : quantized energy error,       Q10  */
126        /*      (for MR122 MA predictor update)    */
127        Word16 *qua_ener,         /* o  : quantized energy error,       Q10  */
128        /*      (for other MA predictor update)    */
129        Word16 **anap,            /* o  : Index of quantization              */
130        /*      (first gain pitch, then code pitch)*/
131        Flag   *pOverflow         /* o  : overflow indicator                 */
132    );
133
134    /*----------------------------------------------------------------------------
135    ; END
136    ----------------------------------------------------------------------------*/
137#ifdef __cplusplus
138}
139#endif
140
141#endif /* qgain795_H_ */
142
143
144