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