Git init
[external/opencore-amr.git] / opencore / codecs_v2 / audio / gsm_amr / amr_nb / enc / src / spstproc.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: spstproc.h
35
36 ------------------------------------------------------------------------------
37  INCLUDE DESCRIPTION
38
39  This file contains all the constant definitions and prototype definitions
40  needed by the file, spstproc.c
41
42 ------------------------------------------------------------------------------
43 */
44
45 /*----------------------------------------------------------------------------
46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
47 ----------------------------------------------------------------------------*/
48 #ifndef spstproc_h
49 #define spstproc_h "$Id $"
50
51 /*----------------------------------------------------------------------------
52 ; INCLUDES
53 ----------------------------------------------------------------------------*/
54 #include "typedef.h"
55 #include "mode.h"
56
57 /*--------------------------------------------------------------------------*/
58 #ifdef __cplusplus
59 extern "C"
60 {
61 #endif
62
63     /*----------------------------------------------------------------------------
64     ; MACROS
65     ; Define module specific macros here
66     ----------------------------------------------------------------------------*/
67
68     /*----------------------------------------------------------------------------
69     ; DEFINES
70     ; Include all pre-processor statements here.
71     ----------------------------------------------------------------------------*/
72
73     /*----------------------------------------------------------------------------
74     ; EXTERNAL VARIABLES REFERENCES
75     ; Declare variables used in this module but defined elsewhere
76     ----------------------------------------------------------------------------*/
77
78     /*----------------------------------------------------------------------------
79     ; SIMPLE TYPEDEF'S
80     ----------------------------------------------------------------------------*/
81
82     /*----------------------------------------------------------------------------
83     ; ENUMERATED TYPEDEF'S
84     ----------------------------------------------------------------------------*/
85
86     /*----------------------------------------------------------------------------
87     ; STRUCTURES TYPEDEF'S
88     ----------------------------------------------------------------------------*/
89
90     /*----------------------------------------------------------------------------
91     ; GLOBAL FUNCTION DEFINITIONS
92     ; Function Prototype declaration
93     ----------------------------------------------------------------------------*/
94
95     void subframePostProc(
96         Word16 *speech,   /* i   : speech segment                        */
97         enum Mode mode,   /* i   : coder mode                            */
98         Word16 i_subfr,   /* i   : Subframe nr                           */
99         Word16 gain_pit,  /* i   : Pitch gain                       Q14  */
100         Word16 gain_code, /* i   : Decoded innovation gain               */
101         Word16 *Aq,       /* i   : A(z) quantized for the 4 subframes    */
102         Word16 synth[],   /* i   : Local snthesis                        */
103         Word16 xn[],      /* i   : Target vector for pitch search        */
104         Word16 code[],    /* i   : Fixed codebook exitation              */
105         Word16 y1[],      /* i   : Filtered adaptive exitation           */
106         Word16 y2[],      /* i   : Filtered fixed codebook excitation    */
107         Word16 *mem_syn,  /* i/o : memory of synthesis filter            */
108         Word16 *mem_err,  /* o   : pointer to error signal               */
109         Word16 *mem_w0,   /* o   : memory of weighting filter            */
110         Word16 *exc,      /* o   : long term prediction residual         */
111         Word16 *sharp,    /* o   : pitch sharpening value                */
112         Flag   *pOverflow
113     );
114     /*----------------------------------------------------------------------------
115     ; END
116     ----------------------------------------------------------------------------*/
117 #ifdef __cplusplus
118 }
119 #endif
120
121 #endif /* spstproc_h */
122