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