git.sesse.net Git - ffmpeg/blob - libavfilter/af_asoftclip.c

   1 /*
   2  * Copyright (c) 2019 The FFmpeg Project
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include "libavutil/channel_layout.h"
  22 #include "libavutil/opt.h"
  23 #include "avfilter.h"
  24 #include "audio.h"
  25 #include "formats.h"
  26
  27 enum ASoftClipTypes {
  28     ASC_TANH,
  29     ASC_ATAN,
  30     ASC_CUBIC,
  31     ASC_EXP,
  32     ASC_ALG,
  33     ASC_QUINTIC,
  34     ASC_SIN,
  35     NB_TYPES,
  36 };
  37
  38 typedef struct ASoftClipContext {
  39     const AVClass *class;
  40
  41     int type;
  42     double param;
  43
  44     void (*filter)(struct ASoftClipContext *s, void **dst, const void **src,
  45                    int nb_samples, int channels, int start, int end);
  46 } ASoftClipContext;
  47
  48 #define OFFSET(x) offsetof(ASoftClipContext, x)
  49 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
  50
  51 static const AVOption asoftclip_options[] = {
  52     { "type", "set softclip type", OFFSET(type), AV_OPT_TYPE_INT,    {.i64=0},          0, NB_TYPES-1, A, "types" },
  53     { "tanh",                NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_TANH},   0,          0, A, "types" },
  54     { "atan",                NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_ATAN},   0,          0, A, "types" },
  55     { "cubic",               NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_CUBIC},  0,          0, A, "types" },
  56     { "exp",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_EXP},    0,          0, A, "types" },
  57     { "alg",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_ALG},    0,          0, A, "types" },
  58     { "quintic",             NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_QUINTIC},0,          0, A, "types" },
  59     { "sin",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_SIN},    0,          0, A, "types" },
  60     { "param", "set softclip parameter", OFFSET(param), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.01,        3, A },
  61     { NULL }
  62 };
  63
  64 AVFILTER_DEFINE_CLASS(asoftclip);
  65
  66 static int query_formats(AVFilterContext *ctx)
  67 {
  68     AVFilterFormats *formats = NULL;
  69     AVFilterChannelLayouts *layouts = NULL;
  70     static const enum AVSampleFormat sample_fmts[] = {
  71         AV_SAMPLE_FMT_FLT, AV_SAMPLE_FMT_FLTP,
  72         AV_SAMPLE_FMT_DBL, AV_SAMPLE_FMT_DBLP,
  73         AV_SAMPLE_FMT_NONE
  74     };
  75     int ret;
  76
  77     formats = ff_make_format_list(sample_fmts);
  78     if (!formats)
  79         return AVERROR(ENOMEM);
  80     ret = ff_set_common_formats(ctx, formats);
  81     if (ret < 0)
  82         return ret;
  83
  84     layouts = ff_all_channel_counts();
  85     if (!layouts)
  86         return AVERROR(ENOMEM);
  87
  88     ret = ff_set_common_channel_layouts(ctx, layouts);
  89     if (ret < 0)
  90         return ret;
  91
  92     formats = ff_all_samplerates();
  93     return ff_set_common_samplerates(ctx, formats);
  94 }
  95
  96 #define SQR(x) ((x) * (x))
  97
  98 static void filter_flt(ASoftClipContext *s,
  99                        void **dptr, const void **sptr,
 100                        int nb_samples, int channels,
 101                        int start, int end)
 102 {
 103     float param = s->param;
 104
 105     for (int c = start; c < end; c++) {
 106         const float *src = sptr[c];
 107         float *dst = dptr[c];
 108
 109         switch (s->type) {
 110         case ASC_TANH:
 111             for (int n = 0; n < nb_samples; n++) {
 112                 dst[n] = tanhf(src[n] * param);
 113             }
 114             break;
 115         case ASC_ATAN:
 116             for (int n = 0; n < nb_samples; n++)
 117                 dst[n] = 2.f / M_PI * atanf(src[n] * param);
 118             break;
 119         case ASC_CUBIC:
 120             for (int n = 0; n < nb_samples; n++) {
 121                 if (FFABS(src[n]) >= 1.5f)
 122                     dst[n] = FFSIGN(src[n]);
 123                 else
 124                     dst[n] = src[n] - 0.1481f * powf(src[n], 3.f);
 125             }
 126             break;
 127         case ASC_EXP:
 128             for (int n = 0; n < nb_samples; n++)
 129                 dst[n] = 2.f / (1.f + expf(-2.f * src[n])) - 1.;
 130             break;
 131         case ASC_ALG:
 132             for (int n = 0; n < nb_samples; n++)
 133                 dst[n] = src[n] / (sqrtf(param + src[n] * src[n]));
 134             break;
 135         case ASC_QUINTIC:
 136             for (int n = 0; n < nb_samples; n++) {
 137                 if (FFABS(src[n]) >= 1.25)
 138                     dst[n] = FFSIGN(src[n]);
 139                 else
 140                     dst[n] = src[n] - 0.08192f * powf(src[n], 5.f);
 141             }
 142             break;
 143         case ASC_SIN:
 144             for (int n = 0; n < nb_samples; n++) {
 145                 if (FFABS(src[n]) >= M_PI_2)
 146                     dst[n] = FFSIGN(src[n]);
 147                 else
 148                     dst[n] = sinf(src[n]);
 149             }
 150             break;
 151         }
 152     }
 153 }
 154
 155 static void filter_dbl(ASoftClipContext *s,
 156                        void **dptr, const void **sptr,
 157                        int nb_samples, int channels,
 158                        int start, int end)
 159 {
 160     double param = s->param;
 161
 162     for (int c = start; c < end; c++) {
 163         const double *src = sptr[c];
 164         double *dst = dptr[c];
 165
 166         switch (s->type) {
 167         case ASC_TANH:
 168             for (int n = 0; n < nb_samples; n++) {
 169                 dst[n] = tanh(src[n] * param);
 170             }
 171             break;
 172         case ASC_ATAN:
 173             for (int n = 0; n < nb_samples; n++)
 174                 dst[n] = 2. / M_PI * atan(src[n] * param);
 175             break;
 176         case ASC_CUBIC:
 177             for (int n = 0; n < nb_samples; n++) {
 178                 if (FFABS(src[n]) >= 1.5)
 179                     dst[n] = FFSIGN(src[n]);
 180                 else
 181                     dst[n] = src[n] - 0.1481 * pow(src[n], 3.);
 182             }
 183             break;
 184         case ASC_EXP:
 185             for (int n = 0; n < nb_samples; n++)
 186                 dst[n] = 2. / (1. + exp(-2. * src[n])) - 1.;
 187             break;
 188         case ASC_ALG:
 189             for (int n = 0; n < nb_samples; n++)
 190                 dst[n] = src[n] / (sqrt(param + src[n] * src[n]));
 191             break;
 192         case ASC_QUINTIC:
 193             for (int n = 0; n < nb_samples; n++) {
 194                 if (FFABS(src[n]) >= 1.25)
 195                     dst[n] = FFSIGN(src[n]);
 196                 else
 197                     dst[n] = src[n] - 0.08192 * pow(src[n], 5.);
 198             }
 199             break;
 200         case ASC_SIN:
 201             for (int n = 0; n < nb_samples; n++) {
 202                 if (FFABS(src[n]) >= M_PI_2)
 203                     dst[n] = FFSIGN(src[n]);
 204                 else
 205                     dst[n] = sin(src[n]);
 206             }
 207             break;
 208         }
 209     }
 210 }
 211
 212 static int config_input(AVFilterLink *inlink)
 213 {
 214     AVFilterContext *ctx = inlink->dst;
 215     ASoftClipContext *s = ctx->priv;
 216
 217     switch (inlink->format) {
 218     case AV_SAMPLE_FMT_FLT:
 219     case AV_SAMPLE_FMT_FLTP: s->filter = filter_flt; break;
 220     case AV_SAMPLE_FMT_DBL:
 221     case AV_SAMPLE_FMT_DBLP: s->filter = filter_dbl; break;
 222     }
 223
 224     return 0;
 225 }
 226
 227 typedef struct ThreadData {
 228     AVFrame *in, *out;
 229     int nb_samples;
 230     int channels;
 231 } ThreadData;
 232
 233 static int filter_channels(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 234 {
 235     ASoftClipContext *s = ctx->priv;
 236     ThreadData *td = arg;
 237     AVFrame *out = td->out;
 238     AVFrame *in = td->in;
 239     const int channels = td->channels;
 240     const int nb_samples = td->nb_samples;
 241     const int start = (channels * jobnr) / nb_jobs;
 242     const int end = (channels * (jobnr+1)) / nb_jobs;
 243
 244     s->filter(s, (void **)out->extended_data, (const void **)in->extended_data,
 245               nb_samples, channels, start, end);
 246
 247     return 0;
 248 }
 249
 250 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 251 {
 252     AVFilterContext *ctx = inlink->dst;
 253     AVFilterLink *outlink = ctx->outputs[0];
 254     int nb_samples, channels;
 255     ThreadData td;
 256     AVFrame *out;
 257
 258     if (av_frame_is_writable(in)) {
 259         out = in;
 260     } else {
 261         out = ff_get_audio_buffer(outlink, in->nb_samples);
 262         if (!out) {
 263             av_frame_free(&in);
 264             return AVERROR(ENOMEM);
 265         }
 266         av_frame_copy_props(out, in);
 267     }
 268
 269     if (av_sample_fmt_is_planar(in->format)) {
 270         nb_samples = in->nb_samples;
 271         channels = in->channels;
 272     } else {
 273         nb_samples = in->channels * in->nb_samples;
 274         channels = 1;
 275     }
 276
 277     td.in = in;
 278     td.out = out;
 279     td.nb_samples = nb_samples;
 280     td.channels = channels;
 281     ctx->internal->execute(ctx, filter_channels, &td, NULL, FFMIN(channels,
 282                                                             ff_filter_get_nb_threads(ctx)));
 283
 284     if (out != in)
 285         av_frame_free(&in);
 286
 287     return ff_filter_frame(outlink, out);
 288 }
 289
 290 static const AVFilterPad inputs[] = {
 291     {
 292         .name         = "default",
 293         .type         = AVMEDIA_TYPE_AUDIO,
 294         .filter_frame = filter_frame,
 295         .config_props = config_input,
 296     },
 297     { NULL }
 298 };
 299
 300 static const AVFilterPad outputs[] = {
 301     {
 302         .name = "default",
 303         .type = AVMEDIA_TYPE_AUDIO,
 304     },
 305     { NULL }
 306 };
 307
 308 AVFilter ff_af_asoftclip = {
 309     .name           = "asoftclip",
 310     .description    = NULL_IF_CONFIG_SMALL("Audio Soft Clipper."),
 311     .query_formats  = query_formats,
 312     .priv_size      = sizeof(ASoftClipContext),
 313     .priv_class     = &asoftclip_class,
 314     .inputs         = inputs,
 315     .outputs        = outputs,
 316     .process_command = ff_filter_process_command,
 317     .flags          = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
 318                       AVFILTER_FLAG_SLICE_THREADS,
 319 };