Git init
[external/opencore-amr.git] / opencore / codecs_v2 / audio / gsm_amr / amr_nb / enc / src / c3_14pf.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: c3_14pf.h
35
36 ------------------------------------------------------------------------------
37  INCLUDE DESCRIPTION
38
39  This file contains all the constant definitions and prototype definitions
40  needed by c3_14pf.c
41
42 ------------------------------------------------------------------------------
43 */
44
45 /*----------------------------------------------------------------------------
46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
47 ----------------------------------------------------------------------------*/
48 #ifndef c3_14pf_h
49 #define c3_14pf_h "$Id $"
50
51 /*----------------------------------------------------------------------------
52 ; INCLUDES
53 ----------------------------------------------------------------------------*/
54 #include "typedef.h"
55
56 /*--------------------------------------------------------------------------*/
57 #ifdef __cplusplus
58 extern "C"
59 {
60 #endif
61
62     /*----------------------------------------------------------------------------
63     ; MACROS
64     ; Define module specific macros here
65     ----------------------------------------------------------------------------*/
66
67     /*----------------------------------------------------------------------------
68     ; DEFINES
69     ; Include all pre-processor statements here.
70     ----------------------------------------------------------------------------*/
71
72     /*----------------------------------------------------------------------------
73     ; EXTERNAL VARIABLES REFERENCES
74     ; Declare variables used in this module but defined elsewhere
75     ----------------------------------------------------------------------------*/
76
77     /*----------------------------------------------------------------------------
78     ; SIMPLE TYPEDEF'S
79     ----------------------------------------------------------------------------*/
80
81     /*----------------------------------------------------------------------------
82     ; ENUMERATED TYPEDEF'S
83     ----------------------------------------------------------------------------*/
84
85     /*----------------------------------------------------------------------------
86     ; STRUCTURES TYPEDEF'S
87     ----------------------------------------------------------------------------*/
88
89     /*----------------------------------------------------------------------------
90     ; GLOBAL FUNCTION DEFINITIONS
91     ; Function Prototype declaration
92     ----------------------------------------------------------------------------*/
93
94     Word16 code_3i40_14bits(
95         Word16 x[], /* (i)   : target vector                                 */
96         Word16 h[], /* (i)   : impulse response of weighted synthesis filter */
97         /*         h[-L_subfr..-1] must be set to zero.          */
98         Word16 T0,  /* (i)   : Pitch lag                                     */
99         Word16 pitch_sharp, /* (i)   : Last quantized pitch gain             */
100         Word16 code[],      /* (o)   : Innovative codebook                   */
101         Word16 y[],         /* (o)   : filtered fixed codebook excitation    */
102         Word16 * sign,      /* (o)   : Signs of 3 pulses                     */
103         Flag   *pOverflow
104     );
105
106     /*----------------------------------------------------------------------------
107     ; END
108     ----------------------------------------------------------------------------*/
109 #ifdef __cplusplus
110 }
111 #endif
112
113 #endif /* _c3_14PF_H_ */
114