libavfilter/vf_atadenoise.c

   1 /*
   2  * Copyright (c) 2015 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 /**
  22  * @file
  23  * Adaptive Temporal Averaging Denoiser,
  24  * based on paper "Video Denoising Based on Adaptive Temporal Averaging" by
  25  * David Bartovčak and Miroslav Vrankić
  26  */
  27
  28 #include "libavutil/imgutils.h"
  29 #include "libavutil/opt.h"
  30 #include "libavutil/pixdesc.h"
  31 #include "avfilter.h"
  32
  33 #define FF_BUFQUEUE_SIZE 129
  34 #include "bufferqueue.h"
  35
  36 #include "formats.h"
  37 #include "internal.h"
  38 #include "video.h"
  39
  40 #define SIZE FF_BUFQUEUE_SIZE
  41
  42 typedef struct ATADenoiseContext {
  43     const AVClass *class;
  44
  45     float fthra[4], fthrb[4];
  46     int thra[4], thrb[4];
  47
  48     int planes;
  49     int nb_planes;
  50     int planewidth[4];
  51     int planeheight[4];
  52
  53     struct FFBufQueue q;
  54     void *data[4][SIZE];
  55     int linesize[4][SIZE];
  56     int size, mid;
  57     int available;
  58
  59     int (*filter_slice)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
  60 } ATADenoiseContext;
  61
  62 #define OFFSET(x) offsetof(ATADenoiseContext, x)
  63 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  64
  65 static const AVOption atadenoise_options[] = {
  66     { "0a", "set threshold A for 1st plane", OFFSET(fthra[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
  67     { "0b", "set threshold B for 1st plane", OFFSET(fthrb[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
  68     { "1a", "set threshold A for 2nd plane", OFFSET(fthra[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
  69     { "1b", "set threshold B for 2nd plane", OFFSET(fthrb[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
  70     { "2a", "set threshold A for 3rd plane", OFFSET(fthra[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
  71     { "2b", "set threshold B for 3rd plane", OFFSET(fthrb[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
  72     { "s",  "set how many frames to use",    OFFSET(size),     AV_OPT_TYPE_INT,   {.i64=9},   5, SIZE, FLAGS },
  73     { "p",  "set what planes to filter",     OFFSET(planes),   AV_OPT_TYPE_FLAGS, {.i64=7},    0, 15,  FLAGS },
  74     { NULL }
  75 };
  76
  77 AVFILTER_DEFINE_CLASS(atadenoise);
  78
  79 static int query_formats(AVFilterContext *ctx)
  80 {
  81     static const enum AVPixelFormat pixel_fmts[] = {
  82         AV_PIX_FMT_GRAY8,
  83         AV_PIX_FMT_GRAY10,
  84         AV_PIX_FMT_GRAY12,
  85         AV_PIX_FMT_GRAY16,
  86         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
  87         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
  88         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
  89         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
  90         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
  91         AV_PIX_FMT_YUVJ411P,
  92         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
  93         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
  94         AV_PIX_FMT_YUV440P10,
  95         AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
  96         AV_PIX_FMT_YUV440P12,
  97         AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
  98         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
  99         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
 100         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
 101         AV_PIX_FMT_NONE
 102     };
 103     AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
 104     if (!formats)
 105         return AVERROR(ENOMEM);
 106     return ff_set_common_formats(ctx, formats);
 107 }
 108
 109 static av_cold int init(AVFilterContext *ctx)
 110 {
 111     ATADenoiseContext *s = ctx->priv;
 112
 113     if (!(s->size & 1)) {
 114         av_log(ctx, AV_LOG_ERROR, "size %d is invalid. Must be an odd value.\n", s->size);
 115         return AVERROR(EINVAL);
 116     }
 117     s->mid = s->size / 2 + 1;
 118
 119     return 0;
 120 }
 121
 122 typedef struct ThreadData {
 123     AVFrame *in, *out;
 124 } ThreadData;
 125
 126 static int filter_slice8(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 127 {
 128     ATADenoiseContext *s = ctx->priv;
 129     ThreadData *td = arg;
 130     AVFrame *in = td->in;
 131     AVFrame *out = td->out;
 132     const int size = s->size;
 133     const int mid = s->mid;
 134     int p, x, y, i, j;
 135
 136     for (p = 0; p < s->nb_planes; p++) {
 137         const int h = s->planeheight[p];
 138         const int w = s->planewidth[p];
 139         const int slice_start = (h * jobnr) / nb_jobs;
 140         const int slice_end = (h * (jobnr+1)) / nb_jobs;
 141         const uint8_t *src = in->data[p] + slice_start * in->linesize[p];
 142         uint8_t *dst = out->data[p] + slice_start * out->linesize[p];
 143         const int thra = s->thra[p];
 144         const int thrb = s->thrb[p];
 145         const uint8_t **data = (const uint8_t **)s->data[p];
 146         const int *linesize = (const int *)s->linesize[p];
 147         const uint8_t *srcf[SIZE];
 148
 149         if (!((1 << p) & s->planes)) {
 150             av_image_copy_plane(dst, out->linesize[p], src, in->linesize[p],
 151                                 w, slice_end - slice_start);
 152             continue;
 153         }
 154
 155         for (i = 0; i < size; i++)
 156             srcf[i] = data[i] + slice_start * linesize[i];
 157
 158         for (y = slice_start; y < slice_end; y++) {
 159             for (x = 0; x < w; x++) {
 160                 const int srcx = src[x];
 161                 unsigned lsumdiff = 0, rsumdiff = 0;
 162                 unsigned ldiff, rdiff;
 163                 unsigned sum = srcx;
 164                 int l = 0, r = 0;
 165                 int srcjx, srcix;
 166
 167                 for (j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) {
 168                     srcjx = srcf[j][x];
 169
 170                     ldiff = FFABS(srcx - srcjx);
 171                     lsumdiff += ldiff;
 172                     if (ldiff > thra ||
 173                         lsumdiff > thrb)
 174                         break;
 175                     l++;
 176                     sum += srcjx;
 177
 178                     srcix = srcf[i][x];
 179
 180                     rdiff = FFABS(srcx - srcix);
 181                     rsumdiff += rdiff;
 182                     if (rdiff > thra ||
 183                         rsumdiff > thrb)
 184                         break;
 185                     r++;
 186                     sum += srcix;
 187                 }
 188
 189                 dst[x] = sum / (r + l + 1);
 190             }
 191
 192             dst += out->linesize[p];
 193             src += in->linesize[p];
 194
 195             for (i = 0; i < size; i++)
 196                 srcf[i] += linesize[i];
 197         }
 198     }
 199
 200     return 0;
 201 }
 202
 203 static int filter_slice16(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 204 {
 205     ATADenoiseContext *s = ctx->priv;
 206     ThreadData *td = arg;
 207     AVFrame *in = td->in;
 208     AVFrame *out = td->out;
 209     const int size = s->size;
 210     const int mid = s->mid;
 211     int p, x, y, i, j;
 212
 213     for (p = 0; p < s->nb_planes; p++) {
 214         const int h = s->planeheight[p];
 215         const int w = s->planewidth[p];
 216         const int slice_start = (h * jobnr) / nb_jobs;
 217         const int slice_end = (h * (jobnr+1)) / nb_jobs;
 218         const uint16_t *src = (uint16_t *)(in->data[p] + slice_start * in->linesize[p]);
 219         uint16_t *dst = (uint16_t *)(out->data[p] + slice_start * out->linesize[p]);
 220         const int thra = s->thra[p];
 221         const int thrb = s->thrb[p];
 222         const uint8_t **data = (const uint8_t **)s->data[p];
 223         const int *linesize = (const int *)s->linesize[p];
 224         const uint16_t *srcf[SIZE];
 225
 226         if (!((1 << p) & s->planes)) {
 227             av_image_copy_plane((uint8_t *)dst, out->linesize[p], (uint8_t *)src, in->linesize[p],
 228                                 w * 2, slice_end - slice_start);
 229             continue;
 230         }
 231
 232         for (i = 0; i < s->size; i++)
 233             srcf[i] = (const uint16_t *)(data[i] + slice_start * linesize[i]);
 234
 235         for (y = slice_start; y < slice_end; y++) {
 236             for (x = 0; x < w; x++) {
 237                 const int srcx = src[x];
 238                 unsigned lsumdiff = 0, rsumdiff = 0;
 239                 unsigned ldiff, rdiff;
 240                 unsigned sum = srcx;
 241                 int l = 0, r = 0;
 242                 int srcjx, srcix;
 243
 244                 for (j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) {
 245                     srcjx = srcf[j][x];
 246
 247                     ldiff = FFABS(srcx - srcjx);
 248                     lsumdiff += ldiff;
 249                     if (ldiff > thra ||
 250                         lsumdiff > thrb)
 251                         break;
 252                     l++;
 253                     sum += srcjx;
 254
 255                     srcix = srcf[i][x];
 256
 257                     rdiff = FFABS(srcx - srcix);
 258                     rsumdiff += rdiff;
 259                     if (rdiff > thra ||
 260                         rsumdiff > thrb)
 261                         break;
 262                     r++;
 263                     sum += srcix;
 264                 }
 265
 266                 dst[x] = sum / (r + l + 1);
 267             }
 268
 269             dst += out->linesize[p] / 2;
 270             src += in->linesize[p] / 2;
 271
 272             for (i = 0; i < size; i++)
 273                 srcf[i] += linesize[i] / 2;
 274         }
 275     }
 276
 277     return 0;
 278 }
 279
 280 static int config_input(AVFilterLink *inlink)
 281 {
 282     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 283     AVFilterContext *ctx = inlink->dst;
 284     ATADenoiseContext *s = ctx->priv;
 285     int depth;
 286
 287     s->nb_planes = desc->nb_components;
 288
 289     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
 290     s->planeheight[0] = s->planeheight[3] = inlink->h;
 291     s->planewidth[1]  = s->planewidth[2]  = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
 292     s->planewidth[0]  = s->planewidth[3]  = inlink->w;
 293
 294     depth = desc->comp[0].depth;
 295     if (depth == 8)
 296         s->filter_slice = filter_slice8;
 297     else
 298         s->filter_slice = filter_slice16;
 299
 300     s->thra[0] = s->fthra[0] * (1 << depth) - 1;
 301     s->thra[1] = s->fthra[1] * (1 << depth) - 1;
 302     s->thra[2] = s->fthra[2] * (1 << depth) - 1;
 303     s->thrb[0] = s->fthrb[0] * (1 << depth) - 1;
 304     s->thrb[1] = s->fthrb[1] * (1 << depth) - 1;
 305     s->thrb[2] = s->fthrb[2] * (1 << depth) - 1;
 306
 307     return 0;
 308 }
 309
 310 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
 311 {
 312     AVFilterContext *ctx = inlink->dst;
 313     AVFilterLink *outlink = ctx->outputs[0];
 314     ATADenoiseContext *s = ctx->priv;
 315     AVFrame *out, *in;
 316     int i;
 317
 318     if (s->q.available != s->size) {
 319         if (s->q.available < s->mid) {
 320             for (i = 0; i < s->mid; i++) {
 321                 out = av_frame_clone(buf);
 322                 if (!out) {
 323                     av_frame_free(&buf);
 324                     return AVERROR(ENOMEM);
 325                 }
 326                 ff_bufqueue_add(ctx, &s->q, out);
 327             }
 328         }
 329         if (s->q.available < s->size) {
 330             ff_bufqueue_add(ctx, &s->q, buf);
 331             s->available++;
 332         }
 333         return 0;
 334     }
 335
 336     in = ff_bufqueue_peek(&s->q, s->mid);
 337
 338     if (!ctx->is_disabled) {
 339         ThreadData td;
 340
 341         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 342         if (!out) {
 343             av_frame_free(&buf);
 344             return AVERROR(ENOMEM);
 345         }
 346
 347         for (i = 0; i < s->size; i++) {
 348             AVFrame *frame = ff_bufqueue_peek(&s->q, i);
 349
 350             s->data[0][i] = frame->data[0];
 351             s->data[1][i] = frame->data[1];
 352             s->data[2][i] = frame->data[2];
 353             s->linesize[0][i] = frame->linesize[0];
 354             s->linesize[1][i] = frame->linesize[1];
 355             s->linesize[2][i] = frame->linesize[2];
 356         }
 357
 358         td.in = in; td.out = out;
 359         ctx->internal->execute(ctx, s->filter_slice, &td, NULL,
 360                                FFMIN3(s->planeheight[1],
 361                                       s->planeheight[2],
 362                                       ff_filter_get_nb_threads(ctx)));
 363         av_frame_copy_props(out, in);
 364     } else {
 365         out = av_frame_clone(in);
 366         if (!out) {
 367             av_frame_free(&buf);
 368             return AVERROR(ENOMEM);
 369         }
 370     }
 371
 372     in = ff_bufqueue_get(&s->q);
 373     av_frame_free(&in);
 374     ff_bufqueue_add(ctx, &s->q, buf);
 375
 376     return ff_filter_frame(outlink, out);
 377 }
 378
 379 static int request_frame(AVFilterLink *outlink)
 380 {
 381     AVFilterContext *ctx = outlink->src;
 382     ATADenoiseContext *s = ctx->priv;
 383     int ret = 0;
 384
 385     ret = ff_request_frame(ctx->inputs[0]);
 386
 387     if (ret == AVERROR_EOF && !ctx->is_disabled && s->available) {
 388         AVFrame *buf = av_frame_clone(ff_bufqueue_peek(&s->q, s->available));
 389         if (!buf)
 390             return AVERROR(ENOMEM);
 391
 392         ret = filter_frame(ctx->inputs[0], buf);
 393         s->available--;
 394     }
 395
 396     return ret;
 397 }
 398
 399 static av_cold void uninit(AVFilterContext *ctx)
 400 {
 401     ATADenoiseContext *s = ctx->priv;
 402
 403     ff_bufqueue_discard_all(&s->q);
 404 }
 405
 406 static const AVFilterPad inputs[] = {
 407     {
 408         .name         = "default",
 409         .type         = AVMEDIA_TYPE_VIDEO,
 410         .filter_frame = filter_frame,
 411         .config_props = config_input,
 412     },
 413     { NULL }
 414 };
 415
 416 static const AVFilterPad outputs[] = {
 417     {
 418         .name          = "default",
 419         .type          = AVMEDIA_TYPE_VIDEO,
 420         .request_frame = request_frame,
 421     },
 422     { NULL }
 423 };
 424
 425 AVFilter ff_vf_atadenoise = {
 426     .name          = "atadenoise",
 427     .description   = NULL_IF_CONFIG_SMALL("Apply an Adaptive Temporal Averaging Denoiser."),
 428     .priv_size     = sizeof(ATADenoiseContext),
 429     .priv_class    = &atadenoise_class,
 430     .init          = init,
 431     .uninit        = uninit,
 432     .query_formats = query_formats,
 433     .inputs        = inputs,
 434     .outputs       = outputs,
 435     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
 436 };