FFmpeg  4.4
vf_maskfun.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include "libavutil/imgutils.h"
22 #include "libavutil/pixdesc.h"
23 #include "libavutil/opt.h"
24 #include "avfilter.h"
25 #include "formats.h"
26 #include "internal.h"
27 #include "video.h"
28 
29 typedef struct MaskFunContext {
30  const AVClass *class;
31 
32  int low, high;
33  int planes;
34  int fill;
35  int sum;
36 
37  int linesize[4];
38  int width[4], height[4];
39  int nb_planes;
40  int depth;
41  int max;
42  uint64_t max_sum;
43 
46  int (*maskfun)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
48 
49 #define OFFSET(x) offsetof(MaskFunContext, x)
50 #define VFT AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
51 
52 static const AVOption maskfun_options[] = {
53  { "low", "set low threshold", OFFSET(low), AV_OPT_TYPE_INT, {.i64=10}, 0, UINT16_MAX, VFT },
54  { "high", "set high threshold", OFFSET(high), AV_OPT_TYPE_INT, {.i64=10}, 0, UINT16_MAX, VFT },
55  { "planes", "set planes", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=0xF}, 0, 0xF, VFT },
56  { "fill", "set fill value", OFFSET(fill), AV_OPT_TYPE_INT, {.i64=0}, 0, UINT16_MAX, VFT },
57  { "sum", "set sum value", OFFSET(sum), AV_OPT_TYPE_INT, {.i64=10}, 0, UINT16_MAX, VFT },
58  { NULL }
59 };
60 
62 
64 {
65  static const enum AVPixelFormat pix_fmts[] = {
84  };
85 
87 }
88 
89 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
90 {
91  AVFilterContext *ctx = inlink->dst;
92  MaskFunContext *s = ctx->priv;
93  AVFilterLink *outlink = ctx->outputs[0];
94 
95  if (s->getsum(ctx, frame)) {
96  AVFrame *out = av_frame_clone(s->empty);
97 
98  if (!out) {
100  return AVERROR(ENOMEM);
101  }
102  out->pts = frame->pts;
104 
105  return ff_filter_frame(outlink, out);
106  }
107 
108  ctx->internal->execute(ctx, s->maskfun, frame, NULL,
109  FFMIN(s->height[1], ff_filter_get_nb_threads(ctx)));
110 
111  return ff_filter_frame(outlink, frame);
112 }
113 
114 #define GETSUM(name, type, div) \
115 static int getsum##name(AVFilterContext *ctx, AVFrame *out) \
116 { \
117  MaskFunContext *s = ctx->priv; \
118  uint64_t sum = 0; \
119  int p; \
120  \
121  for (p = 0; p < s->nb_planes; p++) { \
122  const int linesize = out->linesize[p] / div; \
123  const int w = s->width[p]; \
124  const int h = s->height[p]; \
125  type *dst = (type *)out->data[p]; \
126  \
127  if (!((1 << p) & s->planes)) \
128  continue; \
129  \
130  for (int y = 0; y < h; y++) { \
131  for (int x = 0; x < w; x++) \
132  sum += dst[x]; \
133  if (sum >= s->max_sum) \
134  return 1; \
135  dst += linesize; \
136  } \
137  } \
138  \
139  return 0; \
140 }
141 
142 GETSUM(8, uint8_t, 1)
143 GETSUM(16, uint16_t, 2)
144 
145 #define MASKFUN(name, type, div) \
146 static int maskfun##name(AVFilterContext *ctx, void *arg, \
147  int jobnr, int nb_jobs) \
148 { \
149  MaskFunContext *s = ctx->priv; \
150  AVFrame *out = arg; \
151  const int low = s->low; \
152  const int high = s->high; \
153  const int max = s->max; \
154  int p; \
155  \
156  for (p = 0; p < s->nb_planes; p++) { \
157  const int linesize = out->linesize[p] / div; \
158  const int w = s->width[p]; \
159  const int h = s->height[p]; \
160  const int slice_start = (h * jobnr) / nb_jobs; \
161  const int slice_end = (h * (jobnr+1)) / nb_jobs; \
162  type *dst = (type *)out->data[p] + slice_start * linesize; \
163  \
164  if (!((1 << p) & s->planes)) \
165  continue; \
166  \
167  for (int y = slice_start; y < slice_end; y++) { \
168  for (int x = 0; x < w; x++) { \
169  if (dst[x] <= low) \
170  dst[x] = 0; \
171  else if (dst[x] > high) \
172  dst[x] = max; \
173  } \
174  \
175  dst += linesize; \
176  } \
177  } \
178  \
179  return 0; \
180 }
181 
182 MASKFUN(8, uint8_t, 1)
183 MASKFUN(16, uint16_t, 2)
184 
186 {
187  MaskFunContext *s = ctx->priv;
188 
189  s->fill = FFMIN(s->fill, s->max);
190  if (s->depth == 8) {
191  for (int p = 0; p < s->nb_planes; p++) {
192  uint8_t *dst = s->empty->data[p];
193 
194  for (int y = 0; y < s->height[p]; y++) {
195  memset(dst, s->fill, s->width[p]);
196  dst += s->empty->linesize[p];
197  }
198  }
199  } else {
200  for (int p = 0; p < s->nb_planes; p++) {
201  uint16_t *dst = (uint16_t *)s->empty->data[p];
202 
203  for (int y = 0; y < s->height[p]; y++) {
204  for (int x = 0; x < s->width[p]; x++)
205  dst[x] = s->fill;
206  dst += s->empty->linesize[p] / 2;
207  }
208  }
209  }
210 }
211 
213 {
214  MaskFunContext *s = ctx->priv;
215 
216  s->max_sum = 0;
217  for (int p = 0; p < s->nb_planes; p++) {
218  if (!((1 << p) & s->planes))
219  continue;
220  s->max_sum += (uint64_t)s->sum * s->width[p] * s->height[p];
221  }
222 }
223 
224 static int config_input(AVFilterLink *inlink)
225 {
226  AVFilterContext *ctx = inlink->dst;
227  MaskFunContext *s = ctx->priv;
229  int vsub, hsub, ret;
230 
231  s->nb_planes = av_pix_fmt_count_planes(inlink->format);
232 
233  if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
234  return ret;
235 
236  hsub = desc->log2_chroma_w;
237  vsub = desc->log2_chroma_h;
238  s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
239  s->height[0] = s->height[3] = inlink->h;
240  s->width[1] = s->width[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
241  s->width[0] = s->width[3] = inlink->w;
242 
243  s->depth = desc->comp[0].depth;
244  s->max = (1 << s->depth) - 1;
245 
246  if (s->depth == 8) {
247  s->maskfun = maskfun8;
248  s->getsum = getsum8;
249  } else {
250  s->maskfun = maskfun16;
251  s->getsum = getsum16;
252  }
253 
254  s->empty = ff_get_video_buffer(inlink, inlink->w, inlink->h);
255  if (!s->empty)
256  return AVERROR(ENOMEM);
257 
258  fill_frame(ctx);
259 
260  set_max_sum(ctx);
261 
262  return 0;
263 }
264 
265 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
266  char *res, int res_len, int flags)
267 {
268  MaskFunContext *s = ctx->priv;
269  int fill = s->fill;
270  int sum = s->sum;
271  int ret;
272 
273  ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
274  if (ret < 0)
275  return ret;
276 
277  if (sum != s->sum)
278  set_max_sum(ctx);
279 
280  if (fill != s->fill)
281  fill_frame(ctx);
282 
283  return 0;
284 }
285 
287 {
288  MaskFunContext *s = ctx->priv;
289 
290  av_frame_free(&s->empty);
291 }
292 
293 static const AVFilterPad maskfun_inputs[] = {
294  {
295  .name = "default",
296  .type = AVMEDIA_TYPE_VIDEO,
297  .filter_frame = filter_frame,
298  .config_props = config_input,
299  .needs_writable = 1,
300  },
301  { NULL }
302 };
303 
304 static const AVFilterPad maskfun_outputs[] = {
305  {
306  .name = "default",
307  .type = AVMEDIA_TYPE_VIDEO,
308  },
309  { NULL }
310 };
311 
313  .name = "maskfun",
314  .description = NULL_IF_CONFIG_SMALL("Create Mask."),
315  .priv_size = sizeof(MaskFunContext),
317  .uninit = uninit,
320  .priv_class = &maskfun_class,
323 };
static const AVFilterPad inputs[]
Definition: af_acontrast.c:193
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
#define av_cold
Definition: attributes.h:88
uint8_t
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1094
int ff_filter_process_command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
Generic processing of user supplied commands that are set in the same way as the filter options.
Definition: avfilter.c:882
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:802
Main libavfilter public API header.
#define flags(name, subs,...)
Definition: cbs_av1.c:561
#define s(width, name)
Definition: cbs_vp9.c:257
#define FFMIN(a, b)
Definition: common.h:105
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58
#define NULL
Definition: coverity.c:32
static AVFrame * frame
int
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:587
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:286
@ AV_OPT_TYPE_INT
Definition: opt.h:225
#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:126
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:117
#define AVERROR(e)
Definition: error.h:43
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:540
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
Fill plane linesizes for an image with pixel format pix_fmt and width width.
Definition: imgutils.c:89
for(j=16;j >0;--j)
misc image utilities
const char * arg
Definition: jacosubdec.c:66
common internal API header
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:303
const char * desc
Definition: libsvtav1.c:79
static const struct @322 planes[]
AVOptions.
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2613
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2573
#define AV_PIX_FMT_GBRAP12
Definition: pixfmt.h:420
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:410
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:406
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:398
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:399
#define AV_PIX_FMT_YUV440P12
Definition: pixfmt.h:405
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:379
#define AV_PIX_FMT_GBRAP16
Definition: pixfmt.h:421
#define AV_PIX_FMT_GBRP9
Definition: pixfmt.h:414
#define AV_PIX_FMT_YUV422P9
Definition: pixfmt.h:397
#define AV_PIX_FMT_YUVA444P10
Definition: pixfmt.h:438
#define AV_PIX_FMT_YUVA420P16
Definition: pixfmt.h:441
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:403
#define AV_PIX_FMT_YUVA420P10
Definition: pixfmt.h:436
#define AV_PIX_FMT_YUVA422P9
Definition: pixfmt.h:434
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:404
#define AV_PIX_FMT_GBRP10
Definition: pixfmt.h:415
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:400
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:381
#define AV_PIX_FMT_GBRP12
Definition: pixfmt.h:416
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:396
#define AV_PIX_FMT_YUVA420P9
Definition: pixfmt.h:433
#define AV_PIX_FMT_YUVA422P10
Definition: pixfmt.h:437
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:407
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
@ AV_PIX_FMT_YUV440P
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:99
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
@ AV_PIX_FMT_YUVA420P
planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
Definition: pixfmt.h:101
@ AV_PIX_FMT_YUVJ440P
planar YUV 4:4:0 full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV440P and setting color_range
Definition: pixfmt.h:100
@ AV_PIX_FMT_YUV410P
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:72
@ AV_PIX_FMT_YUV411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:73
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:71
@ AV_PIX_FMT_YUVA444P
planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
Definition: pixfmt.h:177
@ AV_PIX_FMT_YUVJ411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor ...
Definition: pixfmt.h:258
@ AV_PIX_FMT_GBRAP
planar GBRA 4:4:4:4 32bpp
Definition: pixfmt.h:215
@ AV_PIX_FMT_YUVJ422P
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:79
@ AV_PIX_FMT_YUVA422P
planar YUV 4:2:2 24bpp, (1 Cr & Cb sample per 2x1 Y & A samples)
Definition: pixfmt.h:176
@ AV_PIX_FMT_GBRP
planar GBR 4:4:4 24bpp
Definition: pixfmt.h:168
@ AV_PIX_FMT_YUVJ444P
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:80
@ 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
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:408
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:380
#define AV_PIX_FMT_GRAY14
Definition: pixfmt.h:382
#define AV_PIX_FMT_YUV422P16
Definition: pixfmt.h:411
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:383
#define AV_PIX_FMT_GBRAP10
Definition: pixfmt.h:419
#define AV_PIX_FMT_YUVA444P16
Definition: pixfmt.h:443
#define AV_PIX_FMT_YUVA422P16
Definition: pixfmt.h:442
#define AV_PIX_FMT_GBRP16
Definition: pixfmt.h:418
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:409
#define AV_PIX_FMT_YUVA444P9
Definition: pixfmt.h:435
#define AV_PIX_FMT_GBRP14
Definition: pixfmt.h:417
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:412
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:402
Describe the class of an AVClass context structure.
Definition: log.h:67
An instance of a filter.
Definition: avfilter.h:341
A filter pad used for either input or output.
Definition: internal.h:54
const char * name
Pad name.
Definition: internal.h:60
Filter definition.
Definition: avfilter.h:145
const char * name
Filter name.
Definition: avfilter.h:149
AVFormatInternal * internal
An opaque field for libavformat internal usage.
Definition: avformat.h:1699
This structure describes decoded (raw) audio or video data.
Definition: frame.h:318
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:411
AVOption.
Definition: opt.h:248
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
int height[4]
Definition: vf_maskfun.c:38
int(* maskfun)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: vf_maskfun.c:46
int width[4]
Definition: vf_maskfun.c:38
uint64_t max_sum
Definition: vf_maskfun.c:42
AVFrame * empty
Definition: vf_maskfun.c:44
int(* getsum)(AVFilterContext *ctx, AVFrame *out)
Definition: vf_maskfun.c:45
int linesize[4]
Definition: vf_maskfun.c:37
FILE * out
Definition: movenc.c:54
AVFormatContext * ctx
Definition: movenc.c:48
#define VFT
Definition: vf_maskfun.c:50
static const AVFilterPad maskfun_outputs[]
Definition: vf_maskfun.c:304
static const AVOption maskfun_options[]
Definition: vf_maskfun.c:52
static int query_formats(AVFilterContext *ctx)
Definition: vf_maskfun.c:63
static const AVFilterPad maskfun_inputs[]
Definition: vf_maskfun.c:293
static int config_input(AVFilterLink *inlink)
Definition: vf_maskfun.c:224
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: vf_maskfun.c:89
static void fill_frame(AVFilterContext *ctx)
Definition: vf_maskfun.c:185
AVFILTER_DEFINE_CLASS(maskfun)
static void set_max_sum(AVFilterContext *ctx)
Definition: vf_maskfun.c:212
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
Definition: vf_maskfun.c:265
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_maskfun.c:286
AVFilter ff_vf_maskfun
Definition: vf_maskfun.c:312
#define OFFSET(x)
Definition: vf_maskfun.c:49
#define GETSUM(name, type, div)
Definition: vf_maskfun.c:114
#define MASKFUN(name, type, div)
Definition: vf_maskfun.c:145
static void hsub(htype *dst, const htype *src, int bins)
Definition: vf_median.c:75
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:99