FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavfilter/vf_limiter.c
Date: 2026-09-17 21:53:11
Exec Total Coverage
Lines: 0 88 0.0%
Functions: 0 7 0.0%
Branches: 0 70 0.0%

Line Branch Exec Source
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 "filters.h"
26 #include "limiter.h"
27 #include "video.h"
28
29 #define MAX_THREADS 64
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 int rets[MAX_THREADS];
46
47 LimiterDSPContext dsp;
48 } LimiterContext;
49
50 #define OFFSET(x) offsetof(LimiterContext, x)
51 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
52
53 static const AVOption limiter_options[] = {
54 { "min", "set min value", OFFSET(min), AV_OPT_TYPE_INT, {.i64=0}, -1, 65535, .flags = FLAGS, .unit = "value" },
55 { "max", "set max value", OFFSET(max), AV_OPT_TYPE_INT, {.i64=65535}, -1, 65535, .flags = FLAGS, .unit = "value" },
56 { "auto", "automatically use tagged signal range", 0, AV_OPT_TYPE_CONST, {.i64=-1}, .flags = FLAGS, .unit = "value" },
57 { "planes", "set planes", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=15}, 0, 15, .flags = FLAGS },
58 { NULL }
59 };
60
61 AVFILTER_DEFINE_CLASS(limiter);
62
63 static av_cold int init(AVFilterContext *ctx)
64 {
65 LimiterContext *s = ctx->priv;
66
67 if (s->min >= 0 && s->max >= 0 && s->min > s->max)
68 return AVERROR(EINVAL);
69 return 0;
70 }
71
72 static const enum AVPixelFormat pix_fmts[] = {
73 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
74 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
75 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
76 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
77 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
78 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
79 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
80 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
81 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
82 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
83 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
84 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
85 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
86 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
87 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
88 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
89 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
90 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
91 AV_PIX_FMT_NONE
92 };
93
94 #define LIMITER(n, type) \
95 static void limiter##n(const uint8_t *ssrc, uint8_t *ddst, \
96 ptrdiff_t slinesize, ptrdiff_t dlinesize,\
97 int w, int h, int min, int max) \
98 { \
99 const type *src = (const type *)ssrc; \
100 type *dst = (type *)ddst; \
101 \
102 dlinesize /= sizeof(type); \
103 slinesize /= sizeof(type); \
104 \
105 for (int y = 0; y < h; y++) { \
106 for (int 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 LIMITER(8, uint8_t)
116 LIMITER(16, uint16_t)
117
118 static int config_input(AVFilterLink *inlink)
119 {
120 AVFilterContext *ctx = inlink->dst;
121 LimiterContext *s = ctx->priv;
122 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
123 int depth, vsub, hsub, ret;
124
125 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
126
127 if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
128 return ret;
129
130 depth = desc->comp[0].depth;
131 hsub = desc->log2_chroma_w;
132 vsub = desc->log2_chroma_h;
133 s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
134 s->height[0] = s->height[3] = inlink->h;
135 s->width[1] = s->width[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
136 s->width[0] = s->width[3] = inlink->w;
137
138 s->max = FFMIN(s->max, (1 << depth) - 1);
139 s->min = FFMIN(s->min, (1 << depth) - 1);
140
141 if (depth == 8) {
142 s->dsp.limiter = limiter8;
143 } else {
144 s->dsp.limiter = limiter16;
145 }
146
147 #if ARCH_X86 && HAVE_X86ASM
148 ff_limiter_init_x86(&s->dsp, desc->comp[0].depth);
149 #endif
150
151 return 0;
152 }
153
154 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
155 {
156 LimiterContext *s = ctx->priv;
157 ThreadData *td = arg;
158 AVFrame *in = td->in;
159 AVFrame *out = td->out;
160 int p;
161
162 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(in->format);
163 const int depth = desc->comp[0].depth;
164 const int full_range = (1 << depth) - 1;
165 const int is_mpeg = in->color_range == AVCOL_RANGE_MPEG &&
166 !(desc->flags & AV_PIX_FMT_FLAG_RGB);
167
168 for (p = 0; p < s->nb_planes; p++) {
169 const int h = s->height[p];
170 const int slice_start = ff_slice_pos(h, jobnr, nb_jobs);
171 const int slice_end = ff_slice_pos(h, jobnr + 1, nb_jobs);
172 const int mpeg_min = 16 << (depth - 8);
173 const int mpeg_max = (p ? 240 : 235) << (depth - 8);
174
175 int min = s->min, max = s->max;
176 if (min < 0)
177 min = (is_mpeg && p != 3) ? mpeg_min : 0;
178 if (max < 0)
179 max = (is_mpeg && p != 3) ? mpeg_max : full_range;
180
181 if (!((1 << p) & s->planes) || (min == 0 && max == full_range)) {
182 if (out != in)
183 av_image_copy_plane(out->data[p] + slice_start * out->linesize[p],
184 out->linesize[p],
185 in->data[p] + slice_start * in->linesize[p],
186 in->linesize[p],
187 s->linesize[p], slice_end - slice_start);
188 continue;
189 }
190
191 /* check only after resolving no-op planes */
192 if (min > max)
193 return AVERROR(EINVAL);
194
195 s->dsp.limiter(in->data[p] + slice_start * in->linesize[p],
196 out->data[p] + slice_start * out->linesize[p],
197 in->linesize[p], out->linesize[p],
198 s->width[p], slice_end - slice_start,
199 min, max);
200 }
201
202 return 0;
203 }
204
205 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
206 {
207 AVFilterContext *ctx = inlink->dst;
208 LimiterContext *s = ctx->priv;
209 AVFilterLink *outlink = ctx->outputs[0];
210 ThreadData td;
211 AVFrame *out;
212
213 const int nb_jobs = FFMIN3(ff_filter_get_nb_threads(ctx),
214 MAX_THREADS, s->height[2]);
215
216 if (av_frame_is_writable(in)) {
217 out = in;
218 } else {
219 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
220 if (!out) {
221 av_frame_free(&in);
222 return AVERROR(ENOMEM);
223 }
224 av_frame_copy_props(out, in);
225 }
226
227 td.out = out;
228 td.in = in;
229 memset(s->rets, 0, sizeof(s->rets));
230 ff_filter_execute(ctx, filter_slice, &td, s->rets, nb_jobs);
231 if (out != in)
232 av_frame_free(&in);
233
234 for (int i = 0; i < nb_jobs; i++) {
235 if (s->rets[i] < 0) {
236 av_frame_free(&out);
237 return s->rets[i];
238 }
239 }
240
241 return ff_filter_frame(outlink, out);
242 }
243
244 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
245 char *res, int res_len, int flags)
246 {
247 int ret;
248
249 ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
250 if (ret < 0)
251 return ret;
252
253 return config_input(ctx->inputs[0]);
254 }
255
256 static const AVFilterPad inputs[] = {
257 {
258 .name = "default",
259 .type = AVMEDIA_TYPE_VIDEO,
260 .filter_frame = filter_frame,
261 .config_props = config_input,
262 },
263 };
264
265 const FFFilter ff_vf_limiter = {
266 .p.name = "limiter",
267 .p.description = NULL_IF_CONFIG_SMALL("Limit pixels components to the specified range."),
268 .p.priv_class = &limiter_class,
269 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
270 AVFILTER_FLAG_SLICE_THREADS,
271 .priv_size = sizeof(LimiterContext),
272 .init = init,
273 FILTER_INPUTS(inputs),
274 FILTER_OUTPUTS(ff_video_default_filterpad),
275 FILTER_PIXFMTS_ARRAY(pix_fmts),
276 .process_command = process_command,
277 };
278