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/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     int rounding;           ///< AVRounding method for timestamps
  50
  51     /* statistics */
  52     int frames_in;             ///< number of frames on input
  53     int frames_out;            ///< number of frames on output
  54     int dup;                   ///< number of frames duplicated
  55     int drop;                  ///< number of framed dropped
  56 } FPSContext;
  57
  58 #define OFFSET(x) offsetof(FPSContext, x)
  59 #define V AV_OPT_FLAG_VIDEO_PARAM
  60 #define F AV_OPT_FLAG_FILTERING_PARAM
  61 static const AVOption fps_options[] = {
  62     { "fps", "A string describing desired output framerate", OFFSET(fps), AV_OPT_TYPE_STRING, { .str = "25" }, .flags = V|F },
  63     { "round", "set rounding method for timestamps", OFFSET(rounding), AV_OPT_TYPE_INT, { .i64 = AV_ROUND_NEAR_INF }, 0, 5, V|F, "round" },
  64     { "zero", "round towards 0",      OFFSET(rounding), AV_OPT_TYPE_CONST, { .i64 = AV_ROUND_ZERO     }, 0, 5, V|F, "round" },
  65     { "inf",  "round away from 0",    OFFSET(rounding), AV_OPT_TYPE_CONST, { .i64 = AV_ROUND_INF      }, 0, 5, V|F, "round" },
  66     { "down", "round towards -infty", OFFSET(rounding), AV_OPT_TYPE_CONST, { .i64 = AV_ROUND_DOWN     }, 0, 5, V|F, "round" },
  67     { "up",   "round towards +infty", OFFSET(rounding), AV_OPT_TYPE_CONST, { .i64 = AV_ROUND_UP       }, 0, 5, V|F, "round" },
  68     { "near", "round to nearest",     OFFSET(rounding), AV_OPT_TYPE_CONST, { .i64 = AV_ROUND_NEAR_INF }, 0, 5, V|F, "round" },
  69     { NULL },
  70 };
  71
  72 AVFILTER_DEFINE_CLASS(fps);
  73
  74 static av_cold int init(AVFilterContext *ctx, const char *args)
  75 {
  76     FPSContext *s = ctx->priv;
  77     int ret;
  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
  84     if (!(s->fifo = av_fifo_alloc(2*sizeof(AVFrame*))))
  85         return AVERROR(ENOMEM);
  86
  87     av_log(ctx, AV_LOG_VERBOSE, "fps=%d/%d\n", s->framerate.num, s->framerate.den);
  88     return 0;
  89 }
  90
  91 static void flush_fifo(AVFifoBuffer *fifo)
  92 {
  93     while (av_fifo_size(fifo)) {
  94         AVFrame *tmp;
  95         av_fifo_generic_read(fifo, &tmp, sizeof(tmp), NULL);
  96         av_frame_free(&tmp);
  97     }
  98 }
  99
 100 static av_cold void uninit(AVFilterContext *ctx)
 101 {
 102     FPSContext *s = ctx->priv;
 103     if (s->fifo) {
 104         s->drop += av_fifo_size(s->fifo) / sizeof(AVFrame*);
 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 = av_inv_q(s->framerate);
 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             AVFrame *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_filter_frame(outlink, buf)) < 0)
 147                 return ret;
 148
 149             s->frames_out++;
 150         }
 151         return 0;
 152     }
 153
 154     return ret;
 155 }
 156
 157 static int write_to_fifo(AVFifoBuffer *fifo, AVFrame *buf)
 158 {
 159     int ret;
 160
 161     if (!av_fifo_space(fifo) &&
 162         (ret = av_fifo_realloc2(fifo, 2*av_fifo_size(fifo)))) {
 163         av_frame_free(&buf);
 164         return ret;
 165     }
 166
 167     av_fifo_generic_write(fifo, &buf, sizeof(buf), NULL);
 168     return 0;
 169 }
 170
 171 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
 172 {
 173     AVFilterContext    *ctx = inlink->dst;
 174     FPSContext           *s = ctx->priv;
 175     AVFilterLink   *outlink = ctx->outputs[0];
 176     int64_t delta;
 177     int i, ret;
 178
 179     s->frames_in++;
 180     /* discard frames until we get the first timestamp */
 181     if (s->pts == AV_NOPTS_VALUE) {
 182         if (buf->pts != AV_NOPTS_VALUE) {
 183             ret = write_to_fifo(s->fifo, buf);
 184             if (ret < 0)
 185                 return ret;
 186
 187             s->first_pts = s->pts = buf->pts;
 188         } else {
 189             av_log(ctx, AV_LOG_WARNING, "Discarding initial frame(s) with no "
 190                    "timestamp.\n");
 191             av_frame_free(&buf);
 192             s->drop++;
 193         }
 194         return 0;
 195     }
 196
 197     /* now wait for the next timestamp */
 198     if (buf->pts == AV_NOPTS_VALUE) {
 199         return write_to_fifo(s->fifo, buf);
 200     }
 201
 202     /* number of output frames */
 203     delta = av_rescale_q_rnd(buf->pts - s->pts, inlink->time_base,
 204                              outlink->time_base, s->rounding);
 205
 206     if (delta < 1) {
 207         /* drop the frame and everything buffered except the first */
 208         AVFrame *tmp;
 209         int drop = av_fifo_size(s->fifo)/sizeof(AVFrame*);
 210
 211         av_log(ctx, AV_LOG_DEBUG, "Dropping %d frame(s).\n", drop);
 212         s->drop += drop;
 213
 214         av_fifo_generic_read(s->fifo, &tmp, sizeof(tmp), NULL);
 215         flush_fifo(s->fifo);
 216         ret = write_to_fifo(s->fifo, tmp);
 217
 218         av_frame_free(&buf);
 219         return ret;
 220     }
 221
 222     /* can output >= 1 frames */
 223     for (i = 0; i < delta; i++) {
 224         AVFrame *buf_out;
 225         av_fifo_generic_read(s->fifo, &buf_out, sizeof(buf_out), NULL);
 226
 227         /* duplicate the frame if needed */
 228         if (!av_fifo_size(s->fifo) && i < delta - 1) {
 229             AVFrame *dup = av_frame_clone(buf_out);
 230
 231             av_log(ctx, AV_LOG_DEBUG, "Duplicating frame.\n");
 232             if (dup)
 233                 ret = write_to_fifo(s->fifo, dup);
 234             else
 235                 ret = AVERROR(ENOMEM);
 236
 237             if (ret < 0) {
 238                 av_frame_free(&buf_out);
 239                 av_frame_free(&buf);
 240                 return ret;
 241             }
 242
 243             s->dup++;
 244         }
 245
 246         buf_out->pts = av_rescale_q(s->first_pts, inlink->time_base,
 247                                     outlink->time_base) + s->frames_out;
 248
 249         if ((ret = ff_filter_frame(outlink, buf_out)) < 0) {
 250             av_frame_free(&buf);
 251             return ret;
 252         }
 253
 254         s->frames_out++;
 255     }
 256     flush_fifo(s->fifo);
 257
 258     ret = write_to_fifo(s->fifo, buf);
 259     s->pts = s->first_pts + av_rescale_q(s->frames_out, outlink->time_base, inlink->time_base);
 260
 261     return ret;
 262 }
 263
 264 static const AVFilterPad avfilter_vf_fps_inputs[] = {
 265     {
 266         .name        = "default",
 267         .type        = AVMEDIA_TYPE_VIDEO,
 268         .filter_frame = filter_frame,
 269     },
 270     { NULL }
 271 };
 272
 273 static const AVFilterPad avfilter_vf_fps_outputs[] = {
 274     {
 275         .name          = "default",
 276         .type          = AVMEDIA_TYPE_VIDEO,
 277         .request_frame = request_frame,
 278         .config_props  = config_props
 279     },
 280     { NULL }
 281 };
 282
 283 static const char *const shorthand[] = { "fps", "round", NULL };
 284
 285 AVFilter avfilter_vf_fps = {
 286     .name        = "fps",
 287     .description = NULL_IF_CONFIG_SMALL("Force constant framerate"),
 288
 289     .init      = init,
 290     .uninit    = uninit,
 291
 292     .priv_size = sizeof(FPSContext),
 293
 294     .inputs    = avfilter_vf_fps_inputs,
 295     .outputs   = avfilter_vf_fps_outputs,
 296     .priv_class = &fps_class,
 297     .shorthand = shorthand,
 298 };