Add mode to yadif to enable/disable deinterlacing based on src frame "interlaced...
[ffmpeg.git] / libavfilter / vf_yadif.c
1 /*
2  * Copyright (C) 2006-2010 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/cpu.h"
21 #include "libavutil/common.h"
22 #include "libavutil/pixdesc.h"
23 #include "avfilter.h"
24 #include "yadif.h"
25
26 #undef NDEBUG
27 #include <assert.h>
28
29 typedef struct {
30     /**
31      * 0: send 1 frame for each frame
32      * 1: send 1 frame for each field
33      * 2: like 0 but skips spatial interlacing check
34      * 3: like 1 but skips spatial interlacing check
35      */
36     int mode;
37
38     /**
39      *  0: bottom field first
40      *  1: top field first
41      * -1: auto-detection
42      */
43     int parity;
44
45     int frame_pending;
46
47     /**
48      *  0: deinterlace all frames
49      *  1: only deinterlace frames marked as interlaced
50      */
51     int auto_enable;
52
53     AVFilterBufferRef *cur;
54     AVFilterBufferRef *next;
55     AVFilterBufferRef *prev;
56     AVFilterBufferRef *out;
57     void (*filter_line)(uint8_t *dst,
58                         uint8_t *prev, uint8_t *cur, uint8_t *next,
59                         int w, int prefs, int mrefs, int parity, int mode);
60
61     const AVPixFmtDescriptor *csp;
62 } YADIFContext;
63
64 #define CHECK(j)\
65     {   int score = FFABS(cur[mrefs-1+(j)] - cur[prefs-1-(j)])\
66                   + FFABS(cur[mrefs  +(j)] - cur[prefs  -(j)])\
67                   + FFABS(cur[mrefs+1+(j)] - cur[prefs+1-(j)]);\
68         if (score < spatial_score) {\
69             spatial_score= score;\
70             spatial_pred= (cur[mrefs  +(j)] + cur[prefs  -(j)])>>1;\
71
72 #define FILTER \
73     for (x = 0;  x < w; x++) { \
74         int c = cur[mrefs]; \
75         int d = (prev2[0] + next2[0])>>1; \
76         int e = cur[prefs]; \
77         int temporal_diff0 = FFABS(prev2[0] - next2[0]); \
78         int temporal_diff1 =(FFABS(prev[mrefs] - c) + FFABS(prev[prefs] - e) )>>1; \
79         int temporal_diff2 =(FFABS(next[mrefs] - c) + FFABS(next[prefs] - e) )>>1; \
80         int diff = FFMAX3(temporal_diff0>>1, temporal_diff1, temporal_diff2); \
81         int spatial_pred = (c+e)>>1; \
82         int spatial_score = FFABS(cur[mrefs-1] - cur[prefs-1]) + FFABS(c-e) \
83                           + FFABS(cur[mrefs+1] - cur[prefs+1]) - 1; \
84  \
85         CHECK(-1) CHECK(-2) }} }} \
86         CHECK( 1) CHECK( 2) }} }} \
87  \
88         if (mode < 2) { \
89             int b = (prev2[2*mrefs] + next2[2*mrefs])>>1; \
90             int f = (prev2[2*prefs] + next2[2*prefs])>>1; \
91             int max = FFMAX3(d-e, d-c, FFMIN(b-c, f-e)); \
92             int min = FFMIN3(d-e, d-c, FFMAX(b-c, f-e)); \
93  \
94             diff = FFMAX3(diff, min, -max); \
95         } \
96  \
97         if (spatial_pred > d + diff) \
98            spatial_pred = d + diff; \
99         else if (spatial_pred < d - diff) \
100            spatial_pred = d - diff; \
101  \
102         dst[0] = spatial_pred; \
103  \
104         dst++; \
105         cur++; \
106         prev++; \
107         next++; \
108         prev2++; \
109         next2++; \
110     }
111
112 static void filter_line_c(uint8_t *dst,
113                           uint8_t *prev, uint8_t *cur, uint8_t *next,
114                           int w, int prefs, int mrefs, int parity, int mode)
115 {
116     int x;
117     uint8_t *prev2 = parity ? prev : cur ;
118     uint8_t *next2 = parity ? cur  : next;
119
120     FILTER
121 }
122
123 static void filter_line_c_16bit(uint16_t *dst,
124                                 uint16_t *prev, uint16_t *cur, uint16_t *next,
125                                 int w, int prefs, int mrefs, int parity, int mode)
126 {
127     int x;
128     uint16_t *prev2 = parity ? prev : cur ;
129     uint16_t *next2 = parity ? cur  : next;
130     mrefs /= 2;
131     prefs /= 2;
132
133     FILTER
134 }
135
136 static void filter(AVFilterContext *ctx, AVFilterBufferRef *dstpic,
137                    int parity, int tff)
138 {
139     YADIFContext *yadif = ctx->priv;
140     int y, i;
141
142     for (i = 0; i < yadif->csp->nb_components; i++) {
143         int w = dstpic->video->w;
144         int h = dstpic->video->h;
145         int refs = yadif->cur->linesize[i];
146         int df = (yadif->csp->comp[i].depth_minus1+1) / 8;
147
148         if (i) {
149         /* Why is this not part of the per-plane description thing? */
150             w >>= yadif->csp->log2_chroma_w;
151             h >>= yadif->csp->log2_chroma_h;
152         }
153
154         for (y = 0; y < h; y++) {
155             if ((y ^ parity) & 1) {
156                 uint8_t *prev = &yadif->prev->data[i][y*refs];
157                 uint8_t *cur  = &yadif->cur ->data[i][y*refs];
158                 uint8_t *next = &yadif->next->data[i][y*refs];
159                 uint8_t *dst  = &dstpic->data[i][y*dstpic->linesize[i]];
160                 int     mode  = y==1 || y+2==h ? 2 : yadif->mode;
161                 yadif->filter_line(dst, prev, cur, next, w, y+1<h ? refs : -refs, y ? -refs : refs, parity ^ tff, mode);
162             } else {
163                 memcpy(&dstpic->data[i][y*dstpic->linesize[i]],
164                        &yadif->cur->data[i][y*refs], w*df);
165             }
166         }
167     }
168 #if HAVE_MMX
169     __asm__ volatile("emms \n\t" : : : "memory");
170 #endif
171 }
172
173 static AVFilterBufferRef *get_video_buffer(AVFilterLink *link, int perms, int w, int h)
174 {
175     AVFilterBufferRef *picref;
176     int width = FFALIGN(w, 32);
177     int height= FFALIGN(h+2, 32);
178     int i;
179
180     picref = avfilter_default_get_video_buffer(link, perms, width, height);
181
182     picref->video->w = w;
183     picref->video->h = h;
184
185     for (i = 0; i < 3; i++)
186         picref->data[i] += picref->linesize[i];
187
188     return picref;
189 }
190
191 static void return_frame(AVFilterContext *ctx, int is_second)
192 {
193     YADIFContext *yadif = ctx->priv;
194     AVFilterLink *link= ctx->outputs[0];
195     int tff;
196
197     if (yadif->parity == -1) {
198         tff = yadif->cur->video->interlaced ?
199             yadif->cur->video->top_field_first : 1;
200     } else {
201         tff = yadif->parity^1;
202     }
203
204     if (is_second)
205         yadif->out = avfilter_get_video_buffer(link, AV_PERM_WRITE | AV_PERM_PRESERVE |
206                                                AV_PERM_REUSE, link->w, link->h);
207
208     if (!yadif->csp)
209         yadif->csp = &av_pix_fmt_descriptors[link->format];
210     if (yadif->csp->comp[0].depth_minus1 == 15)
211         yadif->filter_line = filter_line_c_16bit;
212
213     filter(ctx, yadif->out, tff ^ !is_second, tff);
214
215     if (is_second) {
216         if (yadif->next->pts != AV_NOPTS_VALUE &&
217             yadif->cur->pts != AV_NOPTS_VALUE) {
218             yadif->out->pts =
219                 (yadif->next->pts&yadif->cur->pts) +
220                 ((yadif->next->pts^yadif->cur->pts)>>1);
221         } else {
222             yadif->out->pts = AV_NOPTS_VALUE;
223         }
224         avfilter_start_frame(ctx->outputs[0], yadif->out);
225     }
226     avfilter_draw_slice(ctx->outputs[0], 0, link->h, 1);
227     avfilter_end_frame(ctx->outputs[0]);
228
229     yadif->frame_pending = (yadif->mode&1) && !is_second;
230 }
231
232 static void start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
233 {
234     AVFilterContext *ctx = link->dst;
235     YADIFContext *yadif = ctx->priv;
236
237     if (yadif->frame_pending)
238         return_frame(ctx, 1);
239
240     if (yadif->prev)
241         avfilter_unref_buffer(yadif->prev);
242     yadif->prev = yadif->cur;
243     yadif->cur  = yadif->next;
244     yadif->next = picref;
245
246     if (!yadif->cur)
247         return;
248
249     if (yadif->auto_enable && !yadif->cur->video->interlaced) {
250         yadif->out  = avfilter_ref_buffer(yadif->cur, AV_PERM_READ);
251         avfilter_unref_buffer(yadif->prev);
252         yadif->prev = NULL;
253         avfilter_start_frame(ctx->outputs[0], yadif->out);
254         return;
255     }
256
257     if (!yadif->prev)
258         yadif->prev = avfilter_ref_buffer(yadif->cur, AV_PERM_READ);
259
260     yadif->out = avfilter_get_video_buffer(ctx->outputs[0], AV_PERM_WRITE | AV_PERM_PRESERVE |
261                                        AV_PERM_REUSE, link->w, link->h);
262
263     avfilter_copy_buffer_ref_props(yadif->out, yadif->cur);
264     yadif->out->video->interlaced = 0;
265     avfilter_start_frame(ctx->outputs[0], yadif->out);
266 }
267
268 static void end_frame(AVFilterLink *link)
269 {
270     AVFilterContext *ctx = link->dst;
271     YADIFContext *yadif = ctx->priv;
272
273     if (!yadif->out)
274         return;
275
276     if (yadif->auto_enable && !yadif->cur->video->interlaced) {
277         avfilter_draw_slice(ctx->outputs[0], 0, link->h, 1);
278         avfilter_end_frame(ctx->outputs[0]);
279         return;
280     }
281
282     return_frame(ctx, 0);
283 }
284
285 static int request_frame(AVFilterLink *link)
286 {
287     AVFilterContext *ctx = link->src;
288     YADIFContext *yadif = ctx->priv;
289
290     if (yadif->frame_pending) {
291         return_frame(ctx, 1);
292         return 0;
293     }
294
295     do {
296         int ret;
297
298         if ((ret = avfilter_request_frame(link->src->inputs[0])))
299             return ret;
300     } while (!yadif->cur);
301
302     return 0;
303 }
304
305 static int poll_frame(AVFilterLink *link)
306 {
307     YADIFContext *yadif = link->src->priv;
308     int ret, val;
309
310     if (yadif->frame_pending)
311         return 1;
312
313     val = avfilter_poll_frame(link->src->inputs[0]);
314
315     if (val==1 && !yadif->next) { //FIXME change API to not requre this red tape
316         if ((ret = avfilter_request_frame(link->src->inputs[0])) < 0)
317             return ret;
318         val = avfilter_poll_frame(link->src->inputs[0]);
319     }
320     assert(yadif->next || !val);
321
322     if (yadif->auto_enable && yadif->next && !yadif->next->video->interlaced)
323         return val;
324
325     return val * ((yadif->mode&1)+1);
326 }
327
328 static av_cold void uninit(AVFilterContext *ctx)
329 {
330     YADIFContext *yadif = ctx->priv;
331
332     if (yadif->prev) avfilter_unref_buffer(yadif->prev);
333     if (yadif->cur ) avfilter_unref_buffer(yadif->cur );
334     if (yadif->next) avfilter_unref_buffer(yadif->next);
335 }
336
337 static int query_formats(AVFilterContext *ctx)
338 {
339     static const enum PixelFormat pix_fmts[] = {
340         PIX_FMT_YUV420P,
341         PIX_FMT_YUV422P,
342         PIX_FMT_YUV444P,
343         PIX_FMT_YUV410P,
344         PIX_FMT_YUV411P,
345         PIX_FMT_GRAY8,
346         PIX_FMT_YUVJ420P,
347         PIX_FMT_YUVJ422P,
348         PIX_FMT_YUVJ444P,
349         AV_NE( PIX_FMT_GRAY16BE, PIX_FMT_GRAY16LE ),
350         PIX_FMT_YUV440P,
351         PIX_FMT_YUVJ440P,
352         AV_NE( PIX_FMT_YUV420P16BE, PIX_FMT_YUV420P16LE ),
353         AV_NE( PIX_FMT_YUV422P16BE, PIX_FMT_YUV422P16LE ),
354         AV_NE( PIX_FMT_YUV444P16BE, PIX_FMT_YUV444P16LE ),
355         PIX_FMT_NONE
356     };
357
358     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
359
360     return 0;
361 }
362
363 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
364 {
365     YADIFContext *yadif = ctx->priv;
366     av_unused int cpu_flags = av_get_cpu_flags();
367
368     yadif->mode = 0;
369     yadif->parity = -1;
370     yadif->auto_enable = 0;
371     yadif->csp = NULL;
372
373     if (args) sscanf(args, "%d:%d:%d", &yadif->mode, &yadif->parity, &yadif->auto_enable);
374
375     yadif->filter_line = filter_line_c;
376     if (HAVE_SSSE3 && cpu_flags & AV_CPU_FLAG_SSSE3)
377         yadif->filter_line = ff_yadif_filter_line_ssse3;
378     else if (HAVE_SSE && cpu_flags & AV_CPU_FLAG_SSE2)
379         yadif->filter_line = ff_yadif_filter_line_sse2;
380     else if (HAVE_MMX && cpu_flags & AV_CPU_FLAG_MMX)
381         yadif->filter_line = ff_yadif_filter_line_mmx;
382
383     av_log(ctx, AV_LOG_INFO, "mode:%d parity:%d auto_enable:%d\n", yadif->mode, yadif->parity, yadif->auto_enable);
384
385     return 0;
386 }
387
388 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
389
390 AVFilter avfilter_vf_yadif = {
391     .name          = "yadif",
392     .description   = NULL_IF_CONFIG_SMALL("Deinterlace the input image"),
393
394     .priv_size     = sizeof(YADIFContext),
395     .init          = init,
396     .uninit        = uninit,
397     .query_formats = query_formats,
398
399     .inputs    = (AVFilterPad[]) {{ .name             = "default",
400                                     .type             = AVMEDIA_TYPE_VIDEO,
401                                     .start_frame      = start_frame,
402                                     .get_video_buffer = get_video_buffer,
403                                     .draw_slice       = null_draw_slice,
404                                     .end_frame        = end_frame, },
405                                   { .name = NULL}},
406
407     .outputs   = (AVFilterPad[]) {{ .name             = "default",
408                                     .type             = AVMEDIA_TYPE_VIDEO,
409                                     .poll_frame       = poll_frame,
410                                     .request_frame    = request_frame, },
411                                   { .name = NULL}},
412 };