git.sesse.net Git - ffmpeg/blob - libavfilter/f_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 "libavutil/internal.h"
  29 #include "libavutil/opt.h"
  30 #include "avfilter.h"
  31 #include "audio.h"
  32 #include "formats.h"
  33 #include "internal.h"
  34 #include "video.h"
  35
  36 #if CONFIG_AVCODEC
  37 #include "libavcodec/dsputil.h"
  38 #endif
  39
  40 static const char *const var_names[] = {
  41     "TB",                ///< timebase
  42
  43     "pts",               ///< original pts in the file of the frame
  44     "start_pts",         ///< first PTS in the stream, expressed in TB units
  45     "prev_pts",          ///< previous frame PTS
  46     "prev_selected_pts", ///< previous selected frame PTS
  47
  48     "t",                 ///< first PTS in seconds
  49     "start_t",           ///< first PTS in the stream, expressed in seconds
  50     "prev_t",            ///< previous frame time
  51     "prev_selected_t",   ///< previously selected time
  52
  53     "pict_type",         ///< the type of picture in the movie
  54     "I",
  55     "P",
  56     "B",
  57     "S",
  58     "SI",
  59     "SP",
  60     "BI",
  61
  62     "interlace_type",    ///< the frame interlace type
  63     "PROGRESSIVE",
  64     "TOPFIRST",
  65     "BOTTOMFIRST",
  66
  67     "consumed_samples_n",///< number of samples consumed by the filter (only audio)
  68     "samples_n",         ///< number of samples in the current frame (only audio)
  69     "sample_rate",       ///< sample rate (only audio)
  70
  71     "n",                 ///< frame number (starting from zero)
  72     "selected_n",        ///< selected frame number (starting from zero)
  73     "prev_selected_n",   ///< number of the last selected frame
  74
  75     "key",               ///< tell if the frame is a key frame
  76     "pos",               ///< original position in the file of the frame
  77
  78     "scene",
  79
  80     NULL
  81 };
  82
  83 enum var_name {
  84     VAR_TB,
  85
  86     VAR_PTS,
  87     VAR_START_PTS,
  88     VAR_PREV_PTS,
  89     VAR_PREV_SELECTED_PTS,
  90
  91     VAR_T,
  92     VAR_START_T,
  93     VAR_PREV_T,
  94     VAR_PREV_SELECTED_T,
  95
  96     VAR_PICT_TYPE,
  97     VAR_PICT_TYPE_I,
  98     VAR_PICT_TYPE_P,
  99     VAR_PICT_TYPE_B,
 100     VAR_PICT_TYPE_S,
 101     VAR_PICT_TYPE_SI,
 102     VAR_PICT_TYPE_SP,
 103     VAR_PICT_TYPE_BI,
 104
 105     VAR_INTERLACE_TYPE,
 106     VAR_INTERLACE_TYPE_P,
 107     VAR_INTERLACE_TYPE_T,
 108     VAR_INTERLACE_TYPE_B,
 109
 110     VAR_CONSUMED_SAMPLES_N,
 111     VAR_SAMPLES_N,
 112     VAR_SAMPLE_RATE,
 113
 114     VAR_N,
 115     VAR_SELECTED_N,
 116     VAR_PREV_SELECTED_N,
 117
 118     VAR_KEY,
 119     VAR_POS,
 120
 121     VAR_SCENE,
 122
 123     VAR_VARS_NB
 124 };
 125
 126 typedef struct {
 127     const AVClass *class;
 128     AVExpr *expr;
 129     char *expr_str;
 130     double var_values[VAR_VARS_NB];
 131     int do_scene_detect;            ///< 1 if the expression requires scene detection variables, 0 otherwise
 132 #if CONFIG_AVCODEC
 133     AVCodecContext *avctx;          ///< codec context required for the DSPContext (scene detect only)
 134     DSPContext c;                   ///< context providing optimized SAD methods   (scene detect only)
 135     double prev_mafd;               ///< previous MAFD                             (scene detect only)
 136 #endif
 137     AVFilterBufferRef *prev_picref; ///< previous frame                            (scene detect only)
 138     double select;
 139 } SelectContext;
 140
 141 #define OFFSET(x) offsetof(SelectContext, x)
 142 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM
 143 static const AVOption options[] = {
 144     { "expr", "set selection expression", OFFSET(expr_str), AV_OPT_TYPE_STRING, {.str = "1"}, 0, 0, FLAGS },
 145     { "e",    "set selection expression", OFFSET(expr_str), AV_OPT_TYPE_STRING, {.str = "1"}, 0, 0, FLAGS },
 146     {NULL},
 147 };
 148
 149 static av_cold int init(AVFilterContext *ctx, const char *args, const AVClass *class)
 150 {
 151     SelectContext *select = ctx->priv;
 152     const char *shorthand[] = { "expr", NULL };
 153     int ret;
 154
 155     select->class = class;
 156     av_opt_set_defaults(select);
 157
 158     if ((ret = av_opt_set_from_string(select, args, shorthand, "=", ":")) < 0)
 159         return ret;
 160
 161     if ((ret = av_expr_parse(&select->expr, select->expr_str,
 162                              var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
 163         av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", select->expr_str);
 164         return ret;
 165     }
 166     select->do_scene_detect = !!strstr(select->expr_str, "scene");
 167
 168     return 0;
 169 }
 170
 171 #define INTERLACE_TYPE_P 0
 172 #define INTERLACE_TYPE_T 1
 173 #define INTERLACE_TYPE_B 2
 174
 175 static int config_input(AVFilterLink *inlink)
 176 {
 177     SelectContext *select = inlink->dst->priv;
 178
 179     select->var_values[VAR_N]          = 0.0;
 180     select->var_values[VAR_SELECTED_N] = 0.0;
 181
 182     select->var_values[VAR_TB] = av_q2d(inlink->time_base);
 183
 184     select->var_values[VAR_PREV_PTS]          = NAN;
 185     select->var_values[VAR_PREV_SELECTED_PTS] = NAN;
 186     select->var_values[VAR_PREV_SELECTED_T]   = NAN;
 187     select->var_values[VAR_START_PTS]         = NAN;
 188     select->var_values[VAR_START_T]           = NAN;
 189
 190     select->var_values[VAR_PICT_TYPE_I]  = AV_PICTURE_TYPE_I;
 191     select->var_values[VAR_PICT_TYPE_P]  = AV_PICTURE_TYPE_P;
 192     select->var_values[VAR_PICT_TYPE_B]  = AV_PICTURE_TYPE_B;
 193     select->var_values[VAR_PICT_TYPE_SI] = AV_PICTURE_TYPE_SI;
 194     select->var_values[VAR_PICT_TYPE_SP] = AV_PICTURE_TYPE_SP;
 195
 196     select->var_values[VAR_INTERLACE_TYPE_P] = INTERLACE_TYPE_P;
 197     select->var_values[VAR_INTERLACE_TYPE_T] = INTERLACE_TYPE_T;
 198     select->var_values[VAR_INTERLACE_TYPE_B] = INTERLACE_TYPE_B;
 199
 200     select->var_values[VAR_PICT_TYPE]         = NAN;
 201     select->var_values[VAR_INTERLACE_TYPE]    = NAN;
 202     select->var_values[VAR_SCENE]             = NAN;
 203     select->var_values[VAR_CONSUMED_SAMPLES_N] = NAN;
 204     select->var_values[VAR_SAMPLES_N]          = NAN;
 205
 206     select->var_values[VAR_SAMPLE_RATE] =
 207         inlink->type == AVMEDIA_TYPE_AUDIO ? inlink->sample_rate : NAN;
 208
 209 #if CONFIG_AVCODEC
 210     if (select->do_scene_detect) {
 211         select->avctx = avcodec_alloc_context3(NULL);
 212         if (!select->avctx)
 213             return AVERROR(ENOMEM);
 214         dsputil_init(&select->c, select->avctx);
 215     }
 216 #endif
 217     return 0;
 218 }
 219
 220 #if CONFIG_AVCODEC
 221 static double get_scene_score(AVFilterContext *ctx, AVFilterBufferRef *picref)
 222 {
 223     double ret = 0;
 224     SelectContext *select = ctx->priv;
 225     AVFilterBufferRef *prev_picref = select->prev_picref;
 226
 227     if (prev_picref &&
 228         picref->video->h    == prev_picref->video->h &&
 229         picref->video->w    == prev_picref->video->w &&
 230         picref->linesize[0] == prev_picref->linesize[0]) {
 231         int x, y, nb_sad = 0;
 232         int64_t sad = 0;
 233         double mafd, diff;
 234         uint8_t *p1 =      picref->data[0];
 235         uint8_t *p2 = prev_picref->data[0];
 236         const int linesize = picref->linesize[0];
 237
 238         for (y = 0; y < picref->video->h - 8; y += 8) {
 239             for (x = 0; x < picref->video->w*3 - 8; x += 8) {
 240                 sad += select->c.sad[1](select, p1 + x, p2 + x,
 241                                         linesize, 8);
 242                 nb_sad += 8 * 8;
 243             }
 244             p1 += 8 * linesize;
 245             p2 += 8 * linesize;
 246         }
 247         emms_c();
 248         mafd = nb_sad ? sad / nb_sad : 0;
 249         diff = fabs(mafd - select->prev_mafd);
 250         ret  = av_clipf(FFMIN(mafd, diff) / 100., 0, 1);
 251         select->prev_mafd = mafd;
 252         avfilter_unref_buffer(prev_picref);
 253     }
 254     select->prev_picref = avfilter_ref_buffer(picref, ~0);
 255     return ret;
 256 }
 257 #endif
 258
 259 #define D2TS(d)  (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
 260 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
 261
 262 static int select_frame(AVFilterContext *ctx, AVFilterBufferRef *ref)
 263 {
 264     SelectContext *select = ctx->priv;
 265     AVFilterLink *inlink = ctx->inputs[0];
 266     double res;
 267
 268     if (isnan(select->var_values[VAR_START_PTS]))
 269         select->var_values[VAR_START_PTS] = TS2D(ref->pts);
 270     if (isnan(select->var_values[VAR_START_T]))
 271         select->var_values[VAR_START_T] = TS2D(ref->pts) * av_q2d(inlink->time_base);
 272
 273     select->var_values[VAR_PTS] = TS2D(ref->pts);
 274     select->var_values[VAR_T  ] = TS2D(ref->pts) * av_q2d(inlink->time_base);
 275     select->var_values[VAR_POS] = ref->pos == -1 ? NAN : ref->pos;
 276     select->var_values[VAR_PREV_PTS] = TS2D(ref ->pts);
 277
 278     switch (inlink->type) {
 279     case AVMEDIA_TYPE_AUDIO:
 280         select->var_values[VAR_SAMPLES_N] = ref->audio->nb_samples;
 281         break;
 282
 283     case AVMEDIA_TYPE_VIDEO:
 284         select->var_values[VAR_INTERLACE_TYPE] =
 285             !ref->video->interlaced ? INTERLACE_TYPE_P :
 286         ref->video->top_field_first ? INTERLACE_TYPE_T : INTERLACE_TYPE_B;
 287         select->var_values[VAR_PICT_TYPE] = ref->video->pict_type;
 288 #if CONFIG_AVCODEC
 289         if (select->do_scene_detect) {
 290             char buf[32];
 291             select->var_values[VAR_SCENE] = get_scene_score(ctx, ref);
 292             // TODO: document metadata
 293             snprintf(buf, sizeof(buf), "%f", select->var_values[VAR_SCENE]);
 294             av_dict_set(&ref->metadata, "lavfi.scene_score", buf, 0);
 295         }
 296 #endif
 297         break;
 298     }
 299
 300     res = av_expr_eval(select->expr, select->var_values, NULL);
 301     av_log(inlink->dst, AV_LOG_DEBUG,
 302            "n:%d pts:%d t:%f pos:%d key:%d",
 303            (int)select->var_values[VAR_N],
 304            (int)select->var_values[VAR_PTS],
 305            select->var_values[VAR_T],
 306            (int)select->var_values[VAR_POS],
 307            (int)select->var_values[VAR_KEY]);
 308
 309     switch (inlink->type) {
 310     case AVMEDIA_TYPE_VIDEO:
 311         av_log(inlink->dst, AV_LOG_DEBUG, " interlace_type:%c pict_type:%c scene:%f",
 312                select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_P ? 'P' :
 313                select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_T ? 'T' :
 314                select->var_values[VAR_INTERLACE_TYPE] == INTERLACE_TYPE_B ? 'B' : '?',
 315                av_get_picture_type_char(select->var_values[VAR_PICT_TYPE]),
 316                select->var_values[VAR_SCENE]);
 317         break;
 318     case AVMEDIA_TYPE_AUDIO:
 319         av_log(inlink->dst, AV_LOG_DEBUG, " samples_n:%d consumed_samples_n:%d",
 320                (int)select->var_values[VAR_SAMPLES_N],
 321                (int)select->var_values[VAR_CONSUMED_SAMPLES_N]);
 322         break;
 323     }
 324
 325     av_log(inlink->dst, AV_LOG_DEBUG, " -> select:%f\n", res);
 326
 327     if (res) {
 328         select->var_values[VAR_PREV_SELECTED_N]   = select->var_values[VAR_N];
 329         select->var_values[VAR_PREV_SELECTED_PTS] = select->var_values[VAR_PTS];
 330         select->var_values[VAR_PREV_SELECTED_T]   = select->var_values[VAR_T];
 331         select->var_values[VAR_SELECTED_N] += 1.0;
 332         if (inlink->type == AVMEDIA_TYPE_AUDIO)
 333             select->var_values[VAR_CONSUMED_SAMPLES_N] += ref->audio->nb_samples;
 334     }
 335
 336     select->var_values[VAR_N] += 1.0;
 337
 338     return res;
 339 }
 340
 341 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *frame)
 342 {
 343     SelectContext *select = inlink->dst->priv;
 344
 345     select->select = select_frame(inlink->dst, frame);
 346     if (select->select)
 347         return ff_filter_frame(inlink->dst->outputs[0], frame);
 348
 349     avfilter_unref_bufferp(&frame);
 350     return 0;
 351 }
 352
 353 static int request_frame(AVFilterLink *outlink)
 354 {
 355     AVFilterContext *ctx = outlink->src;
 356     SelectContext *select = ctx->priv;
 357     AVFilterLink *inlink = outlink->src->inputs[0];
 358     select->select = 0;
 359
 360     do {
 361         int ret = ff_request_frame(inlink);
 362         if (ret < 0)
 363             return ret;
 364     } while (!select->select);
 365
 366     return 0;
 367 }
 368
 369 static av_cold void uninit(AVFilterContext *ctx)
 370 {
 371     SelectContext *select = ctx->priv;
 372
 373     av_expr_free(select->expr);
 374     select->expr = NULL;
 375     av_opt_free(select);
 376
 377 #if CONFIG_AVCODEC
 378     if (select->do_scene_detect) {
 379         avfilter_unref_bufferp(&select->prev_picref);
 380         if (select->avctx) {
 381             avcodec_close(select->avctx);
 382             av_freep(&select->avctx);
 383         }
 384     }
 385 #endif
 386 }
 387
 388 static int query_formats(AVFilterContext *ctx)
 389 {
 390     SelectContext *select = ctx->priv;
 391
 392     if (!select->do_scene_detect) {
 393         return ff_default_query_formats(ctx);
 394     } else {
 395         static const enum AVPixelFormat pix_fmts[] = {
 396             AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
 397             AV_PIX_FMT_NONE
 398         };
 399         ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 400     }
 401     return 0;
 402 }
 403
 404 #if CONFIG_ASELECT_FILTER
 405
 406 #define aselect_options options
 407 AVFILTER_DEFINE_CLASS(aselect);
 408
 409 static av_cold int aselect_init(AVFilterContext *ctx, const char *args)
 410 {
 411     SelectContext *select = ctx->priv;
 412     int ret;
 413
 414     if ((ret = init(ctx, args, &aselect_class)) < 0)
 415         return ret;
 416
 417     if (select->do_scene_detect) {
 418         av_log(ctx, AV_LOG_ERROR, "Scene detection is ignored in aselect filter\n");
 419         return AVERROR(EINVAL);
 420     }
 421
 422     return 0;
 423 }
 424
 425 static const AVFilterPad avfilter_af_aselect_inputs[] = {
 426     {
 427         .name             = "default",
 428         .type             = AVMEDIA_TYPE_AUDIO,
 429         .get_audio_buffer = ff_null_get_audio_buffer,
 430         .config_props     = config_input,
 431         .filter_frame     = filter_frame,
 432     },
 433     { NULL }
 434 };
 435
 436 static const AVFilterPad avfilter_af_aselect_outputs[] = {
 437     {
 438         .name = "default",
 439         .type = AVMEDIA_TYPE_AUDIO,
 440     },
 441     { NULL }
 442 };
 443
 444 AVFilter avfilter_af_aselect = {
 445     .name      = "aselect",
 446     .description = NULL_IF_CONFIG_SMALL("Select audio frames to pass in output."),
 447     .init      = aselect_init,
 448     .uninit    = uninit,
 449     .priv_size = sizeof(SelectContext),
 450     .inputs    = avfilter_af_aselect_inputs,
 451     .outputs   = avfilter_af_aselect_outputs,
 452     .priv_class = &aselect_class,
 453 };
 454 #endif /* CONFIG_ASELECT_FILTER */
 455
 456 #if CONFIG_SELECT_FILTER
 457
 458 #define select_options options
 459 AVFILTER_DEFINE_CLASS(select);
 460
 461 static av_cold int select_init(AVFilterContext *ctx, const char *args)
 462 {
 463     SelectContext *select = ctx->priv;
 464     int ret;
 465
 466     if ((ret = init(ctx, args, &select_class)) < 0)
 467         return ret;
 468
 469     if (select->do_scene_detect && !CONFIG_AVCODEC) {
 470         av_log(ctx, AV_LOG_ERROR, "Scene detection is not available without libavcodec.\n");
 471         return AVERROR(EINVAL);
 472     }
 473
 474     return 0;
 475 }
 476
 477 static const AVFilterPad avfilter_vf_select_inputs[] = {
 478     {
 479         .name             = "default",
 480         .type             = AVMEDIA_TYPE_VIDEO,
 481         .get_video_buffer = ff_null_get_video_buffer,
 482         .min_perms        = AV_PERM_PRESERVE,
 483         .config_props     = config_input,
 484         .filter_frame     = filter_frame,
 485     },
 486     { NULL }
 487 };
 488
 489 static const AVFilterPad avfilter_vf_select_outputs[] = {
 490     {
 491         .name          = "default",
 492         .type          = AVMEDIA_TYPE_VIDEO,
 493         .request_frame = request_frame,
 494     },
 495     { NULL }
 496 };
 497
 498 AVFilter avfilter_vf_select = {
 499     .name      = "select",
 500     .description = NULL_IF_CONFIG_SMALL("Select video frames to pass in output."),
 501     .init      = select_init,
 502     .uninit    = uninit,
 503     .query_formats = query_formats,
 504
 505     .priv_size = sizeof(SelectContext),
 506
 507     .inputs    = avfilter_vf_select_inputs,
 508     .outputs   = avfilter_vf_select_outputs,
 509     .priv_class = &select_class,
 510 };
 511 #endif /* CONFIG_SELECT_FILTER */