git.sesse.net Git - ffmpeg/blob - libavfilter/vf_select.c

   1 /*
   2  * Copyright (c) 2011 Stefano Sabatini
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * filter for selecting which frame passes in the filterchain
  24  */
  25
  26 #include "libavutil/eval.h"
  27 #include "libavutil/fifo.h"
  28 #include "avfilter.h"
  29
  30 static const char *var_names[] = {
  31     "E",                 ///< Euler number
  32     "PHI",               ///< golden ratio
  33     "PI",                ///< greek pi
  34
  35     "TB",                ///< timebase
  36
  37     "pts",               ///< original pts in the file of the frame
  38     "start_pts",         ///< first PTS in the stream, expressed in TB units
  39     "prev_pts",          ///< previous frame PTS
  40     "prev_selected_pts", ///< previous selected frame PTS
  41
  42     "t",                 ///< first PTS in seconds
  43     "start_t",           ///< first PTS in the stream, expressed in seconds
  44     "prev_t",            ///< previous frame time
  45     "prev_selected_t",   ///< previously selected time
  46
  47     "pict_type",         ///< the type of picture in the movie
  48     "PICT_TYPE_I",
  49     "PICT_TYPE_P",
  50     "PICT_TYPE_B",
  51     "PICT_TYPE_S",
  52     "PICT_TYPE_SI",
  53     "PICT_TYPE_SP",
  54     "PICT_TYPE_BI",
  55
  56     "interlace_type",    ///< the frame interlace type
  57     "INTERLACE_TYPE_P",
  58     "INTERLACE_TYPE_T",
  59     "INTERLACE_TYPE_B",
  60
  61     "n",                 ///< frame number (starting from zero)
  62     "selected_n",        ///< selected frame number (starting from zero)
  63     "prev_selected_n",   ///< number of the last selected frame
  64
  65     "key",               ///< tell if the frame is a key frame
  66     "pos",               ///< original position in the file of the frame
  67
  68     NULL
  69 };
  70
  71 enum var_name {
  72     VAR_E,
  73     VAR_PHI,
  74     VAR_PI,
  75
  76     VAR_TB,
  77
  78     VAR_PTS,
  79     VAR_START_PTS,
  80     VAR_PREV_PTS,
  81     VAR_PREV_SELECTED_PTS,
  82
  83     VAR_T,
  84     VAR_START_T,
  85     VAR_PREV_T,
  86     VAR_PREV_SELECTED_T,
  87
  88     VAR_PICT_TYPE,
  89     VAR_PICT_TYPE_I,
  90     VAR_PICT_TYPE_P,
  91     VAR_PICT_TYPE_B,
  92     VAR_PICT_TYPE_S,
  93     VAR_PICT_TYPE_SI,
  94     VAR_PICT_TYPE_SP,
  95     VAR_PICT_TYPE_BI,
  96
  97     VAR_INTERLACE_TYPE,
  98     VAR_INTERLACE_TYPE_P,
  99     VAR_INTERLACE_TYPE_T,
 100     VAR_INTERLACE_TYPE_B,
 101
 102     VAR_N,
 103     VAR_SELECTED_N,
 104     VAR_PREV_SELECTED_N,
 105
 106     VAR_KEY,
 107     VAR_POS,
 108
 109     VAR_VARS_NB
 110 };
 111
 112 #define FIFO_SIZE 8
 113
 114 typedef struct {
 115     AVExpr *expr;
 116     double var_values[VAR_VARS_NB];
 117     double select;
 118     int cache_frames;
 119     AVFifoBuffer *pending_frames; ///< FIFO buffer of video frames
 120 } SelectContext;
 121
 122 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
 123 {
 124     SelectContext *select = ctx->priv;
 125     int ret;
 126
 127     if ((ret = av_expr_parse(&select->expr, args ? args : "1",
 128                              var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
 129         av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", args);
 130         return ret;
 131     }
 132
 133     select->pending_frames = av_fifo_alloc(FIFO_SIZE*sizeof(AVFilterBufferRef*));
 134     if (!select->pending_frames) {
 135         av_log(ctx, AV_LOG_ERROR, "Failed to allocate pending frames buffer.\n");
 136         return AVERROR(ENOMEM);
 137     }
 138     return 0;
 139 }
 140
 141 #define INTERLACE_TYPE_P 0
 142 #define INTERLACE_TYPE_T 1
 143 #define INTERLACE_TYPE_B 2
 144
 145 static int config_input(AVFilterLink *inlink)
 146 {
 147     SelectContext *select = inlink->dst->priv;
 148
 149     select->var_values[VAR_E]   = M_E;
 150     select->var_values[VAR_PHI] = M_PHI;
 151     select->var_values[VAR_PI]  = M_PI;
 152
 153     select->var_values[VAR_N]          = 0.0;
 154     select->var_values[VAR_SELECTED_N] = 0.0;
 155
 156     select->var_values[VAR_TB] = av_q2d(inlink->time_base);
 157
 158     select->var_values[VAR_PREV_PTS]          = NAN;
 159     select->var_values[VAR_PREV_SELECTED_PTS] = NAN;
 160     select->var_values[VAR_PREV_SELECTED_T]   = NAN;
 161     select->var_values[VAR_START_PTS]         = NAN;
 162     select->var_values[VAR_START_T]           = NAN;
 163
 164     select->var_values[VAR_PICT_TYPE_I]  = AV_PICTURE_TYPE_I;
 165     select->var_values[VAR_PICT_TYPE_P]  = AV_PICTURE_TYPE_P;
 166     select->var_values[VAR_PICT_TYPE_B]  = AV_PICTURE_TYPE_B;
 167     select->var_values[VAR_PICT_TYPE_SI] = AV_PICTURE_TYPE_SI;
 168     select->var_values[VAR_PICT_TYPE_SP] = AV_PICTURE_TYPE_SP;
 169
 170     select->var_values[VAR_INTERLACE_TYPE_P] = INTERLACE_TYPE_P;
 171     select->var_values[VAR_INTERLACE_TYPE_T] = INTERLACE_TYPE_T;
 172     select->var_values[VAR_INTERLACE_TYPE_B] = INTERLACE_TYPE_B;;
 173
 174     return 0;
 175 }
 176
 177 #define D2TS(d)  (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
 178 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
 179
 180 static int select_frame(AVFilterContext *ctx, AVFilterBufferRef *picref)
 181 {
 182     SelectContext *select = ctx->priv;
 183     AVFilterLink *inlink = ctx->inputs[0];
 184     double res;
 185
 186     if (isnan(select->var_values[VAR_START_PTS]))
 187         select->var_values[VAR_START_PTS] = TS2D(picref->pts);
 188     if (isnan(select->var_values[VAR_START_T]))
 189         select->var_values[VAR_START_T] = TS2D(picref->pts) * av_q2d(inlink->time_base);
 190
 191     select->var_values[VAR_PTS] = TS2D(picref->pts);
 192     select->var_values[VAR_T  ] = picref->pts * av_q2d(inlink->time_base);
 193     select->var_values[VAR_POS] = picref->pos == -1 ? NAN : picref->pos;
 194     select->var_values[VAR_PREV_PTS] = TS2D(picref ->pts);
 195
 196     select->var_values[VAR_INTERLACE_TYPE] =
 197         !picref->video->interlaced     ? INTERLACE_TYPE_P :
 198         picref->video->top_field_first ? INTERLACE_TYPE_T : INTERLACE_TYPE_B;
 199     select->var_values[VAR_PICT_TYPE] = picref->video->pict_type;
 200
 201     res = av_expr_eval(select->expr, select->var_values, NULL);
 202     av_log(inlink->dst, AV_LOG_DEBUG,
 203            "n:%d pts:%d t:%f pos:%d interlace_type:%c key:%d pict_type:%c "
 204            "-> select:%f\n",
 205            (int)select->var_values[VAR_N],
 206            (int)select->var_values[VAR_PTS],
 207            select->var_values[VAR_T],
 208            (int)select->var_values[VAR_POS],
 209            select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_P ? 'P' :
 210            select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_T ? 'T' :
 211            select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_B ? 'B' : '?',
 212            (int)select->var_values[VAR_KEY],
 213            av_get_picture_type_char(select->var_values[VAR_PICT_TYPE]),
 214            res);
 215
 216     select->var_values[VAR_N] += 1.0;
 217
 218     if (res) {
 219         select->var_values[VAR_PREV_SELECTED_N]   = select->var_values[VAR_N];
 220         select->var_values[VAR_PREV_SELECTED_PTS] = select->var_values[VAR_PTS];
 221         select->var_values[VAR_PREV_SELECTED_T]   = select->var_values[VAR_T];
 222         select->var_values[VAR_SELECTED_N] += 1.0;
 223     }
 224     return res;
 225 }
 226
 227 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *picref)
 228 {
 229     SelectContext *select = inlink->dst->priv;
 230
 231     select->select = select_frame(inlink->dst, picref);
 232     if (select->select) {
 233         /* frame was requested through poll_frame */
 234         if (select->cache_frames) {
 235             if (!av_fifo_space(select->pending_frames))
 236                 av_log(inlink->dst, AV_LOG_ERROR,
 237                        "Buffering limit reached, cannot cache more frames\n");
 238             else
 239                 av_fifo_generic_write(select->pending_frames, &picref,
 240                                       sizeof(picref), NULL);
 241             return;
 242         }
 243         avfilter_start_frame(inlink->dst->outputs[0], avfilter_ref_buffer(picref, ~0));
 244     }
 245 }
 246
 247 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
 248 {
 249     SelectContext *select = inlink->dst->priv;
 250
 251     if (select->select && !select->cache_frames)
 252         avfilter_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
 253 }
 254
 255 static void end_frame(AVFilterLink *inlink)
 256 {
 257     SelectContext *select = inlink->dst->priv;
 258     AVFilterBufferRef *picref = inlink->cur_buf;
 259
 260     if (select->select) {
 261         if (select->cache_frames)
 262             return;
 263         avfilter_end_frame(inlink->dst->outputs[0]);
 264     }
 265     avfilter_unref_buffer(picref);
 266 }
 267
 268 static int request_frame(AVFilterLink *outlink)
 269 {
 270     AVFilterContext *ctx = outlink->src;
 271     SelectContext *select = ctx->priv;
 272     AVFilterLink *inlink = outlink->src->inputs[0];
 273     select->select = 0;
 274
 275     if (av_fifo_size(select->pending_frames)) {
 276         AVFilterBufferRef *picref;
 277         av_fifo_generic_read(select->pending_frames, &picref, sizeof(picref), NULL);
 278         avfilter_start_frame(outlink, avfilter_ref_buffer(picref, ~0));
 279         avfilter_draw_slice(outlink, 0, outlink->h, 1);
 280         avfilter_end_frame(outlink);
 281         avfilter_unref_buffer(picref);
 282         return 0;
 283     }
 284
 285     while (!select->select) {
 286         int ret = avfilter_request_frame(inlink);
 287         if (ret < 0)
 288             return ret;
 289     }
 290
 291     return 0;
 292 }
 293
 294 static int poll_frame(AVFilterLink *outlink)
 295 {
 296     SelectContext *select = outlink->src->priv;
 297     AVFilterLink *inlink = outlink->src->inputs[0];
 298     int count, ret;
 299
 300     if (!av_fifo_size(select->pending_frames)) {
 301         if ((count = avfilter_poll_frame(inlink)) <= 0)
 302             return count;
 303         /* request frame from input, and apply select condition to it */
 304         select->cache_frames = 1;
 305         while (count-- && av_fifo_space(select->pending_frames)) {
 306             ret = avfilter_request_frame(inlink);
 307             if (ret < 0)
 308                 break;
 309         }
 310         select->cache_frames = 0;
 311     }
 312
 313     return av_fifo_size(select->pending_frames)/sizeof(AVFilterBufferRef *);
 314 }
 315
 316 static av_cold void uninit(AVFilterContext *ctx)
 317 {
 318     SelectContext *select = ctx->priv;
 319     AVFilterBufferRef *picref;
 320     int i;
 321
 322     av_expr_free(select->expr);
 323     select->expr = NULL;
 324
 325     for (i = 0; i < av_fifo_size(select->pending_frames)/sizeof(picref); i++) {
 326         av_fifo_generic_read(select->pending_frames, &picref, sizeof(picref), NULL);
 327         avfilter_unref_buffer(picref);
 328     }
 329     av_fifo_free(select->pending_frames);
 330 }
 331
 332 AVFilter avfilter_vf_select = {
 333     .name      = "select",
 334     .description = NULL_IF_CONFIG_SMALL("Select frames to pass in output."),
 335     .init      = init,
 336     .uninit    = uninit,
 337
 338     .priv_size = sizeof(SelectContext),
 339
 340     .inputs    = (AVFilterPad[]) {{ .name             = "default",
 341                                     .type             = AVMEDIA_TYPE_VIDEO,
 342                                     .get_video_buffer = avfilter_null_get_video_buffer,
 343                                     .config_props     = config_input,
 344                                     .start_frame      = start_frame,
 345                                     .draw_slice       = draw_slice,
 346                                     .end_frame        = end_frame },
 347                                   { .name = NULL }},
 348     .outputs   = (AVFilterPad[]) {{ .name             = "default",
 349                                     .type             = AVMEDIA_TYPE_VIDEO,
 350                                     .poll_frame       = poll_frame,
 351                                     .request_frame    = request_frame, },
 352                                   { .name = NULL}},
 353 };