FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavfilter/f_sidedata.c
Date: 2026-04-24 19:58:39
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 { NULL } \
84 }
85
86 ✗ static av_cold int init(AVFilterContext *ctx)
87 {
88 ✗ SideDataContext *s = ctx->priv;
89
90 ✗ if (s->type == -1 && s->mode != SIDEDATA_DELETE) {
91 ✗ av_log(ctx, AV_LOG_ERROR, "Side data type must be set\n");
92 ✗ return AVERROR(EINVAL);
93 }
94
95 ✗ return 0;
96 }
97
98 ✗ static int config_props(AVFilterLink *outlink)
99 {
100 ✗ AVFilterContext *ctx = outlink->src;
101 ✗ SideDataContext *s = ctx->priv;
102 ✗ const AVFrameSideData *sd = NULL;
103
104 ✗ if (s->type != -1)
105 ✗ sd = av_frame_side_data_get(outlink->side_data, outlink->nb_side_data, s->type);
106
107 ✗ switch (s->mode) {
108 ✗ case SIDEDATA_SELECT:
109 ✗ break;
110 ✗ case SIDEDATA_DELETE:
111 ✗ if (s->type == -1)
112 ✗ av_frame_side_data_free(&outlink->side_data, &outlink->nb_side_data);
113 ✗ else if (sd)
114 ✗ av_frame_side_data_remove(&outlink->side_data, &outlink->nb_side_data, s->type);
115 ✗ break;
116 ✗ default:
117 ✗ av_assert0(0);
118 };
119
120 ✗ return 0;
121 }
122
123 ✗ static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
124 {
125 ✗ AVFilterContext *ctx = inlink->dst;
126 ✗ AVFilterLink *outlink = ctx->outputs[0];
127 ✗ SideDataContext *s = ctx->priv;
128 ✗ AVFrameSideData *sd = NULL;
129
130 ✗ if (s->type != -1)
131 ✗ sd = av_frame_get_side_data(frame, s->type);
132
133 ✗ switch (s->mode) {
134 ✗ case SIDEDATA_SELECT:
135 ✗ if (sd) {
136 ✗ return ff_filter_frame(outlink, frame);
137 }
138 ✗ break;
139 ✗ case SIDEDATA_DELETE:
140 ✗ if (s->type == -1) {
141 ✗ while (frame->nb_side_data)
142 ✗ av_frame_remove_side_data(frame, frame->side_data[0]->type);
143 ✗ } else if (sd) {
144 ✗ av_frame_remove_side_data(frame, s->type);
145 }
146 ✗ return ff_filter_frame(outlink, frame);
147 break;
148 ✗ default:
149 ✗ av_assert0(0);
150 };
151
152 ✗ av_frame_free(&frame);
153
154 ✗ return 0;
155 }
156
157 #if CONFIG_ASIDEDATA_FILTER
158
159 DEFINE_OPTIONS(asidedata, AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
160 AVFILTER_DEFINE_CLASS(asidedata);
161
162 static const AVFilterPad ainputs[] = {
163 {
164 .name = "default",
165 .type = AVMEDIA_TYPE_AUDIO,
166 .filter_frame = filter_frame,
167 },
168 };
169
170 static const AVFilterPad aoutputs[] = {
171 {
172 .name = "default",
173 .type = AVMEDIA_TYPE_AUDIO,
174 .config_props = config_props,
175 },
176 };
177
178 const FFFilter ff_af_asidedata = {
179 .p.name = "asidedata",
180 .p.description = NULL_IF_CONFIG_SMALL("Manipulate audio frame side data."),
181 .p.priv_class = &asidedata_class,
182 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
183 AVFILTER_FLAG_METADATA_ONLY,
184 .priv_size = sizeof(SideDataContext),
185 .init = init,
186 FILTER_INPUTS(ainputs),
187 FILTER_OUTPUTS(aoutputs),
188 };
189 #endif /* CONFIG_ASIDEDATA_FILTER */
190
191 #if CONFIG_SIDEDATA_FILTER
192
193 DEFINE_OPTIONS(sidedata, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
194 AVFILTER_DEFINE_CLASS(sidedata);
195
196 static const AVFilterPad inputs[] = {
197 {
198 .name = "default",
199 .type = AVMEDIA_TYPE_VIDEO,
200 .filter_frame = filter_frame,
201 },
202 };
203
204 static const AVFilterPad outputs[] = {
205 {
206 .name = "default",
207 .type = AVMEDIA_TYPE_VIDEO,
208 .config_props = config_props,
209 },
210 };
211
212 const FFFilter ff_vf_sidedata = {
213 .p.name = "sidedata",
214 .p.description = NULL_IF_CONFIG_SMALL("Manipulate video frame side data."),
215 .p.priv_class = &sidedata_class,
216 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
217 AVFILTER_FLAG_METADATA_ONLY,
218 .priv_size = sizeof(SideDataContext),
219 .init = init,
220 FILTER_INPUTS(inputs),
221 FILTER_OUTPUTS(outputs),
222 };
223 #endif /* CONFIG_SIDEDATA_FILTER */
224