]> git.sesse.net Git - ffmpeg/blob - libavfilter/vf_vaguedenoiser.c
avfilter/vf_vaguedenoiser: remove excessive code from soft thresholding
[ffmpeg] / libavfilter / vf_vaguedenoiser.c
1 /*
2  * Copyright (c) 2003 LeFunGus, lefungus@altern.org
3  *
4  * This file is part of FFmpeg
5  *
6  * FFmpeg is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20
21 #include <float.h>
22
23 #include "libavutil/imgutils.h"
24 #include "libavutil/attributes.h"
25 #include "libavutil/common.h"
26 #include "libavutil/pixdesc.h"
27 #include "libavutil/intreadwrite.h"
28 #include "libavutil/opt.h"
29
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 #include "video.h"
34
35 typedef struct VagueDenoiserContext {
36     const AVClass *class;
37
38     float threshold;
39     float percent;
40     int method;
41     int nsteps;
42     int planes;
43
44     int depth;
45     int bpc;
46     int peak;
47     int nb_planes;
48     int planeheight[4];
49     int planewidth[4];
50
51     float *block;
52     float *in;
53     float *out;
54     float *tmp;
55
56     int hlowsize[4][32];
57     int hhighsize[4][32];
58     int vlowsize[4][32];
59     int vhighsize[4][32];
60
61     void (*thresholding)(float *block, const int width, const int height,
62                          const int stride, const float threshold,
63                          const float percent, const int nsteps);
64 } VagueDenoiserContext;
65
66 #define OFFSET(x) offsetof(VagueDenoiserContext, x)
67 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
68 static const AVOption vaguedenoiser_options[] = {
69     { "threshold", "set filtering strength",   OFFSET(threshold), AV_OPT_TYPE_FLOAT, {.dbl=2.},  0,DBL_MAX, FLAGS },
70     { "method",    "set filtering method",     OFFSET(method),    AV_OPT_TYPE_INT,   {.i64=2 },  0, 2,      FLAGS, "method" },
71         { "hard",   "hard thresholding",       0,                 AV_OPT_TYPE_CONST, {.i64=0},   0, 0,      FLAGS, "method" },
72         { "soft",   "soft thresholding",       0,                 AV_OPT_TYPE_CONST, {.i64=1},   0, 0,      FLAGS, "method" },
73         { "garrote", "garotte thresholding",   0,                 AV_OPT_TYPE_CONST, {.i64=2},   0, 0,      FLAGS, "method" },
74     { "nsteps",    "set number of steps",      OFFSET(nsteps),    AV_OPT_TYPE_INT,   {.i64=6 },  1, 32,     FLAGS },
75     { "percent", "set percent of full denoising", OFFSET(percent),AV_OPT_TYPE_FLOAT, {.dbl=85},  0,100,     FLAGS },
76     { "planes",    "set planes to filter",     OFFSET(planes),    AV_OPT_TYPE_INT,   {.i64=15 }, 0, 15,     FLAGS },
77     { NULL }
78 };
79
80 AVFILTER_DEFINE_CLASS(vaguedenoiser);
81
82 #define NPAD 10
83
84 static const float analysis_low[9] = {
85     0.037828455506995f, -0.023849465019380f, -0.110624404418423f, 0.377402855612654f,
86     0.852698679009403f, 0.377402855612654f, -0.110624404418423f, -0.023849465019380f, 0.037828455506995f
87 };
88
89 static const float analysis_high[7] = {
90     -0.064538882628938f, 0.040689417609558f, 0.418092273222212f, -0.788485616405664f,
91     0.418092273222212f, 0.040689417609558f, -0.064538882628938f
92 };
93
94 static const float synthesis_low[7] = {
95     -0.064538882628938f, -0.040689417609558f, 0.418092273222212f, 0.788485616405664f,
96     0.418092273222212f, -0.040689417609558f, -0.064538882628938f
97 };
98
99 static const float synthesis_high[9] = {
100     -0.037828455506995f, -0.023849465019380f, 0.110624404418423f, 0.377402855612654f,
101     -0.852698679009403f, 0.377402855612654f, 0.110624404418423f, -0.023849465019380f, -0.037828455506995f
102 };
103
104 static int query_formats(AVFilterContext *ctx)
105 {
106     static const enum AVPixelFormat pix_fmts[] = {
107         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10,
108         AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
109         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
110         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
111         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
112         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
113         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
114         AV_PIX_FMT_YUVJ411P,
115         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
116         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
117         AV_PIX_FMT_YUV440P10,
118         AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
119         AV_PIX_FMT_YUV440P12,
120         AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
121         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
122         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
123         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
124         AV_PIX_FMT_YUVA420P,  AV_PIX_FMT_YUVA422P,   AV_PIX_FMT_YUVA444P,
125         AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA444P12, AV_PIX_FMT_YUVA444P16,
126         AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA422P16,
127         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA420P16,
128         AV_PIX_FMT_GBRAP,     AV_PIX_FMT_GBRAP10,    AV_PIX_FMT_GBRAP12,    AV_PIX_FMT_GBRAP16,
129         AV_PIX_FMT_NONE
130     };
131     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
132     if (!fmts_list)
133         return AVERROR(ENOMEM);
134     return ff_set_common_formats(ctx, fmts_list);
135 }
136
137 static int config_input(AVFilterLink *inlink)
138 {
139     VagueDenoiserContext *s = inlink->dst->priv;
140     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
141     int p, i, nsteps_width, nsteps_height, nsteps_max;
142
143     s->depth = desc->comp[0].depth;
144     s->bpc = (s->depth + 7) / 8;
145     s->nb_planes = desc->nb_components;
146
147     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
148     s->planeheight[0] = s->planeheight[3] = inlink->h;
149     s->planewidth[1]  = s->planewidth[2]  = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
150     s->planewidth[0]  = s->planewidth[3]  = inlink->w;
151
152     s->block = av_malloc_array(inlink->w * inlink->h, sizeof(*s->block));
153     s->in    = av_malloc_array(32 + FFMAX(inlink->w, inlink->h), sizeof(*s->in));
154     s->out   = av_malloc_array(32 + FFMAX(inlink->w, inlink->h), sizeof(*s->out));
155     s->tmp   = av_malloc_array(32 + FFMAX(inlink->w, inlink->h), sizeof(*s->tmp));
156
157     if (!s->block || !s->in || !s->out || !s->tmp)
158         return AVERROR(ENOMEM);
159
160     s->threshold *= 1 << (s->depth - 8);
161     s->peak = (1 << s->depth) - 1;
162
163     nsteps_width  = ((s->planes & 2 || s->planes & 4) && s->nb_planes > 1) ? s->planewidth[1] : s->planewidth[0];
164     nsteps_height = ((s->planes & 2 || s->planes & 4) && s->nb_planes > 1) ? s->planeheight[1] : s->planeheight[0];
165
166     for (nsteps_max = 1; nsteps_max < 15; nsteps_max++) {
167         if (pow(2, nsteps_max) >= nsteps_width || pow(2, nsteps_max) >= nsteps_height)
168             break;
169     }
170
171     s->nsteps = FFMIN(s->nsteps, nsteps_max - 2);
172
173     for (p = 0; p < 4; p++) {
174         s->hlowsize[p][0]  = (s->planewidth[p] + 1) >> 1;
175         s->hhighsize[p][0] =  s->planewidth[p] >> 1;
176         s->vlowsize[p][0]  = (s->planeheight[p] + 1) >> 1;
177         s->vhighsize[p][0] =  s->planeheight[p] >> 1;
178
179         for (i = 1; i < s->nsteps; i++) {
180             s->hlowsize[p][i]  = (s->hlowsize[p][i - 1] + 1) >> 1;
181             s->hhighsize[p][i] =  s->hlowsize[p][i - 1] >> 1;
182             s->vlowsize[p][i]  = (s->vlowsize[p][i - 1] + 1) >> 1;
183             s->vhighsize[p][i] =  s->vlowsize[p][i - 1] >> 1;
184         }
185     }
186
187     return 0;
188 }
189
190 static inline void copy(const float *p1, float *p2, const int length)
191 {
192     memcpy(p2, p1, length * sizeof(float));
193 }
194
195 static inline void copyv(const float *p1, const int stride1, float *p2, const int length)
196 {
197     int i;
198
199     for (i = 0; i < length; i++) {
200         p2[i] = *p1;
201         p1 += stride1;
202     }
203 }
204
205 static inline void copyh(const float *p1, float *p2, const int stride2, const int length)
206 {
207     int i;
208
209     for (i = 0; i < length; i++) {
210         *p2 = p1[i];
211         p2 += stride2;
212     }
213 }
214
215 // Do symmetric extension of data using prescribed symmetries
216 // Original values are in output[npad] through output[npad+size-1]
217 // New values will be placed in output[0] through output[npad] and in output[npad+size] through output[2*npad+size-1] (note: end values may not be filled in)
218 // extension at left bdry is ... 3 2 1 0 | 0 1 2 3 ...
219 // same for right boundary
220 // if right_ext=1 then ... 3 2 1 0 | 1 2 3
221 static void symmetric_extension(float *output, const int size, const int left_ext, const int right_ext)
222 {
223     int first = NPAD;
224     int last = NPAD - 1 + size;
225     const int originalLast = last;
226     int i, nextend, idx;
227
228     if (left_ext == 2)
229         output[--first] = output[NPAD];
230     if (right_ext == 2)
231         output[++last] = output[originalLast];
232
233     // extend left end
234     nextend = first;
235     for (i = 0; i < nextend; i++)
236         output[--first] = output[NPAD + 1 + i];
237
238     idx = NPAD + NPAD - 1 + size;
239
240     // extend right end
241     nextend = idx - last;
242     for (i = 0; i < nextend; i++)
243         output[++last] = output[originalLast - 1 - i];
244 }
245
246 static void transform_step(float *input, float *output, const int size, const int low_size, VagueDenoiserContext *s)
247 {
248     int i;
249
250     symmetric_extension(input, size, 1, 1);
251
252     for (i = NPAD; i < NPAD + low_size; i++) {
253         const float a = input[2 * i - 14] * analysis_low[0];
254         const float b = input[2 * i - 13] * analysis_low[1];
255         const float c = input[2 * i - 12] * analysis_low[2];
256         const float d = input[2 * i - 11] * analysis_low[3];
257         const float e = input[2 * i - 10] * analysis_low[4];
258         const float f = input[2 * i -  9] * analysis_low[3];
259         const float g = input[2 * i -  8] * analysis_low[2];
260         const float h = input[2 * i -  7] * analysis_low[1];
261         const float k = input[2 * i -  6] * analysis_low[0];
262
263         output[i] = a + b + c + d + e + f + g + h + k;
264     }
265
266     for (i = NPAD; i < NPAD + low_size; i++) {
267         const float a = input[2 * i - 12] * analysis_high[0];
268         const float b = input[2 * i - 11] * analysis_high[1];
269         const float c = input[2 * i - 10] * analysis_high[2];
270         const float d = input[2 * i -  9] * analysis_high[3];
271         const float e = input[2 * i -  8] * analysis_high[2];
272         const float f = input[2 * i -  7] * analysis_high[1];
273         const float g = input[2 * i -  6] * analysis_high[0];
274
275         output[i + low_size] = a + b + c + d + e + f + g;
276     }
277 }
278
279 static void invert_step(const float *input, float *output, float *temp, const int size, VagueDenoiserContext *s)
280 {
281     const int low_size = (size + 1) >> 1;
282     const int high_size = size >> 1;
283     int left_ext = 1, right_ext, i;
284     int findex;
285
286     memcpy(temp + NPAD, input + NPAD, low_size * sizeof(float));
287
288     right_ext = (size % 2 == 0) ? 2 : 1;
289     symmetric_extension(temp, low_size, left_ext, right_ext);
290
291     memset(output, 0, (NPAD + NPAD + size) * sizeof(float));
292     findex = (size + 2) >> 1;
293
294     for (i = 9; i < findex + 11; i++) {
295         const float a = temp[i] * synthesis_low[0];
296         const float b = temp[i] * synthesis_low[1];
297         const float c = temp[i] * synthesis_low[2];
298         const float d = temp[i] * synthesis_low[3];
299
300         output[2 * i - 13] += a;
301         output[2 * i - 12] += b;
302         output[2 * i - 11] += c;
303         output[2 * i - 10] += d;
304         output[2 * i -  9] += c;
305         output[2 * i -  8] += b;
306         output[2 * i -  7] += a;
307     }
308
309     memcpy(temp + NPAD, input + NPAD + low_size, high_size * sizeof(float));
310
311     left_ext = 2;
312     right_ext = (size % 2 == 0) ? 1 : 2;
313     symmetric_extension(temp, high_size, left_ext, right_ext);
314
315     for (i = 8; i < findex + 11; i++) {
316         const float a = temp[i] * synthesis_high[0];
317         const float b = temp[i] * synthesis_high[1];
318         const float c = temp[i] * synthesis_high[2];
319         const float d = temp[i] * synthesis_high[3];
320         const float e = temp[i] * synthesis_high[4];
321
322         output[2 * i - 13] += a;
323         output[2 * i - 12] += b;
324         output[2 * i - 11] += c;
325         output[2 * i - 10] += d;
326         output[2 * i -  9] += e;
327         output[2 * i -  8] += d;
328         output[2 * i -  7] += c;
329         output[2 * i -  6] += b;
330         output[2 * i -  5] += a;
331     }
332 }
333
334 static void hard_thresholding(float *block, const int width, const int height,
335                               const int stride, const float threshold,
336                               const float percent, const int unused)
337 {
338     const float frac = 1.f - percent * 0.01f;
339     int y, x;
340
341     for (y = 0; y < height; y++) {
342         for (x = 0; x < width; x++) {
343             if (FFABS(block[x]) <= threshold)
344                 block[x] *= frac;
345         }
346         block += stride;
347     }
348 }
349
350 static void soft_thresholding(float *block, const int width, const int height, const int stride,
351                               const float threshold, const float percent, const int nsteps)
352 {
353     const float frac = 1.f - percent * 0.01f;
354     const float shift = threshold * 0.01f * percent;
355     int y, x;
356
357     for (y = 0; y < height; y++) {
358         for (x = 0; x < width; x++) {
359             const float temp = FFABS(block[x]);
360             if (temp <= threshold)
361                 block[x] *= frac;
362             else
363                 block[x] = (block[x] < 0.f ? -1.f : (block[x] > 0.f ? 1.f : 0.f)) * (temp - shift);
364         }
365         block += stride;
366     }
367 }
368
369 static void qian_thresholding(float *block, const int width, const int height,
370                               const int stride, const float threshold,
371                               const float percent, const int unused)
372 {
373     const float percent01 = percent * 0.01f;
374     const float tr2 = threshold * threshold * percent01;
375     const float frac = 1.f - percent01;
376     int y, x;
377
378     for (y = 0; y < height; y++) {
379         for (x = 0; x < width; x++) {
380             const float temp = FFABS(block[x]);
381             if (temp <= threshold) {
382                 block[x] *= frac;
383             } else {
384                 const float tp2 = temp * temp;
385                 block[x] *= (tp2 - tr2) / tp2;
386             }
387         }
388         block += stride;
389     }
390 }
391
392 static void filter(VagueDenoiserContext *s, AVFrame *in, AVFrame *out)
393 {
394     int p, y, x, i, j;
395
396     for (p = 0; p < s->nb_planes; p++) {
397         const int height = s->planeheight[p];
398         const int width = s->planewidth[p];
399         const uint8_t *srcp8 = in->data[p];
400         const uint16_t *srcp16 = (const uint16_t *)in->data[p];
401         uint8_t *dstp8 = out->data[p];
402         uint16_t *dstp16 = (uint16_t *)out->data[p];
403         float *output = s->block;
404         int h_low_size0 = width;
405         int v_low_size0 = height;
406         int nsteps_transform = s->nsteps;
407         int nsteps_invert = s->nsteps;
408         const float *input = s->block;
409
410         if (!((1 << p) & s->planes)) {
411             av_image_copy_plane(out->data[p], out->linesize[p], in->data[p], in->linesize[p],
412                                 s->planewidth[p] * s->bpc, s->planeheight[p]);
413             continue;
414         }
415
416         if (s->depth <= 8) {
417             for (y = 0; y < height; y++) {
418                 for (x = 0; x < width; x++)
419                     output[x] = srcp8[x];
420                 srcp8 += in->linesize[p];
421                 output += width;
422             }
423         } else {
424             for (y = 0; y < height; y++) {
425                 for (x = 0; x < width; x++)
426                     output[x] = srcp16[x];
427                 srcp16 += in->linesize[p] / 2;
428                 output += width;
429             }
430         }
431
432         while (nsteps_transform--) {
433             int low_size = (h_low_size0 + 1) >> 1;
434             float *input = s->block;
435             for (j = 0; j < v_low_size0; j++) {
436                 copy(input, s->in + NPAD, h_low_size0);
437                 transform_step(s->in, s->out, h_low_size0, low_size, s);
438                 copy(s->out + NPAD, input, h_low_size0);
439                 input += width;
440             }
441
442             low_size = (v_low_size0 + 1) >> 1;
443             input = s->block;
444             for (j = 0; j < h_low_size0; j++) {
445                 copyv(input, width, s->in + NPAD, v_low_size0);
446                 transform_step(s->in, s->out, v_low_size0, low_size, s);
447                 copyh(s->out + NPAD, input, width, v_low_size0);
448                 input++;
449             }
450
451             h_low_size0 = (h_low_size0 + 1) >> 1;
452             v_low_size0 = (v_low_size0 + 1) >> 1;
453         }
454
455         s->thresholding(s->block, width, height, width, s->threshold, s->percent, s->nsteps);
456
457         while (nsteps_invert--) {
458             const int idx = s->vlowsize[p][nsteps_invert]  + s->vhighsize[p][nsteps_invert];
459             const int idx2 = s->hlowsize[p][nsteps_invert] + s->hhighsize[p][nsteps_invert];
460             float * idx3 = s->block;
461             for (i = 0; i < idx2; i++) {
462                 copyv(idx3, width, s->in + NPAD, idx);
463                 invert_step(s->in, s->out, s->tmp, idx, s);
464                 copyh(s->out + NPAD, idx3, width, idx);
465                 idx3++;
466             }
467
468             idx3 = s->block;
469             for (i = 0; i < idx; i++) {
470                 copy(idx3, s->in + NPAD, idx2);
471                 invert_step(s->in, s->out, s->tmp, idx2, s);
472                 copy(s->out + NPAD, idx3, idx2);
473                 idx3 += width;
474             }
475         }
476
477         if (s->depth <= 8) {
478             for (y = 0; y < height; y++) {
479                 for (x = 0; x < width; x++)
480                     dstp8[x] = av_clip_uint8(input[x] + 0.5f);
481                 input += width;
482                 dstp8 += out->linesize[p];
483             }
484         } else {
485             for (y = 0; y < height; y++) {
486                 for (x = 0; x < width; x++)
487                     dstp16[x] = av_clip(input[x] + 0.5f, 0, s->peak);
488                 input += width;
489                 dstp16 += out->linesize[p] / 2;
490             }
491         }
492     }
493 }
494
495 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
496 {
497     AVFilterContext *ctx  = inlink->dst;
498     VagueDenoiserContext *s = ctx->priv;
499     AVFilterLink *outlink = ctx->outputs[0];
500     AVFrame *out;
501     int direct = av_frame_is_writable(in);
502
503     if (direct) {
504         out = in;
505     } else {
506         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
507         if (!out) {
508             av_frame_free(&in);
509             return AVERROR(ENOMEM);
510         }
511
512         av_frame_copy_props(out, in);
513     }
514
515     filter(s, in, out);
516
517     if (!direct)
518         av_frame_free(&in);
519
520     return ff_filter_frame(outlink, out);
521 }
522
523 static av_cold int init(AVFilterContext *ctx)
524 {
525     VagueDenoiserContext *s = ctx->priv;
526
527     switch (s->method) {
528     case 0:
529         s->thresholding = hard_thresholding;
530         break;
531     case 1:
532         s->thresholding = soft_thresholding;
533         break;
534     case 2:
535         s->thresholding = qian_thresholding;
536         break;
537     }
538
539     return 0;
540 }
541
542 static av_cold void uninit(AVFilterContext *ctx)
543 {
544     VagueDenoiserContext *s = ctx->priv;
545
546     av_freep(&s->block);
547     av_freep(&s->in);
548     av_freep(&s->out);
549     av_freep(&s->tmp);
550 }
551
552 static const AVFilterPad vaguedenoiser_inputs[] = {
553     {
554         .name         = "default",
555         .type         = AVMEDIA_TYPE_VIDEO,
556         .config_props = config_input,
557         .filter_frame = filter_frame,
558     },
559     { NULL }
560 };
561
562
563 static const AVFilterPad vaguedenoiser_outputs[] = {
564     {
565         .name = "default",
566         .type = AVMEDIA_TYPE_VIDEO
567     },
568     { NULL }
569 };
570
571 AVFilter ff_vf_vaguedenoiser = {
572     .name          = "vaguedenoiser",
573     .description   = NULL_IF_CONFIG_SMALL("Apply a Wavelet based Denoiser."),
574     .priv_size     = sizeof(VagueDenoiserContext),
575     .priv_class    = &vaguedenoiser_class,
576     .init          = init,
577     .uninit        = uninit,
578     .query_formats = query_formats,
579     .inputs        = vaguedenoiser_inputs,
580     .outputs       = vaguedenoiser_outputs,
581     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
582 };