2 * Copyright (c) 2015 Niklas Haas
3 * Copyright (c) 2015 Paul B Mahol
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
30 typedef struct DebandContext {
48 int (*deband)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
51 #define OFFSET(x) offsetof(DebandContext, x)
52 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
54 static const AVOption deband_options[] = {
55 { "1thr", "set 1st plane threshold", OFFSET(threshold[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0.00003, 0.5, FLAGS },
56 { "2thr", "set 2nd plane threshold", OFFSET(threshold[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0.00003, 0.5, FLAGS },
57 { "3thr", "set 3rd plane threshold", OFFSET(threshold[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0.00003, 0.5, FLAGS },
58 { "4thr", "set 4th plane threshold", OFFSET(threshold[3]), AV_OPT_TYPE_FLOAT, {.dbl=0.02}, 0.00003, 0.5, FLAGS },
59 { "range", "set range", OFFSET(range), AV_OPT_TYPE_INT, {.i64=16}, INT_MIN, INT_MAX, FLAGS },
60 { "r", "set range", OFFSET(range), AV_OPT_TYPE_INT, {.i64=16}, INT_MIN, INT_MAX, FLAGS },
61 { "direction", "set direction", OFFSET(direction), AV_OPT_TYPE_FLOAT, {.dbl=2*M_PI},-2*M_PI, 2*M_PI, FLAGS },
62 { "d", "set direction", OFFSET(direction), AV_OPT_TYPE_FLOAT, {.dbl=2*M_PI},-2*M_PI, 2*M_PI, FLAGS },
63 { "blur", "set blur", OFFSET(blur), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
64 { "b", "set blur", OFFSET(blur), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
65 { "coupling", "set plane coupling", OFFSET(coupling), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
66 { "c", "set plane coupling", OFFSET(coupling), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
70 AVFILTER_DEFINE_CLASS(deband);
72 static int query_formats(AVFilterContext *ctx)
74 DebandContext *s = ctx->priv;
76 static const enum AVPixelFormat pix_fmts[] = {
77 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10,
78 AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
79 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
80 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
81 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
82 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ440P,
83 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
84 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
85 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
86 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
87 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12,
88 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
89 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
90 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
91 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14,
92 AV_PIX_FMT_GBRP16, AV_PIX_FMT_GBRAP16,
93 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
94 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
98 static const enum AVPixelFormat cpix_fmts[] = {
99 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
100 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P9,
101 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10,
102 AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV444P14,
103 AV_PIX_FMT_YUV444P16, AV_PIX_FMT_YUVA444P16,
104 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
105 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
106 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14,
107 AV_PIX_FMT_GBRP16, AV_PIX_FMT_GBRAP16,
111 AVFilterFormats *fmts_list = ff_make_format_list(s->coupling ? cpix_fmts : pix_fmts);
113 return AVERROR(ENOMEM);
115 return ff_set_common_formats(ctx, fmts_list);
118 static float frand(int x, int y)
120 const float r = sinf(x * 12.9898f + y * 78.233f) * 43758.545f;
122 return r - floorf(r);
125 static int inline get_avg(int ref0, int ref1, int ref2, int ref3)
127 return (ref0 + ref1 + ref2 + ref3) / 4;
130 typedef struct ThreadData {
134 static int deband_8_c(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
136 DebandContext *s = ctx->priv;
137 ThreadData *td = arg;
138 AVFrame *in = td->in;
139 AVFrame *out = td->out;
142 for (p = 0; p < s->nb_components; p++) {
143 const uint8_t *src_ptr = (const uint8_t *)in->data[p];
144 uint8_t *dst_ptr = (uint8_t *)out->data[p];
145 const int dst_linesize = out->linesize[p];
146 const int src_linesize = in->linesize[p];
147 const int thr = s->thr[p];
148 const int start = (s->planeheight[p] * jobnr ) / nb_jobs;
149 const int end = (s->planeheight[p] * (jobnr+1)) / nb_jobs;
150 const int w = s->planewidth[p] - 1;
151 const int h = s->planeheight[p] - 1;
153 for (y = start; y < end; y++) {
154 const int pos = y * s->planewidth[0];
156 for (x = 0; x < s->planewidth[p]; x++) {
157 const int x_pos = s->x_pos[pos + x];
158 const int y_pos = s->y_pos[pos + x];
159 const int ref0 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
160 const int ref1 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
161 const int ref2 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
162 const int ref3 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
163 const int src0 = src_ptr[y * src_linesize + x];
166 const int avg = get_avg(ref0, ref1, ref2, ref3);
167 const int diff = FFABS(src0 - avg);
169 dst_ptr[y * dst_linesize + x] = diff < thr ? avg : src0;
171 dst_ptr[y * dst_linesize + x] = (FFABS(src0 - ref0) < thr) &&
172 (FFABS(src0 - ref1) < thr) &&
173 (FFABS(src0 - ref2) < thr) &&
174 (FFABS(src0 - ref3) < thr) ? get_avg(ref0, ref1, ref2, ref3) : src0;
183 static int deband_8_coupling_c(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
185 DebandContext *s = ctx->priv;
186 ThreadData *td = arg;
187 AVFrame *in = td->in;
188 AVFrame *out = td->out;
189 const int start = (s->planeheight[0] * jobnr ) / nb_jobs;
190 const int end = (s->planeheight[0] * (jobnr+1)) / nb_jobs;
193 for (y = start; y < end; y++) {
194 const int pos = y * s->planewidth[0];
196 for (x = 0; x < s->planewidth[0]; x++) {
197 const int x_pos = s->x_pos[pos + x];
198 const int y_pos = s->y_pos[pos + x];
199 int avg[4], cmp[4] = { 0 }, src[4];
201 for (p = 0; p < s->nb_components; p++) {
202 const uint8_t *src_ptr = (const uint8_t *)in->data[p];
203 const int src_linesize = in->linesize[p];
204 const int thr = s->thr[p];
205 const int w = s->planewidth[p] - 1;
206 const int h = s->planeheight[p] - 1;
207 const int ref0 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
208 const int ref1 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
209 const int ref2 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
210 const int ref3 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
211 const int src0 = src_ptr[y * src_linesize + x];
214 avg[p] = get_avg(ref0, ref1, ref2, ref3);
217 cmp[p] = FFABS(src0 - avg[p]) < thr;
219 cmp[p] = (FFABS(src0 - ref0) < thr) &&
220 (FFABS(src0 - ref1) < thr) &&
221 (FFABS(src0 - ref2) < thr) &&
222 (FFABS(src0 - ref3) < thr);
226 for (p = 0; p < s->nb_components; p++)
229 if (p == s->nb_components) {
230 for (p = 0; p < s->nb_components; p++) {
231 const int dst_linesize = out->linesize[p];
233 out->data[p][y * dst_linesize + x] = avg[p];
236 for (p = 0; p < s->nb_components; p++) {
237 const int dst_linesize = out->linesize[p];
239 out->data[p][y * dst_linesize + x] = src[p];
248 static int deband_16_coupling_c(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
250 DebandContext *s = ctx->priv;
251 ThreadData *td = arg;
252 AVFrame *in = td->in;
253 AVFrame *out = td->out;
254 const int start = (s->planeheight[0] * jobnr ) / nb_jobs;
255 const int end = (s->planeheight[0] * (jobnr+1)) / nb_jobs;
258 for (y = start; y < end; y++) {
259 const int pos = y * s->planewidth[0];
261 for (x = 0; x < s->planewidth[0]; x++) {
262 const int x_pos = s->x_pos[pos + x];
263 const int y_pos = s->y_pos[pos + x];
264 int avg[4], cmp[4] = { 0 }, src[4];
266 for (p = 0; p < s->nb_components; p++) {
267 const uint16_t *src_ptr = (const uint16_t *)in->data[p];
268 const int src_linesize = in->linesize[p] / 2;
269 const int thr = s->thr[p];
270 const int w = s->planewidth[p] - 1;
271 const int h = s->planeheight[p] - 1;
272 const int ref0 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
273 const int ref1 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
274 const int ref2 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
275 const int ref3 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
276 const int src0 = src_ptr[y * src_linesize + x];
279 avg[p] = get_avg(ref0, ref1, ref2, ref3);
282 cmp[p] = FFABS(src0 - avg[p]) < thr;
284 cmp[p] = (FFABS(src0 - ref0) < thr) &&
285 (FFABS(src0 - ref1) < thr) &&
286 (FFABS(src0 - ref2) < thr) &&
287 (FFABS(src0 - ref3) < thr);
291 for (z = 0; z < s->nb_components; z++)
294 if (z == s->nb_components) {
295 for (p = 0; p < s->nb_components; p++) {
296 const int dst_linesize = out->linesize[p] / 2;
297 uint16_t *dst = (uint16_t *)out->data[p] + y * dst_linesize + x;
302 for (p = 0; p < s->nb_components; p++) {
303 const int dst_linesize = out->linesize[p] / 2;
304 uint16_t *dst = (uint16_t *)out->data[p] + y * dst_linesize + x;
315 static int deband_16_c(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
317 DebandContext *s = ctx->priv;
318 ThreadData *td = arg;
319 AVFrame *in = td->in;
320 AVFrame *out = td->out;
323 for (p = 0; p < s->nb_components; p++) {
324 const uint16_t *src_ptr = (const uint16_t *)in->data[p];
325 uint16_t *dst_ptr = (uint16_t *)out->data[p];
326 const int dst_linesize = out->linesize[p] / 2;
327 const int src_linesize = in->linesize[p] / 2;
328 const int thr = s->thr[p];
329 const int start = (s->planeheight[p] * jobnr ) / nb_jobs;
330 const int end = (s->planeheight[p] * (jobnr+1)) / nb_jobs;
331 const int w = s->planewidth[p] - 1;
332 const int h = s->planeheight[p] - 1;
334 for (y = start; y < end; y++) {
335 const int pos = y * s->planewidth[0];
337 for (x = 0; x < s->planewidth[p]; x++) {
338 const int x_pos = s->x_pos[pos + x];
339 const int y_pos = s->y_pos[pos + x];
340 const int ref0 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
341 const int ref1 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + x_pos, 0, w)];
342 const int ref2 = src_ptr[av_clip(y + -y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
343 const int ref3 = src_ptr[av_clip(y + y_pos, 0, h) * src_linesize + av_clip(x + -x_pos, 0, w)];
344 const int src0 = src_ptr[y * src_linesize + x];
347 const int avg = get_avg(ref0, ref1, ref2, ref3);
348 const int diff = FFABS(src0 - avg);
350 dst_ptr[y * dst_linesize + x] = diff < thr ? avg : src0;
352 dst_ptr[y * dst_linesize + x] = (FFABS(src0 - ref0) < thr) &&
353 (FFABS(src0 - ref1) < thr) &&
354 (FFABS(src0 - ref2) < thr) &&
355 (FFABS(src0 - ref3) < thr) ? get_avg(ref0, ref1, ref2, ref3) : src0;
364 static int config_input(AVFilterLink *inlink)
366 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
367 AVFilterContext *ctx = inlink->dst;
368 DebandContext *s = ctx->priv;
369 const float direction = s->direction;
370 const int range = s->range;
373 s->nb_components = desc->nb_components;
375 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
376 s->planeheight[0] = s->planeheight[3] = inlink->h;
377 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
378 s->planewidth[0] = s->planewidth[3] = inlink->w;
379 s->shift[0] = desc->log2_chroma_w;
380 s->shift[1] = desc->log2_chroma_h;
383 s->deband = desc->comp[0].depth > 8 ? deband_16_coupling_c : deband_8_coupling_c;
385 s->deband = desc->comp[0].depth > 8 ? deband_16_c : deband_8_c;
387 s->thr[0] = ((1 << desc->comp[0].depth) - 1) * s->threshold[0];
388 s->thr[1] = ((1 << desc->comp[1].depth) - 1) * s->threshold[1];
389 s->thr[2] = ((1 << desc->comp[2].depth) - 1) * s->threshold[2];
390 s->thr[3] = ((1 << desc->comp[3].depth) - 1) * s->threshold[3];
393 s->x_pos = av_malloc(s->planewidth[0] * s->planeheight[0] * sizeof(*s->x_pos));
395 s->y_pos = av_malloc(s->planewidth[0] * s->planeheight[0] * sizeof(*s->y_pos));
396 if (!s->x_pos || !s->y_pos)
397 return AVERROR(ENOMEM);
399 for (y = 0; y < s->planeheight[0]; y++) {
400 for (x = 0; x < s->planewidth[0]; x++) {
401 const float r = frand(x, y);
402 const float dir = direction < 0 ? -direction : r * direction;
403 const int dist = range < 0 ? -range : r * range;
405 s->x_pos[y * s->planewidth[0] + x] = cosf(dir) * dist;
406 s->y_pos[y * s->planewidth[0] + x] = sinf(dir) * dist;
413 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
415 AVFilterContext *ctx = inlink->dst;
416 AVFilterLink *outlink = ctx->outputs[0];
417 DebandContext *s = ctx->priv;
421 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
424 return AVERROR(ENOMEM);
426 av_frame_copy_props(out, in);
428 td.in = in; td.out = out;
429 ctx->internal->execute(ctx, s->deband, &td, NULL, FFMIN3(s->planeheight[1],
431 ff_filter_get_nb_threads(ctx)));
434 return ff_filter_frame(outlink, out);
437 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
438 char *res, int res_len, int flags)
440 int ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
445 return config_input(ctx->inputs[0]);
448 static av_cold void uninit(AVFilterContext *ctx)
450 DebandContext *s = ctx->priv;
456 static const AVFilterPad avfilter_vf_deband_inputs[] = {
459 .type = AVMEDIA_TYPE_VIDEO,
460 .config_props = config_input,
461 .filter_frame = filter_frame,
466 static const AVFilterPad avfilter_vf_deband_outputs[] = {
469 .type = AVMEDIA_TYPE_VIDEO,
474 const AVFilter ff_vf_deband = {
476 .description = NULL_IF_CONFIG_SMALL("Debands video."),
477 .priv_size = sizeof(DebandContext),
478 .priv_class = &deband_class,
480 .query_formats = query_formats,
481 .inputs = avfilter_vf_deband_inputs,
482 .outputs = avfilter_vf_deband_outputs,
483 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
484 .process_command = process_command,