2 * Copyright (c) 2021 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
21 #include "libavutil/common.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
29 typedef struct ESTDIFContext {
32 int mode; ///< 0 is frame, 1 is field
33 int parity; ///< frame field parity
34 int deint; ///< which frames to deinterlace
35 int rslope; ///< best edge slope search radius
36 int redge; ///< best edge match search radius
37 int ecost; ///< edge cost for edge matching
38 int mcost; ///< middle cost for edge matching
39 int dcost; ///< distance cost for edge matching
40 int interp; ///< type of interpolation
41 int linesize[4]; ///< bytes of pixel data per line for each plane
42 int planewidth[4]; ///< width of each plane
43 int planeheight[4]; ///< height of each plane
44 int field; ///< which field are we on, 0 or 1
52 void (*interpolate)(struct ESTDIFContext *s, uint8_t *dst,
53 const uint8_t *prev_line, const uint8_t *next_line,
54 const uint8_t *prev2_line, const uint8_t *next2_line,
55 const uint8_t *prev3_line, const uint8_t *next3_line,
56 int x, int width, int rslope, int redge,
59 unsigned (*mid_8[3])(const uint8_t *const prev,
60 const uint8_t *const next,
61 const uint8_t *const prev2,
62 const uint8_t *const next2,
63 const uint8_t *const prev3,
64 const uint8_t *const next3,
65 int end, int x, int k, int depth);
67 unsigned (*mid_16[3])(const uint16_t *const prev,
68 const uint16_t *const next,
69 const uint16_t *const prev2,
70 const uint16_t *const next2,
71 const uint16_t *const prev3,
72 const uint16_t *const next3,
73 int end, int x, int k, int depth);
77 #define S (MAX_R * 2 + 1)
79 #define OFFSET(x) offsetof(ESTDIFContext, x)
80 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
81 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, 0, 0, FLAGS, unit }
83 static const AVOption estdif_options[] = {
84 { "mode", "specify the mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS, "mode" },
85 CONST("frame", "send one frame for each frame", 0, "mode"),
86 CONST("field", "send one frame for each field", 1, "mode"),
87 { "parity", "specify the assumed picture field parity", OFFSET(parity), AV_OPT_TYPE_INT, {.i64=-1}, -1, 1, FLAGS, "parity" },
88 CONST("tff", "assume top field first", 0, "parity"),
89 CONST("bff", "assume bottom field first", 1, "parity"),
90 CONST("auto", "auto detect parity", -1, "parity"),
91 { "deint", "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "deint" },
92 CONST("all", "deinterlace all frames", 0, "deint"),
93 CONST("interlaced", "only deinterlace frames marked as interlaced", 1, "deint"),
94 { "rslope", "specify the search radius for edge slope tracing", OFFSET(rslope), AV_OPT_TYPE_INT, {.i64=1}, 1, MAX_R, FLAGS },
95 { "redge", "specify the search radius for best edge matching", OFFSET(redge), AV_OPT_TYPE_INT, {.i64=2}, 0, MAX_R, FLAGS },
96 { "ecost", "specify the edge cost for edge matching", OFFSET(ecost), AV_OPT_TYPE_INT, {.i64=2}, 0, 50, FLAGS },
97 { "mcost", "specify the middle cost for edge matching", OFFSET(mcost), AV_OPT_TYPE_INT, {.i64=1}, 0, 50, FLAGS },
98 { "dcost", "specify the distance cost for edge matching", OFFSET(dcost), AV_OPT_TYPE_INT, {.i64=1}, 0, 50, FLAGS },
99 { "interp", "specify the type of interpolation", OFFSET(interp), AV_OPT_TYPE_INT, {.i64=1}, 0, 2, FLAGS, "interp" },
100 CONST("2p", "two-point interpolation", 0, "interp"),
101 CONST("4p", "four-point interpolation", 1, "interp"),
102 CONST("6p", "six-point interpolation", 2, "interp"),
106 AVFILTER_DEFINE_CLASS(estdif);
108 static const enum AVPixelFormat pix_fmts[] = {
109 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
110 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
111 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
112 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
113 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
115 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
116 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
118 AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
119 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
120 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
121 AV_PIX_FMT_YUV440P10,
122 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12,
123 AV_PIX_FMT_YUV440P12,
124 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
125 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
126 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
127 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA444P12, AV_PIX_FMT_YUVA444P16,
128 AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA422P16,
129 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA420P16,
130 AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
134 static int config_output(AVFilterLink *outlink)
136 AVFilterContext *ctx = outlink->src;
137 AVFilterLink *inlink = ctx->inputs[0];
138 ESTDIFContext *s = ctx->priv;
140 outlink->time_base = av_mul_q(inlink->time_base, (AVRational){1, 2});
142 outlink->frame_rate = av_mul_q(inlink->frame_rate, (AVRational){2, 1});
147 typedef struct ThreadData {
151 #define MIDL(type, ss) \
152 static unsigned midl_##ss(const type *const prev, \
153 const type *const next, \
154 int end, int x, int k) \
156 return (prev[av_clip(x + k, 0, end)] + \
157 next[av_clip(x - k, 0, end)] + 1) >> 1; \
163 #define MID2(type, ss) \
164 static unsigned mid2_##ss(const type *const prev, \
165 const type *const next, \
166 const type *const prev2, \
167 const type *const next2, \
168 const type *const prev3, \
169 const type *const next3, \
170 int end, int x, int k, int depth) \
172 return (prev[av_clip(x + k, 0, end)] + \
173 next[av_clip(x - k, 0, end)] + 1) >> 1; \
179 #define MID4(type, ss) \
180 static unsigned mid4_##ss(const type *const prev, \
181 const type *const next, \
182 const type *const prev2, \
183 const type *const next2, \
184 const type *const prev3, \
185 const type *const next3, \
186 int end, int x, int k, int depth) \
188 return av_clip_uintp2_c(( \
189 9 * (prev[av_clip(x + k, 0, end)] + \
190 next[av_clip(x - k, 0, end)]) - \
191 1 * (prev2[av_clip(x + k*3, 0, end)] + \
192 next2[av_clip(x - k*3, 0, end)]) + 8) >> 4, \
199 #define MID6(type, ss) \
200 static unsigned mid6_##ss(const type *const prev, \
201 const type *const next, \
202 const type *const prev2, \
203 const type *const next2, \
204 const type *const prev3, \
205 const type *const next3, \
206 int end, int x, int k, int depth) \
208 return av_clip_uintp2_c(( \
209 20 * (prev[av_clip(x + k, 0, end)] + \
210 next[av_clip(x - k, 0, end)]) - \
211 5 * (prev2[av_clip(x + k*3, 0, end)] + \
212 next2[av_clip(x - k*3, 0, end)]) + \
213 1 * (prev3[av_clip(x + k*5, 0, end)] + \
214 next3[av_clip(x - k*5, 0, end)]) + 16) >> 5, \
221 #define DIFF(type, ss) \
222 static unsigned diff_##ss(const type *const prev, \
223 const type *const next, \
226 return FFABS(prev[x] - next[y]); \
232 #define COST(type, ss) \
233 static unsigned cost_##ss(const type *const prev, \
234 const type *const next, \
235 int end, int x, int k) \
237 const int m = midl_##ss(prev, next, end, x, k); \
238 const int p = prev[x]; \
239 const int n = next[x]; \
241 return FFABS(p - m) + FFABS(n - m); \
247 #define INTERPOLATE(type, atype, amax, ss) \
248 static void interpolate_##ss(ESTDIFContext *s, uint8_t *ddst, \
249 const uint8_t *const pprev_line, \
250 const uint8_t *const nnext_line, \
251 const uint8_t *const pprev2_line, \
252 const uint8_t *const nnext2_line, \
253 const uint8_t *const pprev3_line, \
254 const uint8_t *const nnext3_line, \
255 int x, int width, int rslope, \
256 int redge, int depth, \
259 type *dst = (type *)ddst; \
260 const type *const prev_line = (const type *const)pprev_line; \
261 const type *const prev2_line = (const type *const)pprev2_line; \
262 const type *const prev3_line = (const type *const)pprev3_line; \
263 const type *const next_line = (const type *const)nnext_line; \
264 const type *const next2_line = (const type *const)nnext2_line; \
265 const type *const next3_line = (const type *const)nnext3_line; \
266 const int interp = s->interp; \
267 const int ecost = s->ecost; \
268 const int dcost = s->dcost; \
269 const int mcost = s->mcost; \
270 atype sd[S], sD[S], di = 0; \
271 const int end = width - 1; \
273 int id = 0, iD = 0; \
276 for (int i = -rslope; i <= rslope && abs(k) > rslope; i++) { \
279 for (int j = -redge; j <= redge; j++) { \
280 const int xx = av_clip(x + i + j, 0, end); \
281 const int yy = av_clip(x - i + j, 0, end); \
282 sum += diff_##ss(prev_line, next_line, xx, yy); \
283 sum += diff_##ss(prev2_line, prev_line, xx, yy); \
284 sum += diff_##ss(next_line, next2_line, xx, yy); \
287 sD[i + rslope] = ecost * sum; \
288 sD[i + rslope] += mcost * cost_##ss(prev_line, next_line, end, x, i);\
289 sD[i + rslope] += dcost * abs(i); \
291 if (dmin > sD[i + rslope]) { \
292 dmin = sD[i + rslope]; \
298 for (int i = -rslope; i <= rslope; i++) { \
301 for (int j = -redge; j <= redge; j++) { \
302 const int xx = av_clip(x + k + i + j, 0, end); \
303 const int yy = av_clip(x - k - i + j, 0, end); \
304 sum += diff_##ss(prev_line, next_line, xx, yy); \
305 sum += diff_##ss(prev2_line, prev_line, xx, yy); \
306 sum += diff_##ss(next_line, next2_line, xx, yy); \
309 sd[i + rslope] = ecost * sum; \
310 sd[i + rslope] += mcost * cost_##ss(prev_line, next_line, end, x, k+i);\
311 sd[i + rslope] += dcost * abs(k + i); \
313 if (dmin > sd[i + rslope]) { \
314 dmin = sd[i + rslope]; \
320 k = di ? iD : k + id; \
322 dst[x] = s->mid_##ss[interp](prev_line, next_line, \
323 prev2_line, next2_line, \
324 prev3_line, next3_line, \
330 INTERPOLATE(uint8_t, unsigned, UINT_MAX, 8)
331 INTERPOLATE(uint16_t, uint64_t, UINT64_MAX, 16)
333 static int deinterlace_slice(AVFilterContext *ctx, void *arg,
334 int jobnr, int nb_jobs)
336 ESTDIFContext *s = ctx->priv;
337 ThreadData *td = arg;
338 AVFrame *out = td->out;
339 AVFrame *in = td->in;
340 const int rslope = s->rslope;
341 const int redge = s->redge;
342 const int depth = s->depth;
343 const int interlaced = !!(in->flags & AV_FRAME_FLAG_INTERLACED);
344 const int tff = (s->field == (s->parity == -1 ? interlaced ? !!(in->flags & AV_FRAME_FLAG_TOP_FIELD_FIRST) : 1 :
347 for (int plane = 0; plane < s->nb_planes; plane++) {
348 const uint8_t *src_data = in->data[plane];
349 uint8_t *dst_data = out->data[plane];
350 const int linesize = s->linesize[plane];
351 const int width = s->planewidth[plane];
352 const int height = s->planeheight[plane];
353 const int src_linesize = in->linesize[plane];
354 const int dst_linesize = out->linesize[plane];
355 const int start = (height * jobnr) / nb_jobs;
356 const int end = (height * (jobnr+1)) / nb_jobs;
357 const uint8_t *prev_line, *prev2_line, *next_line, *next2_line, *in_line;
358 const uint8_t *prev3_line, *next3_line;
362 y_out = start + (tff ^ (start & 1));
364 in_line = src_data + (y_out * src_linesize);
365 out_line = dst_data + (y_out * dst_linesize);
367 while (y_out < end) {
368 memcpy(out_line, in_line, linesize);
370 in_line += src_linesize * 2;
371 out_line += dst_linesize * 2;
374 y_out = start + ((!tff) ^ (start & 1));
375 out_line = dst_data + (y_out * dst_linesize);
377 for (int y = y_out; y < end; y += 2) {
378 int y_prev3_in = y - 5;
379 int y_next3_in = y + 5;
380 int y_prev2_in = y - 3;
381 int y_next2_in = y + 3;
382 int y_prev_in = y - 1;
383 int y_next_in = y + 1;
386 while (y_prev3_in < 0)
389 while (y_next3_in >= height)
392 while (y_prev2_in < 0)
395 while (y_next2_in >= height)
398 while (y_prev_in < 0)
401 while (y_next_in >= height)
404 prev3_line = src_data + (y_prev3_in * src_linesize);
405 next3_line = src_data + (y_next3_in * src_linesize);
407 prev2_line = src_data + (y_prev2_in * src_linesize);
408 next2_line = src_data + (y_next2_in * src_linesize);
410 prev_line = src_data + (y_prev_in * src_linesize);
411 next_line = src_data + (y_next_in * src_linesize);
415 for (int x = 0; x < width; x++) {
416 s->interpolate(s, out_line,
417 prev_line, next_line,
418 prev2_line, next2_line,
419 prev3_line, next3_line,
420 x, width, rslope, redge, depth, &k);
423 out_line += 2 * dst_linesize;
430 static int filter(AVFilterContext *ctx, AVFrame *in, int64_t pts, int64_t duration)
432 ESTDIFContext *s = ctx->priv;
433 AVFilterLink *outlink = ctx->outputs[0];
437 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
439 return AVERROR(ENOMEM);
440 av_frame_copy_props(out, in);
441 #if FF_API_INTERLACED_FRAME
442 FF_DISABLE_DEPRECATION_WARNINGS
443 out->interlaced_frame = 0;
444 FF_ENABLE_DEPRECATION_WARNINGS
446 out->flags &= ~AV_FRAME_FLAG_INTERLACED;
448 out->duration = duration;
450 td.out = out; td.in = in;
451 ff_filter_execute(ctx, deinterlace_slice, &td, NULL,
452 FFMIN(s->planeheight[1] / 2, s->nb_threads));
455 s->field = !s->field;
457 return ff_filter_frame(outlink, out);
460 static int config_input(AVFilterLink *inlink)
462 AVFilterContext *ctx = inlink->dst;
463 ESTDIFContext *s = ctx->priv;
464 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
467 if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
470 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
471 s->planeheight[0] = s->planeheight[3] = inlink->h;
472 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
473 s->planewidth[0] = s->planewidth[3] = inlink->w;
476 av_log(ctx, AV_LOG_ERROR, "Video of less than 3 lines is not supported\n");
477 return AVERROR(EINVAL);
480 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
481 s->nb_threads = ff_filter_get_nb_threads(ctx);
482 s->depth = desc->comp[0].depth;
483 s->interpolate = s->depth <= 8 ? interpolate_8 : interpolate_16;
484 s->mid_8[0] = mid2_8;
485 s->mid_8[1] = mid4_8;
486 s->mid_8[2] = mid6_8;
487 s->mid_16[0] = mid2_16;
488 s->mid_16[1] = mid4_16;
489 s->mid_16[2] = mid6_16;
490 s->max = (1 << (s->depth)) - 1;
494 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
496 AVFilterContext *ctx = inlink->dst;
497 ESTDIFContext *s = ctx->priv;
505 if ((s->deint && !(s->prev->flags & AV_FRAME_FLAG_INTERLACED)) || ctx->is_disabled) {
507 s->prev->duration *= 2;
508 ret = ff_filter_frame(ctx->outputs[0], s->prev);
513 ret = filter(ctx, s->prev, s->prev->pts * 2,
514 s->prev->duration * (s->mode ? 1 : 2));
515 if (ret < 0 || s->mode == 0) {
516 av_frame_free(&s->prev);
521 ret = filter(ctx, s->prev, s->prev->pts + in->pts, in->duration);
522 av_frame_free(&s->prev);
527 static int request_frame(AVFilterLink *link)
529 AVFilterContext *ctx = link->src;
530 ESTDIFContext *s = ctx->priv;
536 ret = ff_request_frame(ctx->inputs[0]);
538 if (ret == AVERROR_EOF && s->prev) {
539 AVFrame *next = av_frame_clone(s->prev);
542 return AVERROR(ENOMEM);
544 next->pts = s->prev->pts + av_rescale_q(1, av_inv_q(ctx->outputs[0]->frame_rate),
545 ctx->outputs[0]->time_base);
547 ret = filter_frame(ctx->inputs[0], next);
548 } else if (ret < 0) {
555 static av_cold void uninit(AVFilterContext *ctx)
557 ESTDIFContext *s = ctx->priv;
559 av_frame_free(&s->prev);
562 static const AVFilterPad estdif_inputs[] = {
565 .type = AVMEDIA_TYPE_VIDEO,
566 .filter_frame = filter_frame,
567 .config_props = config_input,
571 static const AVFilterPad estdif_outputs[] = {
574 .type = AVMEDIA_TYPE_VIDEO,
575 .config_props = config_output,
576 .request_frame = request_frame,
580 const AVFilter ff_vf_estdif = {
582 .description = NULL_IF_CONFIG_SMALL("Apply Edge Slope Tracing deinterlace."),
583 .priv_size = sizeof(ESTDIFContext),
584 .priv_class = &estdif_class,
586 FILTER_INPUTS(estdif_inputs),
587 FILTER_OUTPUTS(estdif_outputs),
588 FILTER_PIXFMTS_ARRAY(pix_fmts),
589 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
590 .process_command = ff_filter_process_command,