avfilter: various cosmetics
[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 "avfilter.h"
40 #include "formats.h"
41 #include "internal.h"
42 #include "video.h"
43 #include "libavutil/common.h"
44 #include "libavutil/imgutils.h"
45 #include "libavutil/mem.h"
46 #include "libavutil/opt.h"
47 #include "libavutil/pixdesc.h"
48 #include "unsharp.h"
49 #include "unsharp_opencl.h"
50
51 static void apply_unsharp(      uint8_t *dst, int dst_stride,
52                           const uint8_t *src, int src_stride,
53                           int width, int height, UnsharpFilterParam *fp)
54 {
55     uint32_t **sc = fp->sc;
56     uint32_t sr[MAX_MATRIX_SIZE - 1], tmp1, tmp2;
57
58     int32_t res;
59     int x, y, z;
60     const uint8_t *src2 = NULL;  //silence a warning
61     const int amount = fp->amount;
62     const int steps_x = fp->steps_x;
63     const int steps_y = fp->steps_y;
64     const int scalebits = fp->scalebits;
65     const int32_t halfscale = fp->halfscale;
66
67     if (!amount) {
68         av_image_copy_plane(dst, dst_stride, src, src_stride, width, height);
69         return;
70     }
71
72     for (y = 0; y < 2 * steps_y; y++)
73         memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * steps_x));
74
75     for (y = -steps_y; y < height + steps_y; y++) {
76         if (y < height)
77             src2 = src;
78
79         memset(sr, 0, sizeof(sr[0]) * (2 * steps_x - 1));
80         for (x = -steps_x; x < width + steps_x; x++) {
81             tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
82             for (z = 0; z < steps_x * 2; z += 2) {
83                 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
84                 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
85             }
86             for (z = 0; z < steps_y * 2; z += 2) {
87                 tmp2 = sc[z + 0][x + steps_x] + tmp1; sc[z + 0][x + steps_x] = tmp1;
88                 tmp1 = sc[z + 1][x + steps_x] + tmp2; sc[z + 1][x + steps_x] = tmp2;
89             }
90             if (x >= steps_x && y >= steps_y) {
91                 const uint8_t *srx = src - steps_y * src_stride + x - steps_x;
92                 uint8_t *dsx       = dst - steps_y * dst_stride + x - steps_x;
93
94                 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + halfscale) >> scalebits)) * amount) >> 16);
95                 *dsx = av_clip_uint8(res);
96             }
97         }
98         if (y >= 0) {
99             dst += dst_stride;
100             src += src_stride;
101         }
102     }
103 }
104
105 static int apply_unsharp_c(AVFilterContext *ctx, AVFrame *in, AVFrame *out)
106 {
107     AVFilterLink *inlink = ctx->inputs[0];
108     UnsharpContext *unsharp = ctx->priv;
109     int i, plane_w[3], plane_h[3];
110     UnsharpFilterParam *fp[3];
111     plane_w[0] = inlink->w;
112     plane_w[1] = plane_w[2] = FF_CEIL_RSHIFT(inlink->w, unsharp->hsub);
113     plane_h[0] = inlink->h;
114     plane_h[1] = plane_h[2] = FF_CEIL_RSHIFT(inlink->h, unsharp->vsub);
115     fp[0] = &unsharp->luma;
116     fp[1] = fp[2] = &unsharp->chroma;
117     for (i = 0; i < 3; i++) {
118         apply_unsharp(out->data[i], out->linesize[i], in->data[i], in->linesize[i], plane_w[i], plane_h[i], fp[i]);
119     }
120     return 0;
121 }
122
123 static void set_filter_param(UnsharpFilterParam *fp, int msize_x, int msize_y, float amount)
124 {
125     fp->msize_x = msize_x;
126     fp->msize_y = msize_y;
127     fp->amount = amount * 65536.0;
128
129     fp->steps_x = msize_x / 2;
130     fp->steps_y = msize_y / 2;
131     fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
132     fp->halfscale = 1 << (fp->scalebits - 1);
133 }
134
135 static av_cold int init(AVFilterContext *ctx)
136 {
137     int ret = 0;
138     UnsharpContext *unsharp = ctx->priv;
139
140
141     set_filter_param(&unsharp->luma,   unsharp->lmsize_x, unsharp->lmsize_y, unsharp->lamount);
142     set_filter_param(&unsharp->chroma, unsharp->cmsize_x, unsharp->cmsize_y, unsharp->camount);
143
144     unsharp->apply_unsharp = apply_unsharp_c;
145     if (!CONFIG_OPENCL && unsharp->opencl) {
146         av_log(ctx, AV_LOG_ERROR, "OpenCL support was not enabled in this build, cannot be selected\n");
147         return AVERROR(EINVAL);
148     }
149     if (CONFIG_OPENCL && unsharp->opencl) {
150         unsharp->apply_unsharp = ff_opencl_apply_unsharp;
151         ret = ff_opencl_unsharp_init(ctx);
152         if (ret < 0)
153             return ret;
154     }
155     return 0;
156 }
157
158 static int query_formats(AVFilterContext *ctx)
159 {
160     static const enum AVPixelFormat pix_fmts[] = {
161         AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV410P,
162         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
163         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
164     };
165
166     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
167
168     return 0;
169 }
170
171 static int init_filter_param(AVFilterContext *ctx, UnsharpFilterParam *fp, const char *effect_type, int width)
172 {
173     int z;
174     const char *effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
175
176     if  (!(fp->msize_x & fp->msize_y & 1)) {
177         av_log(ctx, AV_LOG_ERROR,
178                "Invalid even size for %s matrix size %dx%d\n",
179                effect_type, fp->msize_x, fp->msize_y);
180         return AVERROR(EINVAL);
181     }
182
183     av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
184            effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
185
186     for (z = 0; z < 2 * fp->steps_y; z++)
187         if (!(fp->sc[z] = av_malloc(sizeof(*(fp->sc[z])) * (width + 2 * fp->steps_x))))
188             return AVERROR(ENOMEM);
189
190     return 0;
191 }
192
193 static int config_props(AVFilterLink *link)
194 {
195     UnsharpContext *unsharp = link->dst->priv;
196     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
197     int ret;
198
199     unsharp->hsub = desc->log2_chroma_w;
200     unsharp->vsub = desc->log2_chroma_h;
201
202     ret = init_filter_param(link->dst, &unsharp->luma,   "luma",   link->w);
203     if (ret < 0)
204         return ret;
205     ret = init_filter_param(link->dst, &unsharp->chroma, "chroma", FF_CEIL_RSHIFT(link->w, unsharp->hsub));
206     if (ret < 0)
207         return ret;
208
209     return 0;
210 }
211
212 static void free_filter_param(UnsharpFilterParam *fp)
213 {
214     int z;
215
216     for (z = 0; z < 2 * fp->steps_y; z++)
217         av_free(fp->sc[z]);
218 }
219
220 static av_cold void uninit(AVFilterContext *ctx)
221 {
222     UnsharpContext *unsharp = ctx->priv;
223
224     if (CONFIG_OPENCL && unsharp->opencl) {
225         ff_opencl_unsharp_uninit(ctx);
226     }
227
228     free_filter_param(&unsharp->luma);
229     free_filter_param(&unsharp->chroma);
230 }
231
232 static int filter_frame(AVFilterLink *link, AVFrame *in)
233 {
234     UnsharpContext *unsharp = link->dst->priv;
235     AVFilterLink *outlink   = link->dst->outputs[0];
236     AVFrame *out;
237     int ret = 0;
238
239     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
240     if (!out) {
241         av_frame_free(&in);
242         return AVERROR(ENOMEM);
243     }
244     av_frame_copy_props(out, in);
245     if (CONFIG_OPENCL && unsharp->opencl) {
246         ret = ff_opencl_unsharp_process_inout_buf(link->dst, in, out);
247         if (ret < 0)
248             goto end;
249     }
250
251     ret = unsharp->apply_unsharp(link->dst, in, out);
252 end:
253     av_frame_free(&in);
254
255     if (ret < 0)
256         return ret;
257     return ff_filter_frame(outlink, out);
258 }
259
260 #define OFFSET(x) offsetof(UnsharpContext, x)
261 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
262 #define MIN_SIZE 3
263 #define MAX_SIZE 63
264 static const AVOption unsharp_options[] = {
265     { "luma_msize_x",   "set luma matrix horizontal size",   OFFSET(lmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
266     { "lx",             "set luma matrix horizontal size",   OFFSET(lmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
267     { "luma_msize_y",   "set luma matrix vertical size",     OFFSET(lmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
268     { "ly",             "set luma matrix vertical size",     OFFSET(lmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
269     { "luma_amount",    "set luma effect strength",          OFFSET(lamount),  AV_OPT_TYPE_FLOAT, { .dbl = 1 },       -2,        5, FLAGS },
270     { "la",             "set luma effect strength",          OFFSET(lamount),  AV_OPT_TYPE_FLOAT, { .dbl = 1 },       -2,        5, FLAGS },
271     { "chroma_msize_x", "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
272     { "cx",             "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
273     { "chroma_msize_y", "set chroma matrix vertical size",   OFFSET(cmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
274     { "cy",             "set chroma matrix vertical size",   OFFSET(cmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
275     { "chroma_amount",  "set chroma effect strength",        OFFSET(camount),  AV_OPT_TYPE_FLOAT, { .dbl = 0 },       -2,        5, FLAGS },
276     { "ca",             "set chroma effect strength",        OFFSET(camount),  AV_OPT_TYPE_FLOAT, { .dbl = 0 },       -2,        5, FLAGS },
277     { "opencl",         "use OpenCL filtering capabilities", OFFSET(opencl), AV_OPT_TYPE_INT, { .i64 = 0 },        0,        1, FLAGS },
278     { NULL }
279 };
280
281 AVFILTER_DEFINE_CLASS(unsharp);
282
283 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
284     {
285         .name         = "default",
286         .type         = AVMEDIA_TYPE_VIDEO,
287         .filter_frame = filter_frame,
288         .config_props = config_props,
289     },
290     { NULL }
291 };
292
293 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
294     {
295         .name = "default",
296         .type = AVMEDIA_TYPE_VIDEO,
297     },
298     { NULL }
299 };
300
301 AVFilter avfilter_vf_unsharp = {
302     .name          = "unsharp",
303     .description   = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
304     .priv_size     = sizeof(UnsharpContext),
305     .priv_class    = &unsharp_class,
306     .init          = init,
307     .uninit        = uninit,
308     .query_formats = query_formats,
309     .inputs        = avfilter_vf_unsharp_inputs,
310     .outputs       = avfilter_vf_unsharp_outputs,
311     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
312 };