avfilter/blackframe: add "thres" back as alternative
[ffmpeg.git] / libavfilter / vf_boxblur.c
1 /*
2  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (c) 2011 Stefano Sabatini
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 /**
23  * @file
24  * Apply a boxblur filter to the input video.
25  * Ported from MPlayer libmpcodecs/vf_boxblur.c.
26  */
27
28 #include "libavutil/avstring.h"
29 #include "libavutil/common.h"
30 #include "libavutil/eval.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33 #include "avfilter.h"
34 #include "formats.h"
35 #include "internal.h"
36 #include "video.h"
37
38 static const char *const var_names[] = {
39     "w",
40     "h",
41     "cw",
42     "ch",
43     "hsub",
44     "vsub",
45     NULL
46 };
47
48 enum var_name {
49     VAR_W,
50     VAR_H,
51     VAR_CW,
52     VAR_CH,
53     VAR_HSUB,
54     VAR_VSUB,
55     VARS_NB
56 };
57
58 typedef struct {
59     int radius;
60     int power;
61     char *radius_expr;
62 } FilterParam;
63
64 typedef struct {
65     const AVClass *class;
66     FilterParam luma_param;
67     FilterParam chroma_param;
68     FilterParam alpha_param;
69
70     int hsub, vsub;
71     int radius[4];
72     int power[4];
73     uint8_t *temp[2]; ///< temporary buffer used in blur_power()
74 } BoxBlurContext;
75
76 #define OFFSET(x) offsetof(BoxBlurContext, x)
77 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
78
79 static const AVOption boxblur_options[] = {
80     { "luma_radius", "set luma radius", OFFSET(luma_param.radius_expr), AV_OPT_TYPE_STRING, {.str="2"}, .flags = FLAGS },
81     { "lr",          "set luma radius", OFFSET(luma_param.radius_expr), AV_OPT_TYPE_STRING, {.str="2"}, .flags = FLAGS },
82     { "luma_power",  "set luma power",  OFFSET(luma_param.power), AV_OPT_TYPE_INT, {.i64=2}, 0, INT_MAX, .flags = FLAGS },
83     { "lp",          "set luma power",  OFFSET(luma_param.power), AV_OPT_TYPE_INT, {.i64=2}, 0, INT_MAX, .flags = FLAGS },
84
85     { "chroma_radius", "set chroma radius", OFFSET(chroma_param.radius_expr), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
86     { "cr",            "set chroma radius", OFFSET(chroma_param.radius_expr), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
87     { "chroma_power",  "set chroma power",  OFFSET(chroma_param.power), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, .flags = FLAGS },
88     { "cp",            "set chroma power",  OFFSET(chroma_param.power), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, .flags = FLAGS },
89
90     { "alpha_radius", "set alpha radius", OFFSET(alpha_param.radius_expr), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
91     { "ar",           "set alpha radius", OFFSET(alpha_param.radius_expr), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
92     { "alpha_power",  "set alpha power",  OFFSET(alpha_param.power), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, .flags = FLAGS },
93     { "ap",           "set alpha power",  OFFSET(alpha_param.power), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, .flags = FLAGS },
94
95     { NULL }
96 };
97
98 AVFILTER_DEFINE_CLASS(boxblur);
99
100 #define Y 0
101 #define U 1
102 #define V 2
103 #define A 3
104
105 static av_cold int init(AVFilterContext *ctx, const char *args)
106 {
107     BoxBlurContext *boxblur = ctx->priv;
108
109     /* fill missing params */
110     if (!boxblur->chroma_param.radius_expr) {
111         boxblur->chroma_param.radius_expr = av_strdup(boxblur->luma_param.radius_expr);
112         if (!boxblur->chroma_param.radius_expr)
113             return AVERROR(ENOMEM);
114     }
115     if (boxblur->chroma_param.power < 0)
116         boxblur->chroma_param.power = boxblur->luma_param.power;
117
118     if (!boxblur->alpha_param.radius_expr) {
119         boxblur->alpha_param.radius_expr = av_strdup(boxblur->luma_param.radius_expr);
120         if (!boxblur->alpha_param.radius_expr)
121             return AVERROR(ENOMEM);
122     }
123     if (boxblur->alpha_param.power < 0)
124         boxblur->alpha_param.power = boxblur->luma_param.power;
125
126     return 0;
127 }
128
129 static av_cold void uninit(AVFilterContext *ctx)
130 {
131     BoxBlurContext *boxblur = ctx->priv;
132
133     av_freep(&boxblur->temp[0]);
134     av_freep(&boxblur->temp[1]);
135 }
136
137 static int query_formats(AVFilterContext *ctx)
138 {
139     static const enum AVPixelFormat pix_fmts[] = {
140         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
141         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUVA420P,
142         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_GRAY8,
143         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
144         AV_PIX_FMT_YUVJ440P,
145         AV_PIX_FMT_NONE
146     };
147
148     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
149     return 0;
150 }
151
152 static int config_input(AVFilterLink *inlink)
153 {
154     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
155     AVFilterContext    *ctx = inlink->dst;
156     BoxBlurContext *boxblur = ctx->priv;
157     int w = inlink->w, h = inlink->h;
158     int cw, ch;
159     double var_values[VARS_NB], res;
160     char *expr;
161     int ret;
162
163     if (!(boxblur->temp[0] = av_malloc(FFMAX(w, h))) ||
164         !(boxblur->temp[1] = av_malloc(FFMAX(w, h))))
165         return AVERROR(ENOMEM);
166
167     boxblur->hsub = desc->log2_chroma_w;
168     boxblur->vsub = desc->log2_chroma_h;
169
170     var_values[VAR_W]       = inlink->w;
171     var_values[VAR_H]       = inlink->h;
172     var_values[VAR_CW] = cw = w>>boxblur->hsub;
173     var_values[VAR_CH] = ch = h>>boxblur->vsub;
174     var_values[VAR_HSUB]    = 1<<boxblur->hsub;
175     var_values[VAR_VSUB]    = 1<<boxblur->vsub;
176
177 #define EVAL_RADIUS_EXPR(comp)                                          \
178     expr = boxblur->comp##_param.radius_expr;                           \
179     ret = av_expr_parse_and_eval(&res, expr, var_names, var_values,     \
180                                  NULL, NULL, NULL, NULL, NULL, 0, ctx); \
181     boxblur->comp##_param.radius = res;                                 \
182     if (ret < 0) {                                                      \
183         av_log(NULL, AV_LOG_ERROR,                                      \
184                "Error when evaluating " #comp " radius expression '%s'\n", expr); \
185         return ret;                                                     \
186     }
187     EVAL_RADIUS_EXPR(luma);
188     EVAL_RADIUS_EXPR(chroma);
189     EVAL_RADIUS_EXPR(alpha);
190
191     av_log(ctx, AV_LOG_VERBOSE,
192            "luma_radius:%d luma_power:%d "
193            "chroma_radius:%d chroma_power:%d "
194            "alpha_radius:%d alpha_power:%d "
195            "w:%d chroma_w:%d h:%d chroma_h:%d\n",
196            boxblur->luma_param  .radius, boxblur->luma_param  .power,
197            boxblur->chroma_param.radius, boxblur->chroma_param.power,
198            boxblur->alpha_param .radius, boxblur->alpha_param .power,
199            w, cw, h, ch);
200
201 #define CHECK_RADIUS_VAL(w_, h_, comp)                                  \
202     if (boxblur->comp##_param.radius < 0 ||                             \
203         2*boxblur->comp##_param.radius > FFMIN(w_, h_)) {               \
204         av_log(ctx, AV_LOG_ERROR,                                       \
205                "Invalid " #comp " radius value %d, must be >= 0 and <= %d\n", \
206                boxblur->comp##_param.radius, FFMIN(w_, h_)/2);          \
207         return AVERROR(EINVAL);                                         \
208     }
209     CHECK_RADIUS_VAL(w,  h,  luma);
210     CHECK_RADIUS_VAL(cw, ch, chroma);
211     CHECK_RADIUS_VAL(w,  h,  alpha);
212
213     boxblur->radius[Y] = boxblur->luma_param.radius;
214     boxblur->radius[U] = boxblur->radius[V] = boxblur->chroma_param.radius;
215     boxblur->radius[A] = boxblur->alpha_param.radius;
216
217     boxblur->power[Y] = boxblur->luma_param.power;
218     boxblur->power[U] = boxblur->power[V] = boxblur->chroma_param.power;
219     boxblur->power[A] = boxblur->alpha_param.power;
220
221     return 0;
222 }
223
224 static inline void blur(uint8_t *dst, int dst_step, const uint8_t *src, int src_step,
225                         int len, int radius)
226 {
227     /* Naive boxblur would sum source pixels from x-radius .. x+radius
228      * for destination pixel x. That would be O(radius*width).
229      * If you now look at what source pixels represent 2 consecutive
230      * output pixels, then you see they are almost identical and only
231      * differ by 2 pixels, like:
232      * src0       111111111
233      * dst0           1
234      * src1        111111111
235      * dst1            1
236      * src0-src1  1       -1
237      * so when you know one output pixel you can find the next by just adding
238      * and subtracting 1 input pixel.
239      * The following code adopts this faster variant.
240      */
241     const int length = radius*2 + 1;
242     const int inv = ((1<<16) + length/2)/length;
243     int x, sum = 0;
244
245     for (x = 0; x < radius; x++)
246         sum += src[x*src_step]<<1;
247     sum += src[radius*src_step];
248
249     for (x = 0; x <= radius; x++) {
250         sum += src[(radius+x)*src_step] - src[(radius-x)*src_step];
251         dst[x*dst_step] = (sum*inv + (1<<15))>>16;
252     }
253
254     for (; x < len-radius; x++) {
255         sum += src[(radius+x)*src_step] - src[(x-radius-1)*src_step];
256         dst[x*dst_step] = (sum*inv + (1<<15))>>16;
257     }
258
259     for (; x < len; x++) {
260         sum += src[(2*len-radius-x-1)*src_step] - src[(x-radius-1)*src_step];
261         dst[x*dst_step] = (sum*inv + (1<<15))>>16;
262     }
263 }
264
265 static inline void blur_power(uint8_t *dst, int dst_step, const uint8_t *src, int src_step,
266                               int len, int radius, int power, uint8_t *temp[2])
267 {
268     uint8_t *a = temp[0], *b = temp[1];
269
270     if (radius && power) {
271         blur(a, 1, src, src_step, len, radius);
272         for (; power > 2; power--) {
273             uint8_t *c;
274             blur(b, 1, a, 1, len, radius);
275             c = a; a = b; b = c;
276         }
277         if (power > 1) {
278             blur(dst, dst_step, a, 1, len, radius);
279         } else {
280             int i;
281             for (i = 0; i < len; i++)
282                 dst[i*dst_step] = a[i];
283         }
284     } else {
285         int i;
286         for (i = 0; i < len; i++)
287             dst[i*dst_step] = src[i*src_step];
288     }
289 }
290
291 static void hblur(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize,
292                   int w, int h, int radius, int power, uint8_t *temp[2])
293 {
294     int y;
295
296     if (radius == 0 && dst == src)
297         return;
298
299     for (y = 0; y < h; y++)
300         blur_power(dst + y*dst_linesize, 1, src + y*src_linesize, 1,
301                    w, radius, power, temp);
302 }
303
304 static void vblur(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize,
305                   int w, int h, int radius, int power, uint8_t *temp[2])
306 {
307     int x;
308
309     if (radius == 0 && dst == src)
310         return;
311
312     for (x = 0; x < w; x++)
313         blur_power(dst + x, dst_linesize, src + x, src_linesize,
314                    h, radius, power, temp);
315 }
316
317 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
318 {
319     AVFilterContext *ctx = inlink->dst;
320     BoxBlurContext *boxblur = ctx->priv;
321     AVFilterLink *outlink = inlink->dst->outputs[0];
322     AVFrame *out;
323     int plane;
324     int cw = inlink->w >> boxblur->hsub, ch = in->height >> boxblur->vsub;
325     int w[4] = { inlink->w, cw, cw, inlink->w };
326     int h[4] = { in->height, ch, ch, in->height };
327
328     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
329     if (!out) {
330         av_frame_free(&in);
331         return AVERROR(ENOMEM);
332     }
333     av_frame_copy_props(out, in);
334
335     for (plane = 0; in->data[plane] && plane < 4; plane++)
336         hblur(out->data[plane], out->linesize[plane],
337               in ->data[plane], in ->linesize[plane],
338               w[plane], h[plane], boxblur->radius[plane], boxblur->power[plane],
339               boxblur->temp);
340
341     for (plane = 0; in->data[plane] && plane < 4; plane++)
342         vblur(out->data[plane], out->linesize[plane],
343               out->data[plane], out->linesize[plane],
344               w[plane], h[plane], boxblur->radius[plane], boxblur->power[plane],
345               boxblur->temp);
346
347     av_frame_free(&in);
348
349     return ff_filter_frame(outlink, out);
350 }
351
352 static const AVFilterPad avfilter_vf_boxblur_inputs[] = {
353     {
354         .name         = "default",
355         .type         = AVMEDIA_TYPE_VIDEO,
356         .config_props = config_input,
357         .filter_frame = filter_frame,
358     },
359     { NULL }
360 };
361
362 static const AVFilterPad avfilter_vf_boxblur_outputs[] = {
363     {
364         .name = "default",
365         .type = AVMEDIA_TYPE_VIDEO,
366     },
367     { NULL }
368 };
369
370 static const char *const shorthand[] = {
371     "luma_radius",   "luma_power",
372     "chroma_radius", "chroma_power",
373     "alpha_radius",  "alpha_power",
374     NULL
375 };
376
377 AVFilter avfilter_vf_boxblur = {
378     .name          = "boxblur",
379     .description   = NULL_IF_CONFIG_SMALL("Blur the input."),
380     .priv_size     = sizeof(BoxBlurContext),
381     .init          = init,
382     .uninit        = uninit,
383     .query_formats = query_formats,
384
385     .inputs    = avfilter_vf_boxblur_inputs,
386     .outputs   = avfilter_vf_boxblur_outputs,
387
388     .priv_class = &boxblur_class,
389     .shorthand  = shorthand,
390 };