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