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