FFmpeg
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/imgutils.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/pixdesc.h"
24 #include "avfilter.h"
25 #include "formats.h"
26 #include "internal.h"
27 #include "limiter.h"
28 #include "video.h"
29 
30 typedef struct ThreadData {
31  AVFrame *in;
32  AVFrame *out;
33 } ThreadData;
34 
35 typedef struct LimiterContext {
36  const AVClass *class;
37  int min;
38  int max;
39  int planes;
40  int nb_planes;
41  int linesize[4];
42  int width[4];
43  int height[4];
44 
47 
48 #define OFFSET(x) offsetof(LimiterContext, x)
49 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
50 
51 static const AVOption limiter_options[] = {
52  { "min", "set min value", OFFSET(min), AV_OPT_TYPE_INT, {.i64=0}, 0, 65535, .flags = FLAGS },
53  { "max", "set max value", OFFSET(max), AV_OPT_TYPE_INT, {.i64=65535}, 0, 65535, .flags = FLAGS },
54  { "planes", "set planes", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=15}, 0, 15, .flags = FLAGS },
55  { NULL }
56 };
57 
58 AVFILTER_DEFINE_CLASS(limiter);
59 
61 {
62  LimiterContext *s = ctx->priv;
63 
64  if (s->min > s->max)
65  return AVERROR(EINVAL);
66  return 0;
67 }
68 
70 {
71  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 depth, vsub, hsub, ret;
142 
144 
145  if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
146  return ret;
147 
148  depth = desc->comp[0].depth;
149  hsub = desc->log2_chroma_w;
150  vsub = desc->log2_chroma_h;
151  s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
152  s->height[0] = s->height[3] = inlink->h;
153  s->width[1] = s->width[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
154  s->width[0] = s->width[3] = inlink->w;
155 
156  s->max = FFMIN(s->max, (1 << depth) - 1);
157  s->min = FFMIN(s->min, (1 << depth) - 1);
158 
159  if (depth == 8) {
160  s->dsp.limiter = limiter8;
161  } else {
162  s->dsp.limiter = limiter16;
163  }
164 
165  if (ARCH_X86)
166  ff_limiter_init_x86(&s->dsp, desc->comp[0].depth);
167 
168  return 0;
169 }
170 
171 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
172 {
173  LimiterContext *s = ctx->priv;
174  ThreadData *td = arg;
175  AVFrame *in = td->in;
176  AVFrame *out = td->out;
177  int p;
178 
179  for (p = 0; p < s->nb_planes; p++) {
180  const int h = s->height[p];
181  const int slice_start = (h * jobnr) / nb_jobs;
182  const int slice_end = (h * (jobnr+1)) / nb_jobs;
183 
184  if (!((1 << p) & s->planes)) {
185  if (out != in)
186  av_image_copy_plane(out->data[p] + slice_start * out->linesize[p],
187  out->linesize[p],
188  in->data[p] + slice_start * in->linesize[p],
189  in->linesize[p],
190  s->linesize[p], slice_end - slice_start);
191  continue;
192  }
193 
194  s->dsp.limiter(in->data[p] + slice_start * in->linesize[p],
195  out->data[p] + slice_start * out->linesize[p],
196  in->linesize[p], out->linesize[p],
197  s->width[p], slice_end - slice_start,
198  s->min, s->max);
199  }
200 
201  return 0;
202 }
203 
205 {
206  AVFilterContext *ctx = inlink->dst;
207  LimiterContext *s = ctx->priv;
208  AVFilterLink *outlink = ctx->outputs[0];
209  ThreadData td;
210  AVFrame *out;
211 
212  if (av_frame_is_writable(in)) {
213  out = in;
214  } else {
215  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
216  if (!out) {
217  av_frame_free(&in);
218  return AVERROR(ENOMEM);
219  }
220  av_frame_copy_props(out, in);
221  }
222 
223  td.out = out;
224  td.in = in;
225  ctx->internal->execute(ctx, filter_slice, &td, NULL,
226  FFMIN(s->height[2], ff_filter_get_nb_threads(ctx)));
227  if (out != in)
228  av_frame_free(&in);
229 
230  return ff_filter_frame(outlink, out);
231 }
232 
233 static const AVFilterPad inputs[] = {
234  {
235  .name = "default",
236  .type = AVMEDIA_TYPE_VIDEO,
237  .filter_frame = filter_frame,
238  .config_props = config_props,
239  },
240  { NULL }
241 };
242 
243 static const AVFilterPad outputs[] = {
244  {
245  .name = "default",
246  .type = AVMEDIA_TYPE_VIDEO,
247  },
248  { NULL }
249 };
250 
252  .name = "limiter",
253  .description = NULL_IF_CONFIG_SMALL("Limit pixels components to the specified range."),
254  .priv_size = sizeof(LimiterContext),
255  .priv_class = &limiter_class,
256  .init = init,
258  .inputs = inputs,
259  .outputs = outputs,
261 };
static av_cold int init(AVFilterContext *ctx)
Definition: vf_limiter.c:60
#define NULL
Definition: coverity.c:32
#define OFFSET(x)
Definition: vf_limiter.c:48
#define AV_PIX_FMT_YUVA422P16
Definition: pixfmt.h:440
AVFrame * out
Definition: af_adeclick.c:494
static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: vf_limiter.c:171
#define AV_PIX_FMT_YUVA422P9
Definition: pixfmt.h:432
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2549
This structure describes decoded (raw) audio or video data.
Definition: frame.h:300
AVOption.
Definition: opt.h:246
#define AV_PIX_FMT_YUVA420P10
Definition: pixfmt.h:434
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:407
#define AV_PIX_FMT_GBRAP10
Definition: pixfmt.h:417
#define AV_PIX_FMT_YUVA422P10
Definition: pixfmt.h:435
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:2589
Main libavfilter public API header.
planar GBR 4:4:4 24bpp
Definition: pixfmt.h:168
#define AV_PIX_FMT_GBRP10
Definition: pixfmt.h:413
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:377
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:401
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:204
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:378
#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:379
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1075
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
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:41
AVOptions.
#define AV_PIX_FMT_YUVA420P9
Definition: pixfmt.h:431
#define AV_PIX_FMT_GBRP9
Definition: pixfmt.h:412
int height
Definition: vf_avgblur.c:61
static const AVFilterPad inputs[]
Definition: vf_limiter.c:233
AVFrame * dst
Definition: vf_blend.c:55
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:42
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:410
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:402
#define AV_PIX_FMT_YUVA420P16
Definition: pixfmt.h:439
static const AVFilterPad outputs[]
Definition: vf_limiter.c:243
A filter pad used for either input or output.
Definition: internal.h:54
LimiterDSPContext dsp
Definition: vf_limiter.c:45
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:51
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:600
#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:251
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:203
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
const uint8_t * src
Definition: vf_bm3d.c:56
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:441
const char * arg
Definition: jacosubdec.c:66
#define AV_PIX_FMT_GBRAP12
Definition: pixfmt.h:418
AVFILTER_DEFINE_CLASS(limiter)
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:400
#define AV_PIX_FMT_GBRAP16
Definition: pixfmt.h:419
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:395
static const struct @315 planes[]
#define AV_PIX_FMT_GBRP16
Definition: pixfmt.h:416
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:784
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:381
#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
#define AV_PIX_FMT_YUVA444P12
Definition: pixfmt.h:438
int height[4]
Definition: vf_limiter.c:43
AVFormatContext * ctx
Definition: movenc.c:48
#define AV_PIX_FMT_YUVA444P10
Definition: pixfmt.h:436
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:396
#define AV_PIX_FMT_GBRP14
Definition: pixfmt.h:415
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:408
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:405
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:595
Used for passing data between threads.
Definition: dsddec.c:67
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:331
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:380
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:397
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:403
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:394
static int query_formats(AVFilterContext *ctx)
Definition: vf_limiter.c:69
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:275
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:406
#define AV_PIX_FMT_GBRP12
Definition: pixfmt.h:414
#define flags(name, subs,...)
Definition: cbs_av1.c:564
AVFilterInternal * internal
An opaque struct for libavfilter internal use.
Definition: avfilter.h:378
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:398
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:404
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:314
#define FLAGS
Definition: vf_limiter.c:49
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:433
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:144
static int slice_end(AVCodecContext *avctx, AVFrame *pict)
Handle slice ends.
Definition: mpeg12dec.c:2043
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
const AVPixFmtDescriptor * desc
Definition: vf_tonemap.c:196
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
const void ** s
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:99
AVFrame * in
Definition: af_afftdn.c:1083
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
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
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:409
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:659
AVFrame * max
Definition: vf_threshold.c:75
#define AV_PIX_FMT_YUVA422P12
Definition: pixfmt.h:437
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58