FFmpeg
vf_detelecine.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Himangi Saraogi <himangi774@gmail.com>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /**
22  * @file detelecine filter.
23  */
24 
25 
26 #include "libavutil/avstring.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 #include "video.h"
34 
35 typedef struct DetelecineContext {
36  const AVClass *class;
38  char *pattern;
40  int init_len;
41  unsigned int pattern_pos;
42  unsigned int nskip_fields;
43  int64_t start_time;
44 
47  int occupied;
48 
49  int nb_planes;
50  int planeheight[4];
51  int stride[4];
52 
56 
57 #define OFFSET(x) offsetof(DetelecineContext, x)
58 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
59 
60 static const AVOption detelecine_options[] = {
61  {"first_field", "select first field", OFFSET(first_field), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "field"},
62  {"top", "select top field first", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "field"},
63  {"t", "select top field first", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "field"},
64  {"bottom", "select bottom field first", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "field"},
65  {"b", "select bottom field first", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "field"},
66  {"pattern", "pattern that describe for how many fields a frame is to be displayed", OFFSET(pattern), AV_OPT_TYPE_STRING, {.str="23"}, 0, 0, FLAGS},
67  {"start_frame", "position of first frame with respect to the pattern if stream is cut", OFFSET(start_frame), AV_OPT_TYPE_INT, {.i64=0}, 0, 13, FLAGS},
68  {NULL}
69 };
70 
71 AVFILTER_DEFINE_CLASS(detelecine);
72 
74 {
75  DetelecineContext *s = ctx->priv;
76  const char *p;
77  int max = 0;
78  int sum = 0;
79 
80  if (!strlen(s->pattern)) {
81  av_log(ctx, AV_LOG_ERROR, "No pattern provided.\n");
82  return AVERROR_INVALIDDATA;
83  }
84 
85  for (p = s->pattern; *p; p++) {
86  if (!av_isdigit(*p)) {
87  av_log(ctx, AV_LOG_ERROR, "Provided pattern includes non-numeric characters.\n");
88  return AVERROR_INVALIDDATA;
89  }
90 
91  sum += *p - '0';
92  max = FFMAX(*p - '0', max);
93  s->pts.num += *p - '0';
94  s->pts.den += 2;
95  }
96 
97  if (s->start_frame >= sum) {
98  av_log(ctx, AV_LOG_ERROR, "Provided start_frame is too big.\n");
99  return AVERROR_INVALIDDATA;
100  }
101 
102  s->nskip_fields = 0;
103  s->pattern_pos = 0;
105  s->init_len = 0;
106 
107  if (s->start_frame != 0) {
108  int nfields = 0;
109  for (p = s->pattern; *p; p++) {
110  nfields += *p - '0';
111  s->pattern_pos++;
112  if (nfields >= 2*s->start_frame) {
113  s->init_len = nfields - 2*s->start_frame;
114  break;
115  }
116  }
117  }
118 
119  av_log(ctx, AV_LOG_INFO, "Detelecine pattern %s removes up to %d frames per frame, pts advance factor: %d/%d\n",
120  s->pattern, (max + 1) / 2, s->pts.num, s->pts.den);
121 
122  return 0;
123 }
124 
126 {
128  int fmt, ret;
129 
130  for (fmt = 0; av_pix_fmt_desc_get(fmt); fmt++) {
132  if (!(desc->flags & AV_PIX_FMT_FLAG_HWACCEL ||
133  desc->flags & AV_PIX_FMT_FLAG_PAL ||
134  desc->flags & AV_PIX_FMT_FLAG_BITSTREAM) &&
135  (ret = ff_add_format(&pix_fmts, fmt)) < 0)
136  return ret;
137  }
138 
139  return ff_set_common_formats(ctx, pix_fmts);
140 }
141 
143 {
144  DetelecineContext *s = inlink->dst->priv;
146  int ret;
147 
148  s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
149  if (!s->temp)
150  return AVERROR(ENOMEM);
151 
152  s->frame[0] = ff_get_video_buffer(inlink, inlink->w, inlink->h);
153  if (!s->frame[0])
154  return AVERROR(ENOMEM);
155 
156  s->frame[1] = ff_get_video_buffer(inlink, inlink->w, inlink->h);
157  if (!s->frame[1])
158  return AVERROR(ENOMEM);
159 
160  if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
161  return ret;
162 
163  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
164  s->planeheight[0] = s->planeheight[3] = inlink->h;
165 
167 
168  return 0;
169 }
170 
171 static int config_output(AVFilterLink *outlink)
172 {
173  AVFilterContext *ctx = outlink->src;
174  DetelecineContext *s = ctx->priv;
175  const AVFilterLink *inlink = ctx->inputs[0];
176  AVRational fps = inlink->frame_rate;
177 
178  if (!fps.num || !fps.den) {
179  av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
180  "current rate of %d/%d is invalid\n", fps.num, fps.den);
181  return AVERROR(EINVAL);
182  }
183  fps = av_mul_q(fps, av_inv_q(s->pts));
184  av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
185  inlink->frame_rate.num, inlink->frame_rate.den, fps.num, fps.den);
186 
187  outlink->frame_rate = fps;
188  outlink->time_base = av_mul_q(inlink->time_base, s->pts);
189  av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
190  inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
191 
192  s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
193 
194  return 0;
195 }
196 
197 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
198 {
199  AVFilterContext *ctx = inlink->dst;
200  AVFilterLink *outlink = ctx->outputs[0];
201  DetelecineContext *s = ctx->priv;
202  int i, len = 0, ret = 0, out = 0;
203 
204  if (s->start_time == AV_NOPTS_VALUE)
205  s->start_time = inpicref->pts;
206 
207  if (s->nskip_fields >= 2) {
208  s->nskip_fields -= 2;
209  av_frame_free(&inpicref);
210  return 0;
211  } else if (s->nskip_fields >= 1) {
212  for (i = 0; i < s->nb_planes; i++) {
213  av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
214  inpicref->data[i], inpicref->linesize[i],
215  s->stride[i],
216  s->planeheight[i]);
217  }
218  s->occupied = 1;
219  s->nskip_fields--;
220  av_frame_free(&inpicref);
221  return 0;
222  }
223 
224  if (s->nskip_fields == 0) {
225  len = s->init_len;
226  s->init_len = 0;
227  while(!len && s->pattern[s->pattern_pos]) {
228  len = s->pattern[s->pattern_pos] - '0';
229  s->pattern_pos++;
230  }
231 
232  if (!s->pattern[s->pattern_pos])
233  s->pattern_pos = 0;
234 
235  if(!len) { // do not output any field as the entire pattern is zero
236  av_frame_free(&inpicref);
237  return 0;
238  }
239 
240  if (len == 1 && s->occupied) {
241  s->occupied = 0;
242  // output THIS image as-is
243  for (i = 0; i < s->nb_planes; i++)
245  s->temp->data[i], s->temp->linesize[i],
246  s->stride[i],
247  s->planeheight[i]);
248  len = 0;
249  while(!len && s->pattern[s->pattern_pos]) {
250  len = s->pattern[s->pattern_pos] - '0';
251  s->pattern_pos++;
252  }
253 
254  if (!s->pattern[s->pattern_pos])
255  s->pattern_pos = 0;
256 
257  s->occupied = 0;
258  ++out;
259  }
260 
261  if (s->occupied) {
262  for (i = 0; i < s->nb_planes; i++) {
263  // fill in the EARLIER field from the new pic
265  s->frame[out]->linesize[i] * 2,
266  inpicref->data[i] + inpicref->linesize[i] * s->first_field,
267  inpicref->linesize[i] * 2,
268  s->stride[i],
269  (s->planeheight[i] - s->first_field + 1) / 2);
270  // fill in the LATER field from the buffered pic
271  av_image_copy_plane(s->frame[out]->data[i] + s->frame[out]->linesize[i] * !s->first_field,
272  s->frame[out]->linesize[i] * 2,
273  s->temp->data[i] + s->temp->linesize[i] * !s->first_field,
274  s->temp->linesize[i] * 2,
275  s->stride[i],
276  (s->planeheight[i] - !s->first_field + 1) / 2);
277  }
278 
279  s->occupied = 0;
280  if (len <= 2) {
281  for (i = 0; i < s->nb_planes; i++) {
282  av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
283  inpicref->data[i], inpicref->linesize[i],
284  s->stride[i],
285  s->planeheight[i]);
286  }
287  s->occupied = 1;
288  }
289  ++out;
290  len = (len >= 3) ? len - 3 : 0;
291  } else {
292  if (len >= 2) {
293  // output THIS image as-is
294  for (i = 0; i < s->nb_planes; i++)
296  inpicref->data[i], inpicref->linesize[i],
297  s->stride[i],
298  s->planeheight[i]);
299  len -= 2;
300  ++out;
301  } else if (len == 1) {
302  // output THIS image as-is
303  for (i = 0; i < s->nb_planes; i++)
305  inpicref->data[i], inpicref->linesize[i],
306  s->stride[i],
307  s->planeheight[i]);
308 
309  for (i = 0; i < s->nb_planes; i++) {
310  av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
311  inpicref->data[i], inpicref->linesize[i],
312  s->stride[i],
313  s->planeheight[i]);
314  }
315  s->occupied = 1;
316 
317  len--;
318  ++out;
319  }
320  }
321 
322  if (len == 1 && s->occupied)
323  {
324  len--;
325  s->occupied = 0;
326  }
327  }
328  s->nskip_fields = len;
329 
330  for (i = 0; i < out; ++i) {
331  AVFrame *frame = av_frame_clone(s->frame[i]);
332 
333  if (!frame) {
334  av_frame_free(&inpicref);
335  return AVERROR(ENOMEM);
336  }
337 
338  av_frame_copy_props(frame, inpicref);
339  frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
340  av_rescale(outlink->frame_count_in, s->ts_unit.num,
341  s->ts_unit.den);
342  ret = ff_filter_frame(outlink, frame);
343  }
344 
345  av_frame_free(&inpicref);
346 
347  return ret;
348 }
349 
351 {
352  DetelecineContext *s = ctx->priv;
353 
354  av_frame_free(&s->temp);
355  av_frame_free(&s->frame[0]);
356  av_frame_free(&s->frame[1]);
357 }
358 
359 static const AVFilterPad detelecine_inputs[] = {
360  {
361  .name = "default",
362  .type = AVMEDIA_TYPE_VIDEO,
363  .filter_frame = filter_frame,
364  .config_props = config_input,
365  },
366  { NULL }
367 };
368 
369 static const AVFilterPad detelecine_outputs[] = {
370  {
371  .name = "default",
372  .type = AVMEDIA_TYPE_VIDEO,
373  .config_props = config_output,
374  },
375  { NULL }
376 };
377 
379  .name = "detelecine",
380  .description = NULL_IF_CONFIG_SMALL("Apply an inverse telecine pattern."),
381  .priv_size = sizeof(DetelecineContext),
382  .priv_class = &detelecine_class,
383  .init = init,
384  .uninit = uninit,
386  .inputs = detelecine_inputs,
387  .outputs = detelecine_outputs,
388 };
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
Definition: pixdesc.h:132
#define NULL
Definition: coverity.c:32
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
static av_const int av_isdigit(int c)
Locale-independent conversion of ASCII isdigit.
Definition: avstring.h:206
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2522
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
AVOption.
Definition: opt.h:246
const char * fmt
Definition: avisynth_c.h:861
misc image utilities
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2562
Main libavfilter public API header.
const char * desc
Definition: nvenc.c:68
int num
Numerator.
Definition: rational.h:59
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:99
const char * name
Pad name.
Definition: internal.h:60
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:346
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1093
#define av_cold
Definition: attributes.h:82
AVOptions.
static int config_input(AVFilterLink *inlink)
static av_cold void uninit(AVFilterContext *ctx)
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:388
AVFILTER_DEFINE_CLASS(detelecine)
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
#define max(a, b)
Definition: cuda_runtime.h:33
#define av_log(a,...)
#define FLAGS
Definition: vf_detelecine.c:58
static const AVOption detelecine_options[]
Definition: vf_detelecine.c:60
A filter pad used for either input or output.
Definition: internal.h:54
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:569
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:101
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
void * priv
private data for use by the filter
Definition: avfilter.h:353
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:140
int ff_add_format(AVFilterFormats **avff, int64_t fmt)
Add fmt to the list of media formats contained in *avff.
Definition: formats.c:336
#define FFMAX(a, b)
Definition: common.h:94
uint64_t flags
Combination of AV_PIX_FMT_FLAG_...
Definition: pixdesc.h:106
static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
int64_t av_rescale(int64_t a, int64_t b, int64_t c)
Rescale a 64-bit integer with rounding to nearest.
Definition: mathematics.c:129
AVFormatContext * ctx
Definition: movenc.c:48
static av_cold int init(AVFilterContext *ctx)
Definition: vf_detelecine.c:73
#define s(width, name)
Definition: cbs_vp9.c:257
static int config_output(AVFilterLink *outlink)
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:540
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
#define AV_LOG_INFO
Standard information.
Definition: log.h:187
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:326
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
AVFilter ff_vf_detelecine
AVRational ts_unit
Definition: vf_detelecine.c:46
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
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
Rational number (pair of numerator and denominator).
Definition: rational.h:58
const char * name
Filter name.
Definition: avfilter.h:148
AVFrame * frame[2]
Definition: vf_detelecine.c:53
#define AV_PIX_FMT_FLAG_BITSTREAM
All values of a component are bit-wise packed end to end.
Definition: pixdesc.h:136
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:275
static const AVFilterPad detelecine_inputs[]
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:309
unsigned int nskip_fields
Definition: vf_detelecine.c:42
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
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:104
unsigned int pattern_pos
Definition: vf_detelecine.c:41
int den
Denominator.
Definition: rational.h:60
static const AVFilterPad detelecine_outputs[]
int len
static int query_formats(AVFilterContext *ctx)
A list of supported formats for one end of a filter link.
Definition: formats.h:64
An instance of a filter.
Definition: avfilter.h:338
AVRational av_mul_q(AVRational b, AVRational c)
Multiply two rationals.
Definition: rational.c:80
FILE * out
Definition: movenc.c:54
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:338
internal API functions
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
#define OFFSET(x)
Definition: vf_detelecine.c:57
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:654
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58