55bf782af8daa511c042d13857ff4387635ec091
[ffmpeg.git] / libavfilter / vf_interlace.c
1 /*
2  * Copyright (c) 2003 Michael Zucchi <notzed@ximian.com>
3  * Copyright (c) 2010 Baptiste Coudurier
4  * Copyright (c) 2011 Stefano Sabatini
5  * Copyright (c) 2013 Vittorio Giovara <vittorio.giovara@gmail.com>
6  * Copyright (c) 2017 Thomas Mundt <tmundt75@gmail.com>
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  */
24
25 /**
26  * @file
27  * progressive to interlaced content filter, inspired by heavy debugging of tinterlace filter
28  */
29
30 #include "libavutil/common.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/avassert.h"
34
35 #include "formats.h"
36 #include "avfilter.h"
37 #include "interlace.h"
38 #include "internal.h"
39 #include "video.h"
40
41 #define OFFSET(x) offsetof(InterlaceContext, x)
42 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
43 static const AVOption interlace_options[] = {
44     { "scan", "scanning mode", OFFSET(scan),
45         AV_OPT_TYPE_INT,   {.i64 = MODE_TFF }, 0, 1, .flags = FLAGS, .unit = "scan" },
46     { "tff", "top field first", 0,
47         AV_OPT_TYPE_CONST, {.i64 = MODE_TFF }, INT_MIN, INT_MAX, .flags = FLAGS, .unit = "scan" },
48     { "bff", "bottom field first", 0,
49         AV_OPT_TYPE_CONST, {.i64 = MODE_BFF }, INT_MIN, INT_MAX, .flags = FLAGS, .unit = "scan" },
50     { "lowpass", "set vertical low-pass filter", OFFSET(lowpass),
51         AV_OPT_TYPE_INT,   {.i64 = VLPF_LIN }, 0, 2, .flags = FLAGS, .unit = "lowpass" },
52     { "off",     "disable vertical low-pass filter", 0,
53         AV_OPT_TYPE_CONST, {.i64 = VLPF_OFF }, INT_MIN, INT_MAX, .flags = FLAGS, .unit = "lowpass" },
54     { "linear",  "linear vertical low-pass filter",  0,
55         AV_OPT_TYPE_CONST, {.i64 = VLPF_LIN }, INT_MIN, INT_MAX, .flags = FLAGS, .unit = "lowpass" },
56     { "complex", "complex vertical low-pass filter", 0,
57         AV_OPT_TYPE_CONST, {.i64 = VLPF_CMP }, INT_MIN, INT_MAX, .flags = FLAGS, .unit = "lowpass" },
58     { NULL }
59 };
60
61 AVFILTER_DEFINE_CLASS(interlace);
62
63 static void lowpass_line_c(uint8_t *dstp, ptrdiff_t linesize,
64                            const uint8_t *srcp,
65                            ptrdiff_t mref, ptrdiff_t pref)
66 {
67     const uint8_t *srcp_above = srcp + mref;
68     const uint8_t *srcp_below = srcp + pref;
69     int i;
70     for (i = 0; i < linesize; i++) {
71         // this calculation is an integer representation of
72         // '0.5 * current + 0.25 * above + 0.25 * below'
73         // '1 +' is for rounding.
74         dstp[i] = (1 + srcp[i] + srcp[i] + srcp_above[i] + srcp_below[i]) >> 2;
75     }
76 }
77
78 static void lowpass_line_complex_c(uint8_t *dstp, ptrdiff_t linesize,
79                                    const uint8_t *srcp,
80                                    ptrdiff_t mref, ptrdiff_t pref)
81 {
82     const uint8_t *srcp_above = srcp + mref;
83     const uint8_t *srcp_below = srcp + pref;
84     const uint8_t *srcp_above2 = srcp + mref * 2;
85     const uint8_t *srcp_below2 = srcp + pref * 2;
86     int i, srcp_x, srcp_ab;
87     for (i = 0; i < linesize; i++) {
88         // this calculation is an integer representation of
89         // '0.75 * current + 0.25 * above + 0.25 * below - 0.125 * above2 - 0.125 * below2'
90         // '4 +' is for rounding.
91         srcp_x = srcp[i] << 1;
92         srcp_ab = srcp_above[i] + srcp_below[i];
93         dstp[i] = av_clip_uint8((4 + ((srcp[i] + srcp_x + srcp_ab) << 1)
94                                 - srcp_above2[i] - srcp_below2[i]) >> 3);
95         // Prevent over-sharpening:
96         // dst must not exceed src when the average of above and below
97         // is less than src. And the other way around.
98         if (srcp_ab > srcp_x) {
99             if (dstp[i] < srcp[i])
100                 dstp[i] = srcp[i];
101         } else if (dstp[i] > srcp[i])
102             dstp[i] = srcp[i];
103     }
104 }
105
106 static const enum AVPixelFormat formats_supported[] = {
107     AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV444P,
108     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUVA420P,
109     AV_PIX_FMT_GRAY8,    AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
110     AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
111 };
112
113 static int query_formats(AVFilterContext *ctx)
114 {
115     AVFilterFormats *fmts_list = ff_make_format_list(formats_supported);
116     if (!fmts_list)
117         return AVERROR(ENOMEM);
118     return ff_set_common_formats(ctx, fmts_list);
119 }
120
121 static av_cold void uninit(AVFilterContext *ctx)
122 {
123     InterlaceContext *s = ctx->priv;
124
125     av_frame_free(&s->cur);
126     av_frame_free(&s->next);
127 }
128
129 static int config_out_props(AVFilterLink *outlink)
130 {
131     AVFilterContext *ctx = outlink->src;
132     AVFilterLink *inlink = outlink->src->inputs[0];
133     InterlaceContext *s = ctx->priv;
134
135     if (inlink->h < 2) {
136         av_log(ctx, AV_LOG_ERROR, "input video height is too small\n");
137         return AVERROR_INVALIDDATA;
138     }
139
140     if (!s->lowpass)
141         av_log(ctx, AV_LOG_WARNING, "Lowpass filter is disabled, "
142                "the resulting video will be aliased rather than interlaced.\n");
143
144     // same input size
145     outlink->w = inlink->w;
146     outlink->h = inlink->h;
147     outlink->time_base = inlink->time_base;
148     outlink->frame_rate = inlink->frame_rate;
149     // half framerate
150     outlink->time_base.num *= 2;
151     outlink->frame_rate.den *= 2;
152
153
154     if (s->lowpass) {
155         if (s->lowpass == VLPF_LIN)
156             s->lowpass_line = lowpass_line_c;
157         else if (s->lowpass == VLPF_CMP)
158             s->lowpass_line = lowpass_line_complex_c;
159         if (ARCH_X86)
160             ff_interlace_init_x86(s);
161     }
162
163     av_log(ctx, AV_LOG_VERBOSE, "%s interlacing %s lowpass filter\n",
164            s->scan == MODE_TFF ? "tff" : "bff", (s->lowpass) ? "with" : "without");
165
166     return 0;
167 }
168
169 static void copy_picture_field(InterlaceContext *s,
170                                AVFrame *src_frame, AVFrame *dst_frame,
171                                AVFilterLink *inlink, enum FieldType field_type,
172                                int lowpass)
173 {
174     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
175     int hsub = desc->log2_chroma_w;
176     int vsub = desc->log2_chroma_h;
177     int plane, j;
178
179     for (plane = 0; plane < desc->nb_components; plane++) {
180         int cols  = (plane == 1 || plane == 2) ? -(-inlink->w) >> hsub : inlink->w;
181         int lines = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(inlink->h, vsub) : inlink->h;
182         uint8_t *dstp = dst_frame->data[plane];
183         const uint8_t *srcp = src_frame->data[plane];
184         int srcp_linesize = src_frame->linesize[plane] * 2;
185         int dstp_linesize = dst_frame->linesize[plane] * 2;
186
187         av_assert0(cols >= 0 || lines >= 0);
188
189         lines = (lines + (field_type == FIELD_UPPER)) / 2;
190         if (field_type == FIELD_LOWER) {
191             srcp += src_frame->linesize[plane];
192             dstp += dst_frame->linesize[plane];
193         }
194         if (lowpass) {
195             int x = 0;
196             if (lowpass == VLPF_CMP)
197                 x = 1;
198             for (j = lines; j > 0; j--) {
199                 ptrdiff_t pref = src_frame->linesize[plane];
200                 ptrdiff_t mref = -pref;
201                 if (j >= (lines - x))
202                     mref = 0;
203                 else if (j <= (1 + x))
204                     pref = 0;
205                 s->lowpass_line(dstp, cols, srcp, mref, pref);
206                 dstp += dstp_linesize;
207                 srcp += srcp_linesize;
208             }
209         } else {
210             av_image_copy_plane(dstp, dstp_linesize, srcp, srcp_linesize, cols, lines);
211         }
212     }
213 }
214
215 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
216 {
217     AVFilterContext *ctx = inlink->dst;
218     AVFilterLink *outlink = ctx->outputs[0];
219     InterlaceContext *s = ctx->priv;
220     AVFrame *out;
221     int tff, ret;
222
223     av_frame_free(&s->cur);
224     s->cur  = s->next;
225     s->next = buf;
226
227     /* we need at least two frames */
228     if (!s->cur || !s->next)
229         return 0;
230
231     if (s->cur->interlaced_frame) {
232         av_log(ctx, AV_LOG_WARNING,
233                "video is already interlaced, adjusting framerate only\n");
234         out = av_frame_clone(s->cur);
235         if (!out)
236             return AVERROR(ENOMEM);
237         out->pts /= 2;  // adjust pts to new framerate
238         ret = ff_filter_frame(outlink, out);
239         return ret;
240     }
241
242     tff = (s->scan == MODE_TFF);
243     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
244     if (!out)
245         return AVERROR(ENOMEM);
246
247     av_frame_copy_props(out, s->cur);
248     out->interlaced_frame = 1;
249     out->top_field_first  = tff;
250     out->pts             /= 2;  // adjust pts to new framerate
251
252     /* copy upper/lower field from cur */
253     copy_picture_field(s, s->cur, out, inlink, tff ? FIELD_UPPER : FIELD_LOWER, s->lowpass);
254     av_frame_free(&s->cur);
255
256     /* copy lower/upper field from next */
257     copy_picture_field(s, s->next, out, inlink, tff ? FIELD_LOWER : FIELD_UPPER, s->lowpass);
258     av_frame_free(&s->next);
259
260     ret = ff_filter_frame(outlink, out);
261
262     return ret;
263 }
264
265 static const AVFilterPad inputs[] = {
266     {
267         .name         = "default",
268         .type         = AVMEDIA_TYPE_VIDEO,
269         .filter_frame = filter_frame,
270     },
271     { NULL }
272 };
273
274 static const AVFilterPad outputs[] = {
275     {
276         .name         = "default",
277         .type         = AVMEDIA_TYPE_VIDEO,
278         .config_props = config_out_props,
279     },
280     { NULL }
281 };
282
283 AVFilter ff_vf_interlace = {
284     .name          = "interlace",
285     .description   = NULL_IF_CONFIG_SMALL("Convert progressive video into interlaced."),
286     .uninit        = uninit,
287     .priv_class    = &interlace_class,
288     .priv_size     = sizeof(InterlaceContext),
289     .query_formats = query_formats,
290     .inputs        = inputs,
291     .outputs       = outputs,
292 };