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 FFmpeg.
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.
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.
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
25 * blur / sharpen filter, ported to FFmpeg 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/imgutils.h"
45 #include "libavutil/mem.h"
46 #include "libavutil/opt.h"
47 #include "libavutil/pixdesc.h"
50 static void apply_unsharp( uint8_t *dst, int dst_stride,
51 const uint8_t *src, int src_stride,
52 int width, int height, UnsharpFilterParam *fp)
54 uint32_t **sc = fp->sc;
55 uint32_t sr[MAX_MATRIX_SIZE - 1], tmp1, tmp2;
59 const uint8_t *src2 = NULL; //silence a warning
60 const int amount = fp->amount;
61 const int steps_x = fp->steps_x;
62 const int steps_y = fp->steps_y;
63 const int scalebits = fp->scalebits;
64 const int32_t halfscale = fp->halfscale;
67 av_image_copy_plane(dst, dst_stride, src, src_stride, width, height);
71 for (y = 0; y < 2 * steps_y; y++)
72 memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * steps_x));
74 for (y = -steps_y; y < height + steps_y; y++) {
78 memset(sr, 0, sizeof(sr[0]) * (2 * steps_x - 1));
79 for (x = -steps_x; x < width + steps_x; x++) {
80 tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
81 for (z = 0; z < steps_x * 2; z += 2) {
82 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
83 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
85 for (z = 0; z < steps_y * 2; z += 2) {
86 tmp2 = sc[z + 0][x + steps_x] + tmp1; sc[z + 0][x + steps_x] = tmp1;
87 tmp1 = sc[z + 1][x + steps_x] + tmp2; sc[z + 1][x + steps_x] = tmp2;
89 if (x >= steps_x && y >= steps_y) {
90 const uint8_t *srx = src - steps_y * src_stride + x - steps_x;
91 uint8_t *dsx = dst - steps_y * dst_stride + x - steps_x;
93 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + halfscale) >> scalebits)) * amount) >> 16);
94 *dsx = av_clip_uint8(res);
104 static int apply_unsharp_c(AVFilterContext *ctx, AVFrame *in, AVFrame *out)
106 AVFilterLink *inlink = ctx->inputs[0];
107 UnsharpContext *s = ctx->priv;
108 int i, plane_w[3], plane_h[3];
109 UnsharpFilterParam *fp[3];
110 plane_w[0] = inlink->w;
111 plane_w[1] = plane_w[2] = AV_CEIL_RSHIFT(inlink->w, s->hsub);
112 plane_h[0] = inlink->h;
113 plane_h[1] = plane_h[2] = AV_CEIL_RSHIFT(inlink->h, s->vsub);
115 fp[1] = fp[2] = &s->chroma;
116 for (i = 0; i < 3; i++) {
117 apply_unsharp(out->data[i], out->linesize[i], in->data[i], in->linesize[i], plane_w[i], plane_h[i], fp[i]);
122 static void set_filter_param(UnsharpFilterParam *fp, int msize_x, int msize_y, float amount)
124 fp->msize_x = msize_x;
125 fp->msize_y = msize_y;
126 fp->amount = amount * 65536.0;
128 fp->steps_x = msize_x / 2;
129 fp->steps_y = msize_y / 2;
130 fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
131 fp->halfscale = 1 << (fp->scalebits - 1);
134 static av_cold int init(AVFilterContext *ctx)
136 UnsharpContext *s = ctx->priv;
138 set_filter_param(&s->luma, s->lmsize_x, s->lmsize_y, s->lamount);
139 set_filter_param(&s->chroma, s->cmsize_x, s->cmsize_y, s->camount);
141 if (s->luma.scalebits >= 26 || s->chroma.scalebits >= 26) {
142 av_log(ctx, AV_LOG_ERROR, "luma or chroma matrix size too big\n");
143 return AVERROR(EINVAL);
145 s->apply_unsharp = apply_unsharp_c;
149 static int query_formats(AVFilterContext *ctx)
151 static const 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 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
159 return AVERROR(ENOMEM);
160 return ff_set_common_formats(ctx, fmts_list);
163 static int init_filter_param(AVFilterContext *ctx, UnsharpFilterParam *fp, const char *effect_type, int width)
166 const char *effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
168 if (!(fp->msize_x & fp->msize_y & 1)) {
169 av_log(ctx, AV_LOG_ERROR,
170 "Invalid even size for %s matrix size %dx%d\n",
171 effect_type, fp->msize_x, fp->msize_y);
172 return AVERROR(EINVAL);
175 av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
176 effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
178 for (z = 0; z < 2 * fp->steps_y; z++)
179 if (!(fp->sc[z] = av_malloc_array(width + 2 * fp->steps_x,
180 sizeof(*(fp->sc[z])))))
181 return AVERROR(ENOMEM);
186 static int config_props(AVFilterLink *link)
188 UnsharpContext *s = link->dst->priv;
189 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
192 s->hsub = desc->log2_chroma_w;
193 s->vsub = desc->log2_chroma_h;
195 ret = init_filter_param(link->dst, &s->luma, "luma", link->w);
198 ret = init_filter_param(link->dst, &s->chroma, "chroma", AV_CEIL_RSHIFT(link->w, s->hsub));
205 static void free_filter_param(UnsharpFilterParam *fp)
209 for (z = 0; z < 2 * fp->steps_y; z++)
210 av_freep(&fp->sc[z]);
213 static av_cold void uninit(AVFilterContext *ctx)
215 UnsharpContext *s = ctx->priv;
217 free_filter_param(&s->luma);
218 free_filter_param(&s->chroma);
221 static int filter_frame(AVFilterLink *link, AVFrame *in)
223 UnsharpContext *s = link->dst->priv;
224 AVFilterLink *outlink = link->dst->outputs[0];
228 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
231 return AVERROR(ENOMEM);
233 av_frame_copy_props(out, in);
235 ret = s->apply_unsharp(link->dst, in, out);
243 return ff_filter_frame(outlink, out);
246 #define OFFSET(x) offsetof(UnsharpContext, x)
247 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
250 static const AVOption unsharp_options[] = {
251 { "luma_msize_x", "set luma matrix horizontal size", OFFSET(lmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
252 { "lx", "set luma matrix horizontal size", OFFSET(lmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
253 { "luma_msize_y", "set luma matrix vertical size", OFFSET(lmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
254 { "ly", "set luma matrix vertical size", OFFSET(lmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
255 { "luma_amount", "set luma effect strength", OFFSET(lamount), AV_OPT_TYPE_FLOAT, { .dbl = 1 }, -2, 5, FLAGS },
256 { "la", "set luma effect strength", OFFSET(lamount), AV_OPT_TYPE_FLOAT, { .dbl = 1 }, -2, 5, FLAGS },
257 { "chroma_msize_x", "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
258 { "cx", "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
259 { "chroma_msize_y", "set chroma matrix vertical size", OFFSET(cmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
260 { "cy", "set chroma matrix vertical size", OFFSET(cmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
261 { "chroma_amount", "set chroma effect strength", OFFSET(camount), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -2, 5, FLAGS },
262 { "ca", "set chroma effect strength", OFFSET(camount), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -2, 5, FLAGS },
263 { "opencl", "ignored", OFFSET(opencl), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
267 AVFILTER_DEFINE_CLASS(unsharp);
269 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
272 .type = AVMEDIA_TYPE_VIDEO,
273 .filter_frame = filter_frame,
274 .config_props = config_props,
279 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
282 .type = AVMEDIA_TYPE_VIDEO,
287 AVFilter ff_vf_unsharp = {
289 .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
290 .priv_size = sizeof(UnsharpContext),
291 .priv_class = &unsharp_class,
294 .query_formats = query_formats,
295 .inputs = avfilter_vf_unsharp_inputs,
296 .outputs = avfilter_vf_unsharp_outputs,
297 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,