2 * Copyright (c) 2012 Laurent de Soras
3 * Copyright (c) 2013 Fredrik Mellbin
4 * Copyright (c) 2015 Paul B Mahol
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 #include "libavutil/imgutils.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
35 typedef struct RemoveGrainContext {
46 int (*rg[4])(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8);
49 #define OFFSET(x) offsetof(RemoveGrainContext, x)
50 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
52 static const AVOption removegrain_options[] = {
53 { "m0", "set mode for 1st plane", OFFSET(mode[0]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
54 { "m1", "set mode for 2nd plane", OFFSET(mode[1]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
55 { "m2", "set mode for 3rd plane", OFFSET(mode[2]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
56 { "m3", "set mode for 4th plane", OFFSET(mode[3]), AV_OPT_TYPE_INT, {.i64=0}, 0, 24, FLAGS },
60 AVFILTER_DEFINE_CLASS(removegrain);
62 static int query_formats(AVFilterContext *ctx)
64 static const enum AVPixelFormat pix_fmts[] = {
66 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
67 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
68 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
69 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
70 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
71 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
75 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
77 return AVERROR(ENOMEM);
78 return ff_set_common_formats(ctx, fmts_list);
81 #define REMOVE_GRAIN_SORT_AXIS \
82 const int ma1 = FFMAX(a1, a8); \
83 const int mi1 = FFMIN(a1, a8); \
84 const int ma2 = FFMAX(a2, a7); \
85 const int mi2 = FFMIN(a2, a7); \
86 const int ma3 = FFMAX(a3, a6); \
87 const int mi3 = FFMIN(a3, a6); \
88 const int ma4 = FFMAX(a4, a5); \
89 const int mi4 = FFMIN(a4, a5);
91 static int mode01(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
93 const int mi = FFMIN(FFMIN(FFMIN(a1, a2), FFMIN(a3, a4)), FFMIN(FFMIN(a5, a6), FFMIN(a7, a8)));
94 const int ma = FFMAX(FFMAX(FFMAX(a1, a2), FFMAX(a3, a4)), FFMAX(FFMAX(a5, a6), FFMAX(a7, a8)));
96 return av_clip(c, mi, ma);
99 static int cmp_int(const void *p1, const void *p2)
101 int left = *(const int *)p1;
102 int right = *(const int *)p2;
104 return ((left > right) - (left < right));
107 static int mode02(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
109 int a[8] = { a1, a2, a3, a4, a5, a6, a7, a8 };
111 qsort(&a, 8, sizeof(a[0]), cmp_int);
113 return av_clip(c, a[2 - 1 ], a[7 - 1]);
116 static int mode03(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
118 int a[8] = { a1, a2, a3, a4, a5, a6, a7, a8 };
120 qsort(&a, 8, sizeof(a[0]), cmp_int);
122 return av_clip(c, a[3 - 1 ], a[6 - 1]);
125 static int mode04(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
127 int a[8] = { a1, a2, a3, a4, a5, a6, a7, a8 };
129 qsort(&a, 8, sizeof(a[0]), cmp_int);
131 return av_clip(c, a[4 - 1 ], a[5 - 1]);
134 static int mode05(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
136 REMOVE_GRAIN_SORT_AXIS
138 const int c1 = FFABS(c - av_clip(c, mi1, ma1));
139 const int c2 = FFABS(c - av_clip(c, mi2, ma2));
140 const int c3 = FFABS(c - av_clip(c, mi3, ma3));
141 const int c4 = FFABS(c - av_clip(c, mi4, ma4));
143 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
146 return av_clip(c, mi4, ma4);
147 } else if (mindiff == c2) {
148 return av_clip(c, mi2, ma2);
149 } else if (mindiff == c3) {
150 return av_clip(c, mi3, ma3);
153 return av_clip(c, mi1, ma1);
156 static int mode06(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
158 REMOVE_GRAIN_SORT_AXIS
160 const int d1 = ma1 - mi1;
161 const int d2 = ma2 - mi2;
162 const int d3 = ma3 - mi3;
163 const int d4 = ma4 - mi4;
165 const int cli1 = av_clip(c, mi1, ma1);
166 const int cli2 = av_clip(c, mi2, ma2);
167 const int cli3 = av_clip(c, mi3, ma3);
168 const int cli4 = av_clip(c, mi4, ma4);
170 const int c1 = av_clip_uint8((FFABS(c - cli1) << 1) + d1);
171 const int c2 = av_clip_uint8((FFABS(c - cli2) << 1) + d2);
172 const int c3 = av_clip_uint8((FFABS(c - cli3) << 1) + d3);
173 const int c4 = av_clip_uint8((FFABS(c - cli4) << 1) + d4);
175 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
179 } else if (mindiff == c2) {
181 } else if (mindiff == c3) {
188 static int mode07(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
190 REMOVE_GRAIN_SORT_AXIS
192 const int d1 = ma1 - mi1;
193 const int d2 = ma2 - mi2;
194 const int d3 = ma3 - mi3;
195 const int d4 = ma4 - mi4;
197 const int cli1 = av_clip(c, mi1, ma1);
198 const int cli2 = av_clip(c, mi2, ma2);
199 const int cli3 = av_clip(c, mi3, ma3);
200 const int cli4 = av_clip(c, mi4, ma4);
202 const int c1 = FFABS(c - cli1) + d1;
203 const int c2 = FFABS(c - cli2) + d2;
204 const int c3 = FFABS(c - cli3) + d3;
205 const int c4 = FFABS(c - cli4) + d4;
207 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
211 } else if (mindiff == c2) {
213 } else if (mindiff == c3) {
220 static int mode08(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
222 REMOVE_GRAIN_SORT_AXIS
224 const int d1 = ma1 - mi1;
225 const int d2 = ma2 - mi2;
226 const int d3 = ma3 - mi3;
227 const int d4 = ma4 - mi4;
229 const int cli1 = av_clip(c, mi1, ma1);
230 const int cli2 = av_clip(c, mi2, ma2);
231 const int cli3 = av_clip(c, mi3, ma3);
232 const int cli4 = av_clip(c, mi4, ma4);
234 const int c1 = av_clip_uint8(FFABS(c - cli1) + (d1 << 1));
235 const int c2 = av_clip_uint8(FFABS(c - cli2) + (d2 << 1));
236 const int c3 = av_clip_uint8(FFABS(c - cli3) + (d3 << 1));
237 const int c4 = av_clip_uint8(FFABS(c - cli4) + (d4 << 1));
239 const int mindiff = FFMIN(FFMIN(c1, c2), FFMIN(c3, c4));
243 } else if (mindiff == c2) {
245 } else if (mindiff == c3) {
252 static int mode09(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
254 REMOVE_GRAIN_SORT_AXIS
256 const int d1 = ma1 - mi1;
257 const int d2 = ma2 - mi2;
258 const int d3 = ma3 - mi3;
259 const int d4 = ma4 - mi4;
261 const int mindiff = FFMIN(FFMIN(d1, d2), FFMIN(d3, d4));
264 return av_clip(c, mi4, ma4);
265 } else if (mindiff == d2) {
266 return av_clip(c, mi2, ma2);
267 } else if (mindiff == d3) {
268 return av_clip(c, mi3, ma3);
271 return av_clip(c, mi1, ma1);
274 static int mode10(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
276 const int d1 = FFABS(c - a1);
277 const int d2 = FFABS(c - a2);
278 const int d3 = FFABS(c - a3);
279 const int d4 = FFABS(c - a4);
280 const int d5 = FFABS(c - a5);
281 const int d6 = FFABS(c - a6);
282 const int d7 = FFABS(c - a7);
283 const int d8 = FFABS(c - a8);
285 const int mindiff = FFMIN(FFMIN(FFMIN(d1, d2), FFMIN(d3, d4)),
286 FFMIN(FFMIN(d5, d6), FFMIN(d7, d8)));
288 if (mindiff == d7) return a7;
289 if (mindiff == d8) return a8;
290 if (mindiff == d6) return a6;
291 if (mindiff == d2) return a2;
292 if (mindiff == d3) return a3;
293 if (mindiff == d1) return a1;
294 if (mindiff == d5) return a5;
299 static int mode1112(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
301 const int sum = 4 * c + 2 * (a2 + a4 + a5 + a7) + a1 + a3 + a6 + a8;
302 const int val = (sum + 8) >> 4;
307 static int mode1314(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
309 const int d1 = FFABS(a1 - a8);
310 const int d2 = FFABS(a2 - a7);
311 const int d3 = FFABS(a3 - a6);
313 const int mindiff = FFMIN(FFMIN(d1, d2), d3);
316 return (a2 + a7 + 1) >> 1;
319 return (a3 + a6 + 1) >> 1;
322 return (a1 + a8 + 1) >> 1;
325 static int mode1516(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
327 const int d1 = FFABS(a1 - a8);
328 const int d2 = FFABS(a2 - a7);
329 const int d3 = FFABS(a3 - a6);
331 const int mindiff = FFMIN(FFMIN(d1, d2), d3);
332 const int average = (2 * (a2 + a7) + a1 + a3 + a6 + a8 + 4) >> 3;
335 return av_clip(average, FFMIN(a2, a7), FFMAX(a2, a7));
338 return av_clip(average, FFMIN(a3, a6), FFMAX(a3, a6));
341 return av_clip(average, FFMIN(a1, a8), FFMAX(a1, a8));
344 static int mode17(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
346 REMOVE_GRAIN_SORT_AXIS
348 const int l = FFMAX(FFMAX(mi1, mi2), FFMAX(mi3, mi4));
349 const int u = FFMIN(FFMIN(ma1, ma2), FFMIN(ma3, ma4));
351 return av_clip(c, FFMIN(l, u), FFMAX(l, u));
354 static int mode18(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
356 const int d1 = FFMAX(FFABS(c - a1), FFABS(c - a8));
357 const int d2 = FFMAX(FFABS(c - a2), FFABS(c - a7));
358 const int d3 = FFMAX(FFABS(c - a3), FFABS(c - a6));
359 const int d4 = FFMAX(FFABS(c - a4), FFABS(c - a5));
361 const int mindiff = FFMIN(FFMIN(d1, d2), FFMIN(d3, d4));
364 return av_clip(c, FFMIN(a4, a5), FFMAX(a4, a5));
367 return av_clip(c, FFMIN(a2, a7), FFMAX(a2, a7));
370 return av_clip(c, FFMIN(a3, a6), FFMAX(a3, a6));
373 return av_clip(c, FFMIN(a1, a8), FFMAX(a1, a8));
376 static int mode19(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
378 const int sum = a1 + a2 + a3 + a4 + a5 + a6 + a7 + a8;
379 const int val = (sum + 4) >> 3;
384 static int mode20(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
386 const int sum = a1 + a2 + a3 + a4 + c + a5 + a6 + a7 + a8;
387 const int val = (sum + 4) / 9;
392 static int mode21(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
394 const int l1l = (a1 + a8) >> 1;
395 const int l2l = (a2 + a7) >> 1;
396 const int l3l = (a3 + a6) >> 1;
397 const int l4l = (a4 + a5) >> 1;
399 const int l1h = (a1 + a8 + 1) >> 1;
400 const int l2h = (a2 + a7 + 1) >> 1;
401 const int l3h = (a3 + a6 + 1) >> 1;
402 const int l4h = (a4 + a5 + 1) >> 1;
404 const int mi = FFMIN(FFMIN(l1l, l2l), FFMIN(l3l, l4l));
405 const int ma = FFMAX(FFMAX(l1h, l2h), FFMAX(l3h, l4h));
407 return av_clip(c, mi, ma);
410 static int mode22(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
412 const int l1 = (a1 + a8 + 1) >> 1;
413 const int l2 = (a2 + a7 + 1) >> 1;
414 const int l3 = (a3 + a6 + 1) >> 1;
415 const int l4 = (a4 + a5 + 1) >> 1;
417 const int mi = FFMIN(FFMIN(l1, l2), FFMIN(l3, l4));
418 const int ma = FFMAX(FFMAX(l1, l2), FFMAX(l3, l4));
420 return av_clip(c, mi, ma);
423 static int mode23(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
425 REMOVE_GRAIN_SORT_AXIS
427 const int linediff1 = ma1 - mi1;
428 const int linediff2 = ma2 - mi2;
429 const int linediff3 = ma3 - mi3;
430 const int linediff4 = ma4 - mi4;
432 const int u1 = FFMIN(c - ma1, linediff1);
433 const int u2 = FFMIN(c - ma2, linediff2);
434 const int u3 = FFMIN(c - ma3, linediff3);
435 const int u4 = FFMIN(c - ma4, linediff4);
436 const int u = FFMAX(FFMAX(FFMAX(u1, u2), FFMAX(u3, u4)), 0);
438 const int d1 = FFMIN(mi1 - c, linediff1);
439 const int d2 = FFMIN(mi2 - c, linediff2);
440 const int d3 = FFMIN(mi3 - c, linediff3);
441 const int d4 = FFMIN(mi4 - c, linediff4);
442 const int d = FFMAX(FFMAX(FFMAX(d1, d2), FFMAX(d3, d4)), 0);
444 return c - u + d; // This probably will never overflow.
447 static int mode24(int c, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8)
449 REMOVE_GRAIN_SORT_AXIS
451 const int linediff1 = ma1 - mi1;
452 const int linediff2 = ma2 - mi2;
453 const int linediff3 = ma3 - mi3;
454 const int linediff4 = ma4 - mi4;
456 const int tu1 = c - ma1;
457 const int tu2 = c - ma2;
458 const int tu3 = c - ma3;
459 const int tu4 = c - ma4;
461 const int u1 = FFMIN(tu1, linediff1 - tu1);
462 const int u2 = FFMIN(tu2, linediff2 - tu2);
463 const int u3 = FFMIN(tu3, linediff3 - tu3);
464 const int u4 = FFMIN(tu4, linediff4 - tu4);
465 const int u = FFMAX(FFMAX(FFMAX(u1, u2), FFMAX(u3, u4)), 0);
467 const int td1 = mi1 - c;
468 const int td2 = mi2 - c;
469 const int td3 = mi3 - c;
470 const int td4 = mi4 - c;
472 const int d1 = FFMIN(td1, linediff1 - td1);
473 const int d2 = FFMIN(td2, linediff2 - td2);
474 const int d3 = FFMIN(td3, linediff3 - td3);
475 const int d4 = FFMIN(td4, linediff4 - td4);
476 const int d = FFMAX(FFMAX(FFMAX(d1, d2), FFMAX(d3, d4)), 0);
478 return c - u + d; // This probably will never overflow.
481 static int config_input(AVFilterLink *inlink)
483 RemoveGrainContext *s = inlink->dst->priv;
484 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
487 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
489 s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
490 s->planeheight[0] = s->planeheight[3] = inlink->h;
491 s->planewidth[1] = s->planewidth[2] = FF_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
492 s->planewidth[0] = s->planewidth[3] = inlink->w;
494 for (i = 0; i < s->nb_planes; i++) {
495 switch (s->mode[i]) {
496 case 1: s->rg[i] = mode01; break;
497 case 2: s->rg[i] = mode02; break;
498 case 3: s->rg[i] = mode03; break;
499 case 4: s->rg[i] = mode04; break;
500 case 5: s->rg[i] = mode05; break;
501 case 6: s->rg[i] = mode06; break;
502 case 7: s->rg[i] = mode07; break;
503 case 8: s->rg[i] = mode08; break;
504 case 9: s->rg[i] = mode09; break;
505 case 10: s->rg[i] = mode10; break;
506 case 11: s->rg[i] = mode1112; break;
507 case 12: s->rg[i] = mode1112; break;
508 case 13: s->skip_odd = 1;
509 s->rg[i] = mode1314; break;
510 case 14: s->skip_even = 1;
511 s->rg[i] = mode1314; break;
512 case 15: s->skip_odd = 1;
513 s->rg[i] = mode1516; break;
514 case 16: s->skip_even = 1;
515 s->rg[i] = mode1516; break;
516 case 17: s->rg[i] = mode17; break;
517 case 18: s->rg[i] = mode18; break;
518 case 19: s->rg[i] = mode19; break;
519 case 20: s->rg[i] = mode20; break;
520 case 21: s->rg[i] = mode21; break;
521 case 22: s->rg[i] = mode22; break;
522 case 23: s->rg[i] = mode23; break;
523 case 24: s->rg[i] = mode24; break;
530 typedef struct ThreadData {
535 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
537 RemoveGrainContext *s = ctx->priv;
538 ThreadData *td = arg;
539 AVFrame *in = td->in;
540 AVFrame *out = td->out;
541 const int i = td->plane;
542 const int height = s->planeheight[i];
543 const int om = in->linesize[i] - 1;
544 const int o0 = in->linesize[i] ;
545 const int op = in->linesize[i] + 1;
546 int start = (height * jobnr ) / nb_jobs;
547 int end = (height * (jobnr+1)) / nb_jobs;
550 start = FFMAX(1, start);
551 end = FFMIN(height-1, end);
552 for (y = start; y < end; y++) {
553 uint8_t *dst = out->data[i];
554 uint8_t *src = in->data[i];
556 src = in->data[i] + y * in->linesize[i];
557 dst = out->data[i] + y * out->linesize[i];
559 if (s->skip_even && !(y & 1)) {
560 memcpy(dst, src, s->planewidth[i]);
563 if (s->skip_odd && y & 1) {
564 memcpy(dst, src, s->planewidth[i]);
569 for (x = 1; 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], ctx->graph->nb_threads));
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 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,