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

   1 /*
   2  * Copyright (c) 2016 Paul B Mahol
   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 manipulating frame metadata
  24  */
  25
  26 #include <float.h>
  27
  28 #include "libavutil/avassert.h"
  29 #include "libavutil/avstring.h"
  30 #include "libavutil/eval.h"
  31 #include "libavutil/internal.h"
  32 #include "libavutil/opt.h"
  33 #include "libavutil/timestamp.h"
  34 #include "libavformat/avio.h"
  35 #include "avfilter.h"
  36 #include "audio.h"
  37 #include "formats.h"
  38 #include "internal.h"
  39 #include "video.h"
  40
  41 enum MetadataMode {
  42     METADATA_SELECT,
  43     METADATA_ADD,
  44     METADATA_MODIFY,
  45     METADATA_DELETE,
  46     METADATA_PRINT,
  47     METADATA_NB
  48 };
  49
  50 enum MetadataFunction {
  51     METADATAF_SAME_STR,
  52     METADATAF_STARTS_WITH,
  53     METADATAF_LESS,
  54     METADATAF_EQUAL,
  55     METADATAF_GREATER,
  56     METADATAF_EXPR,
  57     METADATAF_ENDS_WITH,
  58     METADATAF_NB
  59 };
  60
  61 static const char *const var_names[] = {
  62     "VALUE1",
  63     "VALUE2",
  64     NULL
  65 };
  66
  67 enum var_name {
  68     VAR_VALUE1,
  69     VAR_VALUE2,
  70     VAR_VARS_NB
  71 };
  72
  73 typedef struct MetadataContext {
  74     const AVClass *class;
  75
  76     int mode;
  77     char *key;
  78     char *value;
  79     int function;
  80
  81     char *expr_str;
  82     AVExpr *expr;
  83     double var_values[VAR_VARS_NB];
  84
  85     AVIOContext* avio_context;
  86     char *file_str;
  87
  88     int (*compare)(struct MetadataContext *s,
  89                    const char *value1, const char *value2);
  90     void (*print)(AVFilterContext *ctx, const char *msg, ...) av_printf_format(2, 3);
  91 } MetadataContext;
  92
  93 #define OFFSET(x) offsetof(MetadataContext, x)
  94 #define DEFINE_OPTIONS(filt_name, FLAGS) \
  95 static const AVOption filt_name##_options[] = { \
  96     { "mode", "set a mode of operation", OFFSET(mode),   AV_OPT_TYPE_INT,    {.i64 = 0 }, 0, METADATA_NB-1, FLAGS, "mode" }, \
  97     {   "select", "select frame",        0,              AV_OPT_TYPE_CONST,  {.i64 = METADATA_SELECT }, 0, 0, FLAGS, "mode" }, \
  98     {   "add",    "add new metadata",    0,              AV_OPT_TYPE_CONST,  {.i64 = METADATA_ADD },    0, 0, FLAGS, "mode" }, \
  99     {   "modify", "modify metadata",     0,              AV_OPT_TYPE_CONST,  {.i64 = METADATA_MODIFY }, 0, 0, FLAGS, "mode" }, \
 100     {   "delete", "delete metadata",     0,              AV_OPT_TYPE_CONST,  {.i64 = METADATA_DELETE }, 0, 0, FLAGS, "mode" }, \
 101     {   "print",  "print metadata",      0,              AV_OPT_TYPE_CONST,  {.i64 = METADATA_PRINT },  0, 0, FLAGS, "mode" }, \
 102     { "key",   "set metadata key",       OFFSET(key),    AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, FLAGS }, \
 103     { "value", "set metadata value",     OFFSET(value),  AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, FLAGS }, \
 104     { "function", "function for comparing values", OFFSET(function), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, METADATAF_NB-1, FLAGS, "function" }, \
 105     {   "same_str",    NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_SAME_STR },    0, 3, FLAGS, "function" }, \
 106     {   "starts_with", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_STARTS_WITH }, 0, 0, FLAGS, "function" }, \
 107     {   "less",        NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_LESS    },     0, 3, FLAGS, "function" }, \
 108     {   "equal",       NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_EQUAL   },     0, 3, FLAGS, "function" }, \
 109     {   "greater",     NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_GREATER },     0, 3, FLAGS, "function" }, \
 110     {   "expr",        NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_EXPR    },     0, 3, FLAGS, "function" }, \
 111     {   "ends_with",   NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_ENDS_WITH },   0, 0, FLAGS, "function" }, \
 112     { "expr", "set expression for expr function", OFFSET(expr_str), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, FLAGS }, \
 113     { "file", "set file where to print metadata information", OFFSET(file_str), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS }, \
 114     { NULL } \
 115 }
 116
 117 static int same_str(MetadataContext *s, const char *value1, const char *value2)
 118 {
 119     return !strcmp(value1, value2);
 120 }
 121
 122 static int starts_with(MetadataContext *s, const char *value1, const char *value2)
 123 {
 124     return !strncmp(value1, value2, strlen(value2));
 125 }
 126
 127 static int ends_with(MetadataContext *s, const char *value1, const char *value2)
 128 {
 129     const int len1 = strlen(value1);
 130     const int len2 = strlen(value2);
 131
 132     return !strncmp(value1 + FFMAX(len1 - len2, 0), value2, len2);
 133 }
 134
 135 static int equal(MetadataContext *s, const char *value1, const char *value2)
 136 {
 137     float f1, f2;
 138
 139     if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
 140         return 0;
 141
 142     return fabsf(f1 - f2) < FLT_EPSILON;
 143 }
 144
 145 static int less(MetadataContext *s, const char *value1, const char *value2)
 146 {
 147     float f1, f2;
 148
 149     if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
 150         return 0;
 151
 152     return (f1 - f2) < FLT_EPSILON;
 153 }
 154
 155 static int greater(MetadataContext *s, const char *value1, const char *value2)
 156 {
 157     float f1, f2;
 158
 159     if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
 160         return 0;
 161
 162     return (f2 - f1) < FLT_EPSILON;
 163 }
 164
 165 static int parse_expr(MetadataContext *s, const char *value1, const char *value2)
 166 {
 167     double f1, f2;
 168
 169     if (sscanf(value1, "%lf", &f1) + sscanf(value2, "%lf", &f2) != 2)
 170         return 0;
 171
 172     s->var_values[VAR_VALUE1] = f1;
 173     s->var_values[VAR_VALUE2] = f2;
 174
 175     return av_expr_eval(s->expr, s->var_values, NULL);
 176 }
 177
 178 static void print_log(AVFilterContext *ctx, const char *msg, ...)
 179 {
 180     va_list argument_list;
 181
 182     va_start(argument_list, msg);
 183     if (msg)
 184         av_vlog(ctx, AV_LOG_INFO, msg, argument_list);
 185     va_end(argument_list);
 186 }
 187
 188 static void print_file(AVFilterContext *ctx, const char *msg, ...)
 189 {
 190     MetadataContext *s = ctx->priv;
 191     va_list argument_list;
 192
 193     va_start(argument_list, msg);
 194     if (msg) {
 195         char buf[128];
 196         vsnprintf(buf, sizeof(buf), msg, argument_list);
 197         avio_write(s->avio_context, buf, av_strnlen(buf, sizeof(buf)));
 198     }
 199     va_end(argument_list);
 200 }
 201
 202 static av_cold int init(AVFilterContext *ctx)
 203 {
 204     MetadataContext *s = ctx->priv;
 205     int ret;
 206
 207     if (!s->key && s->mode != METADATA_PRINT && s->mode != METADATA_DELETE) {
 208         av_log(ctx, AV_LOG_WARNING, "Metadata key must be set\n");
 209         return AVERROR(EINVAL);
 210     }
 211
 212     if ((s->mode == METADATA_MODIFY ||
 213         s->mode == METADATA_ADD) && !s->value) {
 214         av_log(ctx, AV_LOG_WARNING, "Missing metadata value\n");
 215         return AVERROR(EINVAL);
 216     }
 217
 218     switch (s->function) {
 219     case METADATAF_SAME_STR:
 220         s->compare = same_str;
 221         break;
 222     case METADATAF_STARTS_WITH:
 223         s->compare = starts_with;
 224         break;
 225     case METADATAF_ENDS_WITH:
 226         s->compare = ends_with;
 227         break;
 228     case METADATAF_LESS:
 229         s->compare = less;
 230         break;
 231     case METADATAF_EQUAL:
 232         s->compare = equal;
 233         break;
 234     case METADATAF_GREATER:
 235         s->compare = greater;
 236         break;
 237     case METADATAF_EXPR:
 238         s->compare = parse_expr;
 239         break;
 240     default:
 241         av_assert0(0);
 242     };
 243
 244     if (s->function == METADATAF_EXPR) {
 245         if (!s->expr_str) {
 246             av_log(ctx, AV_LOG_WARNING, "expr option not set\n");
 247             return AVERROR(EINVAL);
 248         }
 249         if ((ret = av_expr_parse(&s->expr, s->expr_str,
 250                                  var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
 251             av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", s->expr_str);
 252             return ret;
 253         }
 254     }
 255
 256     if (s->mode == METADATA_PRINT && s->file_str) {
 257         s->print = print_file;
 258     } else {
 259         s->print = print_log;
 260     }
 261
 262     s->avio_context = NULL;
 263     if (s->file_str) {
 264         if (!strcmp("-", s->file_str)) {
 265             ret = avio_open(&s->avio_context, "pipe:1", AVIO_FLAG_WRITE);
 266         } else {
 267             ret = avio_open(&s->avio_context, s->file_str, AVIO_FLAG_WRITE);
 268         }
 269
 270         if (ret < 0) {
 271             char buf[128];
 272             av_strerror(ret, buf, sizeof(buf));
 273             av_log(ctx, AV_LOG_ERROR, "Could not open %s: %s\n",
 274                    s->file_str, buf);
 275             return ret;
 276         }
 277     }
 278
 279     return 0;
 280 }
 281
 282 static av_cold void uninit(AVFilterContext *ctx)
 283 {
 284     MetadataContext *s = ctx->priv;
 285
 286     av_expr_free(s->expr);
 287     s->expr = NULL;
 288     if (s->avio_context) {
 289         avio_closep(&s->avio_context);
 290     }
 291 }
 292
 293 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 294 {
 295     AVFilterContext *ctx = inlink->dst;
 296     AVFilterLink *outlink = ctx->outputs[0];
 297     MetadataContext *s = ctx->priv;
 298     AVDictionary **metadata = &frame->metadata;
 299     AVDictionaryEntry *e;
 300
 301     if (!*metadata)
 302         return ff_filter_frame(outlink, frame);
 303
 304     e = av_dict_get(*metadata, !s->key ? "" : s->key, NULL,
 305                     !s->key ? AV_DICT_IGNORE_SUFFIX: 0);
 306
 307     switch (s->mode) {
 308     case METADATA_SELECT:
 309         if (!s->value && e && e->value) {
 310             return ff_filter_frame(outlink, frame);
 311         } else if (s->value && e && e->value &&
 312                    s->compare(s, e->value, s->value)) {
 313             return ff_filter_frame(outlink, frame);
 314         }
 315         break;
 316     case METADATA_ADD:
 317         if (e && e->value) {
 318             ;
 319         } else {
 320             av_dict_set(metadata, s->key, s->value, 0);
 321         }
 322         return ff_filter_frame(outlink, frame);
 323         break;
 324     case METADATA_MODIFY:
 325         if (e && e->value) {
 326             av_dict_set(metadata, s->key, s->value, 0);
 327         }
 328         return ff_filter_frame(outlink, frame);
 329         break;
 330     case METADATA_PRINT:
 331         if (!s->key && e) {
 332             s->print(ctx, "frame:%-4"PRId64" pts:%-7s pts_time:%s\n",
 333                      inlink->frame_count_out, av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base));
 334             s->print(ctx, "%s=%s\n", e->key, e->value);
 335             while ((e = av_dict_get(*metadata, "", e, AV_DICT_IGNORE_SUFFIX)) != NULL) {
 336                 s->print(ctx, "%s=%s\n", e->key, e->value);
 337             }
 338         } else if (e && e->value && (!s->value || (e->value && s->compare(s, e->value, s->value)))) {
 339             s->print(ctx, "frame:%-4"PRId64" pts:%-7s pts_time:%s\n",
 340                      inlink->frame_count_out, av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base));
 341             s->print(ctx, "%s=%s\n", s->key, e->value);
 342         }
 343         return ff_filter_frame(outlink, frame);
 344         break;
 345     case METADATA_DELETE:
 346         if (!s->key) {
 347             av_dict_free(metadata);
 348         } else if (e && e->value && (!s->value || s->compare(s, e->value, s->value))) {
 349             av_dict_set(metadata, s->key, NULL, 0);
 350         }
 351         return ff_filter_frame(outlink, frame);
 352         break;
 353     default:
 354         av_assert0(0);
 355     };
 356
 357     av_frame_free(&frame);
 358
 359     return 0;
 360 }
 361
 362 #if CONFIG_AMETADATA_FILTER
 363
 364 DEFINE_OPTIONS(ametadata, AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
 365 AVFILTER_DEFINE_CLASS(ametadata);
 366
 367 static const AVFilterPad ainputs[] = {
 368     {
 369         .name         = "default",
 370         .type         = AVMEDIA_TYPE_AUDIO,
 371         .filter_frame = filter_frame,
 372     },
 373     { NULL }
 374 };
 375
 376 static const AVFilterPad aoutputs[] = {
 377     {
 378         .name = "default",
 379         .type = AVMEDIA_TYPE_AUDIO,
 380     },
 381     { NULL }
 382 };
 383
 384 AVFilter ff_af_ametadata = {
 385     .name          = "ametadata",
 386     .description   = NULL_IF_CONFIG_SMALL("Manipulate audio frame metadata."),
 387     .priv_size     = sizeof(MetadataContext),
 388     .priv_class    = &ametadata_class,
 389     .init          = init,
 390     .uninit        = uninit,
 391     .inputs        = ainputs,
 392     .outputs       = aoutputs,
 393     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 394 };
 395 #endif /* CONFIG_AMETADATA_FILTER */
 396
 397 #if CONFIG_METADATA_FILTER
 398
 399 DEFINE_OPTIONS(metadata, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
 400 AVFILTER_DEFINE_CLASS(metadata);
 401
 402 static const AVFilterPad inputs[] = {
 403     {
 404         .name         = "default",
 405         .type         = AVMEDIA_TYPE_VIDEO,
 406         .filter_frame = filter_frame,
 407     },
 408     { NULL }
 409 };
 410
 411 static const AVFilterPad outputs[] = {
 412     {
 413         .name = "default",
 414         .type = AVMEDIA_TYPE_VIDEO,
 415     },
 416     { NULL }
 417 };
 418
 419 AVFilter ff_vf_metadata = {
 420     .name        = "metadata",
 421     .description = NULL_IF_CONFIG_SMALL("Manipulate video frame metadata."),
 422     .priv_size   = sizeof(MetadataContext),
 423     .priv_class  = &metadata_class,
 424     .init        = init,
 425     .uninit      = uninit,
 426     .inputs      = inputs,
 427     .outputs     = outputs,
 428     .flags       = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 429 };
 430 #endif /* CONFIG_METADATA_FILTER */