0e87f92740a596c814712ef330d147c249a93ef8
[ffmpeg.git] / libavfilter / vf_edgedetect.c
1 /*
2  * Copyright (c) 2012 Clément Bœsch
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  * Edge detection filter
24  *
25  * @see https://en.wikipedia.org/wiki/Canny_edge_detector
26  */
27
28 #include "libavutil/avassert.h"
29 #include "libavutil/opt.h"
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 #include "video.h"
34
35 enum FilterMode {
36     MODE_WIRES,
37     MODE_COLORMIX,
38     NB_MODE
39 };
40
41 struct plane_info {
42     uint8_t  *tmpbuf;
43     uint16_t *gradients;
44     char     *directions;
45 };
46
47 typedef struct {
48     const AVClass *class;
49     struct plane_info planes[3];
50     int nb_planes;
51     double   low, high;
52     uint8_t  low_u8, high_u8;
53     enum FilterMode mode;
54 } EdgeDetectContext;
55
56 #define OFFSET(x) offsetof(EdgeDetectContext, x)
57 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
58 static const AVOption edgedetect_options[] = {
59     { "high", "set high threshold", OFFSET(high), AV_OPT_TYPE_DOUBLE, {.dbl=50/255.}, 0, 1, FLAGS },
60     { "low",  "set low threshold",  OFFSET(low),  AV_OPT_TYPE_DOUBLE, {.dbl=20/255.}, 0, 1, FLAGS },
61     { "mode", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=MODE_WIRES}, 0, NB_MODE-1, FLAGS, "mode" },
62         { "wires",    "white/gray wires on black",  0, AV_OPT_TYPE_CONST, {.i64=MODE_WIRES},    INT_MIN, INT_MAX, FLAGS, "mode" },
63         { "colormix", "mix colors",                 0, AV_OPT_TYPE_CONST, {.i64=MODE_COLORMIX}, INT_MIN, INT_MAX, FLAGS, "mode" },
64     { NULL }
65 };
66
67 AVFILTER_DEFINE_CLASS(edgedetect);
68
69 static av_cold int init(AVFilterContext *ctx)
70 {
71     EdgeDetectContext *edgedetect = ctx->priv;
72
73     edgedetect->low_u8  = edgedetect->low  * 255. + .5;
74     edgedetect->high_u8 = edgedetect->high * 255. + .5;
75     return 0;
76 }
77
78 static int query_formats(AVFilterContext *ctx)
79 {
80     const EdgeDetectContext *edgedetect = ctx->priv;
81
82     if (edgedetect->mode == MODE_WIRES) {
83     /* TODO: reindent */
84     static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE};
85     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
86     } else if (edgedetect->mode == MODE_COLORMIX) {
87         static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_GBRP, AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE};
88         ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
89     } else {
90         av_assert0(0);
91     }
92     return 0;
93 }
94
95 static int config_props(AVFilterLink *inlink)
96 {
97     int p;
98     AVFilterContext *ctx = inlink->dst;
99     EdgeDetectContext *edgedetect = ctx->priv;
100
101     edgedetect->nb_planes = inlink->format == AV_PIX_FMT_GRAY8 ? 1 : 3;
102     for (p = 0; p < edgedetect->nb_planes; p++) {
103         struct plane_info *plane = &edgedetect->planes[p];
104
105         plane->tmpbuf     = av_malloc(inlink->w * inlink->h);
106         plane->gradients  = av_calloc(inlink->w * inlink->h, sizeof(*plane->gradients));
107         plane->directions = av_malloc(inlink->w * inlink->h);
108         if (!plane->tmpbuf || !plane->gradients || !plane->directions)
109             return AVERROR(ENOMEM);
110     }
111     return 0;
112 }
113
114 static void gaussian_blur(AVFilterContext *ctx, int w, int h,
115                                 uint8_t *dst, int dst_linesize,
116                           const uint8_t *src, int src_linesize)
117 {
118     int i, j;
119
120     memcpy(dst, src, w); dst += dst_linesize; src += src_linesize;
121     memcpy(dst, src, w); dst += dst_linesize; src += src_linesize;
122     for (j = 2; j < h - 2; j++) {
123         dst[0] = src[0];
124         dst[1] = src[1];
125         for (i = 2; i < w - 2; i++) {
126             /* Gaussian mask of size 5x5 with sigma = 1.4 */
127             dst[i] = ((src[-2*src_linesize + i-2] + src[2*src_linesize + i-2]) * 2
128                     + (src[-2*src_linesize + i-1] + src[2*src_linesize + i-1]) * 4
129                     + (src[-2*src_linesize + i  ] + src[2*src_linesize + i  ]) * 5
130                     + (src[-2*src_linesize + i+1] + src[2*src_linesize + i+1]) * 4
131                     + (src[-2*src_linesize + i+2] + src[2*src_linesize + i+2]) * 2
132
133                     + (src[  -src_linesize + i-2] + src[  src_linesize + i-2]) *  4
134                     + (src[  -src_linesize + i-1] + src[  src_linesize + i-1]) *  9
135                     + (src[  -src_linesize + i  ] + src[  src_linesize + i  ]) * 12
136                     + (src[  -src_linesize + i+1] + src[  src_linesize + i+1]) *  9
137                     + (src[  -src_linesize + i+2] + src[  src_linesize + i+2]) *  4
138
139                     + src[i-2] *  5
140                     + src[i-1] * 12
141                     + src[i  ] * 15
142                     + src[i+1] * 12
143                     + src[i+2] *  5) / 159;
144         }
145         dst[i    ] = src[i    ];
146         dst[i + 1] = src[i + 1];
147
148         dst += dst_linesize;
149         src += src_linesize;
150     }
151     memcpy(dst, src, w); dst += dst_linesize; src += src_linesize;
152     memcpy(dst, src, w);
153 }
154
155 enum {
156     DIRECTION_45UP,
157     DIRECTION_45DOWN,
158     DIRECTION_HORIZONTAL,
159     DIRECTION_VERTICAL,
160 };
161
162 static int get_rounded_direction(int gx, int gy)
163 {
164     /* reference angles:
165      *   tan( pi/8) = sqrt(2)-1
166      *   tan(3pi/8) = sqrt(2)+1
167      * Gy/Gx is the tangent of the angle (theta), so Gy/Gx is compared against
168      * <ref-angle>, or more simply Gy against <ref-angle>*Gx
169      *
170      * Gx and Gy bounds = [-1020;1020], using 16-bit arithmetic:
171      *   round((sqrt(2)-1) * (1<<16)) =  27146
172      *   round((sqrt(2)+1) * (1<<16)) = 158218
173      */
174     if (gx) {
175         int tanpi8gx, tan3pi8gx;
176
177         if (gx < 0)
178             gx = -gx, gy = -gy;
179         gy <<= 16;
180         tanpi8gx  =  27146 * gx;
181         tan3pi8gx = 158218 * gx;
182         if (gy > -tan3pi8gx && gy < -tanpi8gx)  return DIRECTION_45UP;
183         if (gy > -tanpi8gx  && gy <  tanpi8gx)  return DIRECTION_HORIZONTAL;
184         if (gy >  tanpi8gx  && gy <  tan3pi8gx) return DIRECTION_45DOWN;
185     }
186     return DIRECTION_VERTICAL;
187 }
188
189 static void sobel(int w, int h,
190                        uint16_t *dst, int dst_linesize,
191                          int8_t *dir, int dir_linesize,
192                   const uint8_t *src, int src_linesize)
193 {
194     int i, j;
195
196     for (j = 1; j < h - 1; j++) {
197         dst += dst_linesize;
198         dir += dir_linesize;
199         src += src_linesize;
200         for (i = 1; i < w - 1; i++) {
201             const int gx =
202                 -1*src[-src_linesize + i-1] + 1*src[-src_linesize + i+1]
203                 -2*src[                i-1] + 2*src[                i+1]
204                 -1*src[ src_linesize + i-1] + 1*src[ src_linesize + i+1];
205             const int gy =
206                 -1*src[-src_linesize + i-1] + 1*src[ src_linesize + i-1]
207                 -2*src[-src_linesize + i  ] + 2*src[ src_linesize + i  ]
208                 -1*src[-src_linesize + i+1] + 1*src[ src_linesize + i+1];
209
210             dst[i] = FFABS(gx) + FFABS(gy);
211             dir[i] = get_rounded_direction(gx, gy);
212         }
213     }
214 }
215
216 static void non_maximum_suppression(int w, int h,
217                                           uint8_t  *dst, int dst_linesize,
218                                     const  int8_t  *dir, int dir_linesize,
219                                     const uint16_t *src, int src_linesize)
220 {
221     int i, j;
222
223 #define COPY_MAXIMA(ay, ax, by, bx) do {                \
224     if (src[i] > src[(ay)*src_linesize + i+(ax)] &&     \
225         src[i] > src[(by)*src_linesize + i+(bx)])       \
226         dst[i] = av_clip_uint8(src[i]);                 \
227 } while (0)
228
229     for (j = 1; j < h - 1; j++) {
230         dst += dst_linesize;
231         dir += dir_linesize;
232         src += src_linesize;
233         for (i = 1; i < w - 1; i++) {
234             switch (dir[i]) {
235             case DIRECTION_45UP:        COPY_MAXIMA( 1, -1, -1,  1); break;
236             case DIRECTION_45DOWN:      COPY_MAXIMA(-1, -1,  1,  1); break;
237             case DIRECTION_HORIZONTAL:  COPY_MAXIMA( 0, -1,  0,  1); break;
238             case DIRECTION_VERTICAL:    COPY_MAXIMA(-1,  0,  1,  0); break;
239             }
240         }
241     }
242 }
243
244 static void double_threshold(int low, int high, int w, int h,
245                                    uint8_t *dst, int dst_linesize,
246                              const uint8_t *src, int src_linesize)
247 {
248     int i, j;
249
250     for (j = 0; j < h; j++) {
251         for (i = 0; i < w; i++) {
252             if (src[i] > high) {
253                 dst[i] = src[i];
254                 continue;
255             }
256
257             if ((!i || i == w - 1 || !j || j == h - 1) &&
258                 src[i] > low &&
259                 (src[-src_linesize + i-1] > high ||
260                  src[-src_linesize + i  ] > high ||
261                  src[-src_linesize + i+1] > high ||
262                  src[                i-1] > high ||
263                  src[                i+1] > high ||
264                  src[ src_linesize + i-1] > high ||
265                  src[ src_linesize + i  ] > high ||
266                  src[ src_linesize + i+1] > high))
267                 dst[i] = src[i];
268             else
269                 dst[i] = 0;
270         }
271         dst += dst_linesize;
272         src += src_linesize;
273     }
274 }
275
276 static void color_mix(int w, int h,
277                             uint8_t *dst, int dst_linesize,
278                       const uint8_t *src, int src_linesize)
279 {
280     int i, j;
281
282     for (j = 0; j < h; j++) {
283         for (i = 0; i < w; i++)
284             dst[i] = (dst[i] + src[i]) >> 1;
285         dst += dst_linesize;
286         src += src_linesize;
287     }
288 }
289
290 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
291 {
292     AVFilterContext *ctx = inlink->dst;
293     EdgeDetectContext *edgedetect = ctx->priv;
294     AVFilterLink *outlink = inlink->dst->outputs[0];
295     int p, direct = 0;
296     AVFrame *out;
297
298     if (edgedetect->mode != MODE_COLORMIX && av_frame_is_writable(in)) {
299         direct = 1;
300         out = in;
301     } else {
302         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
303         if (!out) {
304             av_frame_free(&in);
305             return AVERROR(ENOMEM);
306         }
307         av_frame_copy_props(out, in);
308     }
309
310     for (p = 0; p < edgedetect->nb_planes; p++) {
311         struct plane_info *plane = &edgedetect->planes[p];
312         uint8_t  *tmpbuf     = plane->tmpbuf;
313         uint16_t *gradients  = plane->gradients;
314         int8_t   *directions = plane->directions;
315
316         /* TODO: reindent */
317     /* gaussian filter to reduce noise  */
318     gaussian_blur(ctx, inlink->w, inlink->h,
319                   tmpbuf,      inlink->w,
320                   in->data[p], in->linesize[p]);
321
322     /* compute the 16-bits gradients and directions for the next step */
323     sobel(inlink->w, inlink->h,
324           gradients, inlink->w,
325           directions,inlink->w,
326           tmpbuf,    inlink->w);
327
328     /* non_maximum_suppression() will actually keep & clip what's necessary and
329      * ignore the rest, so we need a clean output buffer */
330     memset(tmpbuf, 0, inlink->w * inlink->h);
331     non_maximum_suppression(inlink->w, inlink->h,
332                             tmpbuf,    inlink->w,
333                             directions,inlink->w,
334                             gradients, inlink->w);
335
336     /* keep high values, or low values surrounded by high values */
337     double_threshold(edgedetect->low_u8, edgedetect->high_u8,
338                      inlink->w, inlink->h,
339                      out->data[p], out->linesize[p],
340                      tmpbuf,       inlink->w);
341
342         if (edgedetect->mode == MODE_COLORMIX) {
343             color_mix(inlink->w, inlink->h,
344                       out->data[p], out->linesize[p],
345                       in->data[p], in->linesize[p]);
346         }
347     }
348
349     if (!direct)
350         av_frame_free(&in);
351     return ff_filter_frame(outlink, out);
352 }
353
354 static av_cold void uninit(AVFilterContext *ctx)
355 {
356     int p;
357     EdgeDetectContext *edgedetect = ctx->priv;
358
359     for (p = 0; p < edgedetect->nb_planes; p++) {
360         struct plane_info *plane = &edgedetect->planes[p];
361         av_freep(&plane->tmpbuf);
362         av_freep(&plane->gradients);
363         av_freep(&plane->directions);
364     }
365 }
366
367 static const AVFilterPad edgedetect_inputs[] = {
368     {
369         .name         = "default",
370         .type         = AVMEDIA_TYPE_VIDEO,
371         .config_props = config_props,
372         .filter_frame = filter_frame,
373      },
374      { NULL }
375 };
376
377 static const AVFilterPad edgedetect_outputs[] = {
378      {
379          .name = "default",
380          .type = AVMEDIA_TYPE_VIDEO,
381      },
382      { NULL }
383 };
384
385 AVFilter ff_vf_edgedetect = {
386     .name          = "edgedetect",
387     .description   = NULL_IF_CONFIG_SMALL("Detect and draw edge."),
388     .priv_size     = sizeof(EdgeDetectContext),
389     .init          = init,
390     .uninit        = uninit,
391     .query_formats = query_formats,
392     .inputs        = edgedetect_inputs,
393     .outputs       = edgedetect_outputs,
394     .priv_class    = &edgedetect_class,
395     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
396 };