Initialize Tizen 2.3
[external/opencore-amr.git] / opencore / codecs_v2 / audio / gsm_amr / amr_nb / enc / src / pitch_ol.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: pitch_ol.h
35
36 ------------------------------------------------------------------------------
37  INCLUDE DESCRIPTION
38
39        File             : pitch_ol.h
40        Purpose          : Compute the open loop pitch lag.
41
42 ------------------------------------------------------------------------------
43 */
44
45 #ifndef PITCH_OL_H
46 #define PITCH_OL_H "$Id $"
47
48 /*----------------------------------------------------------------------------
49 ; INCLUDES
50 ----------------------------------------------------------------------------*/
51 #include "typedef.h"
52 #include "mode.h"
53 #include "vad.h"
54
55 /*--------------------------------------------------------------------------*/
56 #ifdef __cplusplus
57 extern "C"
58 {
59 #endif
60
61     /*----------------------------------------------------------------------------
62     ; MACROS
63     ; [Define module specific macros here]
64     ----------------------------------------------------------------------------*/
65
66     /*----------------------------------------------------------------------------
67     ; DEFINES
68     ; [Include all pre-processor statements here.]
69     ----------------------------------------------------------------------------*/
70
71     /*----------------------------------------------------------------------------
72     ; EXTERNAL VARIABLES REFERENCES
73     ; [Declare variables used in this module but defined elsewhere]
74     ----------------------------------------------------------------------------*/
75
76     /*----------------------------------------------------------------------------
77     ; SIMPLE TYPEDEF'S
78     ----------------------------------------------------------------------------*/
79
80     /*----------------------------------------------------------------------------
81     ; ENUMERATED TYPEDEF'S
82     ----------------------------------------------------------------------------*/
83
84     /*----------------------------------------------------------------------------
85     ; STRUCTURES TYPEDEF'S
86     ----------------------------------------------------------------------------*/
87
88
89     /*----------------------------------------------------------------------------
90     ; GLOBAL FUNCTION DEFINITIONS
91     ; [List function prototypes here]
92     ----------------------------------------------------------------------------*/
93     Word16 Pitch_ol(       /* o   : open loop pitch lag                         */
94         vadState *vadSt,   /* i/o : VAD state struct                            */
95         enum Mode mode,    /* i   : coder mode                                  */
96         Word16 signal[],   /* i   : signal used to compute the open loop pitch  */
97         /*    signal[-pit_max] to signal[-1] should be known */
98         Word16 pit_min,    /* i   : minimum pitch lag                           */
99         Word16 pit_max,    /* i   : maximum pitch lag                           */
100         Word16 L_frame,    /* i   : length of frame to compute pitch            */
101         Word16 idx,        /* i   : frame index                                 */
102         Flag dtx,          /* i   : dtx flag; use dtx=1, do not use dtx=0       */
103         Flag *pOverflow    /* i/o : overflow Flag                               */
104     );
105
106
107 #ifdef __cplusplus
108 }
109 #endif
110
111 #endif  /* PITCH_OL_H_ */
112
113