2 * Copyright (C) 2012 British Broadcasting Corporation, All Rights Reserved
3 * Author of de-interlace algorithm: Jim Easterbrook for BBC R&D
4 * Based on the process described by Martin Weston for BBC R&D
5 * Author of FFmpeg filter: Mark Himsley for BBC Broadcast Systems Development
7 * This file is part of FFmpeg.
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
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 GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libavutil/common.h"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/pixdesc.h"
33 typedef struct W3FDIFContext {
35 int filter; ///< 0 is simple, 1 is more complex
36 int deint; ///< which frames to deinterlace
37 int linesize[4]; ///< bytes of pixel data per line for each plane
38 int planeheight[4]; ///< height of each plane
39 int field; ///< which field are we on, 0 or 1
42 AVFrame *prev, *cur, *next; ///< previous, current, next frames
43 int32_t *work_line; ///< line we are calculating
46 #define OFFSET(x) offsetof(W3FDIFContext, x)
47 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
48 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, 0, 0, FLAGS, unit }
50 static const AVOption w3fdif_options[] = {
51 { "filter", "specify the filter", OFFSET(filter), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS, "filter" },
52 CONST("simple", NULL, 0, "filter"),
53 CONST("complex", NULL, 1, "filter"),
54 { "deint", "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "deint" },
55 CONST("all", "deinterlace all frames", 0, "deint"),
56 CONST("interlaced", "only deinterlace frames marked as interlaced", 1, "deint"),
60 AVFILTER_DEFINE_CLASS(w3fdif);
62 static int query_formats(AVFilterContext *ctx)
64 static const enum AVPixelFormat pix_fmts[] = {
65 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
66 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
67 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
68 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
69 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
71 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
72 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
77 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
79 return AVERROR(ENOMEM);
80 return ff_set_common_formats(ctx, fmts_list);
83 static int config_input(AVFilterLink *inlink)
85 W3FDIFContext *s = inlink->dst->priv;
86 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
89 if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
92 s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
93 s->planeheight[0] = s->planeheight[3] = inlink->h;
95 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
96 s->work_line = av_calloc(s->linesize[0], sizeof(*s->work_line));
98 return AVERROR(ENOMEM);
103 static int config_output(AVFilterLink *outlink)
105 AVFilterLink *inlink = outlink->src->inputs[0];
107 outlink->time_base.num = inlink->time_base.num;
108 outlink->time_base.den = inlink->time_base.den * 2;
109 outlink->frame_rate.num = inlink->frame_rate.num * 2;
110 outlink->frame_rate.den = inlink->frame_rate.den;
111 outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
117 * Filter coefficients from PH-2071, scaled by 256 * 256.
118 * Each set of coefficients has a set for low-frequencies and high-frequencies.
119 * n_coef_lf[] and n_coef_hf[] are the number of coefs for simple and more-complex.
120 * It is important for later that n_coef_lf[] is even and n_coef_hf[] is odd.
121 * coef_lf[][] and coef_hf[][] are the coefficients for low-frequencies
122 * and high-frequencies for simple and more-complex mode.
124 static const int8_t n_coef_lf[2] = { 2, 4 };
125 static const int32_t coef_lf[2][4] = {{ 32768, 32768, 0, 0},
126 { -1704, 34472, 34472, -1704}};
127 static const int8_t n_coef_hf[2] = { 3, 5 };
128 static const int32_t coef_hf[2][5] = {{ -4096, 8192, -4096, 0, 0},
129 { 2032, -7602, 11140, -7602, 2032}};
131 static void deinterlace_plane(AVFilterContext *ctx, AVFrame *out,
132 const AVFrame *cur, const AVFrame *adj,
133 const int filter, const int plane)
135 W3FDIFContext *s = ctx->priv;
136 uint8_t *in_line, *in_lines_cur[5], *in_lines_adj[5];
137 uint8_t *out_line, *out_pixel;
138 int32_t *work_line, *work_pixel;
139 uint8_t *cur_data = cur->data[plane];
140 uint8_t *adj_data = adj->data[plane];
141 uint8_t *dst_data = out->data[plane];
142 const int linesize = s->linesize[plane];
143 const int height = s->planeheight[plane];
144 const int cur_line_stride = cur->linesize[plane];
145 const int adj_line_stride = adj->linesize[plane];
146 const int dst_line_stride = out->linesize[plane];
147 int i, j, y_in, y_out;
149 /* copy unchanged the lines of the field */
150 y_out = s->field == cur->top_field_first;
152 in_line = cur_data + (y_out * cur_line_stride);
153 out_line = dst_data + (y_out * dst_line_stride);
155 while (y_out < height) {
156 memcpy(out_line, in_line, linesize);
158 in_line += cur_line_stride * 2;
159 out_line += dst_line_stride * 2;
162 /* interpolate other lines of the field */
163 y_out = s->field != cur->top_field_first;
165 out_line = dst_data + (y_out * dst_line_stride);
167 while (y_out < height) {
168 /* clear workspace */
169 memset(s->work_line, 0, sizeof(*s->work_line) * linesize);
171 /* get low vertical frequencies from current field */
172 for (j = 0; j < n_coef_lf[filter]; j++) {
173 y_in = (y_out + 1) + (j * 2) - n_coef_lf[filter];
177 while (y_in >= height)
180 in_lines_cur[j] = cur_data + (y_in * cur_line_stride);
183 work_line = s->work_line;
184 switch (n_coef_lf[filter]) {
186 for (i = 0; i < linesize; i++) {
187 *work_line += *in_lines_cur[0]++ * coef_lf[filter][0];
188 *work_line++ += *in_lines_cur[1]++ * coef_lf[filter][1];
192 for (i = 0; i < linesize; i++) {
193 *work_line += *in_lines_cur[0]++ * coef_lf[filter][0];
194 *work_line += *in_lines_cur[1]++ * coef_lf[filter][1];
195 *work_line += *in_lines_cur[2]++ * coef_lf[filter][2];
196 *work_line++ += *in_lines_cur[3]++ * coef_lf[filter][3];
200 /* get high vertical frequencies from adjacent fields */
201 for (j = 0; j < n_coef_hf[filter]; j++) {
202 y_in = (y_out + 1) + (j * 2) - n_coef_hf[filter];
206 while (y_in >= height)
209 in_lines_cur[j] = cur_data + (y_in * cur_line_stride);
210 in_lines_adj[j] = adj_data + (y_in * adj_line_stride);
213 work_line = s->work_line;
214 switch (n_coef_hf[filter]) {
216 for (i = 0; i < linesize; i++) {
217 *work_line += *in_lines_cur[0]++ * coef_hf[filter][0];
218 *work_line += *in_lines_adj[0]++ * coef_hf[filter][0];
219 *work_line += *in_lines_cur[1]++ * coef_hf[filter][1];
220 *work_line += *in_lines_adj[1]++ * coef_hf[filter][1];
221 *work_line += *in_lines_cur[2]++ * coef_hf[filter][2];
222 *work_line++ += *in_lines_adj[2]++ * coef_hf[filter][2];
226 for (i = 0; i < linesize; i++) {
227 *work_line += *in_lines_cur[0]++ * coef_hf[filter][0];
228 *work_line += *in_lines_adj[0]++ * coef_hf[filter][0];
229 *work_line += *in_lines_cur[1]++ * coef_hf[filter][1];
230 *work_line += *in_lines_adj[1]++ * coef_hf[filter][1];
231 *work_line += *in_lines_cur[2]++ * coef_hf[filter][2];
232 *work_line += *in_lines_adj[2]++ * coef_hf[filter][2];
233 *work_line += *in_lines_cur[3]++ * coef_hf[filter][3];
234 *work_line += *in_lines_adj[3]++ * coef_hf[filter][3];
235 *work_line += *in_lines_cur[4]++ * coef_hf[filter][4];
236 *work_line++ += *in_lines_adj[4]++ * coef_hf[filter][4];
240 /* save scaled result to the output frame, scaling down by 256 * 256 */
241 work_pixel = s->work_line;
242 out_pixel = out_line;
244 for (j = 0; j < linesize; j++, out_pixel++, work_pixel++)
245 *out_pixel = av_clip(*work_pixel, 0, 255 * 256 * 256) >> 16;
247 /* move on to next line */
249 out_line += dst_line_stride * 2;
253 static int filter(AVFilterContext *ctx, int is_second)
255 W3FDIFContext *s = ctx->priv;
256 AVFilterLink *outlink = ctx->outputs[0];
260 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
262 return AVERROR(ENOMEM);
263 av_frame_copy_props(out, s->cur);
264 out->interlaced_frame = 0;
267 if (out->pts != AV_NOPTS_VALUE)
270 int64_t cur_pts = s->cur->pts;
271 int64_t next_pts = s->next->pts;
273 if (next_pts != AV_NOPTS_VALUE && cur_pts != AV_NOPTS_VALUE) {
274 out->pts = cur_pts + next_pts;
276 out->pts = AV_NOPTS_VALUE;
280 adj = s->field ? s->next : s->prev;
281 for (plane = 0; plane < s->nb_planes; plane++)
282 deinterlace_plane(ctx, out, s->cur, adj, s->filter, plane);
284 s->field = !s->field;
286 return ff_filter_frame(outlink, out);
289 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
291 AVFilterContext *ctx = inlink->dst;
292 W3FDIFContext *s = ctx->priv;
295 av_frame_free(&s->prev);
301 s->cur = av_frame_clone(s->next);
303 return AVERROR(ENOMEM);
306 if ((s->deint && !s->cur->interlaced_frame) || ctx->is_disabled) {
307 AVFrame *out = av_frame_clone(s->cur);
309 return AVERROR(ENOMEM);
311 av_frame_free(&s->prev);
312 if (out->pts != AV_NOPTS_VALUE)
314 return ff_filter_frame(ctx->outputs[0], out);
320 ret = filter(ctx, 0);
324 return filter(ctx, 1);
327 static int request_frame(AVFilterLink *outlink)
329 AVFilterContext *ctx = outlink->src;
330 W3FDIFContext *s = ctx->priv;
338 ret = ff_request_frame(ctx->inputs[0]);
340 if (ret == AVERROR_EOF && s->cur) {
341 AVFrame *next = av_frame_clone(s->next);
343 return AVERROR(ENOMEM);
344 next->pts = s->next->pts * 2 - s->cur->pts;
345 filter_frame(ctx->inputs[0], next);
347 } else if (ret < 0) {
355 static av_cold void uninit(AVFilterContext *ctx)
357 W3FDIFContext *s = ctx->priv;
359 av_frame_free(&s->prev);
360 av_frame_free(&s->cur );
361 av_frame_free(&s->next);
362 av_freep(&s->work_line);
365 static const AVFilterPad w3fdif_inputs[] = {
368 .type = AVMEDIA_TYPE_VIDEO,
369 .filter_frame = filter_frame,
370 .config_props = config_input,
375 static const AVFilterPad w3fdif_outputs[] = {
378 .type = AVMEDIA_TYPE_VIDEO,
379 .config_props = config_output,
380 .request_frame = request_frame,
385 AVFilter ff_vf_w3fdif = {
387 .description = NULL_IF_CONFIG_SMALL("Apply Martin Weston three field deinterlace."),
388 .priv_size = sizeof(W3FDIFContext),
389 .priv_class = &w3fdif_class,
391 .query_formats = query_formats,
392 .inputs = w3fdif_inputs,
393 .outputs = w3fdif_outputs,
394 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,