FFmpeg coverage

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