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.
6 * This file is part of Libav.
8 * Libav 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.
13 * Libav 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.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with Libav; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * blur / sharpen filter, ported to Libav from MPlayer
26 * libmpcodecs/unsharp.c.
28 * This code is based on:
30 * An Efficient algorithm for Gaussian blur using finite-state machines
31 * Frederick M. Waltz and John W. V. Miller
33 * SPIE Conf. on Machine Vision Systems for Inspection and Metrology VII
34 * Originally published Boston, Nov 98
36 * http://www.engin.umd.umich.edu/~jwvm/ece581/21_GBlur.pdf
43 #include "libavutil/common.h"
44 #include "libavutil/mem.h"
45 #include "libavutil/opt.h"
46 #include "libavutil/pixdesc.h"
51 /* right-shift and round-up */
52 #define SHIFTUP(x,shift) (-((-(x))>>(shift)))
54 typedef struct FilterParam {
55 int msize_x; ///< matrix width
56 int msize_y; ///< matrix height
57 int amount; ///< effect amount
58 int steps_x; ///< horizontal step count
59 int steps_y; ///< vertical step count
60 int scalebits; ///< bits to shift pixel
61 int32_t halfscale; ///< amount to add to pixel
62 uint32_t *sc[(MAX_SIZE * MAX_SIZE) - 1]; ///< finite state machine storage
67 int lmsize_x, lmsize_y, cmsize_x, cmsize_y;
68 float lamount, camount;
69 FilterParam luma; ///< luma parameters (width, height, amount)
70 FilterParam chroma; ///< chroma parameters (width, height, amount)
74 static void apply_unsharp( uint8_t *dst, int dst_stride,
75 const uint8_t *src, int src_stride,
76 int width, int height, FilterParam *fp)
78 uint32_t **sc = fp->sc;
79 uint32_t sr[(MAX_SIZE * MAX_SIZE) - 1], tmp1, tmp2;
86 if (dst_stride == src_stride)
87 memcpy(dst, src, src_stride * height);
89 for (y = 0; y < height; y++, dst += dst_stride, src += src_stride)
90 memcpy(dst, src, width);
94 for (y = 0; y < 2 * fp->steps_y; y++)
95 memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * fp->steps_x));
97 for (y = -fp->steps_y; y < height + fp->steps_y; y++) {
101 memset(sr, 0, sizeof(sr[0]) * (2 * fp->steps_x - 1));
102 for (x = -fp->steps_x; x < width + fp->steps_x; x++) {
103 tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
104 for (z = 0; z < fp->steps_x * 2; z += 2) {
105 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
106 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
108 for (z = 0; z < fp->steps_y * 2; z += 2) {
109 tmp2 = sc[z + 0][x + fp->steps_x] + tmp1; sc[z + 0][x + fp->steps_x] = tmp1;
110 tmp1 = sc[z + 1][x + fp->steps_x] + tmp2; sc[z + 1][x + fp->steps_x] = tmp2;
112 if (x >= fp->steps_x && y >= fp->steps_y) {
113 const uint8_t *srx = src - fp->steps_y * src_stride + x - fp->steps_x;
114 uint8_t *dsx = dst - fp->steps_y * dst_stride + x - fp->steps_x;
116 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + fp->halfscale) >> fp->scalebits)) * fp->amount) >> 16);
117 *dsx = av_clip_uint8(res);
127 static void set_filter_param(FilterParam *fp, int msize_x, int msize_y, float amount)
129 fp->msize_x = msize_x;
130 fp->msize_y = msize_y;
131 fp->amount = amount * 65536.0;
133 fp->steps_x = msize_x / 2;
134 fp->steps_y = msize_y / 2;
135 fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
136 fp->halfscale = 1 << (fp->scalebits - 1);
139 static av_cold int init(AVFilterContext *ctx)
141 UnsharpContext *unsharp = ctx->priv;
143 set_filter_param(&unsharp->luma, unsharp->lmsize_x, unsharp->lmsize_y, unsharp->lamount);
144 set_filter_param(&unsharp->chroma, unsharp->cmsize_x, unsharp->cmsize_y, unsharp->camount);
149 static int query_formats(AVFilterContext *ctx)
151 enum AVPixelFormat pix_fmts[] = {
152 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV410P,
153 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
154 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
157 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
162 static void init_filter_param(AVFilterContext *ctx, FilterParam *fp, const char *effect_type, int width)
167 effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
169 av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
170 effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
172 for (z = 0; z < 2 * fp->steps_y; z++)
173 fp->sc[z] = av_malloc(sizeof(*(fp->sc[z])) * (width + 2 * fp->steps_x));
176 static int config_props(AVFilterLink *link)
178 UnsharpContext *unsharp = link->dst->priv;
179 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
181 unsharp->hsub = desc->log2_chroma_w;
182 unsharp->vsub = desc->log2_chroma_h;
184 init_filter_param(link->dst, &unsharp->luma, "luma", link->w);
185 init_filter_param(link->dst, &unsharp->chroma, "chroma", SHIFTUP(link->w, unsharp->hsub));
190 static void free_filter_param(FilterParam *fp)
194 for (z = 0; z < 2 * fp->steps_y; z++)
198 static av_cold void uninit(AVFilterContext *ctx)
200 UnsharpContext *unsharp = ctx->priv;
202 free_filter_param(&unsharp->luma);
203 free_filter_param(&unsharp->chroma);
206 static int filter_frame(AVFilterLink *link, AVFrame *in)
208 UnsharpContext *unsharp = link->dst->priv;
209 AVFilterLink *outlink = link->dst->outputs[0];
211 int cw = SHIFTUP(link->w, unsharp->hsub);
212 int ch = SHIFTUP(link->h, unsharp->vsub);
214 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
217 return AVERROR(ENOMEM);
219 av_frame_copy_props(out, in);
221 apply_unsharp(out->data[0], out->linesize[0], in->data[0], in->linesize[0], link->w, link->h, &unsharp->luma);
222 apply_unsharp(out->data[1], out->linesize[1], in->data[1], in->linesize[1], cw, ch, &unsharp->chroma);
223 apply_unsharp(out->data[2], out->linesize[2], in->data[2], in->linesize[2], cw, ch, &unsharp->chroma);
226 return ff_filter_frame(outlink, out);
229 #define OFFSET(x) offsetof(UnsharpContext, x)
230 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
231 static const AVOption options[] = {
232 { "luma_msize_x", "luma matrix horizontal size", OFFSET(lmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
233 { "luma_msize_y", "luma matrix vertical size", OFFSET(lmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
234 { "luma_amount", "luma effect strength", OFFSET(lamount), AV_OPT_TYPE_FLOAT, { .dbl = 1 }, -2, 5, FLAGS },
235 { "chroma_msize_x", "chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
236 { "chroma_msize_y", "chroma matrix vertical size", OFFSET(cmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
237 { "chroma_amount", "chroma effect strength", OFFSET(camount), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -2, 5, FLAGS },
241 static const AVClass unsharp_class = {
242 .class_name = "unsharp",
243 .item_name = av_default_item_name,
245 .version = LIBAVUTIL_VERSION_INT,
248 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
251 .type = AVMEDIA_TYPE_VIDEO,
252 .filter_frame = filter_frame,
253 .config_props = config_props,
258 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
261 .type = AVMEDIA_TYPE_VIDEO,
266 AVFilter ff_vf_unsharp = {
268 .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
270 .priv_size = sizeof(UnsharpContext),
271 .priv_class = &unsharp_class,
275 .query_formats = query_formats,
277 .inputs = avfilter_vf_unsharp_inputs,
279 .outputs = avfilter_vf_unsharp_outputs,