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
20 Pathname: long_term_prediction.h
21
22------------------------------------------------------------------------------
23 REVISION HISTORY
24
25 Description: Modified prototype with array size passed in per review
26              comments.
27
28 Description: Changed prototype with "weight_index" instead of "weight".
29
30 Description: Removed some passed in buffer size variables since they are
31              not being used for long window.
32
33 Description: Temporarily define LTP_Q_FORMAT for current release.
34              Need to change function prototype and pass out Q_format
35              information later.
36
37 Description: Updated function prototype to reflect the usage of a
38 circular buffer by LTP.
39
40 Description:  Updated function interface with new return type
41
42 Who:                                   Date:
43 Description:
44
45------------------------------------------------------------------------------
46 INCLUDE DESCRIPTION
47
48 This file includes function prototype declaration for long_term_prediction().
49
50------------------------------------------------------------------------------
51*/
52
53/*----------------------------------------------------------------------------
54; CONTINUE ONLY IF NOT ALREADY DEFINED
55----------------------------------------------------------------------------*/
56#ifndef LONG_TERM_PREDICTION_H
57#define LONG_TERM_PREDICTION_H
58
59/*----------------------------------------------------------------------------
60; INCLUDES
61----------------------------------------------------------------------------*/
62#include "pv_audio_type_defs.h"
63#include "e_window_sequence.h"
64
65/*----------------------------------------------------------------------------
66; MACROS
67; Define module specific macros here
68----------------------------------------------------------------------------*/
69
70/*----------------------------------------------------------------------------
71; DEFINES
72; Include all pre-processor statements here.
73----------------------------------------------------------------------------*/
74#define LTP_Q_FORMAT    (15)
75
76/*----------------------------------------------------------------------------
77; EXTERNAL VARIABLES REFERENCES
78; Declare variables used in this module but defined elsewhere
79----------------------------------------------------------------------------*/
80
81/*----------------------------------------------------------------------------
82; SIMPLE TYPEDEF'S
83----------------------------------------------------------------------------*/
84
85/*----------------------------------------------------------------------------
86; ENUMERATED TYPEDEF'S
87----------------------------------------------------------------------------*/
88
89/*----------------------------------------------------------------------------
90; STRUCTURES TYPEDEF'S
91----------------------------------------------------------------------------*/
92
93/*----------------------------------------------------------------------------
94; GLOBAL FUNCTION DEFINITIONS
95; Function Prototype declaration
96----------------------------------------------------------------------------*/
97#ifdef __cplusplus
98extern "C"
99{
100#endif
101
102
103    Int long_term_prediction(
104        WINDOW_SEQUENCE     win_seq,
105        const Int           weight_index,
106        const Int           delay[],
107        const Int16         buffer[],
108        const Int           buffer_offset,
109        const Int32         time_quant[],
110        Int32               predicted_samples[],    /* Q15 */
111        const Int           frame_length);
112
113#ifdef __cplusplus
114}
115#endif
116
117/*----------------------------------------------------------------------------
118; END
119----------------------------------------------------------------------------*/
120#endif
121
122
123