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