g_pitch.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/include/g_pitch.h
35
36
37     Date: 02/01/2002
38
39------------------------------------------------------------------------------
40 REVISION HISTORY
41
42 Description: Moved _cplusplus #ifdef after Include section.
43
44 Description:
45
46
47------------------------------------------------------------------------------
48 INCLUDE DESCRIPTION
49
50 This file contains all the constant definitions and prototype definitions
51 needed by the G_pitch() function.
52
53------------------------------------------------------------------------------
54*/
55
56#ifndef G_PITCH_H
57#define G_PITCH_H
58
59/*----------------------------------------------------------------------------
60; INCLUDES
61----------------------------------------------------------------------------*/
62#include "mode.h"
63#include "typedef.h"
64
65/*--------------------------------------------------------------------------*/
66#ifdef __cplusplus
67extern "C"
68{
69#endif
70
71    /*----------------------------------------------------------------------------
72    ; MACROS
73    ; Define module specific macros here
74    ----------------------------------------------------------------------------*/
75
76    /*----------------------------------------------------------------------------
77    ; DEFINES
78    ; Include all pre-processor statements here.
79    ----------------------------------------------------------------------------*/
80
81    /*----------------------------------------------------------------------------
82    ; EXTERNAL VARIABLES REFERENCES
83    ; Declare variables used in this module but defined elsewhere
84    ----------------------------------------------------------------------------*/
85
86    /*----------------------------------------------------------------------------
87    ; SIMPLE TYPEDEF'S
88    ----------------------------------------------------------------------------*/
89
90    /*----------------------------------------------------------------------------
91    ; ENUMERATED TYPEDEF'S
92    ----------------------------------------------------------------------------*/
93
94    /*----------------------------------------------------------------------------
95    ; STRUCTURES TYPEDEF'S
96    ----------------------------------------------------------------------------*/
97
98    /*----------------------------------------------------------------------------
99    ; GLOBAL FUNCTION DEFINITIONS
100    ; Function Prototype declaration
101    ----------------------------------------------------------------------------*/
102    Word16 G_pitch(         /* o : Gain of pitch lag saturated to 1.2       */
103        enum Mode mode,     /* i : AMR mode                                 */
104        Word16 xn[],        /* i : Pitch target.                            */
105        Word16 y1[],        /* i : Filtered adaptive codebook.              */
106        Word16 g_coeff[],   /* i : Correlations need for gain quantization  */
107        Word16 L_subfr,     /* i : Length of subframe.                      */
108        Flag   *pOverflow   /* i/o : Overflow flag                          */
109    );
110
111    /*----------------------------------------------------------------------------
112    ; END
113    ----------------------------------------------------------------------------*/
114#ifdef __cplusplus
115}
116#endif
117
118#endif /* _G_PITCH_H_ */
119
120