x86/vf_w3fdif: simplify w3fdif_simple_high
[ffmpeg.git] / libavfilter / vf_detelecine.c
1 /*
2  * Copyright (c) 2015 Himangi Saraogi <himangi774@gmail.com>
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 /**
22  * @file detelecine filter.
23  */
24
25
26 #include "libavutil/avstring.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 #include "video.h"
34
35 typedef struct {
36     const AVClass *class;
37     int first_field;
38     char *pattern;
39     int start_frame;
40     unsigned int pattern_pos;
41     unsigned int nskip_fields;
42     int64_t start_time;
43
44     AVRational pts;
45     AVRational ts_unit;
46     int occupied;
47
48     int nb_planes;
49     int planeheight[4];
50     int stride[4];
51
52     AVFrame *frame;
53     AVFrame *temp;
54 } DetelecineContext;
55
56 #define OFFSET(x) offsetof(DetelecineContext, x)
57 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
58
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},
67     {NULL}
68 };
69
70 AVFILTER_DEFINE_CLASS(detelecine);
71
72 static av_cold int init(AVFilterContext *ctx)
73 {
74     DetelecineContext *s = ctx->priv;
75     const char *p;
76     int max = 0;
77
78     if (!strlen(s->pattern)) {
79         av_log(ctx, AV_LOG_ERROR, "No pattern provided.\n");
80         return AVERROR_INVALIDDATA;
81     }
82
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;
87         }
88
89         max = FFMAX(*p - '0', max);
90         s->pts.num += *p - '0';
91         s->pts.den += 2;
92     }
93
94     s->nskip_fields = 0;
95     s->pattern_pos = 0;
96     s->start_time = AV_NOPTS_VALUE;
97
98     if (s->start_frame != 0) {
99         int nfields = 0;
100         for (p = s->pattern; *p; p++) {
101             nfields += *p - '0';
102             s->pattern_pos++;
103             if (nfields >= 2*s->start_frame) {
104                 s->nskip_fields = nfields - 2*s->start_frame;
105                 break;
106             }
107         }
108     }
109
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);
112
113     return 0;
114 }
115
116 static int query_formats(AVFilterContext *ctx)
117 {
118     AVFilterFormats *pix_fmts = NULL;
119     int fmt;
120
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);
127     }
128
129     return ff_set_common_formats(ctx, pix_fmts);
130 }
131
132 static int config_input(AVFilterLink *inlink)
133 {
134     DetelecineContext *s = inlink->dst->priv;
135     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
136     int ret;
137
138     s->temp = ff_get_video_buffer(inlink, inlink->w, inlink->h);
139     if (!s->temp)
140         return AVERROR(ENOMEM);
141
142     s->frame = ff_get_video_buffer(inlink, inlink->w, inlink->h);
143     if (!s->frame)
144         return AVERROR(ENOMEM);
145
146     if ((ret = av_image_fill_linesizes(s->stride, inlink->format, inlink->w)) < 0)
147         return ret;
148
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;
151
152     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
153
154     return 0;
155 }
156
157 static int config_output(AVFilterLink *outlink)
158 {
159     AVFilterContext *ctx = outlink->src;
160     DetelecineContext *s = ctx->priv;
161     const AVFilterLink *inlink = ctx->inputs[0];
162     AVRational fps = inlink->frame_rate;
163
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);
168     }
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);
172
173     outlink->frame_rate = fps;
174     outlink->time_base = av_mul_q(inlink->time_base, s->pts);
175     av_log(ctx, AV_LOG_VERBOSE, "TB: %d/%d -> %d/%d\n",
176            inlink->time_base.num, inlink->time_base.den, outlink->time_base.num, outlink->time_base.den);
177
178     s->ts_unit = av_inv_q(av_mul_q(fps, outlink->time_base));
179
180     return 0;
181 }
182
183 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
184 {
185     AVFilterContext *ctx = inlink->dst;
186     AVFilterLink *outlink = ctx->outputs[0];
187     DetelecineContext *s = ctx->priv;
188     int i, len = 0, ret = 0, out = 0;
189
190     if (s->start_time == AV_NOPTS_VALUE)
191         s->start_time = inpicref->pts;
192
193     if (s->nskip_fields >= 2) {
194         s->nskip_fields -= 2;
195         return 0;
196     } else if (s->nskip_fields >= 1) {
197         if (s->occupied) {
198             s->occupied = 0;
199             s->nskip_fields--;
200         }
201         else {
202             for (i = 0; i < s->nb_planes; i++) {
203                 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
204                                     inpicref->data[i], inpicref->linesize[i],
205                                     s->stride[i],
206                                     s->planeheight[i]);
207             }
208             s->occupied = 1;
209             s->nskip_fields--;
210             return 0;
211         }
212     }
213
214     if (s->nskip_fields == 0) {
215         while(!len && s->pattern[s->pattern_pos]) {
216             len = s->pattern[s->pattern_pos] - '0';
217             s->pattern_pos++;
218         }
219
220         if (!s->pattern[s->pattern_pos])
221             s->pattern_pos = 0;
222
223         if(!len) { // do not output any field as the entire pattern is zero
224             av_frame_free(&inpicref);
225             return 0;
226         }
227
228         if (s->occupied) {
229             for (i = 0; i < s->nb_planes; i++) {
230                 // fill in the EARLIER field from the new pic
231                 av_image_copy_plane(s->frame->data[i] + s->frame->linesize[i] * s->first_field,
232                                     s->frame->linesize[i] * 2,
233                                     inpicref->data[i] + inpicref->linesize[i] * s->first_field,
234                                     inpicref->linesize[i] * 2,
235                                     s->stride[i],
236                                     (s->planeheight[i] - s->first_field + 1) / 2);
237                 // fill in the LATER field from the buffered pic
238                 av_image_copy_plane(s->frame->data[i] + s->frame->linesize[i] * !s->first_field,
239                                     s->frame->linesize[i] * 2,
240                                     s->temp->data[i] + s->temp->linesize[i] * !s->first_field,
241                                     s->temp->linesize[i] * 2,
242                                     s->stride[i],
243                                     (s->planeheight[i] - !s->first_field + 1) / 2);
244             }
245             len -= 2;
246             for (i = 0; i < s->nb_planes; i++) {
247                 av_image_copy_plane(s->temp->data[i], s->temp->linesize[i],
248                                     inpicref->data[i], inpicref->linesize[i],
249                                     s->stride[i],
250                                     s->planeheight[i]);
251             }
252             s->occupied = 1;
253             out = 1;
254         } else {
255             if (len >= 2) {
256                 // output THIS image as-is
257                 for (i = 0; i < s->nb_planes; i++)
258                     av_image_copy_plane(s->frame->data[i], s->frame->linesize[i],
259                                         inpicref->data[i], inpicref->linesize[i],
260                                         s->stride[i],
261                                         s->planeheight[i]);
262                 len -= 2;
263                 out = 1;
264             } else if (len == 1) {
265                 // fill in the EARLIER field from the new pic
266                 for (i = 0; i < s->nb_planes; i++) {
267                     av_image_copy_plane(s->frame->data[i] +
268                                         s->frame->linesize[i] * s->first_field,
269                                         s->frame->linesize[i] * 2,
270                                         inpicref->data[i] +
271                                         inpicref->linesize[i] * s->first_field,
272                                         inpicref->linesize[i] * 2, s->stride[i],
273                                         (s->planeheight[i] - s->first_field + 1) / 2);
274                  }
275
276                 // TODO: not sure about the other field
277
278                 len--;
279                 out = 1;
280             }
281         }
282
283         if (len == 1 && s->occupied)
284         {
285             len--;
286             s->occupied = 0;
287         }
288     }
289     s->nskip_fields = len;
290
291     if (out) {
292         AVFrame *frame = av_frame_clone(s->frame);
293
294         if (!frame) {
295             av_frame_free(&inpicref);
296             return AVERROR(ENOMEM);
297         }
298
299         av_frame_copy_props(frame, inpicref);
300         frame->pts = ((s->start_time == AV_NOPTS_VALUE) ? 0 : s->start_time) +
301                      av_rescale(outlink->frame_count, s->ts_unit.num,
302                                 s->ts_unit.den);
303         ret = ff_filter_frame(outlink, frame);
304     }
305
306     av_frame_free(&inpicref);
307
308     return ret;
309 }
310
311 static av_cold void uninit(AVFilterContext *ctx)
312 {
313     DetelecineContext *s = ctx->priv;
314
315     av_frame_free(&s->temp);
316     av_frame_free(&s->frame);
317 }
318
319 static const AVFilterPad detelecine_inputs[] = {
320     {
321         .name          = "default",
322         .type          = AVMEDIA_TYPE_VIDEO,
323         .filter_frame  = filter_frame,
324         .config_props  = config_input,
325     },
326     { NULL }
327 };
328
329 static const AVFilterPad detelecine_outputs[] = {
330     {
331         .name          = "default",
332         .type          = AVMEDIA_TYPE_VIDEO,
333         .config_props  = config_output,
334     },
335     { NULL }
336 };
337
338 AVFilter ff_vf_detelecine = {
339     .name          = "detelecine",
340     .description   = NULL_IF_CONFIG_SMALL("Apply an inverse telecine pattern."),
341     .priv_size     = sizeof(DetelecineContext),
342     .priv_class    = &detelecine_class,
343     .init          = init,
344     .uninit        = uninit,
345     .query_formats = query_formats,
346     .inputs        = detelecine_inputs,
347     .outputs       = detelecine_outputs,
348 };