git.sesse.net Git - ffmpeg/blob - 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_GRAY9,
  84         AV_PIX_FMT_GRAY10,
  85         AV_PIX_FMT_GRAY12,
  86         AV_PIX_FMT_GRAY16,
  87         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
  88         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
  89         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
  90         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
  91         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
  92         AV_PIX_FMT_YUVJ411P,
  93         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
  94         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
  95         AV_PIX_FMT_YUV440P10,
  96         AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
  97         AV_PIX_FMT_YUV440P12,
  98         AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
  99         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
 100         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
 101         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
 102         AV_PIX_FMT_NONE
 103     };
 104     AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
 105     if (!formats)
 106         return AVERROR(ENOMEM);
 107     return ff_set_common_formats(ctx, formats);
 108 }
 109
 110 static av_cold int init(AVFilterContext *ctx)
 111 {
 112     ATADenoiseContext *s = ctx->priv;
 113
 114     if (!(s->size & 1)) {
 115         av_log(ctx, AV_LOG_WARNING, "size %d is invalid. Must be an odd value, setting it to %d.\n", s->size, s->size|1);
 116         s->size |= 1;
 117     }
 118     s->mid = s->size / 2 + 1;
 119
 120     return 0;
 121 }
 122
 123 typedef struct ThreadData {
 124     AVFrame *in, *out;
 125 } ThreadData;
 126
 127 static int filter_slice8(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 128 {
 129     ATADenoiseContext *s = ctx->priv;
 130     ThreadData *td = arg;
 131     AVFrame *in = td->in;
 132     AVFrame *out = td->out;
 133     const int size = s->size;
 134     const int mid = s->mid;
 135     int p, x, y, i, j;
 136
 137     for (p = 0; p < s->nb_planes; p++) {
 138         const int h = s->planeheight[p];
 139         const int w = s->planewidth[p];
 140         const int slice_start = (h * jobnr) / nb_jobs;
 141         const int slice_end = (h * (jobnr+1)) / nb_jobs;
 142         const uint8_t *src = in->data[p] + slice_start * in->linesize[p];
 143         uint8_t *dst = out->data[p] + slice_start * out->linesize[p];
 144         const int thra = s->thra[p];
 145         const int thrb = s->thrb[p];
 146         const uint8_t **data = (const uint8_t **)s->data[p];
 147         const int *linesize = (const int *)s->linesize[p];
 148         const uint8_t *srcf[SIZE];
 149
 150         if (!((1 << p) & s->planes)) {
 151             av_image_copy_plane(dst, out->linesize[p], src, in->linesize[p],
 152                                 w, slice_end - slice_start);
 153             continue;
 154         }
 155
 156         for (i = 0; i < size; i++)
 157             srcf[i] = data[i] + slice_start * linesize[i];
 158
 159         for (y = slice_start; y < slice_end; y++) {
 160             for (x = 0; x < w; x++) {
 161                 const int srcx = src[x];
 162                 unsigned lsumdiff = 0, rsumdiff = 0;
 163                 unsigned ldiff, rdiff;
 164                 unsigned sum = srcx;
 165                 int l = 0, r = 0;
 166                 int srcjx, srcix;
 167
 168                 for (j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) {
 169                     srcjx = srcf[j][x];
 170
 171                     ldiff = FFABS(srcx - srcjx);
 172                     lsumdiff += ldiff;
 173                     if (ldiff > thra ||
 174                         lsumdiff > thrb)
 175                         break;
 176                     l++;
 177                     sum += srcjx;
 178
 179                     srcix = srcf[i][x];
 180
 181                     rdiff = FFABS(srcx - srcix);
 182                     rsumdiff += rdiff;
 183                     if (rdiff > thra ||
 184                         rsumdiff > thrb)
 185                         break;
 186                     r++;
 187                     sum += srcix;
 188                 }
 189
 190                 dst[x] = sum / (r + l + 1);
 191             }
 192
 193             dst += out->linesize[p];
 194             src += in->linesize[p];
 195
 196             for (i = 0; i < size; i++)
 197                 srcf[i] += linesize[i];
 198         }
 199     }
 200
 201     return 0;
 202 }
 203
 204 static int filter_slice16(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 205 {
 206     ATADenoiseContext *s = ctx->priv;
 207     ThreadData *td = arg;
 208     AVFrame *in = td->in;
 209     AVFrame *out = td->out;
 210     const int size = s->size;
 211     const int mid = s->mid;
 212     int p, x, y, i, j;
 213
 214     for (p = 0; p < s->nb_planes; p++) {
 215         const int h = s->planeheight[p];
 216         const int w = s->planewidth[p];
 217         const int slice_start = (h * jobnr) / nb_jobs;
 218         const int slice_end = (h * (jobnr+1)) / nb_jobs;
 219         const uint16_t *src = (uint16_t *)(in->data[p] + slice_start * in->linesize[p]);
 220         uint16_t *dst = (uint16_t *)(out->data[p] + slice_start * out->linesize[p]);
 221         const int thra = s->thra[p];
 222         const int thrb = s->thrb[p];
 223         const uint8_t **data = (const uint8_t **)s->data[p];
 224         const int *linesize = (const int *)s->linesize[p];
 225         const uint16_t *srcf[SIZE];
 226
 227         if (!((1 << p) & s->planes)) {
 228             av_image_copy_plane((uint8_t *)dst, out->linesize[p], (uint8_t *)src, in->linesize[p],
 229                                 w * 2, slice_end - slice_start);
 230             continue;
 231         }
 232
 233         for (i = 0; i < s->size; i++)
 234             srcf[i] = (const uint16_t *)(data[i] + slice_start * linesize[i]);
 235
 236         for (y = slice_start; y < slice_end; y++) {
 237             for (x = 0; x < w; x++) {
 238                 const int srcx = src[x];
 239                 unsigned lsumdiff = 0, rsumdiff = 0;
 240                 unsigned ldiff, rdiff;
 241                 unsigned sum = srcx;
 242                 int l = 0, r = 0;
 243                 int srcjx, srcix;
 244
 245                 for (j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) {
 246                     srcjx = srcf[j][x];
 247
 248                     ldiff = FFABS(srcx - srcjx);
 249                     lsumdiff += ldiff;
 250                     if (ldiff > thra ||
 251                         lsumdiff > thrb)
 252                         break;
 253                     l++;
 254                     sum += srcjx;
 255
 256                     srcix = srcf[i][x];
 257
 258                     rdiff = FFABS(srcx - srcix);
 259                     rsumdiff += rdiff;
 260                     if (rdiff > thra ||
 261                         rsumdiff > thrb)
 262                         break;
 263                     r++;
 264                     sum += srcix;
 265                 }
 266
 267                 dst[x] = sum / (r + l + 1);
 268             }
 269
 270             dst += out->linesize[p] / 2;
 271             src += in->linesize[p] / 2;
 272
 273             for (i = 0; i < size; i++)
 274                 srcf[i] += linesize[i] / 2;
 275         }
 276     }
 277
 278     return 0;
 279 }
 280
 281 static int config_input(AVFilterLink *inlink)
 282 {
 283     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 284     AVFilterContext *ctx = inlink->dst;
 285     ATADenoiseContext *s = ctx->priv;
 286     int depth;
 287
 288     s->nb_planes = desc->nb_components;
 289
 290     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
 291     s->planeheight[0] = s->planeheight[3] = inlink->h;
 292     s->planewidth[1]  = s->planewidth[2]  = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
 293     s->planewidth[0]  = s->planewidth[3]  = inlink->w;
 294
 295     depth = desc->comp[0].depth;
 296     if (depth == 8)
 297         s->filter_slice = filter_slice8;
 298     else
 299         s->filter_slice = filter_slice16;
 300
 301     s->thra[0] = s->fthra[0] * (1 << depth) - 1;
 302     s->thra[1] = s->fthra[1] * (1 << depth) - 1;
 303     s->thra[2] = s->fthra[2] * (1 << depth) - 1;
 304     s->thrb[0] = s->fthrb[0] * (1 << depth) - 1;
 305     s->thrb[1] = s->fthrb[1] * (1 << depth) - 1;
 306     s->thrb[2] = s->fthrb[2] * (1 << depth) - 1;
 307
 308     return 0;
 309 }
 310
 311 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
 312 {
 313     AVFilterContext *ctx = inlink->dst;
 314     AVFilterLink *outlink = ctx->outputs[0];
 315     ATADenoiseContext *s = ctx->priv;
 316     AVFrame *out, *in;
 317     int i;
 318
 319     if (s->q.available != s->size) {
 320         if (s->q.available < s->mid) {
 321             for (i = 0; i < s->mid; i++) {
 322                 out = av_frame_clone(buf);
 323                 if (!out) {
 324                     av_frame_free(&buf);
 325                     return AVERROR(ENOMEM);
 326                 }
 327                 ff_bufqueue_add(ctx, &s->q, out);
 328             }
 329         }
 330         if (s->q.available < s->size) {
 331             ff_bufqueue_add(ctx, &s->q, buf);
 332             s->available++;
 333         }
 334         return 0;
 335     }
 336
 337     in = ff_bufqueue_peek(&s->q, s->mid);
 338
 339     if (!ctx->is_disabled) {
 340         ThreadData td;
 341
 342         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 343         if (!out) {
 344             av_frame_free(&buf);
 345             return AVERROR(ENOMEM);
 346         }
 347
 348         for (i = 0; i < s->size; i++) {
 349             AVFrame *frame = ff_bufqueue_peek(&s->q, i);
 350
 351             s->data[0][i] = frame->data[0];
 352             s->data[1][i] = frame->data[1];
 353             s->data[2][i] = frame->data[2];
 354             s->linesize[0][i] = frame->linesize[0];
 355             s->linesize[1][i] = frame->linesize[1];
 356             s->linesize[2][i] = frame->linesize[2];
 357         }
 358
 359         td.in = in; td.out = out;
 360         ctx->internal->execute(ctx, s->filter_slice, &td, NULL,
 361                                FFMIN3(s->planeheight[1],
 362                                       s->planeheight[2],
 363                                       ff_filter_get_nb_threads(ctx)));
 364         av_frame_copy_props(out, in);
 365     } else {
 366         out = av_frame_clone(in);
 367         if (!out) {
 368             av_frame_free(&buf);
 369             return AVERROR(ENOMEM);
 370         }
 371     }
 372
 373     in = ff_bufqueue_get(&s->q);
 374     av_frame_free(&in);
 375     ff_bufqueue_add(ctx, &s->q, buf);
 376
 377     return ff_filter_frame(outlink, out);
 378 }
 379
 380 static int request_frame(AVFilterLink *outlink)
 381 {
 382     AVFilterContext *ctx = outlink->src;
 383     ATADenoiseContext *s = ctx->priv;
 384     int ret = 0;
 385
 386     ret = ff_request_frame(ctx->inputs[0]);
 387
 388     if (ret == AVERROR_EOF && !ctx->is_disabled && s->available) {
 389         AVFrame *buf = av_frame_clone(ff_bufqueue_peek(&s->q, s->available));
 390         if (!buf)
 391             return AVERROR(ENOMEM);
 392
 393         ret = filter_frame(ctx->inputs[0], buf);
 394         s->available--;
 395     }
 396
 397     return ret;
 398 }
 399
 400 static av_cold void uninit(AVFilterContext *ctx)
 401 {
 402     ATADenoiseContext *s = ctx->priv;
 403
 404     ff_bufqueue_discard_all(&s->q);
 405 }
 406
 407 static const AVFilterPad inputs[] = {
 408     {
 409         .name         = "default",
 410         .type         = AVMEDIA_TYPE_VIDEO,
 411         .filter_frame = filter_frame,
 412         .config_props = config_input,
 413     },
 414     { NULL }
 415 };
 416
 417 static const AVFilterPad outputs[] = {
 418     {
 419         .name          = "default",
 420         .type          = AVMEDIA_TYPE_VIDEO,
 421         .request_frame = request_frame,
 422     },
 423     { NULL }
 424 };
 425
 426 AVFilter ff_vf_atadenoise = {
 427     .name          = "atadenoise",
 428     .description   = NULL_IF_CONFIG_SMALL("Apply an Adaptive Temporal Averaging Denoiser."),
 429     .priv_size     = sizeof(ATADenoiseContext),
 430     .priv_class    = &atadenoise_class,
 431     .init          = init,
 432     .uninit        = uninit,
 433     .query_formats = query_formats,
 434     .inputs        = inputs,
 435     .outputs       = outputs,
 436     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
 437 };