lavfi/unsharp: add check on matrix x/y size values oddity
[ffmpeg.git] / libavfilter / vf_unsharp.c
1 /*
2  * Original copyright (c) 2002 Remi Guyomarch <rguyom@pobox.com>
3  * Port copyright (c) 2010 Daniel G. Taylor <dan@programmer-art.org>
4  * Relicensed to the LGPL with permission from Remi Guyomarch.
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * blur / sharpen filter, ported to FFmpeg from MPlayer
26  * libmpcodecs/unsharp.c.
27  *
28  * This code is based on:
29  *
30  * An Efficient algorithm for Gaussian blur using finite-state machines
31  * Frederick M. Waltz and John W. V. Miller
32  *
33  * SPIE Conf. on Machine Vision Systems for Inspection and Metrology VII
34  * Originally published Boston, Nov 98
35  *
36  * http://www.engin.umd.umich.edu/~jwvm/ece581/21_GBlur.pdf
37  */
38
39 #include <float.h> /* DBL_MAX */
40
41 #include "avfilter.h"
42 #include "formats.h"
43 #include "internal.h"
44 #include "video.h"
45 #include "libavutil/common.h"
46 #include "libavutil/mem.h"
47 #include "libavutil/opt.h"
48 #include "libavutil/pixdesc.h"
49
50 #define MIN_MATRIX_SIZE 3
51 #define MAX_MATRIX_SIZE 63
52
53 /* right-shift and round-up */
54 #define SHIFTUP(x,shift) (-((-(x))>>(shift)))
55
56 typedef struct FilterParam {
57     int msize_x;                             ///< matrix width
58     int msize_y;                             ///< matrix height
59     int amount;                              ///< effect amount
60     int steps_x;                             ///< horizontal step count
61     int steps_y;                             ///< vertical step count
62     int scalebits;                           ///< bits to shift pixel
63     int32_t halfscale;                       ///< amount to add to pixel
64     uint32_t *sc[MAX_MATRIX_SIZE - 1];       ///< finite state machine storage
65 } FilterParam;
66
67 typedef struct {
68     const AVClass *class;
69     FilterParam luma;   ///< luma parameters (width, height, amount)
70     FilterParam chroma; ///< chroma parameters (width, height, amount)
71     int hsub, vsub;
72     int luma_msize_x, luma_msize_y, chroma_msize_x, chroma_msize_y;
73     double luma_amount, chroma_amount;
74 } UnsharpContext;
75
76 #define OFFSET(x) offsetof(UnsharpContext, x)
77
78 static const AVOption unsharp_options[] = {
79     { "luma_msize_x",    "set luma matrix x size",     OFFSET(luma_msize_x),    AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
80     { "lx",              "set luma matrix x size",     OFFSET(luma_msize_x),    AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
81     { "luma_msize_y",    "set luma matrix y size",     OFFSET(luma_msize_y),    AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
82     { "ly",              "set luma matrix y size",     OFFSET(luma_msize_y),    AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
83     { "luma_amount",     "set luma effect amount",     OFFSET(luma_amount),     AV_OPT_TYPE_DOUBLE, {.dbl=1.0}, -DBL_MAX, DBL_MAX },
84     { "la",              "set luma effect amount",     OFFSET(luma_amount),     AV_OPT_TYPE_DOUBLE, {.dbl=1.0}, -DBL_MAX, DBL_MAX },
85
86     { "chroma_msize_x",  "set chroma matrix x size",   OFFSET(chroma_msize_x), AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
87     { "cx",              "set chroma matrix x size",   OFFSET(chroma_msize_x), AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
88     { "chroma_msize_y",  "set chroma matrix y size",   OFFSET(chroma_msize_y), AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
89     { "cy"          ,    "set chroma matrix y size",   OFFSET(chroma_msize_y), AV_OPT_TYPE_INT,    {.i64=5}, 3, 63 },
90     { "chroma_amount",   "set chroma effect strenght", OFFSET(chroma_amount),  AV_OPT_TYPE_DOUBLE, {.dbl=0.0}, -DBL_MAX, DBL_MAX },
91     { "ca",              "set chroma effect strenght", OFFSET(chroma_amount),  AV_OPT_TYPE_DOUBLE, {.dbl=0.0}, -DBL_MAX, DBL_MAX },
92
93     { NULL }
94 };
95
96 AVFILTER_DEFINE_CLASS(unsharp);
97
98 static void apply_unsharp(      uint8_t *dst, int dst_stride,
99                           const uint8_t *src, int src_stride,
100                           int width, int height, FilterParam *fp)
101 {
102     uint32_t **sc = fp->sc;
103     uint32_t sr[MAX_MATRIX_SIZE - 1], tmp1, tmp2;
104
105     int32_t res;
106     int x, y, z;
107     const uint8_t *src2 = NULL;  //silence a warning
108
109     if (!fp->amount) {
110         if (dst_stride == src_stride)
111             memcpy(dst, src, src_stride * height);
112         else
113             for (y = 0; y < height; y++, dst += dst_stride, src += src_stride)
114                 memcpy(dst, src, width);
115         return;
116     }
117
118     for (y = 0; y < 2 * fp->steps_y; y++)
119         memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * fp->steps_x));
120
121     for (y = -fp->steps_y; y < height + fp->steps_y; y++) {
122         if (y < height)
123             src2 = src;
124
125         memset(sr, 0, sizeof(sr[0]) * (2 * fp->steps_x - 1));
126         for (x = -fp->steps_x; x < width + fp->steps_x; x++) {
127             tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
128             for (z = 0; z < fp->steps_x * 2; z += 2) {
129                 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
130                 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
131             }
132             for (z = 0; z < fp->steps_y * 2; z += 2) {
133                 tmp2 = sc[z + 0][x + fp->steps_x] + tmp1; sc[z + 0][x + fp->steps_x] = tmp1;
134                 tmp1 = sc[z + 1][x + fp->steps_x] + tmp2; sc[z + 1][x + fp->steps_x] = tmp2;
135             }
136             if (x >= fp->steps_x && y >= fp->steps_y) {
137                 const uint8_t *srx = src - fp->steps_y * src_stride + x - fp->steps_x;
138                 uint8_t *dsx       = dst - fp->steps_y * dst_stride + x - fp->steps_x;
139
140                 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + fp->halfscale) >> fp->scalebits)) * fp->amount) >> 16);
141                 *dsx = av_clip_uint8(res);
142             }
143         }
144         if (y >= 0) {
145             dst += dst_stride;
146             src += src_stride;
147         }
148     }
149 }
150
151 static void set_filter_param(FilterParam *fp, int msize_x, int msize_y, double amount)
152 {
153     fp->msize_x = msize_x;
154     fp->msize_y = msize_y;
155     fp->amount = amount * 65536.0;
156
157     fp->steps_x = msize_x / 2;
158     fp->steps_y = msize_y / 2;
159     fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
160     fp->halfscale = 1 << (fp->scalebits - 1);
161 }
162
163 static av_cold int init(AVFilterContext *ctx, const char *args)
164 {
165     UnsharpContext *unsharp = ctx->priv;
166     static const char *shorthand[] = {
167         "luma_msize_x", "luma_msize_y", "luma_amount",
168         "chroma_msize_x", "chroma_msize_y", "chroma_amount",
169         NULL
170     };
171     int ret;
172
173     unsharp->class = &unsharp_class;
174     av_opt_set_defaults(unsharp);
175
176     if ((ret = av_opt_set_from_string(unsharp, args, shorthand, "=", ":")) < 0)
177         return ret;
178
179     set_filter_param(&unsharp->luma,   unsharp->luma_msize_x,   unsharp->luma_msize_y,   unsharp->luma_amount);
180     set_filter_param(&unsharp->chroma, unsharp->chroma_msize_x, unsharp->chroma_msize_y, unsharp->chroma_amount);
181
182     return 0;
183 }
184
185 static int query_formats(AVFilterContext *ctx)
186 {
187     static const enum AVPixelFormat pix_fmts[] = {
188         AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV410P,
189         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
190         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
191     };
192
193     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
194
195     return 0;
196 }
197
198 static int init_filter_param(AVFilterContext *ctx, FilterParam *fp, const char *effect_type, int width)
199 {
200     int z;
201     const char *effect;
202
203     if  (!(fp->msize_x & fp->msize_y & 1)) {
204         av_log(ctx, AV_LOG_ERROR,
205                "Invalid even size for %s matrix size %dx%d\n",
206                effect_type, fp->msize_x, fp->msize_y);
207         return AVERROR(EINVAL);
208     }
209
210     effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
211
212     av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
213            effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
214
215     for (z = 0; z < 2 * fp->steps_y; z++)
216         fp->sc[z] = av_malloc(sizeof(*(fp->sc[z])) * (width + 2 * fp->steps_x));
217
218     return 0;
219 }
220
221 static int config_props(AVFilterLink *link)
222 {
223     UnsharpContext *unsharp = link->dst->priv;
224     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
225     int ret;
226
227     unsharp->hsub = desc->log2_chroma_w;
228     unsharp->vsub = desc->log2_chroma_h;
229
230     ret = init_filter_param(link->dst, &unsharp->luma,   "luma",   link->w);
231     if (ret < 0)
232         return ret;
233     ret = init_filter_param(link->dst, &unsharp->chroma, "chroma", SHIFTUP(link->w, unsharp->hsub));
234     if (ret < 0)
235         return ret;
236
237     return 0;
238 }
239
240 static void free_filter_param(FilterParam *fp)
241 {
242     int z;
243
244     for (z = 0; z < 2 * fp->steps_y; z++)
245         av_free(fp->sc[z]);
246 }
247
248 static av_cold void uninit(AVFilterContext *ctx)
249 {
250     UnsharpContext *unsharp = ctx->priv;
251
252     free_filter_param(&unsharp->luma);
253     free_filter_param(&unsharp->chroma);
254     av_opt_free(unsharp);
255 }
256
257 static int filter_frame(AVFilterLink *link, AVFilterBufferRef *in)
258 {
259     UnsharpContext *unsharp = link->dst->priv;
260     AVFilterLink *outlink   = link->dst->outputs[0];
261     AVFilterBufferRef *out;
262     int cw = SHIFTUP(link->w, unsharp->hsub);
263     int ch = SHIFTUP(link->h, unsharp->vsub);
264
265     out = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
266     if (!out) {
267         avfilter_unref_bufferp(&in);
268         return AVERROR(ENOMEM);
269     }
270     avfilter_copy_buffer_ref_props(out, in);
271
272     apply_unsharp(out->data[0], out->linesize[0], in->data[0], in->linesize[0], link->w, link->h, &unsharp->luma);
273     apply_unsharp(out->data[1], out->linesize[1], in->data[1], in->linesize[1], cw,      ch,      &unsharp->chroma);
274     apply_unsharp(out->data[2], out->linesize[2], in->data[2], in->linesize[2], cw,      ch,      &unsharp->chroma);
275
276     avfilter_unref_bufferp(&in);
277     return ff_filter_frame(outlink, out);
278 }
279
280 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
281     {
282         .name         = "default",
283         .type         = AVMEDIA_TYPE_VIDEO,
284         .filter_frame = filter_frame,
285         .config_props = config_props,
286         .min_perms    = AV_PERM_READ,
287     },
288     { NULL }
289 };
290
291 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
292     {
293         .name = "default",
294         .type = AVMEDIA_TYPE_VIDEO,
295     },
296     { NULL }
297 };
298
299 AVFilter avfilter_vf_unsharp = {
300     .name      = "unsharp",
301     .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
302
303     .priv_size = sizeof(UnsharpContext),
304
305     .init = init,
306     .uninit = uninit,
307     .query_formats = query_formats,
308
309     .inputs    = avfilter_vf_unsharp_inputs,
310
311     .outputs   = avfilter_vf_unsharp_outputs,
312
313     .priv_class = &unsharp_class,
314 };