git.sesse.net Git - ffmpeg/blob - 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/fifo.h"
  29 #include "libavutil/mathematics.h"
  30 #include "libavutil/opt.h"
  31 #include "libavutil/parseutils.h"
  32
  33 #include "avfilter.h"
  34 #include "internal.h"
  35 #include "video.h"
  36
  37 typedef struct FPSContext {
  38     const AVClass *class;
  39
  40     AVFifoBuffer *fifo;     ///< store frames until we get two successive timestamps
  41
  42     /* timestamps in input timebase */
  43     int64_t first_pts;      ///< pts of the first frame that arrived on this filter
  44     int64_t pts;            ///< pts of the first frame currently in the fifo
  45
  46     AVRational framerate;   ///< target framerate
  47     char *fps;              ///< a string describing target framerate
  48
  49     /* statistics */
  50     int frames_in;             ///< number of frames on input
  51     int frames_out;            ///< number of frames on output
  52     int dup;                   ///< number of frames duplicated
  53     int drop;                  ///< number of framed dropped
  54 } FPSContext;
  55
  56 #define OFFSET(x) offsetof(FPSContext, x)
  57 #define V AV_OPT_FLAG_VIDEO_PARAM
  58 static const AVOption fps_options[] = {
  59     { "fps", "A string describing desired output framerate", OFFSET(fps), AV_OPT_TYPE_STRING, { .str = "25" }, .flags = V },
  60     { NULL },
  61 };
  62
  63 AVFILTER_DEFINE_CLASS(fps);
  64
  65 static av_cold int init(AVFilterContext *ctx, const char *args)
  66 {
  67     FPSContext *s = ctx->priv;
  68     int ret;
  69
  70     s->class = &fps_class;
  71     av_opt_set_defaults(s);
  72
  73     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
  74         av_log(ctx, AV_LOG_ERROR, "Error parsing the options string %s.\n",
  75                args);
  76         return ret;
  77     }
  78
  79     if ((ret = av_parse_video_rate(&s->framerate, s->fps)) < 0) {
  80         av_log(ctx, AV_LOG_ERROR, "Error parsing framerate %s.\n", s->fps);
  81         return ret;
  82     }
  83     av_opt_free(s);
  84
  85     if (!(s->fifo = av_fifo_alloc(2*sizeof(AVFilterBufferRef*))))
  86         return AVERROR(ENOMEM);
  87
  88     av_log(ctx, AV_LOG_VERBOSE, "fps=%d/%d\n", s->framerate.num, s->framerate.den);
  89     return 0;
  90 }
  91
  92 static void flush_fifo(AVFifoBuffer *fifo)
  93 {
  94     while (av_fifo_size(fifo)) {
  95         AVFilterBufferRef *tmp;
  96         av_fifo_generic_read(fifo, &tmp, sizeof(tmp), NULL);
  97         avfilter_unref_buffer(tmp);
  98     }
  99 }
 100
 101 static av_cold void uninit(AVFilterContext *ctx)
 102 {
 103     FPSContext *s = ctx->priv;
 104     if (s->fifo) {
 105         flush_fifo(s->fifo);
 106         av_fifo_free(s->fifo);
 107     }
 108
 109     av_log(ctx, AV_LOG_VERBOSE, "%d frames in, %d frames out; %d frames dropped, "
 110            "%d frames duplicated.\n", s->frames_in, s->frames_out, s->drop, s->dup);
 111 }
 112
 113 static int config_props(AVFilterLink* link)
 114 {
 115     FPSContext   *s = link->src->priv;
 116
 117     link->time_base = (AVRational){ s->framerate.den, s->framerate.num };
 118     link->frame_rate= s->framerate;
 119     link->w         = link->src->inputs[0]->w;
 120     link->h         = link->src->inputs[0]->h;
 121     s->pts          = AV_NOPTS_VALUE;
 122
 123     return 0;
 124 }
 125
 126 static int request_frame(AVFilterLink *outlink)
 127 {
 128     AVFilterContext *ctx = outlink->src;
 129     FPSContext        *s = ctx->priv;
 130     int frames_out = s->frames_out;
 131     int ret = 0;
 132
 133     while (ret >= 0 && s->frames_out == frames_out)
 134         ret = ff_request_frame(ctx->inputs[0]);
 135
 136     /* flush the fifo */
 137     if (ret == AVERROR_EOF && av_fifo_size(s->fifo)) {
 138         int i;
 139         for (i = 0; av_fifo_size(s->fifo); i++) {
 140             AVFilterBufferRef *buf;
 141
 142             av_fifo_generic_read(s->fifo, &buf, sizeof(buf), NULL);
 143             buf->pts = av_rescale_q(s->first_pts, ctx->inputs[0]->time_base,
 144                                     outlink->time_base) + s->frames_out;
 145
 146             if ((ret = ff_start_frame(outlink, buf)) < 0 ||
 147                 (ret = ff_draw_slice(outlink, 0, outlink->h, 1)) < 0 ||
 148                 (ret = ff_end_frame(outlink)) < 0)
 149                 return ret;
 150
 151             s->frames_out++;
 152         }
 153         return 0;
 154     }
 155
 156     return ret;
 157 }
 158
 159 static int write_to_fifo(AVFifoBuffer *fifo, AVFilterBufferRef *buf)
 160 {
 161     int ret;
 162
 163     if (!av_fifo_space(fifo) &&
 164         (ret = av_fifo_realloc2(fifo, 2*av_fifo_size(fifo)))) {
 165         avfilter_unref_bufferp(&buf);
 166         return ret;
 167     }
 168
 169     av_fifo_generic_write(fifo, &buf, sizeof(buf), NULL);
 170     return 0;
 171 }
 172
 173 static int end_frame(AVFilterLink *inlink)
 174 {
 175     AVFilterContext    *ctx = inlink->dst;
 176     FPSContext           *s = ctx->priv;
 177     AVFilterLink   *outlink = ctx->outputs[0];
 178     AVFilterBufferRef  *buf = inlink->cur_buf;
 179     int64_t delta;
 180     int i, ret;
 181
 182     inlink->cur_buf = NULL;
 183     s->frames_in++;
 184     /* discard frames until we get the first timestamp */
 185     if (s->pts == AV_NOPTS_VALUE) {
 186         if (buf->pts != AV_NOPTS_VALUE) {
 187             ret = write_to_fifo(s->fifo, buf);
 188             if (ret < 0)
 189                 return ret;
 190
 191             s->first_pts = s->pts = buf->pts;
 192         } else {
 193             av_log(ctx, AV_LOG_WARNING, "Discarding initial frame(s) with no "
 194                    "timestamp.\n");
 195             avfilter_unref_buffer(buf);
 196             s->drop++;
 197         }
 198         return 0;
 199     }
 200
 201     /* now wait for the next timestamp */
 202     if (buf->pts == AV_NOPTS_VALUE) {
 203         return write_to_fifo(s->fifo, buf);
 204     }
 205
 206     /* number of output frames */
 207     delta = av_rescale_q(buf->pts - s->pts, inlink->time_base,
 208                          outlink->time_base);
 209
 210     if (delta < 1) {
 211         /* drop the frame and everything buffered except the first */
 212         AVFilterBufferRef *tmp;
 213         int drop = av_fifo_size(s->fifo)/sizeof(AVFilterBufferRef*);
 214
 215         av_log(ctx, AV_LOG_DEBUG, "Dropping %d frame(s).\n", drop);
 216         s->drop += drop;
 217
 218         av_fifo_generic_read(s->fifo, &tmp, sizeof(tmp), NULL);
 219         flush_fifo(s->fifo);
 220         ret = write_to_fifo(s->fifo, tmp);
 221
 222         avfilter_unref_buffer(buf);
 223         return ret;
 224     }
 225
 226     /* can output >= 1 frames */
 227     for (i = 0; i < delta; i++) {
 228         AVFilterBufferRef *buf_out;
 229         av_fifo_generic_read(s->fifo, &buf_out, sizeof(buf_out), NULL);
 230
 231         /* duplicate the frame if needed */
 232         if (!av_fifo_size(s->fifo) && i < delta - 1) {
 233             AVFilterBufferRef *dup = avfilter_ref_buffer(buf_out, AV_PERM_READ);
 234
 235             av_log(ctx, AV_LOG_DEBUG, "Duplicating frame.\n");
 236             if (dup)
 237                 ret = write_to_fifo(s->fifo, dup);
 238             else
 239                 ret = AVERROR(ENOMEM);
 240
 241             if (ret < 0) {
 242                 avfilter_unref_bufferp(&buf_out);
 243                 avfilter_unref_bufferp(&buf);
 244                 return ret;
 245             }
 246
 247             s->dup++;
 248         }
 249
 250         buf_out->pts = av_rescale_q(s->first_pts, inlink->time_base,
 251                                     outlink->time_base) + s->frames_out;
 252
 253         if ((ret = ff_start_frame(outlink, buf_out)) < 0 ||
 254             (ret = ff_draw_slice(outlink, 0, outlink->h, 1)) < 0 ||
 255             (ret = ff_end_frame(outlink)) < 0) {
 256             avfilter_unref_bufferp(&buf);
 257             return ret;
 258         }
 259
 260         s->frames_out++;
 261     }
 262     flush_fifo(s->fifo);
 263
 264     ret = write_to_fifo(s->fifo, buf);
 265     s->pts = s->first_pts + av_rescale_q(s->frames_out, outlink->time_base, inlink->time_base);
 266
 267     return ret;
 268 }
 269
 270 static int null_start_frame(AVFilterLink *link, AVFilterBufferRef *buf)
 271 {
 272     return 0;
 273 }
 274
 275 static int null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
 276 {
 277     return 0;
 278 }
 279
 280 AVFilter avfilter_vf_fps = {
 281     .name        = "fps",
 282     .description = NULL_IF_CONFIG_SMALL("Force constant framerate"),
 283
 284     .init      = init,
 285     .uninit    = uninit,
 286
 287     .priv_size = sizeof(FPSContext),
 288
 289     .inputs    = (const AVFilterPad[]) {{ .name            = "default",
 290                                           .type            = AVMEDIA_TYPE_VIDEO,
 291                                           .start_frame     = null_start_frame,
 292                                           .draw_slice      = null_draw_slice,
 293                                           .end_frame       = end_frame, },
 294                                         { .name = NULL}},
 295     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
 296                                           .type            = AVMEDIA_TYPE_VIDEO,
 297                                           .request_frame   = request_frame,
 298                                           .config_props    = config_props},
 299                                         { .name = NULL}},
 300 };