Cleanup comment for ff_acelp_interp_filter.
[ffmpeg.git] / libavcodec / acelp_filters.h
1 /*
2  * various filters for ACELP-based codecs
3  *
4  * Copyright (c) 2008 Vladimir Voroshilov
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef FFMPEG_ACELP_FILTERS_H
24 #define FFMPEG_ACELP_FILTERS_H
25
26 #include <stdint.h>
27
28 /**
29  * low-pass Finite Impulse Response filter coefficients.
30  *
31  * Hamming windowed sinc filter with cutoff freq 3/40 of the sampling freq.
32  * This array only contains the right half of the filter.
33  * This filter is likely identical to the one used in G.729, though this
34  * could not be determined from the original comments with certainity.
35  */
36 extern const int16_t ff_acelp_interp_filter[61];
37
38 /**
39  * Generic interpolation routine.
40  * @param out [out] buffer for interpolated data
41  * @param in input data
42  * @param filter_coeffs interpolation filter coefficients (0.15)
43  * @param precision filter is able to interpolate with 1/precision precision of pitch delay
44  * @param pitch_delay_frac pitch delay, fractional part [0..precision-1]
45  * @param filter_length filter length
46  * @param length length of speech data to process
47  *
48  * filter_coeffs contains coefficients of the positive half of the symmetric
49  * interpolation filter. filter_coeffs[0] should the central (unpaired) coefficient.
50  * See ff_acelp_interp_filter for an example.
51  *
52  */
53 void ff_acelp_interpolate(
54         int16_t* out,
55         const int16_t* in,
56         const int16_t* filter_coeffs,
57         int precision,
58         int pitch_delay_frac,
59         int filter_length,
60         int length);
61
62 /**
63  * Circularly convolve fixed vector with a phase dispersion impulse
64  *        response filter (D.6.2 of G.729 and 6.1.5 of AMR).
65  * @param fc_out vector with filter applied
66  * @param fc_in source vector
67  * @param filter phase filter coefficients
68  *
69  *  fc_out[n] = sum(i,0,len-1){ fc_in[i] * filter[(len + n - i)%len] }
70  *
71  * \note fc_in and fc_out should not overlap!
72  */
73 void ff_acelp_convolve_circ(
74         int16_t* fc_out,
75         const int16_t* fc_in,
76         const int16_t* filter,
77         int subframe_size);
78
79 /**
80  * LP synthesis filter.
81  * @param out [out] pointer to output buffer
82  * @param filter_coeffs filter coefficients (-0x8000 <= (3.12) < 0x8000)
83  * @param in input signal
84  * @param buffer_length amount of data to process
85  * @param filter_length filter length (10 for 10th order LP filter)
86  * @param stop_on_overflow   1 - return immediately if overflow occurs
87  *                           0 - ignore overflows
88  * @param rounder the amount to add for rounding (usually 0x800 or 0xfff)
89  *
90  * @return 1 if overflow occurred, 0 - otherwise
91  *
92  * @note Output buffer must contain 10 samples of past
93  *       speech data before pointer.
94  *
95  * Routine applies 1/A(z) filter to given speech data.
96  */
97 int ff_acelp_lp_synthesis_filter(
98         int16_t *out,
99         const int16_t* filter_coeffs,
100         const int16_t* in,
101         int buffer_length,
102         int filter_length,
103         int stop_on_overflow,
104         int rounder);
105
106 /**
107  * Calculates coefficients of weighted A(z/weight) filter.
108  * @param out [out] weighted A(z/weight) result
109  *                  filter (-0x8000 <= (3.12) < 0x8000)
110  * @param in source filter (-0x8000 <= (3.12) < 0x8000)
111  * @param weight_pow array containing weight^i (-0x8000 <= (0.15) < 0x8000)
112  * @param filter_length filter length (11 for 10th order LP filter)
113  *
114  * out[i]=weight_pow[i]*in[i] , i=0..9
115  */
116 void ff_acelp_weighted_filter(
117         int16_t *out,
118         const int16_t* in,
119         const int16_t *weight_pow,
120         int filter_length);
121
122 /**
123  * high-pass filtering and upscaling (4.2.5 of G.729).
124  * @param out [out] output buffer for filtered speech data
125  * @param hpf_f [in/out] past filtered data from previous (2 items long)
126  *                       frames (-0x20000000 <= (14.13) < 0x20000000)
127  * @param in speech data to process
128  * @param length input data size
129  *
130  * out[i] = 0.93980581 * in[i] - 1.8795834 * in[i-1] + 0.93980581 * in[i-2] +
131  *          1.9330735 * out[i-1] - 0.93589199 * out[i-2]
132  *
133  * The filter has a cut-off frequency of 100Hz
134  *
135  * @note Two items before the top of the out buffer must contain two items from the
136  *       tail of the previous subframe.
137  *
138  * @remark It is safe to pass the same array in in and out parameters.
139  *
140  * @remark AMR uses mostly the same filter (cut-off frequency 60Hz, same formula,
141  *         but constants differs in 5th sign after comma). Fortunately in
142  *         fixed-point all coefficients are the same as in G.729. Thus this
143  *         routine can be used for the fixed-point AMR decoder, too.
144  */
145 void ff_acelp_high_pass_filter(
146         int16_t* out,
147         int hpf_f[2],
148         const int16_t* in,
149         int length);
150
151 #endif /* FFMPEG_ACELP_FILTERS_H */