lavfi: port sab filter from libmpcodecs
[ffmpeg.git] / libavfilter / vf_sab.c
1 /*
2  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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.
19  */
20
21 /**
22  * @file
23  * Shape Adaptive Blur filter, ported from MPlayer libmpcodecs/vf_sab.c
24  */
25
26 #include "libavutil/opt.h"
27 #include "libavutil/pixdesc.h"
28 #include "libswscale/swscale.h"
29
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33
34 typedef struct {
35     float radius;
36     float pre_filter_radius;
37     float strength;
38     float quality;
39     struct SwsContext *pre_filter_context;
40     uint8_t *pre_filter_buf;
41     int pre_filter_linesize;
42     int dist_width;
43     int dist_linesize;
44     int *dist_coeff;
45 #define COLOR_DIFF_COEFF_SIZE 512
46     int color_diff_coeff[COLOR_DIFF_COEFF_SIZE];
47 } FilterParam;
48
49 typedef struct {
50     const AVClass *class;
51     FilterParam  luma;
52     FilterParam  chroma;
53     int          hsub;
54     int          vsub;
55     unsigned int sws_flags;
56 } SabContext;
57
58 static int query_formats(AVFilterContext *ctx)
59 {
60     static const enum AVPixelFormat pix_fmts[] = {
61         AV_PIX_FMT_YUV420P,
62         AV_PIX_FMT_YUV410P,
63         AV_PIX_FMT_YUV444P,
64         AV_PIX_FMT_YUV422P,
65         AV_PIX_FMT_YUV411P,
66         AV_PIX_FMT_NONE
67     };
68     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
69
70     return 0;
71 }
72
73 #define RADIUS_MIN 0.1
74 #define RADIUS_MAX 4.0
75
76 #define PRE_FILTER_RADIUS_MIN 0.1
77 #define PRE_FILTER_RADIUS_MAX 2.0
78
79 #define STRENGTH_MIN 0.1
80 #define STRENGTH_MAX 100.0
81
82 #define OFFSET(x) offsetof(SabContext, x)
83 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
84
85 static const AVOption sab_options[] = {
86     { "luma_radius",            "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
87     { "lr"         ,            "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
88     { "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 },
89     { "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 },
90     { "luma_strength",          "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
91     { "ls",                     "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
92
93     { "chroma_radius",            "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
94     { "cr",                       "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
95     { "chroma_pre_filter_radius", "set chroma pre-filter radius",  OFFSET(chroma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=PRE_FILTER_RADIUS_MIN-1},
96                                   PRE_FILTER_RADIUS_MIN-1, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
97     { "cpfr",                     "set chroma pre-filter radius",  OFFSET(chroma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=PRE_FILTER_RADIUS_MIN-1},
98                                   PRE_FILTER_RADIUS_MIN-1, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
99     { "chroma_strength",          "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
100     { "cs",                       "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
101
102     { NULL }
103 };
104
105 AVFILTER_DEFINE_CLASS(sab);
106
107 static av_cold int init(AVFilterContext *ctx)
108 {
109     SabContext *sab = ctx->priv;
110
111     /* make chroma default to luma values, if not explicitly set */
112     if (sab->chroma.radius < RADIUS_MIN)
113         sab->chroma.radius = sab->luma.radius;
114     if (sab->chroma.pre_filter_radius < PRE_FILTER_RADIUS_MIN)
115         sab->chroma.pre_filter_radius = sab->luma.pre_filter_radius;
116     if (sab->chroma.strength < STRENGTH_MIN)
117         sab->chroma.strength = sab->luma.strength;
118
119     sab->luma.quality = sab->chroma.quality = 3.0;
120     sab->sws_flags = SWS_POINT;
121
122     av_log(ctx, AV_LOG_VERBOSE,
123            "luma_radius:%f luma_pre_filter_radius::%f luma_strength:%f "
124            "chroma_radius:%f chroma_pre_filter_radius:%f chroma_strength:%f\n",
125            sab->luma  .radius, sab->luma  .pre_filter_radius, sab->luma  .strength,
126            sab->chroma.radius, sab->chroma.pre_filter_radius, sab->chroma.strength);
127     return 0;
128 }
129
130 static void close_filter_param(FilterParam *f)
131 {
132     if (f->pre_filter_context) {
133         sws_freeContext(f->pre_filter_context);
134         f->pre_filter_context = NULL;
135     }
136     av_freep(&f->pre_filter_buf);
137     av_freep(&f->dist_coeff);
138 }
139
140 static av_cold void uninit(AVFilterContext *ctx)
141 {
142     SabContext *sab = ctx->priv;
143
144     close_filter_param(&sab->luma);
145     close_filter_param(&sab->chroma);
146 }
147
148 static int open_filter_param(FilterParam *f, int width, int height, unsigned int sws_flags)
149 {
150     SwsVector *vec;
151     SwsFilter sws_f;
152     int i, x, y;
153     int linesize = FFALIGN(width, 8);
154
155     f->pre_filter_buf = av_malloc(linesize * height);
156     if (!f->pre_filter_buf)
157         return AVERROR(ENOMEM);
158
159     f->pre_filter_linesize = linesize;
160     vec = sws_getGaussianVec(f->pre_filter_radius, f->quality);
161     sws_f.lumH = sws_f.lumV = vec;
162     sws_f.chrH = sws_f.chrV = NULL;
163     f->pre_filter_context = sws_getContext(width, height, AV_PIX_FMT_GRAY8,
164                                            width, height, AV_PIX_FMT_GRAY8,
165                                            sws_flags, &sws_f, NULL, NULL);
166     sws_freeVec(vec);
167
168     vec = sws_getGaussianVec(f->strength, 5.0);
169     for (i = 0; i < COLOR_DIFF_COEFF_SIZE; i++) {
170         double d;
171         int index = i-COLOR_DIFF_COEFF_SIZE/2 + vec->length/2;
172
173         if (index < 0 || index >= vec->length) d = 0.0;
174         else                                   d = vec->coeff[index];
175
176         f->color_diff_coeff[i] = (int)(d/vec->coeff[vec->length/2]*(1<<12) + 0.5);
177     }
178     sws_freeVec(vec);
179
180     vec = sws_getGaussianVec(f->radius, f->quality);
181     f->dist_width    = vec->length;
182     f->dist_linesize = FFALIGN(vec->length, 8);
183     f->dist_coeff    = av_malloc(f->dist_width * f->dist_linesize * sizeof(*f->dist_coeff));
184     if (!f->dist_coeff)
185         return AVERROR(ENOMEM);
186
187     for (y = 0; y < vec->length; y++) {
188         for (x = 0; x < vec->length; x++) {
189             double d = vec->coeff[x] * vec->coeff[y];
190             f->dist_coeff[x + y*f->dist_linesize] = (int)(d*(1<<10) + 0.5);
191         }
192     }
193     sws_freeVec(vec);
194
195     return 0;
196 }
197
198 static int config_props(AVFilterLink *inlink)
199 {
200     SabContext *sab = inlink->dst->priv;
201     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
202     int ret;
203
204     sab->hsub = desc->log2_chroma_w;
205     sab->vsub = desc->log2_chroma_h;
206
207     close_filter_param(&sab->luma);
208     ret = open_filter_param(&sab->luma, inlink->w, inlink->h, sab->sws_flags);
209     if (ret < 0)
210         return ret;
211
212     close_filter_param(&sab->chroma);
213     ret = open_filter_param(&sab->chroma,
214                             FF_CEIL_RSHIFT(inlink->w, sab->hsub),
215                             FF_CEIL_RSHIFT(inlink->h, sab->vsub), sab->sws_flags);
216     return ret;
217 }
218
219 #define NB_PLANES 4
220
221 static void blur(uint8_t       *dst, const int dst_linesize,
222                  const uint8_t *src, const int src_linesize,
223                  const int w, const int h, FilterParam *fp)
224 {
225     int x, y;
226     FilterParam f = *fp;
227     const int radius = f.dist_width/2;
228
229     const uint8_t * const src2[NB_PLANES] = { src };
230     int          src2_linesize[NB_PLANES] = { src_linesize };
231     uint8_t     *dst2[NB_PLANES] = { f.pre_filter_buf };
232     int dst2_linesize[NB_PLANES] = { f.pre_filter_linesize };
233
234     sws_scale(f.pre_filter_context, src2, src2_linesize, 0, h, dst2, dst2_linesize);
235
236 #define UPDATE_FACTOR do {                                              \
237         int factor;                                                     \
238         factor = f.color_diff_coeff[COLOR_DIFF_COEFF_SIZE/2 + pre_val - \
239                  f.pre_filter_buf[ix + iy*f.pre_filter_linesize]] * f.dist_coeff[dx + dy*f.dist_linesize]; \
240         sum += src[ix + iy*src_linesize] * factor;                      \
241         div += factor;                                                  \
242     } while (0)
243
244     for (y = 0; y < h; y++) {
245         for (x = 0; x < w; x++) {
246             int sum = 0;
247             int div = 0;
248             int dy;
249             const int pre_val = f.pre_filter_buf[x + y*f.pre_filter_linesize];
250             if (x >= radius && x < w - radius) {
251                 for (dy = 0; dy < radius*2 + 1; dy++) {
252                     int dx;
253                     int iy = y+dy - radius;
254                     if      (iy < 0)  iy = -iy;
255                     else if (iy >= h) iy = h+h-iy-1;
256
257                     for (dx = 0; dx < radius*2 + 1; dx++) {
258                         const int ix = x+dx - radius;
259                         UPDATE_FACTOR;
260                     }
261                 }
262             } else {
263                 for (dy = 0; dy < radius*2+1; dy++) {
264                     int dx;
265                     int iy = y+dy - radius;
266                     if      (iy <  0) iy = -iy;
267                     else if (iy >= h) iy = h+h-iy-1;
268
269                     for (dx = 0; dx < radius*2 + 1; dx++) {
270                         int ix = x+dx - radius;
271                         if      (ix < 0)  ix = -ix;
272                         else if (ix >= w) ix = w+w-ix-1;
273                         UPDATE_FACTOR;
274                     }
275                 }
276             }
277             dst[x + y*dst_linesize] = (sum + div/2) / div;
278         }
279     }
280 }
281
282 static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
283 {
284     SabContext  *sab = inlink->dst->priv;
285     AVFilterLink *outlink = inlink->dst->outputs[0];
286     AVFrame *outpic;
287
288     outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
289     if (!outpic) {
290         av_frame_free(&inpic);
291         return AVERROR(ENOMEM);
292     }
293     av_frame_copy_props(outpic, inpic);
294
295     blur(outpic->data[0], outpic->linesize[0], inpic->data[0],  inpic->linesize[0],
296          inlink->w, inlink->h, &sab->luma);
297     if (inpic->data[2]) {
298         int cw = FF_CEIL_RSHIFT(inlink->w, sab->hsub);
299         int ch = FF_CEIL_RSHIFT(inlink->h, sab->vsub);
300         blur(outpic->data[1], outpic->linesize[1], inpic->data[1], inpic->linesize[1], cw, ch, &sab->chroma);
301         blur(outpic->data[2], outpic->linesize[2], inpic->data[2], inpic->linesize[2], cw, ch, &sab->chroma);
302     }
303
304     av_frame_free(&inpic);
305     return ff_filter_frame(outlink, outpic);
306 }
307
308 static const AVFilterPad sab_inputs[] = {
309     {
310         .name         = "default",
311         .type         = AVMEDIA_TYPE_VIDEO,
312         .filter_frame = filter_frame,
313         .config_props = config_props,
314     },
315     { NULL }
316 };
317
318 static const AVFilterPad sab_outputs[] = {
319     {
320         .name = "default",
321         .type = AVMEDIA_TYPE_VIDEO,
322     },
323     { NULL }
324 };
325
326 AVFilter avfilter_vf_sab = {
327     .name          = "sab",
328     .description   = NULL_IF_CONFIG_SMALL("Apply shape adaptive blur."),
329     .priv_size     = sizeof(SabContext),
330     .init          = init,
331     .uninit        = uninit,
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,
337 };