447e8d57fe977d57697190139f03dd587ccd9f8b
[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/opt.h"
32 #include "audio.h"
33 #include "avfilter.h"
34 #include "formats.h"
35 #include "internal.h"
36 #include "af_volume.h"
37
38 static const char *precision_str[] = {
39     "fixed", "float", "double"
40 };
41
42 #define OFFSET(x) offsetof(VolumeContext, x)
43 #define A AV_OPT_FLAG_AUDIO_PARAM
44 #define F AV_OPT_FLAG_FILTERING_PARAM
45
46 static const AVOption volume_options[] = {
47     { "volume", "set volume adjustment",
48             OFFSET(volume), AV_OPT_TYPE_DOUBLE, { .dbl = 1.0 }, 0, 0x7fffff, A|F },
49     { "precision", "select mathematical precision",
50             OFFSET(precision), AV_OPT_TYPE_INT, { .i64 = PRECISION_FLOAT }, PRECISION_FIXED, PRECISION_DOUBLE, A|F, "precision" },
51         { "fixed",  "select 8-bit fixed-point",     0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_FIXED  }, INT_MIN, INT_MAX, A|F, "precision" },
52         { "float",  "select 32-bit floating-point", 0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_FLOAT  }, INT_MIN, INT_MAX, A|F, "precision" },
53         { "double", "select 64-bit floating-point", 0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_DOUBLE }, INT_MIN, INT_MAX, A|F, "precision" },
54     { NULL },
55 };
56
57 AVFILTER_DEFINE_CLASS(volume);
58
59 static av_cold int init(AVFilterContext *ctx, const char *args)
60 {
61     VolumeContext *vol = ctx->priv;
62
63     if (vol->precision == PRECISION_FIXED) {
64         vol->volume_i = (int)(vol->volume * 256 + 0.5);
65         vol->volume   = vol->volume_i / 256.0;
66         av_log(ctx, AV_LOG_VERBOSE, "volume:(%d/256)(%f)(%1.2fdB) precision:fixed\n",
67                vol->volume_i, vol->volume, 20.0*log(vol->volume)/M_LN10);
68     } else {
69         av_log(ctx, AV_LOG_VERBOSE, "volume:(%f)(%1.2fdB) precision:%s\n",
70                vol->volume, 20.0*log(vol->volume)/M_LN10,
71                precision_str[vol->precision]);
72     }
73
74     return 0;
75 }
76
77 static int query_formats(AVFilterContext *ctx)
78 {
79     VolumeContext *vol = ctx->priv;
80     AVFilterFormats *formats = NULL;
81     AVFilterChannelLayouts *layouts;
82     static const enum AVSampleFormat sample_fmts[][7] = {
83         /* PRECISION_FIXED */
84         {
85             AV_SAMPLE_FMT_U8,
86             AV_SAMPLE_FMT_U8P,
87             AV_SAMPLE_FMT_S16,
88             AV_SAMPLE_FMT_S16P,
89             AV_SAMPLE_FMT_S32,
90             AV_SAMPLE_FMT_S32P,
91             AV_SAMPLE_FMT_NONE
92         },
93         /* PRECISION_FLOAT */
94         {
95             AV_SAMPLE_FMT_FLT,
96             AV_SAMPLE_FMT_FLTP,
97             AV_SAMPLE_FMT_NONE
98         },
99         /* PRECISION_DOUBLE */
100         {
101             AV_SAMPLE_FMT_DBL,
102             AV_SAMPLE_FMT_DBLP,
103             AV_SAMPLE_FMT_NONE
104         }
105     };
106
107     layouts = ff_all_channel_layouts();
108     if (!layouts)
109         return AVERROR(ENOMEM);
110     ff_set_common_channel_layouts(ctx, layouts);
111
112     formats = ff_make_format_list(sample_fmts[vol->precision]);
113     if (!formats)
114         return AVERROR(ENOMEM);
115     ff_set_common_formats(ctx, formats);
116
117     formats = ff_all_samplerates();
118     if (!formats)
119         return AVERROR(ENOMEM);
120     ff_set_common_samplerates(ctx, formats);
121
122     return 0;
123 }
124
125 static inline void scale_samples_u8(uint8_t *dst, const uint8_t *src,
126                                     int nb_samples, int volume)
127 {
128     int i;
129     for (i = 0; i < nb_samples; i++)
130         dst[i] = av_clip_uint8(((((int64_t)src[i] - 128) * volume + 128) >> 8) + 128);
131 }
132
133 static inline void scale_samples_u8_small(uint8_t *dst, const uint8_t *src,
134                                           int nb_samples, int volume)
135 {
136     int i;
137     for (i = 0; i < nb_samples; i++)
138         dst[i] = av_clip_uint8((((src[i] - 128) * volume + 128) >> 8) + 128);
139 }
140
141 static inline void scale_samples_s16(uint8_t *dst, const uint8_t *src,
142                                      int nb_samples, int volume)
143 {
144     int i;
145     int16_t *smp_dst       = (int16_t *)dst;
146     const int16_t *smp_src = (const int16_t *)src;
147     for (i = 0; i < nb_samples; i++)
148         smp_dst[i] = av_clip_int16(((int64_t)smp_src[i] * volume + 128) >> 8);
149 }
150
151 static inline void scale_samples_s16_small(uint8_t *dst, const uint8_t *src,
152                                            int nb_samples, int volume)
153 {
154     int i;
155     int16_t *smp_dst       = (int16_t *)dst;
156     const int16_t *smp_src = (const int16_t *)src;
157     for (i = 0; i < nb_samples; i++)
158         smp_dst[i] = av_clip_int16((smp_src[i] * volume + 128) >> 8);
159 }
160
161 static inline void scale_samples_s32(uint8_t *dst, const uint8_t *src,
162                                      int nb_samples, int volume)
163 {
164     int i;
165     int32_t *smp_dst       = (int32_t *)dst;
166     const int32_t *smp_src = (const int32_t *)src;
167     for (i = 0; i < nb_samples; i++)
168         smp_dst[i] = av_clipl_int32((((int64_t)smp_src[i] * volume + 128) >> 8));
169 }
170
171 static void volume_init(VolumeContext *vol)
172 {
173     vol->samples_align = 1;
174
175     switch (av_get_packed_sample_fmt(vol->sample_fmt)) {
176     case AV_SAMPLE_FMT_U8:
177         if (vol->volume_i < 0x1000000)
178             vol->scale_samples = scale_samples_u8_small;
179         else
180             vol->scale_samples = scale_samples_u8;
181         break;
182     case AV_SAMPLE_FMT_S16:
183         if (vol->volume_i < 0x10000)
184             vol->scale_samples = scale_samples_s16_small;
185         else
186             vol->scale_samples = scale_samples_s16;
187         break;
188     case AV_SAMPLE_FMT_S32:
189         vol->scale_samples = scale_samples_s32;
190         break;
191     case AV_SAMPLE_FMT_FLT:
192         avpriv_float_dsp_init(&vol->fdsp, 0);
193         vol->samples_align = 4;
194         break;
195     case AV_SAMPLE_FMT_DBL:
196         avpriv_float_dsp_init(&vol->fdsp, 0);
197         vol->samples_align = 8;
198         break;
199     }
200
201     if (ARCH_X86)
202         ff_volume_init_x86(vol);
203 }
204
205 static int config_output(AVFilterLink *outlink)
206 {
207     AVFilterContext *ctx = outlink->src;
208     VolumeContext *vol   = ctx->priv;
209     AVFilterLink *inlink = ctx->inputs[0];
210
211     vol->sample_fmt = inlink->format;
212     vol->channels   = av_get_channel_layout_nb_channels(inlink->channel_layout);
213     vol->planes     = av_sample_fmt_is_planar(inlink->format) ? vol->channels : 1;
214
215     volume_init(vol);
216
217     return 0;
218 }
219
220 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
221 {
222     VolumeContext *vol    = inlink->dst->priv;
223     AVFilterLink *outlink = inlink->dst->outputs[0];
224     int nb_samples        = buf->nb_samples;
225     AVFrame *out_buf;
226
227     if (vol->volume == 1.0 || vol->volume_i == 256)
228         return ff_filter_frame(outlink, buf);
229
230     /* do volume scaling in-place if input buffer is writable */
231     if (av_frame_is_writable(buf)) {
232         out_buf = buf;
233     } else {
234         out_buf = ff_get_audio_buffer(inlink, nb_samples);
235         if (!out_buf)
236             return AVERROR(ENOMEM);
237         out_buf->pts = buf->pts;
238     }
239
240     if (vol->precision != PRECISION_FIXED || vol->volume_i > 0) {
241         int p, plane_samples;
242
243         if (av_sample_fmt_is_planar(buf->format))
244             plane_samples = FFALIGN(nb_samples, vol->samples_align);
245         else
246             plane_samples = FFALIGN(nb_samples * vol->channels, vol->samples_align);
247
248         if (vol->precision == PRECISION_FIXED) {
249             for (p = 0; p < vol->planes; p++) {
250                 vol->scale_samples(out_buf->extended_data[p],
251                                    buf->extended_data[p], plane_samples,
252                                    vol->volume_i);
253             }
254         } else if (av_get_packed_sample_fmt(vol->sample_fmt) == AV_SAMPLE_FMT_FLT) {
255             for (p = 0; p < vol->planes; p++) {
256                 vol->fdsp.vector_fmul_scalar((float *)out_buf->extended_data[p],
257                                              (const float *)buf->extended_data[p],
258                                              vol->volume, plane_samples);
259             }
260         } else {
261             for (p = 0; p < vol->planes; p++) {
262                 vol->fdsp.vector_dmul_scalar((double *)out_buf->extended_data[p],
263                                              (const double *)buf->extended_data[p],
264                                              vol->volume, plane_samples);
265             }
266         }
267     }
268
269     if (buf != out_buf)
270         av_frame_free(&buf);
271
272     return ff_filter_frame(outlink, out_buf);
273 }
274
275 static const AVFilterPad avfilter_af_volume_inputs[] = {
276     {
277         .name           = "default",
278         .type           = AVMEDIA_TYPE_AUDIO,
279         .filter_frame   = filter_frame,
280     },
281     { NULL }
282 };
283
284 static const AVFilterPad avfilter_af_volume_outputs[] = {
285     {
286         .name         = "default",
287         .type         = AVMEDIA_TYPE_AUDIO,
288         .config_props = config_output,
289     },
290     { NULL }
291 };
292
293 static const char *const shorthand[] = { "volume", "precision", NULL };
294
295 AVFilter avfilter_af_volume = {
296     .name           = "volume",
297     .description    = NULL_IF_CONFIG_SMALL("Change input volume."),
298     .query_formats  = query_formats,
299     .priv_size      = sizeof(VolumeContext),
300     .init           = init,
301     .inputs         = avfilter_af_volume_inputs,
302     .outputs        = avfilter_af_volume_outputs,
303     .priv_class     = &volume_class,
304     .shorthand      = shorthand,
305 };