vf_interlace: implement frame rate
[ffmpeg.git] / libavfilter / vf_interlace.c
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with Libav; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18
19 /**
20  * @file
21  * progressive to interlaced content filter, inspired by heavy debugging of tinterlace filter
22  */
23
24 #include "libavutil/common.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/imgutils.h"
27 #include "libavutil/avassert.h"
28
29 #include "formats.h"
30 #include "avfilter.h"
31 #include "interlace.h"
32 #include "internal.h"
33 #include "video.h"
34
35 #define OFFSET(x) offsetof(InterlaceContext, x)
36 #define V AV_OPT_FLAG_VIDEO_PARAM
37 static const AVOption options[] = {
38     { "scan", "scanning mode", OFFSET(scan),
39         AV_OPT_TYPE_INT,   {.i64 = MODE_TFF }, 0, 1, .flags = V, .unit = "scan" },
40     { "tff", "top field first", 0,
41         AV_OPT_TYPE_CONST, {.i64 = MODE_TFF }, INT_MIN, INT_MAX, .flags = V, .unit = "scan" },
42     { "bff", "bottom field first", 0,
43         AV_OPT_TYPE_CONST, {.i64 = MODE_BFF }, INT_MIN, INT_MAX, .flags = V, .unit = "scan" },
44     { "lowpass", "enable vertical low-pass filter", OFFSET(lowpass),
45         AV_OPT_TYPE_INT,   {.i64 = 1 },        0, 1, .flags = V },
46     { NULL }
47 };
48
49 static const AVClass class = {
50     .class_name = "interlace filter",
51     .item_name  = av_default_item_name,
52     .option     = options,
53     .version    = LIBAVUTIL_VERSION_INT,
54 };
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     av_opt_free(s);
91 }
92
93 static int config_out_props(AVFilterLink *outlink)
94 {
95     AVFilterContext *ctx = outlink->src;
96     AVFilterLink *inlink = outlink->src->inputs[0];
97     InterlaceContext *s = ctx->priv;
98
99     if (inlink->h < 2) {
100         av_log(ctx, AV_LOG_ERROR, "input video height is too small\n");
101         return AVERROR_INVALIDDATA;
102     }
103
104     if (!s->lowpass)
105         av_log(ctx, AV_LOG_WARNING, "Lowpass filter is disabled, "
106                "the resulting video will be aliased rather than interlaced.\n");
107
108     // same input size
109     outlink->w = inlink->w;
110     outlink->h = inlink->h;
111     outlink->time_base = inlink->time_base;
112     outlink->frame_rate = inlink->frame_rate;
113     // half framerate
114     outlink->time_base.num *= 2;
115     outlink->frame_rate.den *= 2;
116
117
118     if (s->lowpass) {
119         s->lowpass_line = lowpass_line_c;
120         if (ARCH_X86)
121             ff_interlace_init_x86(s);
122     }
123
124     av_log(ctx, AV_LOG_VERBOSE, "%s interlacing %s lowpass filter\n",
125            s->scan == MODE_TFF ? "tff" : "bff", (s->lowpass) ? "with" : "without");
126
127     return 0;
128 }
129
130 static void copy_picture_field(InterlaceContext *s,
131                                AVFrame *src_frame, AVFrame *dst_frame,
132                                AVFilterLink *inlink, enum FieldType field_type,
133                                int lowpass)
134 {
135     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
136     int hsub = desc->log2_chroma_w;
137     int vsub = desc->log2_chroma_h;
138     int plane, j;
139
140     for (plane = 0; plane < desc->nb_components; plane++) {
141         int cols  = (plane == 1 || plane == 2) ? -(-inlink->w) >> hsub : inlink->w;
142         int lines = (plane == 1 || plane == 2) ? -(-inlink->h) >> vsub : inlink->h;
143         uint8_t *dstp = dst_frame->data[plane];
144         const uint8_t *srcp = src_frame->data[plane];
145
146         av_assert0(cols >= 0 || lines >= 0);
147
148         lines = (lines + (field_type == FIELD_UPPER)) / 2;
149         if (field_type == FIELD_LOWER) {
150             srcp += src_frame->linesize[plane];
151             dstp += dst_frame->linesize[plane];
152         }
153         if (lowpass) {
154             int srcp_linesize = src_frame->linesize[plane] * 2;
155             int dstp_linesize = dst_frame->linesize[plane] * 2;
156             for (j = lines; j > 0; j--) {
157                 const uint8_t *srcp_above = srcp - src_frame->linesize[plane];
158                 const uint8_t *srcp_below = srcp + src_frame->linesize[plane];
159                 if (j == lines)
160                     srcp_above = srcp; // there is no line above
161                 if (j == 1)
162                     srcp_below = srcp; // there is no line below
163                 s->lowpass_line(dstp, cols, srcp, srcp_above, srcp_below);
164                 dstp += dstp_linesize;
165                 srcp += srcp_linesize;
166             }
167         } else {
168             av_image_copy_plane(dstp, dst_frame->linesize[plane] * 2,
169                                 srcp, src_frame->linesize[plane] * 2,
170                                 cols, lines);
171         }
172     }
173 }
174
175 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
176 {
177     AVFilterContext *ctx = inlink->dst;
178     AVFilterLink *outlink = ctx->outputs[0];
179     InterlaceContext *s = ctx->priv;
180     AVFrame *out;
181     int tff, ret;
182
183     av_frame_free(&s->cur);
184     s->cur  = s->next;
185     s->next = buf;
186
187     /* we need at least two frames */
188     if (!s->cur || !s->next)
189         return 0;
190
191     if (s->cur->interlaced_frame) {
192         av_log(ctx, AV_LOG_WARNING,
193                "video is already interlaced, adjusting framerate only\n");
194         out = av_frame_clone(s->cur);
195         if (!out)
196             return AVERROR(ENOMEM);
197         out->pts /= 2;  // adjust pts to new framerate
198         ret = ff_filter_frame(outlink, out);
199         s->got_output = 1;
200         return ret;
201     }
202
203     tff = (s->scan == MODE_TFF);
204     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
205     if (!out)
206         return AVERROR(ENOMEM);
207
208     av_frame_copy_props(out, s->cur);
209     out->interlaced_frame = 1;
210     out->top_field_first  = tff;
211     out->pts             /= 2;  // adjust pts to new framerate
212
213     /* copy upper/lower field from cur */
214     copy_picture_field(s, s->cur, out, inlink, tff ? FIELD_UPPER : FIELD_LOWER, s->lowpass);
215     av_frame_free(&s->cur);
216
217     /* copy lower/upper field from next */
218     copy_picture_field(s, s->next, out, inlink, tff ? FIELD_LOWER : FIELD_UPPER, s->lowpass);
219     av_frame_free(&s->next);
220
221     ret = ff_filter_frame(outlink, out);
222     s->got_output = 1;
223
224     return ret;
225 }
226
227 static int request_frame(AVFilterLink *outlink)
228 {
229     AVFilterContext *ctx = outlink->src;
230     InterlaceContext *s  = ctx->priv;
231     int ret = 0;
232
233     s->got_output = 0;
234     while (ret >= 0 && !s->got_output)
235         ret = ff_request_frame(ctx->inputs[0]);
236
237     return ret;
238 }
239
240 static const AVFilterPad inputs[] = {
241     {
242         .name         = "default",
243         .type         = AVMEDIA_TYPE_VIDEO,
244         .filter_frame = filter_frame,
245     },
246     { NULL }
247 };
248
249 static const AVFilterPad outputs[] = {
250     {
251         .name          = "default",
252         .type          = AVMEDIA_TYPE_VIDEO,
253         .config_props  = config_out_props,
254         .request_frame = request_frame,
255     },
256     { NULL }
257 };
258
259 AVFilter ff_vf_interlace = {
260     .name          = "interlace",
261     .description   = NULL_IF_CONFIG_SMALL("Convert progressive video into interlaced."),
262     .uninit        = uninit,
263
264     .priv_class    = &class,
265     .priv_size     = sizeof(InterlaceContext),
266     .query_formats = query_formats,
267
268     .inputs        = inputs,
269     .outputs       = outputs,
270 };
271