2 * Copyright (c) 2015 Paul B Mahol
4 * This file is part of FFmpeg.
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.
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.
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
23 * Adaptive Temporal Averaging Denoiser,
24 * based on paper "Video Denoising Based on Adaptive Temporal Averaging" by
25 * David Bartovčak and Miroslav Vrankić
28 #include "libavutil/imgutils.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
33 #define FF_BUFQUEUE_SIZE 129
34 #include "bufferqueue.h"
36 #include "atadenoise.h"
41 #define SIZE FF_BUFQUEUE_SIZE
43 typedef struct ATADenoiseContext {
46 float fthra[4], fthrb[4];
57 int linesize[4][SIZE];
61 int (*filter_slice)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
63 ATADenoiseDSPContext dsp;
66 #define OFFSET(x) offsetof(ATADenoiseContext, x)
67 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
68 #define VF AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
70 static const AVOption atadenoise_options[] = {
71 { "0a", "set threshold A for 1st plane", OFFSET(fthra[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
72 { "0b", "set threshold B for 1st plane", OFFSET(fthrb[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
73 { "1a", "set threshold A for 2nd plane", OFFSET(fthra[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
74 { "1b", "set threshold B for 2nd plane", OFFSET(fthrb[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
75 { "2a", "set threshold A for 3rd plane", OFFSET(fthra[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0, 0.3, FLAGS },
76 { "2b", "set threshold B for 3rd plane", OFFSET(fthrb[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.04}, 0, 5.0, FLAGS },
77 { "s", "set how many frames to use", OFFSET(size), AV_OPT_TYPE_INT, {.i64=9}, 5, SIZE, VF },
78 { "p", "set what planes to filter", OFFSET(planes), AV_OPT_TYPE_FLAGS, {.i64=7}, 0, 15, FLAGS },
79 { "a", "set variant of algorithm", OFFSET(algorithm),AV_OPT_TYPE_INT, {.i64=PARALLEL}, 0, NB_ATAA-1, FLAGS, "a" },
80 { "p", "parallel", 0, AV_OPT_TYPE_CONST, {.i64=PARALLEL}, 0, 0, FLAGS, "a" },
81 { "s", "serial", 0, AV_OPT_TYPE_CONST, {.i64=SERIAL}, 0, 0, FLAGS, "a" },
85 AVFILTER_DEFINE_CLASS(atadenoise);
87 static int query_formats(AVFilterContext *ctx)
89 static const enum AVPixelFormat pixel_fmts[] = {
96 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
97 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
98 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
99 AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
100 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
102 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
103 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
104 AV_PIX_FMT_YUV440P10,
105 AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
106 AV_PIX_FMT_YUV440P12,
107 AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
108 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
109 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
110 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
111 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
112 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA444P12, AV_PIX_FMT_YUVA444P16,
113 AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA422P16,
114 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA420P16,
115 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
118 AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
120 return AVERROR(ENOMEM);
121 return ff_set_common_formats(ctx, formats);
124 static av_cold int init(AVFilterContext *ctx)
126 ATADenoiseContext *s = ctx->priv;
128 if (!(s->size & 1)) {
129 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);
132 s->mid = s->size / 2 + 1;
137 typedef struct ThreadData {
141 #define FILTER_ROW(type, name) \
142 static void filter_row##name(const uint8_t *ssrc, uint8_t *ddst, \
143 const uint8_t *ssrcf[SIZE], \
144 int w, int mid, int size, \
145 int thra, int thrb) \
147 const type *src = (const type *)ssrc; \
148 const type **srcf = (const type **)ssrcf; \
149 type *dst = (type *)ddst; \
151 for (int x = 0; x < w; x++) { \
152 const int srcx = src[x]; \
153 unsigned lsumdiff = 0, rsumdiff = 0; \
154 unsigned ldiff, rdiff; \
155 unsigned sum = srcx; \
159 for (int j = mid - 1, i = mid + 1; j >= 0 && i < size; j--, i++) { \
160 srcjx = srcf[j][x]; \
162 ldiff = FFABS(srcx - srcjx); \
164 if (ldiff > thra || \
170 srcix = srcf[i][x]; \
172 rdiff = FFABS(srcx - srcix); \
174 if (rdiff > thra || \
181 dst[x] = (sum + ((r + l + 1) >> 1)) / (r + l + 1); \
185 FILTER_ROW(uint8_t, 8)
186 FILTER_ROW(uint16_t, 16)
188 #define FILTER_ROW_SERIAL(type, name) \
189 static void filter_row##name##_serial(const uint8_t *ssrc, uint8_t *ddst, \
190 const uint8_t *ssrcf[SIZE], \
191 int w, int mid, int size, \
192 int thra, int thrb) \
194 const type *src = (const type *)ssrc; \
195 const type **srcf = (const type **)ssrcf; \
196 type *dst = (type *)ddst; \
198 for (int x = 0; x < w; x++) { \
199 const int srcx = src[x]; \
200 unsigned lsumdiff = 0, rsumdiff = 0; \
201 unsigned ldiff, rdiff; \
202 unsigned sum = srcx; \
206 for (int j = mid - 1; j >= 0; j--) { \
207 srcjx = srcf[j][x]; \
209 ldiff = FFABS(srcx - srcjx); \
211 if (ldiff > thra || \
218 for (int i = mid + 1; i < size; i++) { \
219 srcix = srcf[i][x]; \
221 rdiff = FFABS(srcx - srcix); \
223 if (rdiff > thra || \
230 dst[x] = (sum + ((r + l + 1) >> 1)) / (r + l + 1); \
234 FILTER_ROW_SERIAL(uint8_t, 8)
235 FILTER_ROW_SERIAL(uint16_t, 16)
237 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
239 ATADenoiseContext *s = ctx->priv;
240 ThreadData *td = arg;
241 AVFrame *in = td->in;
242 AVFrame *out = td->out;
243 const int size = s->size;
244 const int mid = s->mid;
247 for (p = 0; p < s->nb_planes; p++) {
248 const int h = s->planeheight[p];
249 const int w = s->planewidth[p];
250 const int slice_start = (h * jobnr) / nb_jobs;
251 const int slice_end = (h * (jobnr+1)) / nb_jobs;
252 const uint8_t *src = in->data[p] + slice_start * in->linesize[p];
253 uint8_t *dst = out->data[p] + slice_start * out->linesize[p];
254 const int thra = s->thra[p];
255 const int thrb = s->thrb[p];
256 const uint8_t **data = (const uint8_t **)s->data[p];
257 const int *linesize = (const int *)s->linesize[p];
258 const uint8_t *srcf[SIZE];
260 if (!((1 << p) & s->planes)) {
261 av_image_copy_plane(dst, out->linesize[p], src, in->linesize[p],
262 w, slice_end - slice_start);
266 for (i = 0; i < size; i++)
267 srcf[i] = data[i] + slice_start * linesize[i];
269 for (y = slice_start; y < slice_end; y++) {
270 s->dsp.filter_row(src, dst, srcf, w, mid, size, thra, thrb);
272 dst += out->linesize[p];
273 src += in->linesize[p];
275 for (i = 0; i < size; i++)
276 srcf[i] += linesize[i];
283 static int config_input(AVFilterLink *inlink)
285 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
286 AVFilterContext *ctx = inlink->dst;
287 ATADenoiseContext *s = ctx->priv;
290 s->nb_planes = desc->nb_components;
292 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
293 s->planeheight[0] = s->planeheight[3] = inlink->h;
294 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
295 s->planewidth[0] = s->planewidth[3] = inlink->w;
297 depth = desc->comp[0].depth;
298 s->filter_slice = filter_slice;
300 s->dsp.filter_row = s->algorithm == PARALLEL ? filter_row8 : filter_row8_serial;
302 s->dsp.filter_row = s->algorithm == PARALLEL ? filter_row16 : filter_row16_serial;
304 s->thra[0] = s->fthra[0] * (1 << depth) - 1;
305 s->thra[1] = s->fthra[1] * (1 << depth) - 1;
306 s->thra[2] = s->fthra[2] * (1 << depth) - 1;
307 s->thrb[0] = s->fthrb[0] * (1 << depth) - 1;
308 s->thrb[1] = s->fthrb[1] * (1 << depth) - 1;
309 s->thrb[2] = s->fthrb[2] * (1 << depth) - 1;
312 ff_atadenoise_init_x86(&s->dsp, depth, s->algorithm);
317 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
319 AVFilterContext *ctx = inlink->dst;
320 AVFilterLink *outlink = ctx->outputs[0];
321 ATADenoiseContext *s = ctx->priv;
325 if (s->q.available != s->size) {
326 if (s->q.available < s->mid) {
327 for (i = 0; i < s->mid; i++) {
328 out = av_frame_clone(buf);
331 return AVERROR(ENOMEM);
333 ff_bufqueue_add(ctx, &s->q, out);
336 if (s->q.available < s->size) {
337 ff_bufqueue_add(ctx, &s->q, buf);
343 in = ff_bufqueue_peek(&s->q, s->mid);
345 if (!ctx->is_disabled) {
348 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
351 return AVERROR(ENOMEM);
354 for (i = 0; i < s->size; i++) {
355 AVFrame *frame = ff_bufqueue_peek(&s->q, i);
357 s->data[0][i] = frame->data[0];
358 s->data[1][i] = frame->data[1];
359 s->data[2][i] = frame->data[2];
360 s->linesize[0][i] = frame->linesize[0];
361 s->linesize[1][i] = frame->linesize[1];
362 s->linesize[2][i] = frame->linesize[2];
365 td.in = in; td.out = out;
366 ctx->internal->execute(ctx, s->filter_slice, &td, NULL,
367 FFMIN3(s->planeheight[1],
369 ff_filter_get_nb_threads(ctx)));
370 av_frame_copy_props(out, in);
372 out = av_frame_clone(in);
375 return AVERROR(ENOMEM);
379 in = ff_bufqueue_get(&s->q);
381 ff_bufqueue_add(ctx, &s->q, buf);
383 return ff_filter_frame(outlink, out);
386 static int request_frame(AVFilterLink *outlink)
388 AVFilterContext *ctx = outlink->src;
389 ATADenoiseContext *s = ctx->priv;
392 ret = ff_request_frame(ctx->inputs[0]);
394 if (ret == AVERROR_EOF && !ctx->is_disabled && s->available) {
395 AVFrame *buf = av_frame_clone(ff_bufqueue_peek(&s->q, s->available));
397 return AVERROR(ENOMEM);
399 ret = filter_frame(ctx->inputs[0], buf);
406 static av_cold void uninit(AVFilterContext *ctx)
408 ATADenoiseContext *s = ctx->priv;
410 ff_bufqueue_discard_all(&s->q);
413 static int process_command(AVFilterContext *ctx,
420 int ret = ff_filter_process_command(ctx, cmd, arg, res, res_len, flags);
425 return config_input(ctx->inputs[0]);
428 static const AVFilterPad inputs[] = {
431 .type = AVMEDIA_TYPE_VIDEO,
432 .filter_frame = filter_frame,
433 .config_props = config_input,
438 static const AVFilterPad outputs[] = {
441 .type = AVMEDIA_TYPE_VIDEO,
442 .request_frame = request_frame,
447 AVFilter ff_vf_atadenoise = {
448 .name = "atadenoise",
449 .description = NULL_IF_CONFIG_SMALL("Apply an Adaptive Temporal Averaging Denoiser."),
450 .priv_size = sizeof(ATADenoiseContext),
451 .priv_class = &atadenoise_class,
454 .query_formats = query_formats,
457 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
458 .process_command = process_command,