FFmpeg
vf_cover_rect.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2015 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20 
21 /**
22  * @todo switch to dualinput
23  */
24 
25 #include "libavutil/imgutils.h"
26 #include "libavutil/opt.h"
27 #include "internal.h"
28 
29 #include "lavfutils.h"
30 
31 enum mode {
35 };
36 
37 typedef struct CoverContext {
38  AVClass *class;
39  int mode;
42  int width, height;
43 } CoverContext;
44 
45 #define OFFSET(x) offsetof(CoverContext, x)
46 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
47 static const AVOption cover_rect_options[] = {
48  { "cover", "cover bitmap filename", OFFSET(cover_filename), AV_OPT_TYPE_STRING, {.str = NULL}, .flags = FLAGS },
49  { "mode", "set removal mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = MODE_BLUR}, 0, NB_MODES - 1, FLAGS, "mode" },
50  { "cover", "cover area with bitmap", 0, AV_OPT_TYPE_CONST, {.i64 = MODE_COVER}, INT_MIN, INT_MAX, FLAGS, "mode" },
51  { "blur", "blur area", 0, AV_OPT_TYPE_CONST, {.i64 = MODE_BLUR}, INT_MIN, INT_MAX, FLAGS, "mode" },
52  { NULL }
53 };
54 
56 
58 {
59  return 0;
60 }
61 
62 static void cover_rect(CoverContext *cover, AVFrame *in, int offx, int offy)
63 {
64  int x, y, p;
65 
66  for (p = 0; p < 3; p++) {
67  uint8_t *data = in->data[p] + (offx>>!!p) + (offy>>!!p) * in->linesize[p];
68  const uint8_t *src = cover->cover_frame->data[p];
69  int w = AV_CEIL_RSHIFT(cover->cover_frame->width , !!p);
70  int h = AV_CEIL_RSHIFT(cover->cover_frame->height, !!p);
71  for (y = 0; y < h; y++) {
72  for (x = 0; x < w; x++) {
73  data[x] = src[x];
74  }
75  data += in->linesize[p];
76  src += cover->cover_frame->linesize[p];
77  }
78  }
79 }
80 static void blur(CoverContext *cover, AVFrame *in, int offx, int offy)
81 {
82  int x, y, p;
83 
84  for (p=0; p<3; p++) {
85  int ox = offx>>!!p;
86  int oy = offy>>!!p;
87  int stride = in->linesize[p];
88  uint8_t *data = in->data[p] + ox + oy * stride;
89  int w = AV_CEIL_RSHIFT(cover->width , !!p);
90  int h = AV_CEIL_RSHIFT(cover->height, !!p);
91  int iw = AV_CEIL_RSHIFT(in->width , !!p);
92  int ih = AV_CEIL_RSHIFT(in->height, !!p);
93  for (y = 0; y < h; y++) {
94  for (x = 0; x < w; x++) {
95  int c = 0;
96  int s = 0;
97  if (ox) {
98  int scale = 65536 / (x + 1);
99  s += data[-1 + y*stride] * scale;
100  c += scale;
101  }
102  if (oy) {
103  int scale = 65536 / (y + 1);
104  s += data[x - stride] * scale;
105  c += scale;
106  }
107  if (ox + w < iw) {
108  int scale = 65536 / (w - x);
109  s += data[w + y*stride] * scale;
110  c += scale;
111  }
112  if (oy + h < ih) {
113  int scale = 65536 / (h - y);
114  s += data[x + h*stride] * scale;
115  c += scale;
116  }
117  data[x + y*stride] = c ? (s + (c>>1)) / c : 0;
118  }
119  }
120  }
121 }
122 
124 {
125  AVFilterContext *ctx = inlink->dst;
126  CoverContext *cover = ctx->priv;
127  AVDictionaryEntry *ex, *ey, *ew, *eh;
128  int x = -1, y = -1, w = -1, h = -1;
129  char *xendptr = NULL, *yendptr = NULL, *wendptr = NULL, *hendptr = NULL;
130 
131  ex = av_dict_get(in->metadata, "lavfi.rect.x", NULL, AV_DICT_MATCH_CASE);
132  ey = av_dict_get(in->metadata, "lavfi.rect.y", NULL, AV_DICT_MATCH_CASE);
133  ew = av_dict_get(in->metadata, "lavfi.rect.w", NULL, AV_DICT_MATCH_CASE);
134  eh = av_dict_get(in->metadata, "lavfi.rect.h", NULL, AV_DICT_MATCH_CASE);
135  if (ex && ey && ew && eh) {
136  x = strtol(ex->value, &xendptr, 10);
137  y = strtol(ey->value, &yendptr, 10);
138  w = strtol(ew->value, &wendptr, 10);
139  h = strtol(eh->value, &hendptr, 10);
140  }
141 
142  if (!xendptr || *xendptr || !yendptr || *yendptr ||
143  !wendptr || *wendptr || !hendptr || *hendptr
144  ) {
145  return ff_filter_frame(ctx->outputs[0], in);
146  }
147 
148  if (x < 0) {
149  w += x;
150  x = 0;
151  }
152  if (y < 0) {
153  h += y;
154  y = 0;
155  }
156  w = FFMIN(w, in->width - x);
157  h = FFMIN(h, in->height - y);
158 
159  if (w > in->width || h > in->height || w <= 0 || h <= 0)
160  return AVERROR(EINVAL);
161 
162  if (cover->cover_frame) {
163  if (w != cover->cover_frame->width || h != cover->cover_frame->height)
164  return AVERROR(EINVAL);
165  }
166 
167  cover->width = w;
168  cover->height = h;
169 
170  x = av_clip(x, 0, in->width - w);
171  y = av_clip(y, 0, in->height - h);
172 
174 
175  if (cover->mode == MODE_BLUR) {
176  blur (cover, in, x, y);
177  } else {
178  cover_rect(cover, in, x, y);
179  }
180  return ff_filter_frame(ctx->outputs[0], in);
181 }
182 
184 {
185  CoverContext *cover = ctx->priv;
186 
187  if (cover->cover_frame)
188  av_freep(&cover->cover_frame->data[0]);
189  av_frame_free(&cover->cover_frame);
190 }
191 
193 {
194  CoverContext *cover = ctx->priv;
195  int ret;
196 
197  if (cover->mode == MODE_COVER) {
198  if (!cover->cover_filename) {
199  av_log(ctx, AV_LOG_ERROR, "cover filename not set\n");
200  return AVERROR(EINVAL);
201  }
202 
203  cover->cover_frame = av_frame_alloc();
204  if (!cover->cover_frame)
205  return AVERROR(ENOMEM);
206 
207  if ((ret = ff_load_image(cover->cover_frame->data, cover->cover_frame->linesize,
208  &cover->cover_frame->width, &cover->cover_frame->height,
209  &cover->cover_frame->format, cover->cover_filename, ctx)) < 0)
210  return ret;
211 
213  av_log(ctx, AV_LOG_ERROR, "cover image is not a YUV420 image\n");
214  return AVERROR(EINVAL);
215  }
216  }
217 
218  return 0;
219 }
220 
221 static const AVFilterPad cover_rect_inputs[] = {
222  {
223  .name = "default",
224  .type = AVMEDIA_TYPE_VIDEO,
225  .config_props = config_input,
226  .filter_frame = filter_frame,
227  },
228 };
229 
230 static const AVFilterPad cover_rect_outputs[] = {
231  {
232  .name = "default",
233  .type = AVMEDIA_TYPE_VIDEO,
234  },
235 };
236 
238  .name = "cover_rect",
239  .description = NULL_IF_CONFIG_SMALL("Find and cover a user specified object."),
240  .priv_size = sizeof(CoverContext),
241  .init = init,
242  .uninit = uninit,
246  .priv_class = &cover_rect_class,
247 };
av_clip
#define av_clip
Definition: common.h:96
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
CoverContext::cover_frame
AVFrame * cover_frame
Definition: vf_cover_rect.c:41
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
ff_vf_cover_rect
const AVFilter ff_vf_cover_rect
Definition: vf_cover_rect.c:237
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
CoverContext::height
int height
Definition: vf_cover_rect.c:42
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:109
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:317
av_frame_make_writable
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:490
AVFrame::width
int width
Definition: frame.h:389
w
uint8_t w
Definition: llviddspenc.c:38
AVOption
AVOption.
Definition: opt.h:247
data
const char data[16]
Definition: mxf.c:143
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:169
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:338
cover_rect_outputs
static const AVFilterPad cover_rect_outputs[]
Definition: vf_cover_rect.c:230
OFFSET
#define OFFSET(x)
Definition: vf_cover_rect.c:45
scale
static av_always_inline float scale(float x, float s)
Definition: vf_v360.c:1388
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:97
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
cover_rect_inputs
static const AVFilterPad cover_rect_inputs[]
Definition: vf_cover_rect.c:221
av_dict_get
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:40
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
NB_MODES
@ NB_MODES
Definition: vf_cover_rect.c:34
ctx
AVFormatContext * ctx
Definition: movenc.c:48
cover_rect
static void cover_rect(CoverContext *cover, AVFrame *in, int offx, int offy)
Definition: vf_cover_rect.c:62
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:78
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
CoverContext::cover_filename
char * cover_filename
Definition: vf_cover_rect.c:40
blur
static void blur(CoverContext *cover, AVFrame *in, int offx, int offy)
Definition: vf_cover_rect.c:80
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:117
FILTER_PIXFMTS
#define FILTER_PIXFMTS(...)
Definition: internal.h:177
ff_load_image
int ff_load_image(uint8_t *data[4], int linesize[4], int *w, int *h, enum AVPixelFormat *pix_fmt, const char *filename, void *log_ctx)
Load image from filename and put the resulting image in data.
Definition: lavfutils.c:34
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:404
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_cover_rect.c:183
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_cover_rect.c:57
internal.h
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
MODE_BLUR
@ MODE_BLUR
Definition: vf_cover_rect.c:33
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
stride
#define stride
Definition: h264pred_template.c:537
AVFilter
Filter definition.
Definition: avfilter.h:165
CoverContext
Definition: vf_cover_rect.c:37
ret
ret
Definition: filter_design.txt:187
AV_DICT_MATCH_CASE
#define AV_DICT_MATCH_CASE
Only get an entry with exact-case key match.
Definition: dict.h:67
AVFrame::height
int height
Definition: frame.h:389
MODE_COVER
@ MODE_COVER
Definition: vf_cover_rect.c:32
CoverContext::width
int width
Definition: vf_cover_rect.c:42
mode
mode
Definition: ebur128.h:83
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
AVFrame::metadata
AVDictionary * metadata
metadata.
Definition: frame.h:608
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_cover_rect.c:192
lavfutils.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:402
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(cover_rect)
AVDictionaryEntry
Definition: dict.h:79
CoverContext::mode
int mode
Definition: vf_cover_rect.c:39
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:362
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
FLAGS
#define FLAGS
Definition: vf_cover_rect.c:46
h
h
Definition: vp9dsp_template.c:2038
AVDictionaryEntry::value
char * value
Definition: dict.h:81
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:228
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_cover_rect.c:123
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
cover_rect_options
static const AVOption cover_rect_options[]
Definition: vf_cover_rect.c:47