FFmpeg
f_sidedata.c
Go to the documentation of this file.
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 */
SIDEDATA_NB
@ SIDEDATA_NB
Definition: f_sidedata.c:36
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
av_frame_get_side_data
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:659
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1067
ff_vf_sidedata
const FFFilter ff_vf_sidedata
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
SIDEDATA_DELETE
@ SIDEDATA_DELETE
Definition: f_sidedata.c:35
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:64
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:263
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:427
init
static av_cold int init(AVFilterContext *ctx)
Definition: f_sidedata.c:86
DEFINE_OPTIONS
#define DEFINE_OPTIONS(filt_name, FLAGS)
Definition: f_sidedata.c:47
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:220
SideDataContext::type
int type
Definition: f_sidedata.c:43
AVFilterPad
A filter pad used for either input or output.
Definition: filters.h:39
AV_OPT_FLAG_AUDIO_PARAM
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:357
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:210
av_cold
#define av_cold
Definition: attributes.h:106
FFFilter
Definition: filters.h:266
SideDataContext
Definition: f_sidedata.c:39
s
#define s(width, name)
Definition: cbs_vp9.c:198
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:201
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:41
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:49
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: filters.h:264
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:76
NULL
#define NULL
Definition: coverity.c:32
av_frame_side_data_remove
void av_frame_side_data_remove(AVFrameSideData ***sd, int *nb_sd, enum AVFrameSideDataType type)
Remove and free all side data instances of the given type from an array.
Definition: side_data.c:102
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:244
AVFILTER_DEFINE_CLASS
#define AVFILTER_DEFINE_CLASS(fname)
Definition: filters.h:477
AV_OPT_FLAG_FILTERING_PARAM
#define AV_OPT_FLAG_FILTERING_PARAM
A generic parameter which can be set by the user for filtering.
Definition: opt.h:381
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
ff_af_asidedata
const FFFilter ff_af_asidedata
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: f_sidedata.c:123
frame.h
av_frame_remove_side_data
void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
Remove and free all side data instances of the given type.
Definition: frame.c:725
SIDEDATA_SELECT
@ SIDEDATA_SELECT
Definition: f_sidedata.c:34
SideDataMode
SideDataMode
Definition: f_sidedata.c:33
AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
#define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
Some filters support a generic "enable" expression option that can be used to enable or disable a fil...
Definition: avfilter.h:197
av_frame_side_data_free
void av_frame_side_data_free(AVFrameSideData ***sd, int *nb_sd)
Free all side data entries and their contents, then zeroes out the values which the pointers are poin...
Definition: side_data.c:133
internal.h
AV_OPT_FLAG_VIDEO_PARAM
#define AV_OPT_FLAG_VIDEO_PARAM
Definition: opt.h:358
AVFilterPad::name
const char * name
Pad name.
Definition: filters.h:45
outputs
static const AVFilterPad outputs[]
Definition: af_aap.c:310
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:265
avfilter.h
AVFILTER_FLAG_METADATA_ONLY
#define AVFILTER_FLAG_METADATA_ONLY
The filter is a "metadata" filter - it does not modify the frame data in any way.
Definition: avfilter.h:183
AVFilterContext
An instance of a filter.
Definition: avfilter.h:274
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:200
FFFilter::p
AVFilter p
The public AVFilter.
Definition: filters.h:270
AVFrameSideData
Structure to hold side data for an AVFrame.
Definition: frame.h:282
av_frame_side_data_get
static const AVFrameSideData * av_frame_side_data_get(AVFrameSideData *const *sd, const int nb_sd, enum AVFrameSideDataType type)
Wrapper around av_frame_side_data_get_c() to workaround the limitation that for any type T the conver...
Definition: frame.h:1151
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
config_props
static int config_props(AVFilterLink *outlink)
Definition: f_sidedata.c:98
SideDataContext::mode
int mode
Definition: f_sidedata.c:42
Generated on Fri Dec 19 2025 19:22:48 for FFmpeg by   doxygen 1.8.17