24472f7985568ef6bd76e03d682878229276063a
[ffmpeg.git] / libavfilter / af_compand.c
1 /*
2  * Copyright (c) 1999 Chris Bagwell
3  * Copyright (c) 1999 Nick Bailey
4  * Copyright (c) 2007 Rob Sykes <robs@users.sourceforge.net>
5  * Copyright (c) 2013 Paul B Mahol
6  * Copyright (c) 2014 Andrew Kelley
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25
26 /**
27  * @file
28  * audio compand filter
29  */
30
31 #include "libavutil/avassert.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/samplefmt.h"
35 #include "avfilter.h"
36 #include "audio.h"
37 #include "internal.h"
38
39 typedef struct ChanParam {
40     double attack;
41     double decay;
42     double volume;
43 } ChanParam;
44
45 typedef struct CompandSegment {
46     double x, y;
47     double a, b;
48 } CompandSegment;
49
50 typedef struct CompandContext {
51     const AVClass *class;
52     char *attacks, *decays, *points;
53     CompandSegment *segments;
54     ChanParam *channels;
55     int nb_segments;
56     double in_min_lin;
57     double out_min_lin;
58     double curve_dB;
59     double gain_dB;
60     double initial_volume;
61     double delay;
62     AVFrame *delay_frame;
63     int delay_samples;
64     int delay_count;
65     int delay_index;
66     int64_t pts;
67
68     int (*compand)(AVFilterContext *ctx, AVFrame *frame);
69 } CompandContext;
70
71 #define OFFSET(x) offsetof(CompandContext, x)
72 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
73
74 static const AVOption compand_options[] = {
75     { "attacks", "set time over which increase of volume is determined", OFFSET(attacks), AV_OPT_TYPE_STRING, { .str = "0.3" }, 0, 0, A },
76     { "decays", "set time over which decrease of volume is determined", OFFSET(decays), AV_OPT_TYPE_STRING, { .str = "0.8" }, 0, 0, A },
77     { "points", "set points of transfer function", OFFSET(points), AV_OPT_TYPE_STRING, { .str = "-70/-70|-60/-20" }, 0, 0, A },
78     { "soft-knee", "set soft-knee", OFFSET(curve_dB), AV_OPT_TYPE_DOUBLE, { .dbl = 0.01 }, 0.01, 900, A },
79     { "gain", "set output gain", OFFSET(gain_dB), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, -900, 900, A },
80     { "volume", "set initial volume", OFFSET(initial_volume), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, -900, 0, A },
81     { "delay", "set delay for samples before sending them to volume adjuster", OFFSET(delay), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, 0, 20, A },
82     { NULL }
83 };
84
85 AVFILTER_DEFINE_CLASS(compand);
86
87 static av_cold int init(AVFilterContext *ctx)
88 {
89     CompandContext *s = ctx->priv;
90     s->pts            = AV_NOPTS_VALUE;
91     return 0;
92 }
93
94 static av_cold void uninit(AVFilterContext *ctx)
95 {
96     CompandContext *s = ctx->priv;
97
98     av_freep(&s->channels);
99     av_freep(&s->segments);
100     av_frame_free(&s->delay_frame);
101 }
102
103 static int query_formats(AVFilterContext *ctx)
104 {
105     AVFilterChannelLayouts *layouts;
106     AVFilterFormats *formats;
107     static const enum AVSampleFormat sample_fmts[] = {
108         AV_SAMPLE_FMT_DBLP,
109         AV_SAMPLE_FMT_NONE
110     };
111
112     layouts = ff_all_channel_layouts();
113     if (!layouts)
114         return AVERROR(ENOMEM);
115     ff_set_common_channel_layouts(ctx, layouts);
116
117     formats = ff_make_format_list(sample_fmts);
118     if (!formats)
119         return AVERROR(ENOMEM);
120     ff_set_common_formats(ctx, formats);
121
122     formats = ff_all_samplerates();
123     if (!formats)
124         return AVERROR(ENOMEM);
125     ff_set_common_samplerates(ctx, formats);
126
127     return 0;
128 }
129
130 static void count_items(char *item_str, int *nb_items)
131 {
132     char *p;
133
134     *nb_items = 1;
135     for (p = item_str; *p; p++) {
136         if (*p == ' ' || *p == '|')
137             (*nb_items)++;
138     }
139 }
140
141 static void update_volume(ChanParam *cp, double in)
142 {
143     double delta = in - cp->volume;
144
145     if (delta > 0.0)
146         cp->volume += delta * cp->attack;
147     else
148         cp->volume += delta * cp->decay;
149 }
150
151 static double get_volume(CompandContext *s, double in_lin)
152 {
153     CompandSegment *cs;
154     double in_log, out_log;
155     int i;
156
157     if (in_lin < s->in_min_lin)
158         return s->out_min_lin;
159
160     in_log = log(in_lin);
161
162     for (i = 1; i < s->nb_segments; i++)
163         if (in_log <= s->segments[i].x)
164             break;
165     cs = &s->segments[i - 1];
166     in_log -= cs->x;
167     out_log = cs->y + in_log * (cs->a * in_log + cs->b);
168
169     return exp(out_log);
170 }
171
172 static int compand_nodelay(AVFilterContext *ctx, AVFrame *frame)
173 {
174     CompandContext *s    = ctx->priv;
175     AVFilterLink *inlink = ctx->inputs[0];
176     const int channels = inlink->channels;
177     const int nb_samples = frame->nb_samples;
178     AVFrame *out_frame;
179     int chan, i;
180     int err;
181
182     if (av_frame_is_writable(frame)) {
183         out_frame = frame;
184     } else {
185         out_frame = ff_get_audio_buffer(inlink, nb_samples);
186         if (!out_frame) {
187             av_frame_free(&frame);
188             return AVERROR(ENOMEM);
189         }
190         err = av_frame_copy_props(out_frame, frame);
191         if (err < 0) {
192             av_frame_free(&out_frame);
193             av_frame_free(&frame);
194             return err;
195         }
196     }
197
198     for (chan = 0; chan < channels; chan++) {
199         const double *src = (double *)frame->extended_data[chan];
200         double *dst = (double *)out_frame->extended_data[chan];
201         ChanParam *cp = &s->channels[chan];
202
203         for (i = 0; i < nb_samples; i++) {
204             update_volume(cp, fabs(src[i]));
205
206             dst[i] = av_clipd(src[i] * get_volume(s, cp->volume), -1, 1);
207         }
208     }
209
210     if (frame != out_frame)
211         av_frame_free(&frame);
212
213     return ff_filter_frame(ctx->outputs[0], out_frame);
214 }
215
216 #define MOD(a, b) (((a) >= (b)) ? (a) - (b) : (a))
217
218 static int compand_delay(AVFilterContext *ctx, AVFrame *frame)
219 {
220     CompandContext *s    = ctx->priv;
221     AVFilterLink *inlink = ctx->inputs[0];
222     const int channels = inlink->channels;
223     const int nb_samples = frame->nb_samples;
224     int chan, i, av_uninit(dindex), oindex, av_uninit(count);
225     AVFrame *out_frame   = NULL;
226     int err;
227
228     if (s->pts == AV_NOPTS_VALUE) {
229         s->pts = (frame->pts == AV_NOPTS_VALUE) ? 0 : frame->pts;
230     }
231
232     av_assert1(channels > 0); /* would corrupt delay_count and delay_index */
233
234     for (chan = 0; chan < channels; chan++) {
235         AVFrame *delay_frame = s->delay_frame;
236         const double *src = (double *)frame->extended_data[chan];
237         double *dbuf      = (double *)delay_frame->extended_data[chan];
238         ChanParam *cp        = &s->channels[chan];
239         double *dst;
240
241         count  = s->delay_count;
242         dindex = s->delay_index;
243         for (i = 0, oindex = 0; i < nb_samples; i++) {
244             const double in = src[i];
245             update_volume(cp, fabs(in));
246
247             if (count >= s->delay_samples) {
248                 if (!out_frame) {
249                     out_frame = ff_get_audio_buffer(inlink, nb_samples - i);
250                     if (!out_frame) {
251                         av_frame_free(&frame);
252                         return AVERROR(ENOMEM);
253                     }
254                     err = av_frame_copy_props(out_frame, frame);
255                     if (err < 0) {
256                         av_frame_free(&out_frame);
257                         av_frame_free(&frame);
258                         return err;
259                     }
260                     out_frame->pts = s->pts;
261                     s->pts += av_rescale_q(nb_samples - i,
262                         (AVRational){ 1, inlink->sample_rate },
263                         inlink->time_base);
264                 }
265
266                 dst = (double *)out_frame->extended_data[chan];
267                 dst[oindex++] = av_clipd(dbuf[dindex] *
268                         get_volume(s, cp->volume), -1, 1);
269             } else {
270                 count++;
271             }
272
273             dbuf[dindex] = in;
274             dindex = MOD(dindex + 1, s->delay_samples);
275         }
276     }
277
278     s->delay_count = count;
279     s->delay_index = dindex;
280
281     av_frame_free(&frame);
282     return out_frame ? ff_filter_frame(ctx->outputs[0], out_frame) : 0;
283 }
284
285 static int compand_drain(AVFilterLink *outlink)
286 {
287     AVFilterContext *ctx = outlink->src;
288     CompandContext *s    = ctx->priv;
289     const int channels = outlink->channels;
290     int chan, i, dindex;
291     AVFrame *frame = NULL;
292
293     frame = ff_get_audio_buffer(outlink, FFMIN(2048, s->delay_count));
294     if (!frame)
295         return AVERROR(ENOMEM);
296     frame->pts = s->pts;
297     s->pts += av_rescale_q(frame->nb_samples,
298             (AVRational){ 1, outlink->sample_rate }, outlink->time_base);
299
300     for (chan = 0; chan < channels; chan++) {
301         AVFrame *delay_frame = s->delay_frame;
302         double *dbuf = (double *)delay_frame->extended_data[chan];
303         double *dst = (double *)frame->extended_data[chan];
304         ChanParam *cp = &s->channels[chan];
305
306         dindex = s->delay_index;
307         for (i = 0; i < frame->nb_samples; i++) {
308             dst[i] = av_clipd(dbuf[dindex] * get_volume(s, cp->volume), -1, 1);
309             dindex = MOD(dindex + 1, s->delay_samples);
310         }
311     }
312     s->delay_count -= frame->nb_samples;
313     s->delay_index = dindex;
314
315     return ff_filter_frame(outlink, frame);
316 }
317
318 static int config_output(AVFilterLink *outlink)
319 {
320     AVFilterContext *ctx  = outlink->src;
321     CompandContext *s     = ctx->priv;
322     const int sample_rate = outlink->sample_rate;
323     double radius         = s->curve_dB * M_LN10 / 20;
324     int nb_attacks, nb_decays, nb_points;
325     char *p, *saveptr = NULL;
326     const int channels    = outlink->channels;
327     int new_nb_items, num;
328     int i;
329     int err;
330
331
332     count_items(s->attacks, &nb_attacks);
333     count_items(s->decays, &nb_decays);
334     count_items(s->points, &nb_points);
335
336     if (channels <= 0) {
337         av_log(ctx, AV_LOG_ERROR, "Invalid number of channels: %d\n", channels);
338         return AVERROR(EINVAL);
339     }
340
341     if ((nb_attacks > channels) || (nb_decays > channels)) {
342         av_log(ctx, AV_LOG_ERROR, "Number of attacks/decays bigger than number of channels.\n");
343         return AVERROR(EINVAL);
344     }
345
346     uninit(ctx);
347
348     s->channels = av_mallocz_array(channels, sizeof(*s->channels));
349     s->nb_segments = (nb_points + 4) * 2;
350     s->segments = av_mallocz_array(s->nb_segments, sizeof(*s->segments));
351
352     if (!s->channels || !s->segments) {
353         uninit(ctx);
354         return AVERROR(ENOMEM);
355     }
356
357     p = s->attacks;
358     for (i = 0, new_nb_items = 0; i < nb_attacks; i++) {
359         char *tstr = av_strtok(p, " |", &saveptr);
360         p = NULL;
361         new_nb_items += sscanf(tstr, "%lf", &s->channels[i].attack) == 1;
362         if (s->channels[i].attack < 0) {
363             uninit(ctx);
364             return AVERROR(EINVAL);
365         }
366     }
367     nb_attacks = new_nb_items;
368
369     p = s->decays;
370     for (i = 0, new_nb_items = 0; i < nb_decays; i++) {
371         char *tstr = av_strtok(p, " |", &saveptr);
372         p = NULL;
373         new_nb_items += sscanf(tstr, "%lf", &s->channels[i].decay) == 1;
374         if (s->channels[i].decay < 0) {
375             uninit(ctx);
376             return AVERROR(EINVAL);
377         }
378     }
379     nb_decays = new_nb_items;
380
381     if (nb_attacks != nb_decays) {
382         av_log(ctx, AV_LOG_ERROR,
383                 "Number of attacks %d differs from number of decays %d.\n",
384                 nb_attacks, nb_decays);
385         uninit(ctx);
386         return AVERROR(EINVAL);
387     }
388
389 #define S(x) s->segments[2 * ((x) + 1)]
390     p = s->points;
391     for (i = 0, new_nb_items = 0; i < nb_points; i++) {
392         char *tstr = av_strtok(p, " |", &saveptr);
393         p = NULL;
394         if (sscanf(tstr, "%lf/%lf", &S(i).x, &S(i).y) != 2) {
395             av_log(ctx, AV_LOG_ERROR,
396                     "Invalid and/or missing input/output value.\n");
397             uninit(ctx);
398             return AVERROR(EINVAL);
399         }
400         if (i && S(i - 1).x > S(i).x) {
401             av_log(ctx, AV_LOG_ERROR,
402                     "Transfer function input values must be increasing.\n");
403             uninit(ctx);
404             return AVERROR(EINVAL);
405         }
406         S(i).y -= S(i).x;
407         av_log(ctx, AV_LOG_DEBUG, "%d: x=%f y=%f\n", i, S(i).x, S(i).y);
408         new_nb_items++;
409     }
410     num = new_nb_items;
411
412     /* Add 0,0 if necessary */
413     if (num == 0 || S(num - 1).x)
414         num++;
415
416 #undef S
417 #define S(x) s->segments[2 * (x)]
418     /* Add a tail off segment at the start */
419     S(0).x = S(1).x - 2 * s->curve_dB;
420     S(0).y = S(1).y;
421     num++;
422
423     /* Join adjacent colinear segments */
424     for (i = 2; i < num; i++) {
425         double g1 = (S(i - 1).y - S(i - 2).y) * (S(i - 0).x - S(i - 1).x);
426         double g2 = (S(i - 0).y - S(i - 1).y) * (S(i - 1).x - S(i - 2).x);
427         int j;
428
429         if (fabs(g1 - g2))
430             continue;
431         num--;
432         for (j = --i; j < num; j++)
433             S(j) = S(j + 1);
434     }
435
436     for (i = 0; !i || s->segments[i - 2].x; i += 2) {
437         s->segments[i].y += s->gain_dB;
438         s->segments[i].x *= M_LN10 / 20;
439         s->segments[i].y *= M_LN10 / 20;
440     }
441
442 #define L(x) s->segments[i - (x)]
443     for (i = 4; s->segments[i - 2].x; i += 2) {
444         double x, y, cx, cy, in1, in2, out1, out2, theta, len, r;
445
446         L(4).a = 0;
447         L(4).b = (L(2).y - L(4).y) / (L(2).x - L(4).x);
448
449         L(2).a = 0;
450         L(2).b = (L(0).y - L(2).y) / (L(0).x - L(2).x);
451
452         theta = atan2(L(2).y - L(4).y, L(2).x - L(4).x);
453         len = sqrt(pow(L(2).x - L(4).x, 2.) + pow(L(2).y - L(4).y, 2.));
454         r = FFMIN(radius, len);
455         L(3).x = L(2).x - r * cos(theta);
456         L(3).y = L(2).y - r * sin(theta);
457
458         theta = atan2(L(0).y - L(2).y, L(0).x - L(2).x);
459         len = sqrt(pow(L(0).x - L(2).x, 2.) + pow(L(0).y - L(2).y, 2.));
460         r = FFMIN(radius, len / 2);
461         x = L(2).x + r * cos(theta);
462         y = L(2).y + r * sin(theta);
463
464         cx = (L(3).x + L(2).x + x) / 3;
465         cy = (L(3).y + L(2).y + y) / 3;
466
467         L(2).x = x;
468         L(2).y = y;
469
470         in1  = cx - L(3).x;
471         out1 = cy - L(3).y;
472         in2  = L(2).x - L(3).x;
473         out2 = L(2).y - L(3).y;
474         L(3).a = (out2 / in2 - out1 / in1) / (in2 - in1);
475         L(3).b = out1 / in1 - L(3).a * in1;
476     }
477     L(3).x = 0;
478     L(3).y = L(2).y;
479
480     s->in_min_lin  = exp(s->segments[1].x);
481     s->out_min_lin = exp(s->segments[1].y);
482
483     for (i = 0; i < channels; i++) {
484         ChanParam *cp = &s->channels[i];
485
486         if (cp->attack > 1.0 / sample_rate)
487             cp->attack = 1.0 - exp(-1.0 / (sample_rate * cp->attack));
488         else
489             cp->attack = 1.0;
490         if (cp->decay > 1.0 / sample_rate)
491             cp->decay = 1.0 - exp(-1.0 / (sample_rate * cp->decay));
492         else
493             cp->decay = 1.0;
494         cp->volume = pow(10.0, s->initial_volume / 20);
495     }
496
497     s->delay_samples = s->delay * sample_rate;
498     if (s->delay_samples <= 0) {
499         s->compand = compand_nodelay;
500         return 0;
501     }
502
503     s->delay_frame = av_frame_alloc();
504     if (!s->delay_frame) {
505         uninit(ctx);
506         return AVERROR(ENOMEM);
507     }
508
509     s->delay_frame->format         = outlink->format;
510     s->delay_frame->nb_samples     = s->delay_samples;
511     s->delay_frame->channel_layout = outlink->channel_layout;
512
513     err = av_frame_get_buffer(s->delay_frame, 32);
514     if (err)
515         return err;
516
517     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
518     s->compand = compand_delay;
519     return 0;
520 }
521
522 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
523 {
524     AVFilterContext *ctx = inlink->dst;
525     CompandContext *s    = ctx->priv;
526
527     return s->compand(ctx, frame);
528 }
529
530 static int request_frame(AVFilterLink *outlink)
531 {
532     AVFilterContext *ctx = outlink->src;
533     CompandContext *s    = ctx->priv;
534     int ret;
535
536     ret = ff_request_frame(ctx->inputs[0]);
537
538     if (ret == AVERROR_EOF && !ctx->is_disabled && s->delay_count)
539         ret = compand_drain(outlink);
540
541     return ret;
542 }
543
544 static const AVFilterPad compand_inputs[] = {
545     {
546         .name         = "default",
547         .type         = AVMEDIA_TYPE_AUDIO,
548         .filter_frame = filter_frame,
549     },
550     { NULL }
551 };
552
553 static const AVFilterPad compand_outputs[] = {
554     {
555         .name          = "default",
556         .request_frame = request_frame,
557         .config_props  = config_output,
558         .type          = AVMEDIA_TYPE_AUDIO,
559     },
560     { NULL }
561 };
562
563
564 AVFilter ff_af_compand = {
565     .name           = "compand",
566     .description    = NULL_IF_CONFIG_SMALL(
567             "Compress or expand audio dynamic range."),
568     .query_formats  = query_formats,
569     .priv_size      = sizeof(CompandContext),
570     .priv_class     = &compand_class,
571     .init           = init,
572     .uninit         = uninit,
573     .inputs         = compand_inputs,
574     .outputs        = compand_outputs,
575 };