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/q_gain.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, q_gain.c
53
54------------------------------------------------------------------------------
55*/
56
57/*----------------------------------------------------------------------------
58; CONTINUE ONLY IF NOT ALREADY DEFINED
59----------------------------------------------------------------------------*/
60#ifndef q_gain_c_h
61#define q_gain_c_h "$Id $"
62
63/*----------------------------------------------------------------------------
64; INCLUDES
65----------------------------------------------------------------------------*/
66#include "typedef.h"
67#include "mode.h"
68#include "gc_pred.h"
69
70/*--------------------------------------------------------------------------*/
71#ifdef __cplusplus
72extern "C"
73{
74#endif
75
76    /*----------------------------------------------------------------------------
77    ; MACROS
78    ; Define module specific macros here
79    ----------------------------------------------------------------------------*/
80
81    /*----------------------------------------------------------------------------
82    ; DEFINES
83    ; Include all pre-processor statements here.
84    ----------------------------------------------------------------------------*/
85
86    /*----------------------------------------------------------------------------
87    ; EXTERNAL VARIABLES REFERENCES
88    ; Declare variables used in this module but defined elsewhere
89    ----------------------------------------------------------------------------*/
90
91    /*----------------------------------------------------------------------------
92    ; SIMPLE TYPEDEF'S
93    ----------------------------------------------------------------------------*/
94
95    /*----------------------------------------------------------------------------
96    ; ENUMERATED TYPEDEF'S
97    ----------------------------------------------------------------------------*/
98
99    /*----------------------------------------------------------------------------
100    ; STRUCTURES TYPEDEF'S
101    ----------------------------------------------------------------------------*/
102
103    /*----------------------------------------------------------------------------
104    ; GLOBAL FUNCTION DEFINITIONS
105    ; Function Prototype declaration
106    ----------------------------------------------------------------------------*/
107
108    /*--------------------------------------------------------------------------*
109     * Function q_gain_code()                                                   *
110     * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~                                  *
111     * Scalar quantization of the innovative codebook gain.                     *
112     *                                                                          *
113     * gc_pred() is used for MA prediction of the innovation energy             *
114     *--------------------------------------------------------------------------*/
115    Word16 q_gain_code(         /* o  : quantization index,            Q0  */
116        enum Mode mode,         /* i  : AMR mode                           */
117        Word16 exp_gcode0,      /* i  : predicted CB gain (exponent),  Q0  */
118        Word16 frac_gcode0,     /* i  : predicted CB gain (fraction),  Q15 */
119        Word16 *gain,           /* i/o: quantized fixed codebook gain, Q1  */
120        Word16 *qua_ener_MR122, /* o  : quantized energy error,        Q10 */
121        /*      (for MR122 MA predictor update)    */
122        Word16 *qua_ener,       /* o  : quantized energy error,        Q10 */
123        /*      (for other MA predictor update)    */
124        Flag   *pOverflow
125    );
126
127    /*----------------------------------------------------------------------------
128    ; END
129    ----------------------------------------------------------------------------*/
130#ifdef __cplusplus
131}
132#endif
133
134#endif /* q_gain_c_h */
135
136
137