FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavfilter/vf_yaepblur.c
Date: 2026-04-19 20:43:40
Exec Total Coverage
Lines: 0 83 0.0%
Functions: 0 8 0.0%
Branches: 0 48 0.0%
Line Branch Exec Source
1 /*
2 * Copyright (C) 2019 Leo Zhang <leozhang@qiyi.com>
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 /**
22 * @file
23 * yaep(yet another edge preserving) blur filter
24 *
25 * This implementation is based on an algorithm described in
26 * "J. S. Lee, Digital image enhancement and noise filtering by use of local statistics, IEEE Trans. Pattern
27 * Anal. Mach. Intell. PAMI-2, 1980."
28 */
29
30 #include "libavutil/mem.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/imgutils.h"
33 #include "avfilter.h"
34 #include "filters.h"
35 #include "video.h"
36
37 typedef struct YAEPContext {
38 const AVClass *class;
39
40 int planes;
41 int radius;
42 int sigma;
43
44 int nb_planes;
45 int planewidth[4];
46 int planeheight[4];
47 int depth;
48
49 uint64_t *sat; ///< summed area table
50 uint64_t *square_sat; ///< square summed area table
51 int sat_linesize;
52
53 int (*pre_calculate_row)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
54 int (*filter_slice )(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
55 } YAEPContext;
56
57 ✗ static av_cold void uninit(AVFilterContext *ctx)
58 {
59 ✗ YAEPContext *s = ctx->priv;
60 ✗ av_freep(&s->sat);
61 ✗ av_freep(&s->square_sat);
62 ✗ }
63
64 static const enum AVPixelFormat pix_fmts[] = {
65 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
66 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
67 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
68 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
69 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
70 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
71 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
72 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
73 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
74 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
75 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
76 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
77 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
78 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
79 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
80 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
81 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
82 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
83 AV_PIX_FMT_NONE
84 };
85
86 typedef struct ThreadData {
87 int width;
88 int height;
89 int src_linesize;
90 int dst_linesize;
91 uint8_t *src;
92 uint8_t *dst;
93 } ThreadData;
94
95 #define PRE_CALCULATE_ROW(type, name) \
96 static int pre_calculate_row_##name(AVFilterContext *ctx, void *arg, \
97 int jobnr, int nb_jobs) \
98 { \
99 ThreadData *td = arg; \
100 YAEPContext *s = ctx->priv; \
101 \
102 const int width = td->width; \
103 const int height = td->height; \
104 const int linesize = td->src_linesize / sizeof(type); \
105 const int sat_linesize = s->sat_linesize; \
106 \
107 const int starty = height * jobnr / nb_jobs; \
108 const int endy = height * (jobnr+1) / nb_jobs; \
109 \
110 uint64_t *sat = s->sat + (starty + 1) * sat_linesize; \
111 uint64_t *square_sat = s->square_sat + (starty + 1) * sat_linesize; \
112 const type *src = (const type *)td->src + starty * linesize; \
113 \
114 int x, y; \
115 \
116 for (y = starty; y < endy; y++) { \
117 for (x = 0; x < width; x++) { \
118 sat[x+1] = sat[x] + src[x]; \
119 square_sat[x+1] = square_sat[x] + (uint64_t)src[x] * src[x]; \
120 } \
121 sat += sat_linesize; \
122 square_sat += sat_linesize; \
123 src += linesize; \
124 } \
125 \
126 return 0; \
127 }
128
129 ✗ PRE_CALCULATE_ROW(uint8_t, byte)
130 ✗ PRE_CALCULATE_ROW(uint16_t, word)
131
132 ✗ static int pre_calculate_col(AVFilterContext *ctx, void *arg,
133 int jobnr, int nb_jobs)
134 {
135 ✗ ThreadData *td = arg;
136 ✗ YAEPContext *s = ctx->priv;
137
138 ✗ const int width = td->width;
139 ✗ const int height = td->height;
140 ✗ const int sat_linesize = s->sat_linesize;
141
142 ✗ const int startx = width * jobnr / nb_jobs;
143 ✗ const int endx = width * (jobnr + 1) / nb_jobs;
144
145 uint64_t *sat, *square_sat;
146 int x, y;
147
148 ✗ for (x = startx; x < endx; x++) {
149 ✗ sat = s->sat + x + 1;
150 ✗ square_sat = s->square_sat + x + 1;
151 ✗ for (y = 0; y < height; y++) {
152 ✗ *(sat+sat_linesize) += *sat;
153 ✗ *(square_sat+sat_linesize) += *square_sat;
154 ✗ sat += sat_linesize;
155 ✗ square_sat += sat_linesize;
156 }
157 }
158
159 ✗ return 0;
160 }
161
162 #define FILTER_SLICE(type, name) \
163 static int filter_slice_##name(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs) \
164 { \
165 ThreadData *td = arg; \
166 YAEPContext *s = ctx->priv; \
167 \
168 const int width = td->width; \
169 const int height = td->height; \
170 const int src_linesize = td->src_linesize / sizeof(type); \
171 const int dst_linesize = td->dst_linesize / sizeof(type); \
172 const int sat_linesize = s->sat_linesize; \
173 const int sigma = s->sigma; \
174 const int radius = s->radius; \
175 \
176 uint64_t *sat = s->sat; \
177 uint64_t *square_sat = s->square_sat; \
178 const type *src = (const type *)td->src; \
179 type *dst = (type *)td->dst; \
180 \
181 const int starty = height * jobnr / nb_jobs; \
182 const int endy = height * (jobnr + 1) / nb_jobs; \
183 \
184 int x, y; \
185 int lower_x, higher_x; \
186 int lower_y, higher_y; \
187 int dist_y, count; \
188 uint64_t sum, square_sum, mean, var; \
189 \
190 for (y = starty; y < endy; y++) { \
191 lower_y = y - radius < 0 ? 0 : y - radius; \
192 higher_y = y + radius + 1 > height ? height : y + radius + 1; \
193 dist_y = higher_y - lower_y; \
194 for (x = 0; x < width; x++) { \
195 lower_x = x - radius < 0 ? 0 : x - radius; \
196 higher_x = x + radius + 1 > width ? width : x + radius + 1; \
197 count = dist_y * (higher_x - lower_x); \
198 sum = sat[higher_y * sat_linesize + higher_x] \
199 - sat[higher_y * sat_linesize + lower_x] \
200 - sat[lower_y * sat_linesize + higher_x] \
201 + sat[lower_y * sat_linesize + lower_x]; \
202 square_sum = square_sat[higher_y * sat_linesize + higher_x] \
203 - square_sat[higher_y * sat_linesize + lower_x] \
204 - square_sat[lower_y * sat_linesize + higher_x] \
205 + square_sat[lower_y * sat_linesize + lower_x]; \
206 mean = sum / count; \
207 var = (square_sum - sum * sum / count) / count; \
208 dst[y * dst_linesize + x] = (sigma * mean + var * src[y * src_linesize + x]) / (sigma + var); \
209 } \
210 } \
211 return 0; \
212 }
213
214 ✗ FILTER_SLICE(uint8_t, byte)
215 ✗ FILTER_SLICE(uint16_t, word)
216
217 ✗ static int filter_frame(AVFilterLink *inlink, AVFrame *in)
218 {
219 ✗ AVFilterContext *ctx = inlink->dst;
220 ✗ YAEPContext *s = ctx->priv;
221 ✗ AVFilterLink *outlink = ctx->outputs[0];
222 AVFrame *out;
223 int plane;
224 ✗ const int nb_threads = ff_filter_get_nb_threads(ctx);
225 ThreadData td;
226
227 ✗ if (av_frame_is_writable(in)) {
228 ✗ out = in;
229 } else {
230 ✗ out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
231 ✗ if (!out) {
232 ✗ av_frame_free(&in);
233 ✗ return AVERROR(ENOMEM);
234 }
235 ✗ av_frame_copy_props(out, in);
236 }
237
238 ✗ for (plane = 0; plane < s->nb_planes; plane++) {
239 ✗ if (!s->radius || !(s->planes & (1<<plane))) {
240 ✗ if (out != in) {
241 ✗ av_image_copy_plane(out->data[plane], out->linesize[plane],
242 ✗ in->data[plane], in->linesize[plane],
243 ✗ s->planewidth[plane] * ((s->depth + 7) / 8),
244 s->planeheight[plane]);
245 }
246 ✗ continue;
247 }
248
249 ✗ td.width = s->planewidth[plane];
250 ✗ td.height = s->planeheight[plane];
251 ✗ td.src = in->data[plane];
252 ✗ td.src_linesize = in->linesize[plane];
253 ✗ ff_filter_execute(ctx, s->pre_calculate_row, &td, NULL,
254 ✗ FFMIN(td.height, nb_threads));
255 ✗ ff_filter_execute(ctx, pre_calculate_col, &td, NULL,
256 ✗ FFMIN(td.width, nb_threads));
257
258 ✗ td.dst = out->data[plane];
259 ✗ td.dst_linesize = out->linesize[plane];
260 ✗ ff_filter_execute(ctx, s->filter_slice, &td, NULL,
261 ✗ FFMIN(td.height, nb_threads));
262 }
263
264 ✗ if (out != in)
265 ✗ av_frame_free(&in);
266
267 ✗ return ff_filter_frame(outlink, out);
268 }
269
270 ✗ static int config_input(AVFilterLink *inlink)
271 {
272 ✗ YAEPContext *s = inlink->dst->priv;
273 ✗ const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
274
275 ✗ s->depth = desc->comp[0].depth;
276 ✗ s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
277 ✗ s->planewidth[0] = s->planewidth[3] = inlink->w;
278 ✗ s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
279 ✗ s->planeheight[0] = s->planeheight[3] = inlink->h;
280 ✗ s->nb_planes = av_pix_fmt_count_planes(inlink->format);
281
282 ✗ s->radius = FFMIN(s->radius, AV_CEIL_RSHIFT(FFMIN(inlink->w, inlink->h), 1));
283
284 ✗ if (s->depth <= 8) {
285 ✗ s->pre_calculate_row = pre_calculate_row_byte;
286 ✗ s->filter_slice = filter_slice_byte;
287 } else {
288 ✗ s->pre_calculate_row = pre_calculate_row_word;
289 ✗ s->filter_slice = filter_slice_word;
290 }
291
292 // padding one row on the top, and padding one col on the left, that is why + 1 below
293 ✗ s->sat_linesize = inlink->w + 1;
294 ✗ s->sat = av_calloc(inlink->h + 1, s->sat_linesize * sizeof(*s->sat));
295 ✗ if (!s->sat)
296 ✗ return AVERROR(ENOMEM);
297
298 ✗ s->square_sat = av_calloc(inlink->h + 1, s->sat_linesize * sizeof(*s->square_sat));
299 ✗ if (!s->square_sat)
300 ✗ return AVERROR(ENOMEM);
301
302 ✗ return 0;
303 }
304
305 static const AVFilterPad yaep_inputs[] = {
306 {
307 .name = "default",
308 .type = AVMEDIA_TYPE_VIDEO,
309 .config_props = config_input,
310 .filter_frame = filter_frame,
311 },
312 };
313
314 #define OFFSET(x) offsetof(YAEPContext, x)
315 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
316
317 static const AVOption yaepblur_options[] = {
318 { "radius", "set window radius", OFFSET(radius), AV_OPT_TYPE_INT, {.i64=3}, 0, INT_MAX, .flags=FLAGS },
319 { "r" , "set window radius", OFFSET(radius), AV_OPT_TYPE_INT, {.i64=3}, 0, INT_MAX, .flags=FLAGS },
320 { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=1}, 0, 0xF, .flags=FLAGS },
321 { "p", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=1}, 0, 0xF, .flags=FLAGS },
322 { "sigma", "set blur strength", OFFSET(sigma), AV_OPT_TYPE_INT, {.i64=128}, 1, INT_MAX, .flags=FLAGS },
323 { "s", "set blur strength", OFFSET(sigma), AV_OPT_TYPE_INT, {.i64=128}, 1, INT_MAX, .flags=FLAGS },
324 { NULL }
325 };
326
327 AVFILTER_DEFINE_CLASS(yaepblur);
328
329 const FFFilter ff_vf_yaepblur = {
330 .p.name = "yaepblur",
331 .p.description = NULL_IF_CONFIG_SMALL("Yet another edge preserving blur filter."),
332 .p.priv_class = &yaepblur_class,
333 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
334 .priv_size = sizeof(YAEPContext),
335 .uninit = uninit,
336 FILTER_INPUTS(yaep_inputs),
337 FILTER_OUTPUTS(ff_video_default_filterpad),
338 FILTER_PIXFMTS_ARRAY(pix_fmts),
339 .process_command = ff_filter_process_command,
340 };
341