libavfilter/vf_unsharp.c
e0728d79
 /*
3fa77bde
  * Original copyright (c) 2002 Remi Guyomarch <rguyom@pobox.com>
  * Port copyright (c) 2010 Daniel G. Taylor <dan@programmer-art.org>
e0728d79
  * Relicensed to the LGPL with permission from Remi Guyomarch.
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
3fa77bde
  * blur / sharpen filter, ported to FFmpeg from MPlayer
  * libmpcodecs/unsharp.c.
e0728d79
  *
  * This code is based on:
  *
  * An Efficient algorithm for Gaussian blur using finite-state machines
  * Frederick M. Waltz and John W. V. Miller
  *
  * SPIE Conf. on Machine Vision Systems for Inspection and Metrology VII
  * Originally published Boston, Nov 98
  *
  * http://www.engin.umd.umich.edu/~jwvm/ece581/21_GBlur.pdf
  */
 
 #include "avfilter.h"
b74a1da4
 #include "formats.h"
9d0bfc50
 #include "internal.h"
803391f7
 #include "video.h"
e0728d79
 #include "libavutil/common.h"
faceb0af
 #include "libavutil/imgutils.h"
e0728d79
 #include "libavutil/mem.h"
fbcc584d
 #include "libavutil/opt.h"
e0728d79
 #include "libavutil/pixdesc.h"
cd134963
 #include "unsharp.h"
e0728d79
 
53e86382
 static void apply_unsharp(      uint8_t *dst, int dst_stride,
                           const uint8_t *src, int src_stride,
cd134963
                           int width, int height, UnsharpFilterParam *fp)
e0728d79
 {
     uint32_t **sc = fp->sc;
7ac3ccc5
     uint32_t sr[MAX_MATRIX_SIZE - 1], tmp1, tmp2;
e0728d79
 
     int32_t res;
     int x, y, z;
cb3034e0
     const uint8_t *src2 = NULL;  //silence a warning
d2cadea3
     const int amount = fp->amount;
     const int steps_x = fp->steps_x;
     const int steps_y = fp->steps_y;
     const int scalebits = fp->scalebits;
     const int32_t halfscale = fp->halfscale;
e0728d79
 
d2cadea3
     if (!amount) {
faceb0af
         av_image_copy_plane(dst, dst_stride, src, src_stride, width, height);
e0728d79
         return;
     }
 
d2cadea3
     for (y = 0; y < 2 * steps_y; y++)
         memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * steps_x));
e0728d79
 
d2cadea3
     for (y = -steps_y; y < height + steps_y; y++) {
63b61d55
         if (y < height)
             src2 = src;
 
d2cadea3
         memset(sr, 0, sizeof(sr[0]) * (2 * steps_x - 1));
         for (x = -steps_x; x < width + steps_x; x++) {
63b61d55
             tmp1 = x <= 0 ? src2[0] : x >= width ? src2[width-1] : src2[x];
d2cadea3
             for (z = 0; z < steps_x * 2; z += 2) {
e0728d79
                 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
                 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
             }
d2cadea3
             for (z = 0; z < steps_y * 2; z += 2) {
                 tmp2 = sc[z + 0][x + steps_x] + tmp1; sc[z + 0][x + steps_x] = tmp1;
                 tmp1 = sc[z + 1][x + steps_x] + tmp2; sc[z + 1][x + steps_x] = tmp2;
e0728d79
             }
d2cadea3
             if (x >= steps_x && y >= steps_y) {
                 const uint8_t *srx = src - steps_y * src_stride + x - steps_x;
                 uint8_t *dsx       = dst - steps_y * dst_stride + x - steps_x;
e0728d79
 
d2cadea3
                 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + halfscale) >> scalebits)) * amount) >> 16);
e0728d79
                 *dsx = av_clip_uint8(res);
             }
         }
         if (y >= 0) {
             dst += dst_stride;
             src += src_stride;
         }
     }
 }
 
cd134963
 static int apply_unsharp_c(AVFilterContext *ctx, AVFrame *in, AVFrame *out)
 {
     AVFilterLink *inlink = ctx->inputs[0];
78995dc2
     UnsharpContext *s = ctx->priv;
cd134963
     int i, plane_w[3], plane_h[3];
     UnsharpFilterParam *fp[3];
     plane_w[0] = inlink->w;
21f94684
     plane_w[1] = plane_w[2] = AV_CEIL_RSHIFT(inlink->w, s->hsub);
cd134963
     plane_h[0] = inlink->h;
21f94684
     plane_h[1] = plane_h[2] = AV_CEIL_RSHIFT(inlink->h, s->vsub);
78995dc2
     fp[0] = &s->luma;
     fp[1] = fp[2] = &s->chroma;
cd134963
     for (i = 0; i < 3; i++) {
         apply_unsharp(out->data[i], out->linesize[i], in->data[i], in->linesize[i], plane_w[i], plane_h[i], fp[i]);
     }
     return 0;
 }
 
 static void set_filter_param(UnsharpFilterParam *fp, int msize_x, int msize_y, float amount)
e0728d79
 {
     fp->msize_x = msize_x;
     fp->msize_y = msize_y;
     fp->amount = amount * 65536.0;
 
     fp->steps_x = msize_x / 2;
     fp->steps_y = msize_y / 2;
     fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
     fp->halfscale = 1 << (fp->scalebits - 1);
 }
 
d69a4177
 static av_cold int init(AVFilterContext *ctx)
e0728d79
 {
78995dc2
     UnsharpContext *s = ctx->priv;
fbcc584d
 
78995dc2
     set_filter_param(&s->luma,   s->lmsize_x, s->lmsize_y, s->lamount);
     set_filter_param(&s->chroma, s->cmsize_x, s->cmsize_y, s->camount);
e0728d79
 
d790887d
     if (s->luma.scalebits >= 26 || s->chroma.scalebits >= 26) {
         av_log(ctx, AV_LOG_ERROR, "luma or chroma matrix size too big\n");
         return AVERROR(EINVAL);
     }
78995dc2
     s->apply_unsharp = apply_unsharp_c;
e0728d79
     return 0;
 }
 
 static int query_formats(AVFilterContext *ctx)
 {
185d1f3b
     static const enum AVPixelFormat pix_fmts[] = {
716d413c
         AV_PIX_FMT_YUV420P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_NONE
e0728d79
     };
 
a0854c08
     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
     if (!fmts_list)
         return AVERROR(ENOMEM);
     return ff_set_common_formats(ctx, fmts_list);
e0728d79
 }
 
cd134963
 static int init_filter_param(AVFilterContext *ctx, UnsharpFilterParam *fp, const char *effect_type, int width)
e0728d79
 {
     int z;
64e592ee
     const char *effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
e0728d79
 
ef4c71e8
     if  (!(fp->msize_x & fp->msize_y & 1)) {
         av_log(ctx, AV_LOG_ERROR,
                "Invalid even size for %s matrix size %dx%d\n",
                effect_type, fp->msize_x, fp->msize_y);
         return AVERROR(EINVAL);
     }
 
1a49a169
     av_log(ctx, AV_LOG_VERBOSE, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
e0728d79
            effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
 
     for (z = 0; z < 2 * fp->steps_y; z++)
263aeb82
         if (!(fp->sc[z] = av_malloc_array(width + 2 * fp->steps_x,
                                           sizeof(*(fp->sc[z])))))
89505f2c
             return AVERROR(ENOMEM);
ef4c71e8
 
     return 0;
e0728d79
 }
 
 static int config_props(AVFilterLink *link)
 {
78995dc2
     UnsharpContext *s = link->dst->priv;
59ee9f78
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
ef4c71e8
     int ret;
e0728d79
 
78995dc2
     s->hsub = desc->log2_chroma_w;
     s->vsub = desc->log2_chroma_h;
09603dcf
 
78995dc2
     ret = init_filter_param(link->dst, &s->luma,   "luma",   link->w);
ef4c71e8
     if (ret < 0)
         return ret;
21f94684
     ret = init_filter_param(link->dst, &s->chroma, "chroma", AV_CEIL_RSHIFT(link->w, s->hsub));
ef4c71e8
     if (ret < 0)
         return ret;
e0728d79
 
     return 0;
 }
 
cd134963
 static void free_filter_param(UnsharpFilterParam *fp)
e0728d79
 {
     int z;
 
     for (z = 0; z < 2 * fp->steps_y; z++)
498396f8
         av_freep(&fp->sc[z]);
e0728d79
 }
 
 static av_cold void uninit(AVFilterContext *ctx)
 {
78995dc2
     UnsharpContext *s = ctx->priv;
e0728d79
 
78995dc2
     free_filter_param(&s->luma);
     free_filter_param(&s->chroma);
e0728d79
 }
 
7e350379
 static int filter_frame(AVFilterLink *link, AVFrame *in)
e0728d79
 {
78995dc2
     UnsharpContext *s = link->dst->priv;
45eed9b1
     AVFilterLink *outlink   = link->dst->outputs[0];
7e350379
     AVFrame *out;
cd134963
     int ret = 0;
45eed9b1
 
7e350379
     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
45eed9b1
     if (!out) {
7e350379
         av_frame_free(&in);
45eed9b1
         return AVERROR(ENOMEM);
     }
7e350379
     av_frame_copy_props(out, in);
e0728d79
 
78995dc2
     ret = s->apply_unsharp(link->dst, in, out);
3650cb2d
 
7e350379
     av_frame_free(&in);
cd134963
 
c347b286
     if (ret < 0) {
         av_frame_free(&out);
cd134963
         return ret;
c347b286
     }
45eed9b1
     return ff_filter_frame(outlink, out);
e0728d79
 }
 
b83e9efc
 #define OFFSET(x) offsetof(UnsharpContext, x)
c2696dab
 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 #define MIN_SIZE 3
4096bb17
 #define MAX_SIZE 23
c2696dab
 static const AVOption unsharp_options[] = {
ae0ce99c
     { "luma_msize_x",   "set luma matrix horizontal size",   OFFSET(lmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "lx",             "set luma matrix horizontal size",   OFFSET(lmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "luma_msize_y",   "set luma matrix vertical size",     OFFSET(lmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "ly",             "set luma matrix vertical size",     OFFSET(lmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "luma_amount",    "set luma effect strength",          OFFSET(lamount),  AV_OPT_TYPE_FLOAT, { .dbl = 1 },       -2,        5, FLAGS },
     { "la",             "set luma effect strength",          OFFSET(lamount),  AV_OPT_TYPE_FLOAT, { .dbl = 1 },       -2,        5, FLAGS },
     { "chroma_msize_x", "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "cx",             "set chroma matrix horizontal size", OFFSET(cmsize_x), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "chroma_msize_y", "set chroma matrix vertical size",   OFFSET(cmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "cy",             "set chroma matrix vertical size",   OFFSET(cmsize_y), AV_OPT_TYPE_INT,   { .i64 = 5 }, MIN_SIZE, MAX_SIZE, FLAGS },
     { "chroma_amount",  "set chroma effect strength",        OFFSET(camount),  AV_OPT_TYPE_FLOAT, { .dbl = 0 },       -2,        5, FLAGS },
     { "ca",             "set chroma effect strength",        OFFSET(camount),  AV_OPT_TYPE_FLOAT, { .dbl = 0 },       -2,        5, FLAGS },
3650cb2d
     { "opencl",         "ignored",                           OFFSET(opencl),   AV_OPT_TYPE_BOOL,  { .i64 = 0 },        0,        1, FLAGS },
b211607b
     { NULL }
b83e9efc
 };
 
c2696dab
 AVFILTER_DEFINE_CLASS(unsharp);
b83e9efc
 
568c70e7
 static const AVFilterPad avfilter_vf_unsharp_inputs[] = {
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
45eed9b1
         .filter_frame = filter_frame,
568c70e7
         .config_props = config_props,
     },
     { NULL }
 };
 
 static const AVFilterPad avfilter_vf_unsharp_outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO,
     },
     { NULL }
 };
 
cd43ca04
 AVFilter ff_vf_unsharp = {
b211607b
     .name          = "unsharp",
     .description   = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
     .priv_size     = sizeof(UnsharpContext),
     .priv_class    = &unsharp_class,
     .init          = init,
     .uninit        = uninit,
e0728d79
     .query_formats = query_formats,
b211607b
     .inputs        = avfilter_vf_unsharp_inputs,
     .outputs       = avfilter_vf_unsharp_outputs,
     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
e0728d79
 };