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