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