libavfilter/af_stereotools.c

   1 /*
   2  * Copyright (C) 2001-2010 Krzysztof Foltman, Markus Schmidt, Thor Harald Johansen
   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 typedef struct StereoToolsContext {
  28     const AVClass *class;
  29
  30     int softclip;
  31     int mute_l;
  32     int mute_r;
  33     int phase_l;
  34     int phase_r;
  35     int mode;
  36     int bmode_in;
  37     int bmode_out;
  38     double slev;
  39     double sbal;
  40     double mlev;
  41     double mpan;
  42     double phase;
  43     double base;
  44     double delay;
  45     double balance_in;
  46     double balance_out;
  47     double phase_sin_coef;
  48     double phase_cos_coef;
  49     double sc_level;
  50     double inv_atan_shape;
  51     double level_in;
  52     double level_out;
  53
  54     double *buffer;
  55     int length;
  56     int pos;
  57 } StereoToolsContext;
  58
  59 #define OFFSET(x) offsetof(StereoToolsContext, x)
  60 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  61
  62 static const AVOption stereotools_options[] = {
  63     { "level_in",    "set level in",     OFFSET(level_in),    AV_OPT_TYPE_DOUBLE, {.dbl=1},   0.015625,  64, A },
  64     { "level_out",   "set level out",    OFFSET(level_out),   AV_OPT_TYPE_DOUBLE, {.dbl=1},   0.015625,  64, A },
  65     { "balance_in",  "set balance in",   OFFSET(balance_in),  AV_OPT_TYPE_DOUBLE, {.dbl=0},  -1,          1, A },
  66     { "balance_out", "set balance out",  OFFSET(balance_out), AV_OPT_TYPE_DOUBLE, {.dbl=0},  -1,          1, A },
  67     { "softclip",    "enable softclip",  OFFSET(softclip),    AV_OPT_TYPE_BOOL,   {.i64=0},   0,          1, A },
  68     { "mutel",       "mute L",           OFFSET(mute_l),      AV_OPT_TYPE_BOOL,   {.i64=0},   0,          1, A },
  69     { "muter",       "mute R",           OFFSET(mute_r),      AV_OPT_TYPE_BOOL,   {.i64=0},   0,          1, A },
  70     { "phasel",      "phase L",          OFFSET(phase_l),     AV_OPT_TYPE_BOOL,   {.i64=0},   0,          1, A },
  71     { "phaser",      "phase R",          OFFSET(phase_r),     AV_OPT_TYPE_BOOL,   {.i64=0},   0,          1, A },
  72     { "mode",        "set stereo mode",  OFFSET(mode),        AV_OPT_TYPE_INT,    {.i64=0},   0,          6, A, "mode" },
  73     {     "lr>lr",   0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=0},   0,          0, A, "mode" },
  74     {     "lr>ms",   0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=1},   0,          0, A, "mode" },
  75     {     "ms>lr",   0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=2},   0,          0, A, "mode" },
  76     {     "lr>ll",   0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=3},   0,          0, A, "mode" },
  77     {     "lr>rr",   0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=4},   0,          0, A, "mode" },
  78     {     "lr>l+r",  0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=5},   0,          0, A, "mode" },
  79     {     "lr>rl",   0,                  0,                   AV_OPT_TYPE_CONST,  {.i64=6},   0,          0, A, "mode" },
  80     { "slev",        "set side level",   OFFSET(slev),        AV_OPT_TYPE_DOUBLE, {.dbl=1},   0.015625,  64, A },
  81     { "sbal",        "set side balance", OFFSET(sbal),        AV_OPT_TYPE_DOUBLE, {.dbl=0},  -1,          1, A },
  82     { "mlev",        "set middle level", OFFSET(mlev),        AV_OPT_TYPE_DOUBLE, {.dbl=1},   0.015625,  64, A },
  83     { "mpan",        "set middle pan",   OFFSET(mpan),        AV_OPT_TYPE_DOUBLE, {.dbl=0},  -1,          1, A },
  84     { "base",        "set stereo base",  OFFSET(base),        AV_OPT_TYPE_DOUBLE, {.dbl=0},  -1,          1, A },
  85     { "delay",       "set delay",        OFFSET(delay),       AV_OPT_TYPE_DOUBLE, {.dbl=0}, -20,         20, A },
  86     { "sclevel",     "set S/C level",    OFFSET(sc_level),    AV_OPT_TYPE_DOUBLE, {.dbl=1},   1,        100, A },
  87     { "phase",       "set stereo phase", OFFSET(phase),       AV_OPT_TYPE_DOUBLE, {.dbl=0},   0,        360, A },
  88     { "bmode_in",    "set balance in mode", OFFSET(bmode_in), AV_OPT_TYPE_INT,    {.i64=0},   0,          2, A, "bmode" },
  89     {     "balance",   0,                0,                   AV_OPT_TYPE_CONST,  {.i64=0},   0,          0, A, "bmode" },
  90     {     "amplitude", 0,                0,                   AV_OPT_TYPE_CONST,  {.i64=1},   0,          0, A, "bmode" },
  91     {     "power",     0,                0,                   AV_OPT_TYPE_CONST,  {.i64=2},   0,          0, A, "bmode" },
  92     { "bmode_out", "set balance out mode", OFFSET(bmode_out), AV_OPT_TYPE_INT,    {.i64=0},   0,          2, A, "bmode" },
  93     { NULL }
  94 };
  95
  96 AVFILTER_DEFINE_CLASS(stereotools);
  97
  98 static int query_formats(AVFilterContext *ctx)
  99 {
 100     AVFilterFormats *formats = NULL;
 101     AVFilterChannelLayouts *layout = NULL;
 102     int ret;
 103
 104     if ((ret = ff_add_format                 (&formats, AV_SAMPLE_FMT_DBL  )) < 0 ||
 105         (ret = ff_set_common_formats         (ctx     , formats            )) < 0 ||
 106         (ret = ff_add_channel_layout         (&layout , AV_CH_LAYOUT_STEREO)) < 0 ||
 107         (ret = ff_set_common_channel_layouts (ctx     , layout             )) < 0)
 108         return ret;
 109
 110     formats = ff_all_samplerates();
 111     return ff_set_common_samplerates(ctx, formats);
 112 }
 113
 114 static int config_input(AVFilterLink *inlink)
 115 {
 116     AVFilterContext *ctx = inlink->dst;
 117     StereoToolsContext *s = ctx->priv;
 118
 119     s->length = 2 * inlink->sample_rate * 0.05;
 120     if (s->length <= 1 || s->length & 1) {
 121         av_log(ctx, AV_LOG_ERROR, "sample rate is too small\n");
 122         return AVERROR(EINVAL);
 123     }
 124     s->buffer = av_calloc(s->length, sizeof(*s->buffer));
 125     if (!s->buffer)
 126         return AVERROR(ENOMEM);
 127
 128     s->inv_atan_shape = 1.0 / atan(s->sc_level);
 129     s->phase_cos_coef = cos(s->phase / 180 * M_PI);
 130     s->phase_sin_coef = sin(s->phase / 180 * M_PI);
 131
 132     return 0;
 133 }
 134
 135 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 136 {
 137     AVFilterContext *ctx = inlink->dst;
 138     AVFilterLink *outlink = ctx->outputs[0];
 139     StereoToolsContext *s = ctx->priv;
 140     const double *src = (const double *)in->data[0];
 141     const double sb = s->base < 0 ? s->base * 0.5 : s->base;
 142     const double sbal = 1 + s->sbal;
 143     const double mpan = 1 + s->mpan;
 144     const double slev = s->slev;
 145     const double mlev = s->mlev;
 146     const double balance_in = s->balance_in;
 147     const double balance_out = s->balance_out;
 148     const double level_in = s->level_in;
 149     const double level_out = s->level_out;
 150     const double sc_level = s->sc_level;
 151     const double delay = s->delay;
 152     const int length = s->length;
 153     const int mute_l = s->mute_l;
 154     const int mute_r = s->mute_r;
 155     const int phase_l = s->phase_l;
 156     const int phase_r = s->phase_r;
 157     double *buffer = s->buffer;
 158     AVFrame *out;
 159     double *dst;
 160     int nbuf = inlink->sample_rate * (fabs(delay) / 1000.);
 161     int n;
 162
 163     nbuf -= nbuf % 2;
 164     if (av_frame_is_writable(in)) {
 165         out = in;
 166     } else {
 167         out = ff_get_audio_buffer(inlink, in->nb_samples);
 168         if (!out) {
 169             av_frame_free(&in);
 170             return AVERROR(ENOMEM);
 171         }
 172         av_frame_copy_props(out, in);
 173     }
 174     dst = (double *)out->data[0];
 175
 176     for (n = 0; n < in->nb_samples; n++, src += 2, dst += 2) {
 177         double L = src[0], R = src[1], l, r, m, S, gl, gr, gd;
 178
 179         L *= level_in;
 180         R *= level_in;
 181
 182         gl = 1. - FFMAX(0., balance_in);
 183         gr = 1. + FFMIN(0., balance_in);
 184         switch (s->bmode_in) {
 185         case 1:
 186             gd = gl - gr;
 187             gl = 1. + gd;
 188             gr = 1. - gd;
 189             break;
 190         case 2:
 191             if (balance_in < 0.) {
 192                 gr = FFMAX(0.5, gr);
 193                 gl = 1. / gr;
 194             } else if (balance_in > 0.) {
 195                 gl = FFMAX(0.5, gl);
 196                 gr = 1. / gl;
 197             }
 198             break;
 199         }
 200         L *= gl;
 201         R *= gr;
 202
 203         if (s->softclip) {
 204             R = s->inv_atan_shape * atan(R * sc_level);
 205             L = s->inv_atan_shape * atan(L * sc_level);
 206         }
 207
 208         switch (s->mode) {
 209         case 0:
 210             m = (L + R) * 0.5;
 211             S = (L - R) * 0.5;
 212             l = m * mlev * FFMIN(1., 2. - mpan) + S * slev * FFMIN(1., 2. - sbal);
 213             r = m * mlev * FFMIN(1., mpan)      - S * slev * FFMIN(1., sbal);
 214             L = l;
 215             R = r;
 216             break;
 217         case 1:
 218             l = L * FFMIN(1., 2. - sbal);
 219             r = R * FFMIN(1., sbal);
 220             L = 0.5 * (l + r) * mlev;
 221             R = 0.5 * (l - r) * slev;
 222             break;
 223         case 2:
 224             l = L * mlev * FFMIN(1., 2. - mpan) + R * slev * FFMIN(1., 2. - sbal);
 225             r = L * mlev * FFMIN(1., mpan)      - R * slev * FFMIN(1., sbal);
 226             L = l;
 227             R = r;
 228             break;
 229         case 3:
 230             R = L;
 231             break;
 232         case 4:
 233             L = R;
 234             break;
 235         case 5:
 236             L = (L + R) / 2;
 237             R = L;
 238             break;
 239         case 6:
 240             l = L;
 241             L = R;
 242             R = l;
 243             m = (L + R) * 0.5;
 244             S = (L - R) * 0.5;
 245             l = m * mlev * FFMIN(1., 2. - mpan) + S * slev * FFMIN(1., 2. - sbal);
 246             r = m * mlev * FFMIN(1., mpan)      - S * slev * FFMIN(1., sbal);
 247             L = l;
 248             R = r;
 249             break;
 250         }
 251
 252         L *= 1. - mute_l;
 253         R *= 1. - mute_r;
 254
 255         L *= (2. * (1. - phase_l)) - 1.;
 256         R *= (2. * (1. - phase_r)) - 1.;
 257
 258         buffer[s->pos  ] = L;
 259         buffer[s->pos+1] = R;
 260
 261         if (delay > 0.) {
 262             R = buffer[(s->pos - (int)nbuf + 1 + length) % length];
 263         } else if (delay < 0.) {
 264             L = buffer[(s->pos - (int)nbuf + length)     % length];
 265         }
 266
 267         l = L + sb * L - sb * R;
 268         r = R + sb * R - sb * L;
 269
 270         L = l;
 271         R = r;
 272
 273         l = L * s->phase_cos_coef - R * s->phase_sin_coef;
 274         r = L * s->phase_sin_coef + R * s->phase_cos_coef;
 275
 276         L = l;
 277         R = r;
 278
 279         s->pos = (s->pos + 2) % s->length;
 280
 281         gl = 1. - FFMAX(0., balance_out);
 282         gr = 1. + FFMIN(0., balance_out);
 283         switch (s->bmode_out) {
 284         case 1:
 285             gd = gl - gr;
 286             gl = 1. + gd;
 287             gr = 1. - gd;
 288             break;
 289         case 2:
 290             if (balance_out < 0.) {
 291                 gr = FFMAX(0.5, gr);
 292                 gl = 1. / gr;
 293             } else if (balance_out > 0.) {
 294                 gl = FFMAX(0.5, gl);
 295                 gr = 1. / gl;
 296             }
 297             break;
 298         }
 299         L *= gl;
 300         R *= gr;
 301
 302
 303         L *= level_out;
 304         R *= level_out;
 305
 306         dst[0] = L;
 307         dst[1] = R;
 308     }
 309
 310     if (out != in)
 311         av_frame_free(&in);
 312     return ff_filter_frame(outlink, out);
 313 }
 314
 315 static av_cold void uninit(AVFilterContext *ctx)
 316 {
 317     StereoToolsContext *s = ctx->priv;
 318
 319     av_freep(&s->buffer);
 320 }
 321
 322 static const AVFilterPad inputs[] = {
 323     {
 324         .name         = "default",
 325         .type         = AVMEDIA_TYPE_AUDIO,
 326         .filter_frame = filter_frame,
 327         .config_props = config_input,
 328     },
 329     { NULL }
 330 };
 331
 332 static const AVFilterPad outputs[] = {
 333     {
 334         .name = "default",
 335         .type = AVMEDIA_TYPE_AUDIO,
 336     },
 337     { NULL }
 338 };
 339
 340 AVFilter ff_af_stereotools = {
 341     .name           = "stereotools",
 342     .description    = NULL_IF_CONFIG_SMALL("Apply various stereo tools."),
 343     .query_formats  = query_formats,
 344     .priv_size      = sizeof(StereoToolsContext),
 345     .priv_class     = &stereotools_class,
 346     .uninit         = uninit,
 347     .inputs         = inputs,
 348     .outputs        = outputs,
 349 };