FFmpeg
vf_mcdeint.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20 
21 /**
22  * @file
23  * Motion Compensation Deinterlacer
24  * Ported from MPlayer libmpcodecs/vf_mcdeint.c.
25  *
26  * Known Issues:
27  *
28  * The motion estimation is somewhat at the mercy of the input, if the
29  * input frames are created purely based on spatial interpolation then
30  * for example a thin black line or another random and not
31  * interpolateable pattern will cause problems.
32  * Note: completely ignoring the "unavailable" lines during motion
33  * estimation did not look any better, so the most obvious solution
34  * would be to improve tfields or penalize problematic motion vectors.
35  *
36  * If non iterative ME is used then snow currently ignores the OBMC
37  * window and as a result sometimes creates artifacts.
38  *
39  * Only past frames are used, we should ideally use future frames too,
40  * something like filtering the whole movie in forward and then
41  * backward direction seems like an interesting idea but the current
42  * filter framework is FAR from supporting such things.
43  *
44  * Combining the motion compensated image with the input image also is
45  * not as trivial as it seems, simple blindly taking even lines from
46  * one and odd ones from the other does not work at all as ME/MC
47  * sometimes has nothing in the previous frames which matches the
48  * current. The current algorithm has been found by trial and error
49  * and almost certainly can be improved...
50  */
51 
52 #include "libavutil/opt.h"
53 #include "libavutil/pixdesc.h"
54 #include "libavcodec/avcodec.h"
55 #include "avfilter.h"
56 #include "formats.h"
57 #include "internal.h"
58 
60  MODE_FAST = 0,
65 };
66 
68  PARITY_TFF = 0, ///< top field first
69  PARITY_BFF = 1, ///< bottom field first
70 };
71 
72 typedef struct MCDeintContext {
73  const AVClass *class;
74  int mode; ///< MCDeintMode
75  int parity; ///< MCDeintParity
76  int qp;
80 
81 #define OFFSET(x) offsetof(MCDeintContext, x)
82 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
83 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, INT_MIN, INT_MAX, FLAGS, unit }
84 
85 static const AVOption mcdeint_options[] = {
86  { "mode", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=MODE_FAST}, 0, MODE_NB-1, FLAGS, .unit="mode" },
87  CONST("fast", NULL, MODE_FAST, "mode"),
88  CONST("medium", NULL, MODE_MEDIUM, "mode"),
89  CONST("slow", NULL, MODE_SLOW, "mode"),
90  CONST("extra_slow", NULL, MODE_EXTRA_SLOW, "mode"),
91 
92  { "parity", "set the assumed picture field parity", OFFSET(parity), AV_OPT_TYPE_INT, {.i64=PARITY_BFF}, -1, 1, FLAGS, "parity" },
93  CONST("tff", "assume top field first", PARITY_TFF, "parity"),
94  CONST("bff", "assume bottom field first", PARITY_BFF, "parity"),
95 
96  { "qp", "set qp", OFFSET(qp), AV_OPT_TYPE_INT, {.i64=1}, INT_MIN, INT_MAX, FLAGS },
97  { NULL }
98 };
99 
100 AVFILTER_DEFINE_CLASS(mcdeint);
101 
103 {
104  AVFilterContext *ctx = inlink->dst;
105  MCDeintContext *mcdeint = ctx->priv;
106  const AVCodec *enc;
107  AVCodecContext *enc_ctx;
109  int ret;
110 
111  if (!(enc = avcodec_find_encoder(AV_CODEC_ID_SNOW))) {
112  av_log(ctx, AV_LOG_ERROR, "Snow encoder is not enabled in libavcodec\n");
113  return AVERROR(EINVAL);
114  }
115 
116  mcdeint->pkt = av_packet_alloc();
117  if (!mcdeint->pkt)
118  return AVERROR(ENOMEM);
119  mcdeint->enc_ctx = avcodec_alloc_context3(enc);
120  if (!mcdeint->enc_ctx)
121  return AVERROR(ENOMEM);
122  enc_ctx = mcdeint->enc_ctx;
123  enc_ctx->width = inlink->w;
124  enc_ctx->height = inlink->h;
125  enc_ctx->time_base = (AVRational){1,25}; // meaningless
126  enc_ctx->gop_size = INT_MAX;
127  enc_ctx->max_b_frames = 0;
128  enc_ctx->pix_fmt = AV_PIX_FMT_YUV420P;
131  enc_ctx->global_quality = 1;
132  enc_ctx->me_cmp = enc_ctx->me_sub_cmp = FF_CMP_SAD;
133  enc_ctx->mb_cmp = FF_CMP_SSE;
134  av_dict_set(&opts, "memc_only", "1", 0);
135  av_dict_set(&opts, "no_bitstream", "1", 0);
136 
137  switch (mcdeint->mode) {
138  case MODE_EXTRA_SLOW:
139  enc_ctx->refs = 3;
140  case MODE_SLOW:
141  av_dict_set(&opts, "motion_est", "iter", 0);
142  case MODE_MEDIUM:
143  enc_ctx->flags |= AV_CODEC_FLAG_4MV;
144  enc_ctx->dia_size = 2;
145  case MODE_FAST:
146  enc_ctx->flags |= AV_CODEC_FLAG_QPEL;
147  }
148 
149  ret = avcodec_open2(enc_ctx, enc, &opts);
150  av_dict_free(&opts);
151  if (ret < 0)
152  return ret;
153 
154  return 0;
155 }
156 
158 {
159  MCDeintContext *mcdeint = ctx->priv;
160 
161  av_packet_free(&mcdeint->pkt);
162  avcodec_free_context(&mcdeint->enc_ctx);
163 }
164 
166 {
167  MCDeintContext *mcdeint = inlink->dst->priv;
168  AVFilterLink *outlink = inlink->dst->outputs[0];
169  AVFrame *outpic, *frame_dec;
170  AVPacket *pkt = mcdeint->pkt;
171  int x, y, i, ret, got_frame = 0;
172 
173  outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
174  if (!outpic) {
176  return AVERROR(ENOMEM);
177  }
178  av_frame_copy_props(outpic, inpic);
179  inpic->quality = mcdeint->qp * FF_QP2LAMBDA;
180 
181  ret = avcodec_encode_video2(mcdeint->enc_ctx, pkt, inpic, &got_frame);
182  if (ret < 0)
183  goto end;
184 
185  frame_dec = mcdeint->enc_ctx->coded_frame;
186 
187  for (i = 0; i < 3; i++) {
188  int is_chroma = !!i;
189  int w = AV_CEIL_RSHIFT(inlink->w, is_chroma);
190  int h = AV_CEIL_RSHIFT(inlink->h, is_chroma);
191  int fils = frame_dec->linesize[i];
192  int srcs = inpic ->linesize[i];
193  int dsts = outpic ->linesize[i];
194 
195  for (y = 0; y < h; y++) {
196  if ((y ^ mcdeint->parity) & 1) {
197  for (x = 0; x < w; x++) {
198  uint8_t *filp = &frame_dec->data[i][x + y*fils];
199  uint8_t *srcp = &inpic ->data[i][x + y*srcs];
200  uint8_t *dstp = &outpic ->data[i][x + y*dsts];
201 
202  if (y > 0 && y < h-1){
203  int is_edge = x < 3 || x > w-4;
204  int diff0 = filp[-fils] - srcp[-srcs];
205  int diff1 = filp[+fils] - srcp[+srcs];
206  int temp = filp[0];
207 
208 #define DELTA(j) av_clip(j, -x, w-1-x)
209 
210 #define GET_SCORE_EDGE(j)\
211  FFABS(srcp[-srcs+DELTA(-1+(j))] - srcp[+srcs+DELTA(-1-(j))])+\
212  FFABS(srcp[-srcs+DELTA(j) ] - srcp[+srcs+DELTA( -(j))])+\
213  FFABS(srcp[-srcs+DELTA(1+(j)) ] - srcp[+srcs+DELTA( 1-(j))])
214 
215 #define GET_SCORE(j)\
216  FFABS(srcp[-srcs-1+(j)] - srcp[+srcs-1-(j)])+\
217  FFABS(srcp[-srcs +(j)] - srcp[+srcs -(j)])+\
218  FFABS(srcp[-srcs+1+(j)] - srcp[+srcs+1-(j)])
219 
220 #define CHECK_EDGE(j)\
221  { int score = GET_SCORE_EDGE(j);\
222  if (score < spatial_score){\
223  spatial_score = score;\
224  diff0 = filp[-fils+DELTA(j)] - srcp[-srcs+DELTA(j)];\
225  diff1 = filp[+fils+DELTA(-(j))] - srcp[+srcs+DELTA(-(j))];\
226 
227 #define CHECK(j)\
228  { int score = GET_SCORE(j);\
229  if (score < spatial_score){\
230  spatial_score= score;\
231  diff0 = filp[-fils+(j)] - srcp[-srcs+(j)];\
232  diff1 = filp[+fils-(j)] - srcp[+srcs-(j)];\
233 
234  if (is_edge) {
235  int spatial_score = GET_SCORE_EDGE(0) - 1;
236  CHECK_EDGE(-1) CHECK_EDGE(-2) }} }}
237  CHECK_EDGE( 1) CHECK_EDGE( 2) }} }}
238  } else {
239  int spatial_score = GET_SCORE(0) - 1;
240  CHECK(-1) CHECK(-2) }} }}
241  CHECK( 1) CHECK( 2) }} }}
242  }
243 
244 
245  if (diff0 + diff1 > 0)
246  temp -= (diff0 + diff1 - FFABS(FFABS(diff0) - FFABS(diff1)) / 2) / 2;
247  else
248  temp -= (diff0 + diff1 + FFABS(FFABS(diff0) - FFABS(diff1)) / 2) / 2;
249  *filp = *dstp = temp > 255U ? ~(temp>>31) : temp;
250  } else {
251  *dstp = *filp;
252  }
253  }
254  }
255  }
256 
257  for (y = 0; y < h; y++) {
258  if (!((y ^ mcdeint->parity) & 1)) {
259  for (x = 0; x < w; x++) {
260  frame_dec->data[i][x + y*fils] =
261  outpic ->data[i][x + y*dsts] = inpic->data[i][x + y*srcs];
262  }
263  }
264  }
265  }
266  mcdeint->parity ^= 1;
267 
268 end:
271  if (ret < 0) {
272  av_frame_free(&outpic);
273  return ret;
274  }
275  return ff_filter_frame(outlink, outpic);
276 }
277 
278 static const AVFilterPad mcdeint_inputs[] = {
279  {
280  .name = "default",
281  .type = AVMEDIA_TYPE_VIDEO,
282  .filter_frame = filter_frame,
283  .config_props = config_props,
284  },
285 };
286 
287 static const AVFilterPad mcdeint_outputs[] = {
288  {
289  .name = "default",
290  .type = AVMEDIA_TYPE_VIDEO,
291  },
292 };
293 
295  .name = "mcdeint",
296  .description = NULL_IF_CONFIG_SMALL("Apply motion compensating deinterlacing."),
297  .priv_size = sizeof(MCDeintContext),
298  .uninit = uninit,
302  .priv_class = &mcdeint_class,
303 };
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
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:417
MCDeintContext::parity
int parity
MCDeintParity.
Definition: vf_mcdeint.c:75
AVCodec
AVCodec.
Definition: codec.h:202
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
MCDeintContext::pkt
AVPacket * pkt
Definition: vf_mcdeint.c:77
FF_COMPLIANCE_EXPERIMENTAL
#define FF_COMPLIANCE_EXPERIMENTAL
Allow nonstandardized experimental things.
Definition: avcodec.h:1285
MODE_SLOW
@ MODE_SLOW
Definition: vf_mcdeint.c:62
MODE_NB
@ MODE_NB
Definition: vf_mcdeint.c:64
MODE_MEDIUM
@ MODE_MEDIUM
Definition: vf_mcdeint.c:61
AV_CODEC_FLAG_QSCALE
#define AV_CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:210
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
MODE_FAST
@ MODE_FAST
Definition: vf_mcdeint.c:60
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
avcodec_find_encoder
const AVCodec * avcodec_find_encoder(enum AVCodecID id)
Find a registered encoder with a matching codec ID.
Definition: allcodecs.c:914
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
w
uint8_t w
Definition: llviddspenc.c:38
AVOption
AVOption.
Definition: opt.h:247
AVDictionary
Definition: dict.c:30
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
PARITY_BFF
@ PARITY_BFF
bottom field first
Definition: vf_mcdeint.c:69
AV_CODEC_FLAG_4MV
#define AV_CODEC_FLAG_4MV
4 MV per MB allowed / advanced prediction for H.263.
Definition: avcodec.h:214
AVCodecContext::mb_cmp
int mb_cmp
macroblock comparison function (not supported yet)
Definition: avcodec.h:772
av_packet_free
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
Definition: avpacket.c:75
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
ff_filter_frame
return ff_filter_frame(outlink, outpic)
formats.h
CHECK_EDGE
#define CHECK_EDGE(j)
U
#define U(x)
Definition: vp56_arith.h:37
AVCodecContext::refs
int refs
number of reference frames
Definition: avcodec.h:932
AVCodecContext::flags
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:463
AV_CODEC_FLAG_LOW_DELAY
#define AV_CODEC_FLAG_LOW_DELAY
Force low delay.
Definition: avcodec.h:264
FF_CMP_SSE
#define FF_CMP_SSE
Definition: avcodec.h:780
mcdeint_options
static const AVOption mcdeint_options[]
Definition: vf_mcdeint.c:85
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
else
else
Definition: vf_mcdeint.c:238
avcodec_alloc_context3
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:141
AVCodecContext::global_quality
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:449
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
MCDeintParity
MCDeintParity
Definition: vf_mcdeint.c:67
ctx
AVFormatContext * ctx
Definition: movenc.c:48
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
FFABS
#define FFABS(a)
Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they are not representable ...
Definition: common.h:65
filp
* filp
Definition: vf_mcdeint.c:249
opts
AVDictionary * opts
Definition: movenc.c:50
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
CHECK
#define CHECK(j)
MCDeintContext
Definition: vf_mcdeint.c:72
avcodec_free_context
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer.
Definition: options.c:156
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
avcodec_open2
int attribute_align_arg avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: avcodec.c:137
AVCodecContext::me_cmp
int me_cmp
motion estimation comparison function
Definition: avcodec.h:760
MODE_EXTRA_SLOW
@ MODE_EXTRA_SLOW
Definition: vf_mcdeint.c:63
AVCodecContext::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:506
AV_CODEC_FLAG_QPEL
#define AV_CODEC_FLAG_QPEL
Use qpel MC.
Definition: avcodec.h:222
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
AVCodecContext::gop_size
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition: avcodec.h:578
MCDeintMode
MCDeintMode
Definition: vf_mcdeint.c:59
parity
mcdeint parity
Definition: vf_mcdeint.c:266
MCDeintContext::enc_ctx
AVCodecContext * enc_ctx
Definition: vf_mcdeint.c:78
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(mcdeint)
PARITY_TFF
@ PARITY_TFF
top field first
Definition: vf_mcdeint.c:68
AVCodecContext::me_sub_cmp
int me_sub_cmp
subpixel motion estimation comparison function
Definition: avcodec.h:766
GET_SCORE_EDGE
#define GET_SCORE_EDGE(j)
av_packet_alloc
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: avpacket.c:64
av_dict_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:203
config_props
static int config_props(AVFilterLink *inlink)
Definition: vf_mcdeint.c:102
FF_CMP_SAD
#define FF_CMP_SAD
Definition: avcodec.h:779
internal.h
FILTER_SINGLE_PIXFMT
#define FILTER_SINGLE_PIXFMT(pix_fmt_)
Definition: internal.h:181
OFFSET
#define OFFSET(x)
Definition: vf_mcdeint.c:81
ff_vf_mcdeint
const AVFilter ff_vf_mcdeint
Definition: vf_mcdeint.c:294
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
AVCodecContext::dia_size
int dia_size
ME diamond size & shape.
Definition: avcodec.h:802
CONST
#define CONST(name, help, val, unit)
Definition: vf_mcdeint.c:83
MCDeintContext::mode
int mode
MCDeintMode.
Definition: vf_mcdeint.c:74
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
AVCodecContext::height
int height
Definition: avcodec.h:556
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:593
GET_SCORE
#define GET_SCORE(j)
MCDeintContext::qp
int qp
Definition: vf_mcdeint.c:76
avcodec.h
AVFilter
Filter definition.
Definition: avfilter.h:149
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
Definition: vf_mcdeint.c:165
FLAGS
#define FLAGS
Definition: vf_mcdeint.c:82
if
if(ret< 0)
Definition: vf_mcdeint.c:271
ret
ret
Definition: filter_design.txt:187
AVCodecContext::strict_std_compliance
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition: avcodec.h:1280
mcdeint_inputs
static const AVFilterPad mcdeint_inputs[]
Definition: vf_mcdeint.c:278
AVCodecContext
main external API structure.
Definition: avcodec.h:383
AV_CODEC_ID_SNOW
@ AV_CODEC_ID_SNOW
Definition: codec_id.h:262
mode
mode
Definition: ebur128.h:83
mcdeint_outputs
static const AVFilterPad mcdeint_outputs[]
Definition: vf_mcdeint.c:287
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
temp
else temp
Definition: vf_mcdeint.c:248
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_mcdeint.c:157
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVCodecContext::max_b_frames
int max_b_frames
maximum number of B-frames between non-B-frames Note: The output will be delayed by max_b_frames+1 re...
Definition: avcodec.h:655
AVPacket
This structure stores compressed data.
Definition: packet.h:350
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
av_dict_set
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:70
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:556
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
h
h
Definition: vp9dsp_template.c:2038
FF_QP2LAMBDA
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:227