avfilter: add atadenoise

Changelog

@@ -28,6 +28,7 @@ version <next>:
 - bitstream filter for converting HEVC from MP4 to Annex B
 - acrossfade audio filter
 - allyuv video source
+- atadenoise video filter
 
 
 version 2.7:

doc/filters.texi

@@ -2967,6 +2967,44 @@ Slower shaper using OpenType for substitutions and positioning
 The default is @code{auto}.
 @end table
 
+@section atadenoise
+Apply an Adaptive Temporal Averaging Denoiser to the video input.
+
+The filter accepts the following options:
+
+@table @option
+@item 0a
+Set threshold A for 1st plane. Default is 0.02.
+Valid range is 0 to 0.3.
+
+@item 0b
+Set threshold B for 1st plane. Default is 0.04.
+Valid range is 0 to 5.
+
+@item 1a
+Set threshold A for 2nd plane. Default is 0.02.
+Valid range is 0 to 0.3.
+
+@item 1b
+Set threshold B for 2nd plane. Default is 0.04.
+Valid range is 0 to 5.
+
+@item 2a
+Set threshold A for 3rd plane. Default is 0.02.
+Valid range is 0 to 0.3.
+
+@item 2b
+Set threshold B for 3rd plane. Default is 0.04.
+Valid range is 0 to 5.
+
+Threshold A is designed to react on abrupt changes in the input signal and
+threshold B is designed to react on continuous changes in the input signal.
+
+@item s
+Set number of frames filter will use for averaging. Default is 33. Must be odd
+number in range [5, 129].
+@end table
+
 @section bbox
 
 Compute the bounding box for the non-black pixels in the input frame

libavfilter/Makefile

@@ -98,6 +98,7 @@ OBJS-$(CONFIG_ANULLSINK_FILTER)              += asink_anullsink.o
 OBJS-$(CONFIG_ASS_FILTER)                    += vf_subtitles.o
 OBJS-$(CONFIG_ALPHAEXTRACT_FILTER)           += vf_extractplanes.o
 OBJS-$(CONFIG_ALPHAMERGE_FILTER)             += vf_alphamerge.o
+OBJS-$(CONFIG_ATADENOISE_FILTER)             += vf_atadenoise.o
 OBJS-$(CONFIG_BBOX_FILTER)                   += bbox.o vf_bbox.o
 OBJS-$(CONFIG_BLACKDETECT_FILTER)            += vf_blackdetect.o
 OBJS-$(CONFIG_BLACKFRAME_FILTER)             += vf_blackframe.o

libavfilter/allfilters.c

@@ -113,6 +113,7 @@ void avfilter_register_all(void)
 
     REGISTER_FILTER(ALPHAEXTRACT,   alphaextract,   vf);
     REGISTER_FILTER(ALPHAMERGE,     alphamerge,     vf);
+    REGISTER_FILTER(ATADENOISE,     atadenoise,     vf);
     REGISTER_FILTER(ASS,            ass,            vf);
     REGISTER_FILTER(BBOX,           bbox,           vf);
     REGISTER_FILTER(BLACKDETECT,    blackdetect,    vf);

libavfilter/version.h

@@ -30,7 +30,7 @@
 #include "libavutil/version.h"
 
 #define LIBAVFILTER_VERSION_MAJOR  5
-#define LIBAVFILTER_VERSION_MINOR  31
+#define LIBAVFILTER_VERSION_MINOR  32
 #define LIBAVFILTER_VERSION_MICRO 100
 
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \

libavfilter/vf_atadenoise.c

+/*
+ * Copyright (c) 2015 Paul B Mahol
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+/**
+ * @file
+ * Adaptive Temporal Averaging Denoiser,
+ * based on paper "Video Denoising Based on Adaptive Temporal Averaging" by
+ * David Bartovčak and Miroslav Vrankić
+ */
+
+#include "libavutil/opt.h"
+#include "libavutil/pixdesc.h"
+#include "avfilter.h"
+
+#define FF_BUFQUEUE_SIZE 129
+#include "bufferqueue.h"
+
+#include "formats.h"
+#include "internal.h"
+#include "video.h"
+
+#define SIZE FF_BUFQUEUE_SIZE
+
+typedef struct ATADenoiseContext {
+    const AVClass *class;
+
+    float fthra[4], fthrb[4];
+    int thra[4], thrb[4];
+
+    int nb_planes;
+    int planewidth[4];
+    int planeheight[4];
+
+    struct FFBufQueue q;
+    void *data[4][SIZE];
+    int linesize[4][SIZE];
+    int size, mid;
+    int available;
+
+    int (*filter_slice)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
+} ATADenoiseContext;
+
+#define OFFSET(x) offsetof(ATADenoiseContext, x)
+#define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
+
+static const AVOption atadenoise_options[] = {
+    { "0a", "set threshold A for 1st plane", OFFSET(fthra[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
+    { "0b", "set threshold B for 1st plane", OFFSET(fthrb[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
+    { "1a", "set threshold A for 2nd plane", OFFSET(fthra[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
+    { "1b", "set threshold B for 2nd plane", OFFSET(fthrb[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
+    { "2a", "set threshold A for 3rd plane", OFFSET(fthra[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
+    { "2b", "set threshold B for 3rd plane", OFFSET(fthrb[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
+    { "s",  "set how many frames to use",    OFFSET(size),     AV_OPT_TYPE_INT,   {.i64=33},   5, SIZE, FLAGS },
+    { NULL }
+};
+
+AVFILTER_DEFINE_CLASS(atadenoise);
+
+static int query_formats(AVFilterContext *ctx)
+{
+    static const enum AVPixelFormat pixel_fmts[] = {
+        AV_PIX_FMT_GRAY8,
+        AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
+        AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
+        AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
+        AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
+        AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
+        AV_PIX_FMT_YUVJ411P,
+        AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
+        AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
+        AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
+        AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
+        AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
+        AV_PIX_FMT_NONE
+    };
+    AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
+    if (!formats)
+        return AVERROR(ENOMEM);
+    return ff_set_common_formats(ctx, formats);
+}
+
+static av_cold int init(AVFilterContext *ctx)
+{
+    ATADenoiseContext *s = ctx->priv;
+
+    if (!(s->size & 1)) {
+        av_log(ctx, AV_LOG_ERROR, "size %d is invalid. Must be an odd value.\n", s->size);
+        return AVERROR(EINVAL);
+    }
+    s->mid = s->size / 2 + 1;
+
+    return 0;
+}
+
+typedef struct ThreadData {
+    AVFrame *in, *out;
+} ThreadData;
+
+static int filter_slice8(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
+{
+    ATADenoiseContext *s = ctx->priv;
+    ThreadData *td = arg;
+    AVFrame *in = td->in;
+    AVFrame *out = td->out;
+    const int size = s->size;
+    const int mid = s->mid;
+    int p, x, y, i, j;
+
+    for (p = 0; p < s->nb_planes; p++) {
+        const int h = s->planeheight[p];
+        const int w = s->planewidth[p];
+        const int slice_start = (h * jobnr) / nb_jobs;
+        const int slice_end = (h * (jobnr+1)) / nb_jobs;
+        const uint8_t *src = in->data[p] + slice_start * in->linesize[p];
+        uint8_t *dst = out->data[p] + slice_start * out->linesize[p];
+        const int thra = s->thra[p];
+        const int thrb = s->thrb[p];
+        const uint8_t **data = (const uint8_t **)s->data[p];
+        const int *linesize = (const int *)s->linesize[p];
+        const uint8_t *srcf[SIZE];
+
+        for (i = 0; i < size; i++)
+            srcf[i] = data[i] + slice_start * linesize[i];
+
+        for (y = slice_start; y < slice_end; y++) {
+            for (x = 0; x < w; x++) {
+                const int srcx = src[x];
+                unsigned lsumdiff = 0, rsumdiff = 0;
+                unsigned ldiff, rdiff;
+                unsigned sum = srcx;
+                int l = 0, r = 0;
+                int srcjx, srcix;
+
+                for (j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) {
+                    srcjx = srcf[j][x];
+
+                    ldiff = FFABS(srcx - srcjx);
+                    lsumdiff += ldiff;
+                    if (ldiff > thra ||
+                        lsumdiff > thrb)
+                        break;
+                    l++;
+                    sum += srcjx;
+
+                    srcix = srcf[i][x];
+
+                    rdiff = FFABS(srcx - srcix);
+                    rsumdiff += rdiff;
+                    if (rdiff > thra ||
+                        rsumdiff > thrb)
+                        break;
+                    r++;
+                    sum += srcix;
+                }
+
+                dst[x] = sum / (r + l + 1);
+            }
+
+            dst += out->linesize[p];
+            src += in->linesize[p];
+
+            for (i = 0; i < size; i++)
+                srcf[i] += linesize[i];
+        }
+    }
+
+    return 0;
+}
+
+static int filter_slice16(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
+{
+    ATADenoiseContext *s = ctx->priv;
+    ThreadData *td = arg;
+    AVFrame *in = td->in;
+    AVFrame *out = td->out;
+    const int size = s->size;
+    const int mid = s->mid;
+    int p, x, y, i, j;
+
+    for (p = 0; p < s->nb_planes; p++) {
+        const int h = s->planeheight[p];
+        const int w = s->planewidth[p];
+        const int slice_start = (h * jobnr) / nb_jobs;
+        const int slice_end = (h * (jobnr+1)) / nb_jobs;
+        const uint16_t *src = (uint16_t *)(in->data[p] + slice_start * in->linesize[p]);
+        uint16_t *dst = (uint16_t *)(out->data[p] + slice_start * out->linesize[p]);
+        const int thra = s->thra[p];
+        const int thrb = s->thrb[p];
+        const uint8_t **data = (const uint8_t **)s->data[p];
+        const int *linesize = (const int *)s->linesize[p];
+        const uint16_t *srcf[SIZE];
+
+        for (i = 0; i < s->size; i++)
+            srcf[i] = (const uint16_t *)(data[i] + slice_start * linesize[i]);
+
+        for (y = slice_start; y < slice_end; y++) {
+            for (x = 0; x < w; x++) {
+                const int srcx = src[x];
+                unsigned lsumdiff = 0, rsumdiff = 0;
+                unsigned ldiff, rdiff;
+                unsigned sum = srcx;
+                int l = 0, r = 0;
+                int srcjx, srcix;
+
+                for (j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) {
+                    srcjx = srcf[j][x];
+
+                    ldiff = FFABS(srcx - srcjx);
+                    lsumdiff += ldiff;
+                    if (ldiff > thra ||
+                        lsumdiff > thrb)
+                        break;
+                    l++;
+                    sum += srcjx;
+
+                    srcix = srcf[i][x];
+
+                    rdiff = FFABS(srcx - srcix);
+                    rsumdiff += rdiff;
+                    if (rdiff > thra ||
+                        rsumdiff > thrb)
+                        break;
+                    r++;
+                    sum += srcix;
+                }
+
+                dst[x] = sum / (r + l + 1);
+            }
+
+            dst += out->linesize[p] / 2;
+            src += in->linesize[p] / 2;
+
+            for (i = 0; i < size; i++)
+                srcf[i] += linesize[i] / 2;
+        }
+    }
+
+    return 0;
+}
+
+static int config_input(AVFilterLink *inlink)
+{
+    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
+    AVFilterContext *ctx = inlink->dst;
+    ATADenoiseContext *s = ctx->priv;
+    int depth;
+
+    s->nb_planes = desc->nb_components;
+
+    s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
+    s->planeheight[0] = s->planeheight[3] = inlink->h;
+    s->planewidth[1]  = s->planewidth[2]  = FF_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
+    s->planewidth[0]  = s->planewidth[3]  = inlink->w;
+
+    depth = desc->comp[0].depth_minus1 + 1;
+    if (depth == 8)
+        s->filter_slice = filter_slice8;
+    else
+        s->filter_slice = filter_slice16;
+
+    s->thra[0] = s->fthra[0] * (1 << depth) - 1;
+    s->thra[1] = s->fthra[1] * (1 << depth) - 1;
+    s->thra[2] = s->fthra[2] * (1 << depth) - 1;
+    s->thrb[0] = s->fthrb[0] * (1 << depth) - 1;
+    s->thrb[1] = s->fthrb[1] * (1 << depth) - 1;
+    s->thrb[2] = s->fthrb[2] * (1 << depth) - 1;
+
+    return 0;
+}
+
+static int config_output(AVFilterLink *outlink)
+{
+    outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
+    return 0;
+}
+
+static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
+{
+    AVFilterContext *ctx = inlink->dst;
+    AVFilterLink *outlink = ctx->outputs[0];
+    ATADenoiseContext *s = ctx->priv;
+    AVFrame *out, *in;
+    int i;
+
+    if (s->q.available != s->size) {
+        if (s->q.available < s->mid) {
+            out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
+            for (i = 0; i < s->mid; i++)
+                ff_bufqueue_add(ctx, &s->q, av_frame_clone(out));
+            av_frame_free(&out);
+        }
+        if (s->q.available < s->size) {
+            ff_bufqueue_add(ctx, &s->q, buf);
+            s->available++;
+        }
+        return 0;
+    }
+
+    in = ff_bufqueue_peek(&s->q, s->mid);
+
+    if (!ctx->is_disabled) {
+        ThreadData td;
+
+        out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
+        if (!out) {
+            av_frame_free(&buf);
+            return AVERROR(ENOMEM);
+        }
+
+        for (i = 0; i < s->size; i++) {
+            AVFrame *frame = ff_bufqueue_peek(&s->q, i);
+
+            s->data[0][i] = frame->data[0];
+            s->data[1][i] = frame->data[1];
+            s->data[2][i] = frame->data[2];
+            s->linesize[0][i] = frame->linesize[0];
+            s->linesize[1][i] = frame->linesize[1];
+            s->linesize[2][i] = frame->linesize[2];
+        }
+
+        td.in = in; td.out = out;
+        ctx->internal->execute(ctx, s->filter_slice, &td, NULL,
+                               FFMIN3(s->planeheight[1],
+                                      s->planeheight[2],
+                                      ctx->graph->nb_threads));
+        av_frame_copy_props(out, in);
+    } else {
+        out = av_frame_clone(in);
+        if (!out) {
+            av_frame_free(&buf);
+            return AVERROR(ENOMEM);
+        }
+    }
+
+    in = ff_bufqueue_get(&s->q);
+    av_frame_free(&in);
+    ff_bufqueue_add(ctx, &s->q, buf);
+
+    return ff_filter_frame(outlink, out);
+}
+
+static int request_frame(AVFilterLink *outlink)
+{
+    AVFilterContext *ctx = outlink->src;
+    ATADenoiseContext *s = ctx->priv;
+    int ret = 0;
+
+    ret = ff_request_frame(ctx->inputs[0]);
+
+    if (ret == AVERROR_EOF && !ctx->is_disabled && s->available) {
+        AVFrame *buf = ff_get_video_buffer(outlink, outlink->w, outlink->h);
+        if (!buf)
+            return AVERROR(ENOMEM);
+
+        ret = filter_frame(ctx->inputs[0], buf);
+        s->available--;
+    }
+
+    return ret;
+}
+
+static av_cold void uninit(AVFilterContext *ctx)
+{
+    ATADenoiseContext *s = ctx->priv;
+
+    ff_bufqueue_discard_all(&s->q);
+}
+
+static const AVFilterPad inputs[] = {
+    {
+        .name         = "default",
+        .type         = AVMEDIA_TYPE_VIDEO,
+        .filter_frame = filter_frame,
+        .config_props = config_input,
+    },
+    { NULL }
+};
+
+static const AVFilterPad outputs[] = {
+    {
+        .name          = "default",
+        .type          = AVMEDIA_TYPE_VIDEO,
+        .request_frame = request_frame,
+        .config_props  = config_output,
+    },
+    { NULL }
+};
+
+AVFilter ff_vf_atadenoise = {
+    .name          = "atadenoise",
+    .description   = NULL_IF_CONFIG_SMALL("Apply an Adaptive Temporal Averaging Denoiser."),
+    .priv_size     = sizeof(ATADenoiseContext),
+    .priv_class    = &atadenoise_class,
+    .init          = init,
+    .uninit        = uninit,
+    .query_formats = query_formats,
+    .inputs        = inputs,
+    .outputs       = outputs,
+    .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
+};