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     s->class = &fps_class;
  80     av_opt_set_defaults(s);
  81
  82     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
  83         av_log(ctx, AV_LOG_ERROR, "Error parsing the options string %s.\n",
  84                args);
  85         return ret;
  86     }
  87
  88     if ((ret = av_parse_video_rate(&s->framerate, s->fps)) < 0) {
  89         av_log(ctx, AV_LOG_ERROR, "Error parsing framerate %s.\n", s->fps);
  90         return ret;
  91     }
  92     av_opt_free(s);
  93
  94     if (!(s->fifo = av_fifo_alloc(2*sizeof(AVFilterBufferRef*))))
  95         return AVERROR(ENOMEM);
  96
  97     av_log(ctx, AV_LOG_VERBOSE, "fps=%d/%d\n", s->framerate.num, s->framerate.den);
  98     return 0;
  99 }
 100
 101 static void flush_fifo(AVFifoBuffer *fifo)
 102 {
 103     while (av_fifo_size(fifo)) {
 104         AVFilterBufferRef *tmp;
 105         av_fifo_generic_read(fifo, &tmp, sizeof(tmp), NULL);
 106         avfilter_unref_buffer(tmp);
 107     }
 108 }
 109
 110 static av_cold void uninit(AVFilterContext *ctx)
 111 {
 112     FPSContext *s = ctx->priv;
 113     if (s->fifo) {
 114         flush_fifo(s->fifo);
 115         av_fifo_free(s->fifo);
 116     }
 117
 118     av_log(ctx, AV_LOG_VERBOSE, "%d frames in, %d frames out; %d frames dropped, "
 119            "%d frames duplicated.\n", s->frames_in, s->frames_out, s->drop, s->dup);
 120 }
 121
 122 static int config_props(AVFilterLink* link)
 123 {
 124     FPSContext   *s = link->src->priv;
 125
 126     link->time_base = av_inv_q(s->framerate);
 127     link->frame_rate= s->framerate;
 128     link->w         = link->src->inputs[0]->w;
 129     link->h         = link->src->inputs[0]->h;
 130     s->pts          = AV_NOPTS_VALUE;
 131
 132     return 0;
 133 }
 134
 135 static int request_frame(AVFilterLink *outlink)
 136 {
 137     AVFilterContext *ctx = outlink->src;
 138     FPSContext        *s = ctx->priv;
 139     int frames_out = s->frames_out;
 140     int ret = 0;
 141
 142     while (ret >= 0 && s->frames_out == frames_out)
 143         ret = ff_request_frame(ctx->inputs[0]);
 144
 145     /* flush the fifo */
 146     if (ret == AVERROR_EOF && av_fifo_size(s->fifo)) {
 147         int i;
 148         for (i = 0; av_fifo_size(s->fifo); i++) {
 149             AVFilterBufferRef *buf;
 150
 151             av_fifo_generic_read(s->fifo, &buf, sizeof(buf), NULL);
 152             buf->pts = av_rescale_q(s->first_pts, ctx->inputs[0]->time_base,
 153                                     outlink->time_base) + s->frames_out;
 154
 155             if ((ret = ff_start_frame(outlink, buf)) < 0 ||
 156                 (ret = ff_draw_slice(outlink, 0, outlink->h, 1)) < 0 ||
 157                 (ret = ff_end_frame(outlink)) < 0)
 158                 return ret;
 159
 160             s->frames_out++;
 161         }
 162         return 0;
 163     }
 164
 165     return ret;
 166 }
 167
 168 static int write_to_fifo(AVFifoBuffer *fifo, AVFilterBufferRef *buf)
 169 {
 170     int ret;
 171
 172     if (!av_fifo_space(fifo) &&
 173         (ret = av_fifo_realloc2(fifo, 2*av_fifo_size(fifo)))) {
 174         avfilter_unref_bufferp(&buf);
 175         return ret;
 176     }
 177
 178     av_fifo_generic_write(fifo, &buf, sizeof(buf), NULL);
 179     return 0;
 180 }
 181
 182 static int end_frame(AVFilterLink *inlink)
 183 {
 184     AVFilterContext    *ctx = inlink->dst;
 185     FPSContext           *s = ctx->priv;
 186     AVFilterLink   *outlink = ctx->outputs[0];
 187     AVFilterBufferRef  *buf = inlink->cur_buf;
 188     int64_t delta;
 189     int i, ret;
 190
 191     inlink->cur_buf = NULL;
 192     s->frames_in++;
 193     /* discard frames until we get the first timestamp */
 194     if (s->pts == AV_NOPTS_VALUE) {
 195         if (buf->pts != AV_NOPTS_VALUE) {
 196             ret = write_to_fifo(s->fifo, buf);
 197             if (ret < 0)
 198                 return ret;
 199
 200             s->first_pts = s->pts = buf->pts;
 201         } else {
 202             av_log(ctx, AV_LOG_WARNING, "Discarding initial frame(s) with no "
 203                    "timestamp.\n");
 204             avfilter_unref_buffer(buf);
 205             s->drop++;
 206         }
 207         return 0;
 208     }
 209
 210     /* now wait for the next timestamp */
 211     if (buf->pts == AV_NOPTS_VALUE) {
 212         return write_to_fifo(s->fifo, buf);
 213     }
 214
 215     /* number of output frames */
 216     delta = av_rescale_q_rnd(buf->pts - s->pts, inlink->time_base,
 217                              outlink->time_base, s->rounding);
 218
 219     if (delta < 1) {
 220         /* drop the frame and everything buffered except the first */
 221         AVFilterBufferRef *tmp;
 222         int drop = av_fifo_size(s->fifo)/sizeof(AVFilterBufferRef*);
 223
 224         av_log(ctx, AV_LOG_DEBUG, "Dropping %d frame(s).\n", drop);
 225         s->drop += drop;
 226
 227         av_fifo_generic_read(s->fifo, &tmp, sizeof(tmp), NULL);
 228         flush_fifo(s->fifo);
 229         ret = write_to_fifo(s->fifo, tmp);
 230
 231         avfilter_unref_buffer(buf);
 232         return ret;
 233     }
 234
 235     /* can output >= 1 frames */
 236     for (i = 0; i < delta; i++) {
 237         AVFilterBufferRef *buf_out;
 238         av_fifo_generic_read(s->fifo, &buf_out, sizeof(buf_out), NULL);
 239
 240         /* duplicate the frame if needed */
 241         if (!av_fifo_size(s->fifo) && i < delta - 1) {
 242             AVFilterBufferRef *dup = avfilter_ref_buffer(buf_out, ~0);
 243
 244             av_log(ctx, AV_LOG_DEBUG, "Duplicating frame.\n");
 245             if (dup)
 246                 ret = write_to_fifo(s->fifo, dup);
 247             else
 248                 ret = AVERROR(ENOMEM);
 249
 250             if (ret < 0) {
 251                 avfilter_unref_bufferp(&buf_out);
 252                 avfilter_unref_bufferp(&buf);
 253                 return ret;
 254             }
 255
 256             s->dup++;
 257         }
 258
 259         buf_out->pts = av_rescale_q(s->first_pts, inlink->time_base,
 260                                     outlink->time_base) + s->frames_out;
 261
 262         if ((ret = ff_start_frame(outlink, buf_out)) < 0 ||
 263             (ret = ff_draw_slice(outlink, 0, outlink->h, 1)) < 0 ||
 264             (ret = ff_end_frame(outlink)) < 0) {
 265             avfilter_unref_bufferp(&buf);
 266             return ret;
 267         }
 268
 269         s->frames_out++;
 270     }
 271     flush_fifo(s->fifo);
 272
 273     ret = write_to_fifo(s->fifo, buf);
 274     s->pts = s->first_pts + av_rescale_q(s->frames_out, outlink->time_base, inlink->time_base);
 275
 276     return ret;
 277 }
 278
 279 static int null_start_frame(AVFilterLink *link, AVFilterBufferRef *buf)
 280 {
 281     return 0;
 282 }
 283
 284 static int null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
 285 {
 286     return 0;
 287 }
 288
 289 static const AVFilterPad avfilter_vf_fps_inputs[] = {
 290     {
 291         .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     },
 298     { NULL }
 299 };
 300
 301 static const AVFilterPad avfilter_vf_fps_outputs[] = {
 302     {
 303         .name          = "default",
 304         .type          = AVMEDIA_TYPE_VIDEO,
 305         .rej_perms     = AV_PERM_WRITE,
 306         .request_frame = request_frame,
 307         .config_props  = config_props
 308     },
 309     { NULL }
 310 };
 311
 312 AVFilter avfilter_vf_fps = {
 313     .name        = "fps",
 314     .description = NULL_IF_CONFIG_SMALL("Force constant framerate"),
 315
 316     .init      = init,
 317     .uninit    = uninit,
 318
 319     .priv_size = sizeof(FPSContext),
 320
 321     .inputs    = avfilter_vf_fps_inputs,
 322     .outputs   = avfilter_vf_fps_outputs,
 323     .priv_class = &fps_class,
 324 };