2cfc3ba62d15888487abec7a5edf6e3164348466
[ffmpeg.git] / libavfilter / vf_convolution.c
1 /*
2  * Copyright (c) 2012-2013 Oka Motofumi (chikuzen.mo at gmail dot com)
3  * Copyright (c) 2015 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "libavutil/avstring.h"
23 #include "libavutil/imgutils.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
26 #include "avfilter.h"
27 #include "formats.h"
28 #include "internal.h"
29 #include "video.h"
30
31 typedef struct ConvolutionContext {
32     const AVClass *class;
33
34     char *matrix_str[4];
35     float rdiv[4];
36     float bias[4];
37
38     int size[4];
39     int depth;
40     int bstride;
41     uint8_t *buffer;
42     int nb_planes;
43     int planewidth[4];
44     int planeheight[4];
45     int matrix[4][25];
46     int matrix_length[4];
47     int copy[4];
48
49     void (*filter[4])(struct ConvolutionContext *s, AVFrame *in, AVFrame *out, int plane);
50 } ConvolutionContext;
51
52 #define OFFSET(x) offsetof(ConvolutionContext, x)
53 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
54
55 static const AVOption convolution_options[] = {
56     { "0m", "set matrix for 1st plane", OFFSET(matrix_str[0]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
57     { "1m", "set matrix for 2nd plane", OFFSET(matrix_str[1]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
58     { "2m", "set matrix for 3rd plane", OFFSET(matrix_str[2]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
59     { "3m", "set matrix for 4th plane", OFFSET(matrix_str[3]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
60     { "0rdiv", "set rdiv for 1st plane", OFFSET(rdiv[0]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
61     { "1rdiv", "set rdiv for 2nd plane", OFFSET(rdiv[1]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
62     { "2rdiv", "set rdiv for 3rd plane", OFFSET(rdiv[2]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
63     { "3rdiv", "set rdiv for 4th plane", OFFSET(rdiv[3]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
64     { "0bias", "set bias for 1st plane", OFFSET(bias[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
65     { "1bias", "set bias for 2nd plane", OFFSET(bias[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
66     { "2bias", "set bias for 3rd plane", OFFSET(bias[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
67     { "3bias", "set bias for 4th plane", OFFSET(bias[3]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
68     { NULL }
69 };
70
71 AVFILTER_DEFINE_CLASS(convolution);
72
73 static const int same3x3[9] = {0, 0, 0,
74                                0, 1, 0,
75                                0, 0, 0};
76
77 static const int same5x5[25] = {0, 0, 0, 0, 0,
78                                 0, 0, 0, 0, 0,
79                                 0, 0, 1, 0, 0,
80                                 0, 0, 0, 0, 0,
81                                 0, 0, 0, 0, 0};
82
83 static int query_formats(AVFilterContext *ctx)
84 {
85     static const enum AVPixelFormat pix_fmts[] = {
86         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
87         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
88         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
89         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
90         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
91         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
92         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
93         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
94         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
95         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
96         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
97         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
98         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
99         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
100         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
101         AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
102         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16,
103         AV_PIX_FMT_NONE
104     };
105
106     return ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
107 }
108
109 static inline void line_copy8(uint8_t *line, const uint8_t *srcp, int width, int mergin)
110 {
111     int i;
112
113     memcpy(line, srcp, width);
114
115     for (i = mergin; i > 0; i--) {
116         line[-i] = line[i];
117         line[width - 1 + i] = line[width - 1 - i];
118     }
119 }
120
121 static inline void line_copy16(uint16_t *line, const uint16_t *srcp, int width, int mergin)
122 {
123     int i;
124
125     memcpy(line, srcp, width * 2);
126
127     for (i = mergin; i > 0; i--) {
128         line[-i] = line[i];
129         line[width - 1 + i] = line[width - 1 - i];
130     }
131 }
132
133 static void filter16_3x3(ConvolutionContext *s, AVFrame *in, AVFrame *out, int plane)
134 {
135     const uint16_t *src = (const uint16_t *)in->data[plane];
136     uint16_t *dst = (uint16_t *)out->data[plane];
137     const int peak = (1 << s->depth) - 1;
138     const int stride = in->linesize[plane] / 2;
139     const int bstride = s->bstride;
140     const int height = s->planeheight[plane];
141     const int width  = s->planewidth[plane];
142     uint16_t *p0 = (uint16_t *)s->buffer + 16;
143     uint16_t *p1 = p0 + bstride;
144     uint16_t *p2 = p1 + bstride;
145     uint16_t *orig = p0, *end = p2;
146     const int *matrix = s->matrix[plane];
147     const float rdiv = s->rdiv[plane];
148     const float bias = s->bias[plane];
149     int y, x;
150
151     line_copy16(p0, src + stride, width, 1);
152     line_copy16(p1, src, width, 1);
153
154     for (y = 0; y < height; y++) {
155         src += stride * (y < height - 1 ? 1 : -1);
156         line_copy16(p2, src, width, 1);
157
158         for (x = 0; x < width; x++) {
159             int sum = p0[x - 1] * matrix[0] +
160                       p0[x] *     matrix[1] +
161                       p0[x + 1] * matrix[2] +
162                       p1[x - 1] * matrix[3] +
163                       p1[x] *     matrix[4] +
164                       p1[x + 1] * matrix[5] +
165                       p2[x - 1] * matrix[6] +
166                       p2[x] *     matrix[7] +
167                       p2[x + 1] * matrix[8];
168             sum = (int)(sum * rdiv + bias + 0.5f);
169             dst[x] = av_clip(sum, 0, peak);
170         }
171
172         p0 = p1;
173         p1 = p2;
174         p2 = (p2 == end) ? orig: p2 + bstride;
175         dst += out->linesize[plane] / 2;
176     }
177 }
178
179 static void filter16_5x5(ConvolutionContext *s, AVFrame *in, AVFrame *out, int plane)
180 {
181     const uint16_t *src = (const uint16_t *)in->data[plane];
182     uint16_t *dst = (uint16_t *)out->data[plane];
183     const int peak = (1 << s->depth) - 1;
184     const int stride = in->linesize[plane] / 2;
185     const int bstride = s->bstride;
186     const int height = s->planeheight[plane];
187     const int width  = s->planewidth[plane];
188     uint16_t *p0 = (uint16_t *)s->buffer + 16;
189     uint16_t *p1 = p0 + bstride;
190     uint16_t *p2 = p1 + bstride;
191     uint16_t *p3 = p2 + bstride;
192     uint16_t *p4 = p3 + bstride;
193     uint16_t *orig = p0, *end = p4;
194     const int *matrix = s->matrix[plane];
195     float rdiv = s->rdiv[plane];
196     float bias = s->bias[plane];
197     int y, x, i;
198
199     line_copy16(p0, src + 2 * stride, width, 2);
200     line_copy16(p1, src + stride, width, 2);
201     line_copy16(p2, src, width, 2);
202     src += stride;
203     line_copy16(p3, src, width, 2);
204
205
206     for (y = 0; y < height; y++) {
207         uint16_t *array[] = {
208             p0 - 2, p0 - 1, p0, p0 + 1, p0 + 2,
209             p1 - 2, p1 - 1, p1, p1 + 1, p1 + 2,
210             p2 - 2, p2 - 1, p2, p2 + 1, p2 + 2,
211             p3 - 2, p3 - 1, p3, p3 + 1, p3 + 2,
212             p4 - 2, p4 - 1, p4, p4 + 1, p4 + 2
213         };
214
215         src += stride * (y < height - 2 ? 1 : -1);
216         line_copy16(p4, src, width, 2);
217
218         for (x = 0; x < width; x++) {
219             int sum = 0;
220
221             for (i = 0; i < 25; i++) {
222                 sum += *(array[i] + x) * matrix[i];
223             }
224             sum = (int)(sum * rdiv + bias + 0.5f);
225             dst[x] = av_clip(sum, 0, peak);
226         }
227
228         p0 = p1;
229         p1 = p2;
230         p2 = p3;
231         p3 = p4;
232         p4 = (p4 == end) ? orig: p4 + bstride;
233         dst += out->linesize[plane] / 2;
234     }
235 }
236
237 static void filter_3x3(ConvolutionContext *s, AVFrame *in, AVFrame *out, int plane)
238 {
239     const uint8_t *src = in->data[plane];
240     uint8_t *dst = out->data[plane];
241     const int stride = in->linesize[plane];
242     const int bstride = s->bstride;
243     const int height = s->planeheight[plane];
244     const int width  = s->planewidth[plane];
245     uint8_t *p0 = s->buffer + 16;
246     uint8_t *p1 = p0 + bstride;
247     uint8_t *p2 = p1 + bstride;
248     uint8_t *orig = p0, *end = p2;
249     const int *matrix = s->matrix[plane];
250     const float rdiv = s->rdiv[plane];
251     const float bias = s->bias[plane];
252     int y, x;
253
254     line_copy8(p0, src + stride, width, 1);
255     line_copy8(p1, src, width, 1);
256
257     for (y = 0; y < height; y++) {
258         src += stride * (y < height - 1 ? 1 : -1);
259         line_copy8(p2, src, width, 1);
260
261         for (x = 0; x < width; x++) {
262             int sum = p0[x - 1] * matrix[0] +
263                       p0[x] *     matrix[1] +
264                       p0[x + 1] * matrix[2] +
265                       p1[x - 1] * matrix[3] +
266                       p1[x] *     matrix[4] +
267                       p1[x + 1] * matrix[5] +
268                       p2[x - 1] * matrix[6] +
269                       p2[x] *     matrix[7] +
270                       p2[x + 1] * matrix[8];
271             sum = (int)(sum * rdiv + bias + 0.5f);
272             dst[x] = av_clip_uint8(sum);
273         }
274
275         p0 = p1;
276         p1 = p2;
277         p2 = (p2 == end) ? orig: p2 + bstride;
278         dst += out->linesize[plane];
279     }
280 }
281
282 static void filter_5x5(ConvolutionContext *s, AVFrame *in, AVFrame *out, int plane)
283 {
284     const uint8_t *src = in->data[plane];
285     uint8_t *dst = out->data[plane];
286     const int stride = in->linesize[plane];
287     const int bstride = s->bstride;
288     const int height = s->planeheight[plane];
289     const int width  = s->planewidth[plane];
290     uint8_t *p0 = s->buffer + 16;
291     uint8_t *p1 = p0 + bstride;
292     uint8_t *p2 = p1 + bstride;
293     uint8_t *p3 = p2 + bstride;
294     uint8_t *p4 = p3 + bstride;
295     uint8_t *orig = p0, *end = p4;
296     const int *matrix = s->matrix[plane];
297     float rdiv = s->rdiv[plane];
298     float bias = s->bias[plane];
299     int y, x, i;
300
301     line_copy8(p0, src + 2 * stride, width, 2);
302     line_copy8(p1, src + stride, width, 2);
303     line_copy8(p2, src, width, 2);
304     src += stride;
305     line_copy8(p3, src, width, 2);
306
307
308     for (y = 0; y < height; y++) {
309         uint8_t *array[] = {
310             p0 - 2, p0 - 1, p0, p0 + 1, p0 + 2,
311             p1 - 2, p1 - 1, p1, p1 + 1, p1 + 2,
312             p2 - 2, p2 - 1, p2, p2 + 1, p2 + 2,
313             p3 - 2, p3 - 1, p3, p3 + 1, p3 + 2,
314             p4 - 2, p4 - 1, p4, p4 + 1, p4 + 2
315         };
316
317         src += stride * (y < height - 2 ? 1 : -1);
318         line_copy8(p4, src, width, 2);
319
320         for (x = 0; x < width; x++) {
321             int sum = 0;
322
323             for (i = 0; i < 25; i++) {
324                 sum += *(array[i] + x) * matrix[i];
325             }
326             sum = (int)(sum * rdiv + bias + 0.5f);
327             dst[x] = av_clip_uint8(sum);
328         }
329
330         p0 = p1;
331         p1 = p2;
332         p2 = p3;
333         p3 = p4;
334         p4 = (p4 == end) ? orig: p4 + bstride;
335         dst += out->linesize[plane];
336     }
337 }
338
339 static int config_input(AVFilterLink *inlink)
340 {
341     ConvolutionContext *s = inlink->dst->priv;
342     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
343     int ret, p;
344
345     s->depth = desc->comp[0].depth;
346     if ((ret = av_image_fill_linesizes(s->planewidth, inlink->format, inlink->w)) < 0)
347         return ret;
348
349     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
350     s->planeheight[0] = s->planeheight[3] = inlink->h;
351
352     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
353
354     s->bstride = s->planewidth[0] + 32;
355     s->buffer = av_malloc_array(5 * s->bstride, (s->depth + 7) / 8);
356     if (!s->buffer)
357         return AVERROR(ENOMEM);
358
359     if (s->depth > 8) {
360         for (p = 0; p < s->nb_planes; p++) {
361             if (s->size[p] == 3)
362                 s->filter[p] = filter16_3x3;
363             else if (s->size[p] == 5)
364                 s->filter[p] = filter16_5x5;
365         }
366     }
367
368     return 0;
369 }
370
371 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
372 {
373     ConvolutionContext *s = inlink->dst->priv;
374     AVFilterLink *outlink = inlink->dst->outputs[0];
375     AVFrame *out;
376     int plane;
377
378     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
379     if (!out) {
380         av_frame_free(&in);
381         return AVERROR(ENOMEM);
382     }
383     av_frame_copy_props(out, in);
384
385     for (plane = 0; plane < s->nb_planes; plane++) {
386         if (s->copy[plane]) {
387             av_image_copy_plane(out->data[plane], out->linesize[plane],
388                                 in->data[plane], in->linesize[plane],
389                                 s->planewidth[plane],
390                                 s->planeheight[plane]);
391             continue;
392         }
393
394         s->filter[plane](s, in, out, plane);
395     }
396
397     av_frame_free(&in);
398     return ff_filter_frame(outlink, out);
399 }
400
401 static av_cold int init(AVFilterContext *ctx)
402 {
403     ConvolutionContext *s = ctx->priv;
404     int i;
405
406     for (i = 0; i < 4; i++) {
407         int *matrix = (int *)s->matrix[i];
408         char *p, *arg, *saveptr = NULL;
409
410         p = s->matrix_str[i];
411         while (s->matrix_length[i] < 25) {
412             if (!(arg = av_strtok(p, " ", &saveptr)))
413                 break;
414
415             p = NULL;
416             sscanf(arg, "%d", &matrix[s->matrix_length[i]]);
417             s->matrix_length[i]++;
418         }
419
420         if (s->matrix_length[i] == 9) {
421             s->size[i] = 3;
422             if (!memcmp(matrix, same3x3, sizeof(same3x3)))
423                 s->copy[i] = 1;
424             else
425                 s->filter[i] = filter_3x3;
426         } else if (s->matrix_length[i] == 25) {
427             s->size[i] = 5;
428             if (!memcmp(matrix, same5x5, sizeof(same5x5)))
429                 s->copy[i] = 1;
430             else
431                 s->filter[i] = filter_5x5;
432         } else {
433             return AVERROR(EINVAL);
434         }
435     }
436
437     return 0;
438 }
439
440 static av_cold void uninit(AVFilterContext *ctx)
441 {
442     ConvolutionContext *s = ctx->priv;
443
444     av_freep(&s->buffer);
445 }
446
447 static const AVFilterPad convolution_inputs[] = {
448     {
449         .name         = "default",
450         .type         = AVMEDIA_TYPE_VIDEO,
451         .config_props = config_input,
452         .filter_frame = filter_frame,
453     },
454     { NULL }
455 };
456
457 static const AVFilterPad convolution_outputs[] = {
458     {
459         .name = "default",
460         .type = AVMEDIA_TYPE_VIDEO,
461     },
462     { NULL }
463 };
464
465 AVFilter ff_vf_convolution = {
466     .name          = "convolution",
467     .description   = NULL_IF_CONFIG_SMALL("Apply convolution filter."),
468     .priv_size     = sizeof(ConvolutionContext),
469     .priv_class    = &convolution_class,
470     .init          = init,
471     .uninit        = uninit,
472     .query_formats = query_formats,
473     .inputs        = convolution_inputs,
474     .outputs       = convolution_outputs,
475     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
476 };