git.sesse.net Git - ffmpeg/blob - libavfilter/vf_unsharp.c

   1 /*
   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.
   5  *
   6  * This file is part of FFmpeg.
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 /**
  24  * @file
  25  * blur / sharpen filter, ported to FFmpeg from MPlayer
  26  * libmpcodecs/unsharp.c.
  27  *
  28  * This code is based on:
  29  *
  30  * An Efficient algorithm for Gaussian blur using finite-state machines
  31  * Frederick M. Waltz and John W. V. Miller
  32  *
  33  * SPIE Conf. on Machine Vision Systems for Inspection and Metrology VII
  34  * Originally published Boston, Nov 98
  35  *
  36  * http://www.engin.umd.umich.edu/~jwvm/ece581/21_GBlur.pdf
  37  */
  38
  39 #include <float.h> /* DBL_MAX */
  40
  41 #include "avfilter.h"
  42 #include "formats.h"
  43 #include "internal.h"
  44 #include "video.h"
  45 #include "libavutil/common.h"
  46 #include "libavutil/mem.h"
  47 #include "libavutil/opt.h"
  48 #include "libavutil/pixdesc.h"
  49
  50 #define MIN_MATRIX_SIZE 3
  51 #define MAX_MATRIX_SIZE 63
  52
  53 /* right-shift and round-up */
  54 #define SHIFTUP(x,shift) (-((-(x))>>(shift)))
  55
  56 typedef struct FilterParam {
  57     int msize_x;                             ///< matrix width
  58     int msize_y;                             ///< matrix height
  59     int amount;                              ///< effect amount
  60     int steps_x;                             ///< horizontal step count
  61     int steps_y;                             ///< vertical step count
  62     int scalebits;                           ///< bits to shift pixel
  63     int32_t halfscale;                       ///< amount to add to pixel
  64     uint32_t *sc[MAX_MATRIX_SIZE - 1];       ///< finite state machine storage
  65 } FilterParam;
  66
  67 typedef struct {
  68     const AVClass *class;
  69     int lmsize_x, lmsize_y, cmsize_x, cmsize_y;
  70     float lamount, camount;
  71     FilterParam luma;   ///< luma parameters (width, height, amount)
  72     FilterParam chroma; ///< chroma parameters (width, height, amount)
  73     int hsub, vsub;
  74 } UnsharpContext;
  75
  76 static void apply_unsharp(      uint8_t *dst, int dst_stride,
  77                           const uint8_t *src, int src_stride,
  78                           int width, int height, FilterParam *fp)
  79 {
  80     uint32_t **sc = fp->sc;
  81     uint32_t sr[MAX_MATRIX_SIZE - 1], tmp1, tmp2;
  82
  83     int32_t res;
  84     int x, y, z;
  85     const uint8_t *src2 = NULL;  //silence a warning
  86     const int amount = fp->amount;
  87     const int steps_x = fp->steps_x;
  88     const int steps_y = fp->steps_y;
  89     const int scalebits = fp->scalebits;
  90     const int32_t halfscale = fp->halfscale;
  91
  92     if (!amount) {
  93         if (dst_stride == src_stride)
  94             memcpy(dst, src, src_stride * height);
  95         else
  96             for (y = 0; y < height; y++, dst += dst_stride, src += src_stride)
  97                 memcpy(dst, src, width);
  98         return;
  99     }
 100
 101     for (y = 0; y < 2 * steps_y; y++)
 102         memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * steps_x));
 103
 104     for (y = -steps_y; y < height + steps_y; y++) {
 105         if (y < height)
 106             src2 = src;
 107
 108         memset(sr, 0, sizeof(sr[0]) * (2 * steps_x - 1));
 109         for (x = -steps_x; x < width + steps_x; x++) {
 110             tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
 111             for (z = 0; z < steps_x * 2; z += 2) {
 112                 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
 113                 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
 114             }
 115             for (z = 0; z < steps_y * 2; z += 2) {
 116                 tmp2 = sc[z + 0][x + steps_x] + tmp1; sc[z + 0][x + steps_x] = tmp1;
 117                 tmp1 = sc[z + 1][x + steps_x] + tmp2; sc[z + 1][x + steps_x] = tmp2;
 118             }
 119             if (x >= steps_x && y >= steps_y) {
 120                 const uint8_t *srx = src - steps_y * src_stride + x - steps_x;
 121                 uint8_t *dsx       = dst - steps_y * dst_stride + x - steps_x;
 122
 123                 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + halfscale) >> scalebits)) * amount) >> 16);
 124                 *dsx = av_clip_uint8(res);
 125             }
 126         }
 127         if (y >= 0) {
 128             dst += dst_stride;
 129             src += src_stride;
 130         }
 131     }
 132 }
 133
 134 static void set_filter_param(FilterParam *fp, int msize_x, int msize_y, float amount)
 135 {
 136     fp->msize_x = msize_x;
 137     fp->msize_y = msize_y;
 138     fp->amount = amount * 65536.0;
 139
 140     fp->steps_x = msize_x / 2;
 141     fp->steps_y = msize_y / 2;
 142     fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
 143     fp->halfscale = 1 << (fp->scalebits - 1);
 144 }
 145
 146 static av_cold int init(AVFilterContext *ctx, const char *args)
 147 {
 148     UnsharpContext *unsharp = ctx->priv;
 149
 150
 151     set_filter_param(&unsharp->luma,   unsharp->lmsize_x, unsharp->lmsize_y, unsharp->lamount);
 152     set_filter_param(&unsharp->chroma, unsharp->cmsize_x, unsharp->cmsize_y, unsharp->camount);
 153
 154     return 0;
 155 }
 156
 157 static int query_formats(AVFilterContext *ctx)
 158 {
 159     static const enum AVPixelFormat pix_fmts[] = {
 160         AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV410P,
 161         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
 162         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
 163     };
 164
 165     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 166
 167     return 0;
 168 }
 169
 170 static int init_filter_param(AVFilterContext *ctx, FilterParam *fp, const char *effect_type, int width)
 171 {
 172     int z;
 173     const char *effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
 174
 175     if  (!(fp->msize_x & fp->msize_y & 1)) {
 176         av_log(ctx, AV_LOG_ERROR,
 177                "Invalid even size for %s matrix size %dx%d\n",
 178                effect_type, fp->msize_x, fp->msize_y);
 179         return AVERROR(EINVAL);
 180     }
 181
 182     av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
 183            effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
 184
 185     for (z = 0; z < 2 * fp->steps_y; z++)
 186         if (!(fp->sc[z] = av_malloc(sizeof(*(fp->sc[z])) * (width + 2 * fp->steps_x))))
 187             return AVERROR(ENOMEM);
 188
 189     return 0;
 190 }
 191
 192 static int config_props(AVFilterLink *link)
 193 {
 194     UnsharpContext *unsharp = link->dst->priv;
 195     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
 196     int ret;
 197
 198     unsharp->hsub = desc->log2_chroma_w;
 199     unsharp->vsub = desc->log2_chroma_h;
 200
 201     ret = init_filter_param(link->dst, &unsharp->luma,   "luma",   link->w);
 202     if (ret < 0)
 203         return ret;
 204     ret = init_filter_param(link->dst, &unsharp->chroma, "chroma", SHIFTUP(link->w, unsharp->hsub));
 205     if (ret < 0)
 206         return ret;
 207
 208     return 0;
 209 }
 210
 211 static void free_filter_param(FilterParam *fp)
 212 {
 213     int z;
 214
 215     for (z = 0; z < 2 * fp->steps_y; z++)
 216         av_free(fp->sc[z]);
 217 }
 218
 219 static av_cold void uninit(AVFilterContext *ctx)
 220 {
 221     UnsharpContext *unsharp = ctx->priv;
 222
 223     free_filter_param(&unsharp->luma);
 224     free_filter_param(&unsharp->chroma);
 225 }
 226
 227 static int filter_frame(AVFilterLink *link, AVFrame *in)
 228 {
 229     UnsharpContext *unsharp = link->dst->priv;
 230     AVFilterLink *outlink   = link->dst->outputs[0];
 231     AVFrame *out;
 232     int cw = SHIFTUP(link->w, unsharp->hsub);
 233     int ch = SHIFTUP(link->h, unsharp->vsub);
 234
 235     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 236     if (!out) {
 237         av_frame_free(&in);
 238         return AVERROR(ENOMEM);
 239     }
 240     av_frame_copy_props(out, in);
 241
 242     apply_unsharp(out->data[0], out->linesize[0], in->data[0], in->linesize[0], link->w, link->h, &unsharp->luma);
 243     apply_unsharp(out->data[1], out->linesize[1], in->data[1], in->linesize[1], cw,      ch,      &unsharp->chroma);
 244     apply_unsharp(out->data[2], out->linesize[2], in->data[2], in->linesize[2], cw,      ch,      &unsharp->chroma);
 245
 246     av_frame_free(&in);
 247     return ff_filter_frame(outlink, out);
 248 }
 249
 250 #define OFFSET(x) offsetof(UnsharpContext, x)
 251 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 252 #define MIN_SIZE 3
 253 #define MAX_SIZE 63
 254 static const AVOption unsharp_options[] = {
 255     { "luma_msize_x",   "luma matrix horizontal size",   OFFSET(lmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 256     { "lx",             "luma matrix horizontal size",   OFFSET(lmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 257     { "luma_msize_y",   "luma matrix vertical size",     OFFSET(lmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 258     { "ly",             "luma matrix vertical size",     OFFSET(lmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 259     { "luma_amount",    "luma effect strength",          OFFSET(lamount),  AV_OPT_TYPE_FLOAT, { .dbl = 1 },       -2,        5, FLAGS },
 260     { "la",             "luma effect strength",          OFFSET(lamount),  AV_OPT_TYPE_FLOAT, { .dbl = 1 },       -2,        5, FLAGS },
 261     { "chroma_msize_x", "chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 262     { "cx",             "chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 263     { "chroma_msize_y", "chroma matrix vertical size",   OFFSET(cmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 264     { "cy",             "chroma matrix vertical size",   OFFSET(cmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
 265     { "chroma_amount",  "chroma effect strength",        OFFSET(camount),  AV_OPT_TYPE_FLOAT, { .dbl = 0 },       -2,        5, FLAGS },
 266     { "ca",             "chroma effect strength",        OFFSET(camount),  AV_OPT_TYPE_FLOAT, { .dbl = 0 },       -2,        5, FLAGS },
 267     { NULL },
 268 };
 269
 270 AVFILTER_DEFINE_CLASS(unsharp);
 271
 272 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
 273     {
 274         .name         = "default",
 275         .type         = AVMEDIA_TYPE_VIDEO,
 276         .filter_frame = filter_frame,
 277         .config_props = config_props,
 278     },
 279     { NULL }
 280 };
 281
 282 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
 283     {
 284         .name = "default",
 285         .type = AVMEDIA_TYPE_VIDEO,
 286     },
 287     { NULL }
 288 };
 289
 290 AVFilter avfilter_vf_unsharp = {
 291     .name      = "unsharp",
 292     .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
 293
 294     .priv_size = sizeof(UnsharpContext),
 295     .priv_class = &unsharp_class,
 296
 297     .init = init,
 298     .uninit = uninit,
 299     .query_formats = query_formats,
 300
 301     .inputs    = avfilter_vf_unsharp_inputs,
 302
 303     .outputs   = avfilter_vf_unsharp_outputs,
 304 };