avfilter: add sidechaingate filter
[ffmpeg.git] / libavfilter / af_agate.c
1 /*
2  * Copyright (C) 2001-2010 Krzysztof Foltman, Markus Schmidt, Thor Harald Johansen, Damien Zammit
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 /**
22  * @file
23  * Audio (Sidechain) Gate filter
24  */
25
26 #include "libavutil/avassert.h"
27 #include "libavutil/channel_layout.h"
28 #include "libavutil/opt.h"
29 #include "avfilter.h"
30 #include "audio.h"
31 #include "formats.h"
32 #include "hermite.h"
33
34 typedef struct AudioGateContext {
35     const AVClass *class;
36
37     double level_in;
38     double attack;
39     double release;
40     double threshold;
41     double ratio;
42     double knee;
43     double makeup;
44     double range;
45     int link;
46     int detection;
47
48     double thres;
49     double knee_start;
50     double lin_knee_stop;
51     double knee_stop;
52     double lin_slope;
53     double attack_coeff;
54     double release_coeff;
55
56     AVFrame *input_frame[2];
57 } AudioGateContext;
58
59 #define OFFSET(x) offsetof(AudioGateContext, x)
60 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
61
62 static const AVOption options[] = {
63     { "level_in",  "set input level",        OFFSET(level_in),  AV_OPT_TYPE_DOUBLE, {.dbl=1},           0.015625,   64, A },
64     { "range",     "set max gain reduction", OFFSET(range),     AV_OPT_TYPE_DOUBLE, {.dbl=0.06125},     0, 1, A },
65     { "threshold", "set threshold",          OFFSET(threshold), AV_OPT_TYPE_DOUBLE, {.dbl=0.125},       0, 1, A },
66     { "ratio",     "set ratio",              OFFSET(ratio),     AV_OPT_TYPE_DOUBLE, {.dbl=2},           1,  9000, A },
67     { "attack",    "set attack",             OFFSET(attack),    AV_OPT_TYPE_DOUBLE, {.dbl=20},          0.01, 9000, A },
68     { "release",   "set release",            OFFSET(release),   AV_OPT_TYPE_DOUBLE, {.dbl=250},         0.01, 9000, A },
69     { "makeup",    "set makeup gain",        OFFSET(makeup),    AV_OPT_TYPE_DOUBLE, {.dbl=1},           1,   64, A },
70     { "knee",      "set knee",               OFFSET(knee),      AV_OPT_TYPE_DOUBLE, {.dbl=2.828427125}, 1,    8, A },
71     { "detection", "set detection",          OFFSET(detection), AV_OPT_TYPE_INT,    {.i64=0},           0,    1, A, "detection" },
72     {   "peak",    0,                        0,                 AV_OPT_TYPE_CONST,  {.i64=0},           0,    0, A, "detection" },
73     {   "rms",     0,                        0,                 AV_OPT_TYPE_CONST,  {.i64=1},           0,    0, A, "detection" },
74     { "link",      "set link",               OFFSET(link),      AV_OPT_TYPE_INT,    {.i64=0},           0,    1, A, "link" },
75     {   "average", 0,                        0,                 AV_OPT_TYPE_CONST,  {.i64=0},           0,    0, A, "link" },
76     {   "maximum", 0,                        0,                 AV_OPT_TYPE_CONST,  {.i64=1},           0,    0, A, "link" },
77     { NULL }
78 };
79
80 #define agate_options options
81 AVFILTER_DEFINE_CLASS(agate);
82
83 static int query_formats(AVFilterContext *ctx)
84 {
85     AVFilterFormats *formats = NULL;
86     AVFilterChannelLayouts *layouts;
87     int ret;
88
89     if ((ret = ff_add_format(&formats, AV_SAMPLE_FMT_DBL)) < 0)
90         return ret;
91     ret = ff_set_common_formats(ctx, formats);
92     if (ret < 0)
93         return ret;
94
95     layouts = ff_all_channel_counts();
96     if (!layouts)
97         return AVERROR(ENOMEM);
98     ret = ff_set_common_channel_layouts(ctx, layouts);
99     if (ret < 0)
100         return ret;
101
102     formats = ff_all_samplerates();
103     if (!formats)
104         return AVERROR(ENOMEM);
105
106     return ff_set_common_samplerates(ctx, formats);
107 }
108
109 static int agate_config_input(AVFilterLink *inlink)
110 {
111     AVFilterContext *ctx = inlink->dst;
112     AudioGateContext *s = ctx->priv;
113     double lin_threshold = s->threshold;
114     double lin_knee_sqrt = sqrt(s->knee);
115     double lin_knee_start;
116
117     if (s->detection)
118         lin_threshold *= lin_threshold;
119
120     s->attack_coeff  = FFMIN(1., 1. / (s->attack * inlink->sample_rate / 4000.));
121     s->release_coeff = FFMIN(1., 1. / (s->release * inlink->sample_rate / 4000.));
122     s->lin_knee_stop = lin_threshold * lin_knee_sqrt;
123     lin_knee_start = lin_threshold / lin_knee_sqrt;
124     s->thres = log(lin_threshold);
125     s->knee_start = log(lin_knee_start);
126     s->knee_stop = log(s->lin_knee_stop);
127
128     return 0;
129 }
130
131 // A fake infinity value (because real infinity may break some hosts)
132 #define FAKE_INFINITY (65536.0 * 65536.0)
133
134 // Check for infinity (with appropriate-ish tolerance)
135 #define IS_FAKE_INFINITY(value) (fabs(value-FAKE_INFINITY) < 1.0)
136
137 static double output_gain(double lin_slope, double ratio, double thres,
138                           double knee, double knee_start, double knee_stop,
139                           double lin_knee_stop, double range)
140 {
141     if (lin_slope < lin_knee_stop) {
142         double slope = log(lin_slope);
143         double tratio = ratio;
144         double gain = 0.;
145         double delta = 0.;
146
147         if (IS_FAKE_INFINITY(ratio))
148             tratio = 1000.;
149         gain = (slope - thres) * tratio + thres;
150         delta = tratio;
151
152         if (knee > 1. && slope > knee_start) {
153             gain = hermite_interpolation(slope, knee_start, knee_stop, ((knee_start - thres) * tratio  + thres), knee_stop, delta, 1.);
154         }
155         return FFMAX(range, exp(gain - slope));
156     }
157
158     return 1.;
159 }
160
161 static void gate(AudioGateContext *s, const double *src, double *dst, const double *scsrc,
162                  int nb_samples, AVFilterLink *inlink, AVFilterLink *sclink)
163 {
164     const double makeup = s->makeup;
165     const double attack_coeff = s->attack_coeff;
166     const double release_coeff = s->release_coeff;
167     const double level_in = s->level_in;
168     int n, c;
169
170     for (n = 0; n < nb_samples; n++, src += inlink->channels, dst += inlink->channels, scsrc += sclink->channels) {
171         double abs_sample = fabs(scsrc[0]), gain = 1.0;
172
173         for (c = 0; c < inlink->channels; c++)
174             dst[c] = src[c] * level_in;
175
176         if (s->link == 1) {
177             for (c = 1; c < sclink->channels; c++)
178                 abs_sample = FFMAX(fabs(scsrc[c]), abs_sample);
179         } else {
180             for (c = 1; c < sclink->channels; c++)
181                 abs_sample += fabs(scsrc[c]);
182
183             abs_sample /= sclink->channels;
184         }
185
186         if (s->detection)
187             abs_sample *= abs_sample;
188
189         s->lin_slope += (abs_sample - s->lin_slope) * (abs_sample > s->lin_slope ? attack_coeff : release_coeff);
190         if (s->lin_slope > 0.0)
191             gain = output_gain(s->lin_slope, s->ratio, s->thres,
192                                s->knee, s->knee_start, s->knee_stop,
193                                s->lin_knee_stop, s->range);
194
195         for (c = 0; c < inlink->channels; c++)
196             dst[c] *= gain * makeup;
197     }
198 }
199
200 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
201 {
202     const double *src = (const double *)in->data[0];
203     AVFilterContext *ctx = inlink->dst;
204     AVFilterLink *outlink = ctx->outputs[0];
205     AudioGateContext *s = ctx->priv;
206     AVFrame *out;
207     double *dst;
208
209     if (av_frame_is_writable(in)) {
210         out = in;
211     } else {
212         out = ff_get_audio_buffer(inlink, in->nb_samples);
213         if (!out) {
214             av_frame_free(&in);
215             return AVERROR(ENOMEM);
216         }
217         av_frame_copy_props(out, in);
218     }
219     dst = (double *)out->data[0];
220
221     gate(s, src, dst, src, in->nb_samples, inlink, inlink);
222
223     if (out != in)
224         av_frame_free(&in);
225     return ff_filter_frame(outlink, out);
226 }
227
228 static const AVFilterPad inputs[] = {
229     {
230         .name         = "default",
231         .type         = AVMEDIA_TYPE_AUDIO,
232         .filter_frame = filter_frame,
233         .config_props = agate_config_input,
234     },
235     { NULL }
236 };
237
238 static const AVFilterPad outputs[] = {
239     {
240         .name = "default",
241         .type = AVMEDIA_TYPE_AUDIO,
242     },
243     { NULL }
244 };
245
246 AVFilter ff_af_agate = {
247     .name           = "agate",
248     .description    = NULL_IF_CONFIG_SMALL("Audio gate."),
249     .query_formats  = query_formats,
250     .priv_size      = sizeof(AudioGateContext),
251     .priv_class     = &agate_class,
252     .inputs         = inputs,
253     .outputs        = outputs,
254 };
255
256 #if CONFIG_SIDECHAINGATE_FILTER
257
258 #define sidechaingate_options options
259 AVFILTER_DEFINE_CLASS(sidechaingate);
260
261 static int scfilter_frame(AVFilterLink *link, AVFrame *in)
262 {
263     AVFilterContext *ctx = link->dst;
264     AudioGateContext *s = ctx->priv;
265     AVFilterLink *outlink = ctx->outputs[0];
266     const double *scsrc;
267     double *sample;
268     int nb_samples;
269     int ret, i;
270
271     for (i = 0; i < 2; i++)
272         if (link == ctx->inputs[i])
273             break;
274     av_assert0(i < 2 && !s->input_frame[i]);
275     s->input_frame[i] = in;
276
277     if (!s->input_frame[0] || !s->input_frame[1])
278         return 0;
279
280     nb_samples = FFMIN(s->input_frame[0]->nb_samples,
281                        s->input_frame[1]->nb_samples);
282
283     sample = (double *)s->input_frame[0]->data[0];
284     scsrc = (const double *)s->input_frame[1]->data[0];
285
286     gate(s, sample, sample, scsrc, nb_samples,
287          ctx->inputs[0], ctx->inputs[1]);
288     ret = ff_filter_frame(outlink, s->input_frame[0]);
289
290     s->input_frame[0] = NULL;
291     av_frame_free(&s->input_frame[1]);
292
293     return ret;
294 }
295
296 static int screquest_frame(AVFilterLink *outlink)
297 {
298     AVFilterContext *ctx = outlink->src;
299     AudioGateContext *s = ctx->priv;
300     int i, ret;
301
302     /* get a frame on each input */
303     for (i = 0; i < 2; i++) {
304         AVFilterLink *inlink = ctx->inputs[i];
305         if (!s->input_frame[i] &&
306             (ret = ff_request_frame(inlink)) < 0)
307             return ret;
308
309         /* request the same number of samples on all inputs */
310         if (i == 0)
311             ctx->inputs[1]->request_samples = s->input_frame[0]->nb_samples;
312     }
313
314     return 0;
315 }
316
317 static int scquery_formats(AVFilterContext *ctx)
318 {
319     AVFilterFormats *formats;
320     AVFilterChannelLayouts *layouts = NULL;
321     static const enum AVSampleFormat sample_fmts[] = {
322         AV_SAMPLE_FMT_DBL,
323         AV_SAMPLE_FMT_NONE
324     };
325     int ret, i;
326
327     if (!ctx->inputs[0]->in_channel_layouts ||
328         !ctx->inputs[0]->in_channel_layouts->nb_channel_layouts) {
329         av_log(ctx, AV_LOG_WARNING,
330                "No channel layout for input 1\n");
331             return AVERROR(EAGAIN);
332     }
333
334     if ((ret = ff_add_channel_layout(&layouts, ctx->inputs[0]->in_channel_layouts->channel_layouts[0])) < 0 ||
335         (ret = ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts)) < 0)
336         return ret;
337
338     for (i = 0; i < 2; i++) {
339         layouts = ff_all_channel_counts();
340         if ((ret = ff_channel_layouts_ref(layouts, &ctx->inputs[i]->out_channel_layouts)) < 0)
341             return ret;
342     }
343
344     formats = ff_make_format_list(sample_fmts);
345     if ((ret = ff_set_common_formats(ctx, formats)) < 0)
346         return ret;
347
348     formats = ff_all_samplerates();
349     return ff_set_common_samplerates(ctx, formats);
350 }
351
352 static int scconfig_output(AVFilterLink *outlink)
353 {
354     AVFilterContext *ctx = outlink->src;
355
356     if (ctx->inputs[0]->sample_rate != ctx->inputs[1]->sample_rate) {
357         av_log(ctx, AV_LOG_ERROR,
358                "Inputs must have the same sample rate "
359                "%d for in0 vs %d for in1\n",
360                ctx->inputs[0]->sample_rate, ctx->inputs[1]->sample_rate);
361         return AVERROR(EINVAL);
362     }
363
364     outlink->sample_rate = ctx->inputs[0]->sample_rate;
365     outlink->time_base   = ctx->inputs[0]->time_base;
366     outlink->channel_layout = ctx->inputs[0]->channel_layout;
367     outlink->channels = ctx->inputs[0]->channels;
368
369     agate_config_input(ctx->inputs[0]);
370
371     return 0;
372 }
373
374 static const AVFilterPad sidechaingate_inputs[] = {
375     {
376         .name           = "main",
377         .type           = AVMEDIA_TYPE_AUDIO,
378         .filter_frame   = scfilter_frame,
379         .needs_writable = 1,
380         .needs_fifo     = 1,
381     },{
382         .name           = "sidechain",
383         .type           = AVMEDIA_TYPE_AUDIO,
384         .filter_frame   = scfilter_frame,
385         .needs_fifo     = 1,
386     },
387     { NULL }
388 };
389
390 static const AVFilterPad sidechaingate_outputs[] = {
391     {
392         .name          = "default",
393         .type          = AVMEDIA_TYPE_AUDIO,
394         .config_props  = scconfig_output,
395         .request_frame = screquest_frame,
396     },
397     { NULL }
398 };
399
400 AVFilter ff_af_sidechaingate = {
401     .name           = "sidechaingate",
402     .description    = NULL_IF_CONFIG_SMALL("Audio sidechain gate."),
403     .priv_size      = sizeof(AudioGateContext),
404     .priv_class     = &sidechaingate_class,
405     .query_formats  = scquery_formats,
406     .inputs         = sidechaingate_inputs,
407     .outputs        = sidechaingate_outputs,
408 };
409 #endif  /* CONFIG_SIDECHAINGATE_FILTER */