avfilter/vf_maskedmerge: get rid of MaskedMergeContext from functions that do actual...
[ffmpeg.git] / libavfilter / vf_telecine.c
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 {
37     const AVClass *class;
38     int first_field;
39     char *pattern;
40     unsigned int pattern_pos;
41     int64_t start_time;
42
43     AVRational pts;
44     AVRational ts_unit;
45     int out_cnt;
46     int occupied;
47
48     int nb_planes;
49     int planeheight[4];
50     int stride[4];
51
52     AVFrame *frame[5];
53     AVFrame *temp;
54 } TelecineContext;
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
71 static av_cold int init(AVFilterContext *ctx)
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
102 static int query_formats(AVFilterContext *ctx)
103 {
104     AVFilterFormats *pix_fmts = NULL;
105     int fmt;
106
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             ff_add_format(&pix_fmts, fmt);
113     }
114
115     return ff_set_common_formats(ctx, pix_fmts);
116 }
117
118 static int config_input(AVFilterLink *inlink)
119 {
120     TelecineContext *s = inlink->dst->priv;
121     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
122     int i, ret;
123
124     s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
125     if (!s->temp)
126         return AVERROR(ENOMEM);
127     for (i = 0; i < s->out_cnt; i++) {
128         s->frame[i] = ff_get_video_buffer(inlink, inlink->w, inlink->h);
129         if (!s->frame[i])
130             return AVERROR(ENOMEM);
131     }
132
133     if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
134         return ret;
135
136     s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
137     s->planeheight[0] = s->planeheight[3] = inlink->h;
138
139     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
140
141     return 0;
142 }
143
144 static int config_output(AVFilterLink *outlink)
145 {
146     AVFilterContext *ctx = outlink->src;
147     TelecineContext *s = ctx->priv;
148     const AVFilterLink *inlink = ctx->inputs[0];
149     AVRational fps = inlink->frame_rate;
150
151     if (!fps.num || !fps.den) {
152         av_log(ctx, AV_LOG_ERROR, "The input needs a constant frame rate; "
153                "current rate of %d/%d is invalid\n", fps.num, fps.den);
154         return AVERROR(EINVAL);
155     }
156     fps = av_mul_q(fps, av_inv_q(s->pts));
157     av_log(ctx, AV_LOG_VERBOSE, "FPS: %d/%d -> %d/%d\n",
158            inlink->frame_rate.num, inlink->frame_rate.den, fps.num, fps.den);
159
160     outlink->frame_rate = fps;
161     outlink->time_base = av_mul_q(inlink->time_base, s->pts);
162     av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
163            inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
164
165     s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
166
167     return 0;
168 }
169
170 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
171 {
172     AVFilterContext *ctx = inlink->dst;
173     AVFilterLink *outlink = ctx->outputs[0];
174     TelecineContext *s = ctx->priv;
175     int i, len, ret = 0, nout = 0;
176
177     if (s->start_time == AV_NOPTS_VALUE)
178         s->start_time = inpicref->pts;
179
180     len = s->pattern[s->pattern_pos] - '0';
181
182     s->pattern_pos++;
183     if (!s->pattern[s->pattern_pos])
184         s->pattern_pos = 0;
185
186     if (!len) { // do not output any field from this frame
187         av_frame_free(&inpicref);
188         return 0;
189     }
190
191     if (s->occupied) {
192         for (i = 0; i < s->nb_planes; i++) {
193             // fill in the EARLIER field from the buffered pic
194             av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * s->first_field,
195                                 s->frame[nout]->linesize[i] * 2,
196                                 s->temp->data[i] + s->temp->linesize[i] * s->first_field,
197                                 s->temp->linesize[i] * 2,
198                                 s->stride[i],
199                                 (s->planeheight[i] - s->first_field + 1) / 2);
200             // fill in the LATER field from the new pic
201             av_image_copy_plane(s->frame[nout]->data[i] + s->frame[nout]->linesize[i] * !s->first_field,
202                                 s->frame[nout]->linesize[i] * 2,
203                                 inpicref->data[i] + inpicref->linesize[i] * !s->first_field,
204                                 inpicref->linesize[i] * 2,
205                                 s->stride[i],
206                                 (s->planeheight[i] - !s->first_field + 1) / 2);
207         }
208         nout++;
209         len--;
210         s->occupied = 0;
211     }
212
213     while (len >= 2) {
214         // output THIS image as-is
215         for (i = 0; i < s->nb_planes; i++)
216             av_image_copy_plane(s->frame[nout]->data[i], s->frame[nout]->linesize[i],
217                                 inpicref->data[i], inpicref->linesize[i],
218                                 s->stride[i],
219                                 s->planeheight[i]);
220         nout++;
221         len -= 2;
222     }
223
224     if (len >= 1) {
225         // copy THIS image to the buffer, we need it later
226         for (i = 0; i < s->nb_planes; i++)
227             av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
228                                 inpicref->data[i], inpicref->linesize[i],
229                                 s->stride[i],
230                                 s->planeheight[i]);
231         s->occupied = 1;
232     }
233
234     for (i = 0; i < nout; i++) {
235         AVFrame *frame = av_frame_clone(s->frame[i]);
236
237         if (!frame) {
238             av_frame_free(&inpicref);
239             return AVERROR(ENOMEM);
240         }
241
242         av_frame_copy_props(frame, inpicref);
243         frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
244                      av_rescale(outlink->frame_count, s->ts_unit.num,
245                                 s->ts_unit.den);
246         ret = ff_filter_frame(outlink, frame);
247     }
248     av_frame_free(&inpicref);
249
250     return ret;
251 }
252
253 static av_cold void uninit(AVFilterContext *ctx)
254 {
255     TelecineContext *s = ctx->priv;
256     int i;
257
258     av_frame_free(&s->temp);
259     for (i = 0; i < s->out_cnt; i++)
260         av_frame_free(&s->frame[i]);
261 }
262
263 static const AVFilterPad telecine_inputs[] = {
264     {
265         .name          = "default",
266         .type          = AVMEDIA_TYPE_VIDEO,
267         .filter_frame  = filter_frame,
268         .config_props  = config_input,
269     },
270     { NULL }
271 };
272
273 static const AVFilterPad telecine_outputs[] = {
274     {
275         .name          = "default",
276         .type          = AVMEDIA_TYPE_VIDEO,
277         .config_props  = config_output,
278     },
279     { NULL }
280 };
281
282 AVFilter ff_vf_telecine = {
283     .name          = "telecine",
284     .description   = NULL_IF_CONFIG_SMALL("Apply a telecine pattern."),
285     .priv_size     = sizeof(TelecineContext),
286     .priv_class    = &telecine_class,
287     .init          = init,
288     .uninit        = uninit,
289     .query_formats = query_formats,
290     .inputs        = telecine_inputs,
291     .outputs       = telecine_outputs,
292 };