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