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);
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 }, \
117 static int same_str(MetadataContext *s, const char *value1, const char *value2)
119 return !strcmp(value1, value2);
122 static int starts_with(MetadataContext *s, const char *value1, const char *value2)
124 return !strncmp(value1, value2, strlen(value2));
127 static int ends_with(MetadataContext *s, const char *value1, const char *value2)
129 const int len1 = strlen(value1);
130 const int len2 = strlen(value2);
132 return !strncmp(value1 + FFMAX(len1 - len2, 0), value2, len2);
135 static int equal(MetadataContext *s, const char *value1, const char *value2)
139 if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
142 return fabsf(f1 - f2) < FLT_EPSILON;
145 static int less(MetadataContext *s, const char *value1, const char *value2)
149 if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
152 return (f1 - f2) < FLT_EPSILON;
155 static int greater(MetadataContext *s, const char *value1, const char *value2)
159 if (sscanf(value1, "%f", &f1) + sscanf(value2, "%f", &f2) != 2)
162 return (f2 - f1) < FLT_EPSILON;
165 static int parse_expr(MetadataContext *s, const char *value1, const char *value2)
169 if (sscanf(value1, "%lf", &f1) + sscanf(value2, "%lf", &f2) != 2)
172 s->var_values[VAR_VALUE1] = f1;
173 s->var_values[VAR_VALUE2] = f2;
175 return av_expr_eval(s->expr, s->var_values, NULL);
178 static void print_log(AVFilterContext *ctx, const char *msg, ...)
180 va_list argument_list;
182 va_start(argument_list, msg);
184 av_vlog(ctx, AV_LOG_INFO, msg, argument_list);
185 va_end(argument_list);
188 static void print_file(AVFilterContext *ctx, const char *msg, ...)
190 MetadataContext *s = ctx->priv;
191 va_list argument_list;
193 va_start(argument_list, msg);
196 vsnprintf(buf, sizeof(buf), msg, argument_list);
197 avio_write(s->avio_context, buf, av_strnlen(buf, sizeof(buf)));
199 va_end(argument_list);
202 static av_cold int init(AVFilterContext *ctx)
204 MetadataContext *s = ctx->priv;
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);
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);
218 switch (s->function) {
219 case METADATAF_SAME_STR:
220 s->compare = same_str;
222 case METADATAF_STARTS_WITH:
223 s->compare = starts_with;
225 case METADATAF_ENDS_WITH:
226 s->compare = ends_with;
231 case METADATAF_EQUAL:
234 case METADATAF_GREATER:
235 s->compare = greater;
238 s->compare = parse_expr;
244 if (s->function == METADATAF_EXPR) {
246 av_log(ctx, AV_LOG_WARNING, "expr option not set\n");
247 return AVERROR(EINVAL);
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);
256 if (s->mode == METADATA_PRINT && s->file_str) {
257 s->print = print_file;
259 s->print = print_log;
262 s->avio_context = NULL;
264 if (!strcmp("-", s->file_str)) {
265 ret = avio_open(&s->avio_context, "pipe:1", AVIO_FLAG_WRITE);
267 ret = avio_open(&s->avio_context, s->file_str, AVIO_FLAG_WRITE);
272 av_strerror(ret, buf, sizeof(buf));
273 av_log(ctx, AV_LOG_ERROR, "Could not open %s: %s\n",
282 static av_cold void uninit(AVFilterContext *ctx)
284 MetadataContext *s = ctx->priv;
286 av_expr_free(s->expr);
288 if (s->avio_context) {
289 avio_closep(&s->avio_context);
293 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
295 AVFilterContext *ctx = inlink->dst;
296 AVFilterLink *outlink = ctx->outputs[0];
297 MetadataContext *s = ctx->priv;
298 AVDictionary **metadata = &frame->metadata;
299 AVDictionaryEntry *e;
302 return ff_filter_frame(outlink, frame);
304 e = av_dict_get(*metadata, !s->key ? "" : s->key, NULL,
305 !s->key ? AV_DICT_IGNORE_SUFFIX: 0);
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);
320 av_dict_set(metadata, s->key, s->value, 0);
322 return ff_filter_frame(outlink, frame);
323 case METADATA_MODIFY:
325 av_dict_set(metadata, s->key, s->value, 0);
327 return ff_filter_frame(outlink, frame);
330 s->print(ctx, "frame:%-4"PRId64" pts:%-7s pts_time:%s\n",
331 inlink->frame_count_out, av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base));
332 s->print(ctx, "%s=%s\n", e->key, e->value);
333 while ((e = av_dict_get(*metadata, "", e, AV_DICT_IGNORE_SUFFIX)) != NULL) {
334 s->print(ctx, "%s=%s\n", e->key, e->value);
336 } else if (e && e->value && (!s->value || (e->value && s->compare(s, e->value, s->value)))) {
337 s->print(ctx, "frame:%-4"PRId64" pts:%-7s pts_time:%s\n",
338 inlink->frame_count_out, av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base));
339 s->print(ctx, "%s=%s\n", s->key, e->value);
341 return ff_filter_frame(outlink, frame);
342 case METADATA_DELETE:
344 av_dict_free(metadata);
345 } else if (e && e->value && (!s->value || s->compare(s, e->value, s->value))) {
346 av_dict_set(metadata, s->key, NULL, 0);
348 return ff_filter_frame(outlink, frame);
353 av_frame_free(&frame);
358 #if CONFIG_AMETADATA_FILTER
360 DEFINE_OPTIONS(ametadata, AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
361 AVFILTER_DEFINE_CLASS(ametadata);
363 static const AVFilterPad ainputs[] = {
366 .type = AVMEDIA_TYPE_AUDIO,
367 .filter_frame = filter_frame,
372 static const AVFilterPad aoutputs[] = {
375 .type = AVMEDIA_TYPE_AUDIO,
380 AVFilter ff_af_ametadata = {
382 .description = NULL_IF_CONFIG_SMALL("Manipulate audio frame metadata."),
383 .priv_size = sizeof(MetadataContext),
384 .priv_class = &ametadata_class,
389 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
391 #endif /* CONFIG_AMETADATA_FILTER */
393 #if CONFIG_METADATA_FILTER
395 DEFINE_OPTIONS(metadata, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
396 AVFILTER_DEFINE_CLASS(metadata);
398 static const AVFilterPad inputs[] = {
401 .type = AVMEDIA_TYPE_VIDEO,
402 .filter_frame = filter_frame,
407 static const AVFilterPad outputs[] = {
410 .type = AVMEDIA_TYPE_VIDEO,
415 AVFilter ff_vf_metadata = {
417 .description = NULL_IF_CONFIG_SMALL("Manipulate video frame metadata."),
418 .priv_size = sizeof(MetadataContext),
419 .priv_class = &metadata_class,
424 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
426 #endif /* CONFIG_METADATA_FILTER */