2 * Copyright (c) 2003 Rich Felker
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 General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 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
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * 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/avassert.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
29 #include "vf_pullup.h"
31 #define F_HAVE_BREAKS 1
32 #define F_HAVE_AFFINITY 2
37 #define OFFSET(x) offsetof(PullupContext, x)
38 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
40 static const AVOption pullup_options[] = {
41 { "jl", "set left junk size", OFFSET(junk_left), AV_OPT_TYPE_INT, {.i64=1}, 0, INT_MAX, FLAGS },
42 { "jr", "set right junk size", OFFSET(junk_right), AV_OPT_TYPE_INT, {.i64=1}, 0, INT_MAX, FLAGS },
43 { "jt", "set top junk size", OFFSET(junk_top), AV_OPT_TYPE_INT, {.i64=4}, 1, INT_MAX, FLAGS },
44 { "jb", "set bottom junk size", OFFSET(junk_bottom), AV_OPT_TYPE_INT, {.i64=4}, 1, INT_MAX, FLAGS },
45 { "sb", "set strict breaks", OFFSET(strict_breaks), AV_OPT_TYPE_INT, {.i64=0},-1, 1, FLAGS },
46 { "mp", "set metric plane", OFFSET(metric_plane), AV_OPT_TYPE_INT, {.i64=0}, 0, 2, FLAGS, "mp" },
47 { "y", "luma", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "mp" },
48 { "u", "chroma blue", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "mp" },
49 { "v", "chroma red", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, FLAGS, "mp" },
53 AVFILTER_DEFINE_CLASS(pullup);
55 static int query_formats(AVFilterContext *ctx)
57 static const enum AVPixelFormat pix_fmts[] = {
58 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
59 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
60 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
61 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
62 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
63 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_GRAY8,
66 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
70 #define ABS(a) (((a) ^ ((a) >> 31)) - ((a) >> 31))
72 static int diff_c(const uint8_t *a, const uint8_t *b, int s)
76 for (i = 0; i < 4; i++) {
77 for (j = 0; j < 8; j++)
78 diff += ABS(a[j] - b[j]);
86 static int comb_c(const uint8_t *a, const uint8_t *b, int s)
90 for (i = 0; i < 4; i++) {
91 for (j = 0; j < 8; j++)
92 comb += ABS((a[j] << 1) - b[j - s] - b[j ]) +
93 ABS((b[j] << 1) - a[j ] - a[j + s]);
101 static int var_c(const uint8_t *a, const uint8_t *b, int s)
105 for (i = 0; i < 3; i++) {
106 for (j = 0; j < 8; j++)
107 var += ABS(a[j] - a[j + s]);
111 return 4 * var; /* match comb scaling */
114 static int alloc_metrics(PullupContext *s, PullupField *f)
116 f->diffs = av_calloc(FFALIGN(s->metric_length, 16), sizeof(*f->diffs));
117 f->combs = av_calloc(FFALIGN(s->metric_length, 16), sizeof(*f->combs));
118 f->vars = av_calloc(FFALIGN(s->metric_length, 16), sizeof(*f->vars));
120 if (!f->diffs || !f->combs || !f->vars) {
124 return AVERROR(ENOMEM);
129 static PullupField *make_field_queue(PullupContext *s, int len)
131 PullupField *head, *f;
133 f = head = av_mallocz(sizeof(*head));
137 if (alloc_metrics(s, f) < 0) {
142 for (; len > 0; len--) {
143 f->next = av_mallocz(sizeof(*f->next));
149 if (alloc_metrics(s, f) < 0)
159 static int config_input(AVFilterLink *inlink)
161 AVFilterContext *ctx = inlink->dst;
162 PullupContext *s = ctx->priv;
163 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
164 int mp = s->metric_plane;
166 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
168 if (mp + 1 > s->nb_planes) {
169 av_log(ctx, AV_LOG_ERROR, "input format does not have such plane\n");
170 return AVERROR(EINVAL);
173 s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
174 s->planeheight[0] = s->planeheight[3] = inlink->h;
175 s->planewidth[1] = s->planewidth[2] = FF_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
176 s->planewidth[0] = s->planewidth[3] = inlink->w;
178 s->metric_w = (s->planewidth[mp] - ((s->junk_left + s->junk_right) << 3)) >> 3;
179 s->metric_h = (s->planeheight[mp] - ((s->junk_top + s->junk_bottom) << 1)) >> 3;
180 s->metric_offset = (s->junk_left << 3) + (s->junk_top << 1) * s->planewidth[mp];
181 s->metric_length = s->metric_w * s->metric_h;
183 av_log(ctx, AV_LOG_DEBUG, "w: %d h: %d\n", s->metric_w, s->metric_h);
184 av_log(ctx, AV_LOG_DEBUG, "offset: %d length: %d\n", s->metric_offset, s->metric_length);
186 s->head = make_field_queue(s, 8);
188 return AVERROR(ENOMEM);
195 ff_pullup_init_x86(s);
199 static int config_output(AVFilterLink *outlink)
201 outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
205 static PullupBuffer *pullup_lock_buffer(PullupBuffer *b, int parity)
210 if ((parity + 1) & 1)
212 if ((parity + 1) & 2)
218 static void pullup_release_buffer(PullupBuffer *b, int parity)
223 if ((parity + 1) & 1)
225 if ((parity + 1) & 2)
229 static int alloc_buffer(PullupContext *s, PullupBuffer *b)
235 for (i = 0; i < s->nb_planes; i++) {
236 b->planes[i] = av_malloc(s->planeheight[i] * s->planewidth[i]);
242 static PullupBuffer *pullup_get_buffer(PullupContext *s, int parity)
246 /* Try first to get the sister buffer for the previous field */
247 if (parity < 2 && s->last && parity != s->last->parity
248 && !s->last->buffer->lock[parity]) {
249 alloc_buffer(s, s->last->buffer);
250 return pullup_lock_buffer(s->last->buffer, parity);
253 /* Prefer a buffer with both fields open */
254 for (i = 0; i < FF_ARRAY_ELEMS(s->buffers); i++) {
255 if (s->buffers[i].lock[0])
257 if (s->buffers[i].lock[1])
259 alloc_buffer(s, &s->buffers[i]);
260 return pullup_lock_buffer(&s->buffers[i], parity);
266 /* Search for any half-free buffer */
267 for (i = 0; i < FF_ARRAY_ELEMS(s->buffers); i++) {
268 if (((parity + 1) & 1) && s->buffers[i].lock[0])
270 if (((parity + 1) & 2) && s->buffers[i].lock[1])
272 alloc_buffer(s, &s->buffers[i]);
273 return pullup_lock_buffer(&s->buffers[i], parity);
279 static int queue_length(PullupField *begin, PullupField *end)
287 for (f = begin; f != end; f = f->next)
293 static int find_first_break(PullupField *f, int max)
297 for (i = 0; i < max; i++) {
298 if (f->breaks & BREAK_RIGHT || f->next->breaks & BREAK_LEFT)
306 static void compute_breaks(PullupContext *s, PullupField *f0)
308 PullupField *f1 = f0->next;
309 PullupField *f2 = f1->next;
310 PullupField *f3 = f2->next;
311 int i, l, max_l = 0, max_r = 0;
313 if (f0->flags & F_HAVE_BREAKS)
316 f0->flags |= F_HAVE_BREAKS;
318 /* Special case when fields are 100% identical */
319 if (f0->buffer == f2->buffer && f1->buffer != f3->buffer) {
320 f2->breaks |= BREAK_RIGHT;
324 if (f0->buffer != f2->buffer && f1->buffer == f3->buffer) {
325 f1->breaks |= BREAK_LEFT;
329 for (i = 0; i < s->metric_length; i++) {
330 l = f2->diffs[i] - f3->diffs[i];
338 /* Don't get tripped up when differences are mostly quant error */
339 if (max_l + max_r < 128)
341 if (max_l > 4 * max_r)
342 f1->breaks |= BREAK_LEFT;
343 if (max_r > 4 * max_l)
344 f2->breaks |= BREAK_RIGHT;
347 static void compute_affinity(PullupContext *s, PullupField *f)
349 int i, max_l = 0, max_r = 0, l;
351 if (f->flags & F_HAVE_AFFINITY)
354 f->flags |= F_HAVE_AFFINITY;
356 if (f->buffer == f->next->next->buffer) {
358 f->next->affinity = 0;
359 f->next->next->affinity = -1;
360 f->next->flags |= F_HAVE_AFFINITY;
361 f->next->next->flags |= F_HAVE_AFFINITY;
365 for (i = 0; i < s->metric_length; i++) {
367 int lv = f->prev->vars[i];
368 int rv = f->next->vars[i];
369 int lc = f->combs[i] - (v + lv) + ABS(v - lv);
370 int rc = f->next->combs[i] - (v + rv) + ABS(v - rv);
382 if (max_l + max_r < 64)
385 if (max_r > 6 * max_l)
387 else if (max_l > 6 * max_r)
391 static int decide_frame_length(PullupContext *s)
393 PullupField *f0 = s->first;
394 PullupField *f1 = f0->next;
395 PullupField *f2 = f1->next;
399 if (queue_length(s->first, s->last) < 4)
403 n = queue_length(f, s->last);
404 for (i = 0; i < n - 1; i++) {
406 compute_breaks(s, f);
408 compute_affinity(s, f);
413 if (f0->affinity == -1)
416 l = find_first_break(f0, 3);
418 if (l == 1 && s->strict_breaks < 0)
423 return 1 + (s->strict_breaks < 1 && f0->affinity == 1 && f1->affinity == -1);
425 /* FIXME: strictly speaking, f0->prev is no longer valid... :) */
427 && (f0->prev->breaks & BREAK_RIGHT) && (f2->breaks & BREAK_LEFT)
428 && (f0->affinity != 1 || f1->affinity != -1) )
430 return 1 + (f1->affinity != 1);
432 return 2 + (f2->affinity != 1);
434 /* 9 possibilities covered before switch */
435 if (f1->affinity == 1)
436 return 1; /* covers 6 */
437 else if (f1->affinity == -1)
438 return 2; /* covers 6 */
439 else if (f2->affinity == -1) { /* covers 2 */
440 return (f0->affinity == 1) ? 3 : 1;
442 return 2; /* the remaining 6 */
447 static PullupFrame *pullup_get_frame(PullupContext *s)
449 PullupFrame *fr = &s->frame;
450 int i, n = decide_frame_length(s);
451 int aff = s->first->next->affinity;
453 av_assert1(n < FF_ARRAY_ELEMS(fr->ifields));
459 fr->parity = s->first->parity;
462 for (i = 0; i < n; i++) {
463 /* We cheat and steal the buffer without release+relock */
464 fr->ifields[i] = s->first->buffer;
465 s->first->buffer = 0;
466 s->first = s->first->next;
470 fr->ofields[fr->parity ] = fr->ifields[0];
471 fr->ofields[fr->parity ^ 1] = 0;
473 fr->ofields[fr->parity ] = fr->ifields[0];
474 fr->ofields[fr->parity ^ 1] = fr->ifields[1];
477 aff = (fr->ifields[0] == fr->ifields[1]) ? -1 : 1;
478 fr->ofields[fr->parity ] = fr->ifields[1 + aff];
479 fr->ofields[fr->parity ^ 1] = fr->ifields[1 ];
482 pullup_lock_buffer(fr->ofields[0], 0);
483 pullup_lock_buffer(fr->ofields[1], 1);
485 if (fr->ofields[0] == fr->ofields[1]) {
486 fr->buffer = fr->ofields[0];
487 pullup_lock_buffer(fr->buffer, 2);
494 static void pullup_release_frame(PullupFrame *f)
498 for (i = 0; i < f->length; i++)
499 pullup_release_buffer(f->ifields[i], f->parity ^ (i & 1));
501 pullup_release_buffer(f->ofields[0], 0);
502 pullup_release_buffer(f->ofields[1], 1);
505 pullup_release_buffer(f->buffer, 2);
509 static void compute_metric(PullupContext *s, int *dest,
510 PullupField *fa, int pa, PullupField *fb, int pb,
511 int (*func)(const uint8_t *, const uint8_t *, int))
513 int mp = s->metric_plane;
515 int ystep = s->planewidth[mp] << 3;
516 int stride = s->planewidth[mp] << 1; /* field stride */
517 int w = s->metric_w * xstep;
521 if (!fa->buffer || !fb->buffer)
524 /* Shortcut for duplicate fields (e.g. from RFF flag) */
525 if (fa->buffer == fb->buffer && pa == pb) {
526 memset(dest, 0, s->metric_length * sizeof(*dest));
530 a = fa->buffer->planes[mp] + pa * s->planewidth[mp] + s->metric_offset;
531 b = fb->buffer->planes[mp] + pb * s->planewidth[mp] + s->metric_offset;
533 for (y = 0; y < s->metric_h; y++) {
534 for (x = 0; x < w; x += xstep)
535 *dest++ = func(a + x, b + x, stride);
536 a += ystep; b += ystep;
540 static int check_field_queue(PullupContext *s)
544 if (s->head->next == s->first) {
545 PullupField *f = av_mallocz(sizeof(*f));
548 return AVERROR(ENOMEM);
550 if ((ret = alloc_metrics(s, f)) < 0) {
564 static void pullup_submit_field(PullupContext *s, PullupBuffer *b, int parity)
568 /* Grow the circular list if needed */
569 if (check_field_queue(s) < 0)
572 /* Cannot have two fields of same parity in a row; drop the new one */
573 if (s->last && s->last->parity == parity)
578 f->buffer = pullup_lock_buffer(b, parity);
583 compute_metric(s, f->diffs, f, parity, f->prev->prev, parity, s->diff);
584 compute_metric(s, f->combs, parity ? f->prev : f, 0, parity ? f : f->prev, 1, s->comb);
585 compute_metric(s, f->vars, f, parity, f, -1, s->var);
588 /* Advance the circular list */
593 s->head = s->head->next;
596 static void copy_field(PullupContext *s,
597 PullupBuffer *dst, PullupBuffer *src, int parity)
602 for (i = 0; i < s->nb_planes; i++) {
603 ss = src->planes[i] + parity * s->planewidth[i];
604 dd = dst->planes[i] + parity * s->planewidth[i];
606 av_image_copy_plane(dd, s->planewidth[i] << 1,
607 ss, s->planewidth[i] << 1,
608 s->planewidth[i], s->planeheight[i] >> 1);
612 static void pullup_pack_frame(PullupContext *s, PullupFrame *fr)
620 return; /* FIXME: deal with this */
622 for (i = 0; i < 2; i++) {
623 if (fr->ofields[i]->lock[i^1])
626 fr->buffer = fr->ofields[i];
627 pullup_lock_buffer(fr->buffer, 2);
628 copy_field(s, fr->buffer, fr->ofields[i^1], i^1);
632 fr->buffer = pullup_get_buffer(s, 2);
634 copy_field(s, fr->buffer, fr->ofields[0], 0);
635 copy_field(s, fr->buffer, fr->ofields[1], 1);
638 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
640 AVFilterContext *ctx = inlink->dst;
641 AVFilterLink *outlink = ctx->outputs[0];
642 PullupContext *s = ctx->priv;
648 b = pullup_get_buffer(s, 2);
650 av_log(ctx, AV_LOG_WARNING, "Could not get buffer!\n");
651 f = pullup_get_frame(s);
652 pullup_release_frame(f);
656 av_image_copy(b->planes, s->planewidth,
657 (const uint8_t**)in->data, in->linesize,
658 inlink->format, inlink->w, inlink->h);
660 p = in->interlaced_frame ? !in->top_field_first : 0;
661 pullup_submit_field(s, b, p );
662 pullup_submit_field(s, b, p^1);
665 pullup_submit_field(s, b, p);
667 pullup_release_buffer(b, 2);
669 f = pullup_get_frame(s);
674 pullup_release_frame(f);
675 f = pullup_get_frame(s);
679 pullup_release_frame(f);
680 if (!in->repeat_pict)
682 f = pullup_get_frame(s);
686 pullup_release_frame(f);
692 /* If the frame isn't already exportable... */
694 pullup_pack_frame(s, f);
696 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
698 ret = AVERROR(ENOMEM);
701 av_frame_copy_props(out, in);
703 av_image_copy(out->data, out->linesize,
704 (const uint8_t**)f->buffer->planes, s->planewidth,
705 inlink->format, inlink->w, inlink->h);
707 ret = ff_filter_frame(outlink, out);
708 pullup_release_frame(f);
714 static av_cold void uninit(AVFilterContext *ctx)
716 PullupContext *s = ctx->priv;
733 for (i = 0; i < FF_ARRAY_ELEMS(s->buffers); i++) {
734 av_freep(&s->buffers[i].planes[0]);
735 av_freep(&s->buffers[i].planes[1]);
736 av_freep(&s->buffers[i].planes[2]);
740 static const AVFilterPad pullup_inputs[] = {
743 .type = AVMEDIA_TYPE_VIDEO,
744 .filter_frame = filter_frame,
745 .config_props = config_input,
750 static const AVFilterPad pullup_outputs[] = {
753 .type = AVMEDIA_TYPE_VIDEO,
754 .config_props = config_output,
759 AVFilter ff_vf_pullup = {
761 .description = NULL_IF_CONFIG_SMALL("Pullup from field sequence to frames."),
762 .priv_size = sizeof(PullupContext),
763 .priv_class = &pullup_class,
765 .query_formats = query_formats,
766 .inputs = pullup_inputs,
767 .outputs = pullup_outputs,