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 typedef struct TheadData {
51 UnsharpFilterParam *fp;
60 static int unsharp_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
63 UnsharpFilterParam *fp = td->fp;
64 uint32_t **sc = fp->sc;
65 uint32_t *sr = fp->sr;
66 const uint8_t *src2 = NULL; //silence a warning
67 const int amount = fp->amount;
68 const int steps_x = fp->steps_x;
69 const int steps_y = fp->steps_y;
70 const int scalebits = fp->scalebits;
71 const int32_t halfscale = fp->halfscale;
73 uint8_t *dst = td->dst;
74 const uint8_t *src = td->src;
75 const int dst_stride = td->dst_stride;
76 const int src_stride = td->src_stride;
77 const int width = td->width;
78 const int height = td->height;
79 const int sc_offset = jobnr * 2 * steps_y;
80 const int sr_offset = jobnr * (MAX_MATRIX_SIZE - 1);
81 const int slice_start = (height * jobnr) / nb_jobs;
82 const int slice_end = (height * (jobnr+1)) / nb_jobs;
89 av_image_copy_plane(dst + slice_start * dst_stride, dst_stride,
90 src + slice_start * src_stride, src_stride,
91 width, slice_end - slice_start);
95 for (y = 0; y < 2 * steps_y; y++)
96 memset(sc[sc_offset + y], 0, sizeof(sc[y][0]) * (width + 2 * steps_x));
98 // if this is not the first tile, we start from (slice_start - steps_y),
99 // so we can get smooth result at slice boundary
100 if (slice_start > steps_y) {
101 src += (slice_start - steps_y) * src_stride;
102 dst += (slice_start - steps_y) * dst_stride;
105 for (y = -steps_y + slice_start; y < steps_y + slice_end; y++) {
109 memset(sr + sr_offset, 0, sizeof(sr[0]) * (2 * steps_x - 1));
110 for (x = -steps_x; x < width + steps_x; x++) {
111 tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
112 for (z = 0; z < steps_x * 2; z += 2) {
113 tmp2 = sr[sr_offset + z + 0] + tmp1; sr[sr_offset + z + 0] = tmp1;
114 tmp1 = sr[sr_offset + z + 1] + tmp2; sr[sr_offset + z + 1] = tmp2;
116 for (z = 0; z < steps_y * 2; z += 2) {
117 tmp2 = sc[sc_offset + z + 0][x + steps_x] + tmp1; sc[sc_offset + z + 0][x + steps_x] = tmp1;
118 tmp1 = sc[sc_offset + z + 1][x + steps_x] + tmp2; sc[sc_offset + z + 1][x + steps_x] = tmp2;
120 if (x >= steps_x && y >= (steps_y + slice_start)) {
121 const uint8_t *srx = src - steps_y * src_stride + x - steps_x;
122 uint8_t *dsx = dst - steps_y * dst_stride + x - steps_x;
124 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + halfscale) >> scalebits)) * amount) >> 16);
125 *dsx = av_clip_uint8(res);
136 static int apply_unsharp_c(AVFilterContext *ctx, AVFrame *in, AVFrame *out)
138 AVFilterLink *inlink = ctx->inputs[0];
139 UnsharpContext *s = ctx->priv;
140 int i, plane_w[3], plane_h[3];
141 UnsharpFilterParam *fp[3];
144 plane_w[0] = inlink->w;
145 plane_w[1] = plane_w[2] = AV_CEIL_RSHIFT(inlink->w, s->hsub);
146 plane_h[0] = inlink->h;
147 plane_h[1] = plane_h[2] = AV_CEIL_RSHIFT(inlink->h, s->vsub);
149 fp[1] = fp[2] = &s->chroma;
150 for (i = 0; i < 3; i++) {
152 td.dst = out->data[i];
153 td.src = in->data[i];
154 td.width = plane_w[i];
155 td.height = plane_h[i];
156 td.dst_stride = out->linesize[i];
157 td.src_stride = in->linesize[i];
158 ctx->internal->execute(ctx, unsharp_slice, &td, NULL, FFMIN(plane_h[i], s->nb_threads));
163 static void set_filter_param(UnsharpFilterParam *fp, int msize_x, int msize_y, float amount)
165 fp->msize_x = msize_x;
166 fp->msize_y = msize_y;
167 fp->amount = amount * 65536.0;
169 fp->steps_x = msize_x / 2;
170 fp->steps_y = msize_y / 2;
171 fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
172 fp->halfscale = 1 << (fp->scalebits - 1);
175 static av_cold int init(AVFilterContext *ctx)
177 UnsharpContext *s = ctx->priv;
179 set_filter_param(&s->luma, s->lmsize_x, s->lmsize_y, s->lamount);
180 set_filter_param(&s->chroma, s->cmsize_x, s->cmsize_y, s->camount);
182 if (s->luma.scalebits >= 26 || s->chroma.scalebits >= 26) {
183 av_log(ctx, AV_LOG_ERROR, "luma or chroma matrix size too big\n");
184 return AVERROR(EINVAL);
186 s->apply_unsharp = apply_unsharp_c;
190 static int query_formats(AVFilterContext *ctx)
192 static const enum AVPixelFormat pix_fmts[] = {
193 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV410P,
194 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
195 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
198 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
200 return AVERROR(ENOMEM);
201 return ff_set_common_formats(ctx, fmts_list);
204 static int init_filter_param(AVFilterContext *ctx, UnsharpFilterParam *fp, const char *effect_type, int width)
207 UnsharpContext *s = ctx->priv;
208 const char *effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
210 if (!(fp->msize_x & fp->msize_y & 1)) {
211 av_log(ctx, AV_LOG_ERROR,
212 "Invalid even size for %s matrix size %dx%d\n",
213 effect_type, fp->msize_x, fp->msize_y);
214 return AVERROR(EINVAL);
217 av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
218 effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
220 fp->sr = av_malloc_array((MAX_MATRIX_SIZE - 1) * s->nb_threads, sizeof(uint32_t));
221 fp->sc = av_mallocz_array(2 * fp->steps_y * s->nb_threads, sizeof(uint32_t *));
222 if (!fp->sr || !fp->sc)
223 return AVERROR(ENOMEM);
225 for (z = 0; z < 2 * fp->steps_y * s->nb_threads; z++)
226 if (!(fp->sc[z] = av_malloc_array(width + 2 * fp->steps_x,
227 sizeof(*(fp->sc[z])))))
228 return AVERROR(ENOMEM);
233 static int config_input(AVFilterLink *inlink)
235 UnsharpContext *s = inlink->dst->priv;
236 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
239 s->hsub = desc->log2_chroma_w;
240 s->vsub = desc->log2_chroma_h;
242 // ensure (height / nb_threads) > 4 * steps_y,
243 // so that we don't have too much overlap between two threads
244 s->nb_threads = FFMIN(ff_filter_get_nb_threads(inlink->dst),
245 inlink->h / (4 * s->luma.steps_y));
247 ret = init_filter_param(inlink->dst, &s->luma, "luma", inlink->w);
250 ret = init_filter_param(inlink->dst, &s->chroma, "chroma", AV_CEIL_RSHIFT(inlink->w, s->hsub));
257 static void free_filter_param(UnsharpFilterParam *fp, int nb_threads)
262 for (z = 0; z < 2 * fp->steps_y * nb_threads; z++)
263 av_freep(&fp->sc[z]);
269 static av_cold void uninit(AVFilterContext *ctx)
271 UnsharpContext *s = ctx->priv;
273 free_filter_param(&s->luma, s->nb_threads);
274 free_filter_param(&s->chroma, s->nb_threads);
277 static int filter_frame(AVFilterLink *link, AVFrame *in)
279 UnsharpContext *s = link->dst->priv;
280 AVFilterLink *outlink = link->dst->outputs[0];
284 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
287 return AVERROR(ENOMEM);
289 av_frame_copy_props(out, in);
291 ret = s->apply_unsharp(link->dst, in, out);
299 return ff_filter_frame(outlink, out);
302 #define OFFSET(x) offsetof(UnsharpContext, x)
303 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
306 static const AVOption unsharp_options[] = {
307 { "luma_msize_x", "set luma matrix horizontal size", OFFSET(lmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
308 { "lx", "set luma matrix horizontal size", OFFSET(lmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
309 { "luma_msize_y", "set luma matrix vertical size", OFFSET(lmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
310 { "ly", "set luma matrix vertical size", OFFSET(lmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
311 { "luma_amount", "set luma effect strength", OFFSET(lamount), AV_OPT_TYPE_FLOAT, { .dbl = 1 }, -2, 5, FLAGS },
312 { "la", "set luma effect strength", OFFSET(lamount), AV_OPT_TYPE_FLOAT, { .dbl = 1 }, -2, 5, FLAGS },
313 { "chroma_msize_x", "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
314 { "cx", "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
315 { "chroma_msize_y", "set chroma matrix vertical size", OFFSET(cmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
316 { "cy", "set chroma matrix vertical size", OFFSET(cmsize_y), AV_OPT_TYPE_INT, { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
317 { "chroma_amount", "set chroma effect strength", OFFSET(camount), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -2, 5, FLAGS },
318 { "ca", "set chroma effect strength", OFFSET(camount), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -2, 5, FLAGS },
319 { "opencl", "ignored", OFFSET(opencl), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
323 AVFILTER_DEFINE_CLASS(unsharp);
325 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
328 .type = AVMEDIA_TYPE_VIDEO,
329 .filter_frame = filter_frame,
330 .config_props = config_input,
335 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
338 .type = AVMEDIA_TYPE_VIDEO,
343 AVFilter ff_vf_unsharp = {
345 .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
346 .priv_size = sizeof(UnsharpContext),
347 .priv_class = &unsharp_class,
350 .query_formats = query_formats,
351 .inputs = avfilter_vf_unsharp_inputs,
352 .outputs = avfilter_vf_unsharp_outputs,
353 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,