2 * Copyright (c) 2012 Laurent de Soras
3 * Copyright (c) 2013 Fredrik Mellbin
4 * Copyright (c) 2015 Paul B Mahol
5 * Copyright (c) 2015 James Darnley
7 * This file is part of FFmpeg.
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * FFmpeg is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libavutil/imgutils.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/pixdesc.h"
27 #include "libavutil/qsort.h"
31 #include "removegrain.h"
34 #define OFFSET(x) offsetof(RemoveGrainContext, x)
35 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
37 static const AVOption removegrain_options[] = {
38 { "m0", "set mode for 1st plane", OFFSET(mode[0]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
39 { "m1", "set mode for 2nd plane", OFFSET(mode[1]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
40 { "m2", "set mode for 3rd plane", OFFSET(mode[2]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
41 { "m3", "set mode for 4th plane", OFFSET(mode[3]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
45 AVFILTER_DEFINE_CLASS(removegrain);
47 static int query_formats(AVFilterContext *ctx)
49 static const enum AVPixelFormat pix_fmts[] = {
51 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
52 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
53 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
54 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
55 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
56 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
60 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
62 return AVERROR(ENOMEM);
63 return ff_set_common_formats(ctx, fmts_list);
66 #define REMOVE_GRAIN_SORT_AXIS \
67 const int ma1 = FFMAX(a1, a8); \
68 const int mi1 = FFMIN(a1, a8); \
69 const int ma2 = FFMAX(a2, a7); \
70 const int mi2 = FFMIN(a2, a7); \
71 const int ma3 = FFMAX(a3, a6); \
72 const int mi3 = FFMIN(a3, a6); \
73 const int ma4 = FFMAX(a4, a5); \
74 const int mi4 = FFMIN(a4, a5);
76 static int mode01(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
78 const int mi = FFMIN(FFMIN(FFMIN(a1, a2), FFMIN(a3, a4)), FFMIN(FFMIN(a5, a6), FFMIN(a7, a8)));
79 const int ma = FFMAX(FFMAX(FFMAX(a1, a2), FFMAX(a3, a4)), FFMAX(FFMAX(a5, a6), FFMAX(a7, a8)));
81 return av_clip(c, mi, ma);
84 static int cmp_int(const void *p1, const void *p2)
86 int left = *(const int *)p1;
87 int right = *(const int *)p2;
88 return FFDIFFSIGN(left, right);
91 static int mode02(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
93 int a[8] = { a1, a2, a3, a4, a5, a6, a7, a8 };
95 AV_QSORT(a, 8, int, cmp_int);
97 return av_clip(c, a[2 - 1 ], a[7 - 1]);
100 static int mode03(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
102 int a[8] = { a1, a2, a3, a4, a5, a6, a7, a8 };
104 AV_QSORT(a, 8, int, cmp_int);
106 return av_clip(c, a[3 - 1 ], a[6 - 1]);
109 static int mode04(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
111 int a[8] = { a1, a2, a3, a4, a5, a6, a7, a8 };
113 AV_QSORT(a, 8, int, cmp_int);
115 return av_clip(c, a[4 - 1 ], a[5 - 1]);
118 static int mode05(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
120 REMOVE_GRAIN_SORT_AXIS
122 const int c1 = FFABS(c - av_clip(c, mi1, ma1));
123 const int c2 = FFABS(c - av_clip(c, mi2, ma2));
124 const int c3 = FFABS(c - av_clip(c, mi3, ma3));
125 const int c4 = FFABS(c - av_clip(c, mi4, ma4));
127 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
129 /* When adding SIMD notice the return order here: 4, 2, 3, 1. */
131 return av_clip(c, mi4, ma4);
132 } else if (mindiff == c2) {
133 return av_clip(c, mi2, ma2);
134 } else if (mindiff == c3) {
135 return av_clip(c, mi3, ma3);
138 return av_clip(c, mi1, ma1);
141 static int mode06(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
143 REMOVE_GRAIN_SORT_AXIS
145 const int d1 = ma1 - mi1;
146 const int d2 = ma2 - mi2;
147 const int d3 = ma3 - mi3;
148 const int d4 = ma4 - mi4;
150 const int cli1 = av_clip(c, mi1, ma1);
151 const int cli2 = av_clip(c, mi2, ma2);
152 const int cli3 = av_clip(c, mi3, ma3);
153 const int cli4 = av_clip(c, mi4, ma4);
155 const int c1 = av_clip_uint16((FFABS(c - cli1) << 1) + d1);
156 const int c2 = av_clip_uint16((FFABS(c - cli2) << 1) + d2);
157 const int c3 = av_clip_uint16((FFABS(c - cli3) << 1) + d3);
158 const int c4 = av_clip_uint16((FFABS(c - cli4) << 1) + d4);
160 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
164 } else if (mindiff == c2) {
166 } else if (mindiff == c3) {
173 static int mode07(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
175 REMOVE_GRAIN_SORT_AXIS
177 const int d1 = ma1 - mi1;
178 const int d2 = ma2 - mi2;
179 const int d3 = ma3 - mi3;
180 const int d4 = ma4 - mi4;
182 const int cli1 = av_clip(c, mi1, ma1);
183 const int cli2 = av_clip(c, mi2, ma2);
184 const int cli3 = av_clip(c, mi3, ma3);
185 const int cli4 = av_clip(c, mi4, ma4);
187 const int c1 = FFABS(c - cli1) + d1;
188 const int c2 = FFABS(c - cli2) + d2;
189 const int c3 = FFABS(c - cli3) + d3;
190 const int c4 = FFABS(c - cli4) + d4;
192 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
196 } else if (mindiff == c2) {
198 } else if (mindiff == c3) {
205 static int mode08(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
207 REMOVE_GRAIN_SORT_AXIS
209 const int d1 = ma1 - mi1;
210 const int d2 = ma2 - mi2;
211 const int d3 = ma3 - mi3;
212 const int d4 = ma4 - mi4;
214 const int cli1 = av_clip(c, mi1, ma1);
215 const int cli2 = av_clip(c, mi2, ma2);
216 const int cli3 = av_clip(c, mi3, ma3);
217 const int cli4 = av_clip(c, mi4, ma4);
219 const int c1 = av_clip_uint16(FFABS(c - cli1) + (d1 << 1));
220 const int c2 = av_clip_uint16(FFABS(c - cli2) + (d2 << 1));
221 const int c3 = av_clip_uint16(FFABS(c - cli3) + (d3 << 1));
222 const int c4 = av_clip_uint16(FFABS(c - cli4) + (d4 << 1));
224 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
228 } else if (mindiff == c2) {
230 } else if (mindiff == c3) {
237 static int mode09(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
239 REMOVE_GRAIN_SORT_AXIS
241 const int d1 = ma1 - mi1;
242 const int d2 = ma2 - mi2;
243 const int d3 = ma3 - mi3;
244 const int d4 = ma4 - mi4;
246 const int mindiff = FFMIN(FFMIN(d1, d2), FFMIN(d3, d4));
249 return av_clip(c, mi4, ma4);
250 } else if (mindiff == d2) {
251 return av_clip(c, mi2, ma2);
252 } else if (mindiff == d3) {
253 return av_clip(c, mi3, ma3);
256 return av_clip(c, mi1, ma1);
259 static int mode10(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
261 const int d1 = FFABS(c - a1);
262 const int d2 = FFABS(c - a2);
263 const int d3 = FFABS(c - a3);
264 const int d4 = FFABS(c - a4);
265 const int d5 = FFABS(c - a5);
266 const int d6 = FFABS(c - a6);
267 const int d7 = FFABS(c - a7);
268 const int d8 = FFABS(c - a8);
270 const int mindiff = FFMIN(FFMIN(FFMIN(d1, d2), FFMIN(d3, d4)),
271 FFMIN(FFMIN(d5, d6), FFMIN(d7, d8)));
273 if (mindiff == d7) return a7;
274 if (mindiff == d8) return a8;
275 if (mindiff == d6) return a6;
276 if (mindiff == d2) return a2;
277 if (mindiff == d3) return a3;
278 if (mindiff == d1) return a1;
279 if (mindiff == d5) return a5;
284 static int mode1112(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
286 const int sum = 4 * c + 2 * (a2 + a4 + a5 + a7) + a1 + a3 + a6 + a8;
287 const int val = (sum + 8) >> 4;
292 static int mode1314(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
294 const int d1 = FFABS(a1 - a8);
295 const int d2 = FFABS(a2 - a7);
296 const int d3 = FFABS(a3 - a6);
298 const int mindiff = FFMIN(FFMIN(d1, d2), d3);
301 return (a2 + a7 + 1) >> 1;
304 return (a3 + a6 + 1) >> 1;
307 return (a1 + a8 + 1) >> 1;
310 static int mode1516(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
312 const int d1 = FFABS(a1 - a8);
313 const int d2 = FFABS(a2 - a7);
314 const int d3 = FFABS(a3 - a6);
316 const int mindiff = FFMIN(FFMIN(d1, d2), d3);
317 const int average = (2 * (a2 + a7) + a1 + a3 + a6 + a8 + 4) >> 3;
320 return av_clip(average, FFMIN(a2, a7), FFMAX(a2, a7));
323 return av_clip(average, FFMIN(a3, a6), FFMAX(a3, a6));
326 return av_clip(average, FFMIN(a1, a8), FFMAX(a1, a8));
329 static int mode17(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
331 REMOVE_GRAIN_SORT_AXIS
333 const int l = FFMAX(FFMAX(mi1, mi2), FFMAX(mi3, mi4));
334 const int u = FFMIN(FFMIN(ma1, ma2), FFMIN(ma3, ma4));
336 return av_clip(c, FFMIN(l, u), FFMAX(l, u));
339 static int mode18(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
341 const int d1 = FFMAX(FFABS(c - a1), FFABS(c - a8));
342 const int d2 = FFMAX(FFABS(c - a2), FFABS(c - a7));
343 const int d3 = FFMAX(FFABS(c - a3), FFABS(c - a6));
344 const int d4 = FFMAX(FFABS(c - a4), FFABS(c - a5));
346 const int mindiff = FFMIN(FFMIN(d1, d2), FFMIN(d3, d4));
349 return av_clip(c, FFMIN(a4, a5), FFMAX(a4, a5));
352 return av_clip(c, FFMIN(a2, a7), FFMAX(a2, a7));
355 return av_clip(c, FFMIN(a3, a6), FFMAX(a3, a6));
358 return av_clip(c, FFMIN(a1, a8), FFMAX(a1, a8));
361 static int mode19(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
363 const int sum = a1 + a2 + a3 + a4 + a5 + a6 + a7 + a8;
364 const int val = (sum + 4) >> 3;
369 static int mode20(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
371 const int sum = a1 + a2 + a3 + a4 + c + a5 + a6 + a7 + a8;
372 const int val = (sum + 4) / 9;
377 static int mode21(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
379 const int l1l = (a1 + a8) >> 1;
380 const int l2l = (a2 + a7) >> 1;
381 const int l3l = (a3 + a6) >> 1;
382 const int l4l = (a4 + a5) >> 1;
384 const int l1h = (a1 + a8 + 1) >> 1;
385 const int l2h = (a2 + a7 + 1) >> 1;
386 const int l3h = (a3 + a6 + 1) >> 1;
387 const int l4h = (a4 + a5 + 1) >> 1;
389 const int mi = FFMIN(FFMIN(l1l, l2l), FFMIN(l3l, l4l));
390 const int ma = FFMAX(FFMAX(l1h, l2h), FFMAX(l3h, l4h));
392 return av_clip(c, mi, ma);
395 static int mode22(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
397 const int l1 = (a1 + a8 + 1) >> 1;
398 const int l2 = (a2 + a7 + 1) >> 1;
399 const int l3 = (a3 + a6 + 1) >> 1;
400 const int l4 = (a4 + a5 + 1) >> 1;
402 const int mi = FFMIN(FFMIN(l1, l2), FFMIN(l3, l4));
403 const int ma = FFMAX(FFMAX(l1, l2), FFMAX(l3, l4));
405 return av_clip(c, mi, ma);
408 static int mode23(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
410 REMOVE_GRAIN_SORT_AXIS
412 const int linediff1 = ma1 - mi1;
413 const int linediff2 = ma2 - mi2;
414 const int linediff3 = ma3 - mi3;
415 const int linediff4 = ma4 - mi4;
417 const int u1 = FFMIN(c - ma1, linediff1);
418 const int u2 = FFMIN(c - ma2, linediff2);
419 const int u3 = FFMIN(c - ma3, linediff3);
420 const int u4 = FFMIN(c - ma4, linediff4);
421 const int u = FFMAX(FFMAX(FFMAX(u1, u2), FFMAX(u3, u4)), 0);
423 const int d1 = FFMIN(mi1 - c, linediff1);
424 const int d2 = FFMIN(mi2 - c, linediff2);
425 const int d3 = FFMIN(mi3 - c, linediff3);
426 const int d4 = FFMIN(mi4 - c, linediff4);
427 const int d = FFMAX(FFMAX(FFMAX(d1, d2), FFMAX(d3, d4)), 0);
429 return c - u + d; // This probably will never overflow.
432 static int mode24(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
434 REMOVE_GRAIN_SORT_AXIS
436 const int linediff1 = ma1 - mi1;
437 const int linediff2 = ma2 - mi2;
438 const int linediff3 = ma3 - mi3;
439 const int linediff4 = ma4 - mi4;
441 const int tu1 = c - ma1;
442 const int tu2 = c - ma2;
443 const int tu3 = c - ma3;
444 const int tu4 = c - ma4;
446 const int u1 = FFMIN(tu1, linediff1 - tu1);
447 const int u2 = FFMIN(tu2, linediff2 - tu2);
448 const int u3 = FFMIN(tu3, linediff3 - tu3);
449 const int u4 = FFMIN(tu4, linediff4 - tu4);
450 const int u = FFMAX(FFMAX(FFMAX(u1, u2), FFMAX(u3, u4)), 0);
452 const int td1 = mi1 - c;
453 const int td2 = mi2 - c;
454 const int td3 = mi3 - c;
455 const int td4 = mi4 - c;
457 const int d1 = FFMIN(td1, linediff1 - td1);
458 const int d2 = FFMIN(td2, linediff2 - td2);
459 const int d3 = FFMIN(td3, linediff3 - td3);
460 const int d4 = FFMIN(td4, linediff4 - td4);
461 const int d = FFMAX(FFMAX(FFMAX(d1, d2), FFMAX(d3, d4)), 0);
463 return c - u + d; // This probably will never overflow.
466 static int config_input(AVFilterLink *inlink)
468 RemoveGrainContext *s = inlink->dst->priv;
469 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
472 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
474 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
475 s->planeheight[0] = s->planeheight[3] = inlink->h;
476 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
477 s->planewidth[0] = s->planewidth[3] = inlink->w;
479 for (i = 0; i < s->nb_planes; i++) {
480 switch (s->mode[i]) {
481 case 1: s->rg[i] = mode01; break;
482 case 2: s->rg[i] = mode02; break;
483 case 3: s->rg[i] = mode03; break;
484 case 4: s->rg[i] = mode04; break;
485 case 5: s->rg[i] = mode05; break;
486 case 6: s->rg[i] = mode06; break;
487 case 7: s->rg[i] = mode07; break;
488 case 8: s->rg[i] = mode08; break;
489 case 9: s->rg[i] = mode09; break;
490 case 10: s->rg[i] = mode10; break;
491 case 11: s->rg[i] = mode1112; break;
492 case 12: s->rg[i] = mode1112; break;
493 case 13: s->skip_odd = 1;
494 s->rg[i] = mode1314; break;
495 case 14: s->skip_even = 1;
496 s->rg[i] = mode1314; break;
497 case 15: s->skip_odd = 1;
498 s->rg[i] = mode1516; break;
499 case 16: s->skip_even = 1;
500 s->rg[i] = mode1516; break;
501 case 17: s->rg[i] = mode17; break;
502 case 18: s->rg[i] = mode18; break;
503 case 19: s->rg[i] = mode19; break;
504 case 20: s->rg[i] = mode20; break;
505 case 21: s->rg[i] = mode21; break;
506 case 22: s->rg[i] = mode22; break;
507 case 23: s->rg[i] = mode23; break;
508 case 24: s->rg[i] = mode24; break;
513 ff_removegrain_init_x86(s);
518 typedef struct ThreadData {
523 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
525 RemoveGrainContext *s = ctx->priv;
526 ThreadData *td = arg;
527 AVFrame *in = td->in;
528 AVFrame *out = td->out;
529 const int i = td->plane;
530 const int height = s->planeheight[i];
531 const int om = in->linesize[i] - 1;
532 const int o0 = in->linesize[i] ;
533 const int op = in->linesize[i] + 1;
534 int start = (height * jobnr ) / nb_jobs;
535 int end = (height * (jobnr+1)) / nb_jobs;
538 start = FFMAX(1, start);
539 end = FFMIN(height-1, end);
540 for (y = start; y < end; y++) {
541 uint8_t *dst = out->data[i];
542 uint8_t *src = in->data[i];
544 src = in->data[i] + y * in->linesize[i];
545 dst = out->data[i] + y * out->linesize[i];
547 if (s->skip_even && !(y & 1)) {
548 memcpy(dst, src, s->planewidth[i]);
551 if (s->skip_odd && y & 1) {
552 memcpy(dst, src, s->planewidth[i]);
559 int w_asm = (s->planewidth[i] - 2) & ~15;
561 s->fl[i](dst, src, in->linesize[i], w_asm);
569 for (; x < s->planewidth[i] - 1; x++) {
570 const int a1 = src[-op];
571 const int a2 = src[-o0];
572 const int a3 = src[-om];
573 const int a4 = src[-1 ];
574 const int c = src[ 0 ];
575 const int a5 = src[ 1 ];
576 const int a6 = src[ om];
577 const int a7 = src[ o0];
578 const int a8 = src[ op];
580 const int res = s->rg[i](c, a1, a2, a3, a4, a5, a6, a7, a8);
591 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
593 AVFilterContext *ctx = inlink->dst;
594 AVFilterLink *outlink = ctx->outputs[0];
595 RemoveGrainContext *s = ctx->priv;
600 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
603 return AVERROR(ENOMEM);
605 av_frame_copy_props(out, in);
607 for (i = 0; i < s->nb_planes; i++) {
608 uint8_t *dst = out->data[i];
609 uint8_t *src = in->data[i];
611 if (s->mode[i] == 0) {
612 av_image_copy_plane(dst, out->linesize[i],
613 src, in->linesize[i],
614 s->planewidth[i], s->planeheight[i]);
618 memcpy(dst, src, s->planewidth[i]);
620 td.in = in; td.out = out; td.plane = i;
621 ctx->internal->execute(ctx, filter_slice, &td, NULL,
622 FFMIN(s->planeheight[i], ff_filter_get_nb_threads(ctx)));
624 src = in->data[i] + (s->planeheight[i] - 1) * in->linesize[i];
625 dst = out->data[i] + (s->planeheight[i] - 1) * out->linesize[i];
626 memcpy(dst, src, s->planewidth[i]);
630 return ff_filter_frame(outlink, out);
633 static const AVFilterPad removegrain_inputs[] = {
636 .type = AVMEDIA_TYPE_VIDEO,
637 .filter_frame = filter_frame,
638 .config_props = config_input,
643 static const AVFilterPad removegrain_outputs[] = {
646 .type = AVMEDIA_TYPE_VIDEO,
651 const AVFilter ff_vf_removegrain = {
652 .name = "removegrain",
653 .description = NULL_IF_CONFIG_SMALL("Remove grain."),
654 .priv_size = sizeof(RemoveGrainContext),
655 .query_formats = query_formats,
656 .inputs = removegrain_inputs,
657 .outputs = removegrain_outputs,
658 .priv_class = &removegrain_class,
659 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,