2 * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * Shape Adaptive Blur filter, ported from MPlayer libmpcodecs/vf_sab.c
26 #include "libavutil/opt.h"
27 #include "libavutil/pixdesc.h"
28 #include "libswscale/swscale.h"
34 typedef struct FilterParam {
36 float pre_filter_radius;
39 struct SwsContext *pre_filter_context;
40 uint8_t *pre_filter_buf;
41 int pre_filter_linesize;
45 #define COLOR_DIFF_COEFF_SIZE 512
46 int color_diff_coeff[COLOR_DIFF_COEFF_SIZE];
49 typedef struct SabContext {
55 unsigned int sws_flags;
58 static int query_formats(AVFilterContext *ctx)
60 static const enum AVPixelFormat pix_fmts[] = {
68 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
70 return AVERROR(ENOMEM);
71 return ff_set_common_formats(ctx, fmts_list);
74 #define RADIUS_MIN 0.1
75 #define RADIUS_MAX 4.0
77 #define PRE_FILTER_RADIUS_MIN 0.1
78 #define PRE_FILTER_RADIUS_MAX 2.0
80 #define STRENGTH_MIN 0.1
81 #define STRENGTH_MAX 100.0
83 #define OFFSET(x) offsetof(SabContext, x)
84 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
86 static const AVOption sab_options[] = {
87 { "luma_radius", "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
88 { "lr" , "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
89 { "luma_pre_filter_radius", "set luma pre-filter radius", OFFSET(luma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, PRE_FILTER_RADIUS_MIN, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
90 { "lpfr", "set luma pre-filter radius", OFFSET(luma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, PRE_FILTER_RADIUS_MIN, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
91 { "luma_strength", "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
92 { "ls", "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
94 { "chroma_radius", "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
95 { "cr", "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
96 { "chroma_pre_filter_radius", "set chroma pre-filter radius", OFFSET(chroma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=PRE_FILTER_RADIUS_MIN-1},
97 PRE_FILTER_RADIUS_MIN-1, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
98 { "cpfr", "set chroma pre-filter radius", OFFSET(chroma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=PRE_FILTER_RADIUS_MIN-1},
99 PRE_FILTER_RADIUS_MIN-1, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
100 { "chroma_strength", "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
101 { "cs", "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
106 AVFILTER_DEFINE_CLASS(sab);
108 static av_cold int init(AVFilterContext *ctx)
110 SabContext *s = ctx->priv;
112 /* make chroma default to luma values, if not explicitly set */
113 if (s->chroma.radius < RADIUS_MIN)
114 s->chroma.radius = s->luma.radius;
115 if (s->chroma.pre_filter_radius < PRE_FILTER_RADIUS_MIN)
116 s->chroma.pre_filter_radius = s->luma.pre_filter_radius;
117 if (s->chroma.strength < STRENGTH_MIN)
118 s->chroma.strength = s->luma.strength;
120 s->luma.quality = s->chroma.quality = 3.0;
121 s->sws_flags = SWS_POINT;
123 av_log(ctx, AV_LOG_VERBOSE,
124 "luma_radius:%f luma_pre_filter_radius::%f luma_strength:%f "
125 "chroma_radius:%f chroma_pre_filter_radius:%f chroma_strength:%f\n",
126 s->luma .radius, s->luma .pre_filter_radius, s->luma .strength,
127 s->chroma.radius, s->chroma.pre_filter_radius, s->chroma.strength);
131 static void close_filter_param(FilterParam *f)
133 if (f->pre_filter_context) {
134 sws_freeContext(f->pre_filter_context);
135 f->pre_filter_context = NULL;
137 av_freep(&f->pre_filter_buf);
138 av_freep(&f->dist_coeff);
141 static av_cold void uninit(AVFilterContext *ctx)
143 SabContext *s = ctx->priv;
145 close_filter_param(&s->luma);
146 close_filter_param(&s->chroma);
149 static int open_filter_param(FilterParam *f, int width, int height, unsigned int sws_flags)
154 int linesize = FFALIGN(width, 8);
156 f->pre_filter_buf = av_malloc(linesize * height);
157 if (!f->pre_filter_buf)
158 return AVERROR(ENOMEM);
160 f->pre_filter_linesize = linesize;
161 vec = sws_getGaussianVec(f->pre_filter_radius, f->quality);
162 sws_f.lumH = sws_f.lumV = vec;
163 sws_f.chrH = sws_f.chrV = NULL;
164 f->pre_filter_context = sws_getContext(width, height, AV_PIX_FMT_GRAY8,
165 width, height, AV_PIX_FMT_GRAY8,
166 sws_flags, &sws_f, NULL, NULL);
169 vec = sws_getGaussianVec(f->strength, 5.0);
170 for (i = 0; i < COLOR_DIFF_COEFF_SIZE; i++) {
172 int index = i-COLOR_DIFF_COEFF_SIZE/2 + vec->length/2;
174 if (index < 0 || index >= vec->length) d = 0.0;
175 else d = vec->coeff[index];
177 f->color_diff_coeff[i] = (int)(d/vec->coeff[vec->length/2]*(1<<12) + 0.5);
181 vec = sws_getGaussianVec(f->radius, f->quality);
182 f->dist_width = vec->length;
183 f->dist_linesize = FFALIGN(vec->length, 8);
184 f->dist_coeff = av_malloc_array(f->dist_width, f->dist_linesize * sizeof(*f->dist_coeff));
185 if (!f->dist_coeff) {
187 return AVERROR(ENOMEM);
190 for (y = 0; y < vec->length; y++) {
191 for (x = 0; x < vec->length; x++) {
192 double d = vec->coeff[x] * vec->coeff[y];
193 f->dist_coeff[x + y*f->dist_linesize] = (int)(d*(1<<10) + 0.5);
201 static int config_props(AVFilterLink *inlink)
203 SabContext *s = inlink->dst->priv;
204 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
207 s->hsub = desc->log2_chroma_w;
208 s->vsub = desc->log2_chroma_h;
210 close_filter_param(&s->luma);
211 ret = open_filter_param(&s->luma, inlink->w, inlink->h, s->sws_flags);
215 close_filter_param(&s->chroma);
216 ret = open_filter_param(&s->chroma,
217 AV_CEIL_RSHIFT(inlink->w, s->hsub),
218 AV_CEIL_RSHIFT(inlink->h, s->vsub), s->sws_flags);
224 static void blur(uint8_t *dst, const int dst_linesize,
225 const uint8_t *src, const int src_linesize,
226 const int w, const int h, FilterParam *fp)
230 const int radius = f.dist_width/2;
232 const uint8_t * const src2[NB_PLANES] = { src };
233 int src2_linesize[NB_PLANES] = { src_linesize };
234 uint8_t *dst2[NB_PLANES] = { f.pre_filter_buf };
235 int dst2_linesize[NB_PLANES] = { f.pre_filter_linesize };
237 sws_scale(f.pre_filter_context, src2, src2_linesize, 0, h, dst2, dst2_linesize);
239 #define UPDATE_FACTOR do { \
241 factor = f.color_diff_coeff[COLOR_DIFF_COEFF_SIZE/2 + pre_val - \
242 f.pre_filter_buf[ix + iy*f.pre_filter_linesize]] * f.dist_coeff[dx + dy*f.dist_linesize]; \
243 sum += src[ix + iy*src_linesize] * factor; \
247 for (y = 0; y < h; y++) {
248 for (x = 0; x < w; x++) {
252 const int pre_val = f.pre_filter_buf[x + y*f.pre_filter_linesize];
253 if (x >= radius && x < w - radius) {
254 for (dy = 0; dy < radius*2 + 1; dy++) {
256 int iy = y+dy - radius;
257 iy = avpriv_mirror(iy, h-1);
259 for (dx = 0; dx < radius*2 + 1; dx++) {
260 const int ix = x+dx - radius;
265 for (dy = 0; dy < radius*2+1; dy++) {
267 int iy = y+dy - radius;
268 iy = avpriv_mirror(iy, h-1);
270 for (dx = 0; dx < radius*2 + 1; dx++) {
271 int ix = x+dx - radius;
272 ix = avpriv_mirror(ix, w-1);
277 dst[x + y*dst_linesize] = (sum + div/2) / div;
282 static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
284 SabContext *s = inlink->dst->priv;
285 AVFilterLink *outlink = inlink->dst->outputs[0];
288 outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
290 av_frame_free(&inpic);
291 return AVERROR(ENOMEM);
293 av_frame_copy_props(outpic, inpic);
295 blur(outpic->data[0], outpic->linesize[0], inpic->data[0], inpic->linesize[0],
296 inlink->w, inlink->h, &s->luma);
297 if (inpic->data[2]) {
298 int cw = AV_CEIL_RSHIFT(inlink->w, s->hsub);
299 int ch = AV_CEIL_RSHIFT(inlink->h, s->vsub);
300 blur(outpic->data[1], outpic->linesize[1], inpic->data[1], inpic->linesize[1], cw, ch, &s->chroma);
301 blur(outpic->data[2], outpic->linesize[2], inpic->data[2], inpic->linesize[2], cw, ch, &s->chroma);
304 av_frame_free(&inpic);
305 return ff_filter_frame(outlink, outpic);
308 static const AVFilterPad sab_inputs[] = {
311 .type = AVMEDIA_TYPE_VIDEO,
312 .filter_frame = filter_frame,
313 .config_props = config_props,
318 static const AVFilterPad sab_outputs[] = {
321 .type = AVMEDIA_TYPE_VIDEO,
326 AVFilter ff_vf_sab = {
328 .description = NULL_IF_CONFIG_SMALL("Apply shape adaptive blur."),
329 .priv_size = sizeof(SabContext),
332 .query_formats = query_formats,
333 .inputs = sab_inputs,
334 .outputs = sab_outputs,
335 .priv_class = &sab_class,
336 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,