git.sesse.net Git - ffmpeg/blob - 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/eval.h"
  30 #include "libavutil/pixdesc.h"
  31 #include "avfilter.h"
  32 #include "formats.h"
  33 #include "internal.h"
  34 #include "video.h"
  35
  36 static const char *const var_names[] = {
  37     "w",
  38     "h",
  39     "cw",
  40     "ch",
  41     "hsub",
  42     "vsub",
  43     NULL
  44 };
  45
  46 enum var_name {
  47     VAR_W,
  48     VAR_H,
  49     VAR_CW,
  50     VAR_CH,
  51     VAR_HSUB,
  52     VAR_VSUB,
  53     VARS_NB
  54 };
  55
  56 typedef struct {
  57     int radius;
  58     int power;
  59 } FilterParam;
  60
  61 typedef struct {
  62     FilterParam luma_param;
  63     FilterParam chroma_param;
  64     FilterParam alpha_param;
  65     char luma_radius_expr  [256];
  66     char chroma_radius_expr[256];
  67     char alpha_radius_expr [256];
  68
  69     int hsub, vsub;
  70     int radius[4];
  71     int power[4];
  72     uint8_t *temp[2]; ///< temporary buffer used in blur_power()
  73 } BoxBlurContext;
  74
  75 #define Y 0
  76 #define U 1
  77 #define V 2
  78 #define A 3
  79
  80 static av_cold int init(AVFilterContext *ctx, const char *args)
  81 {
  82     BoxBlurContext *boxblur = ctx->priv;
  83     int e;
  84
  85     if (!args) {
  86         av_log(ctx, AV_LOG_ERROR,
  87                "Filter expects 2 or 4 or 6 arguments, none provided\n");
  88         return AVERROR(EINVAL);
  89     }
  90
  91     e = sscanf(args, "%255[^:]:%d:%255[^:]:%d:%255[^:]:%d",
  92                boxblur->luma_radius_expr,   &boxblur->luma_param  .power,
  93                boxblur->chroma_radius_expr, &boxblur->chroma_param.power,
  94                boxblur->alpha_radius_expr,  &boxblur->alpha_param .power);
  95
  96     if (e != 2 && e != 4 && e != 6) {
  97         av_log(ctx, AV_LOG_ERROR,
  98                "Filter expects 2 or 4 or 6 params, provided %d\n", e);
  99         return AVERROR(EINVAL);
 100     }
 101
 102     if (e < 4) {
 103         boxblur->chroma_param.power = boxblur->luma_param.power;
 104         av_strlcpy(boxblur->chroma_radius_expr, boxblur->luma_radius_expr,
 105                    sizeof(boxblur->chroma_radius_expr));
 106     }
 107     if (e < 6) {
 108         boxblur->alpha_param.power = boxblur->luma_param.power;
 109         av_strlcpy(boxblur->alpha_radius_expr, boxblur->luma_radius_expr,
 110                    sizeof(boxblur->alpha_radius_expr));
 111     }
 112
 113     return 0;
 114 }
 115
 116 static av_cold void uninit(AVFilterContext *ctx)
 117 {
 118     BoxBlurContext *boxblur = ctx->priv;
 119
 120     av_freep(&boxblur->temp[0]);
 121     av_freep(&boxblur->temp[1]);
 122 }
 123
 124 static int query_formats(AVFilterContext *ctx)
 125 {
 126     enum PixelFormat pix_fmts[] = {
 127         PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,
 128         PIX_FMT_YUV411P,  PIX_FMT_YUV410P,  PIX_FMT_YUVA420P,
 129         PIX_FMT_YUV440P,  PIX_FMT_GRAY8,
 130         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ420P,
 131         PIX_FMT_YUVJ440P,
 132         PIX_FMT_NONE
 133     };
 134
 135     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 136     return 0;
 137 }
 138
 139 static int config_input(AVFilterLink *inlink)
 140 {
 141     AVFilterContext *ctx = inlink->dst;
 142     BoxBlurContext *boxblur = ctx->priv;
 143     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[inlink->format];
 144     int w = inlink->w, h = inlink->h;
 145     int cw, ch;
 146     double var_values[VARS_NB], res;
 147     char *expr;
 148     int ret;
 149
 150     if (!(boxblur->temp[0] = av_malloc(FFMAX(w, h))) ||
 151         !(boxblur->temp[1] = av_malloc(FFMAX(w, h))))
 152         return AVERROR(ENOMEM);
 153
 154     boxblur->hsub = desc->log2_chroma_w;
 155     boxblur->vsub = desc->log2_chroma_h;
 156
 157     var_values[VAR_W]  = inlink->w;
 158     var_values[VAR_H]  = inlink->h;
 159     var_values[VAR_CW] = cw = w>>boxblur->hsub;
 160     var_values[VAR_CH] = ch = h>>boxblur->vsub;
 161     var_values[VAR_HSUB] = 1<<boxblur->hsub;
 162     var_values[VAR_VSUB] = 1<<boxblur->vsub;
 163
 164 #define EVAL_RADIUS_EXPR(comp)                                          \
 165     expr = boxblur->comp##_radius_expr;                                 \
 166     ret = av_expr_parse_and_eval(&res, expr, var_names, var_values,     \
 167                                  NULL, NULL, NULL, NULL, NULL, 0, ctx); \
 168     boxblur->comp##_param.radius = res;                                 \
 169     if (ret < 0) {                                                      \
 170         av_log(NULL, AV_LOG_ERROR,                                      \
 171                "Error when evaluating " #comp " radius expression '%s'\n", expr); \
 172         return ret;                                                     \
 173     }
 174     EVAL_RADIUS_EXPR(luma);
 175     EVAL_RADIUS_EXPR(chroma);
 176     EVAL_RADIUS_EXPR(alpha);
 177
 178     av_log(ctx, AV_LOG_VERBOSE,
 179            "luma_radius:%d luma_power:%d "
 180            "chroma_radius:%d chroma_power:%d "
 181            "alpha_radius:%d alpha_power:%d "
 182            "w:%d chroma_w:%d h:%d chroma_h:%d\n",
 183            boxblur->luma_param  .radius, boxblur->luma_param  .power,
 184            boxblur->chroma_param.radius, boxblur->chroma_param.power,
 185            boxblur->alpha_param .radius, boxblur->alpha_param .power,
 186            w, cw, h, ch);
 187
 188 #define CHECK_RADIUS_VAL(w_, h_, comp)                                  \
 189     if (boxblur->comp##_param.radius < 0 ||                             \
 190         2*boxblur->comp##_param.radius > FFMIN(w_, h_)) {               \
 191         av_log(ctx, AV_LOG_ERROR,                                       \
 192                "Invalid " #comp " radius value %d, must be >= 0 and <= %d\n", \
 193                boxblur->comp##_param.radius, FFMIN(w_, h_)/2);          \
 194         return AVERROR(EINVAL);                                         \
 195     }
 196     CHECK_RADIUS_VAL(w,  h,  luma);
 197     CHECK_RADIUS_VAL(cw, ch, chroma);
 198     CHECK_RADIUS_VAL(w,  h,  alpha);
 199
 200     boxblur->radius[Y] = boxblur->luma_param.radius;
 201     boxblur->radius[U] = boxblur->radius[V] = boxblur->chroma_param.radius;
 202     boxblur->radius[A] = boxblur->alpha_param.radius;
 203
 204     boxblur->power[Y] = boxblur->luma_param.power;
 205     boxblur->power[U] = boxblur->power[V] = boxblur->chroma_param.power;
 206     boxblur->power[A] = boxblur->alpha_param.power;
 207
 208     return 0;
 209 }
 210
 211 static inline void blur(uint8_t *dst, int dst_step, const uint8_t *src, int src_step,
 212                         int len, int radius)
 213 {
 214     /* Naive boxblur would sum source pixels from x-radius .. x+radius
 215      * for destination pixel x. That would be O(radius*width).
 216      * If you now look at what source pixels represent 2 consecutive
 217      * output pixels, then you see they are almost identical and only
 218      * differ by 2 pixels, like:
 219      * src0       111111111
 220      * dst0           1
 221      * src1        111111111
 222      * dst1            1
 223      * src0-src1  1       -1
 224      * so when you know one output pixel you can find the next by just adding
 225      * and subtracting 1 input pixel.
 226      * The following code adopts this faster variant.
 227      */
 228     int x, sum = 0;
 229     const int length = radius*2 + 1;
 230     const int inv = ((1<<16) + length/2)/length;
 231
 232     for (x = 0; x < radius; x++)
 233         sum += src[x*src_step]<<1;
 234     sum += src[radius*src_step];
 235
 236     for (x = 0; x <= radius; x++) {
 237         sum += src[(radius+x)*src_step] - src[(radius-x)*src_step];
 238         dst[x*dst_step] = (sum*inv + (1<<15))>>16;
 239     }
 240
 241     for (; x < len-radius; x++) {
 242         sum += src[(radius+x)*src_step] - src[(x-radius-1)*src_step];
 243         dst[x*dst_step] = (sum*inv + (1<<15))>>16;
 244     }
 245
 246     for (; x < len; x++) {
 247         sum += src[(2*len-radius-x-1)*src_step] - src[(x-radius-1)*src_step];
 248         dst[x*dst_step] = (sum*inv + (1<<15))>>16;
 249     }
 250 }
 251
 252 static inline void blur_power(uint8_t *dst, int dst_step, const uint8_t *src, int src_step,
 253                               int len, int radius, int power, uint8_t *temp[2])
 254 {
 255     uint8_t *a = temp[0], *b = temp[1];
 256
 257     if (radius && power) {
 258         blur(a, 1, src, src_step, len, radius);
 259         for (; power > 2; power--) {
 260             uint8_t *c;
 261             blur(b, 1, a, 1, len, radius);
 262             c = a; a = b; b = c;
 263         }
 264         if (power > 1) {
 265             blur(dst, dst_step, a, 1, len, radius);
 266         } else {
 267             int i;
 268             for (i = 0; i < len; i++)
 269                 dst[i*dst_step] = a[i];
 270         }
 271     } else {
 272         int i;
 273         for (i = 0; i < len; i++)
 274             dst[i*dst_step] = src[i*src_step];
 275     }
 276 }
 277
 278 static void hblur(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize,
 279                   int w, int h, int radius, int power, uint8_t *temp[2])
 280 {
 281     int y;
 282
 283     if (radius == 0 && dst == src)
 284         return;
 285
 286     for (y = 0; y < h; y++)
 287         blur_power(dst + y*dst_linesize, 1, src + y*src_linesize, 1,
 288                    w, radius, power, temp);
 289 }
 290
 291 static void vblur(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 x;
 295
 296     if (radius == 0 && dst == src)
 297         return;
 298
 299     for (x = 0; x < w; x++)
 300         blur_power(dst + x, dst_linesize, src + x, src_linesize,
 301                    h, radius, power, temp);
 302 }
 303
 304 static int null_draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir) { return 0; }
 305
 306 static int end_frame(AVFilterLink *inlink)
 307 {
 308     AVFilterContext *ctx = inlink->dst;
 309     BoxBlurContext *boxblur = ctx->priv;
 310     AVFilterLink *outlink = inlink->dst->outputs[0];
 311     AVFilterBufferRef *inpicref  = inlink ->cur_buf;
 312     AVFilterBufferRef *outpicref = outlink->out_buf;
 313     int plane;
 314     int cw = inlink->w >> boxblur->hsub, ch = inlink->h >> boxblur->vsub;
 315     int w[4] = { inlink->w, cw, cw, inlink->w };
 316     int h[4] = { inlink->h, ch, ch, inlink->h };
 317
 318     for (plane = 0; inpicref->data[plane] && plane < 4; plane++)
 319         hblur(outpicref->data[plane], outpicref->linesize[plane],
 320               inpicref ->data[plane], inpicref ->linesize[plane],
 321               w[plane], h[plane], boxblur->radius[plane], boxblur->power[plane],
 322               boxblur->temp);
 323
 324     for (plane = 0; inpicref->data[plane] && plane < 4; plane++)
 325         vblur(outpicref->data[plane], outpicref->linesize[plane],
 326               outpicref->data[plane], outpicref->linesize[plane],
 327               w[plane], h[plane], boxblur->radius[plane], boxblur->power[plane],
 328               boxblur->temp);
 329
 330     ff_draw_slice(outlink, 0, inlink->h, 1);
 331     return avfilter_default_end_frame(inlink);
 332 }
 333
 334 AVFilter avfilter_vf_boxblur = {
 335     .name          = "boxblur",
 336     .description   = NULL_IF_CONFIG_SMALL("Blur the input."),
 337     .priv_size     = sizeof(BoxBlurContext),
 338     .init          = init,
 339     .uninit        = uninit,
 340     .query_formats = query_formats,
 341
 342     .inputs    = (const AVFilterPad[]) {{ .name             = "default",
 343                                           .type             = AVMEDIA_TYPE_VIDEO,
 344                                           .config_props     = config_input,
 345                                           .draw_slice       = null_draw_slice,
 346                                           .end_frame        = end_frame,
 347                                           .min_perms        = AV_PERM_READ },
 348                                         { .name = NULL}},
 349     .outputs   = (const AVFilterPad[]) {{ .name             = "default",
 350                                           .type             = AVMEDIA_TYPE_VIDEO, },
 351                                         { .name = NULL}},
 352 };