a63f9152ccb55b5ac6be91f11dc1aa2834544a12
[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  *
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  * progressive to interlaced content filter, inspired by heavy debugging of tinterlace filter
27  */
28
29 #include "libavutil/common.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/avassert.h"
33
34 #include "formats.h"
35 #include "avfilter.h"
36 #include "interlace.h"
37 #include "internal.h"
38 #include "video.h"
39
40 #define OFFSET(x) offsetof(InterlaceContext, x)
41 #define V AV_OPT_FLAG_VIDEO_PARAM
42 static const AVOption interlace_options[] = {
43     { "scan", "scanning mode", OFFSET(scan),
44         AV_OPT_TYPE_INT,   {.i64 = MODE_TFF }, 0, 1, .flags = V, .unit = "scan" },
45     { "tff", "top field first", 0,
46         AV_OPT_TYPE_CONST, {.i64 = MODE_TFF }, INT_MIN, INT_MAX, .flags = V, .unit = "scan" },
47     { "bff", "bottom field first", 0,
48         AV_OPT_TYPE_CONST, {.i64 = MODE_BFF }, INT_MIN, INT_MAX, .flags = V, .unit = "scan" },
49     { "lowpass", "enable vertical low-pass filter", OFFSET(lowpass),
50         AV_OPT_TYPE_INT,   {.i64 = 1 },        0, 1, .flags = V },
51     { NULL }
52 };
53
54 AVFILTER_DEFINE_CLASS(interlace);
55
56 static void lowpass_line_c(uint8_t *dstp, ptrdiff_t linesize,
57                            const uint8_t *srcp,
58                            const uint8_t *srcp_above,
59                            const uint8_t *srcp_below)
60 {
61     int i;
62     for (i = 0; i < linesize; i++) {
63         // this calculation is an integer representation of
64         // '0.5 * current + 0.25 * above + 0.25 * below'
65         // '1 +' is for rounding.
66         dstp[i] = (1 + srcp[i] + srcp[i] + srcp_above[i] + srcp_below[i]) >> 2;
67     }
68 }
69
70 static const enum AVPixelFormat formats_supported[] = {
71     AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV444P,
72     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUVA420P,
73     AV_PIX_FMT_GRAY8,    AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
74     AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
75 };
76
77 static int query_formats(AVFilterContext *ctx)
78 {
79     ff_set_common_formats(ctx, ff_make_format_list(formats_supported));
80     return 0;
81 }
82
83 static av_cold void uninit(AVFilterContext *ctx)
84 {
85     InterlaceContext *s = ctx->priv;
86
87     av_frame_free(&s->cur);
88     av_frame_free(&s->next);
89 }
90
91 static int config_out_props(AVFilterLink *outlink)
92 {
93     AVFilterContext *ctx = outlink->src;
94     AVFilterLink *inlink = outlink->src->inputs[0];
95     InterlaceContext *s = ctx->priv;
96
97     if (inlink->h < 2) {
98         av_log(ctx, AV_LOG_ERROR, "input video height is too small\n");
99         return AVERROR_INVALIDDATA;
100     }
101
102     if (!s->lowpass)
103         av_log(ctx, AV_LOG_WARNING, "***warning*** Lowpass filter is disabled, "
104                "the resulting video will be aliased rather than interlaced.\n");
105
106     // same input size
107     outlink->w = inlink->w;
108     outlink->h = inlink->h;
109     outlink->time_base = inlink->time_base;
110     outlink->frame_rate = inlink->frame_rate;
111     // half framerate
112     outlink->frame_rate.den *= 2;
113     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
114
115
116     if (s->lowpass) {
117         s->lowpass_line = lowpass_line_c;
118         if (ARCH_X86)
119             ff_interlace_init_x86(s);
120     }
121
122     av_log(ctx, AV_LOG_VERBOSE, "%s interlacing %s lowpass filter\n",
123            s->scan == MODE_TFF ? "tff" : "bff", (s->lowpass) ? "with" : "without");
124
125     return 0;
126 }
127
128 static void copy_picture_field(InterlaceContext *s,
129                                AVFrame *src_frame, AVFrame *dst_frame,
130                                AVFilterLink *inlink, enum FieldType field_type,
131                                int lowpass)
132 {
133     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
134     int vsub = desc->log2_chroma_h;
135     int plane, j;
136
137     for (plane = 0; plane < desc->nb_components; plane++) {
138         int lines = (plane == 1 || plane == 2) ? FF_CEIL_RSHIFT(inlink->h, vsub) : inlink->h;
139         ptrdiff_t linesize = av_image_get_linesize(inlink->format, inlink->w, plane);
140         uint8_t *dstp = dst_frame->data[plane];
141         const uint8_t *srcp = src_frame->data[plane];
142
143         av_assert0(linesize >= 0);
144
145         lines = (lines + (field_type == FIELD_UPPER)) / 2;
146         if (field_type == FIELD_LOWER)
147             srcp += src_frame->linesize[plane];
148         if (field_type == FIELD_LOWER)
149             dstp += dst_frame->linesize[plane];
150         if (lowpass) {
151             int srcp_linesize = src_frame->linesize[plane] * 2;
152             int dstp_linesize = dst_frame->linesize[plane] * 2;
153             for (j = lines; j > 0; j--) {
154                 const uint8_t *srcp_above = srcp - src_frame->linesize[plane];
155                 const uint8_t *srcp_below = srcp + src_frame->linesize[plane];
156                 if (j == lines)
157                     srcp_above = srcp; // there is no line above
158                 if (j == 1)
159                     srcp_below = srcp; // there is no line below
160                 s->lowpass_line(dstp, linesize, srcp, srcp_above, srcp_below);
161                 dstp += dstp_linesize;
162                 srcp += srcp_linesize;
163             }
164         } else {
165             av_image_copy_plane(dstp, dst_frame->linesize[plane] * 2,
166                                 srcp, src_frame->linesize[plane] * 2,
167                                 linesize, lines);
168         }
169     }
170 }
171
172 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
173 {
174     AVFilterContext *ctx = inlink->dst;
175     AVFilterLink *outlink = ctx->outputs[0];
176     InterlaceContext *s = ctx->priv;
177     AVFrame *out;
178     int tff, ret;
179
180     av_frame_free(&s->cur);
181     s->cur  = s->next;
182     s->next = buf;
183
184     /* we need at least two frames */
185     if (!s->cur || !s->next)
186         return 0;
187
188     if (s->cur->interlaced_frame) {
189         av_log(ctx, AV_LOG_WARNING,
190                "video is already interlaced, adjusting framerate only\n");
191         out = av_frame_clone(s->cur);
192         if (!out)
193             return AVERROR(ENOMEM);
194         out->pts /= 2;  // adjust pts to new framerate
195         ret = ff_filter_frame(outlink, out);
196         return ret;
197     }
198
199     tff = (s->scan == MODE_TFF);
200     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
201     if (!out)
202         return AVERROR(ENOMEM);
203
204     av_frame_copy_props(out, s->cur);
205     out->interlaced_frame = 1;
206     out->top_field_first  = tff;
207
208     /* copy upper/lower field from cur */
209     copy_picture_field(s, s->cur, out, inlink, tff ? FIELD_UPPER : FIELD_LOWER, s->lowpass);
210     av_frame_free(&s->cur);
211
212     /* copy lower/upper field from next */
213     copy_picture_field(s, s->next, out, inlink, tff ? FIELD_LOWER : FIELD_UPPER, s->lowpass);
214     av_frame_free(&s->next);
215
216     ret = ff_filter_frame(outlink, out);
217
218     return ret;
219 }
220
221 static const AVFilterPad inputs[] = {
222     {
223         .name         = "default",
224         .type         = AVMEDIA_TYPE_VIDEO,
225         .filter_frame = filter_frame,
226     },
227     { NULL }
228 };
229
230 static const AVFilterPad outputs[] = {
231     {
232         .name         = "default",
233         .type         = AVMEDIA_TYPE_VIDEO,
234         .config_props = config_out_props,
235     },
236     { NULL }
237 };
238
239 AVFilter ff_vf_interlace = {
240     .name          = "interlace",
241     .description   = NULL_IF_CONFIG_SMALL("Convert progressive video into interlaced."),
242     .uninit        = uninit,
243     .priv_class    = &interlace_class,
244     .priv_size     = sizeof(InterlaceContext),
245     .query_formats = query_formats,
246     .inputs        = inputs,
247     .outputs       = outputs,
248 };