avfilter/af_compand: also support '|' as seperator
[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     uint8_t **delayptrs;
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     if (s->delayptrs)
100         av_freep(&s->delayptrs[0]);
101     av_freep(&s->delayptrs);
102 }
103
104 static int query_formats(AVFilterContext *ctx)
105 {
106     AVFilterChannelLayouts *layouts;
107     AVFilterFormats *formats;
108     static const enum AVSampleFormat sample_fmts[] = {
109         AV_SAMPLE_FMT_DBLP,
110         AV_SAMPLE_FMT_NONE
111     };
112
113     layouts = ff_all_channel_layouts();
114     if (!layouts)
115         return AVERROR(ENOMEM);
116     ff_set_common_channel_layouts(ctx, layouts);
117
118     formats = ff_make_format_list(sample_fmts);
119     if (!formats)
120         return AVERROR(ENOMEM);
121     ff_set_common_formats(ctx, formats);
122
123     formats = ff_all_samplerates();
124     if (!formats)
125         return AVERROR(ENOMEM);
126     ff_set_common_samplerates(ctx, formats);
127
128     return 0;
129 }
130
131 static void count_items(char *item_str, int *nb_items)
132 {
133     char *p;
134
135     *nb_items = 1;
136     for (p = item_str; *p; p++) {
137         if (*p == ' ' || *p == '|')
138             (*nb_items)++;
139     }
140 }
141
142 static void update_volume(ChanParam *cp, double in)
143 {
144     double delta = in - cp->volume;
145
146     if (delta > 0.0)
147         cp->volume += delta * cp->attack;
148     else
149         cp->volume += delta * cp->decay;
150 }
151
152 static double get_volume(CompandContext *s, double in_lin)
153 {
154     CompandSegment *cs;
155     double in_log, out_log;
156     int i;
157
158     if (in_lin < s->in_min_lin)
159         return s->out_min_lin;
160
161     in_log = log(in_lin);
162
163     for (i = 1; i < s->nb_segments; i++)
164         if (in_log <= s->segments[i].x)
165             break;
166     cs = &s->segments[i - 1];
167     in_log -= cs->x;
168     out_log = cs->y + in_log * (cs->a * in_log + cs->b);
169
170     return exp(out_log);
171 }
172
173 static int compand_nodelay(AVFilterContext *ctx, AVFrame *frame)
174 {
175     CompandContext *s    = ctx->priv;
176     AVFilterLink *inlink = ctx->inputs[0];
177     const int channels = inlink->channels;
178     const int nb_samples = frame->nb_samples;
179     AVFrame *out_frame;
180     int chan, i;
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         av_frame_copy_props(out_frame, frame);
191     }
192
193     for (chan = 0; chan < channels; chan++) {
194         const double *src = (double *)frame->extended_data[chan];
195         double *dst = (double *)out_frame->extended_data[chan];
196         ChanParam *cp = &s->channels[chan];
197
198         for (i = 0; i < nb_samples; i++) {
199             update_volume(cp, fabs(src[i]));
200
201             dst[i] = av_clipd(src[i] * get_volume(s, cp->volume), -1, 1);
202         }
203     }
204
205     if (frame != out_frame)
206         av_frame_free(&frame);
207
208     return ff_filter_frame(ctx->outputs[0], out_frame);
209 }
210
211 #define MOD(a, b) (((a) >= (b)) ? (a) - (b) : (a))
212
213 static int compand_delay(AVFilterContext *ctx, AVFrame *frame)
214 {
215     CompandContext *s    = ctx->priv;
216     AVFilterLink *inlink = ctx->inputs[0];
217     const int channels = inlink->channels;
218     const int nb_samples = frame->nb_samples;
219     int chan, i, av_uninit(dindex), oindex, av_uninit(count);
220     AVFrame *out_frame   = NULL;
221
222     av_assert1(channels > 0); /* would corrupt delay_count and delay_index */
223
224     for (chan = 0; chan < channels; chan++) {
225         const double *src = (double *)frame->extended_data[chan];
226         double *dbuf = (double *)s->delayptrs[chan];
227         ChanParam *cp = &s->channels[chan];
228         double *dst;
229
230         count  = s->delay_count;
231         dindex = s->delay_index;
232         for (i = 0, oindex = 0; i < nb_samples; i++) {
233             const double in = src[i];
234             update_volume(cp, fabs(in));
235
236             if (count >= s->delay_samples) {
237                 if (!out_frame) {
238                     out_frame = ff_get_audio_buffer(inlink, nb_samples - i);
239                     if (!out_frame) {
240                         av_frame_free(&frame);
241                         return AVERROR(ENOMEM);
242                     }
243                     av_frame_copy_props(out_frame, frame);
244                     out_frame->pts = s->pts;
245                     s->pts += av_rescale_q(nb_samples - i,
246                         (AVRational){ 1, inlink->sample_rate },
247                         inlink->time_base);
248                 }
249
250                 dst = (double *)out_frame->extended_data[chan];
251                 dst[oindex++] = av_clipd(dbuf[dindex] *
252                         get_volume(s, cp->volume), -1, 1);
253             } else {
254                 count++;
255             }
256
257             dbuf[dindex] = in;
258             dindex = MOD(dindex + 1, s->delay_samples);
259         }
260     }
261
262     s->delay_count = count;
263     s->delay_index = dindex;
264
265     av_frame_free(&frame);
266     return out_frame ? ff_filter_frame(ctx->outputs[0], out_frame) : 0;
267 }
268
269 static int compand_drain(AVFilterLink *outlink)
270 {
271     AVFilterContext *ctx = outlink->src;
272     CompandContext *s    = ctx->priv;
273     const int channels = outlink->channels;
274     int chan, i, dindex;
275     AVFrame *frame = NULL;
276
277     frame = ff_get_audio_buffer(outlink, FFMIN(2048, s->delay_count));
278     if (!frame)
279         return AVERROR(ENOMEM);
280     frame->pts = s->pts;
281     s->pts += av_rescale_q(frame->nb_samples,
282             (AVRational){ 1, outlink->sample_rate }, outlink->time_base);
283
284     for (chan = 0; chan < channels; chan++) {
285         double *dbuf = (double *)s->delayptrs[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
312     count_items(s->attacks, &nb_attacks);
313     count_items(s->decays, &nb_decays);
314     count_items(s->points, &nb_points);
315
316     if ((nb_attacks > outlink->channels) || (nb_decays > outlink->channels)) {
317         av_log(ctx, AV_LOG_ERROR, "Number of attacks/decays bigger than number of channels.\n");
318         return AVERROR(EINVAL);
319     }
320
321     uninit(ctx);
322
323     s->channels = av_mallocz_array(outlink->channels, sizeof(*s->channels));
324     s->nb_segments = (nb_points + 4) * 2;
325     s->segments = av_mallocz_array(s->nb_segments, sizeof(*s->segments));
326
327     if (!s->channels || !s->segments)
328         return AVERROR(ENOMEM);
329
330     p = s->attacks;
331     for (i = 0, new_nb_items = 0; i < nb_attacks; i++) {
332         char *tstr = av_strtok(p, " |", &saveptr);
333         p = NULL;
334         new_nb_items += sscanf(tstr, "%lf", &s->channels[i].attack) == 1;
335         if (s->channels[i].attack < 0)
336             return AVERROR(EINVAL);
337     }
338     nb_attacks = new_nb_items;
339
340     p = s->decays;
341     for (i = 0, new_nb_items = 0; i < nb_decays; i++) {
342         char *tstr = av_strtok(p, " |", &saveptr);
343         p = NULL;
344         new_nb_items += sscanf(tstr, "%lf", &s->channels[i].decay) == 1;
345         if (s->channels[i].decay < 0)
346             return AVERROR(EINVAL);
347     }
348     nb_decays = new_nb_items;
349
350     if (nb_attacks != nb_decays) {
351         av_log(ctx, AV_LOG_ERROR,
352                 "Number of attacks %d differs from number of decays %d.\n",
353                 nb_attacks, nb_decays);
354         return AVERROR(EINVAL);
355     }
356
357 #define S(x) s->segments[2 * ((x) + 1)]
358     p = s->points;
359     for (i = 0, new_nb_items = 0; i < nb_points; i++) {
360         char *tstr = av_strtok(p, " |", &saveptr);
361         p = NULL;
362         if (sscanf(tstr, "%lf/%lf", &S(i).x, &S(i).y) != 2) {
363             av_log(ctx, AV_LOG_ERROR,
364                     "Invalid and/or missing input/output value.\n");
365             return AVERROR(EINVAL);
366         }
367         if (i && S(i - 1).x > S(i).x) {
368             av_log(ctx, AV_LOG_ERROR,
369                     "Transfer function input values must be increasing.\n");
370             return AVERROR(EINVAL);
371         }
372         S(i).y -= S(i).x;
373         av_log(ctx, AV_LOG_DEBUG, "%d: x=%f y=%f\n", i, S(i).x, S(i).y);
374         new_nb_items++;
375     }
376     num = new_nb_items;
377
378     /* Add 0,0 if necessary */
379     if (num == 0 || S(num - 1).x)
380         num++;
381
382 #undef S
383 #define S(x) s->segments[2 * (x)]
384     /* Add a tail off segment at the start */
385     S(0).x = S(1).x - 2 * s->curve_dB;
386     S(0).y = S(1).y;
387     num++;
388
389     /* Join adjacent colinear segments */
390     for (i = 2; i < num; i++) {
391         double g1 = (S(i - 1).y - S(i - 2).y) * (S(i - 0).x - S(i - 1).x);
392         double g2 = (S(i - 0).y - S(i - 1).y) * (S(i - 1).x - S(i - 2).x);
393         int j;
394
395         if (fabs(g1 - g2))
396             continue;
397         num--;
398         for (j = --i; j < num; j++)
399             S(j) = S(j + 1);
400     }
401
402     for (i = 0; !i || s->segments[i - 2].x; i += 2) {
403         s->segments[i].y += s->gain_dB;
404         s->segments[i].x *= M_LN10 / 20;
405         s->segments[i].y *= M_LN10 / 20;
406     }
407
408 #define L(x) s->segments[i - (x)]
409     for (i = 4; s->segments[i - 2].x; i += 2) {
410         double x, y, cx, cy, in1, in2, out1, out2, theta, len, r;
411
412         L(4).a = 0;
413         L(4).b = (L(2).y - L(4).y) / (L(2).x - L(4).x);
414
415         L(2).a = 0;
416         L(2).b = (L(0).y - L(2).y) / (L(0).x - L(2).x);
417
418         theta = atan2(L(2).y - L(4).y, L(2).x - L(4).x);
419         len = sqrt(pow(L(2).x - L(4).x, 2.) + pow(L(2).y - L(4).y, 2.));
420         r = FFMIN(radius, len);
421         L(3).x = L(2).x - r * cos(theta);
422         L(3).y = L(2).y - r * sin(theta);
423
424         theta = atan2(L(0).y - L(2).y, L(0).x - L(2).x);
425         len = sqrt(pow(L(0).x - L(2).x, 2.) + pow(L(0).y - L(2).y, 2.));
426         r = FFMIN(radius, len / 2);
427         x = L(2).x + r * cos(theta);
428         y = L(2).y + r * sin(theta);
429
430         cx = (L(3).x + L(2).x + x) / 3;
431         cy = (L(3).y + L(2).y + y) / 3;
432
433         L(2).x = x;
434         L(2).y = y;
435
436         in1  = cx - L(3).x;
437         out1 = cy - L(3).y;
438         in2  = L(2).x - L(3).x;
439         out2 = L(2).y - L(3).y;
440         L(3).a = (out2 / in2 - out1 / in1) / (in2 - in1);
441         L(3).b = out1 / in1 - L(3).a * in1;
442     }
443     L(3).x = 0;
444     L(3).y = L(2).y;
445
446     s->in_min_lin  = exp(s->segments[1].x);
447     s->out_min_lin = exp(s->segments[1].y);
448
449     for (i = 0; i < outlink->channels; i++) {
450         ChanParam *cp = &s->channels[i];
451
452         if (cp->attack > 1.0 / sample_rate)
453             cp->attack = 1.0 - exp(-1.0 / (sample_rate * cp->attack));
454         else
455             cp->attack = 1.0;
456         if (cp->decay > 1.0 / sample_rate)
457             cp->decay = 1.0 - exp(-1.0 / (sample_rate * cp->decay));
458         else
459             cp->decay = 1.0;
460         cp->volume = pow(10.0, s->initial_volume / 20);
461     }
462
463     s->delay_samples = s->delay * sample_rate;
464     if (s->delay_samples > 0) {
465         int ret;
466         if ((ret = av_samples_alloc_array_and_samples(&s->delayptrs, NULL,
467                                                       outlink->channels,
468                                                       s->delay_samples,
469                                                       outlink->format, 0)) < 0)
470             return ret;
471         s->compand = compand_delay;
472         outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
473     } else {
474         s->compand = compand_nodelay;
475     }
476     return 0;
477 }
478
479 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
480 {
481     AVFilterContext *ctx = inlink->dst;
482     CompandContext *s    = ctx->priv;
483
484     return s->compand(ctx, frame);
485 }
486
487 static int request_frame(AVFilterLink *outlink)
488 {
489     AVFilterContext *ctx = outlink->src;
490     CompandContext *s    = ctx->priv;
491     int ret;
492
493     ret = ff_request_frame(ctx->inputs[0]);
494
495     if (ret == AVERROR_EOF && !ctx->is_disabled && s->delay_count)
496         ret = compand_drain(outlink);
497
498     return ret;
499 }
500
501 static const AVFilterPad compand_inputs[] = {
502     {
503         .name         = "default",
504         .type         = AVMEDIA_TYPE_AUDIO,
505         .filter_frame = filter_frame,
506     },
507     { NULL }
508 };
509
510 static const AVFilterPad compand_outputs[] = {
511     {
512         .name          = "default",
513         .request_frame = request_frame,
514         .config_props  = config_output,
515         .type          = AVMEDIA_TYPE_AUDIO,
516     },
517     { NULL }
518 };
519
520
521 AVFilter ff_af_compand = {
522     .name           = "compand",
523     .description    = NULL_IF_CONFIG_SMALL(
524             "Compress or expand audio dynamic range."),
525     .query_formats  = query_formats,
526     .priv_size      = sizeof(CompandContext),
527     .priv_class     = &compand_class,
528     .init           = init,
529     .uninit         = uninit,
530     .inputs         = compand_inputs,
531     .outputs        = compand_outputs,
532 };