Initialize Tizen 2.3
[external/opencore-amr.git] / opencore / codecs_v2 / audio / gsm_amr / amr_nb / common / include / int_lpc.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: int_lpc.h
32
33 ------------------------------------------------------------------------------
34  INCLUDE DESCRIPTION
35
36  This file contains all the constant definitions and prototype definitions
37  needed by the lsp_avg.c
38
39 ------------------------------------------------------------------------------
40 */
41
42 /*----------------------------------------------------------------------------
43 ; CONTINUE ONLY IF NOT ALREADY DEFINED
44 ----------------------------------------------------------------------------*/
45 #ifndef int_lpc_h
46 #define int_lpc_h "$Id $"
47
48 /*----------------------------------------------------------------------------
49 ; INCLUDES
50 ----------------------------------------------------------------------------*/
51 #include "typedef.h"
52
53 /*--------------------------------------------------------------------------*/
54 #ifdef __cplusplus
55 extern "C"
56 {
57 #endif
58
59     /*----------------------------------------------------------------------------
60     ; MACROS
61     ; Define module specific macros here
62     ----------------------------------------------------------------------------*/
63
64     /*----------------------------------------------------------------------------
65     ; DEFINES
66     ; Include all pre-processor statements here.
67     ----------------------------------------------------------------------------*/
68
69     /*----------------------------------------------------------------------------
70     ; EXTERNAL VARIABLES REFERENCES
71     ; Declare variables used in this module but defined elsewhere
72     ----------------------------------------------------------------------------*/
73
74     /*----------------------------------------------------------------------------
75     ; SIMPLE TYPEDEF'S
76     ----------------------------------------------------------------------------*/
77
78     /*----------------------------------------------------------------------------
79     ; ENUMERATED TYPEDEF'S
80     ----------------------------------------------------------------------------*/
81
82     /*----------------------------------------------------------------------------
83     ; STRUCTURES TYPEDEF'S
84     ----------------------------------------------------------------------------*/
85
86     /*----------------------------------------------------------------------------
87     ; GLOBAL FUNCTION DEFINITIONS
88     ; Function Prototype declaration
89     ----------------------------------------------------------------------------*/
90
91     /*
92     **************************************************************************
93     *
94     *  Function    : Int_lpc_1and3
95     *  Purpose     : Interpolates the LSPs and converts to LPC parameters
96     *                to get a different LP filter in each subframe.
97     *  Description : The 20 ms speech frame is divided into 4 subframes.
98     *                The LSPs are quantized and transmitted at the 2nd and
99     *                4th subframes (twice per frame) and interpolated at the
100     *                1st and 3rd subframe.
101     *
102     *                      |------|------|------|------|
103     *                         sf1    sf2    sf3    sf4
104     *                   F0            Fm            F1
105     *
106     *                 sf1:   1/2 Fm + 1/2 F0         sf3:   1/2 F1 + 1/2 Fm
107     *                 sf2:       Fm                  sf4:       F1
108     *  Returns     : void
109     *
110     **************************************************************************
111     */
112     OSCL_IMPORT_REF void Int_lpc_1and3(
113         Word16 lsp_old[],  /* i : LSP vector at the 4th subfr. of past frame (M) */
114         Word16 lsp_mid[],  /* i : LSP vector at the 2nd subfr. of
115                               present frame (M)                              */
116         Word16 lsp_new[],  /* i : LSP vector at the 4th subfr. of
117                               present frame (M)                              */
118         Word16 Az[],       /* o : interpolated LP parameters in all subfr.
119                               (AZ_SIZE)                                      */
120         Flag   *pOverflow
121     );
122
123     /*
124     **************************************************************************
125     *
126     *  Function    : Int_lpc_1and3_2
127     *  Purpose     : Interpolation of the LPC parameters. Same as the Int_lpc
128     *                function but we do not recompute Az() for subframe 2 and
129     *                4 because it is already available.
130     *  Returns     : void
131     *
132     **************************************************************************
133     */
134     void Int_lpc_1and3_2(
135         Word16 lsp_old[],  /* i : LSP vector at the 4th subfr. of past frame (M) */
136         Word16 lsp_mid[],  /* i : LSP vector at the 2nd subframe of
137                              present frame (M)                                  */
138         Word16 lsp_new[],  /* i : LSP vector at the 4th subframe of
139                              present frame (M)                                  */
140         Word16 Az[],       /* o :interpolated LP parameters
141                              in subframes 1 and 3 (AZ_SIZE)                     */
142         Flag   *pOverflow
143     );
144
145     /*
146     **************************************************************************
147     *
148     *  Function    : Int_lpc_1to3
149     *  Purpose     : Interpolates the LSPs and converts to LPC parameters
150     *                to get a different LP filter in each subframe.
151     *  Description : The 20 ms speech frame is divided into 4 subframes.
152     *                The LSPs are quantized and transmitted at the 4th
153     *                subframes (once per frame) and interpolated at the
154     *                1st, 2nd and 3rd subframe.
155     *
156     *                      |------|------|------|------|
157     *                         sf1    sf2    sf3    sf4
158     *                   F0                          F1
159     *
160     *                 sf1:   3/4 F0 + 1/4 F1         sf3:   1/4 F0 + 3/4 F1
161     *                 sf2:   1/2 F0 + 1/2 F1         sf4:       F1
162     *  Returns     : void
163     *
164     **************************************************************************
165     */
166     OSCL_IMPORT_REF void Int_lpc_1to3(
167         Word16 lsp_old[], /* i : LSP vector at the 4th SF of past frame (M)      */
168         Word16 lsp_new[], /* i : LSP vector at the 4th SF of present frame (M)   */
169         Word16 Az[],      /* o : interpolated LP parameters in all SFs (AZ_SIZE) */
170         Flag   *pOverflow
171     );
172
173     /*
174     **************************************************************************
175     *
176     *  Function    : Int_lpc_1to3_2
177     *  Purpose     : Interpolation of the LPC parameters. Same as the Int_lpc
178     *                function but we do not recompute Az() for subframe 4
179     *                because it is already available.
180     *  Returns     : void
181     *
182     **************************************************************************
183     */
184     void Int_lpc_1to3_2(
185         Word16 lsp_old[],  /* i : LSP vector at the 4th SF of past frame (M) */
186         Word16 lsp_new[],  /* i : LSP vector at the 4th SF present frame (M) */
187         Word16 Az[],       /* o :interpolated LP parameters in SFs 1, 2, 3
188                              (AZ_SIZE)                                   */
189         Flag   *pOverflow
190     );
191
192     /*----------------------------------------------------------------------------
193     ; END
194     ----------------------------------------------------------------------------*/
195 #ifdef __cplusplus
196 }
197 #endif
198
199 #endif /* _INT_LPC_H_ */
200
201