yadif: remove unused variable
[ffmpeg.git] / libavfilter / vf_yadif.c
1 /*
2  * Copyright (C) 2006-2011 Michael Niedermayer <michaelni@gmx.at>
3  *               2010      James Darnley <james.darnley@gmail.com>
4  *
5  * FFmpeg is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19
20 #include "libavutil/avassert.h"
21 #include "libavutil/cpu.h"
22 #include "libavutil/common.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 #include "avfilter.h"
26 #include "formats.h"
27 #include "internal.h"
28 #include "video.h"
29 #include "yadif.h"
30
31 #undef NDEBUG
32 #include <assert.h>
33
34 #define PERM_RWP AV_PERM_WRITE | AV_PERM_PRESERVE | AV_PERM_REUSE
35
36 #define CHECK(j)\
37     {   int score = FFABS(cur[mrefs + off_left + (j)] - cur[prefs + off_left - (j)])\
38                   + FFABS(cur[mrefs  +(j)] - cur[prefs  -(j)])\
39                   + FFABS(cur[mrefs + off_right + (j)] - cur[prefs + off_right - (j)]);\
40         if (score < spatial_score) {\
41             spatial_score= score;\
42             spatial_pred= (cur[mrefs  +(j)] + cur[prefs  -(j)])>>1;\
43
44 #define FILTER(start, end) \
45     for (x = start;  x < end; x++) { \
46         int c = cur[mrefs]; \
47         int d = (prev2[0] + next2[0])>>1; \
48         int e = cur[prefs]; \
49         int temporal_diff0 = FFABS(prev2[0] - next2[0]); \
50         int temporal_diff1 =(FFABS(prev[mrefs] - c) + FFABS(prev[prefs] - e) )>>1; \
51         int temporal_diff2 =(FFABS(next[mrefs] - c) + FFABS(next[prefs] - e) )>>1; \
52         int diff = FFMAX3(temporal_diff0 >> 1, temporal_diff1, temporal_diff2); \
53         int spatial_pred = (c+e) >> 1; \
54         int off_right = (x < w - 1) ? 1 : -1;\
55         int off_left  = x ? -1 : 1;\
56         int spatial_score = FFABS(cur[mrefs + off_left]  - cur[prefs + off_left]) + FFABS(c-e) \
57                           + FFABS(cur[mrefs + off_right] - cur[prefs + off_right]) - 1; \
58  \
59         if (x > 2 && x < w - 3) {\
60             CHECK(-1) CHECK(-2) }} }} \
61             CHECK( 1) CHECK( 2) }} }} \
62         }\
63  \
64         if (mode < 2) { \
65             int b = (prev2[2 * mrefs] + next2[2 * mrefs])>>1; \
66             int f = (prev2[2 * prefs] + next2[2 * prefs])>>1; \
67             int max = FFMAX3(d - e, d - c, FFMIN(b - c, f - e)); \
68             int min = FFMIN3(d - e, d - c, FFMAX(b - c, f - e)); \
69  \
70             diff = FFMAX3(diff, min, -max); \
71         } \
72  \
73         if (spatial_pred > d + diff) \
74            spatial_pred = d + diff; \
75         else if (spatial_pred < d - diff) \
76            spatial_pred = d - diff; \
77  \
78         dst[0] = spatial_pred; \
79  \
80         dst++; \
81         cur++; \
82         prev++; \
83         next++; \
84         prev2++; \
85         next2++; \
86     }
87
88 static void filter_line_c(void *dst1,
89                           void *prev1, void *cur1, void *next1,
90                           int w, int prefs, int mrefs, int parity, int mode)
91 {
92     uint8_t *dst  = dst1;
93     uint8_t *prev = prev1;
94     uint8_t *cur  = cur1;
95     uint8_t *next = next1;
96     int x;
97     uint8_t *prev2 = parity ? prev : cur ;
98     uint8_t *next2 = parity ? cur  : next;
99
100     FILTER(0, w)
101 }
102
103 static void filter_edges(void *dst1, void *prev1, void *cur1, void *next1,
104                          int w, int prefs, int mrefs, int parity, int mode,
105                          int l_edge)
106 {
107     uint8_t *dst  = dst1;
108     uint8_t *prev = prev1;
109     uint8_t *cur  = cur1;
110     uint8_t *next = next1;
111     int x;
112     uint8_t *prev2 = parity ? prev : cur ;
113     uint8_t *next2 = parity ? cur  : next;
114
115     FILTER(0, l_edge)
116
117     dst  = (uint8_t*)dst1  + w - 3;
118     prev = (uint8_t*)prev1 + w - 3;
119     cur  = (uint8_t*)cur1  + w - 3;
120     next = (uint8_t*)next1 + w - 3;
121     prev2 = (uint8_t*)(parity ? prev : cur);
122     next2 = (uint8_t*)(parity ? cur  : next);
123
124     FILTER(w - 3, w)
125 }
126
127
128 static void filter_line_c_16bit(void *dst1,
129                                 void *prev1, void *cur1, void *next1,
130                                 int w, int prefs, int mrefs, int parity,
131                                 int mode)
132 {
133     uint16_t *dst  = dst1;
134     uint16_t *prev = prev1;
135     uint16_t *cur  = cur1;
136     uint16_t *next = next1;
137     int x;
138     uint16_t *prev2 = parity ? prev : cur ;
139     uint16_t *next2 = parity ? cur  : next;
140     mrefs /= 2;
141     prefs /= 2;
142
143     FILTER(0, w)
144 }
145
146 static void filter_edges_16bit(void *dst1, void *prev1, void *cur1, void *next1,
147                                int w, int prefs, int mrefs, int parity, int mode,
148                                int l_edge)
149 {
150     uint16_t *dst  = dst1;
151     uint16_t *prev = prev1;
152     uint16_t *cur  = cur1;
153     uint16_t *next = next1;
154     int x;
155     uint16_t *prev2 = parity ? prev : cur ;
156     uint16_t *next2 = parity ? cur  : next;
157
158     FILTER(0, l_edge)
159
160     dst   = (uint16_t*)dst1  + w - 3;
161     prev  = (uint16_t*)prev1 + w - 3;
162     cur   = (uint16_t*)cur1  + w - 3;
163     next  = (uint16_t*)next1 + w - 3;
164     prev2 = (uint16_t*)(parity ? prev : cur);
165     next2 = (uint16_t*)(parity ? cur  : next);
166
167     FILTER(w - 3, w)
168 }
169
170 static void filter(AVFilterContext *ctx, AVFilterBufferRef *dstpic,
171                    int parity, int tff)
172 {
173     YADIFContext *yadif = ctx->priv;
174     int y, i;
175
176     for (i = 0; i < yadif->csp->nb_components; i++) {
177         int w = dstpic->video->w;
178         int h = dstpic->video->h;
179         int refs = yadif->cur->linesize[i];
180         int df = (yadif->csp->comp[i].depth_minus1 + 8) / 8;
181         int l_edge, l_edge_pix;
182
183         if (i == 1 || i == 2) {
184         /* Why is this not part of the per-plane description thing? */
185             w >>= yadif->csp->log2_chroma_w;
186             h >>= yadif->csp->log2_chroma_h;
187         }
188
189         /* filtering reads 3 pixels to the left/right; to avoid invalid reads,
190          * we need to call the c variant which avoids this for border pixels
191          */
192         l_edge     = yadif->req_align;
193         l_edge_pix = l_edge / df;
194
195         for (y = 0; y < h; y++) {
196             if ((y ^ parity) & 1) {
197                 uint8_t *prev = &yadif->prev->data[i][y * refs];
198                 uint8_t *cur  = &yadif->cur ->data[i][y * refs];
199                 uint8_t *next = &yadif->next->data[i][y * refs];
200                 uint8_t *dst  = &dstpic->data[i][y * dstpic->linesize[i]];
201                 int     mode  = y == 1 || y + 2 == h ? 2 : yadif->mode;
202                 if (yadif->req_align) {
203                     yadif->filter_line(dst + l_edge, prev + l_edge, cur + l_edge,
204                                        next + l_edge, w - l_edge_pix - 3,
205                                        y + 1 < h ? refs : -refs,
206                                        y ? -refs : refs,
207                                        parity ^ tff, mode);
208                     yadif->filter_edges(dst, prev, cur, next, w,
209                                          y + 1 < h ? refs : -refs,
210                                          y ? -refs : refs,
211                                          parity ^ tff, mode, l_edge_pix);
212                 } else {
213                     yadif->filter_line(dst, prev, cur, next + l_edge, w,
214                                        y + 1 < h ? refs : -refs,
215                                        y ? -refs : refs,
216                                        parity ^ tff, mode);
217                 }
218             } else {
219                 memcpy(&dstpic->data[i][y * dstpic->linesize[i]],
220                        &yadif->cur->data[i][y * refs], w * df);
221             }
222         }
223     }
224
225     emms_c();
226 }
227
228 static int return_frame(AVFilterContext *ctx, int is_second)
229 {
230     YADIFContext *yadif = ctx->priv;
231     AVFilterLink *link  = ctx->outputs[0];
232     int tff, ret;
233
234     if (yadif->parity == -1) {
235         tff = yadif->cur->video->interlaced ?
236               yadif->cur->video->top_field_first : 1;
237     } else {
238         tff = yadif->parity ^ 1;
239     }
240
241     if (is_second) {
242         yadif->out = ff_get_video_buffer(link, PERM_RWP, link->w, link->h);
243         if (!yadif->out)
244             return AVERROR(ENOMEM);
245
246         avfilter_copy_buffer_ref_props(yadif->out, yadif->cur);
247         yadif->out->video->interlaced = 0;
248     }
249
250     filter(ctx, yadif->out, tff ^ !is_second, tff);
251
252     if (is_second) {
253         int64_t cur_pts  = yadif->cur->pts;
254         int64_t next_pts = yadif->next->pts;
255
256         if (next_pts != AV_NOPTS_VALUE && cur_pts != AV_NOPTS_VALUE) {
257             yadif->out->pts = cur_pts + next_pts;
258         } else {
259             yadif->out->pts = AV_NOPTS_VALUE;
260         }
261     }
262     ret = ff_filter_frame(ctx->outputs[0], yadif->out);
263
264     yadif->frame_pending = (yadif->mode&1) && !is_second;
265     return ret;
266 }
267
268 static int filter_frame(AVFilterLink *link, AVFilterBufferRef *picref)
269 {
270     AVFilterContext *ctx = link->dst;
271     YADIFContext *yadif = ctx->priv;
272
273     av_assert0(picref);
274
275     if (yadif->frame_pending)
276         return_frame(ctx, 1);
277
278     if (yadif->prev)
279         avfilter_unref_buffer(yadif->prev);
280     yadif->prev = yadif->cur;
281     yadif->cur  = yadif->next;
282     yadif->next = picref;
283
284     if (!yadif->cur)
285         return 0;
286
287     if (yadif->deint && !yadif->cur->video->interlaced) {
288         yadif->out  = avfilter_ref_buffer(yadif->cur, ~AV_PERM_WRITE);
289         if (!yadif->out)
290             return AVERROR(ENOMEM);
291
292         avfilter_unref_bufferp(&yadif->prev);
293         if (yadif->out->pts != AV_NOPTS_VALUE)
294             yadif->out->pts *= 2;
295         return ff_filter_frame(ctx->outputs[0], yadif->out);
296     }
297
298     if (!yadif->prev &&
299         !(yadif->prev = avfilter_ref_buffer(yadif->cur, ~AV_PERM_WRITE)))
300         return AVERROR(ENOMEM);
301
302     yadif->out = ff_get_video_buffer(ctx->outputs[0], PERM_RWP,
303                                      link->w, link->h);
304     if (!yadif->out)
305         return AVERROR(ENOMEM);
306
307     avfilter_copy_buffer_ref_props(yadif->out, yadif->cur);
308     yadif->out->video->interlaced = 0;
309
310     if (yadif->out->pts != AV_NOPTS_VALUE)
311         yadif->out->pts *= 2;
312
313     return return_frame(ctx, 0);
314 }
315
316 static int request_frame(AVFilterLink *link)
317 {
318     AVFilterContext *ctx = link->src;
319     YADIFContext *yadif = ctx->priv;
320
321     if (yadif->frame_pending) {
322         return_frame(ctx, 1);
323         return 0;
324     }
325
326     do {
327         int ret;
328
329         if (yadif->eof)
330             return AVERROR_EOF;
331
332         ret  = ff_request_frame(link->src->inputs[0]);
333
334         if (ret == AVERROR_EOF && yadif->cur) {
335             AVFilterBufferRef *next = avfilter_ref_buffer(yadif->next, ~AV_PERM_WRITE);
336
337             if (!next)
338                 return AVERROR(ENOMEM);
339
340             next->pts = yadif->next->pts * 2 - yadif->cur->pts;
341
342             filter_frame(link->src->inputs[0], next);
343             yadif->eof = 1;
344         } else if (ret < 0) {
345             return ret;
346         }
347     } while (!yadif->cur);
348
349     return 0;
350 }
351
352 #define OFFSET(x) offsetof(YADIFContext, x)
353 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
354
355 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, INT_MIN, INT_MAX, FLAGS, unit }
356
357 static const AVOption yadif_options[] = {
358     { "mode",   "specify the interlacing mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=YADIF_MODE_SEND_FRAME}, 0, 3, FLAGS, "mode"},
359     CONST("send_frame",           "send one frame for each frame",                                     YADIF_MODE_SEND_FRAME,           "mode"),
360     CONST("send_field",           "send one frame for each field",                                     YADIF_MODE_SEND_FIELD,           "mode"),
361     CONST("send_frame_nospatial", "send one frame for each frame, but skip spatial interlacing check", YADIF_MODE_SEND_FRAME_NOSPATIAL, "mode"),
362     CONST("send_field_nospatial", "send one frame for each field, but skip spatial interlacing check", YADIF_MODE_SEND_FIELD_NOSPATIAL, "mode"),
363
364     { "parity", "specify the assumed picture field parity", OFFSET(parity), AV_OPT_TYPE_INT, {.i64=YADIF_PARITY_AUTO}, -1, 1, FLAGS, "parity" },
365     CONST("tff",  "assume top field first",    YADIF_PARITY_TFF,  "parity"),
366     CONST("bff",  "assume bottom field first", YADIF_PARITY_BFF,  "parity"),
367     CONST("auto", "auto detect parity",        YADIF_PARITY_AUTO, "parity"),
368
369     { "deint", "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=YADIF_DEINT_ALL}, 0, 1, FLAGS, "deint" },
370     CONST("all",        "deinterlace all frames",                       YADIF_DEINT_ALL,         "deint"),
371     CONST("interlaced", "only deinterlace frames marked as interlaced", YADIF_DEINT_INTERLACED,  "deint"),
372
373     {NULL},
374 };
375
376 AVFILTER_DEFINE_CLASS(yadif);
377
378 static av_cold void uninit(AVFilterContext *ctx)
379 {
380     YADIFContext *yadif = ctx->priv;
381
382     avfilter_unref_bufferp(&yadif->prev);
383     avfilter_unref_bufferp(&yadif->cur );
384     avfilter_unref_bufferp(&yadif->next);
385     av_opt_free(yadif);
386 }
387
388 static int query_formats(AVFilterContext *ctx)
389 {
390     static const enum AVPixelFormat pix_fmts[] = {
391         AV_PIX_FMT_YUV420P,
392         AV_PIX_FMT_YUV422P,
393         AV_PIX_FMT_YUV444P,
394         AV_PIX_FMT_YUV410P,
395         AV_PIX_FMT_YUV411P,
396         AV_PIX_FMT_GRAY8,
397         AV_PIX_FMT_YUVJ420P,
398         AV_PIX_FMT_YUVJ422P,
399         AV_PIX_FMT_YUVJ444P,
400         AV_NE( AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_GRAY16LE ),
401         AV_PIX_FMT_YUV440P,
402         AV_PIX_FMT_YUVJ440P,
403         AV_NE( AV_PIX_FMT_YUV420P9BE,  AV_PIX_FMT_YUV420P9LE ),
404         AV_NE( AV_PIX_FMT_YUV422P9BE,  AV_PIX_FMT_YUV422P9LE ),
405         AV_NE( AV_PIX_FMT_YUV444P9BE,  AV_PIX_FMT_YUV444P9LE ),
406         AV_NE( AV_PIX_FMT_YUV420P10BE, AV_PIX_FMT_YUV420P10LE ),
407         AV_NE( AV_PIX_FMT_YUV422P10BE, AV_PIX_FMT_YUV422P10LE ),
408         AV_NE( AV_PIX_FMT_YUV444P10BE, AV_PIX_FMT_YUV444P10LE ),
409         AV_NE( AV_PIX_FMT_YUV420P12BE, AV_PIX_FMT_YUV420P12LE ),
410         AV_NE( AV_PIX_FMT_YUV422P12BE, AV_PIX_FMT_YUV422P12LE ),
411         AV_NE( AV_PIX_FMT_YUV444P12BE, AV_PIX_FMT_YUV444P12LE ),
412         AV_NE( AV_PIX_FMT_YUV420P14BE, AV_PIX_FMT_YUV420P14LE ),
413         AV_NE( AV_PIX_FMT_YUV422P14BE, AV_PIX_FMT_YUV422P14LE ),
414         AV_NE( AV_PIX_FMT_YUV444P14BE, AV_PIX_FMT_YUV444P14LE ),
415         AV_NE( AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUV420P16LE ),
416         AV_NE( AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUV422P16LE ),
417         AV_NE( AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUV444P16LE ),
418         AV_PIX_FMT_YUVA420P,
419         AV_PIX_FMT_YUVA422P,
420         AV_PIX_FMT_YUVA444P,
421         AV_PIX_FMT_NONE
422     };
423
424     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
425
426     return 0;
427 }
428
429 static av_cold int init(AVFilterContext *ctx, const char *args)
430 {
431     YADIFContext *yadif = ctx->priv;
432     static const char *shorthand[] = { "mode", "parity", "deint", NULL };
433     int ret;
434
435     yadif->class = &yadif_class;
436     av_opt_set_defaults(yadif);
437
438     if ((ret = av_opt_set_from_string(yadif, args, shorthand, "=", ":")) < 0)
439         return ret;
440
441     av_log(ctx, AV_LOG_VERBOSE, "mode:%d parity:%d deint:%d\n",
442            yadif->mode, yadif->parity, yadif->deint);
443
444     return 0;
445 }
446
447 static int config_props(AVFilterLink *link)
448 {
449     AVFilterContext *ctx = link->src;
450     YADIFContext *s = link->src->priv;
451
452     link->time_base.num = link->src->inputs[0]->time_base.num;
453     link->time_base.den = link->src->inputs[0]->time_base.den * 2;
454     link->w             = link->src->inputs[0]->w;
455     link->h             = link->src->inputs[0]->h;
456
457     if(s->mode&1)
458         link->frame_rate = av_mul_q(link->src->inputs[0]->frame_rate, (AVRational){2,1});
459
460     if (link->w < 3 || link->h < 3) {
461         av_log(ctx, AV_LOG_ERROR, "Video of less than 3 columns or lines is not supported\n");
462         return AVERROR(EINVAL);
463     }
464
465     s->csp = av_pix_fmt_desc_get(link->format);
466     if (s->csp->comp[0].depth_minus1 / 8 == 1) {
467         s->filter_line  = filter_line_c_16bit;
468         s->filter_edges = filter_edges_16bit;
469     } else {
470         s->filter_line  = filter_line_c;
471         s->filter_edges = filter_edges;
472
473         if (ARCH_X86)
474             ff_yadif_init_x86(s);
475     }
476
477     return 0;
478 }
479
480 static const AVFilterPad avfilter_vf_yadif_inputs[] = {
481     {
482         .name             = "default",
483         .type             = AVMEDIA_TYPE_VIDEO,
484         .filter_frame     = filter_frame,
485         .min_perms        = AV_PERM_PRESERVE,
486     },
487     { NULL }
488 };
489
490 static const AVFilterPad avfilter_vf_yadif_outputs[] = {
491     {
492         .name          = "default",
493         .type          = AVMEDIA_TYPE_VIDEO,
494         .request_frame = request_frame,
495         .config_props  = config_props,
496     },
497     { NULL }
498 };
499
500 AVFilter avfilter_vf_yadif = {
501     .name          = "yadif",
502     .description   = NULL_IF_CONFIG_SMALL("Deinterlace the input image."),
503
504     .priv_size     = sizeof(YADIFContext),
505     .init          = init,
506     .uninit        = uninit,
507     .query_formats = query_formats,
508
509     .inputs    = avfilter_vf_yadif_inputs,
510     .outputs   = avfilter_vf_yadif_outputs,
511
512     .priv_class = &yadif_class,
513 };