e289f6933f23a7a62b43c3874ec72ba96ceb8522
[ffmpeg.git] / libavfilter / vf_gblur.c
1 /*
2  * Copyright (c) 2011 Pascal Getreuer
3  * Copyright (c) 2016 Paul B Mahol
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above
11  *    copyright notice, this list of conditions and the following
12  *    disclaimer in the documentation and/or other materials provided
13  *    with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "libavutil/imgutils.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
31 #include "avfilter.h"
32 #include "formats.h"
33 #include "internal.h"
34 #include "video.h"
35
36 typedef struct GBlurContext {
37     const AVClass *class;
38
39     float sigma;
40     int steps;
41     int planes;
42
43     int depth;
44     int planewidth[4];
45     int planeheight[4];
46     float *buffer;
47     float boundaryscale;
48     float postscale;
49     float nu;
50     int nb_planes;
51 } GBlurContext;
52
53 #define OFFSET(x) offsetof(GBlurContext, x)
54 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
55
56 static const AVOption gblur_options[] = {
57     { "sigma",  "set sigma",            OFFSET(sigma),  AV_OPT_TYPE_FLOAT, {.dbl=0.5}, 0.0, 1024, FLAGS },
58     { "steps",  "set number of steps",  OFFSET(steps),  AV_OPT_TYPE_INT,   {.i64=1},     1,    6, FLAGS },
59     { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT,   {.i64=0xF},   0,  0xF, FLAGS },
60     { NULL }
61 };
62
63 AVFILTER_DEFINE_CLASS(gblur);
64
65 typedef struct ThreadData {
66     int height;
67     int width;
68 } ThreadData;
69
70 static int filter_horizontally(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
71 {
72     GBlurContext *s = ctx->priv;
73     ThreadData *td = arg;
74     const int height = td->height;
75     const int width = td->width;
76     const int slice_start = (height *  jobnr   ) / nb_jobs;
77     const int slice_end   = (height * (jobnr+1)) / nb_jobs;
78     const float boundaryscale = s->boundaryscale;
79     const int steps = s->steps;
80     const float nu = s->nu;
81     float *buffer = s->buffer;
82     int y, x, step;
83     float *ptr;
84
85     /* Filter horizontally along each row */
86     for (y = slice_start; y < slice_end; y++) {
87         for (step = 0; step < steps; step++) {
88             ptr = buffer + width * y;
89             ptr[0] *= boundaryscale;
90
91             /* Filter rightwards */
92             for (x = 1; x < width; x++)
93                 ptr[x] += nu * ptr[x - 1];
94
95             ptr[x = width - 1] *= boundaryscale;
96
97             /* Filter leftwards */
98             for (; x > 0; x--)
99                 ptr[x - 1] += nu * ptr[x];
100         }
101     }
102
103     return 0;
104 }
105
106 static int filter_vertically(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
107 {
108     GBlurContext *s = ctx->priv;
109     ThreadData *td = arg;
110     const int height = td->height;
111     const int width = td->width;
112     const int slice_start = (width *  jobnr   ) / nb_jobs;
113     const int slice_end   = (width * (jobnr+1)) / nb_jobs;
114     const float boundaryscale = s->boundaryscale;
115     const int numpixels = width * height;
116     const int steps = s->steps;
117     const float nu = s->nu;
118     float *buffer = s->buffer;
119     int i, x, step;
120     float *ptr;
121
122     /* Filter vertically along each column */
123     for (x = slice_start; x < slice_end; x++) {
124         for (step = 0; step < steps; step++) {
125             ptr = buffer + x;
126             ptr[0] *= boundaryscale;
127
128             /* Filter downwards */
129             for (i = width; i < numpixels; i += width)
130                 ptr[i] += nu * ptr[i - width];
131
132             ptr[i = numpixels - width] *= boundaryscale;
133
134             /* Filter upwards */
135             for (; i > 0; i -= width)
136                 ptr[i - width] += nu * ptr[i];
137         }
138     }
139
140     return 0;
141 }
142
143
144 static int filter_postscale(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
145 {
146     GBlurContext *s = ctx->priv;
147     ThreadData *td = arg;
148     const int height = td->height;
149     const int width = td->width;
150     const int64_t numpixels = width * height;
151     const int slice_start = (numpixels *  jobnr   ) / nb_jobs;
152     const int slice_end   = (numpixels * (jobnr+1)) / nb_jobs;
153     const float postscale = s->postscale;
154     float *buffer = s->buffer;
155     int i;
156
157     for (i = slice_start; i < slice_end; i++)
158         buffer[i] *= postscale;
159
160     return 0;
161 }
162
163 static void gaussianiir2d(AVFilterContext *ctx, int plane)
164 {
165     GBlurContext *s = ctx->priv;
166     const int width = s->planewidth[plane];
167     const int height = s->planeheight[plane];
168     const int nb_threads = ff_filter_get_nb_threads(ctx);
169     ThreadData td;
170
171     if (s->sigma <= 0 || s->steps < 0)
172         return;
173
174     td.width = width;
175     td.height = height;
176     ctx->internal->execute(ctx, filter_horizontally, &td, NULL, FFMIN(height, nb_threads));
177     ctx->internal->execute(ctx, filter_vertically, &td, NULL, FFMIN(width, nb_threads));
178     ctx->internal->execute(ctx, filter_postscale, &td, NULL, FFMIN(width * height, nb_threads));
179 }
180
181 static int query_formats(AVFilterContext *ctx)
182 {
183     static const enum AVPixelFormat pix_fmts[] = {
184         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
185         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
186         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
187         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
188         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
189         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
190         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
191         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
192         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
193         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
194         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
195         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
196         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
197         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
198         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
199         AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
200         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16,
201         AV_PIX_FMT_NONE
202     };
203
204     return ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
205 }
206
207 static int config_input(AVFilterLink *inlink)
208 {
209     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
210     GBlurContext *s = inlink->dst->priv;
211
212     s->depth = desc->comp[0].depth;
213     s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
214     s->planewidth[0] = s->planewidth[3] = inlink->w;
215     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
216     s->planeheight[0] = s->planeheight[3] = inlink->h;
217
218     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
219
220     s->buffer = av_malloc_array(inlink->w, inlink->h * sizeof(*s->buffer));
221     if (!s->buffer)
222         return AVERROR(ENOMEM);
223     return 0;
224 }
225
226 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
227 {
228     AVFilterContext *ctx = inlink->dst;
229     GBlurContext *s = ctx->priv;
230     AVFilterLink *outlink = ctx->outputs[0];
231     double dnu, lambda;
232     float sigma = s->sigma;
233     int steps = s->steps;
234     AVFrame *out;
235     int plane;
236
237     lambda = (sigma * sigma) / (2.0 * steps);
238     dnu = (1.0 + 2.0 * lambda - sqrt(1.0 + 4.0 * lambda)) / (2.0 * lambda);
239     s->postscale = pow(dnu / lambda, 2 * steps);
240     s->boundaryscale = 1.0 / (1.0 - dnu);
241     s->nu = (float)dnu;
242
243     if (av_frame_is_writable(in)) {
244         out = in;
245     } else {
246         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
247         if (!out) {
248             av_frame_free(&in);
249             return AVERROR(ENOMEM);
250         }
251         av_frame_copy_props(out, in);
252     }
253
254     for (plane = 0; plane < s->nb_planes; plane++) {
255         const int height = s->planeheight[plane];
256         const int width = s->planewidth[plane];
257         float *bptr = s->buffer;
258         const uint8_t *src = in->data[plane];
259         const uint16_t *src16 = (const uint16_t *)in->data[plane];
260         uint8_t *dst = out->data[plane];
261         uint16_t *dst16 = (uint16_t *)out->data[plane];
262         int y, x;
263
264         if (!s->sigma || !(s->planes & (1 << plane))) {
265             if (out != in)
266                 av_image_copy_plane(out->data[plane], out->linesize[plane],
267                                     in->data[plane], in->linesize[plane],
268                                     width * ((s->depth + 7) / 8), height);
269             continue;
270         }
271
272         if (s->depth == 8) {
273             for (y = 0; y < height; y++) {
274                 for (x = 0; x < width; x++) {
275                     bptr[x] = src[x];
276                 }
277                 bptr += width;
278                 src += in->linesize[plane];
279             }
280         } else {
281             for (y = 0; y < height; y++) {
282                 for (x = 0; x < width; x++) {
283                     bptr[x] = src16[x];
284                 }
285                 bptr += width;
286                 src16 += in->linesize[plane] / 2;
287             }
288         }
289
290         gaussianiir2d(ctx, plane);
291
292         bptr = s->buffer;
293         if (s->depth == 8) {
294             for (y = 0; y < height; y++) {
295                 for (x = 0; x < width; x++) {
296                     dst[x] = bptr[x];
297                 }
298                 bptr += width;
299                 dst += out->linesize[plane];
300             }
301         } else {
302             for (y = 0; y < height; y++) {
303                 for (x = 0; x < width; x++) {
304                     dst16[x] = bptr[x];
305                 }
306                 bptr += width;
307                 dst16 += out->linesize[plane] / 2;
308             }
309         }
310     }
311
312     if (out != in)
313         av_frame_free(&in);
314     return ff_filter_frame(outlink, out);
315 }
316
317 static av_cold void uninit(AVFilterContext *ctx)
318 {
319     GBlurContext *s = ctx->priv;
320
321     av_freep(&s->buffer);
322 }
323
324 static const AVFilterPad gblur_inputs[] = {
325     {
326         .name         = "default",
327         .type         = AVMEDIA_TYPE_VIDEO,
328         .config_props = config_input,
329         .filter_frame = filter_frame,
330     },
331     { NULL }
332 };
333
334 static const AVFilterPad gblur_outputs[] = {
335     {
336         .name = "default",
337         .type = AVMEDIA_TYPE_VIDEO,
338     },
339     { NULL }
340 };
341
342 AVFilter ff_vf_gblur = {
343     .name          = "gblur",
344     .description   = NULL_IF_CONFIG_SMALL("Apply Gaussian Blur filter."),
345     .priv_size     = sizeof(GBlurContext),
346     .priv_class    = &gblur_class,
347     .uninit        = uninit,
348     .query_formats = query_formats,
349     .inputs        = gblur_inputs,
350     .outputs       = gblur_outputs,
351     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
352 };