FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavfilter/f_sidedata.c
Date: 2026-10-29 17:07:12
Exec Total Coverage
Lines: 0 47 0.0%
Functions: 0 3 0.0%
Branches: 0 26 0.0%
Line Branch Exec Source
1 /*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 /**
20 * @file
21 * filter for manipulating frame side data
22 */
23
24 #include "config_components.h"
25
26 #include "libavutil/avassert.h"
27 #include "libavutil/internal.h"
28 #include "libavutil/frame.h"
29 #include "libavutil/opt.h"
30 #include "avfilter.h"
31 #include "filters.h"
32
33 enum SideDataMode {
34 SIDEDATA_SELECT,
35 SIDEDATA_DELETE,
36 SIDEDATA_NB
37 };
38
39 typedef struct SideDataContext {
40 const AVClass *class;
41
42 int mode;
43 int type; // enum AVFrameSideDataType or -1 for delete side data mode
44 } SideDataContext;
45
46 #define OFFSET(x) offsetof(SideDataContext, x)
47 #define DEFINE_OPTIONS(filt_name, FLAGS) \
48 static const AVOption filt_name##_options[] = { \
49 { "mode", "set a mode of operation", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, SIDEDATA_NB-1, FLAGS, .unit = "mode" }, \
50 { "select", "select frame", 0, AV_OPT_TYPE_CONST, {.i64 = SIDEDATA_SELECT }, 0, 0, FLAGS, .unit = "mode" }, \
51 { "delete", "delete side data", 0, AV_OPT_TYPE_CONST, {.i64 = SIDEDATA_DELETE }, 0, 0, FLAGS, .unit = "mode" }, \
52 { "type", "set side data type", OFFSET(type), AV_OPT_TYPE_INT, {.i64 = -1 }, -1, INT_MAX, FLAGS, .unit = "type" }, \
53 { "PANSCAN", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_PANSCAN }, 0, 0, FLAGS, .unit = "type" }, \
54 { "A53_CC", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_A53_CC }, 0, 0, FLAGS, .unit = "type" }, \
55 { "STEREO3D", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_STEREO3D }, 0, 0, FLAGS, .unit = "type" }, \
56 { "MATRIXENCODING", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_MATRIXENCODING }, 0, 0, FLAGS, .unit = "type" }, \
57 { "DOWNMIX_INFO", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DOWNMIX_INFO }, 0, 0, FLAGS, .unit = "type" }, \
58 { "REPLAYGAIN", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_REPLAYGAIN }, 0, 0, FLAGS, .unit = "type" }, \
59 { "DISPLAYMATRIX", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DISPLAYMATRIX }, 0, 0, FLAGS, .unit = "type" }, \
60 { "AFD", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_AFD }, 0, 0, FLAGS, .unit = "type" }, \
61 { "MOTION_VECTORS", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_MOTION_VECTORS }, 0, 0, FLAGS, .unit = "type" }, \
62 { "SKIP_SAMPLES", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_SKIP_SAMPLES }, 0, 0, FLAGS, .unit = "type" }, \
63 { "AUDIO_SERVICE_TYPE", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_AUDIO_SERVICE_TYPE }, 0, 0, FLAGS, .unit = "type" }, \
64 { "MASTERING_DISPLAY_METADATA", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_MASTERING_DISPLAY_METADATA }, 0, 0, FLAGS, .unit = "type" }, \
65 { "GOP_TIMECODE", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_GOP_TIMECODE }, 0, 0, FLAGS, .unit = "type" }, \
66 { "SPHERICAL", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_SPHERICAL }, 0, 0, FLAGS, .unit = "type" }, \
67 { "CONTENT_LIGHT_LEVEL", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_CONTENT_LIGHT_LEVEL }, 0, 0, FLAGS, .unit = "type" }, \
68 { "ICC_PROFILE", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_ICC_PROFILE }, 0, 0, FLAGS, .unit = "type" }, \
69 { "S12M_TIMECOD", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_S12M_TIMECODE }, 0, 0, FLAGS | AV_OPT_FLAG_DEPRECATED, .unit = "type" }, \
70 { "S12M_TIMECODE", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_S12M_TIMECODE }, 0, 0, FLAGS, .unit = "type" }, \
71 { "DYNAMIC_HDR_PLUS", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DYNAMIC_HDR_PLUS }, 0, 0, FLAGS, .unit = "type" }, \
72 { "REGIONS_OF_INTEREST", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_REGIONS_OF_INTEREST }, 0, 0, FLAGS, .unit = "type" }, \
73 { "VIDEO_ENC_PARAMS", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_VIDEO_ENC_PARAMS }, 0, 0, FLAGS, .unit = "type" }, \
74 { "SEI_UNREGISTERED", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_SEI_UNREGISTERED }, 0, 0, FLAGS, .unit = "type" }, \
75 { "FILM_GRAIN_PARAMS", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_FILM_GRAIN_PARAMS }, 0, 0, FLAGS, .unit = "type" }, \
76 { "DETECTION_BOUNDING_BOXES", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DETECTION_BBOXES }, 0, 0, FLAGS, .unit = "type" }, \
77 { "DETECTION_BBOXES", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DETECTION_BBOXES }, 0, 0, FLAGS, .unit = "type" }, \
78 { "DOVI_RPU_BUFFER", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DOVI_RPU_BUFFER }, 0, 0, FLAGS, .unit = "type" }, \
79 { "DOVI_METADATA", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DOVI_METADATA }, 0, 0, FLAGS, .unit = "type" }, \
80 { "DYNAMIC_HDR_VIVID", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DYNAMIC_HDR_VIVID }, 0, 0, FLAGS, .unit = "type" }, \
81 { "AMBIENT_VIEWING_ENVIRONMENT","", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_AMBIENT_VIEWING_ENVIRONMENT}, 0, 0, FLAGS, .unit = "type" }, \
82 { "VIDEO_HINT", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_VIDEO_HINT }, 0, 0, FLAGS, .unit = "type" }, \
83 { "GAIN_MAP_PARAMS", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_GAIN_MAP_PARAMS }, 0, 0, FLAGS, .unit = "type" }, \
84 { NULL } \
85 }
86
87 ✗ static av_cold int init(AVFilterContext *ctx)
88 {
89 ✗ SideDataContext *s = ctx->priv;
90
91 ✗ if (s->type == -1 && s->mode != SIDEDATA_DELETE) {
92 ✗ av_log(ctx, AV_LOG_ERROR, "Side data type must be set\n");
93 ✗ return AVERROR(EINVAL);
94 }
95
96 ✗ return 0;
97 }
98
99 ✗ static int config_props(AVFilterLink *outlink)
100 {
101 ✗ AVFilterContext *ctx = outlink->src;
102 ✗ SideDataContext *s = ctx->priv;
103 ✗ const AVFrameSideData *sd = NULL;
104
105 ✗ if (s->type != -1)
106 ✗ sd = av_frame_side_data_get(outlink->side_data, outlink->nb_side_data, s->type);
107
108 ✗ switch (s->mode) {
109 ✗ case SIDEDATA_SELECT:
110 ✗ break;
111 ✗ case SIDEDATA_DELETE:
112 ✗ if (s->type == -1)
113 ✗ av_frame_side_data_free(&outlink->side_data, &outlink->nb_side_data);
114 ✗ else if (sd)
115 ✗ av_frame_side_data_remove(&outlink->side_data, &outlink->nb_side_data, s->type);
116 ✗ break;
117 ✗ default:
118 ✗ av_assert0(0);
119 };
120
121 ✗ return 0;
122 }
123
124 ✗ static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
125 {
126 ✗ AVFilterContext *ctx = inlink->dst;
127 ✗ AVFilterLink *outlink = ctx->outputs[0];
128 ✗ SideDataContext *s = ctx->priv;
129 ✗ AVFrameSideData *sd = NULL;
130
131 ✗ if (s->type != -1)
132 ✗ sd = av_frame_get_side_data(frame, s->type);
133
134 ✗ switch (s->mode) {
135 ✗ case SIDEDATA_SELECT:
136 ✗ if (sd) {
137 ✗ return ff_filter_frame(outlink, frame);
138 }
139 ✗ break;
140 ✗ case SIDEDATA_DELETE:
141 ✗ if (s->type == -1) {
142 ✗ while (frame->nb_side_data)
143 ✗ av_frame_remove_side_data(frame, frame->side_data[0]->type);
144 ✗ } else if (sd) {
145 ✗ av_frame_remove_side_data(frame, s->type);
146 }
147 ✗ return ff_filter_frame(outlink, frame);
148 break;
149 ✗ default:
150 ✗ av_assert0(0);
151 };
152
153 ✗ av_frame_free(&frame);
154
155 ✗ return 0;
156 }
157
158 #if CONFIG_ASIDEDATA_FILTER
159
160 DEFINE_OPTIONS(asidedata, AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
161 AVFILTER_DEFINE_CLASS(asidedata);
162
163 static const AVFilterPad ainputs[] = {
164 {
165 .name = "default",
166 .type = AVMEDIA_TYPE_AUDIO,
167 .filter_frame = filter_frame,
168 },
169 };
170
171 static const AVFilterPad aoutputs[] = {
172 {
173 .name = "default",
174 .type = AVMEDIA_TYPE_AUDIO,
175 .config_props = config_props,
176 },
177 };
178
179 const FFFilter ff_af_asidedata = {
180 .p.name = "asidedata",
181 .p.description = NULL_IF_CONFIG_SMALL("Manipulate audio frame side data."),
182 .p.priv_class = &asidedata_class,
183 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
184 AVFILTER_FLAG_METADATA_ONLY,
185 .priv_size = sizeof(SideDataContext),
186 .init = init,
187 FILTER_INPUTS(ainputs),
188 FILTER_OUTPUTS(aoutputs),
189 };
190 #endif /* CONFIG_ASIDEDATA_FILTER */
191
192 #if CONFIG_SIDEDATA_FILTER
193
194 DEFINE_OPTIONS(sidedata, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
195 AVFILTER_DEFINE_CLASS(sidedata);
196
197 static const AVFilterPad inputs[] = {
198 {
199 .name = "default",
200 .type = AVMEDIA_TYPE_VIDEO,
201 .filter_frame = filter_frame,
202 },
203 };
204
205 static const AVFilterPad outputs[] = {
206 {
207 .name = "default",
208 .type = AVMEDIA_TYPE_VIDEO,
209 .config_props = config_props,
210 },
211 };
212
213 const FFFilter ff_vf_sidedata = {
214 .p.name = "sidedata",
215 .p.description = NULL_IF_CONFIG_SMALL("Manipulate video frame side data."),
216 .p.priv_class = &sidedata_class,
217 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
218 AVFILTER_FLAG_METADATA_ONLY,
219 .priv_size = sizeof(SideDataContext),
220 .init = init,
221 FILTER_INPUTS(inputs),
222 FILTER_OUTPUTS(outputs),
223 .flags_internal = FF_FILTER_FLAG_DYNAMIC_FRAME_PARAMS,
224 };
225 #endif /* CONFIG_SIDEDATA_FILTER */
226