6b87ef6a1f49bb524f6a453f96a9afb7a3c3e6fd
[ffmpeg.git] / libavfilter / vf_kerndeint.c
1 /*
2  * Copyright (c) 2012 Jeremy Tran
3  * Copyright (c) 2004 Tobias Diedrich
4  * Copyright (c) 2003 Donald A. Graft
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22
23 /**
24  * @file
25  * Kernel Deinterlacer
26  * Ported from MPlayer libmpcodecs/vf_kerndeint.c.
27  */
28
29 #include "libavutil/imgutils.h"
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33
34 #include "avfilter.h"
35 #include "formats.h"
36 #include "internal.h"
37
38 typedef struct {
39     const AVClass *class;
40     int           frame; ///< frame count, starting from 0
41     int           thresh, map, order, sharp, twoway;
42     int           vsub;
43     uint8_t       *tmp_data [4];  ///< temporary plane data buffer
44     int           tmp_bwidth[4];  ///< temporary plane byte width
45     int           pixel_step;
46 } KerndeintContext;
47
48 #define OFFSET(x) offsetof(KerndeintContext, x)
49 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
50 static const AVOption kerndeint_options[] = {
51     { "thresh", "set the threshold", OFFSET(thresh), AV_OPT_TYPE_INT, {.i64=10}, 0, 255, FLAGS },
52     { "map",    "set the map", OFFSET(map), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
53     { "order",  "set the order", OFFSET(order), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
54     { "sharp",  "enable sharpening", OFFSET(sharp), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
55     { "twoway", "enable twoway", OFFSET(twoway), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
56     { NULL }
57 };
58
59 AVFILTER_DEFINE_CLASS(kerndeint);
60
61 static av_cold int init(AVFilterContext *ctx, const char *args)
62 {
63     KerndeintContext *kerndeint = ctx->priv;
64     const char const * shorthand[] = { "thresh", "map", "order", "sharp", "twoway", NULL };
65
66     kerndeint->class = &kerndeint_class;
67     av_opt_set_defaults(kerndeint);
68
69     return av_opt_set_from_string(kerndeint, args, shorthand, "=", ":");
70 }
71
72 static av_cold void uninit(AVFilterContext *ctx)
73 {
74     KerndeintContext *kerndeint = ctx->priv;
75
76     av_free(kerndeint->tmp_data[0]);
77     av_opt_free(kerndeint);
78 }
79
80 static int query_formats(AVFilterContext *ctx)
81 {
82     static const enum PixelFormat pix_fmts[] = {
83         AV_PIX_FMT_YUV420P,
84         AV_PIX_FMT_YUYV422,
85         AV_PIX_FMT_ARGB, AV_PIX_FMT_0RGB,
86         AV_PIX_FMT_ABGR, AV_PIX_FMT_0BGR,
87         AV_PIX_FMT_RGBA, AV_PIX_FMT_RGB0,
88         AV_PIX_FMT_BGRA, AV_PIX_FMT_BGR0,
89         AV_PIX_FMT_NONE
90     };
91
92     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
93
94     return 0;
95 }
96
97 static int config_props(AVFilterLink *inlink)
98 {
99     KerndeintContext *kerndeint = inlink->dst->priv;
100     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[inlink->format];
101     int ret;
102
103     kerndeint->vsub = desc->log2_chroma_h;
104     kerndeint->pixel_step = av_get_bits_per_pixel(desc) >> 3;
105
106     ret = av_image_alloc(kerndeint->tmp_data, kerndeint->tmp_bwidth,
107                           inlink->w, inlink->h, inlink->format, 1);
108     if (ret < 0)
109         return ret;
110     memset(kerndeint->tmp_data[0], 0, ret);
111     return 0;
112 }
113
114 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *inpic)
115 {
116     KerndeintContext *kerndeint = inlink->dst->priv;
117     AVFilterLink *outlink = inlink->dst->outputs[0];
118     AVFilterBufferRef *outpic;
119     const uint8_t *prvp;   ///< Previous field's pixel line number n
120     const uint8_t *prvpp;  ///< Previous field's pixel line number (n - 1)
121     const uint8_t *prvpn;  ///< Previous field's pixel line number (n + 1)
122     const uint8_t *prvppp; ///< Previous field's pixel line number (n - 2)
123     const uint8_t *prvpnn; ///< Previous field's pixel line number (n + 2)
124     const uint8_t *prvp4p; ///< Previous field's pixel line number (n - 4)
125     const uint8_t *prvp4n; ///< Previous field's pixel line number (n + 4)
126
127     const uint8_t *srcp;   ///< Current field's pixel line number n
128     const uint8_t *srcpp;  ///< Current field's pixel line number (n - 1)
129     const uint8_t *srcpn;  ///< Current field's pixel line number (n + 1)
130     const uint8_t *srcppp; ///< Current field's pixel line number (n - 2)
131     const uint8_t *srcpnn; ///< Current field's pixel line number (n + 2)
132     const uint8_t *srcp3p; ///< Current field's pixel line number (n - 3)
133     const uint8_t *srcp3n; ///< Current field's pixel line number (n + 3)
134     const uint8_t *srcp4p; ///< Current field's pixel line number (n - 4)
135     const uint8_t *srcp4n; ///< Current field's pixel line number (n + 4)
136
137     uint8_t *dstp, *dstp_saved;
138     const uint8_t *srcp_saved;
139
140     int src_linesize, psrc_linesize, dst_linesize, bwidth;
141     int x, y, plane, val, hi, lo, g, h, n = kerndeint->frame++;
142     double valf;
143
144     const int thresh = kerndeint->thresh;
145     const int order  = kerndeint->order;
146     const int map    = kerndeint->map;
147     const int sharp  = kerndeint->sharp;
148     const int twoway = kerndeint->twoway;
149
150     outpic = ff_get_video_buffer(outlink, AV_PERM_WRITE|AV_PERM_ALIGN, outlink->w, outlink->h);
151     if (!outpic) {
152         avfilter_unref_bufferp(&inpic);
153         return AVERROR(ENOMEM);
154     }
155     avfilter_copy_buffer_ref_props(outpic, inpic);
156     outpic->video->interlaced = 0;
157
158     for (plane = 0; inpic->data[plane] && plane < 4; plane++) {
159         h = plane == 0 ? inlink->h : inlink->h >> kerndeint->vsub;
160         bwidth = kerndeint->tmp_bwidth[plane];
161
162         srcp = srcp_saved = inpic->data[plane];
163         src_linesize      = inpic->linesize[plane];
164         psrc_linesize     = outpic->linesize[plane];
165         dstp = dstp_saved = outpic->data[plane];
166         dst_linesize      = outpic->linesize[plane];
167         srcp              = srcp_saved + (1 - order) * src_linesize;
168         dstp              = dstp_saved + (1 - order) * dst_linesize;
169
170         for (y = 0; y < h; y += 2) {
171             memcpy(dstp, srcp, bwidth);
172             srcp += 2 * src_linesize;
173             dstp += 2 * dst_linesize;
174         }
175
176         // Copy through the lines that will be missed below.
177         memcpy(dstp_saved + order            * dst_linesize, srcp_saved + (1 -     order) * src_linesize, bwidth);
178         memcpy(dstp_saved + (2 + order    )  * dst_linesize, srcp_saved + (3 -     order) * src_linesize, bwidth);
179         memcpy(dstp_saved + (h - 2 + order)  * dst_linesize, srcp_saved + (h - 1 - order) * src_linesize, bwidth);
180         memcpy(dstp_saved + (h - 4 + order)  * dst_linesize, srcp_saved + (h - 3 - order) * src_linesize, bwidth);
181
182         /* For the other field choose adaptively between using the previous field
183            or the interpolant from the current field. */
184         prvp   = kerndeint->tmp_data[plane] + 5 * psrc_linesize - (1 - order) * psrc_linesize;
185         prvpp  = prvp - psrc_linesize;
186         prvppp = prvp - 2 * psrc_linesize;
187         prvp4p = prvp - 4 * psrc_linesize;
188         prvpn  = prvp + psrc_linesize;
189         prvpnn = prvp + 2 * psrc_linesize;
190         prvp4n = prvp + 4 * psrc_linesize;
191
192         srcp   = srcp_saved + 5 * src_linesize - (1 - order) * src_linesize;
193         srcpp  = srcp - src_linesize;
194         srcppp = srcp - 2 * src_linesize;
195         srcp3p = srcp - 3 * src_linesize;
196         srcp4p = srcp - 4 * src_linesize;
197
198         srcpn  = srcp + src_linesize;
199         srcpnn = srcp + 2 * src_linesize;
200         srcp3n = srcp + 3 * src_linesize;
201         srcp4n = srcp + 4 * src_linesize;
202
203         dstp   = dstp_saved + 5 * dst_linesize - (1 - order) * dst_linesize;
204
205         for (y = 5 - (1 - order); y <= h - 5 - (1 - order); y += 2) {
206             for (x = 0; x < bwidth; x++) {
207                 if (thresh == 0 || n == 0 ||
208                     (abs((int)prvp[x]  - (int)srcp[x])  > thresh) ||
209                     (abs((int)prvpp[x] - (int)srcpp[x]) > thresh) ||
210                     (abs((int)prvpn[x] - (int)srcpn[x]) > thresh)) {
211                     int is_packed_rgb = av_pix_fmt_desc_get(inlink->format)->flags & PIX_FMT_RGB;
212                     if (map) {
213                         g = x & ~3;
214
215                         if (is_packed_rgb) {
216                             AV_WB32(dstp + g, 0xffffffff);
217                             x = g + 3;
218                         } else if (inlink->format == AV_PIX_FMT_YUYV422) {
219                             // y <- 235, u <- 128, y <- 235, v <- 128
220                             AV_WB32(dstp + g, 0xeb80eb80);
221                             x = g + 3;
222                         } else {
223                             dstp[x] = plane == 0 ? 235 : 128;
224                         }
225                     } else {
226                         if (is_packed_rgb) {
227                             hi = 255;
228                             lo = 0;
229                         } else if (inlink->format == AV_PIX_FMT_YUYV422) {
230                             hi = x & 1 ? 240 : 235;
231                             lo = 16;
232                         } else {
233                             hi = plane == 0 ? 235 : 240;
234                             lo = 16;
235                         }
236
237                         if (sharp) {
238                             if (twoway) {
239                                 valf = + 0.526 * ((int)srcpp[x] + (int)srcpn[x])
240                                     + 0.170 * ((int)srcp[x] + (int)prvp[x])
241                                     - 0.116 * ((int)srcppp[x] + (int)srcpnn[x] + (int)prvppp[x] + (int)prvpnn[x])
242                                     - 0.026 * ((int)srcp3p[x] + (int)srcp3n[x])
243                                     + 0.031 * ((int)srcp4p[x] + (int)srcp4n[x] + (int)prvp4p[x] + (int)prvp4n[x]);
244                             } else {
245                                 valf = + 0.526 * ((int)srcpp[x] + (int)srcpn[x])
246                                     + 0.170 * ((int)prvp[x])
247                                     - 0.116 * ((int)prvppp[x] + (int)prvpnn[x])
248                                     - 0.026 * ((int)srcp3p[x] + (int)srcp3n[x])
249                                     + 0.031 * ((int)prvp4p[x] + (int)prvp4p[x]);
250                             }
251                             dstp[x] = av_clip(valf, lo, hi);
252                         } else {
253                             if (twoway) {
254                                 val = (8 * ((int)srcpp[x] + (int)srcpn[x]) + 2 * ((int)srcp[x] + (int)prvp[x])
255                                        - (int)(srcppp[x]) - (int)(srcpnn[x])
256                                        - (int)(prvppp[x]) - (int)(prvpnn[x])) >> 4;
257                             } else {
258                                 val = (8 * ((int)srcpp[x] + (int)srcpn[x]) + 2 * ((int)prvp[x])
259                                        - (int)(prvppp[x]) - (int)(prvpnn[x])) >> 4;
260                             }
261                             dstp[x] = av_clip(val, lo, hi);
262                         }
263                     }
264                 } else {
265                     dstp[x] = srcp[x];
266                 }
267             }
268             prvp   += 2 * psrc_linesize;
269             prvpp  += 2 * psrc_linesize;
270             prvppp += 2 * psrc_linesize;
271             prvpn  += 2 * psrc_linesize;
272             prvpnn += 2 * psrc_linesize;
273             prvp4p += 2 * psrc_linesize;
274             prvp4n += 2 * psrc_linesize;
275             srcp   += 2 * src_linesize;
276             srcpp  += 2 * src_linesize;
277             srcppp += 2 * src_linesize;
278             srcp3p += 2 * src_linesize;
279             srcp4p += 2 * src_linesize;
280             srcpn  += 2 * src_linesize;
281             srcpnn += 2 * src_linesize;
282             srcp3n += 2 * src_linesize;
283             srcp4n += 2 * src_linesize;
284             dstp   += 2 * dst_linesize;
285         }
286
287         srcp = inpic->data[plane];
288         dstp = kerndeint->tmp_data[plane];
289         av_image_copy_plane(dstp, psrc_linesize, srcp, src_linesize, bwidth, h);
290     }
291
292     avfilter_unref_buffer(inpic);
293     return ff_filter_frame(outlink, outpic);
294 }
295
296 static const AVFilterPad kerndeint_inputs[] = {
297     {
298         .name         = "default",
299         .type         = AVMEDIA_TYPE_VIDEO,
300         .filter_frame = filter_frame,
301         .config_props = config_props,
302         .min_perms    = AV_PERM_READ,
303     },
304     { NULL }
305 };
306
307 static const AVFilterPad kerndeint_outputs[] = {
308     {
309         .name = "default",
310         .type = AVMEDIA_TYPE_VIDEO,
311     },
312     { NULL }
313 };
314
315 AVFilter avfilter_vf_kerndeint = {
316     .name          = "kerndeint",
317     .description   = NULL_IF_CONFIG_SMALL("Apply kernel deinterlacing to the input."),
318     .priv_size     = sizeof(KerndeintContext),
319     .init          = init,
320     .uninit        = uninit,
321     .query_formats = query_formats,
322
323     .inputs        = kerndeint_inputs,
324     .outputs       = kerndeint_outputs,
325
326     .priv_class = &kerndeint_class,
327 };