FFmpeg
vf_addroi.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 #include "libavutil/avassert.h"
20 #include "libavutil/eval.h"
21 #include "libavutil/opt.h"
22 #include "avfilter.h"
23 #include "internal.h"
24 #include "video.h"
25 
26 enum {
27  X, Y, W, H,
29 };
30 static const char addroi_param_names[] = {
31  'x', 'y', 'w', 'h',
32 };
33 
34 enum {
38 };
39 static const char *const addroi_var_names[] = {
40  "iw",
41  "ih",
42 };
43 
44 typedef struct AddROIContext {
45  const AVClass *class;
46 
49 
52 
53  int clear;
55 
57 {
58  AVFilterContext *avctx = inlink->dst;
59  AddROIContext *ctx = avctx->priv;
60  int i;
61  double vars[NB_VARS];
62  double val;
63 
64  vars[VAR_IW] = inlink->w;
65  vars[VAR_IH] = inlink->h;
66 
67  for (i = 0; i < NB_PARAMS; i++) {
68  int max_value;
69  switch (i) {
70  case X: max_value = inlink->w; break;
71  case Y: max_value = inlink->h; break;
72  case W: max_value = inlink->w - ctx->region[X]; break;
73  case H: max_value = inlink->h - ctx->region[Y]; break;
74  }
75 
76  val = av_expr_eval(ctx->region_expr[i], vars, NULL);
77  if (val < 0.0) {
78  av_log(avctx, AV_LOG_WARNING, "Calculated value %g for %c is "
79  "less than zero - using zero instead.\n", val,
81  val = 0.0;
82  } else if (val > max_value) {
83  av_log(avctx, AV_LOG_WARNING, "Calculated value %g for %c is "
84  "greater than maximum allowed value %d - "
85  "using %d instead.\n", val, addroi_param_names[i],
86  max_value, max_value);
87  val = max_value;
88  }
89  ctx->region[i] = val;
90  }
91 
92  return 0;
93 }
94 
96 {
97  AVFilterContext *avctx = inlink->dst;
98  AVFilterLink *outlink = avctx->outputs[0];
99  AddROIContext *ctx = avctx->priv;
100  AVRegionOfInterest *roi;
101  AVFrameSideData *sd;
102  int err;
103 
104  if (ctx->clear) {
106  sd = NULL;
107  } else {
109  }
110  if (sd) {
111  const AVRegionOfInterest *old_roi;
112  uint32_t old_roi_size;
113  AVBufferRef *roi_ref;
114  int nb_roi, i;
115 
116  old_roi = (const AVRegionOfInterest*)sd->data;
117  old_roi_size = old_roi->self_size;
118  av_assert0(old_roi_size && sd->size % old_roi_size == 0);
119  nb_roi = sd->size / old_roi_size + 1;
120 
121  roi_ref = av_buffer_alloc(sizeof(*roi) * nb_roi);
122  if (!roi_ref) {
123  err = AVERROR(ENOMEM);
124  goto fail;
125  }
126  roi = (AVRegionOfInterest*)roi_ref->data;
127 
128  for (i = 0; i < nb_roi - 1; i++) {
129  old_roi = (const AVRegionOfInterest*)
130  (sd->data + old_roi_size * i);
131 
132  roi[i] = (AVRegionOfInterest) {
133  .self_size = sizeof(*roi),
134  .top = old_roi->top,
135  .bottom = old_roi->bottom,
136  .left = old_roi->left,
137  .right = old_roi->right,
138  .qoffset = old_roi->qoffset,
139  };
140  }
141 
142  roi[nb_roi - 1] = (AVRegionOfInterest) {
143  .self_size = sizeof(*roi),
144  .top = ctx->region[Y],
145  .bottom = ctx->region[Y] + ctx->region[H],
146  .left = ctx->region[X],
147  .right = ctx->region[X] + ctx->region[W],
148  .qoffset = ctx->qoffset,
149  };
150 
152 
155  roi_ref);
156  if (!sd) {
157  av_buffer_unref(&roi_ref);
158  err = AVERROR(ENOMEM);
159  goto fail;
160  }
161 
162  } else {
164  sizeof(AVRegionOfInterest));
165  if (!sd) {
166  err = AVERROR(ENOMEM);
167  goto fail;
168  }
169  roi = (AVRegionOfInterest*)sd->data;
170  *roi = (AVRegionOfInterest) {
171  .self_size = sizeof(*roi),
172  .top = ctx->region[Y],
173  .bottom = ctx->region[Y] + ctx->region[H],
174  .left = ctx->region[X],
175  .right = ctx->region[X] + ctx->region[W],
176  .qoffset = ctx->qoffset,
177  };
178  }
179 
180  return ff_filter_frame(outlink, frame);
181 
182 fail:
184  return err;
185 }
186 
188 {
189  AddROIContext *ctx = avctx->priv;
190  int i, err;
191 
192  for (i = 0; i < NB_PARAMS; i++) {
193  err = av_expr_parse(&ctx->region_expr[i], ctx->region_str[i],
195  0, avctx);
196  if (err < 0) {
198  "Error parsing %c expression '%s'.\n",
199  addroi_param_names[i], ctx->region_str[i]);
200  return err;
201  }
202  }
203 
204  return 0;
205 }
206 
208 {
209  AddROIContext *ctx = avctx->priv;
210  int i;
211 
212  for (i = 0; i < NB_PARAMS; i++) {
213  av_expr_free(ctx->region_expr[i]);
214  ctx->region_expr[i] = NULL;
215  }
216 }
217 
218 #define OFFSET(x) offsetof(AddROIContext, x)
219 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
220 static const AVOption addroi_options[] = {
221  { "x", "Region distance from left edge of frame.",
222  OFFSET(region_str[X]), AV_OPT_TYPE_STRING, { .str = "0" }, .flags = FLAGS },
223  { "y", "Region distance from top edge of frame.",
224  OFFSET(region_str[Y]), AV_OPT_TYPE_STRING, { .str = "0" }, .flags = FLAGS },
225  { "w", "Region width.",
226  OFFSET(region_str[W]), AV_OPT_TYPE_STRING, { .str = "0" }, .flags = FLAGS },
227  { "h", "Region height.",
228  OFFSET(region_str[H]), AV_OPT_TYPE_STRING, { .str = "0" }, .flags = FLAGS },
229 
230  { "qoffset", "Quantisation offset to apply in the region.",
231  OFFSET(qoffset), AV_OPT_TYPE_RATIONAL, { .dbl = -0.1 }, -1, +1, FLAGS },
232 
233  { "clear", "Remove any existing regions of interest before adding the new one.",
234  OFFSET(clear), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
235 
236  { NULL }
237 };
238 
239 AVFILTER_DEFINE_CLASS(addroi);
240 
241 static const AVFilterPad addroi_inputs[] = {
242  {
243  .name = "default",
244  .type = AVMEDIA_TYPE_VIDEO,
245  .config_props = addroi_config_input,
246  .filter_frame = addroi_filter_frame,
247  },
248 };
249 
251  .name = "addroi",
252  .description = NULL_IF_CONFIG_SMALL("Add region of interest to frame."),
253  .init = addroi_init,
254  .uninit = addroi_uninit,
255 
256  .priv_size = sizeof(AddROIContext),
257  .priv_class = &addroi_class,
258 
260 
263 };
VAR_IW
@ VAR_IW
Definition: vf_addroi.c:35
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
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
FLAGS
#define FLAGS
Definition: vf_addroi.c:219
av_frame_get_side_data
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:947
av_frame_new_side_data
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, size_t size)
Add a new side data to a frame.
Definition: frame.c:795
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1015
AVBufferRef::data
uint8_t * data
The data buffer.
Definition: buffer.h:90
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
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:160
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:375
AVOption
AVOption.
Definition: opt.h:346
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
ff_vf_addroi
const AVFilter ff_vf_addroi
Definition: vf_addroi.c:250
AV_OPT_TYPE_RATIONAL
@ AV_OPT_TYPE_RATIONAL
Definition: opt.h:240
video.h
AddROIContext::region_str
char * region_str[NB_PARAMS]
Definition: vf_addroi.c:47
av_expr_parse
int av_expr_parse(AVExpr **expr, const char *s, const char *const *const_names, const char *const *func1_names, double(*const *funcs1)(void *, double), const char *const *func2_names, double(*const *funcs2)(void *, double, double), int log_offset, void *log_ctx)
Parse an expression.
Definition: eval.c:710
AVFilterContext::priv
void * priv
private data for use by the filter
Definition: avfilter.h:422
fail
#define fail()
Definition: checkasm.h:179
AddROIContext::clear
int clear
Definition: vf_addroi.c:53
OFFSET
#define OFFSET(x)
Definition: vf_addroi.c:218
val
static double val(void *priv, double ch)
Definition: aeval.c:78
av_expr_free
void av_expr_free(AVExpr *e)
Free a parsed expression previously created with av_expr_parse().
Definition: eval.c:358
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
AVFrameSideData::size
size_t size
Definition: frame.h:253
av_cold
#define av_cold
Definition: attributes.h:90
AVRegionOfInterest
Structure describing a single Region Of Interest.
Definition: frame.h:300
ff_video_default_filterpad
const AVFilterPad ff_video_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_VIDEO.
Definition: video.c:37
addroi_param_names
static const char addroi_param_names[]
Definition: vf_addroi.c:30
AVRegionOfInterest::bottom
int bottom
Definition: frame.h:316
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:40
ctx
AVFormatContext * ctx
Definition: movenc.c:49
av_expr_eval
double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
Evaluate a previously parsed expression.
Definition: eval.c:792
AVExpr
Definition: eval.c:158
addroi_init
static av_cold int addroi_init(AVFilterContext *avctx)
Definition: vf_addroi.c:187
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
av_buffer_unref
void av_buffer_unref(AVBufferRef **buf)
Free a given reference and automatically free the buffer if there are no more references to it.
Definition: buffer.c:139
vars
static const uint8_t vars[2][12]
Definition: camellia.c:183
NB_VARS
@ NB_VARS
Definition: vf_addroi.c:37
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVRegionOfInterest::self_size
uint32_t self_size
Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
Definition: frame.h:305
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(addroi)
av_frame_new_side_data_from_buf
AVFrameSideData * av_frame_new_side_data_from_buf(AVFrame *frame, enum AVFrameSideDataType type, AVBufferRef *buf)
Add a new side data to a frame from an existing AVBufferRef.
Definition: frame.c:786
eval.h
addroi_options
static const AVOption addroi_options[]
Definition: vf_addroi.c:220
Y
@ Y
Definition: vf_addroi.c:27
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
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
AddROIContext::region
int region[NB_PARAMS]
Definition: vf_addroi.c:50
AVFrameSideData::data
uint8_t * data
Definition: frame.h:252
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:1013
NB_PARAMS
@ NB_PARAMS
Definition: vf_addroi.c:28
av_buffer_alloc
AVBufferRef * av_buffer_alloc(size_t size)
Allocate an AVBuffer of the given size using av_malloc().
Definition: buffer.c:77
addroi_config_input
static int addroi_config_input(AVFilterLink *inlink)
Definition: vf_addroi.c:56
AVRegionOfInterest::right
int right
Definition: frame.h:318
internal.h
AVRegionOfInterest::left
int left
Definition: frame.h:317
X
@ X
Definition: vf_addroi.c:27
addroi_inputs
static const AVFilterPad addroi_inputs[]
Definition: vf_addroi.c:241
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AVRegionOfInterest::top
int top
Distance in pixels from the top edge of the frame to the top and bottom edges and from the left edge ...
Definition: frame.h:315
addroi_filter_frame
static int addroi_filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: vf_addroi.c:95
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
AVFilter
Filter definition.
Definition: avfilter.h:166
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:264
AddROIContext
Definition: vf_addroi.c:44
VAR_IH
@ VAR_IH
Definition: vf_addroi.c:36
addroi_uninit
static av_cold void addroi_uninit(AVFilterContext *avctx)
Definition: vf_addroi.c:207
avfilter.h
W
@ W
Definition: vf_addroi.c:27
H
@ H
Definition: vf_addroi.c:27
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:133
AddROIContext::region_expr
AVExpr * region_expr[NB_PARAMS]
Definition: vf_addroi.c:48
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
AVFrameSideData
Structure to hold side data for an AVFrame.
Definition: frame.h:250
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:251
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
AV_FRAME_DATA_REGIONS_OF_INTEREST
@ AV_FRAME_DATA_REGIONS_OF_INTEREST
Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is ...
Definition: frame.h:165
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:474
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:239
AddROIContext::qoffset
AVRational qoffset
Definition: vf_addroi.c:51
AVRegionOfInterest::qoffset
AVRational qoffset
Quantisation offset.
Definition: frame.h:342
addroi_var_names
static const char *const addroi_var_names[]
Definition: vf_addroi.c:39
AVFilterContext::outputs
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:419