FFmpeg coverage


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