FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavfilter/vf_blurdetect.c
Date: 2024-07-26 21:54:09
Exec Total Coverage
Lines: 142 146 97.3%
Functions: 7 8 87.5%
Branches: 66 127 52.0%
Line Branch Exec Source
1 /*
2 * Copyright (c) 2021 Thilo Borgmann <thilo.borgmann _at_ mail.de>
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 * No-reference blurdetect filter
24 *
25 * Implementing:
26 * Marziliano, Pina, et al. "A no-reference perceptual blur metric." Proceedings.
27 * International conference on image processing. Vol. 3. IEEE, 2002.
28 * https://infoscience.epfl.ch/record/111802/files/14%20A%20no-reference%20perceptual%20blur%20metric.pdf
29 *
30 * @author Thilo Borgmann <thilo.borgmann _at_ mail.de>
31 */
32
33 #include "libavutil/mem.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/pixdesc.h"
36 #include "libavutil/qsort.h"
37 #include "internal.h"
38 #include "edge_common.h"
39 #include "video.h"
40
41 ✗ static int comp(const float *a,const float *b)
42 {
43 ✗ return FFDIFFSIGN(*a, *b);
44 }
45
46 typedef struct BLRContext {
47 const AVClass *class;
48
49 int hsub, vsub;
50 int nb_planes;
51
52 float low, high;
53 uint8_t low_u8, high_u8;
54 int radius; // radius during local maxima detection
55 int block_pct; // percentage of "sharpest" blocks in the image to use for bluriness calculation
56 int block_width; // width for block abbreviation
57 int block_height; // height for block abbreviation
58 int planes; // number of planes to filter
59
60 double blur_total;
61 uint64_t nb_frames;
62
63 float *blks;
64 uint8_t *filterbuf;
65 uint8_t *tmpbuf;
66 uint16_t *gradients;
67 int8_t *directions;
68 } BLRContext;
69
70 #define OFFSET(x) offsetof(BLRContext, x)
71 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
72 static const AVOption blurdetect_options[] = {
73 { "high", "set high threshold", OFFSET(high), AV_OPT_TYPE_FLOAT, {.dbl=30/255.}, 0, 1, FLAGS },
74 { "low", "set low threshold", OFFSET(low), AV_OPT_TYPE_FLOAT, {.dbl=15/255.}, 0, 1, FLAGS },
75 { "radius", "search radius for maxima detection", OFFSET(radius), AV_OPT_TYPE_INT, {.i64=50}, 1, 100, FLAGS },
76 { "block_pct", "block pooling threshold when calculating blurriness", OFFSET(block_pct), AV_OPT_TYPE_INT, {.i64=80}, 1, 100, FLAGS },
77 { "block_width", "block size for block-based abbreviation of blurriness", OFFSET(block_width), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, FLAGS },
78 { "block_height", "block size for block-based abbreviation of blurriness", OFFSET(block_height), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, FLAGS },
79 { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=1}, 0, 15, FLAGS },
80 { NULL }
81 };
82
83 AVFILTER_DEFINE_CLASS(blurdetect);
84
85 2 static av_cold int blurdetect_init(AVFilterContext *ctx)
86 {
87 2 BLRContext *s = ctx->priv;
88
89 2 s->low_u8 = s->low * 255. + .5;
90 2 s->high_u8 = s->high * 255. + .5;
91
92 2 return 0;
93 }
94
95 1 static int blurdetect_config_input(AVFilterLink *inlink)
96 {
97 1 AVFilterContext *ctx = inlink->dst;
98 1 BLRContext *s = ctx->priv;
99 1 const int bufsize = inlink->w * inlink->h;
100 const AVPixFmtDescriptor *pix_desc;
101
102 1 pix_desc = av_pix_fmt_desc_get(inlink->format);
103 1 s->hsub = pix_desc->log2_chroma_w;
104 1 s->vsub = pix_desc->log2_chroma_h;
105 1 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
106
107
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 1 if (s->block_width < 1 || s->block_height < 1) {
108 1 s->block_width = inlink->w;
109 1 s->block_height = inlink->h;
110 }
111
112 1 s->tmpbuf = av_malloc(bufsize);
113 1 s->filterbuf = av_malloc(bufsize);
114 1 s->gradients = av_calloc(bufsize, sizeof(*s->gradients));
115 1 s->directions = av_malloc(bufsize);
116 1 s->blks = av_calloc((inlink->w / s->block_width) * (inlink->h / s->block_height),
117 sizeof(*s->blks));
118
119
5/10
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 1 times.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 1 times.
 1 if (!s->tmpbuf || !s->filterbuf || !s->gradients || !s->directions || !s->blks)
120 ✗ return AVERROR(ENOMEM);
121
122 1 return 0;
123 }
124
125 // edge width is defined as the distance between surrounding maxima of the edge pixel
126 9475 static float edge_width(BLRContext *blr, int i, int j, int8_t dir, int w, int h,
127 int edge, const uint8_t *src, int src_linesize)
128 {
129 9475 float width = 0;
130 int dX, dY;
131 int sign;
132 int tmp;
133 int p1;
134 int p2;
135 int k, x, y;
136 9475 int radius = blr->radius;
137
138
4/5
✓ Branch 0 taken 2344 times.
✓ Branch 1 taken 3412 times.
✓ Branch 2 taken 1970 times.
✓ Branch 3 taken 1749 times.
✗ Branch 4 not taken.
 9475 switch(dir) {
139 2344 case DIRECTION_HORIZONTAL: dX = 1; dY = 0; break;
140 3412 case DIRECTION_VERTICAL: dX = 0; dY = 1; break;
141 1970 case DIRECTION_45UP: dX = 1; dY = -1; break;
142 1749 case DIRECTION_45DOWN: dX = 1; dY = 1; break;
143 ✗ default: dX = 1; dY = 1; break;
144 }
145
146 // determines if search in direction dX/dY is looking for a maximum or minimum
147
2/2
✓ Branch 0 taken 4985 times.
✓ Branch 1 taken 4490 times.
 9475 sign = src[j * src_linesize + i] > src[(j - dY) * src_linesize + i - dX] ? 1 : -1;
148
149 // search in -(dX/dY) direction
150
1/2
✓ Branch 0 taken 34427 times.
✗ Branch 1 not taken.
 34427 for (k = 0; k < radius; k++) {
151 34427 x = i - k*dX;
152 34427 y = j - k*dY;
153 34427 p1 = y * src_linesize + x;
154 34427 x -= dX;
155 34427 y -= dY;
156 34427 p2 = y * src_linesize + x;
157
5/8
✓ Branch 0 taken 34426 times.
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 34426 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 34426 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 34426 times.
 34427 if (x < 0 || x >= w || y < 0 || y >= h)
158 1 return 0;
159
160 34426 tmp = (src[p1] - src[p2]) * sign;
161
162
2/2
✓ Branch 0 taken 9474 times.
✓ Branch 1 taken 24952 times.
 34426 if (tmp <= 0) // local maximum found
163 9474 break;
164 }
165 9474 width += k;
166
167 // search in +(dX/dY) direction
168
1/2
✓ Branch 0 taken 34177 times.
✗ Branch 1 not taken.
 34177 for (k = 0; k < radius; k++) {
169 34177 x = i + k * dX;
170 34177 y = j + k * dY;
171 34177 p1 = y * src_linesize + x;
172 34177 x += dX;
173 34177 y += dY;
174 34177 p2 = y * src_linesize + x;
175
5/8
✓ Branch 0 taken 34177 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 34177 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 34167 times.
✓ Branch 5 taken 10 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 34167 times.
 34177 if (x < 0 || x >= w || y < 0 || y >= h)
176 10 return 0;
177
178 34167 tmp = (src[p1] - src[p2]) * sign;
179
180
2/2
✓ Branch 0 taken 9464 times.
✓ Branch 1 taken 24703 times.
 34167 if (tmp >= 0) // local maximum found
181 9464 break;
182 }
183 9464 width += k;
184
185 // for 45 degree directions approximate edge width in pixel units: 0.7 ~= sqrt(2)/2
186
4/4
✓ Branch 0 taken 7504 times.
✓ Branch 1 taken 1960 times.
✓ Branch 2 taken 1748 times.
✓ Branch 3 taken 5756 times.
 9464 if (dir == DIRECTION_45UP || dir == DIRECTION_45DOWN)
187 3708 width *= 0.7;
188
189 9464 return width;
190 }
191
192 5 static float calculate_blur(BLRContext *s, int w, int h, int hsub, int vsub,
193 int8_t* dir, int dir_linesize,
194 uint8_t* dst, int dst_linesize,
195 uint8_t* src, int src_linesize)
196 {
197 5 float total_width = 0.0;
198 int block_count;
199 double block_total_width;
200
201 int i, j;
202 5 int blkcnt = 0;
203
204 5 float *blks = s->blks;
205 5 float block_pool_threshold = s->block_pct / 100.0;
206
207 5 int block_width = AV_CEIL_RSHIFT(s->block_width, hsub);
208 5 int block_height = AV_CEIL_RSHIFT(s->block_height, vsub);
209 5 int brows = h / block_height;
210 5 int bcols = w / block_width;
211
212
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 5 times.
 10 for (int blkj = 0; blkj < brows; blkj++) {
213
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 5 times.
 10 for (int blki = 0; blki < bcols; blki++) {
214 5 block_total_width = 0.0;
215 5 block_count = 0;
216
2/2
✓ Branch 0 taken 1000 times.
✓ Branch 1 taken 5 times.
 1005 for (int inj = 0; inj < block_height; inj++) {
217
2/2
✓ Branch 0 taken 300000 times.
✓ Branch 1 taken 1000 times.
 301000 for (int ini = 0; ini < block_width; ini++) {
218 300000 i = blki * block_width + ini;
219 300000 j = blkj * block_height + inj;
220
221
2/2
✓ Branch 0 taken 9475 times.
✓ Branch 1 taken 290525 times.
 300000 if (dst[j * dst_linesize + i] > 0) {
222 9475 float width = edge_width(s, i, j, dir[j*dir_linesize+i],
223 9475 w, h, dst[j*dst_linesize+i],
224 src, src_linesize);
225
2/2
✓ Branch 0 taken 9455 times.
✓ Branch 1 taken 20 times.
 9475 if (width > 0.001) { // throw away zeros
226 9455 block_count++;
227 9455 block_total_width += width;
228 }
229 }
230 }
231 }
232 // if not enough edge pixels in a block, consider it smooth
233
2/4
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
 5 if (block_total_width >= 2 && block_count) {
234 5 blks[blkcnt] = block_total_width / block_count;
235 5 blkcnt++;
236 }
237 }
238 }
239
240 // simple block pooling by sorting and keeping the sharper blocks
241
3/44
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 12 not taken.
✗ Branch 13 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
✗ Branch 16 not taken.
✗ Branch 17 not taken.
✗ Branch 19 not taken.
✗ Branch 20 not taken.
✗ Branch 21 not taken.
✗ Branch 22 not taken.
✗ Branch 24 not taken.
✗ Branch 25 not taken.
✗ Branch 26 not taken.
✗ Branch 27 not taken.
✗ Branch 28 not taken.
✗ Branch 29 not taken.
✗ Branch 30 not taken.
✗ Branch 31 not taken.
✗ Branch 32 not taken.
✗ Branch 33 not taken.
✗ Branch 34 not taken.
✗ Branch 35 not taken.
✗ Branch 36 not taken.
✗ Branch 37 not taken.
✗ Branch 39 not taken.
✗ Branch 40 not taken.
✗ Branch 41 not taken.
✗ Branch 42 not taken.
✗ Branch 43 not taken.
✗ Branch 44 not taken.
✗ Branch 46 not taken.
✗ Branch 47 not taken.
✗ Branch 48 not taken.
✓ Branch 49 taken 5 times.
✓ Branch 50 taken 5 times.
✓ Branch 51 taken 5 times.
 10 AV_QSORT(blks, blkcnt, float, comp);
242 5 blkcnt = ceil(blkcnt * block_pool_threshold);
243
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 5 times.
 10 for (int i = 0; i < blkcnt; i++) {
244 5 total_width += blks[i];
245 }
246
247 5 return total_width / blkcnt;
248 }
249
250 5 static void set_meta(AVDictionary **metadata, const char *key, float d)
251 {
252 char value[128];
253 5 snprintf(value, sizeof(value), "%f", d);
254 5 av_dict_set(metadata, key, value, 0);
255 5 }
256
257 5 static int blurdetect_filter_frame(AVFilterLink *inlink, AVFrame *in)
258 {
259 5 AVFilterContext *ctx = inlink->dst;
260 5 BLRContext *s = ctx->priv;
261 5 AVFilterLink *outlink = ctx->outputs[0];
262
263 5 const int inw = inlink->w;
264 5 const int inh = inlink->h;
265
266 5 uint8_t *tmpbuf = s->tmpbuf;
267 5 uint8_t *filterbuf = s->filterbuf;
268 5 uint16_t *gradients = s->gradients;
269 5 int8_t *directions = s->directions;
270
271 5 float blur = 0.0f;
272 5 int nplanes = 0;
273 AVDictionary **metadata;
274 5 metadata = &in->metadata;
275
276
2/2
✓ Branch 0 taken 15 times.
✓ Branch 1 taken 5 times.
 20 for (int plane = 0; plane < s->nb_planes; plane++) {
277
4/4
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 5 times.
✓ Branch 2 taken 5 times.
✓ Branch 3 taken 5 times.
 15 int hsub = plane == 1 || plane == 2 ? s->hsub : 0;
278
4/4
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 5 times.
✓ Branch 2 taken 5 times.
✓ Branch 3 taken 5 times.
 15 int vsub = plane == 1 || plane == 2 ? s->vsub : 0;
279 15 int w = AV_CEIL_RSHIFT(inw, hsub);
280 15 int h = AV_CEIL_RSHIFT(inh, vsub);
281
282
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 5 times.
 15 if (!((1 << plane) & s->planes))
283 10 continue;
284
285 5 nplanes++;
286
287 // gaussian filter to reduce noise
288 5 ff_gaussian_blur_8(w, h,
289 filterbuf, w,
290 5 in->data[plane], in->linesize[plane], 1);
291
292 // compute the 16-bits gradients and directions for the next step
293 5 ff_sobel_8(w, h, gradients, w, directions, w, filterbuf, w, 1);
294
295 // non_maximum_suppression() will actually keep & clip what's necessary and
296 // ignore the rest, so we need a clean output buffer
297 5 memset(tmpbuf, 0, inw * inh);
298 5 ff_non_maximum_suppression(w, h, tmpbuf, w, directions, w, gradients, w);
299
300
301 // keep high values, or low values surrounded by high values
302 5 ff_double_threshold(s->low_u8, s->high_u8, w, h,
303 tmpbuf, w, tmpbuf, w);
304
305 5 blur += calculate_blur(s, w, h, hsub, vsub, directions, w,
306 tmpbuf, w, filterbuf, w);
307 }
308
309
1/2
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
 5 if (nplanes)
310 5 blur /= nplanes;
311
312 5 s->blur_total += blur;
313
314 // write stats
315 5 av_log(ctx, AV_LOG_VERBOSE, "blur: %.7f\n", blur);
316
317 5 set_meta(metadata, "lavfi.blur", blur);
318
319 5 s->nb_frames = inlink->frame_count_in;
320
321 5 return ff_filter_frame(outlink, in);
322 }
323
324 2 static av_cold void blurdetect_uninit(AVFilterContext *ctx)
325 {
326 2 BLRContext *s = ctx->priv;
327
328
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
 2 if (s->nb_frames > 0) {
329 1 av_log(ctx, AV_LOG_INFO, "blur mean: %.7f\n",
330 1 s->blur_total / s->nb_frames);
331 }
332
333 2 av_freep(&s->tmpbuf);
334 2 av_freep(&s->filterbuf);
335 2 av_freep(&s->gradients);
336 2 av_freep(&s->directions);
337 2 av_freep(&s->blks);
338 2 }
339
340 static const enum AVPixelFormat pix_fmts[] = {
341 AV_PIX_FMT_GRAY8,
342 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
343 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
344 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
345 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
346 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P,
347 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ444P,
348 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA420P,
349 AV_PIX_FMT_NONE
350 };
351
352 static const AVFilterPad blurdetect_inputs[] = {
353 {
354 .name = "default",
355 .type = AVMEDIA_TYPE_VIDEO,
356 .config_props = blurdetect_config_input,
357 .filter_frame = blurdetect_filter_frame,
358 },
359 };
360
361 const AVFilter ff_vf_blurdetect = {
362 .name = "blurdetect",
363 .description = NULL_IF_CONFIG_SMALL("Blurdetect filter."),
364 .priv_size = sizeof(BLRContext),
365 .init = blurdetect_init,
366 .uninit = blurdetect_uninit,
367 FILTER_PIXFMTS_ARRAY(pix_fmts),
368 FILTER_INPUTS(blurdetect_inputs),
369 FILTER_OUTPUTS(ff_video_default_filterpad),
370 .priv_class = &blurdetect_class,
371 .flags = AVFILTER_FLAG_METADATA_ONLY,
372 };
373