Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / g729postfilter.h
1 /*
2  * G.729, G729 Annex D postfilter
3  * Copyright (c) 2008 Vladimir Voroshilov
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #ifndef FFMPEG_G729POSTFILTER_H
22 #define FFMPEG_G729POSTFILTER_H
23
24 #include <stdint.h>
25
26 /**
27  * tilt compensation factor (G.729, k1>0)
28  * 0.2 in Q15
29  */
30 #define G729_TILT_FACTOR_PLUS       6554
31
32 /**
33  * tilt compensation factor (G.729, k1<0)
34  * 0.9 in Q15
35  */
36 #define G729_TILT_FACTOR_MINUS     29491
37
38 /* 4.2.2 */
39 #define FORMANT_PP_FACTOR_NUM  18022             //0.55 in Q15
40 #define FORMANT_PP_FACTOR_DEN  22938             //0.70 in Q15
41
42 /**
43  * gain adjustment factor (G.729, 4.2.4)
44  * 0.9875 in Q15
45  */
46 #define G729_AGC_FACTOR            32358
47 #define G729_AGC_FAC1 (32768-G729_AGC_FACTOR)
48
49 /**
50  * 1.0 / (1.0 + 0.5) in Q15
51  * where 0.5 is the minimum value of
52  * weight factor, controlling amount of long-term postfiltering
53  */
54 #define MIN_LT_FILT_FACTOR_A       21845
55
56 /**
57  * Short interpolation filter length
58  */
59 #define SHORT_INT_FILT_LEN         2
60
61 /**
62  * Long interpolation filter length
63  */
64 #define LONG_INT_FILT_LEN          8
65
66 /**
67  * Number of analyzed fractional pitch delays in second stage of long-term
68  * postfilter
69  */
70 #define ANALYZED_FRAC_DELAYS       7
71
72 /**
73  * Amount of past residual signal data stored in buffer
74  */
75 #define RES_PREV_DATA_SIZE (PITCH_DELAY_MAX + LONG_INT_FILT_LEN + 1)
76
77 /**
78  * \brief Signal postfiltering (4.2)
79  * \param dsp initialized DSP context
80  * \param ht_prev_data [in/out] (Q12) pointer to variable receiving tilt
81  *                     compensation filter data from previous subframe
82  * \param voicing [in/out] (Q0) pointer to variable receiving voicing decision
83  * \param lp_filter_coeffs (Q12) LP filter coefficients
84  * \param pitch_delay_int integer part of the pitch delay
85  * \param residual [in/out] (Q0) residual signal buffer (used in long-term postfilter)
86  * \param res_filter_data [in/out] (Q0) speech data of previous subframe
87  * \param pos_filter_data [in/out] (Q0) previous speech data for short-term postfilter
88  * \param speech [in/out] (Q0) signal buffer
89  * \param subframe_size size of subframe
90  *
91  * Filtering has the following  stages:
92  *   Long-term postfilter (4.2.1)
93  *   Short-term postfilter (4.2.2).
94  *   Tilt-compensation (4.2.3)
95  */
96 void ff_g729_postfilter(DSPContext *dsp, int16_t* ht_prev_data, int* voicing,
97                      const int16_t *lp_filter_coeffs, int pitch_delay_int,
98                      int16_t* residual, int16_t* res_filter_data,
99                      int16_t* pos_filter_data, int16_t *speech,
100                      int subframe_size);
101
102 /**
103  * \brief Adaptive gain control (4.2.4)
104  * \param gain_before (Q0) gain of speech before applying postfilters
105  * \param gain_after  (Q0) gain of speech after applying postfilters
106  * \param speech [in/out] (Q0) signal buffer
107  * \param subframe_size length of subframe
108  * \param gain_prev (Q12) previous value of gain coefficient
109  *
110  * \return (Q12) last value of gain coefficient
111  */
112 int16_t ff_g729_adaptive_gain_control(int gain_before, int gain_after, int16_t *speech,
113                                    int subframe_size, int16_t gain_prev);
114
115 #endif // FFMPEG_G729POSTFILTER_H