avfilter/yadif: simplify the code for better readability
[ffmpeg.git] / libavfilter / vf_bwdif.c
1 /*
2  * BobWeaver Deinterlacing Filter
3  * Copyright (C) 2016 Thomas Mundt <loudmax@yahoo.de>
4  *
5  * Based on YADIF (Yet Another Deinterlacing Filter)
6  * Copyright (C) 2006-2011 Michael Niedermayer <michaelni@gmx.at>
7  *               2010      James Darnley <james.darnley@gmail.com>
8  *
9  * With use of Weston 3 Field Deinterlacing Filter algorithm
10  * Copyright (C) 2012 British Broadcasting Corporation, All Rights Reserved
11  * Author of de-interlace algorithm: Jim Easterbrook for BBC R&D
12  * Based on the process described by Martin Weston for BBC R&D
13  *
14  * This file is part of FFmpeg.
15  *
16  * FFmpeg is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  *
21  * FFmpeg is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  *
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with FFmpeg; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #include "libavutil/avassert.h"
32 #include "libavutil/common.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/pixdesc.h"
35 #include "libavutil/imgutils.h"
36 #include "avfilter.h"
37 #include "formats.h"
38 #include "internal.h"
39 #include "video.h"
40 #include "bwdif.h"
41
42 /*
43  * Filter coefficients coef_lf and coef_hf taken from BBC PH-2071 (Weston 3 Field Deinterlacer).
44  * Used when there is spatial and temporal interpolation.
45  * Filter coefficients coef_sp are used when there is spatial interpolation only.
46  * Adjusted for matching visual sharpness impression of spatial and temporal interpolation.
47  */
48 static const uint16_t coef_lf[2] = { 4309, 213 };
49 static const uint16_t coef_hf[3] = { 5570, 3801, 1016 };
50 static const uint16_t coef_sp[2] = { 5077, 981 };
51
52 typedef struct ThreadData {
53     AVFrame *frame;
54     int plane;
55     int w, h;
56     int parity;
57     int tff;
58 } ThreadData;
59
60 #define FILTER_INTRA() \
61     for (x = 0; x < w; x++) { \
62         interpol = (coef_sp[0] * (cur[mrefs] + cur[prefs]) - coef_sp[1] * (cur[mrefs3] + cur[prefs3])) >> 13; \
63         dst[0] = av_clip(interpol, 0, clip_max); \
64  \
65         dst++; \
66         cur++; \
67     }
68
69 #define FILTER1() \
70     for (x = 0; x < w; x++) { \
71         int c = cur[mrefs]; \
72         int d = (prev2[0] + next2[0]) >> 1; \
73         int e = cur[prefs]; \
74         int temporal_diff0 = FFABS(prev2[0] - next2[0]); \
75         int temporal_diff1 =(FFABS(prev[mrefs] - c) + FFABS(prev[prefs] - e)) >> 1; \
76         int temporal_diff2 =(FFABS(next[mrefs] - c) + FFABS(next[prefs] - e)) >> 1; \
77         int diff = FFMAX3(temporal_diff0 >> 1, temporal_diff1, temporal_diff2); \
78  \
79         if (!diff) { \
80             dst[0] = d; \
81         } else {
82
83 #define SPAT_CHECK() \
84             int b = ((prev2[mrefs2] + next2[mrefs2]) >> 1) - c; \
85             int f = ((prev2[prefs2] + next2[prefs2]) >> 1) - e; \
86             int dc = d - c; \
87             int de = d - e; \
88             int max = FFMAX3(de, dc, FFMIN(b, f)); \
89             int min = FFMIN3(de, dc, FFMAX(b, f)); \
90             diff = FFMAX3(diff, min, -max);
91
92 #define FILTER_LINE() \
93             SPAT_CHECK() \
94             if (FFABS(c - e) > temporal_diff0) { \
95                 interpol = (((coef_hf[0] * (prev2[0] + next2[0]) \
96                     - coef_hf[1] * (prev2[mrefs2] + next2[mrefs2] + prev2[prefs2] + next2[prefs2]) \
97                     + coef_hf[2] * (prev2[mrefs4] + next2[mrefs4] + prev2[prefs4] + next2[prefs4])) >> 2) \
98                     + coef_lf[0] * (c + e) - coef_lf[1] * (cur[mrefs3] + cur[prefs3])) >> 13; \
99             } else { \
100                 interpol = (coef_sp[0] * (c + e) - coef_sp[1] * (cur[mrefs3] + cur[prefs3])) >> 13; \
101             }
102
103 #define FILTER_EDGE() \
104             if (spat) { \
105                 SPAT_CHECK() \
106             } \
107             interpol = (c + e) >> 1;
108
109 #define FILTER2() \
110             if (interpol > d + diff) \
111                 interpol = d + diff; \
112             else if (interpol < d - diff) \
113                 interpol = d - diff; \
114  \
115             dst[0] = av_clip(interpol, 0, clip_max); \
116         } \
117  \
118         dst++; \
119         cur++; \
120         prev++; \
121         next++; \
122         prev2++; \
123         next2++; \
124     }
125
126 static void filter_intra(void *dst1, void *cur1, int w, int prefs, int mrefs,
127                          int prefs3, int mrefs3, int parity, int clip_max)
128 {
129     uint8_t *dst = dst1;
130     uint8_t *cur = cur1;
131     int interpol, x;
132
133     FILTER_INTRA()
134 }
135
136 static void filter_line_c(void *dst1, void *prev1, void *cur1, void *next1,
137                           int w, int prefs, int mrefs, int prefs2, int mrefs2,
138                           int prefs3, int mrefs3, int prefs4, int mrefs4,
139                           int parity, int clip_max)
140 {
141     uint8_t *dst   = dst1;
142     uint8_t *prev  = prev1;
143     uint8_t *cur   = cur1;
144     uint8_t *next  = next1;
145     uint8_t *prev2 = parity ? prev : cur ;
146     uint8_t *next2 = parity ? cur  : next;
147     int interpol, x;
148
149     FILTER1()
150     FILTER_LINE()
151     FILTER2()
152 }
153
154 static void filter_edge(void *dst1, void *prev1, void *cur1, void *next1,
155                         int w, int prefs, int mrefs, int prefs2, int mrefs2,
156                         int parity, int clip_max, int spat)
157 {
158     uint8_t *dst   = dst1;
159     uint8_t *prev  = prev1;
160     uint8_t *cur   = cur1;
161     uint8_t *next  = next1;
162     uint8_t *prev2 = parity ? prev : cur ;
163     uint8_t *next2 = parity ? cur  : next;
164     int interpol, x;
165
166     FILTER1()
167     FILTER_EDGE()
168     FILTER2()
169 }
170
171 static void filter_intra_16bit(void *dst1, void *cur1, int w, int prefs, int mrefs,
172                                int prefs3, int mrefs3, int parity, int clip_max)
173 {
174     uint16_t *dst = dst1;
175     uint16_t *cur = cur1;
176     int interpol, x;
177
178     FILTER_INTRA()
179 }
180
181 static void filter_line_c_16bit(void *dst1, void *prev1, void *cur1, void *next1,
182                                 int w, int prefs, int mrefs, int prefs2, int mrefs2,
183                                 int prefs3, int mrefs3, int prefs4, int mrefs4,
184                                 int parity, int clip_max)
185 {
186     uint16_t *dst   = dst1;
187     uint16_t *prev  = prev1;
188     uint16_t *cur   = cur1;
189     uint16_t *next  = next1;
190     uint16_t *prev2 = parity ? prev : cur ;
191     uint16_t *next2 = parity ? cur  : next;
192     int interpol, x;
193
194     FILTER1()
195     FILTER_LINE()
196     FILTER2()
197 }
198
199 static void filter_edge_16bit(void *dst1, void *prev1, void *cur1, void *next1,
200                               int w, int prefs, int mrefs, int prefs2, int mrefs2,
201                               int parity, int clip_max, int spat)
202 {
203     uint16_t *dst   = dst1;
204     uint16_t *prev  = prev1;
205     uint16_t *cur   = cur1;
206     uint16_t *next  = next1;
207     uint16_t *prev2 = parity ? prev : cur ;
208     uint16_t *next2 = parity ? cur  : next;
209     int interpol, x;
210
211     FILTER1()
212     FILTER_EDGE()
213     FILTER2()
214 }
215
216 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
217 {
218     BWDIFContext *s = ctx->priv;
219     YADIFContext *yadif = &s->yadif;
220     ThreadData *td  = arg;
221     int linesize = yadif->cur->linesize[td->plane];
222     int clip_max = (1 << (yadif->depth)) - 1;
223     int df = (yadif->depth + 7) / 8;
224     int refs = linesize / df;
225     int slice_start = (td->h *  jobnr   ) / nb_jobs;
226     int slice_end   = (td->h * (jobnr+1)) / nb_jobs;
227     int y;
228
229     for (y = slice_start; y < slice_end; y++) {
230         if ((y ^ td->parity) & 1) {
231             uint8_t *prev = &yadif->prev->data[td->plane][y * linesize];
232             uint8_t *cur  = &yadif->cur ->data[td->plane][y * linesize];
233             uint8_t *next = &yadif->next->data[td->plane][y * linesize];
234             uint8_t *dst  = &td->frame->data[td->plane][y * td->frame->linesize[td->plane]];
235             if (yadif->current_field == YADIF_FIELD_END) {
236                 s->filter_intra(dst, cur, td->w, (y + df) < td->h ? refs : -refs,
237                                 y > (df - 1) ? -refs : refs,
238                                 (y + 3*df) < td->h ? 3 * refs : -refs,
239                                 y > (3*df - 1) ? -3 * refs : refs,
240                                 td->parity ^ td->tff, clip_max);
241             } else if ((y < 4) || ((y + 5) > td->h)) {
242                 s->filter_edge(dst, prev, cur, next, td->w,
243                                (y + df) < td->h ? refs : -refs,
244                                y > (df - 1) ? -refs : refs,
245                                refs << 1, -(refs << 1),
246                                td->parity ^ td->tff, clip_max,
247                                (y < 2) || ((y + 3) > td->h) ? 0 : 1);
248             } else {
249                 s->filter_line(dst, prev, cur, next, td->w,
250                                refs, -refs, refs << 1, -(refs << 1),
251                                3 * refs, -3 * refs, refs << 2, -(refs << 2),
252                                td->parity ^ td->tff, clip_max);
253             }
254         } else {
255             memcpy(&td->frame->data[td->plane][y * td->frame->linesize[td->plane]],
256                    &yadif->cur->data[td->plane][y * linesize], td->w * df);
257         }
258     }
259     return 0;
260 }
261
262 static void filter(AVFilterContext *ctx, AVFrame *dstpic,
263                    int parity, int tff)
264 {
265     BWDIFContext *bwdif = ctx->priv;
266     YADIFContext *yadif = &bwdif->yadif;
267     ThreadData td = { .frame = dstpic, .parity = parity, .tff = tff };
268     int i;
269
270     for (i = 0; i < yadif->nb_components; i++) {
271         int w = dstpic->width;
272         int h = dstpic->height;
273
274         if (i == 1 || i == 2) {
275             w = AV_CEIL_RSHIFT(w, yadif->hsub);
276             h = AV_CEIL_RSHIFT(h, yadif->vsub);
277         }
278
279         td.w     = w;
280         td.h     = h;
281         td.plane = i;
282
283         ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(h, ff_filter_get_nb_threads(ctx)));
284     }
285     if (yadif->current_field == YADIF_FIELD_END) {
286         yadif->current_field = YADIF_FIELD_NORMAL;
287     }
288
289     emms_c();
290 }
291
292 static av_cold void uninit(AVFilterContext *ctx)
293 {
294     BWDIFContext *bwdif = ctx->priv;
295     YADIFContext *yadif = &bwdif->yadif;
296
297     av_frame_free(&yadif->prev);
298     av_frame_free(&yadif->cur );
299     av_frame_free(&yadif->next);
300 }
301
302 static int query_formats(AVFilterContext *ctx)
303 {
304     static const enum AVPixelFormat pix_fmts[] = {
305         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV420P,
306         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
307         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P,
308         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
309         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
310         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
311         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12,
312         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
313         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
314         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
315         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
316         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
317         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
318         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
319         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
320         AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP16,
321         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16,
322         AV_PIX_FMT_NONE
323     };
324
325     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
326     if (!fmts_list)
327         return AVERROR(ENOMEM);
328
329     return ff_set_common_formats(ctx, fmts_list);
330 }
331
332 static int config_props(AVFilterLink *link)
333 {
334     AVFilterContext *ctx = link->src;
335     BWDIFContext *s = link->src->priv;
336     YADIFContext *yadif = &s->yadif;
337
338     link->time_base.num = link->src->inputs[0]->time_base.num;
339     link->time_base.den = link->src->inputs[0]->time_base.den * 2;
340     link->w             = link->src->inputs[0]->w;
341     link->h             = link->src->inputs[0]->h;
342
343     if(yadif->mode&1)
344         link->frame_rate = av_mul_q(link->src->inputs[0]->frame_rate, (AVRational){2,1});
345
346     if (link->w < 3 || link->h < 4) {
347         av_log(ctx, AV_LOG_ERROR, "Video of less than 3 columns or 4 lines is not supported\n");
348         return AVERROR(EINVAL);
349     }
350
351     yadif->filter = filter;
352     if (yadif->depth > 8) {
353         s->filter_intra = filter_intra_16bit;
354         s->filter_line  = filter_line_c_16bit;
355         s->filter_edge  = filter_edge_16bit;
356     } else {
357         s->filter_intra = filter_intra;
358         s->filter_line  = filter_line_c;
359         s->filter_edge  = filter_edge;
360     }
361
362     if (ARCH_X86)
363         ff_bwdif_init_x86(s);
364
365     return 0;
366 }
367
368
369 #define OFFSET(x) offsetof(YADIFContext, x)
370 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
371
372 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, INT_MIN, INT_MAX, FLAGS, unit }
373
374 static const AVOption bwdif_options[] = {
375     { "mode",   "specify the interlacing mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=YADIF_MODE_SEND_FIELD}, 0, 1, FLAGS, "mode"},
376     CONST("send_frame", "send one frame for each frame", YADIF_MODE_SEND_FRAME, "mode"),
377     CONST("send_field", "send one frame for each field", YADIF_MODE_SEND_FIELD, "mode"),
378
379     { "parity", "specify the assumed picture field parity", OFFSET(parity), AV_OPT_TYPE_INT, {.i64=YADIF_PARITY_AUTO}, -1, 1, FLAGS, "parity" },
380     CONST("tff",  "assume top field first",    YADIF_PARITY_TFF,  "parity"),
381     CONST("bff",  "assume bottom field first", YADIF_PARITY_BFF,  "parity"),
382     CONST("auto", "auto detect parity",        YADIF_PARITY_AUTO, "parity"),
383
384     { "deint", "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=YADIF_DEINT_ALL}, 0, 1, FLAGS, "deint" },
385     CONST("all",        "deinterlace all frames",                       YADIF_DEINT_ALL,        "deint"),
386     CONST("interlaced", "only deinterlace frames marked as interlaced", YADIF_DEINT_INTERLACED, "deint"),
387
388     { NULL }
389 };
390
391 AVFILTER_DEFINE_CLASS(bwdif);
392
393 static const AVFilterPad avfilter_vf_bwdif_inputs[] = {
394     {
395         .name          = "default",
396         .type          = AVMEDIA_TYPE_VIDEO,
397         .filter_frame  = ff_yadif_filter_frame,
398     },
399     { NULL }
400 };
401
402 static const AVFilterPad avfilter_vf_bwdif_outputs[] = {
403     {
404         .name          = "default",
405         .type          = AVMEDIA_TYPE_VIDEO,
406         .request_frame = ff_yadif_request_frame,
407         .config_props  = config_props,
408     },
409     { NULL }
410 };
411
412 AVFilter ff_vf_bwdif = {
413     .name          = "bwdif",
414     .description   = NULL_IF_CONFIG_SMALL("Deinterlace the input image."),
415     .priv_size     = sizeof(BWDIFContext),
416     .priv_class    = &bwdif_class,
417     .uninit        = uninit,
418     .query_formats = query_formats,
419     .inputs        = avfilter_vf_bwdif_inputs,
420     .outputs       = avfilter_vf_bwdif_outputs,
421     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
422 };