Tizen 2.0 Release
[external/opencore-amr.git] / opencore / codecs_v2 / audio / gsm_amr / amr_nb / common / include / pred_lt.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  Filename: pred_lt.h
31
32 ------------------------------------------------------------------------------
33  INCLUDE DESCRIPTION
34
35  This file contains all the constant definitions and prototype definitions
36  needed by the pred_lt function.
37
38 ------------------------------------------------------------------------------
39 */
40
41 /*----------------------------------------------------------------------------
42 ; CONTINUE ONLY IF NOT ALREADY DEFINED
43 ----------------------------------------------------------------------------*/
44 #ifndef pred_lt_h
45 #define pred_lt_h "$Id $"
46
47 /*----------------------------------------------------------------------------
48 ; INCLUDES
49 ----------------------------------------------------------------------------*/
50 #include "typedef.h"
51
52 /*--------------------------------------------------------------------------*/
53 #ifdef __cplusplus
54 extern "C"
55 {
56 #endif
57
58     /*----------------------------------------------------------------------------
59     ; MACROS
60     ; Define module specific macros here
61     ----------------------------------------------------------------------------*/
62
63     /*----------------------------------------------------------------------------
64     ; DEFINES
65     ; Include all pre-processor statements here.
66     ----------------------------------------------------------------------------*/
67
68     /*----------------------------------------------------------------------------
69     ; EXTERNAL VARIABLES REFERENCES
70     ; Declare variables used in this module but defined elsewhere
71     ----------------------------------------------------------------------------*/
72
73     /*----------------------------------------------------------------------------
74     ; SIMPLE TYPEDEF'S
75     ----------------------------------------------------------------------------*/
76
77     /*----------------------------------------------------------------------------
78     ; ENUMERATED TYPEDEF'S
79     ----------------------------------------------------------------------------*/
80
81     /*----------------------------------------------------------------------------
82     ; STRUCTURES TYPEDEF'S
83     ----------------------------------------------------------------------------*/
84
85     /*----------------------------------------------------------------------------
86     ; GLOBAL FUNCTION DEFINITIONS
87     ; Function Prototype declaration
88     ----------------------------------------------------------------------------*/
89     OSCL_IMPORT_REF void Pred_lt_3or6(
90         Word16 exc[],     /* in/out: excitation buffer                          */
91         Word16 T0,        /* input : integer pitch lag                          */
92         Word16 frac,      /* input : fraction of lag                            */
93         Word16 L_subfr,   /* input : subframe size                              */
94         Word16 flag3,     /* input : if set, upsampling rate = 3 (6 otherwise)  */
95         Flag  *pOverflow  /* output: if set, overflow occurred in this function */
96     );
97
98     /*----------------------------------------------------------------------------
99     ; END
100     ----------------------------------------------------------------------------*/
101 #ifdef __cplusplus
102 }
103 #endif
104
105 #endif /* PRED_LT_H */