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/mem.h"
26 #include "libavutil/opt.h"
27 #include "filters.h"
28 #include "internal.h"
29 #include "video.h"
30 
31 #include "lavfutils.h"
32 
33 enum mode {
37 };
38 
39 typedef struct CoverContext {
40  AVClass *class;
41  int mode;
44  int width, height;
45 } CoverContext;
46 
47 #define OFFSET(x) offsetof(CoverContext, x)
48 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
49 static const AVOption cover_rect_options[] = {
50  { "cover", "cover bitmap filename", OFFSET(cover_filename), AV_OPT_TYPE_STRING, {.str = NULL}, .flags = FLAGS },
51  { "mode", "set removal mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = MODE_BLUR}, 0, NB_MODES - 1, FLAGS, .unit = "mode" },
52  { "cover", "cover area with bitmap", 0, AV_OPT_TYPE_CONST, {.i64 = MODE_COVER}, INT_MIN, INT_MAX, FLAGS, .unit = "mode" },
53  { "blur", "blur area", 0, AV_OPT_TYPE_CONST, {.i64 = MODE_BLUR}, INT_MIN, INT_MAX, FLAGS, .unit = "mode" },
54  { NULL }
55 };
56 
58 
60 {
61  return 0;
62 }
63 
64 static void cover_rect(CoverContext *cover, AVFrame *in, int offx, int offy)
65 {
66  int x, y, p;
67 
68  for (p = 0; p < 3; p++) {
69  uint8_t *data = in->data[p] + (offx>>!!p) + (offy>>!!p) * in->linesize[p];
70  const uint8_t *src = cover->cover_frame->data[p];
71  int w = AV_CEIL_RSHIFT(cover->cover_frame->width , !!p);
72  int h = AV_CEIL_RSHIFT(cover->cover_frame->height, !!p);
73  for (y = 0; y < h; y++) {
74  for (x = 0; x < w; x++) {
75  data[x] = src[x];
76  }
77  data += in->linesize[p];
78  src += cover->cover_frame->linesize[p];
79  }
80  }
81 }
82 static void blur(CoverContext *cover, AVFrame *in, int offx, int offy)
83 {
84  int x, y, p;
85 
86  for (p=0; p<3; p++) {
87  int ox = offx>>!!p;
88  int oy = offy>>!!p;
89  int stride = in->linesize[p];
90  uint8_t *data = in->data[p] + ox + oy * stride;
91  int w = AV_CEIL_RSHIFT(cover->width , !!p);
92  int h = AV_CEIL_RSHIFT(cover->height, !!p);
93  int iw = AV_CEIL_RSHIFT(in->width , !!p);
94  int ih = AV_CEIL_RSHIFT(in->height, !!p);
95  for (y = 0; y < h; y++) {
96  for (x = 0; x < w; x++) {
97  int c = 0;
98  int s = 0;
99  if (ox) {
100  int scale = 65536 / (x + 1);
101  s += data[-1 + y*stride] * scale;
102  c += scale;
103  }
104  if (oy) {
105  int scale = 65536 / (y + 1);
106  s += data[x - stride] * scale;
107  c += scale;
108  }
109  if (ox + w < iw) {
110  int scale = 65536 / (w - x);
111  s += data[w + y*stride] * scale;
112  c += scale;
113  }
114  if (oy + h < ih) {
115  int scale = 65536 / (h - y);
116  s += data[x + h*stride] * scale;
117  c += scale;
118  }
119  data[x + y*stride] = c ? (s + (c>>1)) / c : 0;
120  }
121  }
122  }
123 }
124 
126 {
127  AVFilterContext *ctx = inlink->dst;
128  CoverContext *cover = ctx->priv;
129  AVDictionaryEntry *ex, *ey, *ew, *eh;
130  int ret, x = -1, y = -1, w = -1, h = -1;
131  char *xendptr = NULL, *yendptr = NULL, *wendptr = NULL, *hendptr = NULL;
132 
133  ex = av_dict_get(in->metadata, "lavfi.rect.x", NULL, AV_DICT_MATCH_CASE);
134  ey = av_dict_get(in->metadata, "lavfi.rect.y", NULL, AV_DICT_MATCH_CASE);
135  ew = av_dict_get(in->metadata, "lavfi.rect.w", NULL, AV_DICT_MATCH_CASE);
136  eh = av_dict_get(in->metadata, "lavfi.rect.h", NULL, AV_DICT_MATCH_CASE);
137  if (ex && ey && ew && eh) {
138  x = strtol(ex->value, &xendptr, 10);
139  y = strtol(ey->value, &yendptr, 10);
140  w = strtol(ew->value, &wendptr, 10);
141  h = strtol(eh->value, &hendptr, 10);
142  }
143 
144  if (!xendptr || *xendptr || !yendptr || *yendptr ||
145  !wendptr || *wendptr || !hendptr || *hendptr
146  ) {
147  return ff_filter_frame(ctx->outputs[0], in);
148  }
149 
150  if (x < 0) {
151  w += x;
152  x = 0;
153  }
154  if (y < 0) {
155  h += y;
156  y = 0;
157  }
158  w = FFMIN(w, in->width - x);
159  h = FFMIN(h, in->height - y);
160 
161  if (w > in->width || h > in->height || w <= 0 || h <= 0)
162  return AVERROR(EINVAL);
163 
164  if (cover->cover_frame) {
165  if (w != cover->cover_frame->width || h != cover->cover_frame->height)
166  return AVERROR(EINVAL);
167  }
168 
169  cover->width = w;
170  cover->height = h;
171 
172  x = av_clip(x, 0, in->width - w);
173  y = av_clip(y, 0, in->height - h);
174 
176  if (ret < 0) {
177  av_frame_free(&in);
178  return ret;
179  }
180 
181  if (cover->mode == MODE_BLUR) {
182  blur (cover, in, x, y);
183  } else {
184  cover_rect(cover, in, x, y);
185  }
186  return ff_filter_frame(ctx->outputs[0], in);
187 }
188 
190 {
191  CoverContext *cover = ctx->priv;
192 
193  if (cover->cover_frame)
194  av_freep(&cover->cover_frame->data[0]);
195  av_frame_free(&cover->cover_frame);
196 }
197 
199 {
200  CoverContext *cover = ctx->priv;
201  int ret;
202 
203  if (cover->mode == MODE_COVER) {
204  if (!cover->cover_filename) {
205  av_log(ctx, AV_LOG_ERROR, "cover filename not set\n");
206  return AVERROR(EINVAL);
207  }
208 
209  cover->cover_frame = av_frame_alloc();
210  if (!cover->cover_frame)
211  return AVERROR(ENOMEM);
212 
213  if ((ret = ff_load_image(cover->cover_frame->data, cover->cover_frame->linesize,
214  &cover->cover_frame->width, &cover->cover_frame->height,
215  &cover->cover_frame->format, cover->cover_filename, ctx)) < 0)
216  return ret;
217 
219  av_log(ctx, AV_LOG_ERROR, "cover image is not a YUV420 image\n");
220  return AVERROR(EINVAL);
221  }
222  }
223 
224  return 0;
225 }
226 
227 static const AVFilterPad cover_rect_inputs[] = {
228  {
229  .name = "default",
230  .type = AVMEDIA_TYPE_VIDEO,
231  .config_props = config_input,
232  .filter_frame = filter_frame,
233  },
234 };
235 
237  .name = "cover_rect",
238  .description = NULL_IF_CONFIG_SMALL("Find and cover a user specified object."),
239  .priv_size = sizeof(CoverContext),
240  .init = init,
241  .uninit = uninit,
245  .priv_class = &cover_rect_class,
246 };
av_clip
#define av_clip
Definition: common.h:99
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:43
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1015
ff_vf_cover_rect
const AVFilter ff_vf_cover_rect
Definition: vf_cover_rect.c:236
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:44
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
AVFrame::width
int width
Definition: frame.h:447
w
uint8_t w
Definition: llviddspenc.c:38
AVOption
AVOption.
Definition: opt.h:346
data
const char data[16]
Definition: mxf.c:148
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
video.h
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:396
OFFSET
#define OFFSET(x)
Definition: vf_cover_rect.c:47
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:148
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:227
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
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:62
s
#define s(width, name)
Definition: cbs_vp9.c:198
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:59
NB_MODES
@ NB_MODES
Definition: vf_cover_rect.c:36
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:49
cover_rect
static void cover_rect(CoverContext *cover, AVFrame *in, int offx, int offy)
Definition: vf_cover_rect.c:64
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:73
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
ff_inlink_make_frame_writable
int ff_inlink_make_frame_writable(AVFilterLink *link, AVFrame **rframe)
Make sure a frame is writable.
Definition: avfilter.c:1489
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:85
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:42
blur
static void blur(CoverContext *cover, AVFrame *in, int offx, int offy)
Definition: vf_cover_rect.c:82
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
FILTER_PIXFMTS
#define FILTER_PIXFMTS(...)
Definition: internal.h:168
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:462
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_cover_rect.c:189
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_cover_rect.c:59
internal.h
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
MODE_BLUR
@ MODE_BLUR
Definition: vf_cover_rect.c:35
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
stride
#define stride
Definition: h264pred_template.c:537
AVFilter
Filter definition.
Definition: avfilter.h:166
CoverContext
Definition: vf_cover_rect.c:39
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:74
AVFrame::height
int height
Definition: frame.h:447
MODE_COVER
@ MODE_COVER
Definition: vf_cover_rect.c:34
CoverContext::width
int width
Definition: vf_cover_rect.c:44
mode
mode
Definition: ebur128.h:83
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:235
AVFrame::metadata
AVDictionary * metadata
metadata.
Definition: frame.h:693
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_cover_rect.c:198
lavfutils.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
mem.h
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(cover_rect)
AVDictionaryEntry
Definition: dict.h:89
scale
static void scale(int *out, const int *in, const int w, const int h, const int shift)
Definition: intra.c:291
CoverContext::mode
int mode
Definition: vf_cover_rect.c:41
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
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:420
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
FLAGS
#define FLAGS
Definition: vf_cover_rect.c:48
h
h
Definition: vp9dsp_template.c:2038
AVDictionaryEntry::value
char * value
Definition: dict.h:91
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:239
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_cover_rect.c:125
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:244
cover_rect_options
static const AVOption cover_rect_options[]
Definition: vf_cover_rect.c:49