FFmpeg  4.1
vf_limiter.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/attributes.h"
20 #include "libavutil/common.h"
21 #include "libavutil/eval.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 #include "avfilter.h"
26 #include "formats.h"
27 #include "internal.h"
28 #include "limiter.h"
29 #include "video.h"
30 
31 typedef struct ThreadData {
32  AVFrame *in;
33  AVFrame *out;
34 } ThreadData;
35 
36 typedef struct LimiterContext {
37  const AVClass *class;
38  int min;
39  int max;
40  int planes;
41  int nb_planes;
42  int linesize[4];
43  int width[4];
44  int height[4];
45 
48 
49 #define OFFSET(x) offsetof(LimiterContext, x)
50 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
51 
52 static const AVOption limiter_options[] = {
53  { "min", "set min value", OFFSET(min), AV_OPT_TYPE_INT, {.i64=0}, 0, 65535, .flags = FLAGS },
54  { "max", "set max value", OFFSET(max), AV_OPT_TYPE_INT, {.i64=65535}, 0, 65535, .flags = FLAGS },
55  { "planes", "set planes", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=15}, 0, 15, .flags = FLAGS },
56  { NULL }
57 };
58 
59 AVFILTER_DEFINE_CLASS(limiter);
60 
62 {
63  LimiterContext *s = ctx->priv;
64 
65  if (s->min > s->max)
66  return AVERROR(EINVAL);
67  return 0;
68 }
69 
71 {
72  static const enum AVPixelFormat pix_fmts[] = {
91  };
92 
93  AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
94  if (!fmts_list)
95  return AVERROR(ENOMEM);
96  return ff_set_common_formats(ctx, fmts_list);
97 }
98 
99 static void limiter8(const uint8_t *src, uint8_t *dst,
100  ptrdiff_t slinesize, ptrdiff_t dlinesize,
101  int w, int h, int min, int max)
102 {
103  int x, y;
104 
105  for (y = 0; y < h; y++) {
106  for (x = 0; x < w; x++) {
107  dst[x] = av_clip(src[x], min, max);
108  }
109 
110  dst += dlinesize;
111  src += slinesize;
112  }
113 }
114 
115 static void limiter16(const uint8_t *ssrc, uint8_t *ddst,
116  ptrdiff_t slinesize, ptrdiff_t dlinesize,
117  int w, int h, int min, int max)
118 {
119  const uint16_t *src = (const uint16_t *)ssrc;
120  uint16_t *dst = (uint16_t *)ddst;
121  int x, y;
122 
123  dlinesize /= 2;
124  slinesize /= 2;
125 
126  for (y = 0; y < h; y++) {
127  for (x = 0; x < w; x++) {
128  dst[x] = av_clip(src[x], min, max);
129  }
130 
131  dst += dlinesize;
132  src += slinesize;
133  }
134 }
135 
137 {
138  AVFilterContext *ctx = inlink->dst;
139  LimiterContext *s = ctx->priv;
141  int vsub, hsub, ret;
142 
144 
145  if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
146  return ret;
147 
148  hsub = desc->log2_chroma_w;
149  vsub = desc->log2_chroma_h;
150  s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
151  s->height[0] = s->height[3] = inlink->h;
152  s->width[1] = s->width[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
153  s->width[0] = s->width[3] = inlink->w;
154 
155  if (desc->comp[0].depth == 8) {
156  s->dsp.limiter = limiter8;
157  s->max = FFMIN(s->max, 255);
158  s->min = FFMIN(s->min, 255);
159  } else {
160  s->dsp.limiter = limiter16;
161  }
162 
163  if (ARCH_X86)
164  ff_limiter_init_x86(&s->dsp, desc->comp[0].depth);
165 
166  return 0;
167 }
168 
169 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
170 {
171  LimiterContext *s = ctx->priv;
172  ThreadData *td = arg;
173  AVFrame *in = td->in;
174  AVFrame *out = td->out;
175  int p;
176 
177  for (p = 0; p < s->nb_planes; p++) {
178  const int h = s->height[p];
179  const int slice_start = (h * jobnr) / nb_jobs;
180  const int slice_end = (h * (jobnr+1)) / nb_jobs;
181 
182  if (!((1 << p) & s->planes)) {
183  if (out != in)
184  av_image_copy_plane(out->data[p] + slice_start * out->linesize[p],
185  out->linesize[p],
186  in->data[p] + slice_start * in->linesize[p],
187  in->linesize[p],
188  s->linesize[p], slice_end - slice_start);
189  continue;
190  }
191 
192  s->dsp.limiter(in->data[p] + slice_start * in->linesize[p],
193  out->data[p] + slice_start * out->linesize[p],
194  in->linesize[p], out->linesize[p],
195  s->width[p], slice_end - slice_start,
196  s->min, s->max);
197  }
198 
199  return 0;
200 }
201 
203 {
204  AVFilterContext *ctx = inlink->dst;
205  LimiterContext *s = ctx->priv;
206  AVFilterLink *outlink = ctx->outputs[0];
207  ThreadData td;
208  AVFrame *out;
209 
210  if (av_frame_is_writable(in)) {
211  out = in;
212  } else {
213  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
214  if (!out) {
215  av_frame_free(&in);
216  return AVERROR(ENOMEM);
217  }
218  av_frame_copy_props(out, in);
219  }
220 
221  td.out = out;
222  td.in = in;
223  ctx->internal->execute(ctx, filter_slice, &td, NULL,
224  FFMIN(s->height[2], ff_filter_get_nb_threads(ctx)));
225  if (out != in)
226  av_frame_free(&in);
227 
228  return ff_filter_frame(outlink, out);
229 }
230 
231 static const AVFilterPad inputs[] = {
232  {
233  .name = "default",
234  .type = AVMEDIA_TYPE_VIDEO,
235  .filter_frame = filter_frame,
236  .config_props = config_props,
237  },
238  { NULL }
239 };
240 
241 static const AVFilterPad outputs[] = {
242  {
243  .name = "default",
244  .type = AVMEDIA_TYPE_VIDEO,
245  },
246  { NULL }
247 };
248 
250  .name = "limiter",
251  .description = NULL_IF_CONFIG_SMALL("Limit pixels components to the specified range."),
252  .priv_size = sizeof(LimiterContext),
253  .priv_class = &limiter_class,
254  .init = init,
256  .inputs = inputs,
257  .outputs = outputs,
259 };
static av_cold int init(AVFilterContext *ctx)
Definition: vf_limiter.c:61
#define NULL
Definition: coverity.c:32
#define OFFSET(x)
Definition: vf_limiter.c:49
#define AV_PIX_FMT_YUVA422P16
Definition: pixfmt.h:420
AVFrame * out
Definition: af_adeclick.c:485
static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: vf_limiter.c:169
#define AV_PIX_FMT_YUVA422P9
Definition: pixfmt.h:414
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2446
This structure describes decoded (raw) audio or video data.
Definition: frame.h:226
AVOption.
Definition: opt.h:246
#define AV_PIX_FMT_YUVA420P10
Definition: pixfmt.h:416
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:389
#define AV_PIX_FMT_GBRAP10
Definition: pixfmt.h:399
#define AV_PIX_FMT_YUVA422P10
Definition: pixfmt.h:417
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:71
misc image utilities
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2486
Main libavfilter public API header.
const char * desc
Definition: nvenc.c:65
planar GBR 4:4:4 24bpp
Definition: pixfmt.h:168
#define AV_PIX_FMT_GBRP10
Definition: pixfmt.h:395
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:359
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:383
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
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:92
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_limiter.c:202
Macro definitions for various function/variable attributes.
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:283
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:360
#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:125
const char * name
Pad name.
Definition: internal.h:60
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:361
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1080
static void limiter16(const uint8_t *ssrc, uint8_t *ddst, ptrdiff_t slinesize, ptrdiff_t dlinesize, int w, int h, int min, int max)
Definition: vf_limiter.c:115
AVFrame * in
Definition: af_afftdn.c:1082
planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
Definition: pixfmt.h:101
AVComponentDescriptor comp[4]
Parameters that describe how pixels are packed.
Definition: pixdesc.h:117
uint8_t
#define av_cold
Definition: attributes.h:82
int linesize[4]
Definition: vf_limiter.c:42
AVOptions.
#define AV_PIX_FMT_YUVA420P9
Definition: pixfmt.h:413
#define AV_PIX_FMT_GBRP9
Definition: pixfmt.h:394
int height
Definition: vf_avgblur.c:61
static const AVFilterPad inputs[]
Definition: vf_limiter.c:231
planar YUV 4:4:0 full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV440P and setting color_range...
Definition: pixfmt.h:100
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:79
int linesize
Definition: vf_avgblur.c:64
void(* limiter)(const uint8_t *src, uint8_t *dst, ptrdiff_t slinesize, ptrdiff_t dlinesize, int w, int h, int min, int max)
Definition: limiter.h:26
int width[4]
Definition: vf_limiter.c:43
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:392
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:384
#define AV_PIX_FMT_YUVA420P16
Definition: pixfmt.h:419
static const AVFilterPad outputs[]
Definition: vf_limiter.c:241
A filter pad used for either input or output.
Definition: internal.h:54
LimiterDSPContext dsp
Definition: vf_limiter.c:46
planar YUV 4:2:2 24bpp, (1 Cr & Cb sample per 2x1 Y & A samples)
Definition: pixfmt.h:176
static const AVOption limiter_options[]
Definition: vf_limiter.c:52
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:568
#define td
Definition: regdef.h:70
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:101
AVFilter ff_vf_limiter
Definition: vf_limiter.c:249
#define ARCH_X86
Definition: config.h:38
#define AVERROR(e)
Definition: error.h:43
static int config_props(AVFilterLink *inlink)
Definition: vf_limiter.c:136
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
void * priv
private data for use by the filter
Definition: avfilter.h:353
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:116
#define AV_PIX_FMT_YUVA444P16
Definition: pixfmt.h:421
const char * arg
Definition: jacosubdec.c:66
#define AV_PIX_FMT_GBRAP12
Definition: pixfmt.h:400
AVFILTER_DEFINE_CLASS(limiter)
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:382
#define AV_PIX_FMT_GBRAP16
Definition: pixfmt.h:401
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
#define AV_PIX_FMT_YUV422P9
Definition: pixfmt.h:377
static const struct @304 planes[]
#define AV_PIX_FMT_GBRP16
Definition: pixfmt.h:398
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:802
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:363
#define FFMIN(a, b)
Definition: common.h:96
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:78
int height[4]
Definition: vf_limiter.c:44
AVFormatContext * ctx
Definition: movenc.c:48
#define AV_PIX_FMT_YUVA444P10
Definition: pixfmt.h:418
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:378
#define AV_PIX_FMT_GBRP14
Definition: pixfmt.h:397
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:390
AVFrame * dst
Definition: vf_blend.c:55
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:387
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:594
Used for passing data between threads.
Definition: af_adeclick.c:484
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:257
planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
Definition: pixfmt.h:177
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
#define AV_PIX_FMT_GRAY14
Definition: pixfmt.h:362
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:379
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:72
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
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
const char * name
Filter name.
Definition: avfilter.h:148
#define AV_PIX_FMT_YUV440P12
Definition: pixfmt.h:385
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:376
static int query_formats(AVFilterContext *ctx)
Definition: vf_limiter.c:70
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
AVFrame * min
Definition: vf_threshold.c:74
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:266
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:388
#define AV_PIX_FMT_GBRP12
Definition: pixfmt.h:396
#define flags(name, subs,...)
Definition: cbs_av1.c:596
AVFilterInternal * internal
An opaque struct for libavfilter internal use.
Definition: avfilter.h:378
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:380
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:386
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:240
#define FLAGS
Definition: vf_limiter.c:50
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
Y , 8bpp.
Definition: pixfmt.h:74
common internal and external API header
planar GBRA 4:4:4:4 32bpp
Definition: pixfmt.h:215
#define AV_PIX_FMT_YUVA444P9
Definition: pixfmt.h:415
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:80
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:73
avfilter_execute_func * execute
Definition: internal.h:155
const uint8_t * src
Definition: vf_bm3d.c:56
static int slice_end(AVCodecContext *avctx, AVFrame *pict)
Handle slice ends.
Definition: mpeg12dec.c:2029
static void limiter8(const uint8_t *src, uint8_t *dst, ptrdiff_t slinesize, ptrdiff_t dlinesize, int w, int h, int min, int max)
Definition: vf_limiter.c:99
A list of supported formats for one end of a filter link.
Definition: formats.h:64
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor ...
Definition: pixfmt.h:258
An instance of a filter.
Definition: avfilter.h:338
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:99
void ff_limiter_init_x86(LimiterDSPContext *dsp, int bpp)
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:338
AVFilterLink * inlink
Definition: vf_blend.c:56
internal API functions
int depth
Number of bits in the component.
Definition: pixdesc.h:58
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
#define AV_PIX_FMT_YUV422P16
Definition: pixfmt.h:391
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:654
AVFrame * max
Definition: vf_threshold.c:75
simple arithmetic expression evaluator
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58