vf_mp: fix duplicate return
[ffmpeg.git] / libavfilter / vf_fps.c
1 /*
2  * Copyright 2007 Bobby Bingham
3  * Copyright 2012 Robert Nagy <ronag89 gmail com>
4  * Copyright 2012 Anton Khirnov <anton khirnov net>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * a filter enforcing given constant framerate
26  */
27
28 #include "libavutil/common.h"
29 #include "libavutil/fifo.h"
30 #include "libavutil/mathematics.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/parseutils.h"
33
34 #include "avfilter.h"
35 #include "internal.h"
36 #include "video.h"
37
38 typedef struct FPSContext {
39     const AVClass *class;
40
41     AVFifoBuffer *fifo;     ///< store frames until we get two successive timestamps
42
43     /* timestamps in input timebase */
44     int64_t first_pts;      ///< pts of the first frame that arrived on this filter
45     int64_t pts;            ///< pts of the first frame currently in the fifo
46
47     AVRational framerate;   ///< target framerate
48     char *fps;              ///< a string describing target framerate
49
50     /* statistics */
51     int frames_in;             ///< number of frames on input
52     int frames_out;            ///< number of frames on output
53     int dup;                   ///< number of frames duplicated
54     int drop;                  ///< number of framed dropped
55 } FPSContext;
56
57 #define OFFSET(x) offsetof(FPSContext, x)
58 #define V AV_OPT_FLAG_VIDEO_PARAM
59 #define F AV_OPT_FLAG_FILTERING_PARAM
60 static const AVOption fps_options[] = {
61     { "fps", "A string describing desired output framerate", OFFSET(fps), AV_OPT_TYPE_STRING, { .str = "25" }, .flags = V|F },
62     { NULL },
63 };
64
65 AVFILTER_DEFINE_CLASS(fps);
66
67 static av_cold int init(AVFilterContext *ctx, const char *args)
68 {
69     FPSContext *s = ctx->priv;
70     int ret;
71
72     s->class = &fps_class;
73     av_opt_set_defaults(s);
74
75     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
76         av_log(ctx, AV_LOG_ERROR, "Error parsing the options string %s.\n",
77                args);
78         return ret;
79     }
80
81     if ((ret = av_parse_video_rate(&s->framerate, s->fps)) < 0) {
82         av_log(ctx, AV_LOG_ERROR, "Error parsing framerate %s.\n", s->fps);
83         return ret;
84     }
85     av_opt_free(s);
86
87     if (!(s->fifo = av_fifo_alloc(2*sizeof(AVFilterBufferRef*))))
88         return AVERROR(ENOMEM);
89
90     av_log(ctx, AV_LOG_VERBOSE, "fps=%d/%d\n", s->framerate.num, s->framerate.den);
91     return 0;
92 }
93
94 static void flush_fifo(AVFifoBuffer *fifo)
95 {
96     while (av_fifo_size(fifo)) {
97         AVFilterBufferRef *tmp;
98         av_fifo_generic_read(fifo, &tmp, sizeof(tmp), NULL);
99         avfilter_unref_buffer(tmp);
100     }
101 }
102
103 static av_cold void uninit(AVFilterContext *ctx)
104 {
105     FPSContext *s = ctx->priv;
106     if (s->fifo) {
107         flush_fifo(s->fifo);
108         av_fifo_free(s->fifo);
109     }
110
111     av_log(ctx, AV_LOG_VERBOSE, "%d frames in, %d frames out; %d frames dropped, "
112            "%d frames duplicated.\n", s->frames_in, s->frames_out, s->drop, s->dup);
113 }
114
115 static int config_props(AVFilterLink* link)
116 {
117     FPSContext   *s = link->src->priv;
118
119     link->time_base = av_inv_q(s->framerate);
120     link->frame_rate= s->framerate;
121     link->w         = link->src->inputs[0]->w;
122     link->h         = link->src->inputs[0]->h;
123     s->pts          = AV_NOPTS_VALUE;
124
125     return 0;
126 }
127
128 static int request_frame(AVFilterLink *outlink)
129 {
130     AVFilterContext *ctx = outlink->src;
131     FPSContext        *s = ctx->priv;
132     int frames_out = s->frames_out;
133     int ret = 0;
134
135     while (ret >= 0 && s->frames_out == frames_out)
136         ret = ff_request_frame(ctx->inputs[0]);
137
138     /* flush the fifo */
139     if (ret == AVERROR_EOF && av_fifo_size(s->fifo)) {
140         int i;
141         for (i = 0; av_fifo_size(s->fifo); i++) {
142             AVFilterBufferRef *buf;
143
144             av_fifo_generic_read(s->fifo, &buf, sizeof(buf), NULL);
145             buf->pts = av_rescale_q(s->first_pts, ctx->inputs[0]->time_base,
146                                     outlink->time_base) + s->frames_out;
147
148             if ((ret = ff_start_frame(outlink, buf)) < 0 ||
149                 (ret = ff_draw_slice(outlink, 0, outlink->h, 1)) < 0 ||
150                 (ret = ff_end_frame(outlink)) < 0)
151                 return ret;
152
153             s->frames_out++;
154         }
155         return 0;
156     }
157
158     return ret;
159 }
160
161 static int write_to_fifo(AVFifoBuffer *fifo, AVFilterBufferRef *buf)
162 {
163     int ret;
164
165     if (!av_fifo_space(fifo) &&
166         (ret = av_fifo_realloc2(fifo, 2*av_fifo_size(fifo)))) {
167         avfilter_unref_bufferp(&buf);
168         return ret;
169     }
170
171     av_fifo_generic_write(fifo, &buf, sizeof(buf), NULL);
172     return 0;
173 }
174
175 static int end_frame(AVFilterLink *inlink)
176 {
177     AVFilterContext    *ctx = inlink->dst;
178     FPSContext           *s = ctx->priv;
179     AVFilterLink   *outlink = ctx->outputs[0];
180     AVFilterBufferRef  *buf = inlink->cur_buf;
181     int64_t delta;
182     int i, ret;
183
184     inlink->cur_buf = NULL;
185     s->frames_in++;
186     /* discard frames until we get the first timestamp */
187     if (s->pts == AV_NOPTS_VALUE) {
188         if (buf->pts != AV_NOPTS_VALUE) {
189             ret = write_to_fifo(s->fifo, buf);
190             if (ret < 0)
191                 return ret;
192
193             s->first_pts = s->pts = buf->pts;
194         } else {
195             av_log(ctx, AV_LOG_WARNING, "Discarding initial frame(s) with no "
196                    "timestamp.\n");
197             avfilter_unref_buffer(buf);
198             s->drop++;
199         }
200         return 0;
201     }
202
203     /* now wait for the next timestamp */
204     if (buf->pts == AV_NOPTS_VALUE) {
205         return write_to_fifo(s->fifo, buf);
206     }
207
208     /* number of output frames */
209     delta = av_rescale_q(buf->pts - s->pts, inlink->time_base,
210                          outlink->time_base);
211
212     if (delta < 1) {
213         /* drop the frame and everything buffered except the first */
214         AVFilterBufferRef *tmp;
215         int drop = av_fifo_size(s->fifo)/sizeof(AVFilterBufferRef*);
216
217         av_log(ctx, AV_LOG_DEBUG, "Dropping %d frame(s).\n", drop);
218         s->drop += drop;
219
220         av_fifo_generic_read(s->fifo, &tmp, sizeof(tmp), NULL);
221         flush_fifo(s->fifo);
222         ret = write_to_fifo(s->fifo, tmp);
223
224         avfilter_unref_buffer(buf);
225         return ret;
226     }
227
228     /* can output >= 1 frames */
229     for (i = 0; i < delta; i++) {
230         AVFilterBufferRef *buf_out;
231         av_fifo_generic_read(s->fifo, &buf_out, sizeof(buf_out), NULL);
232
233         /* duplicate the frame if needed */
234         if (!av_fifo_size(s->fifo) && i < delta - 1) {
235             AVFilterBufferRef *dup = avfilter_ref_buffer(buf_out, ~0);
236
237             av_log(ctx, AV_LOG_DEBUG, "Duplicating frame.\n");
238             if (dup)
239                 ret = write_to_fifo(s->fifo, dup);
240             else
241                 ret = AVERROR(ENOMEM);
242
243             if (ret < 0) {
244                 avfilter_unref_bufferp(&buf_out);
245                 avfilter_unref_bufferp(&buf);
246                 return ret;
247             }
248
249             s->dup++;
250         }
251
252         buf_out->pts = av_rescale_q(s->first_pts, inlink->time_base,
253                                     outlink->time_base) + s->frames_out;
254
255         if ((ret = ff_start_frame(outlink, buf_out)) < 0 ||
256             (ret = ff_draw_slice(outlink, 0, outlink->h, 1)) < 0 ||
257             (ret = ff_end_frame(outlink)) < 0) {
258             avfilter_unref_bufferp(&buf);
259             return ret;
260         }
261
262         s->frames_out++;
263     }
264     flush_fifo(s->fifo);
265
266     ret = write_to_fifo(s->fifo, buf);
267     s->pts = s->first_pts + av_rescale_q(s->frames_out, outlink->time_base, inlink->time_base);
268
269     return ret;
270 }
271
272 static int null_start_frame(AVFilterLink *link, AVFilterBufferRef *buf)
273 {
274     return 0;
275 }
276
277 static int null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
278 {
279     return 0;
280 }
281
282 AVFilter avfilter_vf_fps = {
283     .name        = "fps",
284     .description = NULL_IF_CONFIG_SMALL("Force constant framerate"),
285
286     .init      = init,
287     .uninit    = uninit,
288
289     .priv_size = sizeof(FPSContext),
290
291     .inputs    = (const AVFilterPad[]) {{ .name            = "default",
292                                           .type            = AVMEDIA_TYPE_VIDEO,
293                                           .min_perms       = AV_PERM_READ | AV_PERM_PRESERVE,
294                                           .start_frame     = null_start_frame,
295                                           .draw_slice      = null_draw_slice,
296                                           .end_frame       = end_frame, },
297                                         { .name = NULL}},
298     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
299                                           .type            = AVMEDIA_TYPE_VIDEO,
300                                           .rej_perms       = AV_PERM_WRITE,
301                                           .request_frame   = request_frame,
302                                           .config_props    = config_props},
303                                         { .name = NULL}},
304     .priv_class = &fps_class,
305 };