avfilter: add arbitrary audio IIR filter
[ffmpeg.git] / libavfilter / af_aiir.c
1 /*
2  * Copyright (c) 2018 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include "libavutil/avassert.h"
22 #include "libavutil/avstring.h"
23 #include "libavutil/opt.h"
24 #include "audio.h"
25 #include "avfilter.h"
26 #include "internal.h"
27
28 typedef struct AudioIIRContext {
29     const AVClass *class;
30     char *a_str, *b_str;
31     double dry_gain, wet_gain;
32
33     int *nb_a, *nb_b;
34     double **a, **b;
35     double **input, **output;
36     int clippings;
37     int channels;
38
39     void (*iir_frame)(AVFilterContext *ctx, AVFrame *in, AVFrame *out);
40 } AudioIIRContext;
41
42 static int query_formats(AVFilterContext *ctx)
43 {
44     AVFilterFormats *formats;
45     AVFilterChannelLayouts *layouts;
46     static const enum AVSampleFormat sample_fmts[] = {
47         AV_SAMPLE_FMT_DBLP,
48         AV_SAMPLE_FMT_FLTP,
49         AV_SAMPLE_FMT_S32P,
50         AV_SAMPLE_FMT_S16P,
51         AV_SAMPLE_FMT_NONE
52     };
53     int ret;
54
55     layouts = ff_all_channel_counts();
56     if (!layouts)
57         return AVERROR(ENOMEM);
58     ret = ff_set_common_channel_layouts(ctx, layouts);
59     if (ret < 0)
60         return ret;
61
62     formats = ff_make_format_list(sample_fmts);
63     if (!formats)
64         return AVERROR(ENOMEM);
65     ret = ff_set_common_formats(ctx, formats);
66     if (ret < 0)
67         return ret;
68
69     formats = ff_all_samplerates();
70     if (!formats)
71         return AVERROR(ENOMEM);
72     return ff_set_common_samplerates(ctx, formats);
73 }
74
75 #define IIR_FRAME(name, type, min, max, need_clipping)                  \
76 static void iir_frame_## name(AVFilterContext *ctx, AVFrame *in, AVFrame *out)  \
77 {                                                                       \
78     AudioIIRContext *s = ctx->priv;                                     \
79     const double ig = s->dry_gain;                                      \
80     const double og = s->wet_gain;                                      \
81     int ch, n;                                                          \
82                                                                         \
83     for (ch = 0; ch < out->channels; ch++) {                            \
84         const type *src = (const type *)in->extended_data[ch];          \
85         double *ic = (double *)s->input[ch];                            \
86         double *oc = (double *)s->output[ch];                           \
87         const int nb_a = s->nb_a[ch];                                   \
88         const int nb_b = s->nb_b[ch];                                   \
89         const double *a = s->a[ch];                                     \
90         const double *b = s->b[ch];                                     \
91         type *dst = (type *)out->extended_data[ch];                     \
92                                                                         \
93         for (n = 0; n < in->nb_samples; n++) {                          \
94             double sample = 0.;                                         \
95             int x;                                                      \
96                                                                         \
97             memmove(&ic[1], &ic[0], (nb_b - 1) * sizeof(*ic));          \
98             memmove(&oc[1], &oc[0], (nb_a - 1) * sizeof(*oc));          \
99             ic[0] = src[n] * ig;                                        \
100             for (x = 0; x < nb_b; x++)                                  \
101                 sample += b[x] * ic[x];                                 \
102                                                                         \
103             for (x = 1; x < nb_a; x++)                                  \
104                 sample -= a[x] * oc[x];                                 \
105                                                                         \
106             oc[0] = sample;                                             \
107             sample *= og;                                               \
108             if (need_clipping && sample < min) {                        \
109                 s->clippings++;                                         \
110                 dst[n] = min;                                           \
111             } else if (need_clipping && sample > max) {                 \
112                 s->clippings++;                                         \
113                 dst[n] = max;                                           \
114             } else {                                                    \
115                 dst[n] = sample;                                        \
116             }                                                           \
117         }                                                               \
118     }                                                                   \
119 }
120
121 IIR_FRAME(s16p, int16_t, INT16_MIN, INT16_MAX, 1)
122 IIR_FRAME(s32p, int32_t, INT32_MIN, INT32_MAX, 1)
123 IIR_FRAME(fltp, float,         -1.,        1., 0)
124 IIR_FRAME(dblp, double,        -1.,        1., 0)
125
126 static void count_coefficients(char *item_str, int *nb_items)
127 {
128     char *p;
129
130     *nb_items = 1;
131     for (p = item_str; *p && *p != '|'; p++) {
132         if (*p == ' ')
133             (*nb_items)++;
134     }
135 }
136
137 static int read_coefficients(AVFilterContext *ctx, char *item_str, int nb_items, double *dst)
138 {
139     char *p, *arg, *old_str, *saveptr = NULL;
140     int i;
141
142     p = old_str = av_strdup(item_str);
143     if (!p)
144         return AVERROR(ENOMEM);
145     for (i = 0; i < nb_items; i++) {
146         if (!(arg = av_strtok(p, " ", &saveptr)))
147             break;
148
149         p = NULL;
150         if (sscanf(arg, "%lf", &dst[i]) != 1) {
151             av_log(ctx, AV_LOG_ERROR, "Invalid coefficients supplied: %s\n", arg);
152             return AVERROR(EINVAL);
153         }
154     }
155
156     av_freep(&old_str);
157
158     return 0;
159 }
160
161 static int read_channels(AVFilterContext *ctx, int channels, uint8_t *item_str, int *nb, double **c, double **cache)
162 {
163     char *p, *arg, *old_str, *prev_arg = NULL, *saveptr = NULL;
164     int i, ret;
165
166     p = old_str = av_strdup(item_str);
167     if (!p)
168         return AVERROR(ENOMEM);
169     for (i = 0; i < channels; i++) {
170         if (!(arg = av_strtok(p, "|", &saveptr)))
171             arg = prev_arg;
172
173         p = NULL;
174         count_coefficients(arg, &nb[i]);
175         cache[i] = av_calloc(nb[i], sizeof(cache[i]));
176         c[i] = av_calloc(nb[i], sizeof(c[i]));
177         if (!c[i] || !cache[i])
178             return AVERROR(ENOMEM);
179
180         ret = read_coefficients(ctx, arg, nb[i], c[i]);
181         if (ret < 0)
182             return ret;
183         prev_arg = arg;
184     }
185
186     av_freep(&old_str);
187
188     return 0;
189 }
190
191 static int config_output(AVFilterLink *outlink)
192 {
193     AVFilterContext *ctx = outlink->src;
194     AudioIIRContext *s = ctx->priv;
195     AVFilterLink *inlink = ctx->inputs[0];
196     int ch, ret, i;
197
198     s->channels = inlink->channels;
199     s->a = av_calloc(inlink->channels, sizeof(*s->a));
200     s->b = av_calloc(inlink->channels, sizeof(*s->b));
201     s->nb_a = av_calloc(inlink->channels, sizeof(*s->nb_a));
202     s->nb_b = av_calloc(inlink->channels, sizeof(*s->nb_b));
203     s->input = av_calloc(inlink->channels, sizeof(*s->input));
204     s->output = av_calloc(inlink->channels, sizeof(*s->output));
205     if (!s->a || !s->b || !s->nb_a || !s->nb_b || !s->input || !s->output)
206         return AVERROR(ENOMEM);
207
208     ret = read_channels(ctx, inlink->channels, s->a_str, s->nb_a, s->a, s->output);
209     if (ret < 0)
210         return ret;
211
212     ret = read_channels(ctx, inlink->channels, s->b_str, s->nb_b, s->b, s->input);
213     if (ret < 0)
214         return ret;
215
216     for (ch = 0; ch < inlink->channels; ch++) {
217         for (i = 1; i < s->nb_a[ch]; i++) {
218             s->a[ch][i] /= s->a[ch][0];
219         }
220
221         for (i = 0; i < s->nb_b[ch]; i++) {
222             s->b[ch][i] /= s->a[ch][0];
223         }
224     }
225
226     switch (inlink->format) {
227     case AV_SAMPLE_FMT_DBLP: s->iir_frame = iir_frame_dblp; break;
228     case AV_SAMPLE_FMT_FLTP: s->iir_frame = iir_frame_fltp; break;
229     case AV_SAMPLE_FMT_S32P: s->iir_frame = iir_frame_s32p; break;
230     case AV_SAMPLE_FMT_S16P: s->iir_frame = iir_frame_s16p; break;
231     }
232
233     return 0;
234 }
235
236 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
237 {
238     AVFilterContext *ctx = inlink->dst;
239     AudioIIRContext *s = ctx->priv;
240     AVFilterLink *outlink = ctx->outputs[0];
241     AVFrame *out;
242
243     if (av_frame_is_writable(in)) {
244         out = in;
245     } else {
246         out = ff_get_audio_buffer(outlink, in->nb_samples);
247         if (!out) {
248             av_frame_free(&in);
249             return AVERROR(ENOMEM);
250         }
251         av_frame_copy_props(out, in);
252     }
253
254     s->iir_frame(ctx, in, out);
255
256     if (s->clippings > 0)
257         av_log(ctx, AV_LOG_WARNING, "clipping %d times. Please reduce gain.\n", s->clippings);
258     s->clippings = 0;
259
260     if (in != out)
261         av_frame_free(&in);
262
263     return ff_filter_frame(outlink, out);
264 }
265
266 static av_cold void uninit(AVFilterContext *ctx)
267 {
268     AudioIIRContext *s = ctx->priv;
269     int ch;
270
271     if (s->a) {
272         for (ch = 0; ch < s->channels; ch++) {
273             av_freep(&s->a[ch]);
274             av_freep(&s->output[ch]);
275         }
276     }
277     av_freep(&s->a);
278
279     if (s->b) {
280         for (ch = 0; ch < s->channels; ch++) {
281             av_freep(&s->b[ch]);
282             av_freep(&s->input[ch]);
283         }
284     }
285     av_freep(&s->b);
286
287     av_freep(&s->input);
288     av_freep(&s->output);
289
290     av_freep(&s->nb_a);
291     av_freep(&s->nb_b);
292 }
293
294 static const AVFilterPad inputs[] = {
295     {
296         .name         = "default",
297         .type         = AVMEDIA_TYPE_AUDIO,
298         .filter_frame = filter_frame,
299     },
300     { NULL }
301 };
302
303 static const AVFilterPad outputs[] = {
304     {
305         .name         = "default",
306         .type         = AVMEDIA_TYPE_AUDIO,
307         .config_props = config_output,
308     },
309     { NULL }
310 };
311
312 #define OFFSET(x) offsetof(AudioIIRContext, x)
313 #define AF AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
314
315 static const AVOption aiir_options[] = {
316     { "a", "set A/denominator/poles coefficients", OFFSET(a_str),    AV_OPT_TYPE_STRING, {.str="1 1"}, 0, 0, AF },
317     { "b", "set B/numerator/zeros coefficients",   OFFSET(b_str),    AV_OPT_TYPE_STRING, {.str="1 1"}, 0, 0, AF },
318     { "dry", "set dry gain",                       OFFSET(dry_gain), AV_OPT_TYPE_DOUBLE, {.dbl=1},     0, 1, AF },
319     { "wet", "set wet gain",                       OFFSET(wet_gain), AV_OPT_TYPE_DOUBLE, {.dbl=1},     0, 1, AF },
320     { NULL },
321 };
322
323 AVFILTER_DEFINE_CLASS(aiir);
324
325 AVFilter ff_af_aiir = {
326     .name          = "aiir",
327     .description   = NULL_IF_CONFIG_SMALL("Apply Infinite Impulse Response filter with supplied coefficients."),
328     .priv_size     = sizeof(AudioIIRContext),
329     .uninit        = uninit,
330     .query_formats = query_formats,
331     .inputs        = inputs,
332     .outputs       = outputs,
333     .priv_class    = &aiir_class,
334 };