az_lsp.h revision 93eec2bc24e3782420d76df52586c84a03669087
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 Filename: /audio/gsm_amr/c/include/az_lsp.h.h
32
33
34------------------------------------------------------------------------------
35 REVISION HISTORY
36
37
38 Description: Changed function prototype; pointer to  overflow flag is passed
39              in as a parameter. Added extern declaration for grid_tbl[],
40              defined in grid_tbl.c
41
42 Description: Moved _cplusplus #ifdef after Include section.
43
44 Who:                           Date:
45 Description:
46
47
48------------------------------------------------------------------------------
49 INCLUDE DESCRIPTION
50
51 This file contains all the constant definitions and prototype definitions
52 needed by the function Az_lsp()
53
54------------------------------------------------------------------------------
55*/
56
57#ifndef AZ_LSP_H
58#define AZ_LSP_H
59
60/*----------------------------------------------------------------------------
61; INCLUDES
62----------------------------------------------------------------------------*/
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#define grid_points 60
81
82    /*----------------------------------------------------------------------------
83    ; EXTERNAL VARIABLES REFERENCES
84    ; Declare variables used in this module but defined elsewhere
85    ----------------------------------------------------------------------------*/
86    extern const Word16 grid[];
87
88    /*----------------------------------------------------------------------------
89    ; SIMPLE TYPEDEF'S
90    ----------------------------------------------------------------------------*/
91
92    /*----------------------------------------------------------------------------
93    ; ENUMERATED TYPEDEF'S
94    ----------------------------------------------------------------------------*/
95
96    /*----------------------------------------------------------------------------
97    ; STRUCTURES TYPEDEF'S
98    ----------------------------------------------------------------------------*/
99
100    /*----------------------------------------------------------------------------
101    ; GLOBAL FUNCTION DEFINITIONS
102    ; Function Prototype declaration
103    ----------------------------------------------------------------------------*/
104    void Az_lsp(
105        Word16 a[],         /* (i)  : predictor coefficients (MP1)               */
106        Word16 lsp[],       /* (o)  : line spectral pairs (M)                    */
107        Word16 old_lsp[],   /* (i)  : old lsp[] (in case not found 10 roots) (M) */
108        Flag   *pOverflow   /* (i/o): overflow flag                              */
109    );
110
111
112    /*----------------------------------------------------------------------------
113    ; END
114    ----------------------------------------------------------------------------*/
115#ifdef __cplusplus
116}
117#endif
118
119#endif /* _AZ_LSP_H */
120
121