Merge commit 'a49aa440c939e221194f8d95bf98673f8cf38a06'
[ffmpeg.git] / libavfilter / af_volume.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
3  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * audio volume filter
25  */
26
27 #include "libavutil/channel_layout.h"
28 #include "libavutil/common.h"
29 #include "libavutil/eval.h"
30 #include "libavutil/float_dsp.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/replaygain.h"
34
35 #include "audio.h"
36 #include "avfilter.h"
37 #include "formats.h"
38 #include "internal.h"
39 #include "af_volume.h"
40
41 static const char *precision_str[] = {
42     "fixed", "float", "double"
43 };
44
45 static const char *const var_names[] = {
46     "n",                   ///< frame number (starting at zero)
47     "nb_channels",         ///< number of channels
48     "nb_consumed_samples", ///< number of samples consumed by the filter
49     "nb_samples",          ///< number of samples in the current frame
50     "pos",                 ///< position in the file of the frame
51     "pts",                 ///< frame presentation timestamp
52     "sample_rate",         ///< sample rate
53     "startpts",            ///< PTS at start of stream
54     "startt",              ///< time at start of stream
55     "t",                   ///< time in the file of the frame
56     "tb",                  ///< timebase
57     "volume",              ///< last set value
58     NULL
59 };
60
61 #define OFFSET(x) offsetof(VolumeContext, x)
62 #define A AV_OPT_FLAG_AUDIO_PARAM
63 #define F AV_OPT_FLAG_FILTERING_PARAM
64
65 static const AVOption volume_options[] = {
66     { "volume", "set volume adjustment expression",
67             OFFSET(volume_expr), AV_OPT_TYPE_STRING, { .str = "1.0" }, .flags = A|F },
68     { "precision", "select mathematical precision",
69             OFFSET(precision), AV_OPT_TYPE_INT, { .i64 = PRECISION_FLOAT }, PRECISION_FIXED, PRECISION_DOUBLE, A|F, "precision" },
70         { "fixed",  "select 8-bit fixed-point",     0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_FIXED  }, INT_MIN, INT_MAX, A|F, "precision" },
71         { "float",  "select 32-bit floating-point", 0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_FLOAT  }, INT_MIN, INT_MAX, A|F, "precision" },
72         { "double", "select 64-bit floating-point", 0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_DOUBLE }, INT_MIN, INT_MAX, A|F, "precision" },
73     { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_ONCE}, 0, EVAL_MODE_NB-1, .flags = A|F, "eval" },
74          { "once",  "eval volume expression once", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_ONCE},  .flags = A|F, .unit = "eval" },
75          { "frame", "eval volume expression per-frame",                  0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = A|F, .unit = "eval" },
76     { "replaygain", "Apply replaygain side data when present",
77             OFFSET(replaygain), AV_OPT_TYPE_INT, { .i64 = REPLAYGAIN_DROP }, REPLAYGAIN_DROP, REPLAYGAIN_ALBUM, A, "replaygain" },
78         { "drop",   "replaygain side data is dropped", 0, AV_OPT_TYPE_CONST, { .i64 = REPLAYGAIN_DROP   }, 0, 0, A, "replaygain" },
79         { "ignore", "replaygain side data is ignored", 0, AV_OPT_TYPE_CONST, { .i64 = REPLAYGAIN_IGNORE }, 0, 0, A, "replaygain" },
80         { "track",  "track gain is preferred",         0, AV_OPT_TYPE_CONST, { .i64 = REPLAYGAIN_TRACK  }, 0, 0, A, "replaygain" },
81         { "album",  "album gain is preferred",         0, AV_OPT_TYPE_CONST, { .i64 = REPLAYGAIN_ALBUM  }, 0, 0, A, "replaygain" },
82     { "replaygain_preamp", "Apply replaygain pre-amplification",
83             OFFSET(replaygain_preamp), AV_OPT_TYPE_DOUBLE, { .dbl = 0.0 }, -15.0, 15.0, A },
84     { NULL },
85 };
86
87 AVFILTER_DEFINE_CLASS(volume);
88
89 static int set_expr(AVExpr **pexpr, const char *expr, void *log_ctx)
90 {
91     int ret;
92     AVExpr *old = NULL;
93
94     if (*pexpr)
95         old = *pexpr;
96     ret = av_expr_parse(pexpr, expr, var_names,
97                         NULL, NULL, NULL, NULL, 0, log_ctx);
98     if (ret < 0) {
99         av_log(log_ctx, AV_LOG_ERROR,
100                "Error when evaluating the volume expression '%s'\n", expr);
101         *pexpr = old;
102         return ret;
103     }
104
105     av_expr_free(old);
106     return 0;
107 }
108
109 static av_cold int init(AVFilterContext *ctx)
110 {
111     VolumeContext *vol = ctx->priv;
112     return set_expr(&vol->volume_pexpr, vol->volume_expr, ctx);
113 }
114
115 static av_cold void uninit(AVFilterContext *ctx)
116 {
117     VolumeContext *vol = ctx->priv;
118     av_expr_free(vol->volume_pexpr);
119     av_opt_free(vol);
120 }
121
122 static int query_formats(AVFilterContext *ctx)
123 {
124     VolumeContext *vol = ctx->priv;
125     AVFilterFormats *formats = NULL;
126     AVFilterChannelLayouts *layouts;
127     static const enum AVSampleFormat sample_fmts[][7] = {
128         [PRECISION_FIXED] = {
129             AV_SAMPLE_FMT_U8,
130             AV_SAMPLE_FMT_U8P,
131             AV_SAMPLE_FMT_S16,
132             AV_SAMPLE_FMT_S16P,
133             AV_SAMPLE_FMT_S32,
134             AV_SAMPLE_FMT_S32P,
135             AV_SAMPLE_FMT_NONE
136         },
137         [PRECISION_FLOAT] = {
138             AV_SAMPLE_FMT_FLT,
139             AV_SAMPLE_FMT_FLTP,
140             AV_SAMPLE_FMT_NONE
141         },
142         [PRECISION_DOUBLE] = {
143             AV_SAMPLE_FMT_DBL,
144             AV_SAMPLE_FMT_DBLP,
145             AV_SAMPLE_FMT_NONE
146         }
147     };
148
149     layouts = ff_all_channel_counts();
150     if (!layouts)
151         return AVERROR(ENOMEM);
152     ff_set_common_channel_layouts(ctx, layouts);
153
154     formats = ff_make_format_list(sample_fmts[vol->precision]);
155     if (!formats)
156         return AVERROR(ENOMEM);
157     ff_set_common_formats(ctx, formats);
158
159     formats = ff_all_samplerates();
160     if (!formats)
161         return AVERROR(ENOMEM);
162     ff_set_common_samplerates(ctx, formats);
163
164     return 0;
165 }
166
167 static inline void scale_samples_u8(uint8_t *dst, const uint8_t *src,
168                                     int nb_samples, int volume)
169 {
170     int i;
171     for (i = 0; i < nb_samples; i++)
172         dst[i] = av_clip_uint8(((((int64_t)src[i] - 128) * volume + 128) >> 8) + 128);
173 }
174
175 static inline void scale_samples_u8_small(uint8_t *dst, const uint8_t *src,
176                                           int nb_samples, int volume)
177 {
178     int i;
179     for (i = 0; i < nb_samples; i++)
180         dst[i] = av_clip_uint8((((src[i] - 128) * volume + 128) >> 8) + 128);
181 }
182
183 static inline void scale_samples_s16(uint8_t *dst, const uint8_t *src,
184                                      int nb_samples, int volume)
185 {
186     int i;
187     int16_t *smp_dst       = (int16_t *)dst;
188     const int16_t *smp_src = (const int16_t *)src;
189     for (i = 0; i < nb_samples; i++)
190         smp_dst[i] = av_clip_int16(((int64_t)smp_src[i] * volume + 128) >> 8);
191 }
192
193 static inline void scale_samples_s16_small(uint8_t *dst, const uint8_t *src,
194                                            int nb_samples, int volume)
195 {
196     int i;
197     int16_t *smp_dst       = (int16_t *)dst;
198     const int16_t *smp_src = (const int16_t *)src;
199     for (i = 0; i < nb_samples; i++)
200         smp_dst[i] = av_clip_int16((smp_src[i] * volume + 128) >> 8);
201 }
202
203 static inline void scale_samples_s32(uint8_t *dst, const uint8_t *src,
204                                      int nb_samples, int volume)
205 {
206     int i;
207     int32_t *smp_dst       = (int32_t *)dst;
208     const int32_t *smp_src = (const int32_t *)src;
209     for (i = 0; i < nb_samples; i++)
210         smp_dst[i] = av_clipl_int32((((int64_t)smp_src[i] * volume + 128) >> 8));
211 }
212
213 static av_cold void volume_init(VolumeContext *vol)
214 {
215     vol->samples_align = 1;
216
217     switch (av_get_packed_sample_fmt(vol->sample_fmt)) {
218     case AV_SAMPLE_FMT_U8:
219         if (vol->volume_i < 0x1000000)
220             vol->scale_samples = scale_samples_u8_small;
221         else
222             vol->scale_samples = scale_samples_u8;
223         break;
224     case AV_SAMPLE_FMT_S16:
225         if (vol->volume_i < 0x10000)
226             vol->scale_samples = scale_samples_s16_small;
227         else
228             vol->scale_samples = scale_samples_s16;
229         break;
230     case AV_SAMPLE_FMT_S32:
231         vol->scale_samples = scale_samples_s32;
232         break;
233     case AV_SAMPLE_FMT_FLT:
234         avpriv_float_dsp_init(&vol->fdsp, 0);
235         vol->samples_align = 4;
236         break;
237     case AV_SAMPLE_FMT_DBL:
238         avpriv_float_dsp_init(&vol->fdsp, 0);
239         vol->samples_align = 8;
240         break;
241     }
242
243     if (ARCH_X86)
244         ff_volume_init_x86(vol);
245 }
246
247 static int set_volume(AVFilterContext *ctx)
248 {
249     VolumeContext *vol = ctx->priv;
250
251     vol->volume = av_expr_eval(vol->volume_pexpr, vol->var_values, NULL);
252     if (isnan(vol->volume)) {
253         if (vol->eval_mode == EVAL_MODE_ONCE) {
254             av_log(ctx, AV_LOG_ERROR, "Invalid value NaN for volume\n");
255             return AVERROR(EINVAL);
256         } else {
257             av_log(ctx, AV_LOG_WARNING, "Invalid value NaN for volume, setting to 0\n");
258             vol->volume = 0;
259         }
260     }
261     vol->var_values[VAR_VOLUME] = vol->volume;
262
263     av_log(ctx, AV_LOG_VERBOSE, "n:%f t:%f pts:%f precision:%s ",
264            vol->var_values[VAR_N], vol->var_values[VAR_T], vol->var_values[VAR_PTS],
265            precision_str[vol->precision]);
266
267     if (vol->precision == PRECISION_FIXED) {
268         vol->volume_i = (int)(vol->volume * 256 + 0.5);
269         vol->volume   = vol->volume_i / 256.0;
270         av_log(ctx, AV_LOG_VERBOSE, "volume_i:%d/255 ", vol->volume_i);
271     }
272     av_log(ctx, AV_LOG_VERBOSE, "volume:%f volume_dB:%f\n",
273            vol->volume, 20.0*log(vol->volume)/M_LN10);
274
275     volume_init(vol);
276     return 0;
277 }
278
279 static int config_output(AVFilterLink *outlink)
280 {
281     AVFilterContext *ctx = outlink->src;
282     VolumeContext *vol   = ctx->priv;
283     AVFilterLink *inlink = ctx->inputs[0];
284
285     vol->sample_fmt = inlink->format;
286     vol->channels   = inlink->channels;
287     vol->planes     = av_sample_fmt_is_planar(inlink->format) ? vol->channels : 1;
288
289     vol->var_values[VAR_N] =
290     vol->var_values[VAR_NB_CONSUMED_SAMPLES] =
291     vol->var_values[VAR_NB_SAMPLES] =
292     vol->var_values[VAR_POS] =
293     vol->var_values[VAR_PTS] =
294     vol->var_values[VAR_STARTPTS] =
295     vol->var_values[VAR_STARTT] =
296     vol->var_values[VAR_T] =
297     vol->var_values[VAR_VOLUME] = NAN;
298
299     vol->var_values[VAR_NB_CHANNELS] = inlink->channels;
300     vol->var_values[VAR_TB]          = av_q2d(inlink->time_base);
301     vol->var_values[VAR_SAMPLE_RATE] = inlink->sample_rate;
302
303     av_log(inlink->src, AV_LOG_VERBOSE, "tb:%f sample_rate:%f nb_channels:%f\n",
304            vol->var_values[VAR_TB],
305            vol->var_values[VAR_SAMPLE_RATE],
306            vol->var_values[VAR_NB_CHANNELS]);
307
308     return set_volume(ctx);
309 }
310
311 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
312                            char *res, int res_len, int flags)
313 {
314     VolumeContext *vol = ctx->priv;
315     int ret = AVERROR(ENOSYS);
316
317     if (!strcmp(cmd, "volume")) {
318         if ((ret = set_expr(&vol->volume_pexpr, args, ctx)) < 0)
319             return ret;
320         if (vol->eval_mode == EVAL_MODE_ONCE)
321             set_volume(ctx);
322     }
323
324     return ret;
325 }
326
327 #define D2TS(d)  (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
328 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
329 #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts)*av_q2d(tb))
330
331 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
332 {
333     AVFilterContext *ctx = inlink->dst;
334     VolumeContext *vol    = inlink->dst->priv;
335     AVFilterLink *outlink = inlink->dst->outputs[0];
336     int nb_samples        = buf->nb_samples;
337     AVFrame *out_buf;
338     int64_t pos;
339     AVFrameSideData *sd = av_frame_get_side_data(buf, AV_FRAME_DATA_REPLAYGAIN);
340     int ret;
341
342     if (sd && vol->replaygain != REPLAYGAIN_IGNORE) {
343         if (vol->replaygain != REPLAYGAIN_DROP) {
344             AVReplayGain *replaygain = (AVReplayGain*)sd->data;
345             int32_t gain;
346             float g;
347
348             if (vol->replaygain == REPLAYGAIN_TRACK &&
349                 replaygain->track_gain != INT32_MIN)
350                 gain = replaygain->track_gain;
351             else if (replaygain->album_gain != INT32_MIN)
352                 gain = replaygain->album_gain;
353             else {
354                 av_log(inlink->dst, AV_LOG_WARNING, "Both ReplayGain gain "
355                        "values are unknown.\n");
356                 gain = 100000;
357             }
358             g = gain / 100000.0f;
359
360             av_log(inlink->dst, AV_LOG_VERBOSE,
361                    "Using gain %f dB from replaygain side data.\n", g);
362
363             vol->volume   = pow(10, (g + vol->replaygain_preamp) / 20);
364             vol->volume_i = (int)(vol->volume * 256 + 0.5);
365
366             volume_init(vol);
367         }
368         av_frame_remove_side_data(buf, AV_FRAME_DATA_REPLAYGAIN);
369     }
370
371     if (isnan(vol->var_values[VAR_STARTPTS])) {
372         vol->var_values[VAR_STARTPTS] = TS2D(buf->pts);
373         vol->var_values[VAR_STARTT  ] = TS2T(buf->pts, inlink->time_base);
374     }
375     vol->var_values[VAR_PTS] = TS2D(buf->pts);
376     vol->var_values[VAR_T  ] = TS2T(buf->pts, inlink->time_base);
377     vol->var_values[VAR_N  ] = inlink->frame_count;
378
379     pos = av_frame_get_pkt_pos(buf);
380     vol->var_values[VAR_POS] = pos == -1 ? NAN : pos;
381     if (vol->eval_mode == EVAL_MODE_FRAME)
382         set_volume(ctx);
383
384     if (vol->volume == 1.0 || vol->volume_i == 256) {
385         out_buf = buf;
386         goto end;
387     }
388
389     /* do volume scaling in-place if input buffer is writable */
390     if (av_frame_is_writable(buf)) {
391         out_buf = buf;
392     } else {
393         out_buf = ff_get_audio_buffer(inlink, nb_samples);
394         if (!out_buf)
395             return AVERROR(ENOMEM);
396         ret = av_frame_copy_props(out_buf, buf);
397         if (ret < 0) {
398             av_frame_free(&out_buf);
399             av_frame_free(&buf);
400             return ret;
401         }
402     }
403
404     if (vol->precision != PRECISION_FIXED || vol->volume_i > 0) {
405         int p, plane_samples;
406
407         if (av_sample_fmt_is_planar(buf->format))
408             plane_samples = FFALIGN(nb_samples, vol->samples_align);
409         else
410             plane_samples = FFALIGN(nb_samples * vol->channels, vol->samples_align);
411
412         if (vol->precision == PRECISION_FIXED) {
413             for (p = 0; p < vol->planes; p++) {
414                 vol->scale_samples(out_buf->extended_data[p],
415                                    buf->extended_data[p], plane_samples,
416                                    vol->volume_i);
417             }
418         } else if (av_get_packed_sample_fmt(vol->sample_fmt) == AV_SAMPLE_FMT_FLT) {
419             for (p = 0; p < vol->planes; p++) {
420                 vol->fdsp.vector_fmul_scalar((float *)out_buf->extended_data[p],
421                                              (const float *)buf->extended_data[p],
422                                              vol->volume, plane_samples);
423             }
424         } else {
425             for (p = 0; p < vol->planes; p++) {
426                 vol->fdsp.vector_dmul_scalar((double *)out_buf->extended_data[p],
427                                              (const double *)buf->extended_data[p],
428                                              vol->volume, plane_samples);
429             }
430         }
431     }
432
433     emms_c();
434
435     if (buf != out_buf)
436         av_frame_free(&buf);
437
438 end:
439     vol->var_values[VAR_NB_CONSUMED_SAMPLES] += out_buf->nb_samples;
440     return ff_filter_frame(outlink, out_buf);
441 }
442
443 static const AVFilterPad avfilter_af_volume_inputs[] = {
444     {
445         .name           = "default",
446         .type           = AVMEDIA_TYPE_AUDIO,
447         .filter_frame   = filter_frame,
448     },
449     { NULL }
450 };
451
452 static const AVFilterPad avfilter_af_volume_outputs[] = {
453     {
454         .name         = "default",
455         .type         = AVMEDIA_TYPE_AUDIO,
456         .config_props = config_output,
457     },
458     { NULL }
459 };
460
461 AVFilter ff_af_volume = {
462     .name           = "volume",
463     .description    = NULL_IF_CONFIG_SMALL("Change input volume."),
464     .query_formats  = query_formats,
465     .priv_size      = sizeof(VolumeContext),
466     .priv_class     = &volume_class,
467     .init           = init,
468     .uninit         = uninit,
469     .inputs         = avfilter_af_volume_inputs,
470     .outputs        = avfilter_af_volume_outputs,
471     .flags          = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
472     .process_command = process_command,
473 };