2 * Copyright (c) 2012 Rudolf Polzer
3 * Copyright (c) 2013 Paul B Mahol
5 * This file is part of FFmpeg.
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.
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.
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
23 * @file telecine filter, heavily based from mpv-player:TOOLS/vf_dlopen/telecine.c by
27 #include "libavutil/avstring.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
36 typedef struct TelecineContext {
40 unsigned int pattern_pos;
56 #define OFFSET(x) offsetof(TelecineContext, x)
57 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
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},
69 AVFILTER_DEFINE_CLASS(telecine);
71 static av_cold int init(AVFilterContext *ctx)
73 TelecineContext *s = ctx->priv;
77 if (!strlen(s->pattern)) {
78 av_log(ctx, AV_LOG_ERROR, "No pattern provided.\n");
79 return AVERROR_INVALIDDATA;
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;
88 max = FFMAX(*p - '0', max);
90 s->pts.den += *p - '0';
93 s->start_time = AV_NOPTS_VALUE;
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);
102 static int query_formats(AVFilterContext *ctx)
104 AVFilterFormats *pix_fmts = NULL;
107 for (fmt = 0; av_pix_fmt_desc_get(fmt); fmt++) {
108 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
109 if (!(desc->flags & AV_PIX_FMT_FLAG_HWACCEL ||
110 desc->flags & AV_PIX_FMT_FLAG_PAL ||
111 desc->flags & AV_PIX_FMT_FLAG_BITSTREAM) &&
112 (ret = ff_add_format(&pix_fmts, fmt)) < 0)
116 return ff_set_common_formats(ctx, pix_fmts);
119 static int config_input(AVFilterLink *inlink)
121 TelecineContext *s = inlink->dst->priv;
122 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
125 s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
127 return AVERROR(ENOMEM);
128 for (i = 0; i < s->out_cnt; i++) {
129 s->frame[i] = ff_get_video_buffer(inlink, inlink->w, inlink->h);
131 return AVERROR(ENOMEM);
134 if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
137 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
138 s->planeheight[0] = s->planeheight[3] = inlink->h;
140 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
145 static int config_output(AVFilterLink *outlink)
147 AVFilterContext *ctx = outlink->src;
148 TelecineContext *s = ctx->priv;
149 const AVFilterLink *inlink = ctx->inputs[0];
150 AVRational fps = inlink->frame_rate;
152 if (!fps.num || !fps.den) {
153 av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
154 "current rate of %d/%d is invalid\n", fps.num, fps.den);
155 return AVERROR(EINVAL);
157 fps = av_mul_q(fps, av_inv_q(s->pts));
158 av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
159 inlink->frame_rate.num, inlink->frame_rate.den, fps.num, fps.den);
161 outlink->frame_rate = fps;
162 outlink->time_base = av_mul_q(inlink->time_base, s->pts);
163 av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
164 inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
166 s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
171 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
173 AVFilterContext *ctx = inlink->dst;
174 AVFilterLink *outlink = ctx->outputs[0];
175 TelecineContext *s = ctx->priv;
176 int i, len, ret = 0, nout = 0;
178 if (s->start_time == AV_NOPTS_VALUE)
179 s->start_time = inpicref->pts;
181 len = s->pattern[s->pattern_pos] - '0';
184 if (!s->pattern[s->pattern_pos])
187 if (!len) { // do not output any field from this frame
188 av_frame_free(&inpicref);
193 av_frame_make_writable(s->frame[nout]);
194 for (i = 0; i < s->nb_planes; i++) {
195 // fill in the EARLIER field from the buffered pic
196 av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * s->first_field,
197 s->frame[nout]->linesize[i] * 2,
198 s->temp->data[i] + s->temp->linesize[i] * s->first_field,
199 s->temp->linesize[i] * 2,
201 (s->planeheight[i] - s->first_field + 1) / 2);
202 // fill in the LATER field from the new pic
203 av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * !s->first_field,
204 s->frame[nout]->linesize[i] * 2,
205 inpicref->data[i] + inpicref->linesize[i] * !s->first_field,
206 inpicref->linesize[i] * 2,
208 (s->planeheight[i] - !s->first_field + 1) / 2);
216 // output THIS image as-is
217 av_frame_make_writable(s->frame[nout]);
218 for (i = 0; i < s->nb_planes; i++)
219 av_image_copy_plane(s->frame[nout]->data[i], s->frame[nout]->linesize[i],
220 inpicref->data[i], inpicref->linesize[i],
228 // copy THIS image to the buffer, we need it later
229 for (i = 0; i < s->nb_planes; i++)
230 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
231 inpicref->data[i], inpicref->linesize[i],
237 for (i = 0; i < nout; i++) {
238 AVFrame *frame = av_frame_clone(s->frame[i]);
241 av_frame_free(&inpicref);
242 return AVERROR(ENOMEM);
245 av_frame_copy_props(frame, inpicref);
246 frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
247 av_rescale(outlink->frame_count_in, s->ts_unit.num,
249 ret = ff_filter_frame(outlink, frame);
251 av_frame_free(&inpicref);
256 static av_cold void uninit(AVFilterContext *ctx)
258 TelecineContext *s = ctx->priv;
261 av_frame_free(&s->temp);
262 for (i = 0; i < s->out_cnt; i++)
263 av_frame_free(&s->frame[i]);
266 static const AVFilterPad telecine_inputs[] = {
269 .type = AVMEDIA_TYPE_VIDEO,
270 .filter_frame = filter_frame,
271 .config_props = config_input,
276 static const AVFilterPad telecine_outputs[] = {
279 .type = AVMEDIA_TYPE_VIDEO,
280 .config_props = config_output,
285 AVFilter ff_vf_telecine = {
287 .description = NULL_IF_CONFIG_SMALL("Apply a telecine pattern."),
288 .priv_size = sizeof(TelecineContext),
289 .priv_class = &telecine_class,
292 .query_formats = query_formats,
293 .inputs = telecine_inputs,
294 .outputs = telecine_outputs,