Remove explicit filename from Doxygen @file commands.
[ffmpeg.git] / libavfilter / vf_unsharp.c
1 /*
2  * Ported to FFmpeg from MPlayer libmpcodecs/unsharp.c
3  * Original copyright (C) 2002 Remi Guyomarch <rguyom@pobox.com>
4  * Port copyright (C) 2010 Daniel G. Taylor <dan@programmer-art.org>
5  * Relicensed to the LGPL with permission from Remi Guyomarch.
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 /**
25  * @file
26  * blur / sharpen filter
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 "avfilter.h"
40 #include "libavutil/common.h"
41 #include "libavutil/mem.h"
42 #include "libavutil/pixdesc.h"
43
44 #define MIN_SIZE 3
45 #define MAX_SIZE 13
46
47 #define CHROMA_WIDTH(link)  -((-link->w) >> av_pix_fmt_descriptors[link->format].log2_chroma_w)
48 #define CHROMA_HEIGHT(link) -((-link->h) >> av_pix_fmt_descriptors[link->format].log2_chroma_h)
49
50 typedef struct FilterParam {
51     int msize_x;                             ///< matrix width
52     int msize_y;                             ///< matrix height
53     int amount;                              ///< effect amount
54     int steps_x;                             ///< horizontal step count
55     int steps_y;                             ///< vertical step count
56     int scalebits;                           ///< bits to shift pixel
57     int32_t halfscale;                       ///< amount to add to pixel
58     uint32_t *sc[(MAX_SIZE * MAX_SIZE) - 1]; ///< finite state machine storage
59 } FilterParam;
60
61 typedef struct {
62     FilterParam luma;   ///< luma parameters (width, height, amount)
63     FilterParam chroma; ///< chroma parameters (width, height, amount)
64 } UnsharpContext;
65
66 static void unsharpen(uint8_t *dst, uint8_t *src, int dst_stride, int src_stride, int width, int height, FilterParam *fp)
67 {
68     uint32_t **sc = fp->sc;
69     uint32_t sr[(MAX_SIZE * MAX_SIZE) - 1], tmp1, tmp2;
70
71     int32_t res;
72     int x, y, z;
73
74     if (!fp->amount) {
75         if (dst_stride == src_stride)
76             memcpy(dst, src, src_stride * height);
77         else
78             for (y = 0; y < height; y++, dst += dst_stride, src += src_stride)
79                 memcpy(dst, src, width);
80         return;
81     }
82
83     for (y = 0; y < 2 * fp->steps_y; y++)
84         memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * fp->steps_x));
85
86     for (y =- fp->steps_y; y < height + fp->steps_y; y++) {
87         memset(sr, 0, sizeof(sr[0]) * (2 * fp->steps_x - 1));
88         for (x =- fp->steps_x; x < width + fp->steps_x; x++) {
89             tmp1 = x <= 0 ? src[0] : x >= width ? src[width-1] : src[x];
90             for (z = 0; z < fp->steps_x * 2; z += 2) {
91                 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
92                 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
93             }
94             for (z = 0; z < fp->steps_y * 2; z += 2) {
95                 tmp2 = sc[z + 0][x + fp->steps_x] + tmp1; sc[z + 0][x + fp->steps_x] = tmp1;
96                 tmp1 = sc[z + 1][x + fp->steps_x] + tmp2; sc[z + 1][x + fp->steps_x] = tmp2;
97             }
98             if (x >= fp->steps_x && y >= fp->steps_y) {
99                 uint8_t* srx = src - fp->steps_y * src_stride + x - fp->steps_x;
100                 uint8_t* dsx = dst - fp->steps_y * dst_stride + x - fp->steps_x;
101
102                 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + fp->halfscale) >> fp->scalebits)) * fp->amount) >> 16);
103                 *dsx = av_clip_uint8(res);
104             }
105         }
106         if (y >= 0) {
107             dst += dst_stride;
108             src += src_stride;
109         }
110     }
111 }
112
113 static void set_filter_param(FilterParam *fp, int msize_x, int msize_y, double amount)
114 {
115     fp->msize_x = msize_x;
116     fp->msize_y = msize_y;
117     fp->amount = amount * 65536.0;
118
119     fp->steps_x = msize_x / 2;
120     fp->steps_y = msize_y / 2;
121     fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
122     fp->halfscale = 1 << (fp->scalebits - 1);
123 }
124
125 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
126 {
127     UnsharpContext *unsharp = ctx->priv;
128     int lmsize_x = 5, cmsize_x = 0;
129     int lmsize_y = 5, cmsize_y = 0;
130     double lamount = 1.0f, camount = 0.0f;
131
132     if (args)
133         sscanf(args, "%d:%d:%lf:%d:%d:%lf", &lmsize_x, &lmsize_y, &lamount,
134                                             &cmsize_x, &cmsize_y, &camount);
135
136     set_filter_param(&unsharp->luma,   lmsize_x, lmsize_y, lamount);
137     set_filter_param(&unsharp->chroma, cmsize_x, cmsize_y, camount);
138
139     return 0;
140 }
141
142 static int query_formats(AVFilterContext *ctx)
143 {
144     enum PixelFormat pix_fmts[] = {
145         PIX_FMT_YUV420P,  PIX_FMT_YUV422P,  PIX_FMT_YUV444P,  PIX_FMT_YUV410P,
146         PIX_FMT_YUV411P,  PIX_FMT_YUV440P,  PIX_FMT_YUVJ420P, PIX_FMT_YUVJ422P,
147         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ440P, PIX_FMT_NONE
148     };
149
150     avfilter_set_common_formats(ctx, avfilter_make_format_list(pix_fmts));
151
152     return 0;
153 }
154
155 static void init_filter_param(AVFilterContext *ctx, FilterParam *fp, const char *effect_type, int width)
156 {
157     int z;
158     const char *effect;
159
160     effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
161
162     av_log(ctx, AV_LOG_INFO, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
163            effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
164
165     for (z = 0; z < 2 * fp->steps_y; z++)
166         fp->sc[z] = av_malloc(sizeof(*(fp->sc[z])) * (width + 2 * fp->steps_x));
167 }
168
169 static int config_props(AVFilterLink *link)
170 {
171     UnsharpContext *unsharp = link->dst->priv;
172
173     init_filter_param(link->dst, &unsharp->luma,   "luma",   link->w);
174     init_filter_param(link->dst, &unsharp->chroma, "chroma", CHROMA_WIDTH(link));
175
176     return 0;
177 }
178
179 static void free_filter_param(FilterParam *fp)
180 {
181     int z;
182
183     for (z = 0; z < 2 * fp->steps_y; z++)
184         av_free(fp->sc[z]);
185 }
186
187 static av_cold void uninit(AVFilterContext *ctx)
188 {
189     UnsharpContext *unsharp = ctx->priv;
190
191     free_filter_param(&unsharp->luma);
192     free_filter_param(&unsharp->chroma);
193 }
194
195 static void end_frame(AVFilterLink *link)
196 {
197     UnsharpContext *unsharp = link->dst->priv;
198     AVFilterPicRef *in  = link->cur_pic;
199     AVFilterPicRef *out = link->dst->outputs[0]->outpic;
200
201     unsharpen(out->data[0], in->data[0], out->linesize[0], in->linesize[0], link->w,            link->h,             &unsharp->luma);
202     unsharpen(out->data[1], in->data[1], out->linesize[1], in->linesize[1], CHROMA_WIDTH(link), CHROMA_HEIGHT(link), &unsharp->chroma);
203     unsharpen(out->data[2], in->data[2], out->linesize[2], in->linesize[2], CHROMA_WIDTH(link), CHROMA_HEIGHT(link), &unsharp->chroma);
204
205     avfilter_unref_pic(in);
206     avfilter_draw_slice(link->dst->outputs[0], 0, link->h, 1);
207     avfilter_end_frame(link->dst->outputs[0]);
208     avfilter_unref_pic(out);
209 }
210
211 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
212 {
213 }
214
215 AVFilter avfilter_vf_unsharp = {
216     .name      = "unsharp",
217     .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
218
219     .priv_size = sizeof(UnsharpContext),
220
221     .init = init,
222     .uninit = uninit,
223     .query_formats = query_formats,
224
225     .inputs    = (AVFilterPad[]) {{ .name             = "default",
226                                     .type             = AVMEDIA_TYPE_VIDEO,
227                                     .draw_slice       = draw_slice,
228                                     .end_frame        = end_frame,
229                                     .config_props     = config_props,
230                                     .min_perms        = AV_PERM_READ, },
231                                   { .name = NULL}},
232
233     .outputs   = (AVFilterPad[]) {{ .name             = "default",
234                                     .type             = AVMEDIA_TYPE_VIDEO, },
235                                   { .name = NULL}},
236 };