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

   1 /*
   2  * Copyright (c) 2016 Paul B Mahol
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published
   8  * by the Free Software Foundation; either version 2.1 of the License,
   9  * 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/audio_fifo.h"
  22 #include "libavutil/avstring.h"
  23 #include "libavfilter/internal.h"
  24 #include "libavutil/common.h"
  25 #include "libavutil/opt.h"
  26 #include "libavcodec/avfft.h"
  27 #include "libavutil/eval.h"
  28 #include "audio.h"
  29 #include "filters.h"
  30 #include "window_func.h"
  31
  32 typedef struct AFFTFiltContext {
  33     const AVClass *class;
  34     char *real_str;
  35     char *img_str;
  36     int fft_size;
  37     int fft_bits;
  38
  39     FFTContext *fft, *ifft;
  40     FFTComplex **fft_data;
  41     FFTComplex **fft_temp;
  42     int nb_exprs;
  43     int window_size;
  44     AVExpr **real;
  45     AVExpr **imag;
  46     AVAudioFifo *fifo;
  47     int64_t pts;
  48     int hop_size;
  49     float overlap;
  50     AVFrame *buffer;
  51     int eof;
  52     int win_func;
  53     float *window_func_lut;
  54 } AFFTFiltContext;
  55
  56 static const char *const var_names[] = {            "sr",     "b",       "nb",        "ch",        "chs",   "pts",     "re",     "im", NULL };
  57 enum                                   { VAR_SAMPLE_RATE, VAR_BIN, VAR_NBBINS, VAR_CHANNEL, VAR_CHANNELS, VAR_PTS, VAR_REAL, VAR_IMAG, VAR_VARS_NB };
  58
  59 #define OFFSET(x) offsetof(AFFTFiltContext, x)
  60 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  61
  62 static const AVOption afftfilt_options[] = {
  63     { "real", "set channels real expressions",       OFFSET(real_str), AV_OPT_TYPE_STRING, {.str = "re" }, 0, 0, A },
  64     { "imag", "set channels imaginary expressions",  OFFSET(img_str),  AV_OPT_TYPE_STRING, {.str = "im" }, 0, 0, A },
  65     { "win_size", "set window size", OFFSET(fft_size), AV_OPT_TYPE_INT, {.i64=4096}, 16, 131072, A },
  66     { "win_func", "set window function", OFFSET(win_func), AV_OPT_TYPE_INT, {.i64 = WFUNC_HANNING}, 0, NB_WFUNC-1, A, "win_func" },
  67         { "rect",     "Rectangular",      0, AV_OPT_TYPE_CONST, {.i64=WFUNC_RECT},     0, 0, A, "win_func" },
  68         { "bartlett", "Bartlett",         0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BARTLETT}, 0, 0, A, "win_func" },
  69         { "hann",     "Hann",             0, AV_OPT_TYPE_CONST, {.i64=WFUNC_HANNING},  0, 0, A, "win_func" },
  70         { "hanning",  "Hanning",          0, AV_OPT_TYPE_CONST, {.i64=WFUNC_HANNING},  0, 0, A, "win_func" },
  71         { "hamming",  "Hamming",          0, AV_OPT_TYPE_CONST, {.i64=WFUNC_HAMMING},  0, 0, A, "win_func" },
  72         { "blackman", "Blackman",         0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BLACKMAN}, 0, 0, A, "win_func" },
  73         { "welch",    "Welch",            0, AV_OPT_TYPE_CONST, {.i64=WFUNC_WELCH},    0, 0, A, "win_func" },
  74         { "flattop",  "Flat-top",         0, AV_OPT_TYPE_CONST, {.i64=WFUNC_FLATTOP},  0, 0, A, "win_func" },
  75         { "bharris",  "Blackman-Harris",  0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BHARRIS},  0, 0, A, "win_func" },
  76         { "bnuttall", "Blackman-Nuttall", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BNUTTALL}, 0, 0, A, "win_func" },
  77         { "bhann",    "Bartlett-Hann",    0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BHANN},    0, 0, A, "win_func" },
  78         { "sine",     "Sine",             0, AV_OPT_TYPE_CONST, {.i64=WFUNC_SINE},     0, 0, A, "win_func" },
  79         { "nuttall",  "Nuttall",          0, AV_OPT_TYPE_CONST, {.i64=WFUNC_NUTTALL},  0, 0, A, "win_func" },
  80         { "lanczos",  "Lanczos",          0, AV_OPT_TYPE_CONST, {.i64=WFUNC_LANCZOS},  0, 0, A, "win_func" },
  81         { "gauss",    "Gauss",            0, AV_OPT_TYPE_CONST, {.i64=WFUNC_GAUSS},    0, 0, A, "win_func" },
  82         { "tukey",    "Tukey",            0, AV_OPT_TYPE_CONST, {.i64=WFUNC_TUKEY},    0, 0, A, "win_func" },
  83         { "dolph",    "Dolph-Chebyshev",  0, AV_OPT_TYPE_CONST, {.i64=WFUNC_DOLPH},    0, 0, A, "win_func" },
  84         { "cauchy",   "Cauchy",           0, AV_OPT_TYPE_CONST, {.i64=WFUNC_CAUCHY},   0, 0, A, "win_func" },
  85         { "parzen",   "Parzen",           0, AV_OPT_TYPE_CONST, {.i64=WFUNC_PARZEN},   0, 0, A, "win_func" },
  86         { "poisson",  "Poisson",          0, AV_OPT_TYPE_CONST, {.i64=WFUNC_POISSON},  0, 0, A, "win_func" },
  87         { "bohman",   "Bohman",           0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BOHMAN},   0, 0, A, "win_func" },
  88     { "overlap", "set window overlap", OFFSET(overlap), AV_OPT_TYPE_FLOAT, {.dbl=0.75}, 0,  1, A },
  89     { NULL },
  90 };
  91
  92 AVFILTER_DEFINE_CLASS(afftfilt);
  93
  94 static inline double getreal(void *priv, double x, double ch)
  95 {
  96     AFFTFiltContext *s = priv;
  97     int ich, ix;
  98
  99     ich = av_clip(ch, 0, s->nb_exprs - 1);
 100     ix = av_clip(x, 0, s->window_size / 2);
 101
 102     return s->fft_data[ich][ix].re;
 103 }
 104
 105 static inline double getimag(void *priv, double x, double ch)
 106 {
 107     AFFTFiltContext *s = priv;
 108     int ich, ix;
 109
 110     ich = av_clip(ch, 0, s->nb_exprs - 1);
 111     ix = av_clip(x, 0, s->window_size / 2);
 112
 113     return s->fft_data[ich][ix].im;
 114 }
 115
 116 static double realf(void *priv, double x, double ch) { return getreal(priv, x, ch); }
 117 static double imagf(void *priv, double x, double ch) { return getimag(priv, x, ch); }
 118
 119 static const char *const func2_names[]    = { "real", "imag", NULL };
 120 double (*func2[])(void *, double, double) = {  realf,  imagf, NULL };
 121
 122 static int config_input(AVFilterLink *inlink)
 123 {
 124     AVFilterContext *ctx = inlink->dst;
 125     AFFTFiltContext *s = ctx->priv;
 126     char *saveptr = NULL;
 127     int ret = 0, ch;
 128     float overlap;
 129     char *args;
 130     const char *last_expr = "1";
 131
 132     s->pts  = AV_NOPTS_VALUE;
 133     s->fft_bits = av_log2(s->fft_size);
 134     s->fft  = av_fft_init(s->fft_bits, 0);
 135     s->ifft = av_fft_init(s->fft_bits, 1);
 136     if (!s->fft || !s->ifft)
 137         return AVERROR(ENOMEM);
 138
 139     s->window_size = 1 << s->fft_bits;
 140
 141     s->fft_data = av_calloc(inlink->channels, sizeof(*s->fft_data));
 142     if (!s->fft_data)
 143         return AVERROR(ENOMEM);
 144
 145     s->fft_temp = av_calloc(inlink->channels, sizeof(*s->fft_temp));
 146     if (!s->fft_temp)
 147         return AVERROR(ENOMEM);
 148
 149     for (ch = 0; ch < inlink->channels; ch++) {
 150         s->fft_data[ch] = av_calloc(s->window_size, sizeof(**s->fft_data));
 151         if (!s->fft_data[ch])
 152             return AVERROR(ENOMEM);
 153     }
 154
 155     for (ch = 0; ch < inlink->channels; ch++) {
 156         s->fft_temp[ch] = av_calloc(s->window_size, sizeof(**s->fft_temp));
 157         if (!s->fft_temp[ch])
 158             return AVERROR(ENOMEM);
 159     }
 160
 161     s->real = av_calloc(inlink->channels, sizeof(*s->real));
 162     if (!s->real)
 163         return AVERROR(ENOMEM);
 164
 165     s->imag = av_calloc(inlink->channels, sizeof(*s->imag));
 166     if (!s->imag)
 167         return AVERROR(ENOMEM);
 168
 169     args = av_strdup(s->real_str);
 170     if (!args)
 171         return AVERROR(ENOMEM);
 172
 173     for (ch = 0; ch < inlink->channels; ch++) {
 174         char *arg = av_strtok(ch == 0 ? args : NULL, "|", &saveptr);
 175
 176         ret = av_expr_parse(&s->real[ch], arg ? arg : last_expr, var_names,
 177                             NULL, NULL, func2_names, func2, 0, ctx);
 178         if (ret < 0)
 179             break;
 180         if (arg)
 181             last_expr = arg;
 182         s->nb_exprs++;
 183     }
 184
 185     av_free(args);
 186
 187     args = av_strdup(s->img_str ? s->img_str : s->real_str);
 188     if (!args)
 189         return AVERROR(ENOMEM);
 190
 191     for (ch = 0; ch < inlink->channels; ch++) {
 192         char *arg = av_strtok(ch == 0 ? args : NULL, "|", &saveptr);
 193
 194         ret = av_expr_parse(&s->imag[ch], arg ? arg : last_expr, var_names,
 195                             NULL, NULL, func2_names, func2, 0, ctx);
 196         if (ret < 0)
 197             break;
 198         if (arg)
 199             last_expr = arg;
 200     }
 201
 202     av_free(args);
 203
 204     s->fifo = av_audio_fifo_alloc(inlink->format, inlink->channels, s->window_size);
 205     if (!s->fifo)
 206         return AVERROR(ENOMEM);
 207
 208     s->window_func_lut = av_realloc_f(s->window_func_lut, s->window_size,
 209                                       sizeof(*s->window_func_lut));
 210     if (!s->window_func_lut)
 211         return AVERROR(ENOMEM);
 212     generate_window_func(s->window_func_lut, s->window_size, s->win_func, &overlap);
 213     if (s->overlap == 1)
 214         s->overlap = overlap;
 215
 216     s->hop_size = s->window_size * (1 - s->overlap);
 217     if (s->hop_size <= 0)
 218         return AVERROR(EINVAL);
 219
 220     s->buffer = ff_get_audio_buffer(inlink, s->window_size * 2);
 221     if (!s->buffer)
 222         return AVERROR(ENOMEM);
 223
 224     return ret;
 225 }
 226
 227 static int filter_frame(AVFilterLink *inlink)
 228 {
 229     AVFilterContext *ctx = inlink->dst;
 230     AVFilterLink *outlink = ctx->outputs[0];
 231     AFFTFiltContext *s = ctx->priv;
 232     const int window_size = s->window_size;
 233     const float f = 1. / (s->window_size / 2);
 234     double values[VAR_VARS_NB];
 235     AVFrame *out, *in = NULL;
 236     int ch, n, ret, i;
 237
 238     if (!in) {
 239         in = ff_get_audio_buffer(outlink, window_size);
 240         if (!in)
 241             return AVERROR(ENOMEM);
 242     }
 243
 244     ret = av_audio_fifo_peek(s->fifo, (void **)in->extended_data, window_size);
 245     if (ret < 0)
 246         goto fail;
 247
 248     for (ch = 0; ch < inlink->channels; ch++) {
 249         const float *src = (float *)in->extended_data[ch];
 250         FFTComplex *fft_data = s->fft_data[ch];
 251
 252         for (n = 0; n < in->nb_samples; n++) {
 253             fft_data[n].re = src[n] * s->window_func_lut[n];
 254             fft_data[n].im = 0;
 255         }
 256
 257         for (; n < window_size; n++) {
 258             fft_data[n].re = 0;
 259             fft_data[n].im = 0;
 260         }
 261     }
 262
 263     values[VAR_PTS]         = s->pts;
 264     values[VAR_SAMPLE_RATE] = inlink->sample_rate;
 265     values[VAR_NBBINS]      = window_size / 2;
 266     values[VAR_CHANNELS]    = inlink->channels;
 267
 268     for (ch = 0; ch < inlink->channels; ch++) {
 269         FFTComplex *fft_data = s->fft_data[ch];
 270
 271         av_fft_permute(s->fft, fft_data);
 272         av_fft_calc(s->fft, fft_data);
 273     }
 274
 275     for (ch = 0; ch < inlink->channels; ch++) {
 276         FFTComplex *fft_data = s->fft_data[ch];
 277         FFTComplex *fft_temp = s->fft_temp[ch];
 278         float *buf = (float *)s->buffer->extended_data[ch];
 279         int x;
 280         values[VAR_CHANNEL] = ch;
 281
 282         for (n = 0; n <= window_size / 2; n++) {
 283             float fr, fi;
 284
 285             values[VAR_BIN] = n;
 286             values[VAR_REAL] = fft_data[n].re;
 287             values[VAR_IMAG] = fft_data[n].im;
 288
 289             fr = av_expr_eval(s->real[ch], values, s);
 290             fi = av_expr_eval(s->imag[ch], values, s);
 291
 292             fft_temp[n].re = fr;
 293             fft_temp[n].im = fi;
 294         }
 295
 296         for (n = window_size / 2 + 1, x = window_size / 2 - 1; n < window_size; n++, x--) {
 297             fft_temp[n].re =  fft_temp[x].re;
 298             fft_temp[n].im = -fft_temp[x].im;
 299         }
 300
 301         av_fft_permute(s->ifft, fft_temp);
 302         av_fft_calc(s->ifft, fft_temp);
 303
 304         for (i = 0; i < window_size; i++) {
 305             buf[i] += s->fft_temp[ch][i].re * f;
 306         }
 307     }
 308
 309     out = ff_get_audio_buffer(outlink, s->hop_size);
 310     if (!out) {
 311         ret = AVERROR(ENOMEM);
 312         goto fail;
 313     }
 314
 315     out->pts = s->pts;
 316     s->pts += s->hop_size;
 317
 318     for (ch = 0; ch < inlink->channels; ch++) {
 319         float *dst = (float *)out->extended_data[ch];
 320         float *buf = (float *)s->buffer->extended_data[ch];
 321
 322         for (n = 0; n < s->hop_size; n++)
 323             dst[n] = buf[n] * (1.f - s->overlap);
 324         memmove(buf, buf + s->hop_size, window_size * 4);
 325     }
 326
 327     ret = ff_filter_frame(outlink, out);
 328     if (ret < 0)
 329         goto fail;
 330
 331     av_audio_fifo_drain(s->fifo, s->hop_size);
 332
 333 fail:
 334     av_frame_free(&in);
 335     return ret < 0 ? ret : 0;
 336 }
 337
 338 static int activate(AVFilterContext *ctx)
 339 {
 340     AVFilterLink *inlink = ctx->inputs[0];
 341     AVFilterLink *outlink = ctx->outputs[0];
 342     AFFTFiltContext *s = ctx->priv;
 343     AVFrame *in = NULL;
 344     int ret = 0, status;
 345     int64_t pts;
 346
 347     FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
 348
 349     if (!s->eof && av_audio_fifo_size(s->fifo) < s->window_size) {
 350         ret = ff_inlink_consume_frame(inlink, &in);
 351         if (ret < 0)
 352             return ret;
 353
 354         if (ret > 0) {
 355             ret = av_audio_fifo_write(s->fifo, (void **)in->extended_data,
 356                                       in->nb_samples);
 357             if (ret >= 0 && s->pts == AV_NOPTS_VALUE)
 358                 s->pts = in->pts;
 359
 360             av_frame_free(&in);
 361             if (ret < 0)
 362                 return ret;
 363         }
 364     }
 365
 366     if ((av_audio_fifo_size(s->fifo) >= s->window_size) ||
 367         (av_audio_fifo_size(s->fifo) > 0 && s->eof)) {
 368         ret = filter_frame(inlink);
 369         if (av_audio_fifo_size(s->fifo) >= s->window_size)
 370             ff_filter_set_ready(ctx, 100);
 371         return ret;
 372     }
 373
 374     if (!s->eof && ff_inlink_acknowledge_status(inlink, &status, &pts)) {
 375         if (status == AVERROR_EOF) {
 376             s->eof = 1;
 377             if (av_audio_fifo_size(s->fifo) >= 0) {
 378                 ff_filter_set_ready(ctx, 100);
 379                 return 0;
 380             }
 381         }
 382     }
 383
 384     if (s->eof && av_audio_fifo_size(s->fifo) <= 0) {
 385         ff_outlink_set_status(outlink, AVERROR_EOF, s->pts);
 386         return 0;
 387     }
 388
 389     if (!s->eof)
 390         FF_FILTER_FORWARD_WANTED(outlink, inlink);
 391
 392     return FFERROR_NOT_READY;
 393 }
 394
 395 static int query_formats(AVFilterContext *ctx)
 396 {
 397     AVFilterFormats *formats;
 398     AVFilterChannelLayouts *layouts;
 399     static const enum AVSampleFormat sample_fmts[] = {
 400         AV_SAMPLE_FMT_FLTP,
 401         AV_SAMPLE_FMT_NONE
 402     };
 403     int ret;
 404
 405     layouts = ff_all_channel_counts();
 406     if (!layouts)
 407         return AVERROR(ENOMEM);
 408     ret = ff_set_common_channel_layouts(ctx, layouts);
 409     if (ret < 0)
 410         return ret;
 411
 412     formats = ff_make_format_list(sample_fmts);
 413     if (!formats)
 414         return AVERROR(ENOMEM);
 415     ret = ff_set_common_formats(ctx, formats);
 416     if (ret < 0)
 417         return ret;
 418
 419     formats = ff_all_samplerates();
 420     if (!formats)
 421         return AVERROR(ENOMEM);
 422     return ff_set_common_samplerates(ctx, formats);
 423 }
 424
 425 static av_cold void uninit(AVFilterContext *ctx)
 426 {
 427     AFFTFiltContext *s = ctx->priv;
 428     int i;
 429
 430     av_fft_end(s->fft);
 431     av_fft_end(s->ifft);
 432
 433     for (i = 0; i < s->nb_exprs; i++) {
 434         if (s->fft_data)
 435             av_freep(&s->fft_data[i]);
 436         if (s->fft_temp)
 437             av_freep(&s->fft_temp[i]);
 438     }
 439     av_freep(&s->fft_data);
 440     av_freep(&s->fft_temp);
 441
 442     for (i = 0; i < s->nb_exprs; i++) {
 443         av_expr_free(s->real[i]);
 444         av_expr_free(s->imag[i]);
 445     }
 446
 447     av_freep(&s->real);
 448     av_freep(&s->imag);
 449     av_frame_free(&s->buffer);
 450     av_freep(&s->window_func_lut);
 451
 452     av_audio_fifo_free(s->fifo);
 453 }
 454
 455 static const AVFilterPad inputs[] = {
 456     {
 457         .name         = "default",
 458         .type         = AVMEDIA_TYPE_AUDIO,
 459         .config_props = config_input,
 460     },
 461     { NULL }
 462 };
 463
 464 static const AVFilterPad outputs[] = {
 465     {
 466         .name = "default",
 467         .type = AVMEDIA_TYPE_AUDIO,
 468     },
 469     { NULL }
 470 };
 471
 472 AVFilter ff_af_afftfilt = {
 473     .name            = "afftfilt",
 474     .description     = NULL_IF_CONFIG_SMALL("Apply arbitrary expressions to samples in frequency domain."),
 475     .priv_size       = sizeof(AFFTFiltContext),
 476     .priv_class      = &afftfilt_class,
 477     .inputs          = inputs,
 478     .outputs         = outputs,
 479     .activate        = activate,
 480     .query_formats   = query_formats,
 481     .uninit          = uninit,
 482 };