cor_h_x.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 INCLUDE DESCRIPTION
32
33 This file contains prototype declaration for cor_h_x function.
34
35------------------------------------------------------------------------------
36*/
37
38/*----------------------------------------------------------------------------
39; CONTINUE ONLY IF NOT ALREADY DEFINED
40----------------------------------------------------------------------------*/
41#ifndef COR_H_X_H
42#define COR_H_X_H
43
44/*----------------------------------------------------------------------------
45; INCLUDES
46----------------------------------------------------------------------------*/
47#include    "typedef.h"
48
49/*--------------------------------------------------------------------------*/
50#ifdef __cplusplus
51extern "C"
52{
53#endif
54
55    /*----------------------------------------------------------------------------
56    ; MACROS
57    ; Define module specific macros here
58    ----------------------------------------------------------------------------*/
59
60    /*----------------------------------------------------------------------------
61    ; DEFINES
62    ; Include all pre-processor statements here.
63    ----------------------------------------------------------------------------*/
64
65    /*----------------------------------------------------------------------------
66    ; EXTERNAL VARIABLES REFERENCES
67    ; Declare variables used in this module but defined elsewhere
68    ----------------------------------------------------------------------------*/
69
70    /*----------------------------------------------------------------------------
71    ; SIMPLE TYPEDEF'S
72    ----------------------------------------------------------------------------*/
73
74    /*----------------------------------------------------------------------------
75    ; ENUMERATED TYPEDEF'S
76    ----------------------------------------------------------------------------*/
77
78    /*----------------------------------------------------------------------------
79    ; STRUCTURES TYPEDEF'S
80    ----------------------------------------------------------------------------*/
81
82    /*----------------------------------------------------------------------------
83    ; GLOBAL FUNCTION DEFINITIONS
84    ; Function Prototype declaration
85    ----------------------------------------------------------------------------*/
86    void cor_h_x(
87        Word16 h[],       /* (i): impulse response of weighted synthesis filter */
88        Word16 x[],       /* (i): target                                        */
89        Word16 dn[],      /* (o): correlation between target and h[]            */
90        Word16 sf,        /* (i): scaling factor: 2 for 12.2, 1 for others      */
91        Flag   *pOverflow /* (o): pointer to overflow flag                      */
92    );
93
94    /*----------------------------------------------------------------------------
95    ; END
96    ----------------------------------------------------------------------------*/
97#ifdef __cplusplus
98}
99#endif
100
101#endif
102
103
104