yading@10: /*
yading@10:  * Copyright (c) 2011 Stefano Sabatini
yading@10:  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * audio volume filter
yading@10:  */
yading@10: 
yading@10: #include "libavutil/channel_layout.h"
yading@10: #include "libavutil/common.h"
yading@10: #include "libavutil/eval.h"
yading@10: #include "libavutil/float_dsp.h"
yading@10: #include "libavutil/opt.h"
yading@10: #include "audio.h"
yading@10: #include "avfilter.h"
yading@10: #include "formats.h"
yading@10: #include "internal.h"
yading@10: #include "af_volume.h"
yading@10: 
yading@10: static const char *precision_str[] = {
yading@10:     "fixed", "float", "double"
yading@10: };
yading@10: 
yading@10: #define OFFSET(x) offsetof(VolumeContext, x)
yading@10: #define A AV_OPT_FLAG_AUDIO_PARAM
yading@10: #define F AV_OPT_FLAG_FILTERING_PARAM
yading@10: 
yading@10: static const AVOption volume_options[] = {
yading@10:     { "volume", "set volume adjustment",
yading@10:             OFFSET(volume), AV_OPT_TYPE_DOUBLE, { .dbl = 1.0 }, 0, 0x7fffff, A|F },
yading@10:     { "precision", "select mathematical precision",
yading@10:             OFFSET(precision), AV_OPT_TYPE_INT, { .i64 = PRECISION_FLOAT }, PRECISION_FIXED, PRECISION_DOUBLE, A|F, "precision" },
yading@10:         { "fixed",  "select 8-bit fixed-point",     0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_FIXED  }, INT_MIN, INT_MAX, A|F, "precision" },
yading@10:         { "float",  "select 32-bit floating-point", 0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_FLOAT  }, INT_MIN, INT_MAX, A|F, "precision" },
yading@10:         { "double", "select 64-bit floating-point", 0, AV_OPT_TYPE_CONST, { .i64 = PRECISION_DOUBLE }, INT_MIN, INT_MAX, A|F, "precision" },
yading@10:     { NULL },
yading@10: };
yading@10: 
yading@10: AVFILTER_DEFINE_CLASS(volume);
yading@10: 
yading@10: static av_cold int init(AVFilterContext *ctx)
yading@10: {
yading@10:     VolumeContext *vol = ctx->priv;
yading@10: 
yading@10:     if (vol->precision == PRECISION_FIXED) {
yading@10:         vol->volume_i = (int)(vol->volume * 256 + 0.5);
yading@10:         vol->volume   = vol->volume_i / 256.0;
yading@10:         av_log(ctx, AV_LOG_VERBOSE, "volume:(%d/256)(%f)(%1.2fdB) precision:fixed\n",
yading@10:                vol->volume_i, vol->volume, 20.0*log(vol->volume)/M_LN10);
yading@10:     } else {
yading@10:         av_log(ctx, AV_LOG_VERBOSE, "volume:(%f)(%1.2fdB) precision:%s\n",
yading@10:                vol->volume, 20.0*log(vol->volume)/M_LN10,
yading@10:                precision_str[vol->precision]);
yading@10:     }
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int query_formats(AVFilterContext *ctx)
yading@10: {
yading@10:     VolumeContext *vol = ctx->priv;
yading@10:     AVFilterFormats *formats = NULL;
yading@10:     AVFilterChannelLayouts *layouts;
yading@10:     static const enum AVSampleFormat sample_fmts[][7] = {
yading@10:         [PRECISION_FIXED] = {
yading@10:             AV_SAMPLE_FMT_U8,
yading@10:             AV_SAMPLE_FMT_U8P,
yading@10:             AV_SAMPLE_FMT_S16,
yading@10:             AV_SAMPLE_FMT_S16P,
yading@10:             AV_SAMPLE_FMT_S32,
yading@10:             AV_SAMPLE_FMT_S32P,
yading@10:             AV_SAMPLE_FMT_NONE
yading@10:         },
yading@10:         [PRECISION_FLOAT] = {
yading@10:             AV_SAMPLE_FMT_FLT,
yading@10:             AV_SAMPLE_FMT_FLTP,
yading@10:             AV_SAMPLE_FMT_NONE
yading@10:         },
yading@10:         [PRECISION_DOUBLE] = {
yading@10:             AV_SAMPLE_FMT_DBL,
yading@10:             AV_SAMPLE_FMT_DBLP,
yading@10:             AV_SAMPLE_FMT_NONE
yading@10:         }
yading@10:     };
yading@10: 
yading@10:     layouts = ff_all_channel_layouts();
yading@10:     if (!layouts)
yading@10:         return AVERROR(ENOMEM);
yading@10:     ff_set_common_channel_layouts(ctx, layouts);
yading@10: 
yading@10:     formats = ff_make_format_list(sample_fmts[vol->precision]);
yading@10:     if (!formats)
yading@10:         return AVERROR(ENOMEM);
yading@10:     ff_set_common_formats(ctx, formats);
yading@10: 
yading@10:     formats = ff_all_samplerates();
yading@10:     if (!formats)
yading@10:         return AVERROR(ENOMEM);
yading@10:     ff_set_common_samplerates(ctx, formats);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static inline void scale_samples_u8(uint8_t *dst, const uint8_t *src,
yading@10:                                     int nb_samples, int volume)
yading@10: {
yading@10:     int i;
yading@10:     for (i = 0; i < nb_samples; i++)
yading@10:         dst[i] = av_clip_uint8(((((int64_t)src[i] - 128) * volume + 128) >> 8) + 128);
yading@10: }
yading@10: 
yading@10: static inline void scale_samples_u8_small(uint8_t *dst, const uint8_t *src,
yading@10:                                           int nb_samples, int volume)
yading@10: {
yading@10:     int i;
yading@10:     for (i = 0; i < nb_samples; i++)
yading@10:         dst[i] = av_clip_uint8((((src[i] - 128) * volume + 128) >> 8) + 128);
yading@10: }
yading@10: 
yading@10: static inline void scale_samples_s16(uint8_t *dst, const uint8_t *src,
yading@10:                                      int nb_samples, int volume)
yading@10: {
yading@10:     int i;
yading@10:     int16_t *smp_dst       = (int16_t *)dst;
yading@10:     const int16_t *smp_src = (const int16_t *)src;
yading@10:     for (i = 0; i < nb_samples; i++)
yading@10:         smp_dst[i] = av_clip_int16(((int64_t)smp_src[i] * volume + 128) >> 8);
yading@10: }
yading@10: 
yading@10: static inline void scale_samples_s16_small(uint8_t *dst, const uint8_t *src,
yading@10:                                            int nb_samples, int volume)
yading@10: {
yading@10:     int i;
yading@10:     int16_t *smp_dst       = (int16_t *)dst;
yading@10:     const int16_t *smp_src = (const int16_t *)src;
yading@10:     for (i = 0; i < nb_samples; i++)
yading@10:         smp_dst[i] = av_clip_int16((smp_src[i] * volume + 128) >> 8);
yading@10: }
yading@10: 
yading@10: static inline void scale_samples_s32(uint8_t *dst, const uint8_t *src,
yading@10:                                      int nb_samples, int volume)
yading@10: {
yading@10:     int i;
yading@10:     int32_t *smp_dst       = (int32_t *)dst;
yading@10:     const int32_t *smp_src = (const int32_t *)src;
yading@10:     for (i = 0; i < nb_samples; i++)
yading@10:         smp_dst[i] = av_clipl_int32((((int64_t)smp_src[i] * volume + 128) >> 8));
yading@10: }
yading@10: 
yading@10: static void volume_init(VolumeContext *vol)
yading@10: {
yading@10:     vol->samples_align = 1;
yading@10: 
yading@10:     switch (av_get_packed_sample_fmt(vol->sample_fmt)) {
yading@10:     case AV_SAMPLE_FMT_U8:
yading@10:         if (vol->volume_i < 0x1000000)
yading@10:             vol->scale_samples = scale_samples_u8_small;
yading@10:         else
yading@10:             vol->scale_samples = scale_samples_u8;
yading@10:         break;
yading@10:     case AV_SAMPLE_FMT_S16:
yading@10:         if (vol->volume_i < 0x10000)
yading@10:             vol->scale_samples = scale_samples_s16_small;
yading@10:         else
yading@10:             vol->scale_samples = scale_samples_s16;
yading@10:         break;
yading@10:     case AV_SAMPLE_FMT_S32:
yading@10:         vol->scale_samples = scale_samples_s32;
yading@10:         break;
yading@10:     case AV_SAMPLE_FMT_FLT:
yading@10:         avpriv_float_dsp_init(&vol->fdsp, 0);
yading@10:         vol->samples_align = 4;
yading@10:         break;
yading@10:     case AV_SAMPLE_FMT_DBL:
yading@10:         avpriv_float_dsp_init(&vol->fdsp, 0);
yading@10:         vol->samples_align = 8;
yading@10:         break;
yading@10:     }
yading@10: 
yading@10:     if (ARCH_X86)
yading@10:         ff_volume_init_x86(vol);
yading@10: }
yading@10: 
yading@10: static int config_output(AVFilterLink *outlink)
yading@10: {
yading@10:     AVFilterContext *ctx = outlink->src;
yading@10:     VolumeContext *vol   = ctx->priv;
yading@10:     AVFilterLink *inlink = ctx->inputs[0];
yading@10: 
yading@10:     vol->sample_fmt = inlink->format;
yading@10:     vol->channels   = av_get_channel_layout_nb_channels(inlink->channel_layout);
yading@10:     vol->planes     = av_sample_fmt_is_planar(inlink->format) ? vol->channels : 1;
yading@10: 
yading@10:     volume_init(vol);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
yading@10: {
yading@10:     VolumeContext *vol    = inlink->dst->priv;
yading@10:     AVFilterLink *outlink = inlink->dst->outputs[0];
yading@10:     int nb_samples        = buf->nb_samples;
yading@10:     AVFrame *out_buf;
yading@10: 
yading@10:     if (vol->volume == 1.0 || vol->volume_i == 256)
yading@10:         return ff_filter_frame(outlink, buf);
yading@10: 
yading@10:     /* do volume scaling in-place if input buffer is writable */
yading@10:     if (av_frame_is_writable(buf)) {
yading@10:         out_buf = buf;
yading@10:     } else {
yading@10:         out_buf = ff_get_audio_buffer(inlink, nb_samples);
yading@10:         if (!out_buf)
yading@10:             return AVERROR(ENOMEM);
yading@10:         av_frame_copy_props(out_buf, buf);
yading@10:     }
yading@10: 
yading@10:     if (vol->precision != PRECISION_FIXED || vol->volume_i > 0) {
yading@10:         int p, plane_samples;
yading@10: 
yading@10:         if (av_sample_fmt_is_planar(buf->format))
yading@10:             plane_samples = FFALIGN(nb_samples, vol->samples_align);
yading@10:         else
yading@10:             plane_samples = FFALIGN(nb_samples * vol->channels, vol->samples_align);
yading@10: 
yading@10:         if (vol->precision == PRECISION_FIXED) {
yading@10:             for (p = 0; p < vol->planes; p++) {
yading@10:                 vol->scale_samples(out_buf->extended_data[p],
yading@10:                                    buf->extended_data[p], plane_samples,
yading@10:                                    vol->volume_i);
yading@10:             }
yading@10:         } else if (av_get_packed_sample_fmt(vol->sample_fmt) == AV_SAMPLE_FMT_FLT) {
yading@10:             for (p = 0; p < vol->planes; p++) {
yading@10:                 vol->fdsp.vector_fmul_scalar((float *)out_buf->extended_data[p],
yading@10:                                              (const float *)buf->extended_data[p],
yading@10:                                              vol->volume, plane_samples);
yading@10:             }
yading@10:         } else {
yading@10:             for (p = 0; p < vol->planes; p++) {
yading@10:                 vol->fdsp.vector_dmul_scalar((double *)out_buf->extended_data[p],
yading@10:                                              (const double *)buf->extended_data[p],
yading@10:                                              vol->volume, plane_samples);
yading@10:             }
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     if (buf != out_buf)
yading@10:         av_frame_free(&buf);
yading@10: 
yading@10:     return ff_filter_frame(outlink, out_buf);
yading@10: }
yading@10: 
yading@10: static const AVFilterPad avfilter_af_volume_inputs[] = {
yading@10:     {
yading@10:         .name           = "default",
yading@10:         .type           = AVMEDIA_TYPE_AUDIO,
yading@10:         .filter_frame   = filter_frame,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: static const AVFilterPad avfilter_af_volume_outputs[] = {
yading@10:     {
yading@10:         .name         = "default",
yading@10:         .type         = AVMEDIA_TYPE_AUDIO,
yading@10:         .config_props = config_output,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFilter avfilter_af_volume = {
yading@10:     .name           = "volume",
yading@10:     .description    = NULL_IF_CONFIG_SMALL("Change input volume."),
yading@10:     .query_formats  = query_formats,
yading@10:     .priv_size      = sizeof(VolumeContext),
yading@10:     .priv_class     = &volume_class,
yading@10:     .init           = init,
yading@10:     .inputs         = avfilter_af_volume_inputs,
yading@10:     .outputs        = avfilter_af_volume_outputs,
yading@10: };