f43a0d4227684712e8f9d027792d22199a0ea6c3
[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-1+(j)] - cur[prefs-1-(j)])\
38                   + FFABS(cur[mrefs  +(j)] - cur[prefs  -(j)])\
39                   + FFABS(cur[mrefs+1+(j)] - cur[prefs+1-(j)]);\
40         if (score < spatial_score) {\
41             spatial_score= score;\
42             spatial_pred= (cur[mrefs  +(j)] + cur[prefs  -(j)])>>1;\
43
44 #define FILTER \
45     for (x = 0;  x < w; 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 spatial_score = FFABS(cur[mrefs - 1] - cur[prefs - 1]) + FFABS(c-e) \
55                           + FFABS(cur[mrefs + 1] - cur[prefs + 1]) - 1; \
56  \
57         CHECK(-1) CHECK(-2) }} }} \
58         CHECK( 1) CHECK( 2) }} }} \
59  \
60         if (mode < 2) { \
61             int b = (prev2[2 * mrefs] + next2[2 * mrefs])>>1; \
62             int f = (prev2[2 * prefs] + next2[2 * prefs])>>1; \
63             int max = FFMAX3(d - e, d - c, FFMIN(b - c, f - e)); \
64             int min = FFMIN3(d - e, d - c, FFMAX(b - c, f - e)); \
65  \
66             diff = FFMAX3(diff, min, -max); \
67         } \
68  \
69         if (spatial_pred > d + diff) \
70            spatial_pred = d + diff; \
71         else if (spatial_pred < d - diff) \
72            spatial_pred = d - diff; \
73  \
74         dst[0] = spatial_pred; \
75  \
76         dst++; \
77         cur++; \
78         prev++; \
79         next++; \
80         prev2++; \
81         next2++; \
82     }
83
84 static void filter_line_c(void *dst1,
85                           void *prev1, void *cur1, void *next1,
86                           int w, int prefs, int mrefs, int parity, int mode)
87 {
88     uint8_t *dst  = dst1;
89     uint8_t *prev = prev1;
90     uint8_t *cur  = cur1;
91     uint8_t *next = next1;
92     int x;
93     uint8_t *prev2 = parity ? prev : cur ;
94     uint8_t *next2 = parity ? cur  : next;
95
96     FILTER
97 }
98
99 static void filter_line_c_16bit(void *dst1,
100                                 void *prev1, void *cur1, void *next1,
101                                 int w, int prefs, int mrefs, int parity,
102                                 int mode)
103 {
104     uint16_t *dst  = dst1;
105     uint16_t *prev = prev1;
106     uint16_t *cur  = cur1;
107     uint16_t *next = next1;
108     int x;
109     uint16_t *prev2 = parity ? prev : cur ;
110     uint16_t *next2 = parity ? cur  : next;
111     mrefs /= 2;
112     prefs /= 2;
113
114     FILTER
115 }
116
117 static void filter(AVFilterContext *ctx, AVFilterBufferRef *dstpic,
118                    int parity, int tff)
119 {
120     YADIFContext *yadif = ctx->priv;
121     int y, i;
122
123     for (i = 0; i < yadif->csp->nb_components; i++) {
124         int w = dstpic->video->w;
125         int h = dstpic->video->h;
126         int refs = yadif->cur->linesize[i];
127         int absrefs = FFABS(refs);
128         int df = (yadif->csp->comp[i].depth_minus1 + 8) / 8;
129
130         if (i == 1 || i == 2) {
131         /* Why is this not part of the per-plane description thing? */
132             w >>= yadif->csp->log2_chroma_w;
133             h >>= yadif->csp->log2_chroma_h;
134         }
135
136         if(yadif->temp_line_size < absrefs) {
137             av_free(yadif->temp_line);
138             yadif->temp_line = av_mallocz(2*64 + 5*absrefs);
139             yadif->temp_line_size = absrefs;
140         }
141
142         for (y = 0; y < h; y++) {
143             if ((y ^ parity) & 1) {
144                 uint8_t *prev = &yadif->prev->data[i][y * refs];
145                 uint8_t *cur  = &yadif->cur ->data[i][y * refs];
146                 uint8_t *next = &yadif->next->data[i][y * refs];
147                 uint8_t *dst  = &dstpic->data[i][y * dstpic->linesize[i]];
148                 int     mode  = y == 1 || y + 2 == h ? 2 : yadif->mode;
149                 int     prefs = y+1<h ? refs : -refs;
150                 int     mrefs =     y ?-refs :  refs;
151
152                 if(y<=1 || y+2>=h) {
153                     uint8_t *tmp = yadif->temp_line + 64 + 2*absrefs;
154                     if(mode<2)
155                         memcpy(tmp+2*mrefs, cur+2*mrefs, w*df);
156                     memcpy(tmp+mrefs, cur+mrefs, w*df);
157                     memcpy(tmp      , cur      , w*df);
158                     if(prefs != mrefs) {
159                         memcpy(tmp+prefs, cur+prefs, w*df);
160                         if(mode<2)
161                             memcpy(tmp+2*prefs, cur+2*prefs, w*df);
162                     }
163                     cur = tmp;
164                 }
165
166                 yadif->filter_line(dst, prev, cur, next, w,
167                                    prefs, mrefs,
168                                    parity ^ tff, mode);
169             } else {
170                 memcpy(&dstpic->data[i][y * dstpic->linesize[i]],
171                        &yadif->cur->data[i][y * refs], w * df);
172             }
173         }
174     }
175
176     emms_c();
177 }
178
179 static int return_frame(AVFilterContext *ctx, int is_second)
180 {
181     YADIFContext *yadif = ctx->priv;
182     AVFilterLink *link  = ctx->outputs[0];
183     int tff, ret;
184
185     if (yadif->parity == -1) {
186         tff = yadif->cur->video->interlaced ?
187               yadif->cur->video->top_field_first : 1;
188     } else {
189         tff = yadif->parity ^ 1;
190     }
191
192     if (is_second) {
193         yadif->out = ff_get_video_buffer(link, PERM_RWP, link->w, link->h);
194         if (!yadif->out)
195             return AVERROR(ENOMEM);
196
197         avfilter_copy_buffer_ref_props(yadif->out, yadif->cur);
198         yadif->out->video->interlaced = 0;
199     }
200
201     if (!yadif->csp)
202         yadif->csp = av_pix_fmt_desc_get(link->format);
203     if (yadif->csp->comp[0].depth_minus1 / 8 == 1)
204         yadif->filter_line = filter_line_c_16bit;
205
206     filter(ctx, yadif->out, tff ^ !is_second, tff);
207
208     if (is_second) {
209         int64_t cur_pts  = yadif->cur->pts;
210         int64_t next_pts = yadif->next->pts;
211
212         if (next_pts != AV_NOPTS_VALUE && cur_pts != AV_NOPTS_VALUE) {
213             yadif->out->pts = cur_pts + next_pts;
214         } else {
215             yadif->out->pts = AV_NOPTS_VALUE;
216         }
217     }
218     ret = ff_filter_frame(ctx->outputs[0], yadif->out);
219
220     yadif->frame_pending = (yadif->mode&1) && !is_second;
221     return ret;
222 }
223
224 static int filter_frame(AVFilterLink *link, AVFilterBufferRef *picref)
225 {
226     AVFilterContext *ctx = link->dst;
227     YADIFContext *yadif = ctx->priv;
228
229     av_assert0(picref);
230
231     if (yadif->frame_pending)
232         return_frame(ctx, 1);
233
234     if (yadif->prev)
235         avfilter_unref_buffer(yadif->prev);
236     yadif->prev = yadif->cur;
237     yadif->cur  = yadif->next;
238     yadif->next = picref;
239
240     if (!yadif->cur)
241         return 0;
242
243     if (yadif->deint && !yadif->cur->video->interlaced) {
244         yadif->out  = avfilter_ref_buffer(yadif->cur, ~AV_PERM_WRITE);
245         if (!yadif->out)
246             return AVERROR(ENOMEM);
247
248         avfilter_unref_bufferp(&yadif->prev);
249         if (yadif->out->pts != AV_NOPTS_VALUE)
250             yadif->out->pts *= 2;
251         return ff_filter_frame(ctx->outputs[0], yadif->out);
252     }
253
254     if (!yadif->prev &&
255         !(yadif->prev = avfilter_ref_buffer(yadif->cur, ~AV_PERM_WRITE)))
256         return AVERROR(ENOMEM);
257
258     yadif->out = ff_get_video_buffer(ctx->outputs[0], PERM_RWP,
259                                      link->w, link->h);
260     if (!yadif->out)
261         return AVERROR(ENOMEM);
262
263     avfilter_copy_buffer_ref_props(yadif->out, yadif->cur);
264     yadif->out->video->interlaced = 0;
265
266     if (yadif->out->pts != AV_NOPTS_VALUE)
267         yadif->out->pts *= 2;
268
269     return return_frame(ctx, 0);
270 }
271
272 static int request_frame(AVFilterLink *link)
273 {
274     AVFilterContext *ctx = link->src;
275     YADIFContext *yadif = ctx->priv;
276
277     if (yadif->frame_pending) {
278         return_frame(ctx, 1);
279         return 0;
280     }
281
282     do {
283         int ret;
284
285         if (yadif->eof)
286             return AVERROR_EOF;
287
288         ret  = ff_request_frame(link->src->inputs[0]);
289
290         if (ret == AVERROR_EOF && yadif->cur) {
291             AVFilterBufferRef *next = avfilter_ref_buffer(yadif->next, ~AV_PERM_WRITE);
292
293             if (!next)
294                 return AVERROR(ENOMEM);
295
296             next->pts = yadif->next->pts * 2 - yadif->cur->pts;
297
298             filter_frame(link->src->inputs[0], next);
299             yadif->eof = 1;
300         } else if (ret < 0) {
301             return ret;
302         }
303     } while (!yadif->cur);
304
305     return 0;
306 }
307
308 #define OFFSET(x) offsetof(YADIFContext, x)
309 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
310
311 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, INT_MIN, INT_MAX, FLAGS, unit }
312
313 static const AVOption yadif_options[] = {
314     { "mode",   "specify the interlacing mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=YADIF_MODE_SEND_FRAME}, 0, 3, FLAGS, "mode"},
315     CONST("send_frame",           "send one frame for each frame",                                     YADIF_MODE_SEND_FRAME,           "mode"),
316     CONST("send_field",           "send one frame for each field",                                     YADIF_MODE_SEND_FIELD,           "mode"),
317     CONST("send_frame_nospatial", "send one frame for each frame, but skip spatial interlacing check", YADIF_MODE_SEND_FRAME_NOSPATIAL, "mode"),
318     CONST("send_field_nospatial", "send one frame for each field, but skip spatial interlacing check", YADIF_MODE_SEND_FIELD_NOSPATIAL, "mode"),
319
320     { "parity", "specify the assumed picture field parity", OFFSET(parity), AV_OPT_TYPE_INT, {.i64=YADIF_PARITY_AUTO}, -1, 1, FLAGS, "parity" },
321     CONST("tff",  "assume top field first",    YADIF_PARITY_TFF,  "parity"),
322     CONST("bff",  "assume bottom field first", YADIF_PARITY_BFF,  "parity"),
323     CONST("auto", "auto detect parity",        YADIF_PARITY_AUTO, "parity"),
324
325     { "deint", "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=YADIF_DEINT_ALL}, 0, 1, FLAGS, "deint" },
326     CONST("all",        "deinterlace all frames",                       YADIF_DEINT_ALL,         "deint"),
327     CONST("interlaced", "only deinterlace frames marked as interlaced", YADIF_DEINT_INTERLACED,  "deint"),
328
329     {NULL},
330 };
331
332 AVFILTER_DEFINE_CLASS(yadif);
333
334 static av_cold void uninit(AVFilterContext *ctx)
335 {
336     YADIFContext *yadif = ctx->priv;
337
338     avfilter_unref_bufferp(&yadif->prev);
339     avfilter_unref_bufferp(&yadif->cur );
340     avfilter_unref_bufferp(&yadif->next);
341     av_freep(&yadif->temp_line); yadif->temp_line_size = 0;
342     av_opt_free(yadif);
343 }
344
345 static int query_formats(AVFilterContext *ctx)
346 {
347     static const enum AVPixelFormat pix_fmts[] = {
348         AV_PIX_FMT_YUV420P,
349         AV_PIX_FMT_YUV422P,
350         AV_PIX_FMT_YUV444P,
351         AV_PIX_FMT_YUV410P,
352         AV_PIX_FMT_YUV411P,
353         AV_PIX_FMT_GRAY8,
354         AV_PIX_FMT_YUVJ420P,
355         AV_PIX_FMT_YUVJ422P,
356         AV_PIX_FMT_YUVJ444P,
357         AV_NE( AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_GRAY16LE ),
358         AV_PIX_FMT_YUV440P,
359         AV_PIX_FMT_YUVJ440P,
360         AV_NE( AV_PIX_FMT_YUV420P9BE,  AV_PIX_FMT_YUV420P9LE ),
361         AV_NE( AV_PIX_FMT_YUV422P9BE,  AV_PIX_FMT_YUV422P9LE ),
362         AV_NE( AV_PIX_FMT_YUV444P9BE,  AV_PIX_FMT_YUV444P9LE ),
363         AV_NE( AV_PIX_FMT_YUV420P10BE, AV_PIX_FMT_YUV420P10LE ),
364         AV_NE( AV_PIX_FMT_YUV422P10BE, AV_PIX_FMT_YUV422P10LE ),
365         AV_NE( AV_PIX_FMT_YUV444P10BE, AV_PIX_FMT_YUV444P10LE ),
366         AV_NE( AV_PIX_FMT_YUV420P12BE, AV_PIX_FMT_YUV420P12LE ),
367         AV_NE( AV_PIX_FMT_YUV422P12BE, AV_PIX_FMT_YUV422P12LE ),
368         AV_NE( AV_PIX_FMT_YUV444P12BE, AV_PIX_FMT_YUV444P12LE ),
369         AV_NE( AV_PIX_FMT_YUV420P14BE, AV_PIX_FMT_YUV420P14LE ),
370         AV_NE( AV_PIX_FMT_YUV422P14BE, AV_PIX_FMT_YUV422P14LE ),
371         AV_NE( AV_PIX_FMT_YUV444P14BE, AV_PIX_FMT_YUV444P14LE ),
372         AV_NE( AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUV420P16LE ),
373         AV_NE( AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUV422P16LE ),
374         AV_NE( AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUV444P16LE ),
375         AV_PIX_FMT_YUVA420P,
376         AV_PIX_FMT_YUVA422P,
377         AV_PIX_FMT_YUVA444P,
378         AV_PIX_FMT_NONE
379     };
380
381     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
382
383     return 0;
384 }
385
386 static av_cold int init(AVFilterContext *ctx, const char *args)
387 {
388     YADIFContext *yadif = ctx->priv;
389     static const char *shorthand[] = { "mode", "parity", "deint", NULL };
390     int ret;
391
392     yadif->csp = NULL;
393
394     yadif->class = &yadif_class;
395     av_opt_set_defaults(yadif);
396
397     if ((ret = av_opt_set_from_string(yadif, args, shorthand, "=", ":")) < 0)
398         return ret;
399
400     yadif->filter_line = filter_line_c;
401
402     if (ARCH_X86)
403         ff_yadif_init_x86(yadif);
404
405     av_log(ctx, AV_LOG_VERBOSE, "mode:%d parity:%d deint:%d\n",
406            yadif->mode, yadif->parity, yadif->deint);
407
408     return 0;
409 }
410
411 static int config_props(AVFilterLink *link)
412 {
413     AVFilterContext *ctx = link->src;
414     YADIFContext *yadif = ctx->priv;
415
416     link->time_base.num = link->src->inputs[0]->time_base.num;
417     link->time_base.den = link->src->inputs[0]->time_base.den * 2;
418     link->w             = link->src->inputs[0]->w;
419     link->h             = link->src->inputs[0]->h;
420
421     if(yadif->mode&1)
422         link->frame_rate = av_mul_q(link->src->inputs[0]->frame_rate, (AVRational){2,1});
423
424     if (link->w < 3 || link->h < 3) {
425         av_log(ctx, AV_LOG_ERROR, "Video of less than 3 columns or lines is not supported\n");
426         return AVERROR(EINVAL);
427     }
428
429     return 0;
430 }
431
432 static const AVFilterPad avfilter_vf_yadif_inputs[] = {
433     {
434         .name             = "default",
435         .type             = AVMEDIA_TYPE_VIDEO,
436         .filter_frame     = filter_frame,
437         .min_perms        = AV_PERM_PRESERVE,
438     },
439     { NULL }
440 };
441
442 static const AVFilterPad avfilter_vf_yadif_outputs[] = {
443     {
444         .name          = "default",
445         .type          = AVMEDIA_TYPE_VIDEO,
446         .request_frame = request_frame,
447         .config_props  = config_props,
448     },
449     { NULL }
450 };
451
452 AVFilter avfilter_vf_yadif = {
453     .name          = "yadif",
454     .description   = NULL_IF_CONFIG_SMALL("Deinterlace the input image."),
455
456     .priv_size     = sizeof(YADIFContext),
457     .init          = init,
458     .uninit        = uninit,
459     .query_formats = query_formats,
460
461     .inputs    = avfilter_vf_yadif_inputs,
462     .outputs   = avfilter_vf_yadif_outputs,
463
464     .priv_class = &yadif_class,
465 };