2 * Copyright (c) 2015 Himangi Saraogi <himangi774@gmail.com>
4 * This file is part of FFmpeg.
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.
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.
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
22 * @file detelecine filter.
26 #include "libavutil/avstring.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
40 unsigned int pattern_pos;
41 unsigned int nskip_fields;
56 #define OFFSET(x) offsetof(DetelecineContext, x)
57 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
59 static const AVOption detelecine_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 {"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},
70 AVFILTER_DEFINE_CLASS(detelecine);
72 static av_cold int init(AVFilterContext *ctx)
74 DetelecineContext *s = ctx->priv;
78 if (!strlen(s->pattern)) {
79 av_log(ctx, AV_LOG_ERROR, "No pattern provided.\n");
80 return AVERROR_INVALIDDATA;
83 for (p = s->pattern; *p; p++) {
84 if (!av_isdigit(*p)) {
85 av_log(ctx, AV_LOG_ERROR, "Provided pattern includes non-numeric characters.\n");
86 return AVERROR_INVALIDDATA;
89 max = FFMAX(*p - '0', max);
90 s->pts.num += *p - '0';
96 s->start_time = AV_NOPTS_VALUE;
98 if (s->start_frame != 0) {
100 for (p = s->pattern; *p; p++) {
103 if (nfields >= 2*s->start_frame) {
104 s->nskip_fields = nfields - 2*s->start_frame;
110 av_log(ctx, AV_LOG_INFO, "Detelecine pattern %s removes up to %d frames per frame, pts advance factor: %d/%d\n",
111 s->pattern, (max + 1) / 2, s->pts.num, s->pts.den);
116 static int query_formats(AVFilterContext *ctx)
118 AVFilterFormats *pix_fmts = NULL;
121 for (fmt = 0; av_pix_fmt_desc_get(fmt); fmt++) {
122 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
123 if (!(desc->flags & AV_PIX_FMT_FLAG_HWACCEL ||
124 desc->flags & AV_PIX_FMT_FLAG_PAL ||
125 desc->flags & AV_PIX_FMT_FLAG_BITSTREAM))
126 ff_add_format(&pix_fmts, fmt);
129 return ff_set_common_formats(ctx, pix_fmts);
132 static int config_input(AVFilterLink *inlink)
134 DetelecineContext *s = inlink->dst->priv;
135 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
138 s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
140 return AVERROR(ENOMEM);
142 s->frame = ff_get_video_buffer(inlink, inlink->w, inlink->h);
144 return AVERROR(ENOMEM);
146 if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
149 s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
150 s->planeheight[0] = s->planeheight[3] = inlink->h;
152 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
157 static int config_output(AVFilterLink *outlink)
159 AVFilterContext *ctx = outlink->src;
160 DetelecineContext *s = ctx->priv;
161 const AVFilterLink *inlink = ctx->inputs[0];
162 AVRational fps = inlink->frame_rate;
164 if (!fps.num || !fps.den) {
165 av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
166 "current rate of %d/%d is invalid\n", fps.num, fps.den);
167 return AVERROR(EINVAL);
169 fps = av_mul_q(fps, av_inv_q(s->pts));
170 av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
171 inlink->frame_rate.num, inlink->frame_rate.den, fps.num, fps.den);
173 outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
174 outlink->frame_rate = fps;
175 outlink->time_base = av_mul_q(inlink->time_base, s->pts);
176 av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
177 inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
179 s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
184 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
186 AVFilterContext *ctx = inlink->dst;
187 AVFilterLink *outlink = ctx->outputs[0];
188 DetelecineContext *s = ctx->priv;
189 int i, len = 0, ret = 0, out = 0;
191 if (s->start_time == AV_NOPTS_VALUE)
192 s->start_time = inpicref->pts;
194 if (s->nskip_fields >= 2) {
195 s->nskip_fields -= 2;
197 } else if (s->nskip_fields >= 1) {
203 for (i = 0; i < s->nb_planes; i++) {
204 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
205 inpicref->data[i], inpicref->linesize[i],
215 if (s->nskip_fields == 0) {
216 while(!len && s->pattern[s->pattern_pos]) {
217 len = s->pattern[s->pattern_pos] - '0';
221 if (!s->pattern[s->pattern_pos])
224 if(!len) { // do not output any field as the entire pattern is zero
225 av_frame_free(&inpicref);
230 for (i = 0; i < s->nb_planes; i++) {
231 // fill in the EARLIER field from the new pic
232 av_image_copy_plane(s->frame->data[i] + s->frame->linesize[i] * s->first_field,
233 s->frame->linesize[i] * 2,
234 inpicref->data[i] + inpicref->linesize[i] * s->first_field,
235 inpicref->linesize[i] * 2,
237 (s->planeheight[i] - s->first_field + 1) / 2);
238 // fill in the LATER field from the buffered pic
239 av_image_copy_plane(s->frame->data[i] + s->frame->linesize[i] * !s->first_field,
240 s->frame->linesize[i] * 2,
241 s->temp->data[i] + s->temp->linesize[i] * !s->first_field,
242 s->temp->linesize[i] * 2,
244 (s->planeheight[i] - !s->first_field + 1) / 2);
247 for (i = 0; i < s->nb_planes; i++) {
248 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
249 inpicref->data[i], inpicref->linesize[i],
257 // output THIS image as-is
258 for (i = 0; i < s->nb_planes; i++)
259 av_image_copy_plane(s->frame->data[i], s->frame->linesize[i],
260 inpicref->data[i], inpicref->linesize[i],
265 } else if (len == 1) {
266 // fill in the EARLIER field from the new pic
267 for (i = 0; i < s->nb_planes; i++) {
268 av_image_copy_plane(s->frame->data[i] +
269 s->frame->linesize[i] * s->first_field,
270 s->frame->linesize[i] * 2,
272 inpicref->linesize[i] * s->first_field,
273 inpicref->linesize[i] * 2, s->stride[i],
274 (s->planeheight[i] - s->first_field + 1) / 2);
277 // TODO: not sure about the other field
284 if (len == 1 && s->occupied)
290 s->nskip_fields = len;
293 AVFrame *frame = av_frame_clone(s->frame);
296 av_frame_free(&inpicref);
297 return AVERROR(ENOMEM);
300 av_frame_copy_props(frame, inpicref);
301 frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
302 av_rescale(outlink->frame_count, s->ts_unit.num,
304 ret = ff_filter_frame(outlink, frame);
307 av_frame_free(&inpicref);
312 static av_cold void uninit(AVFilterContext *ctx)
314 DetelecineContext *s = ctx->priv;
316 av_frame_free(&s->temp);
317 av_frame_free(&s->frame);
320 static const AVFilterPad detelecine_inputs[] = {
323 .type = AVMEDIA_TYPE_VIDEO,
324 .filter_frame = filter_frame,
325 .config_props = config_input,
330 static const AVFilterPad detelecine_outputs[] = {
333 .type = AVMEDIA_TYPE_VIDEO,
334 .config_props = config_output,
339 AVFilter ff_vf_detelecine = {
340 .name = "detelecine",
341 .description = NULL_IF_CONFIG_SMALL("Apply an inverse telecine pattern."),
342 .priv_size = sizeof(DetelecineContext),
343 .priv_class = &detelecine_class,
346 .query_formats = query_formats,
347 .inputs = detelecine_inputs,
348 .outputs = detelecine_outputs,