FFmpeg
vf_kerndeint.c
Go to the documentation of this file.
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 KerndeintContext {
39  const AVClass *class;
40  int frame; ///< frame count, starting from 0
42  int vsub;
44  uint8_t *tmp_data [4]; ///< temporary plane data buffer
45  int tmp_linesize[4]; ///< temporary plane byte linesize
46  int tmp_bwidth [4]; ///< temporary plane byte width
48 
49 #define OFFSET(x) offsetof(KerndeintContext, x)
50 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
51 static const AVOption kerndeint_options[] = {
52  { "thresh", "set the threshold", OFFSET(thresh), AV_OPT_TYPE_INT, {.i64=10}, 0, 255, FLAGS },
53  { "map", "set the map", OFFSET(map), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
54  { "order", "set the order", OFFSET(order), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
55  { "sharp", "set sharpening", OFFSET(sharp), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
56  { "twoway", "set twoway", OFFSET(twoway), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
57  { NULL }
58 };
59 
60 AVFILTER_DEFINE_CLASS(kerndeint);
61 
63 {
64  KerndeintContext *kerndeint = ctx->priv;
65 
66  av_freep(&kerndeint->tmp_data[0]);
67 }
68 
69 static const enum AVPixelFormat pix_fmts[] = {
77 };
78 
80 {
81  KerndeintContext *kerndeint = inlink->dst->priv;
83  int ret;
84 
86  kerndeint->vsub = desc->log2_chroma_h;
87 
88  ret = av_image_alloc(kerndeint->tmp_data, kerndeint->tmp_linesize,
89  inlink->w, inlink->h, inlink->format, 16);
90  if (ret < 0)
91  return ret;
92  memset(kerndeint->tmp_data[0], 0, ret);
93 
94  if ((ret = av_image_fill_linesizes(kerndeint->tmp_bwidth, inlink->format, inlink->w)) < 0)
95  return ret;
96 
97  return 0;
98 }
99 
101 {
102  KerndeintContext *kerndeint = inlink->dst->priv;
103  AVFilterLink *outlink = inlink->dst->outputs[0];
104  AVFrame *outpic;
105  const uint8_t *prvp; ///< Previous field's pixel line number n
106  const uint8_t *prvpp; ///< Previous field's pixel line number (n - 1)
107  const uint8_t *prvpn; ///< Previous field's pixel line number (n + 1)
108  const uint8_t *prvppp; ///< Previous field's pixel line number (n - 2)
109  const uint8_t *prvpnn; ///< Previous field's pixel line number (n + 2)
110  const uint8_t *prvp4p; ///< Previous field's pixel line number (n - 4)
111  const uint8_t *prvp4n; ///< Previous field's pixel line number (n + 4)
112 
113  const uint8_t *srcp; ///< Current field's pixel line number n
114  const uint8_t *srcpp; ///< Current field's pixel line number (n - 1)
115  const uint8_t *srcpn; ///< Current field's pixel line number (n + 1)
116  const uint8_t *srcppp; ///< Current field's pixel line number (n - 2)
117  const uint8_t *srcpnn; ///< Current field's pixel line number (n + 2)
118  const uint8_t *srcp3p; ///< Current field's pixel line number (n - 3)
119  const uint8_t *srcp3n; ///< Current field's pixel line number (n + 3)
120  const uint8_t *srcp4p; ///< Current field's pixel line number (n - 4)
121  const uint8_t *srcp4n; ///< Current field's pixel line number (n + 4)
122 
123  uint8_t *dstp, *dstp_saved;
124  const uint8_t *srcp_saved;
125 
126  int src_linesize, psrc_linesize, dst_linesize, bwidth;
127  int x, y, plane, val, hi, lo, g, h, n = kerndeint->frame++;
128  double valf;
129 
130  const int thresh = kerndeint->thresh;
131  const int order = kerndeint->order;
132  const int map = kerndeint->map;
133  const int sharp = kerndeint->sharp;
134  const int twoway = kerndeint->twoway;
135 
136  const int is_packed_rgb = kerndeint->is_packed_rgb;
137 
138  outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
139  if (!outpic) {
141  return AVERROR(ENOMEM);
142  }
143  av_frame_copy_props(outpic, inpic);
144  outpic->interlaced_frame = 0;
145 
146  for (plane = 0; plane < 4 && inpic->data[plane] && inpic->linesize[plane]; plane++) {
147  h = plane == 0 ? inlink->h : AV_CEIL_RSHIFT(inlink->h, kerndeint->vsub);
148  bwidth = kerndeint->tmp_bwidth[plane];
149 
150  srcp_saved = inpic->data[plane];
151  src_linesize = inpic->linesize[plane];
152  psrc_linesize = kerndeint->tmp_linesize[plane];
153  dstp_saved = outpic->data[plane];
154  dst_linesize = outpic->linesize[plane];
155  srcp = srcp_saved + (1 - order) * src_linesize;
156  dstp = dstp_saved + (1 - order) * dst_linesize;
157 
158  for (y = 0; y < h; y += 2) {
159  memcpy(dstp, srcp, bwidth);
160  srcp += 2 * src_linesize;
161  dstp += 2 * dst_linesize;
162  }
163 
164  // Copy through the lines that will be missed below.
165  memcpy(dstp_saved + order * dst_linesize, srcp_saved + (1 - order) * src_linesize, bwidth);
166  memcpy(dstp_saved + (2 + order ) * dst_linesize, srcp_saved + (3 - order) * src_linesize, bwidth);
167  memcpy(dstp_saved + (h - 2 + order) * dst_linesize, srcp_saved + (h - 1 - order) * src_linesize, bwidth);
168  memcpy(dstp_saved + (h - 4 + order) * dst_linesize, srcp_saved + (h - 3 - order) * src_linesize, bwidth);
169 
170  /* For the other field choose adaptively between using the previous field
171  or the interpolant from the current field. */
172  prvp = kerndeint->tmp_data[plane] + 5 * psrc_linesize - (1 - order) * psrc_linesize;
173  prvpp = prvp - psrc_linesize;
174  prvppp = prvp - 2 * psrc_linesize;
175  prvp4p = prvp - 4 * psrc_linesize;
176  prvpn = prvp + psrc_linesize;
177  prvpnn = prvp + 2 * psrc_linesize;
178  prvp4n = prvp + 4 * psrc_linesize;
179 
180  srcp = srcp_saved + 5 * src_linesize - (1 - order) * src_linesize;
181  srcpp = srcp - src_linesize;
182  srcppp = srcp - 2 * src_linesize;
183  srcp3p = srcp - 3 * src_linesize;
184  srcp4p = srcp - 4 * src_linesize;
185 
186  srcpn = srcp + src_linesize;
187  srcpnn = srcp + 2 * src_linesize;
188  srcp3n = srcp + 3 * src_linesize;
189  srcp4n = srcp + 4 * src_linesize;
190 
191  dstp = dstp_saved + 5 * dst_linesize - (1 - order) * dst_linesize;
192 
193  for (y = 5 - (1 - order); y <= h - 5 - (1 - order); y += 2) {
194  for (x = 0; x < bwidth; x++) {
195  if (thresh == 0 || n == 0 ||
196  (abs((int)prvp[x] - (int)srcp[x]) > thresh) ||
197  (abs((int)prvpp[x] - (int)srcpp[x]) > thresh) ||
198  (abs((int)prvpn[x] - (int)srcpn[x]) > thresh)) {
199  if (map) {
200  g = x & ~3;
201 
202  if (is_packed_rgb) {
203  AV_WB32(dstp + g, 0xffffffff);
204  x = g + 3;
205  } else if (inlink->format == AV_PIX_FMT_YUYV422) {
206  // y <- 235, u <- 128, y <- 235, v <- 128
207  AV_WB32(dstp + g, 0xeb80eb80);
208  x = g + 3;
209  } else {
210  dstp[x] = plane == 0 ? 235 : 128;
211  }
212  } else {
213  if (is_packed_rgb) {
214  hi = 255;
215  lo = 0;
216  } else if (inlink->format == AV_PIX_FMT_YUYV422) {
217  hi = x & 1 ? 240 : 235;
218  lo = 16;
219  } else {
220  hi = plane == 0 ? 235 : 240;
221  lo = 16;
222  }
223 
224  if (sharp) {
225  if (twoway) {
226  valf = + 0.526 * ((int)srcpp[x] + (int)srcpn[x])
227  + 0.170 * ((int)srcp[x] + (int)prvp[x])
228  - 0.116 * ((int)srcppp[x] + (int)srcpnn[x] + (int)prvppp[x] + (int)prvpnn[x])
229  - 0.026 * ((int)srcp3p[x] + (int)srcp3n[x])
230  + 0.031 * ((int)srcp4p[x] + (int)srcp4n[x] + (int)prvp4p[x] + (int)prvp4n[x]);
231  } else {
232  valf = + 0.526 * ((int)srcpp[x] + (int)srcpn[x])
233  + 0.170 * ((int)prvp[x])
234  - 0.116 * ((int)prvppp[x] + (int)prvpnn[x])
235  - 0.026 * ((int)srcp3p[x] + (int)srcp3n[x])
236  + 0.031 * ((int)prvp4p[x] + (int)prvp4p[x]);
237  }
238  dstp[x] = av_clip(valf, lo, hi);
239  } else {
240  if (twoway) {
241  val = (8 * ((int)srcpp[x] + (int)srcpn[x]) + 2 * ((int)srcp[x] + (int)prvp[x])
242  - (int)(srcppp[x]) - (int)(srcpnn[x])
243  - (int)(prvppp[x]) - (int)(prvpnn[x])) >> 4;
244  } else {
245  val = (8 * ((int)srcpp[x] + (int)srcpn[x]) + 2 * ((int)prvp[x])
246  - (int)(prvppp[x]) - (int)(prvpnn[x])) >> 4;
247  }
248  dstp[x] = av_clip(val, lo, hi);
249  }
250  }
251  } else {
252  dstp[x] = srcp[x];
253  }
254  }
255  prvp += 2 * psrc_linesize;
256  prvpp += 2 * psrc_linesize;
257  prvppp += 2 * psrc_linesize;
258  prvpn += 2 * psrc_linesize;
259  prvpnn += 2 * psrc_linesize;
260  prvp4p += 2 * psrc_linesize;
261  prvp4n += 2 * psrc_linesize;
262  srcp += 2 * src_linesize;
263  srcpp += 2 * src_linesize;
264  srcppp += 2 * src_linesize;
265  srcp3p += 2 * src_linesize;
266  srcp4p += 2 * src_linesize;
267  srcpn += 2 * src_linesize;
268  srcpnn += 2 * src_linesize;
269  srcp3n += 2 * src_linesize;
270  srcp4n += 2 * src_linesize;
271  dstp += 2 * dst_linesize;
272  }
273 
274  srcp = inpic->data[plane];
275  dstp = kerndeint->tmp_data[plane];
276  av_image_copy_plane(dstp, psrc_linesize, srcp, src_linesize, bwidth, h);
277  }
278 
280  return ff_filter_frame(outlink, outpic);
281 }
282 
283 static const AVFilterPad kerndeint_inputs[] = {
284  {
285  .name = "default",
286  .type = AVMEDIA_TYPE_VIDEO,
287  .filter_frame = filter_frame,
288  .config_props = config_props,
289  },
290 };
291 
292 static const AVFilterPad kerndeint_outputs[] = {
293  {
294  .name = "default",
295  .type = AVMEDIA_TYPE_VIDEO,
296  },
297 };
298 
299 
301  .name = "kerndeint",
302  .description = NULL_IF_CONFIG_SMALL("Apply kernel deinterlacing to the input."),
303  .priv_size = sizeof(KerndeintContext),
304  .priv_class = &kerndeint_class,
305  .uninit = uninit,
309 };
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:98
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
av_clip
#define av_clip
Definition: common.h:96
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_kerndeint.c:62
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2564
FILTER_PIXFMTS_ARRAY
#define FILTER_PIXFMTS_ARRAY(array)
Definition: internal.h:171
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
AVOption
AVOption.
Definition: opt.h:247
KerndeintContext::tmp_data
uint8_t * tmp_data[4]
temporary plane data buffer
Definition: vf_kerndeint.c:44
kerndeint_inputs
static const AVFilterPad kerndeint_inputs[]
Definition: vf_kerndeint.c:283
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:95
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
av_image_copy_plane
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:374
formats.h
KerndeintContext
Definition: vf_kerndeint.c:38
val
static double val(void *priv, double ch)
Definition: aeval.c:76
KerndeintContext::twoway
int twoway
Definition: vf_kerndeint.c:41
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
av_cold
#define av_cold
Definition: attributes.h:90
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(kerndeint)
config_props
static int config_props(AVFilterLink *inlink)
Definition: vf_kerndeint.c:79
av_image_fill_linesizes
int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
Fill plane linesizes for an image with pixel format pix_fmt and width width.
Definition: imgutils.c:89
intreadwrite.h
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
g
const char * g
Definition: vf_curves.c:117
KerndeintContext::order
int order
Definition: vf_kerndeint.c:41
ctx
AVFormatContext * ctx
Definition: movenc.c:48
kerndeint_outputs
static const AVFilterPad kerndeint_outputs[]
Definition: vf_kerndeint.c:292
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
AV_PIX_FMT_RGBA
@ AV_PIX_FMT_RGBA
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:93
KerndeintContext::map
int map
Definition: vf_kerndeint.c:41
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:537
inpic
av_frame_free & inpic
Definition: vf_mcdeint.c:270
AV_PIX_FMT_YUYV422
@ AV_PIX_FMT_YUYV422
packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr
Definition: pixfmt.h:67
ff_vf_kerndeint
const AVFilter ff_vf_kerndeint
Definition: vf_kerndeint.c:300
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: vf_kerndeint.c:69
AV_PIX_FMT_BGR0
@ AV_PIX_FMT_BGR0
packed BGR 8:8:8, 32bpp, BGRXBGRX... X=unused/undefined
Definition: pixfmt.h:230
abs
#define abs(x)
Definition: cuda_runtime.h:35
AVPixFmtDescriptor::flags
uint64_t flags
Combination of AV_PIX_FMT_FLAG_...
Definition: pixdesc.h:94
AV_PIX_FMT_ABGR
@ AV_PIX_FMT_ABGR
packed ABGR 8:8:8:8, 32bpp, ABGRABGR...
Definition: pixfmt.h:94
KerndeintContext::tmp_linesize
int tmp_linesize[4]
temporary plane byte linesize
Definition: vf_kerndeint.c:45
AV_WB32
#define AV_WB32(p, v)
Definition: intreadwrite.h:419
av_image_alloc
int av_image_alloc(uint8_t *pointers[4], int linesizes[4], int w, int h, enum AVPixelFormat pix_fmt, int align)
Allocate an image with size w and h and pixel format pix_fmt, and fill pointers and linesizes accordi...
Definition: imgutils.c:218
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
AV_PIX_FMT_FLAG_RGB
#define AV_PIX_FMT_FLAG_RGB
The pixel format contains RGB-like data (as opposed to YUV/grayscale).
Definition: pixdesc.h:136
KerndeintContext::is_packed_rgb
int is_packed_rgb
Definition: vf_kerndeint.c:43
AV_PIX_FMT_RGB0
@ AV_PIX_FMT_RGB0
packed RGB 8:8:8, 32bpp, RGBXRGBX... X=unused/undefined
Definition: pixfmt.h:228
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
Definition: vf_kerndeint.c:100
internal.h
AV_PIX_FMT_ARGB
@ AV_PIX_FMT_ARGB
packed ARGB 8:8:8:8, 32bpp, ARGBARGB...
Definition: pixfmt.h:92
AVFrame::interlaced_frame
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:433
FLAGS
#define FLAGS
Definition: vf_kerndeint.c:50
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
AV_PIX_FMT_0BGR
@ AV_PIX_FMT_0BGR
packed BGR 8:8:8, 32bpp, XBGRXBGR... X=unused/undefined
Definition: pixfmt.h:229
KerndeintContext::frame
int frame
frame count, starting from 0
Definition: vf_kerndeint.c:40
KerndeintContext::tmp_bwidth
int tmp_bwidth[4]
temporary plane byte width
Definition: vf_kerndeint.c:46
KerndeintContext::thresh
int thresh
Definition: vf_kerndeint.c:41
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
KerndeintContext::vsub
int vsub
Definition: vf_kerndeint.c:42
desc
const char * desc
Definition: libsvtav1.c:79
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
map
const VDPAUPixFmtMap * map
Definition: hwcontext_vdpau.c:71
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:241
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
OFFSET
#define OFFSET(x)
Definition: vf_kerndeint.c:49
kerndeint_options
static const AVOption kerndeint_options[]
Definition: vf_kerndeint.c:51
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
AV_PIX_FMT_0RGB
@ AV_PIX_FMT_0RGB
packed RGB 8:8:8, 32bpp, XRGBXRGB... X=unused/undefined
Definition: pixfmt.h:227
KerndeintContext::sharp
int sharp
Definition: vf_kerndeint.c:41
h
h
Definition: vp9dsp_template.c:2038
int
int
Definition: ffmpeg_filter.c:156