2 * Copyright (c) 2016 Paul B Mahol
4 * This file is part of FFmpeg.
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.
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.
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
23 * filter for manipulating frame metadata
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"
50 enum MetadataFunction {
52 METADATAF_STARTS_WITH,
61 static const char *const var_names[] = {
73 typedef struct MetadataContext {
83 double var_values[VAR_VARS_NB];
85 AVIOContext* avio_context;
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);
92 int direct; // reduces buffering when printing to user-supplied URL
95 #define OFFSET(x) offsetof(MetadataContext, x)
96 #define DEFINE_OPTIONS(filt_name, FLAGS) \
97 static const AVOption filt_name##_options[] = { \
98 { "mode", "set a mode of operation", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, METADATA_NB-1, FLAGS, "mode" }, \
99 { "select", "select frame", 0, AV_OPT_TYPE_CONST, {.i64 = METADATA_SELECT }, 0, 0, FLAGS, "mode" }, \
100 { "add", "add new metadata", 0, AV_OPT_TYPE_CONST, {.i64 = METADATA_ADD }, 0, 0, FLAGS, "mode" }, \
101 { "modify", "modify metadata", 0, AV_OPT_TYPE_CONST, {.i64 = METADATA_MODIFY }, 0, 0, FLAGS, "mode" }, \
102 { "delete", "delete metadata", 0, AV_OPT_TYPE_CONST, {.i64 = METADATA_DELETE }, 0, 0, FLAGS, "mode" }, \
103 { "print", "print metadata", 0, AV_OPT_TYPE_CONST, {.i64 = METADATA_PRINT }, 0, 0, FLAGS, "mode" }, \
104 { "key", "set metadata key", OFFSET(key), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, FLAGS }, \
105 { "value", "set metadata value", OFFSET(value), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, FLAGS }, \
106 { "function", "function for comparing values", OFFSET(function), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, METADATAF_NB-1, FLAGS, "function" }, \
107 { "same_str", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_SAME_STR }, 0, 3, FLAGS, "function" }, \
108 { "starts_with", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_STARTS_WITH }, 0, 0, FLAGS, "function" }, \
109 { "less", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_LESS }, 0, 3, FLAGS, "function" }, \
110 { "equal", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_EQUAL }, 0, 3, FLAGS, "function" }, \
111 { "greater", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_GREATER }, 0, 3, FLAGS, "function" }, \
112 { "expr", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_EXPR }, 0, 3, FLAGS, "function" }, \
113 { "ends_with", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = METADATAF_ENDS_WITH }, 0, 0, FLAGS, "function" }, \
114 { "expr", "set expression for expr function", OFFSET(expr_str), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, FLAGS }, \
115 { "file", "set file where to print metadata information", OFFSET(file_str), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS }, \
116 { "direct", "reduce buffering when printing to user-set file or pipe", OFFSET(direct), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, FLAGS }, \
120 static int same_str(MetadataContext *s, const char *value1, const char *value2)
122 return !strcmp(value1, value2);
125 static int starts_with(MetadataContext *s, const char *value1, const char *value2)
127 return !strncmp(value1, value2, strlen(value2));
130 static int ends_with(MetadataContext *s, const char *value1, const char *value2)
132 const int len1 = strlen(value1);
133 const int len2 = strlen(value2);
135 return !strncmp(value1 + FFMAX(len1 - len2, 0), value2, len2);
138 static int equal(MetadataContext *s, const char *value1, const char *value2)
142 if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
145 return fabsf(f1 - f2) < FLT_EPSILON;
148 static int less(MetadataContext *s, const char *value1, const char *value2)
152 if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
155 return (f1 - f2) < FLT_EPSILON;
158 static int greater(MetadataContext *s, const char *value1, const char *value2)
162 if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
165 return (f2 - f1) < FLT_EPSILON;
168 static int parse_expr(MetadataContext *s, const char *value1, const char *value2)
172 if (sscanf(value1, "%lf", &f1) + sscanf(value2, "%lf", &f2) != 2)
175 s->var_values[VAR_VALUE1] = f1;
176 s->var_values[VAR_VALUE2] = f2;
178 return av_expr_eval(s->expr, s->var_values, NULL);
181 static void print_log(AVFilterContext *ctx, const char *msg, ...)
183 va_list argument_list;
185 va_start(argument_list, msg);
187 av_vlog(ctx, AV_LOG_INFO, msg, argument_list);
188 va_end(argument_list);
191 static void print_file(AVFilterContext *ctx, const char *msg, ...)
193 MetadataContext *s = ctx->priv;
194 va_list argument_list;
196 va_start(argument_list, msg);
199 vsnprintf(buf, sizeof(buf), msg, argument_list);
200 avio_write(s->avio_context, buf, av_strnlen(buf, sizeof(buf)));
202 va_end(argument_list);
205 static av_cold int init(AVFilterContext *ctx)
207 MetadataContext *s = ctx->priv;
210 if (!s->key && s->mode != METADATA_PRINT && s->mode != METADATA_DELETE) {
211 av_log(ctx, AV_LOG_WARNING, "Metadata key must be set\n");
212 return AVERROR(EINVAL);
215 if ((s->mode == METADATA_MODIFY ||
216 s->mode == METADATA_ADD) && !s->value) {
217 av_log(ctx, AV_LOG_WARNING, "Missing metadata value\n");
218 return AVERROR(EINVAL);
221 switch (s->function) {
222 case METADATAF_SAME_STR:
223 s->compare = same_str;
225 case METADATAF_STARTS_WITH:
226 s->compare = starts_with;
228 case METADATAF_ENDS_WITH:
229 s->compare = ends_with;
234 case METADATAF_EQUAL:
237 case METADATAF_GREATER:
238 s->compare = greater;
241 s->compare = parse_expr;
247 if (s->function == METADATAF_EXPR) {
249 av_log(ctx, AV_LOG_WARNING, "expr option not set\n");
250 return AVERROR(EINVAL);
252 if ((ret = av_expr_parse(&s->expr, s->expr_str,
253 var_names, NULL, NULL, NULL, NULL, 0, ctx)) < 0) {
254 av_log(ctx, AV_LOG_ERROR, "Error while parsing expression '%s'\n", s->expr_str);
259 if (s->mode == METADATA_PRINT && s->file_str) {
260 s->print = print_file;
262 s->print = print_log;
265 s->avio_context = NULL;
267 if (!strcmp("-", s->file_str)) {
268 ret = avio_open(&s->avio_context, "pipe:1", AVIO_FLAG_WRITE);
270 ret = avio_open(&s->avio_context, s->file_str, AVIO_FLAG_WRITE);
275 av_strerror(ret, buf, sizeof(buf));
276 av_log(ctx, AV_LOG_ERROR, "Could not open %s: %s\n",
282 s->avio_context->direct = AVIO_FLAG_DIRECT;
288 static av_cold void uninit(AVFilterContext *ctx)
290 MetadataContext *s = ctx->priv;
292 av_expr_free(s->expr);
294 if (s->avio_context) {
295 avio_closep(&s->avio_context);
299 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
301 AVFilterContext *ctx = inlink->dst;
302 AVFilterLink *outlink = ctx->outputs[0];
303 MetadataContext *s = ctx->priv;
304 AVDictionary **metadata = &frame->metadata;
305 AVDictionaryEntry *e;
307 if (!*metadata && s->mode != METADATA_ADD)
308 return ff_filter_frame(outlink, frame);
310 e = av_dict_get(*metadata, !s->key ? "" : s->key, NULL,
311 !s->key ? AV_DICT_IGNORE_SUFFIX: 0);
314 case METADATA_SELECT:
315 if (!s->value && e && e->value) {
316 return ff_filter_frame(outlink, frame);
317 } else if (s->value && e && e->value &&
318 s->compare(s, e->value, s->value)) {
319 return ff_filter_frame(outlink, frame);
326 av_dict_set(metadata, s->key, s->value, 0);
328 return ff_filter_frame(outlink, frame);
329 case METADATA_MODIFY:
331 av_dict_set(metadata, s->key, s->value, 0);
333 return ff_filter_frame(outlink, frame);
336 s->print(ctx, "frame:%-4"PRId64" pts:%-7s pts_time:%s\n",
337 inlink->frame_count_out, av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base));
338 s->print(ctx, "%s=%s\n", e->key, e->value);
339 while ((e = av_dict_get(*metadata, "", e, AV_DICT_IGNORE_SUFFIX)) != NULL) {
340 s->print(ctx, "%s=%s\n", e->key, e->value);
342 } else if (e && e->value && (!s->value || (e->value && s->compare(s, e->value, s->value)))) {
343 s->print(ctx, "frame:%-4"PRId64" pts:%-7s pts_time:%s\n",
344 inlink->frame_count_out, av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base));
345 s->print(ctx, "%s=%s\n", s->key, e->value);
347 return ff_filter_frame(outlink, frame);
348 case METADATA_DELETE:
350 av_dict_free(metadata);
351 } else if (e && e->value && (!s->value || s->compare(s, e->value, s->value))) {
352 av_dict_set(metadata, s->key, NULL, 0);
354 return ff_filter_frame(outlink, frame);
359 av_frame_free(&frame);
364 #if CONFIG_AMETADATA_FILTER
366 DEFINE_OPTIONS(ametadata, AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
367 AVFILTER_DEFINE_CLASS(ametadata);
369 static const AVFilterPad ainputs[] = {
372 .type = AVMEDIA_TYPE_AUDIO,
373 .filter_frame = filter_frame,
378 static const AVFilterPad aoutputs[] = {
381 .type = AVMEDIA_TYPE_AUDIO,
386 AVFilter ff_af_ametadata = {
388 .description = NULL_IF_CONFIG_SMALL("Manipulate audio frame metadata."),
389 .priv_size = sizeof(MetadataContext),
390 .priv_class = &ametadata_class,
395 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
397 #endif /* CONFIG_AMETADATA_FILTER */
399 #if CONFIG_METADATA_FILTER
401 DEFINE_OPTIONS(metadata, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
402 AVFILTER_DEFINE_CLASS(metadata);
404 static const AVFilterPad inputs[] = {
407 .type = AVMEDIA_TYPE_VIDEO,
408 .filter_frame = filter_frame,
413 static const AVFilterPad outputs[] = {
416 .type = AVMEDIA_TYPE_VIDEO,
421 AVFilter ff_vf_metadata = {
423 .description = NULL_IF_CONFIG_SMALL("Manipulate video frame metadata."),
424 .priv_size = sizeof(MetadataContext),
425 .priv_class = &metadata_class,
430 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
432 #endif /* CONFIG_METADATA_FILTER */