FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 "libavutil/avassert.h"
25 #include "libavutil/internal.h"
26 #include "libavutil/frame.h"
27 #include "libavutil/opt.h"
28 #include "avfilter.h"
29 #include "formats.h"
30 #include "internal.h"
31 
36 };
37 
38 typedef struct SideDataContext {
39  const AVClass *class;
40 
41  int mode;
44 
45 #define OFFSET(x) offsetof(SideDataContext, x)
46 #define DEFINE_OPTIONS(filt_name, FLAGS) \
47 static const AVOption filt_name##_options[] = { \
48  { "mode", "set a mode of operation", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, SIDEDATA_NB-1, FLAGS, "mode" }, \
49  { "select", "select frame", 0, AV_OPT_TYPE_CONST, {.i64 = SIDEDATA_SELECT }, 0, 0, FLAGS, "mode" }, \
50  { "delete", "delete side data", 0, AV_OPT_TYPE_CONST, {.i64 = SIDEDATA_DELETE }, 0, 0, FLAGS, "mode" }, \
51  { "type", "set side data type", OFFSET(type), AV_OPT_TYPE_INT, {.i64 = -1 }, -1, INT_MAX, FLAGS, "type" }, \
52  { "PANSCAN", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_PANSCAN }, 0, 0, FLAGS, "type" }, \
53  { "A53_CC", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_A53_CC }, 0, 0, FLAGS, "type" }, \
54  { "STEREO3D", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_STEREO3D }, 0, 0, FLAGS, "type" }, \
55  { "MATRIXENCODING", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_MATRIXENCODING }, 0, 0, FLAGS, "type" }, \
56  { "DOWNMIX_INFO", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DOWNMIX_INFO }, 0, 0, FLAGS, "type" }, \
57  { "REPLAYGAIN", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_REPLAYGAIN }, 0, 0, FLAGS, "type" }, \
58  { "DISPLAYMATRIX", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_DISPLAYMATRIX }, 0, 0, FLAGS, "type" }, \
59  { "AFD", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_AFD }, 0, 0, FLAGS, "type" }, \
60  { "MOTION_VECTORS", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_MOTION_VECTORS }, 0, 0, FLAGS, "type" }, \
61  { "SKIP_SAMPLES", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_SKIP_SAMPLES }, 0, 0, FLAGS, "type" }, \
62  { "AUDIO_SERVICE_TYPE", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_AUDIO_SERVICE_TYPE }, 0, 0, FLAGS, "type" }, \
63  { "MASTERING_DISPLAY_METADATA", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_MASTERING_DISPLAY_METADATA }, 0, 0, FLAGS, "type" }, \
64  { "GOP_TIMECODE", "", 0, AV_OPT_TYPE_CONST, {.i64 = AV_FRAME_DATA_GOP_TIMECODE }, 0, 0, FLAGS, "type" }, \
65  { NULL } \
66 }
67 
69 {
70  SideDataContext *s = ctx->priv;
71 
72  if (s->type == -1 && s->mode != SIDEDATA_DELETE) {
73  av_log(ctx, AV_LOG_ERROR, "Side data type must be set\n");
74  return AVERROR(EINVAL);
75  }
76 
77  return 0;
78 }
79 
80 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
81 {
82  AVFilterContext *ctx = inlink->dst;
83  AVFilterLink *outlink = ctx->outputs[0];
84  SideDataContext *s = ctx->priv;
85  AVFrameSideData *sd = NULL;
86 
87  if (s->type != -1)
88  sd = av_frame_get_side_data(frame, s->type);
89 
90  switch (s->mode) {
91  case SIDEDATA_SELECT:
92  if (sd) {
93  return ff_filter_frame(outlink, frame);
94  }
95  break;
96  case SIDEDATA_DELETE:
97  if (s->type == -1) {
98  while (frame->nb_side_data)
99  av_frame_remove_side_data(frame, frame->side_data[0]->type);
100  } else if (sd) {
101  av_frame_remove_side_data(frame, s->type);
102  }
103  return ff_filter_frame(outlink, frame);
104  break;
105  default:
106  av_assert0(0);
107  };
108 
109  av_frame_free(&frame);
110 
111  return 0;
112 }
113 
114 #if CONFIG_ASIDEDATA_FILTER
115 
117 AVFILTER_DEFINE_CLASS(asidedata);
118 
119 static const AVFilterPad ainputs[] = {
120  {
121  .name = "default",
122  .type = AVMEDIA_TYPE_AUDIO,
123  .filter_frame = filter_frame,
124  },
125  { NULL }
126 };
127 
128 static const AVFilterPad aoutputs[] = {
129  {
130  .name = "default",
131  .type = AVMEDIA_TYPE_AUDIO,
132  },
133  { NULL }
134 };
135 
137  .name = "asidedata",
138  .description = NULL_IF_CONFIG_SMALL("Manipulate audio frame side data."),
139  .priv_size = sizeof(SideDataContext),
140  .priv_class = &asidedata_class,
141  .init = init,
142  .inputs = ainputs,
143  .outputs = aoutputs,
145 };
146 #endif /* CONFIG_ASIDEDATA_FILTER */
147 
148 #if CONFIG_SIDEDATA_FILTER
149 
151 AVFILTER_DEFINE_CLASS(sidedata);
152 
153 static const AVFilterPad inputs[] = {
154  {
155  .name = "default",
156  .type = AVMEDIA_TYPE_VIDEO,
157  .filter_frame = filter_frame,
158  },
159  { NULL }
160 };
161 
162 static const AVFilterPad outputs[] = {
163  {
164  .name = "default",
165  .type = AVMEDIA_TYPE_VIDEO,
166  },
167  { NULL }
168 };
169 
171  .name = "sidedata",
172  .description = NULL_IF_CONFIG_SMALL("Manipulate video frame side data."),
173  .priv_size = sizeof(SideDataContext),
174  .priv_class = &sidedata_class,
175  .init = init,
176  .inputs = inputs,
177  .outputs = outputs,
179 };
180 #endif /* CONFIG_SIDEDATA_FILTER */
#define NULL
Definition: coverity.c:32
This structure describes decoded (raw) audio or video data.
Definition: frame.h:226
Main libavfilter public API header.
#define DEFINE_OPTIONS(filt_name, FLAGS)
Definition: f_sidedata.c:46
AVFilter ff_vf_sidedata
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:278
AVFilter ff_af_asidedata
static av_cold int init(AVFilterContext *ctx)
Definition: f_sidedata.c:68
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:734
#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:125
const char * name
Pad name.
Definition: internal.h:60
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1080
#define av_cold
Definition: attributes.h:82
AVOptions.
static AVFrame * frame
Structure to hold side data for an AVFrame.
Definition: frame.h:188
int nb_side_data
Definition: frame.h:439
AVFrameSideData ** side_data
Definition: frame.h:438
#define av_log(a,...)
A filter pad used for either input or output.
Definition: internal.h:54
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AV_OPT_FLAG_FILTERING_PARAM
a generic parameter which can be set by the user for filtering
Definition: opt.h:291
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
void * priv
private data for use by the filter
Definition: avfilter.h:353
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: f_sidedata.c:80
simple assert() macros that are a bit more flexible than ISO C assert().
reference-counted frame API
common internal API header
AVFormatContext * ctx
Definition: movenc.c:48
AVFrameSideDataType
Definition: frame.h:48
#define s(width, name)
Definition: cbs_vp9.c:257
static const AVFilterPad inputs[]
Definition: af_acontrast.c:193
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
#define AV_OPT_FLAG_VIDEO_PARAM
Definition: opt.h:279
void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
If side data of the supplied type exists in the frame, free it and remove it from the frame...
Definition: frame.c:805
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
const char * name
Filter name.
Definition: avfilter.h:148
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
enum AVFrameSideDataType type
Definition: frame.h:189
#define flags(name, subs,...)
Definition: cbs_av1.c:596
#define AVFILTER_DEFINE_CLASS(fname)
Definition: internal.h:334
enum AVFrameSideDataType type
Definition: f_sidedata.c:42
An instance of a filter.
Definition: avfilter.h:338
SideDataMode
Definition: f_sidedata.c:32
internal API functions