2 * BobWeaver Deinterlacing Filter
3 * Copyright (C) 2016 Thomas Mundt <loudmax@yahoo.de>
5 * Based on YADIF (Yet Another Deinterlacing Filter)
6 * Copyright (C) 2006-2011 Michael Niedermayer <michaelni@gmx.at>
7 * 2010 James Darnley <james.darnley@gmail.com>
9 * With use of Weston 3 Field Deinterlacing Filter algorithm
10 * Copyright (C) 2012 British Broadcasting Corporation, All Rights Reserved
11 * Author of de-interlace algorithm: Jim Easterbrook for BBC R&D
12 * Based on the process described by Martin Weston for BBC R&D
14 * This file is part of FFmpeg.
16 * FFmpeg is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU Lesser General Public
18 * License as published by the Free Software Foundation; either
19 * version 2.1 of the License, or (at your option) any later version.
21 * FFmpeg is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 * Lesser General Public License for more details.
26 * You should have received a copy of the GNU Lesser General Public
27 * License along with FFmpeg; if not, write to the Free Software
28 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31 #include "libavutil/avassert.h"
32 #include "libavutil/common.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/pixdesc.h"
35 #include "libavutil/imgutils.h"
43 * Filter coefficients coef_lf and coef_hf taken from BBC PH-2071 (Weston 3 Field Deinterlacer).
44 * Used when there is spatial and temporal interpolation.
45 * Filter coefficients coef_sp are used when there is spatial interpolation only.
46 * Adjusted for matching visual sharpness impression of spatial and temporal interpolation.
48 static const uint16_t coef_lf[2] = { 4309, 213 };
49 static const uint16_t coef_hf[3] = { 5570, 3801, 1016 };
50 static const uint16_t coef_sp[2] = { 5077, 981 };
52 typedef struct ThreadData {
60 #define FILTER_INTRA() \
61 for (x = 0; x < w; x++) { \
62 interpol = (coef_sp[0] * (cur[mrefs] + cur[prefs]) - coef_sp[1] * (cur[mrefs3] + cur[prefs3])) >> 13; \
63 dst[0] = av_clip(interpol, 0, clip_max); \
70 for (x = 0; x < w; x++) { \
72 int d = (prev2[0] + next2[0]) >> 1; \
74 int temporal_diff0 = FFABS(prev2[0] - next2[0]); \
75 int temporal_diff1 =(FFABS(prev[mrefs] - c) + FFABS(prev[prefs] - e)) >> 1; \
76 int temporal_diff2 =(FFABS(next[mrefs] - c) + FFABS(next[prefs] - e)) >> 1; \
77 int diff = FFMAX3(temporal_diff0 >> 1, temporal_diff1, temporal_diff2); \
83 #define SPAT_CHECK() \
84 int b = ((prev2[mrefs2] + next2[mrefs2]) >> 1) - c; \
85 int f = ((prev2[prefs2] + next2[prefs2]) >> 1) - e; \
88 int max = FFMAX3(de, dc, FFMIN(b, f)); \
89 int min = FFMIN3(de, dc, FFMAX(b, f)); \
90 diff = FFMAX3(diff, min, -max);
92 #define FILTER_LINE() \
94 if (FFABS(c - e) > temporal_diff0) { \
95 interpol = (((coef_hf[0] * (prev2[0] + next2[0]) \
96 - coef_hf[1] * (prev2[mrefs2] + next2[mrefs2] + prev2[prefs2] + next2[prefs2]) \
97 + coef_hf[2] * (prev2[mrefs4] + next2[mrefs4] + prev2[prefs4] + next2[prefs4])) >> 2) \
98 + coef_lf[0] * (c + e) - coef_lf[1] * (cur[mrefs3] + cur[prefs3])) >> 13; \
100 interpol = (coef_sp[0] * (c + e) - coef_sp[1] * (cur[mrefs3] + cur[prefs3])) >> 13; \
103 #define FILTER_EDGE() \
107 interpol = (c + e) >> 1;
110 if (interpol > d + diff) \
111 interpol = d + diff; \
112 else if (interpol < d - diff) \
113 interpol = d - diff; \
115 dst[0] = av_clip(interpol, 0, clip_max); \
126 static void filter_intra(void *dst1, void *cur1, int w, int prefs, int mrefs,
127 int prefs3, int mrefs3, int parity, int clip_max)
136 static void filter_line_c(void *dst1, void *prev1, void *cur1, void *next1,
137 int w, int prefs, int mrefs, int prefs2, int mrefs2,
138 int prefs3, int mrefs3, int prefs4, int mrefs4,
139 int parity, int clip_max)
142 uint8_t *prev = prev1;
144 uint8_t *next = next1;
145 uint8_t *prev2 = parity ? prev : cur ;
146 uint8_t *next2 = parity ? cur : next;
154 static void filter_edge(void *dst1, void *prev1, void *cur1, void *next1,
155 int w, int prefs, int mrefs, int prefs2, int mrefs2,
156 int parity, int clip_max, int spat)
159 uint8_t *prev = prev1;
161 uint8_t *next = next1;
162 uint8_t *prev2 = parity ? prev : cur ;
163 uint8_t *next2 = parity ? cur : next;
171 static void filter_intra_16bit(void *dst1, void *cur1, int w, int prefs, int mrefs,
172 int prefs3, int mrefs3, int parity, int clip_max)
174 uint16_t *dst = dst1;
175 uint16_t *cur = cur1;
181 static void filter_line_c_16bit(void *dst1, void *prev1, void *cur1, void *next1,
182 int w, int prefs, int mrefs, int prefs2, int mrefs2,
183 int prefs3, int mrefs3, int prefs4, int mrefs4,
184 int parity, int clip_max)
186 uint16_t *dst = dst1;
187 uint16_t *prev = prev1;
188 uint16_t *cur = cur1;
189 uint16_t *next = next1;
190 uint16_t *prev2 = parity ? prev : cur ;
191 uint16_t *next2 = parity ? cur : next;
199 static void filter_edge_16bit(void *dst1, void *prev1, void *cur1, void *next1,
200 int w, int prefs, int mrefs, int prefs2, int mrefs2,
201 int parity, int clip_max, int spat)
203 uint16_t *dst = dst1;
204 uint16_t *prev = prev1;
205 uint16_t *cur = cur1;
206 uint16_t *next = next1;
207 uint16_t *prev2 = parity ? prev : cur ;
208 uint16_t *next2 = parity ? cur : next;
216 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
218 BWDIFContext *s = ctx->priv;
219 ThreadData *td = arg;
220 int linesize = s->cur->linesize[td->plane];
221 int clip_max = (1 << (s->csp->comp[td->plane].depth)) - 1;
222 int df = (s->csp->comp[td->plane].depth + 7) / 8;
223 int refs = linesize / df;
224 int slice_start = (td->h * jobnr ) / nb_jobs;
225 int slice_end = (td->h * (jobnr+1)) / nb_jobs;
228 for (y = slice_start; y < slice_end; y++) {
229 if ((y ^ td->parity) & 1) {
230 uint8_t *prev = &s->prev->data[td->plane][y * linesize];
231 uint8_t *cur = &s->cur ->data[td->plane][y * linesize];
232 uint8_t *next = &s->next->data[td->plane][y * linesize];
233 uint8_t *dst = &td->frame->data[td->plane][y * td->frame->linesize[td->plane]];
234 if (!s->inter_field) {
235 s->filter_intra(dst, cur, td->w, (y + df) < td->h ? refs : -refs,
236 y > (df - 1) ? -refs : refs,
237 (y + 3*df) < td->h ? 3 * refs : -refs,
238 y > (3*df - 1) ? -3 * refs : refs,
239 td->parity ^ td->tff, clip_max);
240 } else if ((y < 4) || ((y + 5) > td->h)) {
241 s->filter_edge(dst, prev, cur, next, td->w,
242 (y + df) < td->h ? refs : -refs,
243 y > (df - 1) ? -refs : refs,
244 refs << 1, -(refs << 1),
245 td->parity ^ td->tff, clip_max,
246 (y < 2) || ((y + 3) > td->h) ? 0 : 1);
248 s->filter_line(dst, prev, cur, next, td->w,
249 refs, -refs, refs << 1, -(refs << 1),
250 3 * refs, -3 * refs, refs << 2, -(refs << 2),
251 td->parity ^ td->tff, clip_max);
254 memcpy(&td->frame->data[td->plane][y * td->frame->linesize[td->plane]],
255 &s->cur->data[td->plane][y * linesize], td->w * df);
261 static void filter(AVFilterContext *ctx, AVFrame *dstpic,
264 BWDIFContext *bwdif = ctx->priv;
265 ThreadData td = { .frame = dstpic, .parity = parity, .tff = tff };
268 for (i = 0; i < bwdif->csp->nb_components; i++) {
269 int w = dstpic->width;
270 int h = dstpic->height;
272 if (i == 1 || i == 2) {
273 w = AV_CEIL_RSHIFT(w, bwdif->csp->log2_chroma_w);
274 h = AV_CEIL_RSHIFT(h, bwdif->csp->log2_chroma_h);
281 ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(h, ff_filter_get_nb_threads(ctx)));
283 if (!bwdif->inter_field) {
284 bwdif->inter_field = 1;
290 static int return_frame(AVFilterContext *ctx, int is_second)
292 BWDIFContext *bwdif = ctx->priv;
293 AVFilterLink *link = ctx->outputs[0];
296 if (bwdif->parity == -1) {
297 tff = bwdif->cur->interlaced_frame ?
298 bwdif->cur->top_field_first : 1;
300 tff = bwdif->parity ^ 1;
304 bwdif->out = ff_get_video_buffer(link, link->w, link->h);
306 return AVERROR(ENOMEM);
308 av_frame_copy_props(bwdif->out, bwdif->cur);
309 bwdif->out->interlaced_frame = 0;
310 if (bwdif->inter_field < 0)
311 bwdif->inter_field = 0;
314 filter(ctx, bwdif->out, tff ^ !is_second, tff);
317 int64_t cur_pts = bwdif->cur->pts;
318 int64_t next_pts = bwdif->next->pts;
320 if (next_pts != AV_NOPTS_VALUE && cur_pts != AV_NOPTS_VALUE) {
321 bwdif->out->pts = cur_pts + next_pts;
323 bwdif->out->pts = AV_NOPTS_VALUE;
326 ret = ff_filter_frame(ctx->outputs[0], bwdif->out);
328 bwdif->frame_pending = (bwdif->mode&1) && !is_second;
332 static int checkstride(BWDIFContext *bwdif, const AVFrame *a, const AVFrame *b)
335 for (i = 0; i < bwdif->csp->nb_components; i++)
336 if (a->linesize[i] != b->linesize[i])
341 static void fixstride(AVFilterLink *link, AVFrame *f)
343 AVFrame *dst = ff_default_get_video_buffer(link, f->width, f->height);
346 av_frame_copy_props(dst, f);
347 av_image_copy(dst->data, dst->linesize,
348 (const uint8_t **)f->data, f->linesize,
349 dst->format, dst->width, dst->height);
351 av_frame_move_ref(f, dst);
355 static int filter_frame(AVFilterLink *link, AVFrame *frame)
357 AVFilterContext *ctx = link->dst;
358 BWDIFContext *bwdif = ctx->priv;
362 if (bwdif->frame_pending)
363 return_frame(ctx, 1);
366 av_frame_free(&bwdif->prev);
367 bwdif->prev = bwdif->cur;
368 bwdif->cur = bwdif->next;
372 bwdif->cur = av_frame_clone(bwdif->next);
374 return AVERROR(ENOMEM);
375 bwdif->inter_field = 0;
378 if (checkstride(bwdif, bwdif->next, bwdif->cur)) {
379 av_log(ctx, AV_LOG_VERBOSE, "Reallocating frame due to differing stride\n");
380 fixstride(link, bwdif->next);
382 if (checkstride(bwdif, bwdif->next, bwdif->cur))
383 fixstride(link, bwdif->cur);
384 if (bwdif->prev && checkstride(bwdif, bwdif->next, bwdif->prev))
385 fixstride(link, bwdif->prev);
386 if (checkstride(bwdif, bwdif->next, bwdif->cur) || (bwdif->prev && checkstride(bwdif, bwdif->next, bwdif->prev))) {
387 av_log(ctx, AV_LOG_ERROR, "Failed to reallocate frame\n");
394 if ((bwdif->deint && !bwdif->cur->interlaced_frame) ||
396 (bwdif->deint && !bwdif->prev->interlaced_frame && bwdif->prev->repeat_pict) ||
397 (bwdif->deint && !bwdif->next->interlaced_frame && bwdif->next->repeat_pict)
399 bwdif->out = av_frame_clone(bwdif->cur);
401 return AVERROR(ENOMEM);
403 av_frame_free(&bwdif->prev);
404 if (bwdif->out->pts != AV_NOPTS_VALUE)
405 bwdif->out->pts *= 2;
406 return ff_filter_frame(ctx->outputs[0], bwdif->out);
409 bwdif->out = ff_get_video_buffer(ctx->outputs[0], link->w, link->h);
411 return AVERROR(ENOMEM);
413 av_frame_copy_props(bwdif->out, bwdif->cur);
414 bwdif->out->interlaced_frame = 0;
416 if (bwdif->out->pts != AV_NOPTS_VALUE)
417 bwdif->out->pts *= 2;
419 return return_frame(ctx, 0);
422 static int request_frame(AVFilterLink *link)
424 AVFilterContext *ctx = link->src;
425 BWDIFContext *bwdif = ctx->priv;
428 if (bwdif->frame_pending) {
429 return_frame(ctx, 1);
436 ret = ff_request_frame(link->src->inputs[0]);
438 if (ret == AVERROR_EOF && bwdif->cur) {
439 AVFrame *next = av_frame_clone(bwdif->next);
442 return AVERROR(ENOMEM);
444 bwdif->inter_field = -1;
445 next->pts = bwdif->next->pts * 2 - bwdif->cur->pts;
447 filter_frame(link->src->inputs[0], next);
449 } else if (ret < 0) {
456 static av_cold void uninit(AVFilterContext *ctx)
458 BWDIFContext *bwdif = ctx->priv;
460 av_frame_free(&bwdif->prev);
461 av_frame_free(&bwdif->cur );
462 av_frame_free(&bwdif->next);
465 static int query_formats(AVFilterContext *ctx)
467 static const enum AVPixelFormat pix_fmts[] = {
468 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV420P,
469 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
470 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P,
471 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
472 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
473 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
474 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12,
475 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
476 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
477 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
478 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
479 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
480 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
481 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
482 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
483 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP16,
484 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16,
488 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
490 return AVERROR(ENOMEM);
492 return ff_set_common_formats(ctx, fmts_list);
495 static int config_props(AVFilterLink *link)
497 AVFilterContext *ctx = link->src;
498 BWDIFContext *s = link->src->priv;
500 link->time_base.num = link->src->inputs[0]->time_base.num;
501 link->time_base.den = link->src->inputs[0]->time_base.den * 2;
502 link->w = link->src->inputs[0]->w;
503 link->h = link->src->inputs[0]->h;
506 link->frame_rate = av_mul_q(link->src->inputs[0]->frame_rate, (AVRational){2,1});
508 if (link->w < 3 || link->h < 3) {
509 av_log(ctx, AV_LOG_ERROR, "Video of less than 3 columns or lines is not supported\n");
510 return AVERROR(EINVAL);
513 s->csp = av_pix_fmt_desc_get(link->format);
514 if (s->csp->comp[0].depth > 8) {
515 s->filter_intra = filter_intra_16bit;
516 s->filter_line = filter_line_c_16bit;
517 s->filter_edge = filter_edge_16bit;
519 s->filter_intra = filter_intra;
520 s->filter_line = filter_line_c;
521 s->filter_edge = filter_edge;
525 ff_bwdif_init_x86(s);
531 #define OFFSET(x) offsetof(BWDIFContext, x)
532 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
534 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, INT_MIN, INT_MAX, FLAGS, unit }
536 static const AVOption bwdif_options[] = {
537 { "mode", "specify the interlacing mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=BWDIF_MODE_SEND_FIELD}, 0, 1, FLAGS, "mode"},
538 CONST("send_frame", "send one frame for each frame", BWDIF_MODE_SEND_FRAME, "mode"),
539 CONST("send_field", "send one frame for each field", BWDIF_MODE_SEND_FIELD, "mode"),
541 { "parity", "specify the assumed picture field parity", OFFSET(parity), AV_OPT_TYPE_INT, {.i64=BWDIF_PARITY_AUTO}, -1, 1, FLAGS, "parity" },
542 CONST("tff", "assume top field first", BWDIF_PARITY_TFF, "parity"),
543 CONST("bff", "assume bottom field first", BWDIF_PARITY_BFF, "parity"),
544 CONST("auto", "auto detect parity", BWDIF_PARITY_AUTO, "parity"),
546 { "deint", "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=BWDIF_DEINT_ALL}, 0, 1, FLAGS, "deint" },
547 CONST("all", "deinterlace all frames", BWDIF_DEINT_ALL, "deint"),
548 CONST("interlaced", "only deinterlace frames marked as interlaced", BWDIF_DEINT_INTERLACED, "deint"),
553 AVFILTER_DEFINE_CLASS(bwdif);
555 static const AVFilterPad avfilter_vf_bwdif_inputs[] = {
558 .type = AVMEDIA_TYPE_VIDEO,
559 .filter_frame = filter_frame,
564 static const AVFilterPad avfilter_vf_bwdif_outputs[] = {
567 .type = AVMEDIA_TYPE_VIDEO,
568 .request_frame = request_frame,
569 .config_props = config_props,
574 AVFilter ff_vf_bwdif = {
576 .description = NULL_IF_CONFIG_SMALL("Deinterlace the input image."),
577 .priv_size = sizeof(BWDIFContext),
578 .priv_class = &bwdif_class,
580 .query_formats = query_formats,
581 .inputs = avfilter_vf_bwdif_inputs,
582 .outputs = avfilter_vf_bwdif_outputs,
583 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,