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

   1 /*
   2  * Copyright (c) 2019 Paul B Mahol
   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 <float.h>
  22
  23 #include "libavutil/avassert.h"
  24 #include "libavutil/audio_fifo.h"
  25 #include "libavutil/opt.h"
  26 #include "avfilter.h"
  27 #include "audio.h"
  28 #include "formats.h"
  29
  30 #include "af_anlmdndsp.h"
  31
  32 #define MAX_DIFF         11.f
  33 #define WEIGHT_LUT_NBITS 20
  34 #define WEIGHT_LUT_SIZE  (1<<WEIGHT_LUT_NBITS)
  35
  36 #define SQR(x) ((x) * (x))
  37
  38 typedef struct AudioNLMeansContext {
  39     const AVClass *class;
  40
  41     float a;
  42     int64_t pd;
  43     int64_t rd;
  44     int om;
  45
  46     float pdiff_lut_scale;
  47     float weight_lut[WEIGHT_LUT_SIZE];
  48
  49     int K;
  50     int S;
  51     int N;
  52     int H;
  53
  54     int offset;
  55     AVFrame *in;
  56     AVFrame *cache;
  57
  58     int64_t pts;
  59
  60     AVAudioFifo *fifo;
  61     int eof_left;
  62
  63     AudioNLMDNDSPContext dsp;
  64 } AudioNLMeansContext;
  65
  66 enum OutModes {
  67     IN_MODE,
  68     OUT_MODE,
  69     NOISE_MODE,
  70     NB_MODES
  71 };
  72
  73 #define OFFSET(x) offsetof(AudioNLMeansContext, x)
  74 #define AF AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  75
  76 static const AVOption anlmdn_options[] = {
  77     { "s", "set denoising strength", OFFSET(a),  AV_OPT_TYPE_FLOAT,    {.dbl=0.00001},0.00001, 10, AF },
  78     { "p", "set patch duration",     OFFSET(pd), AV_OPT_TYPE_DURATION, {.i64=2000}, 1000, 100000, AF },
  79     { "r", "set research duration",  OFFSET(rd), AV_OPT_TYPE_DURATION, {.i64=6000}, 2000, 300000, AF },
  80     { "o", "set output mode",        OFFSET(om), AV_OPT_TYPE_INT,      {.i64=OUT_MODE},  0, NB_MODES-1, AF, "mode" },
  81     {  "i", "input",                 0,          AV_OPT_TYPE_CONST,    {.i64=IN_MODE},   0,  0, AF, "mode" },
  82     {  "o", "output",                0,          AV_OPT_TYPE_CONST,    {.i64=OUT_MODE},  0,  0, AF, "mode" },
  83     {  "n", "noise",                 0,          AV_OPT_TYPE_CONST,    {.i64=NOISE_MODE},0,  0, AF, "mode" },
  84     { NULL }
  85 };
  86
  87 AVFILTER_DEFINE_CLASS(anlmdn);
  88
  89 static int query_formats(AVFilterContext *ctx)
  90 {
  91     AVFilterFormats *formats = NULL;
  92     AVFilterChannelLayouts *layouts = NULL;
  93     static const enum AVSampleFormat sample_fmts[] = {
  94         AV_SAMPLE_FMT_FLTP,
  95         AV_SAMPLE_FMT_NONE
  96     };
  97     int ret;
  98
  99     formats = ff_make_format_list(sample_fmts);
 100     if (!formats)
 101         return AVERROR(ENOMEM);
 102     ret = ff_set_common_formats(ctx, formats);
 103     if (ret < 0)
 104         return ret;
 105
 106     layouts = ff_all_channel_counts();
 107     if (!layouts)
 108         return AVERROR(ENOMEM);
 109
 110     ret = ff_set_common_channel_layouts(ctx, layouts);
 111     if (ret < 0)
 112         return ret;
 113
 114     formats = ff_all_samplerates();
 115     return ff_set_common_samplerates(ctx, formats);
 116 }
 117
 118 static float compute_distance_ssd_c(const float *f1, const float *f2, ptrdiff_t K)
 119 {
 120     float distance = 0.;
 121
 122     for (int k = -K; k <= K; k++)
 123         distance += SQR(f1[k] - f2[k]);
 124
 125     return distance;
 126 }
 127
 128 static void compute_cache_c(float *cache, const float *f,
 129                             ptrdiff_t S, ptrdiff_t K,
 130                             ptrdiff_t i, ptrdiff_t jj)
 131 {
 132     int v = 0;
 133
 134     for (int j = jj; j < jj + S; j++, v++)
 135         cache[v] += -SQR(f[i - K - 1] - f[j - K - 1]) + SQR(f[i + K] - f[j + K]);
 136 }
 137
 138 void ff_anlmdn_init(AudioNLMDNDSPContext *dsp)
 139 {
 140     dsp->compute_distance_ssd = compute_distance_ssd_c;
 141     dsp->compute_cache        = compute_cache_c;
 142
 143     if (ARCH_X86)
 144         ff_anlmdn_init_x86(dsp);
 145 }
 146
 147 static int config_output(AVFilterLink *outlink)
 148 {
 149     AVFilterContext *ctx = outlink->src;
 150     AudioNLMeansContext *s = ctx->priv;
 151     int ret;
 152
 153     s->K = av_rescale(s->pd, outlink->sample_rate, AV_TIME_BASE);
 154     s->S = av_rescale(s->rd, outlink->sample_rate, AV_TIME_BASE);
 155
 156     s->eof_left = -1;
 157     s->pts = AV_NOPTS_VALUE;
 158     s->H = s->K * 2 + 1;
 159     s->N = s->H + (s->K + s->S) * 2;
 160
 161     av_log(ctx, AV_LOG_DEBUG, "K:%d S:%d H:%d N:%d\n", s->K, s->S, s->H, s->N);
 162
 163     av_frame_free(&s->in);
 164     av_frame_free(&s->cache);
 165     s->in = ff_get_audio_buffer(outlink, s->N);
 166     if (!s->in)
 167         return AVERROR(ENOMEM);
 168
 169     s->cache = ff_get_audio_buffer(outlink, s->S * 2);
 170     if (!s->cache)
 171         return AVERROR(ENOMEM);
 172
 173     s->fifo = av_audio_fifo_alloc(outlink->format, outlink->channels, s->N);
 174     if (!s->fifo)
 175         return AVERROR(ENOMEM);
 176
 177     ret = av_audio_fifo_write(s->fifo, (void **)s->in->extended_data, s->K + s->S);
 178     if (ret < 0)
 179         return ret;
 180
 181     s->pdiff_lut_scale = 1.f / MAX_DIFF * WEIGHT_LUT_SIZE;
 182     for (int i = 0; i < WEIGHT_LUT_SIZE; i++) {
 183         float w = -i / s->pdiff_lut_scale;
 184
 185         s->weight_lut[i] = expf(w);
 186     }
 187
 188     ff_anlmdn_init(&s->dsp);
 189
 190     return 0;
 191 }
 192
 193 static int filter_channel(AVFilterContext *ctx, void *arg, int ch, int nb_jobs)
 194 {
 195     AudioNLMeansContext *s = ctx->priv;
 196     AVFrame *out = arg;
 197     const int S = s->S;
 198     const int K = s->K;
 199     const int om = s->om;
 200     const float *f = (const float *)(s->in->extended_data[ch]) + K;
 201     float *cache = (float *)s->cache->extended_data[ch];
 202     const float sw = (65536.f / (4 * K + 2)) / sqrtf(s->a);
 203     float *dst = (float *)out->extended_data[ch] + s->offset;
 204
 205     for (int i = S; i < s->H + S; i++) {
 206         float P = 0.f, Q = 0.f;
 207         int v = 0;
 208
 209         if (i == S) {
 210             for (int j = i - S; j <= i + S; j++) {
 211                 if (i == j)
 212                     continue;
 213                 cache[v++] = s->dsp.compute_distance_ssd(f + i, f + j, K);
 214             }
 215         } else {
 216             s->dsp.compute_cache(cache, f, S, K, i, i - S);
 217             s->dsp.compute_cache(cache + S, f, S, K, i, i + 1);
 218         }
 219
 220         for (int j = 0; j < 2 * S && !ctx->is_disabled; j++) {
 221             const float distance = cache[j];
 222             unsigned weight_lut_idx;
 223             float w;
 224
 225             av_assert2(distance >= 0.f);
 226             w = distance * sw;
 227             if (w >= MAX_DIFF)
 228                 continue;
 229             weight_lut_idx = w * s->pdiff_lut_scale;
 230             av_assert2(weight_lut_idx < WEIGHT_LUT_SIZE);
 231             w = s->weight_lut[weight_lut_idx];
 232             P += w * f[i - S + j + (j >= S)];
 233             Q += w;
 234         }
 235
 236         P += f[i];
 237         Q += 1;
 238
 239         switch (om) {
 240         case IN_MODE:    dst[i - S] = f[i];           break;
 241         case OUT_MODE:   dst[i - S] = P / Q;          break;
 242         case NOISE_MODE: dst[i - S] = f[i] - (P / Q); break;
 243         }
 244     }
 245
 246     return 0;
 247 }
 248
 249 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 250 {
 251     AVFilterContext *ctx = inlink->dst;
 252     AVFilterLink *outlink = ctx->outputs[0];
 253     AudioNLMeansContext *s = ctx->priv;
 254     AVFrame *out = NULL;
 255     int available, wanted, ret;
 256
 257     if (s->pts == AV_NOPTS_VALUE)
 258         s->pts = in->pts;
 259
 260     ret = av_audio_fifo_write(s->fifo, (void **)in->extended_data,
 261                               in->nb_samples);
 262     av_frame_free(&in);
 263
 264     s->offset = 0;
 265     available = av_audio_fifo_size(s->fifo);
 266     wanted = (available / s->H) * s->H;
 267
 268     if (wanted >= s->H && available >= s->N) {
 269         out = ff_get_audio_buffer(outlink, wanted);
 270         if (!out)
 271             return AVERROR(ENOMEM);
 272     }
 273
 274     while (available >= s->N) {
 275         ret = av_audio_fifo_peek(s->fifo, (void **)s->in->extended_data, s->N);
 276         if (ret < 0)
 277             break;
 278
 279         ctx->internal->execute(ctx, filter_channel, out, NULL, inlink->channels);
 280
 281         av_audio_fifo_drain(s->fifo, s->H);
 282
 283         s->offset += s->H;
 284         available -= s->H;
 285     }
 286
 287     if (out) {
 288         out->pts = s->pts;
 289         out->nb_samples = s->offset;
 290         if (s->eof_left >= 0) {
 291             out->nb_samples = FFMIN(s->eof_left, s->offset);
 292             s->eof_left -= out->nb_samples;
 293         }
 294         s->pts += s->offset;
 295
 296         return ff_filter_frame(outlink, out);
 297     }
 298
 299     return ret;
 300 }
 301
 302 static int request_frame(AVFilterLink *outlink)
 303 {
 304     AVFilterContext *ctx = outlink->src;
 305     AudioNLMeansContext *s = ctx->priv;
 306     int ret;
 307
 308     ret = ff_request_frame(ctx->inputs[0]);
 309
 310     if (ret == AVERROR_EOF && s->eof_left != 0) {
 311         AVFrame *in;
 312
 313         if (s->eof_left < 0)
 314             s->eof_left = av_audio_fifo_size(s->fifo) - (s->S + s->K);
 315         if (s->eof_left < 0)
 316             return AVERROR_EOF;
 317         in = ff_get_audio_buffer(outlink, s->H);
 318         if (!in)
 319             return AVERROR(ENOMEM);
 320
 321         return filter_frame(ctx->inputs[0], in);
 322     }
 323
 324     return ret;
 325 }
 326
 327 static av_cold void uninit(AVFilterContext *ctx)
 328 {
 329     AudioNLMeansContext *s = ctx->priv;
 330
 331     av_audio_fifo_free(s->fifo);
 332     av_frame_free(&s->in);
 333     av_frame_free(&s->cache);
 334 }
 335
 336 static const AVFilterPad inputs[] = {
 337     {
 338         .name         = "default",
 339         .type         = AVMEDIA_TYPE_AUDIO,
 340         .filter_frame = filter_frame,
 341     },
 342     { NULL }
 343 };
 344
 345 static const AVFilterPad outputs[] = {
 346     {
 347         .name          = "default",
 348         .type          = AVMEDIA_TYPE_AUDIO,
 349         .config_props  = config_output,
 350         .request_frame = request_frame,
 351     },
 352     { NULL }
 353 };
 354
 355 AVFilter ff_af_anlmdn = {
 356     .name          = "anlmdn",
 357     .description   = NULL_IF_CONFIG_SMALL("Reduce broadband noise from stream using Non-Local Means."),
 358     .query_formats = query_formats,
 359     .priv_size     = sizeof(AudioNLMeansContext),
 360     .priv_class    = &anlmdn_class,
 361     .uninit        = uninit,
 362     .inputs        = inputs,
 363     .outputs       = outputs,
 364     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL |
 365                      AVFILTER_FLAG_SLICE_THREADS,
 366 };