7159a1ee023ca2caeb6981b43f7d27e69801f3b2
[ffmpeg.git] / libavcodec / lowpass.c
1 /*
2  * Lowpass IIR filter
3  * Copyright (c) 2008 Konstantin Shishkov
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
22 /**
23  * @file lowpass.c
24  * lowpass filter implementation
25  */
26
27 #include "lowpass.h"
28
29 /**********************
30  *         TODO:
31  * support filters with order != 4
32  * calculate coefficients for filter instead of taking approximate ones from the table
33  *********************/
34
35 /** filter order */
36 #define LOWPASS_FILTER_ORDER 4
37
38 /**
39  * IIR filter global parameters
40  */
41 typedef struct FFLPFilterCoeffs{
42     float gain;
43     float c[LOWPASS_FILTER_ORDER];
44 }FFLPFilterCoeffs;
45
46 /**
47  * filter data for 4th order IIR lowpass Butterworth filter
48  */
49 static const FFLPFilterCoeffs lp_filter_coeffs[] = {
50     { 9.398085e-01, { -0.0176648009,  0.0000000000, -0.4860288221,  0.0000000000 } },
51     { 6.816645e-01, { -0.4646665999, -2.2127207402, -3.9912017501, -3.2380429984 } },
52     { 4.998150e-01, { -0.2498216698, -1.3392807613, -2.7693097862, -2.6386277439 } },
53     { 3.103469e-01, { -0.0965076902, -0.5977763360, -1.4972580903, -1.7740085241 } },
54     { 2.346995e-01, { -0.0557639007, -0.3623690447, -1.0304538354, -1.3066051440 } },
55     { 1.528432e-01, { -0.0261686639, -0.1473794606, -0.6204721225, -0.6514716536 } },
56     { 6.917529e-02, { -0.0202414073,  0.0780167640, -0.5277442247,  0.3631641670 } },
57     { 6.178391e-02, { -0.0223681543,  0.1069446609, -0.5615167033,  0.4883976841 } },
58     { 5.298685e-02, { -0.0261686639,  0.1473794606, -0.6204721225,  0.6514716536 } },
59     { 2.229030e-02, { -0.0647354087,  0.4172275190, -1.1412129810,  1.4320761385 } },
60     { 1.693903e-02, { -0.0823177861,  0.5192354923, -1.3444768251,  1.6365345642 } },
61     { 7.374053e-03, { -0.1481421788,  0.8650973862, -1.9894244796,  2.1544844308 } },
62     { 5.541768e-03, { -0.1742301048,  0.9921936565, -2.2090801108,  2.3024482658 } },
63 };
64
65 /** cutoff ratios for lp_filter_data[] */
66 static const float lp_cutoff_ratios[] = {
67     0.5000000000, 0.4535147392, 0.4166666667, 0.3628117914,
68     0.3333333333, 0.2916666667, 0.2267573696, 0.2187500000,
69     0.2083333333, 0.1587301587, 0.1458333333, 0.1133786848,
70     0.1041666667,
71 };
72
73 /**
74  * IIR filter state
75  */
76 typedef struct FFLPFilterState{
77     float x[LOWPASS_FILTER_ORDER];
78 }FFLPFilterState;
79
80 const struct FFLPFilterCoeffs* ff_lowpass_filter_init_coeffs(int order, float cutoff_ratio)
81 {
82     int i, size;
83
84     //we can create only order-4 filters with cutoff ratio <= 0.5 for now
85     if(order != LOWPASS_FILTER_ORDER) return NULL;
86
87     size = sizeof(lp_cutoff_ratios) / sizeof(lp_cutoff_ratios[0]);
88     if(cutoff_ratio > lp_cutoff_ratios[0])
89         return NULL;
90     for(i = 0; i < size; i++){
91         if(cutoff_ratio >= lp_cutoff_ratios[i])
92             break;
93     }
94     if(i == size)
95         i = size - 1;
96     return &lp_filter_coeffs[i];
97 }
98
99 struct FFLPFilterState* ff_lowpass_filter_init_state(int order)
100 {
101     if(order != LOWPASS_FILTER_ORDER) return NULL;
102     return av_mallocz(sizeof(FFLPFilterState));
103 }
104
105 #define FILTER(i0, i1, i2, i3)                  \
106     in =   *src * c->gain                       \
107          + c->c[0]*s->x[i0] + c->c[1]*s->x[i1]  \
108          + c->c[2]*s->x[i2] + c->c[3]*s->x[i3]; \
109     res =  (s->x[i0] + in      )*1              \
110          + (s->x[i1] + s->x[i3])*4              \
111          +  s->x[i2]            *6;             \
112     *dst = av_clip_int16(lrintf(res));          \
113     s->x[i0] = in;                              \
114     src += sstep;                               \
115     dst += dstep;                               \
116
117 void ff_lowpass_filter(const struct FFLPFilterCoeffs *c, struct FFLPFilterState *s, int size, int16_t *src, int sstep, int16_t *dst, int dstep)
118 {
119     int i;
120
121     for(i = 0; i < size; i += 4){
122         float in, res;
123
124         FILTER(0, 1, 2, 3);
125         FILTER(1, 2, 3, 0);
126         FILTER(2, 3, 0, 1);
127         FILTER(3, 0, 1, 2);
128     }
129 }