FFmpeg
vf_telecine.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 Rudolf Polzer
3  * Copyright (c) 2013 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file telecine filter, heavily based from mpv-player:TOOLS/vf_dlopen/telecine.c by
24  * Rudolf Polzer.
25  */
26 
27 #include "libavutil/avstring.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
31 #include "avfilter.h"
32 #include "formats.h"
33 #include "internal.h"
34 #include "video.h"
35 
36 typedef struct TelecineContext {
37  const AVClass *class;
39  char *pattern;
40  unsigned int pattern_pos;
41  int64_t start_time;
42 
45  int out_cnt;
46  int occupied;
47 
48  int nb_planes;
49  int planeheight[4];
50  int stride[4];
51 
55 
56 #define OFFSET(x) offsetof(TelecineContext, x)
57 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
58 
59 static const AVOption telecine_options[] = {
60  {"first_field", "select first field", OFFSET(first_field), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "field"},
61  {"top", "select top field first", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "field"},
62  {"t", "select top field first", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "field"},
63  {"bottom", "select bottom field first", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "field"},
64  {"b", "select bottom field first", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "field"},
65  {"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},
66  {NULL}
67 };
68 
69 AVFILTER_DEFINE_CLASS(telecine);
70 
72 {
73  TelecineContext *s = ctx->priv;
74  const char *p;
75  int max = 0;
76 
77  if (!strlen(s->pattern)) {
78  av_log(ctx, AV_LOG_ERROR, "No pattern provided.\n");
79  return AVERROR_INVALIDDATA;
80  }
81 
82  for (p = s->pattern; *p; p++) {
83  if (!av_isdigit(*p)) {
84  av_log(ctx, AV_LOG_ERROR, "Provided pattern includes non-numeric characters.\n");
85  return AVERROR_INVALIDDATA;
86  }
87 
88  max = FFMAX(*p - '0', max);
89  s->pts.num += 2;
90  s->pts.den += *p - '0';
91  }
92 
93  s->start_time = AV_NOPTS_VALUE;
94 
95  s->out_cnt = (max + 1) / 2;
96  av_log(ctx, AV_LOG_INFO, "Telecine pattern %s yields up to %d frames per frame, pts advance factor: %d/%d\n",
97  s->pattern, s->out_cnt, s->pts.num, s->pts.den);
98 
99  return 0;
100 }
101 
103 {
105  int ret;
106 
111  if (ret < 0)
112  return ret;
114 }
115 
117 {
118  TelecineContext *s = inlink->dst->priv;
120  int i, ret;
121 
122  s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
123  if (!s->temp)
124  return AVERROR(ENOMEM);
125  for (i = 0; i < s->out_cnt; i++) {
126  s->frame[i] = ff_get_video_buffer(inlink, inlink->w, inlink->h);
127  if (!s->frame[i])
128  return AVERROR(ENOMEM);
129  }
130 
131  if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
132  return ret;
133 
134  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
135  s->planeheight[0] = s->planeheight[3] = inlink->h;
136 
137  s->nb_planes = av_pix_fmt_count_planes(inlink->format);
138 
139  return 0;
140 }
141 
142 static int config_output(AVFilterLink *outlink)
143 {
144  AVFilterContext *ctx = outlink->src;
145  TelecineContext *s = ctx->priv;
146  const AVFilterLink *inlink = ctx->inputs[0];
147  AVRational fps = inlink->frame_rate;
148 
149  if (!fps.num || !fps.den) {
150  av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
151  "current rate of %d/%d is invalid\n", fps.num, fps.den);
152  return AVERROR(EINVAL);
153  }
154  fps = av_mul_q(fps, av_inv_q(s->pts));
155  av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
156  inlink->frame_rate.num, inlink->frame_rate.den, fps.num, fps.den);
157 
158  outlink->frame_rate = fps;
159  outlink->time_base = av_mul_q(inlink->time_base, s->pts);
160  av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
161  inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
162 
163  s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
164 
165  return 0;
166 }
167 
168 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
169 {
170  AVFilterContext *ctx = inlink->dst;
171  AVFilterLink *outlink = ctx->outputs[0];
172  TelecineContext *s = ctx->priv;
173  int i, len, ret = 0, nout = 0;
174 
175  if (s->start_time == AV_NOPTS_VALUE)
176  s->start_time = inpicref->pts;
177 
178  len = s->pattern[s->pattern_pos] - '0';
179 
180  s->pattern_pos++;
181  if (!s->pattern[s->pattern_pos])
182  s->pattern_pos = 0;
183 
184  if (!len) { // do not output any field from this frame
185  av_frame_free(&inpicref);
186  return 0;
187  }
188 
189  if (s->occupied) {
190  av_frame_make_writable(s->frame[nout]);
191  for (i = 0; i < s->nb_planes; i++) {
192  // fill in the EARLIER field from the buffered pic
193  av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * s->first_field,
194  s->frame[nout]->linesize[i] * 2,
195  s->temp->data[i] + s->temp->linesize[i] * s->first_field,
196  s->temp->linesize[i] * 2,
197  s->stride[i],
198  (s->planeheight[i] - s->first_field + 1) / 2);
199  // fill in the LATER field from the new pic
200  av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * !s->first_field,
201  s->frame[nout]->linesize[i] * 2,
202  inpicref->data[i] + inpicref->linesize[i] * !s->first_field,
203  inpicref->linesize[i] * 2,
204  s->stride[i],
205  (s->planeheight[i] - !s->first_field + 1) / 2);
206  }
207  s->frame[nout]->interlaced_frame = 1;
208  s->frame[nout]->top_field_first = !s->first_field;
209  nout++;
210  len--;
211  s->occupied = 0;
212  }
213 
214  while (len >= 2) {
215  // output THIS image as-is
216  av_frame_make_writable(s->frame[nout]);
217  for (i = 0; i < s->nb_planes; i++)
218  av_image_copy_plane(s->frame[nout]->data[i], s->frame[nout]->linesize[i],
219  inpicref->data[i], inpicref->linesize[i],
220  s->stride[i],
221  s->planeheight[i]);
222  s->frame[nout]->interlaced_frame = inpicref->interlaced_frame;
223  s->frame[nout]->top_field_first = inpicref->top_field_first;
224  nout++;
225  len -= 2;
226  }
227 
228  if (len >= 1) {
229  // copy THIS image to the buffer, we need it later
230  for (i = 0; i < s->nb_planes; i++)
231  av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
232  inpicref->data[i], inpicref->linesize[i],
233  s->stride[i],
234  s->planeheight[i]);
235  s->occupied = 1;
236  }
237 
238  for (i = 0; i < nout; i++) {
239  AVFrame *frame = av_frame_clone(s->frame[i]);
240  int interlaced = frame ? frame->interlaced_frame : 0;
241  int tff = frame ? frame->top_field_first : 0;
242 
243  if (!frame) {
244  av_frame_free(&inpicref);
245  return AVERROR(ENOMEM);
246  }
247 
248  av_frame_copy_props(frame, inpicref);
249  frame->interlaced_frame = interlaced;
250  frame->top_field_first = tff;
251  frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
252  av_rescale(outlink->frame_count_in, s->ts_unit.num,
253  s->ts_unit.den);
254  ret = ff_filter_frame(outlink, frame);
255  }
256  av_frame_free(&inpicref);
257 
258  return ret;
259 }
260 
262 {
263  TelecineContext *s = ctx->priv;
264  int i;
265 
266  av_frame_free(&s->temp);
267  for (i = 0; i < s->out_cnt; i++)
268  av_frame_free(&s->frame[i]);
269 }
270 
271 static const AVFilterPad telecine_inputs[] = {
272  {
273  .name = "default",
274  .type = AVMEDIA_TYPE_VIDEO,
275  .filter_frame = filter_frame,
276  .config_props = config_input,
277  },
278  { NULL }
279 };
280 
281 static const AVFilterPad telecine_outputs[] = {
282  {
283  .name = "default",
284  .type = AVMEDIA_TYPE_VIDEO,
285  .config_props = config_output,
286  },
287  { NULL }
288 };
289 
291  .name = "telecine",
292  .description = NULL_IF_CONFIG_SMALL("Apply a telecine pattern."),
293  .priv_size = sizeof(TelecineContext),
294  .priv_class = &telecine_class,
295  .init = init,
296  .uninit = uninit,
300 };
formats
formats
Definition: signature.h:48
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:97
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
TelecineContext::pattern_pos
unsigned int pattern_pos
Definition: vf_telecine.c:40
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:978
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2540
ff_formats_pixdesc_filter
int ff_formats_pixdesc_filter(AVFilterFormats **rfmts, unsigned want, unsigned rej)
Construct a formats list containing all pixel formats with certain properties.
Definition: formats.c:360
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
av_frame_make_writable
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:490
pixdesc.h
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:396
AVFrame::top_field_first
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:438
AVOption
AVOption.
Definition: opt.h:247
TelecineContext::occupied
int occupied
Definition: vf_telecine.c:46
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:196
TelecineContext::temp
AVFrame * temp
Definition: vf_telecine.c:53
max
#define max(a, b)
Definition: cuda_runtime.h:33
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
telecine_options
static const AVOption telecine_options[]
Definition: vf_telecine.c:59
video.h
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
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
formats.h
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2580
AV_PIX_FMT_FLAG_HWACCEL
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:128
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
Definition: vf_telecine.c:168
AVRational::num
int num
Numerator.
Definition: rational.h:59
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
TelecineContext::pattern
char * pattern
Definition: vf_telecine.c:39
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
inputs
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
Definition: filter_design.txt:243
ff_set_common_formats
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:580
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_telecine.c:261
TelecineContext::stride
int stride[4]
Definition: vf_telecine.c:50
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
TelecineContext::out_cnt
int out_cnt
Definition: vf_telecine.c:45
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58
telecine_inputs
static const AVFilterPad telecine_inputs[]
Definition: vf_telecine.c:271
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_frame_clone
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:424
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
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_telecine.c:116
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:116
TelecineContext::frame
AVFrame * frame[5]
Definition: vf_telecine.c:52
FFMAX
#define FFMAX(a, b)
Definition: common.h:103
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_telecine.c:102
AV_PIX_FMT_FLAG_BITSTREAM
#define AV_PIX_FMT_FLAG_BITSTREAM
All values of a component are bit-wise packed end to end.
Definition: pixdesc.h:124
TelecineContext::planeheight
int planeheight[4]
Definition: vf_telecine.c:49
av_isdigit
static av_const int av_isdigit(int c)
Locale-independent conversion of ASCII isdigit.
Definition: avstring.h:211
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
internal.h
AVFrame::interlaced_frame
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:433
interlaced
uint8_t interlaced
Definition: mxfenc.c:2208
TelecineContext
Definition: vf_telecine.c:36
i
int i
Definition: input.c:406
ff_vf_telecine
const AVFilter ff_vf_telecine
Definition: vf_telecine.c:290
TelecineContext::ts_unit
AVRational ts_unit
Definition: vf_telecine.c:44
av_inv_q
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
len
int len
Definition: vorbis_enc_data.h:426
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
av_rescale
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:128
AVFilter
Filter definition.
Definition: avfilter.h:145
TelecineContext::pts
AVRational pts
Definition: vf_telecine.c:43
ret
ret
Definition: filter_design.txt:187
frame
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 the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
TelecineContext::first_field
int first_field
Definition: vf_telecine.c:38
OFFSET
#define OFFSET(x)
Definition: vf_telecine.c:56
telecine_outputs
static const AVFilterPad telecine_outputs[]
Definition: vf_telecine.c:281
AVRational::den
int den
Denominator.
Definition: rational.h:60
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_telecine.c:71
av_mul_q
AVRational av_mul_q(AVRational b, AVRational c)
Multiply two rationals.
Definition: rational.c:80
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
desc
const char * desc
Definition: libsvtav1.c:79
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
TelecineContext::start_time
int64_t start_time
Definition: vf_telecine.c:41
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(telecine)
config_output
static int config_output(AVFilterLink *outlink)
Definition: vf_telecine.c:142
imgutils.h
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
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
avstring.h
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:228
first_field
static int first_field(const struct video_data *s)
Definition: v4l2.c:235
AV_PIX_FMT_FLAG_PAL
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
Definition: pixdesc.h:120
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
FLAGS
#define FLAGS
Definition: vf_telecine.c:57
TelecineContext::nb_planes
int nb_planes
Definition: vf_telecine.c:48