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 ff_set_common_formats(ctx, pix_fmts);
133 static int config_input(AVFilterLink *inlink)
135 DetelecineContext *s = inlink->dst->priv;
136 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
139 s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
141 return AVERROR(ENOMEM);
143 s->frame = ff_get_video_buffer(inlink, inlink->w, inlink->h);
145 return AVERROR(ENOMEM);
147 if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
150 s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
151 s->planeheight[0] = s->planeheight[3] = inlink->h;
153 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
158 static int config_output(AVFilterLink *outlink)
160 AVFilterContext *ctx = outlink->src;
161 DetelecineContext *s = ctx->priv;
162 const AVFilterLink *inlink = ctx->inputs[0];
163 AVRational fps = inlink->frame_rate;
165 if (!fps.num || !fps.den) {
166 av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
167 "current rate of %d/%d is invalid\n", fps.num, fps.den);
168 return AVERROR(EINVAL);
170 fps = av_mul_q(fps, av_inv_q(s->pts));
171 av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
172 inlink->frame_rate.num, inlink->frame_rate.den, fps.num, fps.den);
174 outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
175 outlink->frame_rate = fps;
176 outlink->time_base = av_mul_q(inlink->time_base, s->pts);
177 av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
178 inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
180 s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
185 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
187 AVFilterContext *ctx = inlink->dst;
188 AVFilterLink *outlink = ctx->outputs[0];
189 DetelecineContext *s = ctx->priv;
190 int i, len = 0, ret = 0, out = 0;
192 if (s->start_time == AV_NOPTS_VALUE)
193 s->start_time = inpicref->pts;
195 if (s->nskip_fields >= 2) {
196 s->nskip_fields -= 2;
198 } else if (s->nskip_fields >= 1) {
204 for (i = 0; i < s->nb_planes; i++) {
205 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
206 inpicref->data[i], inpicref->linesize[i],
216 if (s->nskip_fields == 0) {
217 while(!len && s->pattern[s->pattern_pos]) {
218 len = s->pattern[s->pattern_pos] - '0';
222 if (!s->pattern[s->pattern_pos])
225 if(!len) { // do not output any field as the entire pattern is zero
226 av_frame_free(&inpicref);
231 for (i = 0; i < s->nb_planes; i++) {
232 // fill in the EARLIER field from the new pic
233 av_image_copy_plane(s->frame->data[i] + s->frame->linesize[i] * s->first_field,
234 s->frame->linesize[i] * 2,
235 inpicref->data[i] + inpicref->linesize[i] * s->first_field,
236 inpicref->linesize[i] * 2,
238 (s->planeheight[i] - s->first_field + 1) / 2);
239 // fill in the LATER field from the buffered pic
240 av_image_copy_plane(s->frame->data[i] + s->frame->linesize[i] * !s->first_field,
241 s->frame->linesize[i] * 2,
242 s->temp->data[i] + s->temp->linesize[i] * !s->first_field,
243 s->temp->linesize[i] * 2,
245 (s->planeheight[i] - !s->first_field + 1) / 2);
248 for (i = 0; i < s->nb_planes; i++) {
249 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
250 inpicref->data[i], inpicref->linesize[i],
258 // output THIS image as-is
259 for (i = 0; i < s->nb_planes; i++)
260 av_image_copy_plane(s->frame->data[i], s->frame->linesize[i],
261 inpicref->data[i], inpicref->linesize[i],
266 } else if (len == 1) {
267 // fill in the EARLIER field from the new pic
268 for (i = 0; i < s->nb_planes; i++) {
269 av_image_copy_plane(s->frame->data[i] +
270 s->frame->linesize[i] * s->first_field,
271 s->frame->linesize[i] * 2,
273 inpicref->linesize[i] * s->first_field,
274 inpicref->linesize[i] * 2, s->stride[i],
275 (s->planeheight[i] - s->first_field + 1) / 2);
278 // TODO: not sure about the other field
285 if (len == 1 && s->occupied)
291 s->nskip_fields = len;
294 AVFrame *frame = av_frame_clone(s->frame);
297 av_frame_free(&inpicref);
298 return AVERROR(ENOMEM);
301 av_frame_copy_props(frame, inpicref);
302 frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
303 av_rescale(outlink->frame_count, s->ts_unit.num,
305 ret = ff_filter_frame(outlink, frame);
308 av_frame_free(&inpicref);
313 static av_cold void uninit(AVFilterContext *ctx)
315 DetelecineContext *s = ctx->priv;
317 av_frame_free(&s->temp);
318 av_frame_free(&s->frame);
321 static const AVFilterPad detelecine_inputs[] = {
324 .type = AVMEDIA_TYPE_VIDEO,
325 .filter_frame = filter_frame,
326 .config_props = config_input,
331 static const AVFilterPad detelecine_outputs[] = {
334 .type = AVMEDIA_TYPE_VIDEO,
335 .config_props = config_output,
340 AVFilter ff_vf_detelecine = {
341 .name = "detelecine",
342 .description = NULL_IF_CONFIG_SMALL("Apply an inverse telecine pattern."),
343 .priv_size = sizeof(DetelecineContext),
344 .priv_class = &detelecine_class,
347 .query_formats = query_formats,
348 .inputs = detelecine_inputs,
349 .outputs = detelecine_outputs,