f934a06b6994dbe700dc2ab945d24970abc9bd8b
[ffmpeg.git] / libavfilter / vf_tinterlace.c
1 /*
2  * Copyright (c) 2017 Thomas Mundt <tmundt75@gmail.com>
3  * Copyright (c) 2011 Stefano Sabatini
4  * Copyright (c) 2010 Baptiste Coudurier
5  * Copyright (c) 2003 Michael Zucchi <notzed@ximian.com>
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with FFmpeg if not, write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23
24 /**
25  * @file
26  * temporal field interlace filter, ported from MPlayer/libmpcodecs
27  */
28
29 #include "libavutil/opt.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/avassert.h"
32 #include "avfilter.h"
33 #include "internal.h"
34 #include "tinterlace.h"
35
36 #define OFFSET(x) offsetof(TInterlaceContext, x)
37 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
38
39 static const AVOption tinterlace_options[] = {
40     {"mode",              "select interlace mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=MODE_MERGE}, 0, MODE_NB-1, FLAGS, "mode"},
41     {"merge",             "merge fields",                                 0, AV_OPT_TYPE_CONST, {.i64=MODE_MERGE},             INT_MIN, INT_MAX, FLAGS, "mode"},
42     {"drop_even",         "drop even fields",                             0, AV_OPT_TYPE_CONST, {.i64=MODE_DROP_EVEN},         INT_MIN, INT_MAX, FLAGS, "mode"},
43     {"drop_odd",          "drop odd fields",                              0, AV_OPT_TYPE_CONST, {.i64=MODE_DROP_ODD},          INT_MIN, INT_MAX, FLAGS, "mode"},
44     {"pad",               "pad alternate lines with black",               0, AV_OPT_TYPE_CONST, {.i64=MODE_PAD},               INT_MIN, INT_MAX, FLAGS, "mode"},
45     {"interleave_top",    "interleave top and bottom fields",             0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE_TOP},    INT_MIN, INT_MAX, FLAGS, "mode"},
46     {"interleave_bottom", "interleave bottom and top fields",             0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE_BOTTOM}, INT_MIN, INT_MAX, FLAGS, "mode"},
47     {"interlacex2",       "interlace fields from two consecutive frames", 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLACEX2},       INT_MIN, INT_MAX, FLAGS, "mode"},
48     {"mergex2",           "merge fields keeping same frame rate",         0, AV_OPT_TYPE_CONST, {.i64=MODE_MERGEX2},           INT_MIN, INT_MAX, FLAGS, "mode"},
49
50     {"flags",             "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, INT_MAX, 0, "flags" },
51     {"low_pass_filter",   "enable vertical low-pass filter",              0, AV_OPT_TYPE_CONST, {.i64 = TINTERLACE_FLAG_VLPF}, INT_MIN, INT_MAX, FLAGS, "flags" },
52     {"vlpf",              "enable vertical low-pass filter",              0, AV_OPT_TYPE_CONST, {.i64 = TINTERLACE_FLAG_VLPF}, INT_MIN, INT_MAX, FLAGS, "flags" },
53     {"complex_filter",    "enable complex vertical low-pass filter",      0, AV_OPT_TYPE_CONST, {.i64 = TINTERLACE_FLAG_CVLPF},INT_MIN, INT_MAX, FLAGS, "flags" },
54     {"cvlpf",             "enable complex vertical low-pass filter",      0, AV_OPT_TYPE_CONST, {.i64 = TINTERLACE_FLAG_CVLPF},INT_MIN, INT_MAX, FLAGS, "flags" },
55     {"exact_tb",          "force a timebase which can represent timestamps exactly", 0, AV_OPT_TYPE_CONST, {.i64 = TINTERLACE_FLAG_EXACT_TB}, INT_MIN, INT_MAX, FLAGS, "flags" },
56
57     {NULL}
58 };
59
60 AVFILTER_DEFINE_CLASS(tinterlace);
61
62 #define FULL_SCALE_YUVJ_FORMATS \
63     AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P
64
65 static const enum AVPixelFormat full_scale_yuvj_pix_fmts[] = {
66     FULL_SCALE_YUVJ_FORMATS, AV_PIX_FMT_NONE
67 };
68
69 static const AVRational standard_tbs[] = {
70     {1, 25},
71     {1, 30},
72     {1001, 30000},
73 };
74
75 static int query_formats(AVFilterContext *ctx)
76 {
77     static const enum AVPixelFormat pix_fmts[] = {
78         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
79         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
80         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
81         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
82         AV_PIX_FMT_GRAY8, FULL_SCALE_YUVJ_FORMATS,
83         AV_PIX_FMT_NONE
84     };
85
86     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
87     if (!fmts_list)
88         return AVERROR(ENOMEM);
89     return ff_set_common_formats(ctx, fmts_list);
90 }
91
92 static void lowpass_line_c(uint8_t *dstp, ptrdiff_t width, const uint8_t *srcp,
93                            ptrdiff_t mref, ptrdiff_t pref)
94 {
95     const uint8_t *srcp_above = srcp + mref;
96     const uint8_t *srcp_below = srcp + pref;
97     int i;
98     for (i = 0; i < width; i++) {
99         // this calculation is an integer representation of
100         // '0.5 * current + 0.25 * above + 0.25 * below'
101         // '1 +' is for rounding.
102         dstp[i] = (1 + srcp[i] + srcp[i] + srcp_above[i] + srcp_below[i]) >> 2;
103     }
104 }
105
106 static void lowpass_line_complex_c(uint8_t *dstp, ptrdiff_t width, const uint8_t *srcp,
107                                    ptrdiff_t mref, ptrdiff_t pref)
108 {
109     const uint8_t *srcp_above = srcp + mref;
110     const uint8_t *srcp_below = srcp + pref;
111     const uint8_t *srcp_above2 = srcp + mref * 2;
112     const uint8_t *srcp_below2 = srcp + pref * 2;
113     int i, srcp_x, srcp_ab;
114     for (i = 0; i < width; i++) {
115         // this calculation is an integer representation of
116         // '0.75 * current + 0.25 * above + 0.25 * below - 0.125 * above2 - 0.125 * below2'
117         // '4 +' is for rounding.
118         srcp_x = srcp[i] << 1;
119         srcp_ab = srcp_above[i] + srcp_below[i];
120         dstp[i] = av_clip_uint8((4 + ((srcp[i] + srcp_x + srcp_ab) << 1)
121                                 - srcp_above2[i] - srcp_below2[i]) >> 3);
122         // Prevent over-sharpening:
123         // dst must not exceed src when the average of above and below
124         // is less than src. And the other way around.
125         if (srcp_ab > srcp_x) {
126             if (dstp[i] < srcp[i])
127                 dstp[i] = srcp[i];
128         } else if (dstp[i] > srcp[i])
129             dstp[i] = srcp[i];
130     }
131 }
132
133 static av_cold void uninit(AVFilterContext *ctx)
134 {
135     TInterlaceContext *tinterlace = ctx->priv;
136
137     av_frame_free(&tinterlace->cur );
138     av_frame_free(&tinterlace->next);
139     av_freep(&tinterlace->black_data[0]);
140 }
141
142 static int config_out_props(AVFilterLink *outlink)
143 {
144     AVFilterContext *ctx = outlink->src;
145     AVFilterLink *inlink = outlink->src->inputs[0];
146     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(outlink->format);
147     TInterlaceContext *tinterlace = ctx->priv;
148     int i;
149
150     tinterlace->vsub = desc->log2_chroma_h;
151     outlink->w = inlink->w;
152     outlink->h = tinterlace->mode == MODE_MERGE || tinterlace->mode == MODE_PAD || tinterlace->mode == MODE_MERGEX2?
153         inlink->h*2 : inlink->h;
154     if (tinterlace->mode == MODE_MERGE || tinterlace->mode == MODE_PAD || tinterlace->mode == MODE_MERGEX2)
155         outlink->sample_aspect_ratio = av_mul_q(inlink->sample_aspect_ratio,
156                                                 av_make_q(2, 1));
157
158     if (tinterlace->mode == MODE_PAD) {
159         uint8_t black[4] = { 0, 0, 0, 16 };
160         int ret;
161         ff_draw_init(&tinterlace->draw, outlink->format, 0);
162         ff_draw_color(&tinterlace->draw, &tinterlace->color, black);
163         if (ff_fmt_is_in(outlink->format, full_scale_yuvj_pix_fmts))
164             tinterlace->color.comp[0].u8[0] = 0;
165         ret = av_image_alloc(tinterlace->black_data, tinterlace->black_linesize,
166                              outlink->w, outlink->h, outlink->format, 16);
167         if (ret < 0)
168             return ret;
169
170         ff_fill_rectangle(&tinterlace->draw, &tinterlace->color, tinterlace->black_data,
171                           tinterlace->black_linesize, 0, 0, outlink->w, outlink->h);
172     }
173     if (tinterlace->flags & (TINTERLACE_FLAG_VLPF | TINTERLACE_FLAG_CVLPF)
174             && !(tinterlace->mode == MODE_INTERLEAVE_TOP
175               || tinterlace->mode == MODE_INTERLEAVE_BOTTOM)) {
176         av_log(ctx, AV_LOG_WARNING, "low_pass_filter flags ignored with mode %d\n",
177                 tinterlace->mode);
178         tinterlace->flags &= ~(TINTERLACE_FLAG_VLPF | TINTERLACE_FLAG_CVLPF);
179     }
180     tinterlace->preout_time_base = inlink->time_base;
181     if (tinterlace->mode == MODE_INTERLACEX2) {
182         tinterlace->preout_time_base.den *= 2;
183         outlink->frame_rate = av_mul_q(inlink->frame_rate, (AVRational){2,1});
184         outlink->time_base  = av_mul_q(inlink->time_base , (AVRational){1,2});
185     } else if (tinterlace->mode == MODE_MERGEX2) {
186         outlink->frame_rate = inlink->frame_rate;
187         outlink->time_base  = inlink->time_base;
188     } else if (tinterlace->mode != MODE_PAD) {
189         outlink->frame_rate = av_mul_q(inlink->frame_rate, (AVRational){1,2});
190         outlink->time_base  = av_mul_q(inlink->time_base , (AVRational){2,1});
191     }
192
193     for (i = 0; i<FF_ARRAY_ELEMS(standard_tbs); i++){
194         if (!av_cmp_q(standard_tbs[i], outlink->time_base))
195             break;
196     }
197     if (i == FF_ARRAY_ELEMS(standard_tbs) ||
198         (tinterlace->flags & TINTERLACE_FLAG_EXACT_TB))
199         outlink->time_base = tinterlace->preout_time_base;
200
201     if (tinterlace->flags & TINTERLACE_FLAG_CVLPF) {
202         tinterlace->lowpass_line = lowpass_line_complex_c;
203         if (ARCH_X86)
204             ff_tinterlace_init_x86(tinterlace);
205     } else if (tinterlace->flags & TINTERLACE_FLAG_VLPF) {
206         tinterlace->lowpass_line = lowpass_line_c;
207         if (ARCH_X86)
208             ff_tinterlace_init_x86(tinterlace);
209     }
210
211     av_log(ctx, AV_LOG_VERBOSE, "mode:%d filter:%s h:%d -> h:%d\n", tinterlace->mode,
212            (tinterlace->flags & TINTERLACE_FLAG_CVLPF) ? "complex" :
213            (tinterlace->flags & TINTERLACE_FLAG_VLPF) ? "linear" : "off",
214            inlink->h, outlink->h);
215
216     return 0;
217 }
218
219 #define FIELD_UPPER           0
220 #define FIELD_LOWER           1
221 #define FIELD_UPPER_AND_LOWER 2
222
223 /**
224  * Copy picture field from src to dst.
225  *
226  * @param src_field copy from upper, lower field or both
227  * @param interleave leave a padding line between each copied line
228  * @param dst_field copy to upper or lower field,
229  *        only meaningful when interleave is selected
230  * @param flags context flags
231  */
232 static inline
233 void copy_picture_field(TInterlaceContext *tinterlace,
234                         uint8_t *dst[4], int dst_linesize[4],
235                         const uint8_t *src[4], int src_linesize[4],
236                         enum AVPixelFormat format, int w, int src_h,
237                         int src_field, int interleave, int dst_field,
238                         int flags)
239 {
240     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(format);
241     int hsub = desc->log2_chroma_w;
242     int plane, vsub = desc->log2_chroma_h;
243     int k = src_field == FIELD_UPPER_AND_LOWER ? 1 : 2;
244     int h;
245
246     for (plane = 0; plane < desc->nb_components; plane++) {
247         int lines = plane == 1 || plane == 2 ? AV_CEIL_RSHIFT(src_h, vsub) : src_h;
248         int cols  = plane == 1 || plane == 2 ? AV_CEIL_RSHIFT(    w, hsub) : w;
249         uint8_t *dstp = dst[plane];
250         const uint8_t *srcp = src[plane];
251         int srcp_linesize = src_linesize[plane] * k;
252         int dstp_linesize = dst_linesize[plane] * (interleave ? 2 : 1);
253
254         lines = (lines + (src_field == FIELD_UPPER)) / k;
255         if (src_field == FIELD_LOWER)
256             srcp += src_linesize[plane];
257         if (interleave && dst_field == FIELD_LOWER)
258             dstp += dst_linesize[plane];
259         // Low-pass filtering is required when creating an interlaced destination from
260         // a progressive source which contains high-frequency vertical detail.
261         // Filtering will reduce interlace 'twitter' and Moire patterning.
262         if (flags & (TINTERLACE_FLAG_VLPF | TINTERLACE_FLAG_CVLPF)) {
263             int x = !!(flags & TINTERLACE_FLAG_CVLPF);
264             for (h = lines; h > 0; h--) {
265                 ptrdiff_t pref = src_linesize[plane];
266                 ptrdiff_t mref = -pref;
267                 if (h >= (lines - x))  mref = 0; // there is no line above
268                 else if (h <= (1 + x)) pref = 0; // there is no line below
269
270                 tinterlace->lowpass_line(dstp, cols, srcp, mref, pref);
271                 dstp += dstp_linesize;
272                 srcp += srcp_linesize;
273             }
274         } else {
275             av_image_copy_plane(dstp, dstp_linesize, srcp, srcp_linesize, cols, lines);
276         }
277     }
278 }
279
280 static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
281 {
282     AVFilterContext *ctx = inlink->dst;
283     AVFilterLink *outlink = ctx->outputs[0];
284     TInterlaceContext *tinterlace = ctx->priv;
285     AVFrame *cur, *next, *out;
286     int field, tff, ret;
287
288     av_frame_free(&tinterlace->cur);
289     tinterlace->cur  = tinterlace->next;
290     tinterlace->next = picref;
291
292     cur = tinterlace->cur;
293     next = tinterlace->next;
294     /* we need at least two frames */
295     if (!tinterlace->cur)
296         return 0;
297
298     switch (tinterlace->mode) {
299     case MODE_MERGEX2: /* move the odd frame into the upper field of the new image, even into
300                         * the lower field, generating a double-height video at same framerate */
301     case MODE_MERGE: /* move the odd frame into the upper field of the new image, even into
302              * the lower field, generating a double-height video at half framerate */
303         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
304         if (!out)
305             return AVERROR(ENOMEM);
306         av_frame_copy_props(out, cur);
307         out->height = outlink->h;
308         out->interlaced_frame = 1;
309         out->top_field_first = 1;
310         out->sample_aspect_ratio = av_mul_q(cur->sample_aspect_ratio, av_make_q(2, 1));
311
312         /* write odd frame lines into the upper field of the new frame */
313         copy_picture_field(tinterlace, out->data, out->linesize,
314                            (const uint8_t **)cur->data, cur->linesize,
315                            inlink->format, inlink->w, inlink->h,
316                            FIELD_UPPER_AND_LOWER, 1, tinterlace->mode == MODE_MERGEX2 ? inlink->frame_count_out & 1 ? FIELD_LOWER : FIELD_UPPER : FIELD_UPPER, tinterlace->flags);
317         /* write even frame lines into the lower field of the new frame */
318         copy_picture_field(tinterlace, out->data, out->linesize,
319                            (const uint8_t **)next->data, next->linesize,
320                            inlink->format, inlink->w, inlink->h,
321                            FIELD_UPPER_AND_LOWER, 1, tinterlace->mode == MODE_MERGEX2 ? inlink->frame_count_out & 1 ? FIELD_UPPER : FIELD_LOWER : FIELD_LOWER, tinterlace->flags);
322         if (tinterlace->mode != MODE_MERGEX2)
323             av_frame_free(&tinterlace->next);
324         break;
325
326     case MODE_DROP_ODD:  /* only output even frames, odd  frames are dropped; height unchanged, half framerate */
327     case MODE_DROP_EVEN: /* only output odd  frames, even frames are dropped; height unchanged, half framerate */
328         out = av_frame_clone(tinterlace->mode == MODE_DROP_EVEN ? cur : next);
329         if (!out)
330             return AVERROR(ENOMEM);
331         av_frame_free(&tinterlace->next);
332         break;
333
334     case MODE_PAD: /* expand each frame to double height, but pad alternate
335                     * lines with black; framerate unchanged */
336         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
337         if (!out)
338             return AVERROR(ENOMEM);
339         av_frame_copy_props(out, cur);
340         out->height = outlink->h;
341         out->sample_aspect_ratio = av_mul_q(cur->sample_aspect_ratio, av_make_q(2, 1));
342
343         field = (1 + tinterlace->frame) & 1 ? FIELD_UPPER : FIELD_LOWER;
344         /* copy upper and lower fields */
345         copy_picture_field(tinterlace, out->data, out->linesize,
346                            (const uint8_t **)cur->data, cur->linesize,
347                            inlink->format, inlink->w, inlink->h,
348                            FIELD_UPPER_AND_LOWER, 1, field, tinterlace->flags);
349         /* pad with black the other field */
350         copy_picture_field(tinterlace, out->data, out->linesize,
351                            (const uint8_t **)tinterlace->black_data, tinterlace->black_linesize,
352                            inlink->format, inlink->w, inlink->h,
353                            FIELD_UPPER_AND_LOWER, 1, !field, tinterlace->flags);
354         break;
355
356         /* interleave upper/lower lines from odd frames with lower/upper lines from even frames,
357          * halving the frame rate and preserving image height */
358     case MODE_INTERLEAVE_TOP:    /* top    field first */
359     case MODE_INTERLEAVE_BOTTOM: /* bottom field first */
360         tff = tinterlace->mode == MODE_INTERLEAVE_TOP;
361         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
362         if (!out)
363             return AVERROR(ENOMEM);
364         av_frame_copy_props(out, cur);
365         out->interlaced_frame = 1;
366         out->top_field_first = tff;
367
368         /* copy upper/lower field from cur */
369         copy_picture_field(tinterlace, out->data, out->linesize,
370                            (const uint8_t **)cur->data, cur->linesize,
371                            inlink->format, inlink->w, inlink->h,
372                            tff ? FIELD_UPPER : FIELD_LOWER, 1, tff ? FIELD_UPPER : FIELD_LOWER,
373                            tinterlace->flags);
374         /* copy lower/upper field from next */
375         copy_picture_field(tinterlace, out->data, out->linesize,
376                            (const uint8_t **)next->data, next->linesize,
377                            inlink->format, inlink->w, inlink->h,
378                            tff ? FIELD_LOWER : FIELD_UPPER, 1, tff ? FIELD_LOWER : FIELD_UPPER,
379                            tinterlace->flags);
380         av_frame_free(&tinterlace->next);
381         break;
382     case MODE_INTERLACEX2: /* re-interlace preserving image height, double frame rate */
383         /* output current frame first */
384         out = av_frame_clone(cur);
385         if (!out)
386             return AVERROR(ENOMEM);
387         out->interlaced_frame = 1;
388         if (cur->pts != AV_NOPTS_VALUE)
389             out->pts = cur->pts*2;
390
391         out->pts = av_rescale_q(out->pts, tinterlace->preout_time_base, outlink->time_base);
392         if ((ret = ff_filter_frame(outlink, out)) < 0)
393             return ret;
394
395         /* output mix of current and next frame */
396         tff = next->top_field_first;
397         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
398         if (!out)
399             return AVERROR(ENOMEM);
400         av_frame_copy_props(out, next);
401         out->interlaced_frame = 1;
402         out->top_field_first = !tff;
403
404         if (next->pts != AV_NOPTS_VALUE && cur->pts != AV_NOPTS_VALUE)
405             out->pts = cur->pts + next->pts;
406         else
407             out->pts = AV_NOPTS_VALUE;
408         /* write current frame second field lines into the second field of the new frame */
409         copy_picture_field(tinterlace, out->data, out->linesize,
410                            (const uint8_t **)cur->data, cur->linesize,
411                            inlink->format, inlink->w, inlink->h,
412                            tff ? FIELD_LOWER : FIELD_UPPER, 1, tff ? FIELD_LOWER : FIELD_UPPER,
413                            tinterlace->flags);
414         /* write next frame first field lines into the first field of the new frame */
415         copy_picture_field(tinterlace, out->data, out->linesize,
416                            (const uint8_t **)next->data, next->linesize,
417                            inlink->format, inlink->w, inlink->h,
418                            tff ? FIELD_UPPER : FIELD_LOWER, 1, tff ? FIELD_UPPER : FIELD_LOWER,
419                            tinterlace->flags);
420         break;
421     default:
422         av_assert0(0);
423     }
424
425     out->pts = av_rescale_q(out->pts, tinterlace->preout_time_base, outlink->time_base);
426     ret = ff_filter_frame(outlink, out);
427     tinterlace->frame++;
428
429     return ret;
430 }
431
432 static const AVFilterPad tinterlace_inputs[] = {
433     {
434         .name         = "default",
435         .type         = AVMEDIA_TYPE_VIDEO,
436         .filter_frame = filter_frame,
437     },
438     { NULL }
439 };
440
441 static const AVFilterPad tinterlace_outputs[] = {
442     {
443         .name         = "default",
444         .type         = AVMEDIA_TYPE_VIDEO,
445         .config_props = config_out_props,
446     },
447     { NULL }
448 };
449
450 AVFilter ff_vf_tinterlace = {
451     .name          = "tinterlace",
452     .description   = NULL_IF_CONFIG_SMALL("Perform temporal field interlacing."),
453     .priv_size     = sizeof(TInterlaceContext),
454     .uninit        = uninit,
455     .query_formats = query_formats,
456     .inputs        = tinterlace_inputs,
457     .outputs       = tinterlace_outputs,
458     .priv_class    = &tinterlace_class,
459 };