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: /audio/gsm_amr/c/include/qua_gain.h
32 
33 ------------------------------------------------------------------------------
34  REVISION HISTORY
35 
36  Description: Placed header file in the proper template format.  Added
37  parameter pOverflow for the basic math ops.
38 
39  Description: Moved _cplusplus #ifdef after Include section.
40 
41  Who:                       Date:
42  Description:
43 
44 ------------------------------------------------------------------------------
45  INCLUDE DESCRIPTION
46 
47  This file contains all the constant definitions and prototype definitions
48  needed by the file, qua_gain.c
49 
50 ------------------------------------------------------------------------------
51 */
52 
53 /*----------------------------------------------------------------------------
54 ; CONTINUE ONLY IF NOT ALREADY DEFINED
55 ----------------------------------------------------------------------------*/
56 #ifndef qua_gain_h
57 #define qua_gain_h "$Id $"
58 
59 /*----------------------------------------------------------------------------
60 ; INCLUDES
61 ----------------------------------------------------------------------------*/
62 #include "typedef.h"
63 #include "gc_pred.h"
64 #include "mode.h"
65 
66 
67 /*--------------------------------------------------------------------------*/
68 #ifdef __cplusplus
69 extern "C"
70 {
71 #endif
72 
73     /*----------------------------------------------------------------------------
74     ; MACROS
75     ; Define module specific macros here
76     ----------------------------------------------------------------------------*/
77 
78     /*----------------------------------------------------------------------------
79     ; DEFINES
80     ; Include all pre-processor statements here.
81     ----------------------------------------------------------------------------*/
82 #define VQ_SIZE_HIGHRATES 128
83 #define VQ_SIZE_LOWRATES 64
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 
107     Word16
108     Qua_gain(                   /* o  : index of quantization.                 */
109         enum Mode mode,         /* i  : AMR mode                               */
110         Word16 exp_gcode0,      /* i  : predicted CB gain (exponent),      Q0  */
111         Word16 frac_gcode0,     /* i  : predicted CB gain (fraction),      Q15 */
112         Word16 frac_coeff[],    /* i  : energy coeff. (5), fraction part,  Q15 */
113         Word16 exp_coeff[],     /* i  : energy coeff. (5), exponent part,  Q0  */
114         /*      (frac_coeff and exp_coeff computed in  */
115         /*       calc_filt_energies())                 */
116         Word16 gp_limit,        /* i  : pitch gain limit                       */
117         Word16 *gain_pit,       /* o  : Pitch gain,                        Q14 */
118         Word16 *gain_cod,       /* o  : Code gain,                         Q1  */
119         Word16 *qua_ener_MR122, /* o  : quantized energy error,            Q10 */
120         /*      (for MR122 MA predictor update)        */
121         Word16 *qua_ener,       /* o  : quantized energy error,            Q10 */
122         /*      (for other MA predictor update)        */
123         Flag   *pOverflow       /* o  : overflow indicator                     */
124     );
125     /*----------------------------------------------------------------------------
126     ; END
127     ----------------------------------------------------------------------------*/
128 #ifdef __cplusplus
129 }
130 #endif
131 
132 #endif /* qua_gain_h */
133 
134 
135 
136