FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavfilter/vf_vignette.c
Date: 2026-04-30 23:37:26
Exec Total Coverage
Lines: 0 140 0.0%
Functions: 0 7 0.0%
Branches: 0 80 0.0%
Line Branch Exec Source
1 /*
2 * Copyright (c) 2013 Clément Bœsch
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 <float.h> /* DBL_MAX */
22
23 #include "libavutil/mem.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/eval.h"
26 #include "libavutil/pixdesc.h"
27 #include "avfilter.h"
28 #include "filters.h"
29 #include "video.h"
30
31 static const char *const var_names[] = {
32 "w", // stream width
33 "h", // stream height
34 "n", // frame count
35 "pts", // presentation timestamp expressed in AV_TIME_BASE units
36 "r", // frame rate
37 "t", // timestamp expressed in seconds
38 "tb", // timebase
39 NULL
40 };
41
42 enum var_name {
43 VAR_W,
44 VAR_H,
45 VAR_N,
46 VAR_PTS,
47 VAR_R,
48 VAR_T,
49 VAR_TB,
50 VAR_NB
51 };
52
53 enum EvalMode {
54 EVAL_MODE_INIT,
55 EVAL_MODE_FRAME,
56 EVAL_MODE_NB
57 };
58
59 typedef struct VignetteContext {
60 const AVClass *class;
61 const AVPixFmtDescriptor *desc;
62 int backward;
63 int eval_mode; ///< EvalMode
64 #define DEF_EXPR_FIELDS(name) AVExpr *name##_pexpr; char *name##_expr; double name
65 DEF_EXPR_FIELDS(angle);
66 DEF_EXPR_FIELDS(x0);
67 DEF_EXPR_FIELDS(y0);
68 double var_values[VAR_NB];
69 float *fmap;
70 int fmap_linesize;
71 double dmax;
72 float xscale, yscale;
73 uint32_t dither;
74 int do_dither;
75 AVRational aspect;
76 AVRational scale;
77 } VignetteContext;
78
79 #define OFFSET(x) offsetof(VignetteContext, x)
80 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
81 static const AVOption vignette_options[] = {
82 { "angle", "set lens angle", OFFSET(angle_expr), AV_OPT_TYPE_STRING, {.str="PI/5"}, .flags = FLAGS },
83 { "a", "set lens angle", OFFSET(angle_expr), AV_OPT_TYPE_STRING, {.str="PI/5"}, .flags = FLAGS },
84 { "x0", "set circle center position on x-axis", OFFSET(x0_expr), AV_OPT_TYPE_STRING, {.str="w/2"}, .flags = FLAGS },
85 { "y0", "set circle center position on y-axis", OFFSET(y0_expr), AV_OPT_TYPE_STRING, {.str="h/2"}, .flags = FLAGS },
86 { "mode", "set forward/backward mode", OFFSET(backward), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, FLAGS, .unit = "mode" },
87 { "forward", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 0}, INT_MIN, INT_MAX, FLAGS, .unit = "mode"},
88 { "backward", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 1}, INT_MIN, INT_MAX, FLAGS, .unit = "mode"},
89 { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_INIT}, 0, EVAL_MODE_NB-1, FLAGS, .unit = "eval" },
90 { "init", "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT}, .flags = FLAGS, .unit = "eval" },
91 { "frame", "eval expressions for each frame", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
92 { "dither", "set dithering", OFFSET(do_dither), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, FLAGS },
93 { "aspect", "set aspect ratio", OFFSET(aspect), AV_OPT_TYPE_RATIONAL, {.dbl = 1}, 0, DBL_MAX, .flags = FLAGS },
94 { NULL }
95 };
96
97 AVFILTER_DEFINE_CLASS(vignette);
98
99 ✗ static av_cold int init(AVFilterContext *ctx)
100 {
101 ✗ VignetteContext *s = ctx->priv;
102
103 #define PARSE_EXPR(name) do { \
104 int ret = av_expr_parse(&s->name##_pexpr, s->name##_expr, var_names, \
105 NULL, NULL, NULL, NULL, 0, ctx); \
106 if (ret < 0) { \
107 av_log(ctx, AV_LOG_ERROR, "Unable to parse expression for '" \
108 AV_STRINGIFY(name) "'\n"); \
109 return ret; \
110 } \
111 } while (0)
112
113 ✗ PARSE_EXPR(angle);
114 ✗ PARSE_EXPR(x0);
115 ✗ PARSE_EXPR(y0);
116 ✗ return 0;
117 }
118
119 ✗ static av_cold void uninit(AVFilterContext *ctx)
120 {
121 ✗ VignetteContext *s = ctx->priv;
122 ✗ av_freep(&s->fmap);
123 ✗ av_expr_free(s->angle_pexpr);
124 ✗ av_expr_free(s->x0_pexpr);
125 ✗ av_expr_free(s->y0_pexpr);
126 ✗ }
127
128 static const enum AVPixelFormat pix_fmts[] = {
129 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P,
130 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV411P,
131 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
132 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
133 AV_PIX_FMT_GRAY8,
134 AV_PIX_FMT_NONE
135 };
136
137 ✗ static double get_natural_factor(const VignetteContext *s, int x, int y)
138 {
139 ✗ const int xx = (x - s->x0) * s->xscale;
140 ✗ const int yy = (y - s->y0) * s->yscale;
141 ✗ const double dnorm = hypot(xx, yy) / s->dmax;
142 ✗ if (dnorm > 1) {
143 ✗ return 0;
144 } else {
145 ✗ const double c = cos(s->angle * dnorm);
146 ✗ return (c*c)*(c*c); // do not remove braces, it helps compilers
147 }
148 }
149
150 ✗ static void update_context(VignetteContext *s, AVFilterLink *inlink, AVFrame *frame)
151 {
152 ✗ FilterLink *inl = ff_filter_link(inlink);
153 int x, y;
154 ✗ float *dst = s->fmap;
155 ✗ int dst_linesize = s->fmap_linesize;
156
157 ✗ if (frame) {
158 ✗ s->var_values[VAR_N] = inl->frame_count_out;
159 ✗ s->var_values[VAR_T] = TS2T(frame->pts, inlink->time_base);
160 ✗ s->var_values[VAR_PTS] = TS2D(frame->pts);
161 } else {
162 ✗ s->var_values[VAR_N] = NAN;
163 ✗ s->var_values[VAR_T] = NAN;
164 ✗ s->var_values[VAR_PTS] = NAN;
165 }
166
167 ✗ s->angle = av_expr_eval(s->angle_pexpr, s->var_values, NULL);
168 ✗ s->x0 = av_expr_eval(s->x0_pexpr, s->var_values, NULL);
169 ✗ s->y0 = av_expr_eval(s->y0_pexpr, s->var_values, NULL);
170
171 ✗ if (isnan(s->x0) || isnan(s->y0) || isnan(s->angle))
172 ✗ s->eval_mode = EVAL_MODE_FRAME;
173
174 ✗ s->angle = av_clipf(s->angle, 0, M_PI_2);
175
176 ✗ if (s->backward) {
177 ✗ for (y = 0; y < inlink->h; y++) {
178 ✗ for (x = 0; x < inlink->w; x++)
179 ✗ dst[x] = 1. / get_natural_factor(s, x, y);
180 ✗ dst += dst_linesize;
181 }
182 } else {
183 ✗ for (y = 0; y < inlink->h; y++) {
184 ✗ for (x = 0; x < inlink->w; x++)
185 ✗ dst[x] = get_natural_factor(s, x, y);
186 ✗ dst += dst_linesize;
187 }
188 }
189 ✗ }
190
191 ✗ static inline double get_dither_value(VignetteContext *s)
192 {
193 ✗ double dv = 0;
194 ✗ if (s->do_dither) {
195 ✗ dv = s->dither / (double)(1LL<<32);
196 ✗ s->dither = s->dither * 1664525 + 1013904223;
197 }
198 ✗ return dv;
199 }
200
201 ✗ static int filter_frame(AVFilterLink *inlink, AVFrame *in)
202 {
203 ✗ unsigned x, y, direct = 0;
204 ✗ AVFilterContext *ctx = inlink->dst;
205 ✗ VignetteContext *s = ctx->priv;
206 ✗ AVFilterLink *outlink = ctx->outputs[0];
207 AVFrame *out;
208
209 ✗ if (av_frame_is_writable(in)) {
210 ✗ direct = 1;
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 ✗ if (s->eval_mode == EVAL_MODE_FRAME)
222 ✗ update_context(s, inlink, in);
223
224 ✗ if (s->desc->flags & AV_PIX_FMT_FLAG_RGB) {
225 ✗ uint8_t *dst = out->data[0];
226 ✗ const uint8_t *src = in ->data[0];
227 ✗ const float *fmap = s->fmap;
228 ✗ const int dst_linesize = out->linesize[0];
229 ✗ const int src_linesize = in ->linesize[0];
230 ✗ const int fmap_linesize = s->fmap_linesize;
231
232 ✗ for (y = 0; y < inlink->h; y++) {
233 ✗ uint8_t *dstp = dst;
234 ✗ const uint8_t *srcp = src;
235
236 ✗ for (x = 0; x < inlink->w; x++, dstp += 3, srcp += 3) {
237 ✗ const float f = fmap[x];
238
239 ✗ dstp[0] = av_clip_uint8(srcp[0] * f + get_dither_value(s));
240 ✗ dstp[1] = av_clip_uint8(srcp[1] * f + get_dither_value(s));
241 ✗ dstp[2] = av_clip_uint8(srcp[2] * f + get_dither_value(s));
242 }
243 ✗ dst += dst_linesize;
244 ✗ src += src_linesize;
245 ✗ fmap += fmap_linesize;
246 }
247 } else {
248 int plane;
249
250 ✗ for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
251 ✗ uint8_t *dst = out->data[plane];
252 ✗ const uint8_t *src = in ->data[plane];
253 ✗ const float *fmap = s->fmap;
254 ✗ const int dst_linesize = out->linesize[plane];
255 ✗ const int src_linesize = in ->linesize[plane];
256 ✗ const int fmap_linesize = s->fmap_linesize;
257 ✗ const int chroma = plane == 1 || plane == 2;
258 ✗ const int hsub = chroma ? s->desc->log2_chroma_w : 0;
259 ✗ const int vsub = chroma ? s->desc->log2_chroma_h : 0;
260 ✗ const int w = AV_CEIL_RSHIFT(inlink->w, hsub);
261 ✗ const int h = AV_CEIL_RSHIFT(inlink->h, vsub);
262
263 ✗ for (y = 0; y < h; y++) {
264 ✗ uint8_t *dstp = dst;
265 ✗ const uint8_t *srcp = src;
266
267 ✗ for (x = 0; x < w; x++) {
268 ✗ const double dv = get_dither_value(s);
269 ✗ if (chroma) *dstp++ = av_clip_uint8(fmap[x << hsub] * (*srcp++ - 127) + 127 + dv);
270 ✗ else *dstp++ = av_clip_uint8(fmap[x ] * *srcp++ + dv);
271 }
272 ✗ dst += dst_linesize;
273 ✗ src += src_linesize;
274 ✗ fmap += fmap_linesize << vsub;
275 }
276 }
277 }
278
279 ✗ if (!direct)
280 ✗ av_frame_free(&in);
281 ✗ return ff_filter_frame(outlink, out);
282 }
283
284 ✗ static int config_props(AVFilterLink *inlink)
285 {
286 ✗ AVFilterContext * ctx = inlink->dst;
287 ✗ VignetteContext *s = ctx->priv;
288 ✗ FilterLink *l = ff_filter_link(inlink);
289 ✗ AVRational sar = inlink->sample_aspect_ratio;
290
291 ✗ s->desc = av_pix_fmt_desc_get(inlink->format);
292 ✗ s->var_values[VAR_W] = inlink->w;
293 ✗ s->var_values[VAR_H] = inlink->h;
294 ✗ s->var_values[VAR_TB] = av_q2d(inlink->time_base);
295 ✗ s->var_values[VAR_R] = l->frame_rate.num == 0 || l->frame_rate.den == 0 ?
296 ✗ NAN : av_q2d(l->frame_rate);
297
298 ✗ if (!sar.num || !sar.den)
299 ✗ sar.num = sar.den = 1;
300 ✗ if (sar.num > sar.den) {
301 ✗ s->xscale = av_q2d(av_div_q(sar, s->aspect));
302 ✗ s->yscale = 1;
303 } else {
304 ✗ s->yscale = av_q2d(av_div_q(s->aspect, sar));
305 ✗ s->xscale = 1;
306 }
307 ✗ s->dmax = hypot(inlink->w / 2., inlink->h / 2.);
308 ✗ av_log(ctx, AV_LOG_DEBUG, "xscale=%f yscale=%f dmax=%f\n",
309 ✗ s->xscale, s->yscale, s->dmax);
310
311 ✗ s->fmap_linesize = FFALIGN(inlink->w, 32);
312 ✗ s->fmap = av_malloc_array(s->fmap_linesize, inlink->h * sizeof(*s->fmap));
313 ✗ if (!s->fmap)
314 ✗ return AVERROR(ENOMEM);
315
316 ✗ if (s->eval_mode == EVAL_MODE_INIT)
317 ✗ update_context(s, inlink, NULL);
318
319 ✗ return 0;
320 }
321
322 static const AVFilterPad vignette_inputs[] = {
323 {
324 .name = "default",
325 .type = AVMEDIA_TYPE_VIDEO,
326 .filter_frame = filter_frame,
327 .config_props = config_props,
328 },
329 };
330
331 const FFFilter ff_vf_vignette = {
332 .p.name = "vignette",
333 .p.description = NULL_IF_CONFIG_SMALL("Make or reverse a vignette effect."),
334 .p.priv_class = &vignette_class,
335 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
336 .priv_size = sizeof(VignetteContext),
337 .init = init,
338 .uninit = uninit,
339 FILTER_INPUTS(vignette_inputs),
340 FILTER_OUTPUTS(ff_video_default_filterpad),
341 FILTER_PIXFMTS_ARRAY(pix_fmts),
342 };
343