ol_ltp.h revision b841f14f8e51f2365945281fbfa54ef6a1b1b5a6
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/****************************************************************************************
19Portions 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)
26Permission to distribute, modify and use this file under the standard license
27terms listed above has been obtained from the copyright holder.
28****************************************************************************************/
29/*
30------------------------------------------------------------------------------
31
32
33
34 Filename: /audio/gsm_amr/c/src/include/ol_ltp.h
35
36     Date: 02/06/2002
37
38------------------------------------------------------------------------------
39 REVISION HISTORY
40
41 Description:  Replaced "int" and/or "char" with OSCL defined types.
42
43 Description: Moved _cplusplus #ifdef after Include section.
44
45 Description:
46
47------------------------------------------------------------------------------
48 INCLUDE DESCRIPTION
49
50       File             : ol_ltp.h
51       Purpose          : Compute the open loop pitch lag.
52
53------------------------------------------------------------------------------
54*/
55
56#ifndef OL_LTP_H
57#define OL_LTP_H "$Id $"
58
59/*----------------------------------------------------------------------------
60; INCLUDES
61----------------------------------------------------------------------------*/
62#include "typedef.h"
63#include "mode.h"
64#include "p_ol_wgh.h"
65
66/*--------------------------------------------------------------------------*/
67#ifdef __cplusplus
68extern "C"
69{
70#endif
71
72    /*----------------------------------------------------------------------------
73    ; MACROS
74    ; [Define module specific macros here]
75    ----------------------------------------------------------------------------*/
76
77    /*----------------------------------------------------------------------------
78    ; DEFINES
79    ; [Include all pre-processor statements here.]
80    ----------------------------------------------------------------------------*/
81
82    /*----------------------------------------------------------------------------
83    ; EXTERNAL VARIABLES REFERENCES
84    ; [Declare variables used in this module but defined elsewhere]
85    ----------------------------------------------------------------------------*/
86
87    /*----------------------------------------------------------------------------
88    ; SIMPLE TYPEDEF'S
89    ----------------------------------------------------------------------------*/
90
91    /*----------------------------------------------------------------------------
92    ; ENUMERATED TYPEDEF'S
93    ----------------------------------------------------------------------------*/
94
95    /*----------------------------------------------------------------------------
96    ; STRUCTURES TYPEDEF'S
97    ----------------------------------------------------------------------------*/
98
99
100    /*----------------------------------------------------------------------------
101    ; GLOBAL FUNCTION DEFINITIONS
102    ; [List function prototypes here]
103    ----------------------------------------------------------------------------*/
104    void ol_ltp(
105        pitchOLWghtState *st, /* i/o : State struct                            */
106        vadState *vadSt,      /* i/o : VAD state struct                        */
107        enum Mode mode,       /* i   : coder mode                              */
108        Word16 wsp[],         /* i   : signal used to compute the OL pitch, Q0 */
109        /*       uses signal[-pit_max] to signal[-1]     */
110        Word16 *T_op,         /* o   : open loop pitch lag,                 Q0 */
111        Word16 old_lags[],    /* i   : history with old stored Cl lags         */
112        Word16 ol_gain_flg[], /* i   : OL gain flag                            */
113        Word16 idx,           /* i   : index                                   */
114        Flag dtx,             /* i   : dtx flag; use dtx=1, do not use dtx=0   */
115        Flag *pOverflow       /* i/o : overflow Flag                           */
116    );
117
118
119#ifdef __cplusplus
120}
121#endif
122
123#endif  /* _OL_LTP_H_ */
124
125
126