vf_unsharp: vertically align lines, for better readability
[ffmpeg.git] / 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 "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 /* right-shift and round-up */
48 #define SHIFTUP(x,shift) (-((-(x))>>(shift)))
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     int hsub, vsub;
65 } UnsharpContext;
66
67 static void apply_unsharp(      uint8_t *dst, int dst_stride,
68                           const uint8_t *src, int src_stride,
69                           int width, int height, FilterParam *fp)
70 {
71     uint32_t **sc = fp->sc;
72     uint32_t sr[(MAX_SIZE * MAX_SIZE) - 1], tmp1, tmp2;
73
74     int32_t res;
75     int x, y, z;
76
77     if (!fp->amount) {
78         if (dst_stride == src_stride)
79             memcpy(dst, src, src_stride * height);
80         else
81             for (y = 0; y < height; y++, dst += dst_stride, src += src_stride)
82                 memcpy(dst, src, width);
83         return;
84     }
85
86     for (y = 0; y < 2 * fp->steps_y; y++)
87         memset(sc[y], 0, sizeof(sc[y][0]) * (width + 2 * fp->steps_x));
88
89     for (y = -fp->steps_y; y < height + fp->steps_y; y++) {
90         memset(sr, 0, sizeof(sr[0]) * (2 * fp->steps_x - 1));
91         for (x = -fp->steps_x; x < width + fp->steps_x; x++) {
92             tmp1 = x <= 0 ? src[0] : x >= width ? src[width-1] : src[x];
93             for (z = 0; z < fp->steps_x * 2; z += 2) {
94                 tmp2 = sr[z + 0] + tmp1; sr[z + 0] = tmp1;
95                 tmp1 = sr[z + 1] + tmp2; sr[z + 1] = tmp2;
96             }
97             for (z = 0; z < fp->steps_y * 2; z += 2) {
98                 tmp2 = sc[z + 0][x + fp->steps_x] + tmp1; sc[z + 0][x + fp->steps_x] = tmp1;
99                 tmp1 = sc[z + 1][x + fp->steps_x] + tmp2; sc[z + 1][x + fp->steps_x] = tmp2;
100             }
101             if (x >= fp->steps_x && y >= fp->steps_y) {
102                 const uint8_t *srx = src - fp->steps_y * src_stride + x - fp->steps_x;
103                 uint8_t       *dsx = dst - fp->steps_y * dst_stride + x - fp->steps_x;
104
105                 res = (int32_t)*srx + ((((int32_t) * srx - (int32_t)((tmp1 + fp->halfscale) >> fp->scalebits)) * fp->amount) >> 16);
106                 *dsx = av_clip_uint8(res);
107             }
108         }
109         if (y >= 0) {
110             dst += dst_stride;
111             src += src_stride;
112         }
113     }
114 }
115
116 static void set_filter_param(FilterParam *fp, int msize_x, int msize_y, double amount)
117 {
118     fp->msize_x = msize_x;
119     fp->msize_y = msize_y;
120     fp->amount = amount * 65536.0;
121
122     fp->steps_x = msize_x / 2;
123     fp->steps_y = msize_y / 2;
124     fp->scalebits = (fp->steps_x + fp->steps_y) * 2;
125     fp->halfscale = 1 << (fp->scalebits - 1);
126 }
127
128 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
129 {
130     UnsharpContext *unsharp = ctx->priv;
131     int lmsize_x = 5, cmsize_x = 0;
132     int lmsize_y = 5, cmsize_y = 0;
133     double lamount = 1.0f, camount = 0.0f;
134
135     if (args)
136         sscanf(args, "%d:%d:%lf:%d:%d:%lf", &lmsize_x, &lmsize_y, &lamount,
137                                             &cmsize_x, &cmsize_y, &camount);
138
139     if ((lamount && (lmsize_x < 2 || lmsize_y < 2)) ||
140         (camount && (cmsize_x < 2 || cmsize_y < 2))) {
141         av_log(ctx, AV_LOG_ERROR,
142                "Invalid value <2 for lmsize_x:%d or lmsize_y:%d or cmsize_x:%d or cmsize_y:%d\n",
143                lmsize_x, lmsize_y, cmsize_x, cmsize_y);
144         return AVERROR(EINVAL);
145     }
146
147     set_filter_param(&unsharp->luma,   lmsize_x, lmsize_y, lamount);
148     set_filter_param(&unsharp->chroma, cmsize_x, cmsize_y, camount);
149
150     return 0;
151 }
152
153 static int query_formats(AVFilterContext *ctx)
154 {
155     enum PixelFormat pix_fmts[] = {
156         PIX_FMT_YUV420P,  PIX_FMT_YUV422P,  PIX_FMT_YUV444P,  PIX_FMT_YUV410P,
157         PIX_FMT_YUV411P,  PIX_FMT_YUV440P,  PIX_FMT_YUVJ420P, PIX_FMT_YUVJ422P,
158         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ440P, PIX_FMT_NONE
159     };
160
161     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
162
163     return 0;
164 }
165
166 static void init_filter_param(AVFilterContext *ctx, FilterParam *fp, const char *effect_type, int width)
167 {
168     int z;
169     const char *effect;
170
171     effect = fp->amount == 0 ? "none" : fp->amount < 0 ? "blur" : "sharpen";
172
173     av_log(ctx, AV_LOG_INFO, "effect:%s type:%s msize_x:%d msize_y:%d amount:%0.2f\n",
174            effect, effect_type, fp->msize_x, fp->msize_y, fp->amount / 65535.0);
175
176     for (z = 0; z < 2 * fp->steps_y; z++)
177         fp->sc[z] = av_malloc(sizeof(*(fp->sc[z])) * (width + 2 * fp->steps_x));
178 }
179
180 static int config_props(AVFilterLink *link)
181 {
182     UnsharpContext *unsharp = link->dst->priv;
183
184     unsharp->hsub = av_pix_fmt_descriptors[link->format].log2_chroma_w;
185     unsharp->vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
186
187     init_filter_param(link->dst, &unsharp->luma,   "luma",   link->w);
188     init_filter_param(link->dst, &unsharp->chroma, "chroma", SHIFTUP(link->w, unsharp->hsub));
189
190     return 0;
191 }
192
193 static void free_filter_param(FilterParam *fp)
194 {
195     int z;
196
197     for (z = 0; z < 2 * fp->steps_y; z++)
198         av_free(fp->sc[z]);
199 }
200
201 static av_cold void uninit(AVFilterContext *ctx)
202 {
203     UnsharpContext *unsharp = ctx->priv;
204
205     free_filter_param(&unsharp->luma);
206     free_filter_param(&unsharp->chroma);
207 }
208
209 static void end_frame(AVFilterLink *link)
210 {
211     UnsharpContext *unsharp = link->dst->priv;
212     AVFilterBufferRef *in  = link->cur_buf;
213     AVFilterBufferRef *out = link->dst->outputs[0]->out_buf;
214     int cw = SHIFTUP(link->w, unsharp->hsub);
215     int ch = SHIFTUP(link->h, unsharp->vsub);
216
217     apply_unsharp(out->data[0], out->linesize[0], in->data[0], in->linesize[0], link->w, link->h, &unsharp->luma);
218     apply_unsharp(out->data[1], out->linesize[1], in->data[1], in->linesize[1], cw,      ch,      &unsharp->chroma);
219     apply_unsharp(out->data[2], out->linesize[2], in->data[2], in->linesize[2], cw,      ch,      &unsharp->chroma);
220
221     avfilter_unref_buffer(in);
222     avfilter_draw_slice(link->dst->outputs[0], 0, link->h, 1);
223     avfilter_end_frame(link->dst->outputs[0]);
224     avfilter_unref_buffer(out);
225 }
226
227 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
228 {
229 }
230
231 AVFilter avfilter_vf_unsharp = {
232     .name      = "unsharp",
233     .description = NULL_IF_CONFIG_SMALL("Sharpen or blur the input video."),
234
235     .priv_size = sizeof(UnsharpContext),
236
237     .init = init,
238     .uninit = uninit,
239     .query_formats = query_formats,
240
241     .inputs    = (AVFilterPad[]) {{ .name             = "default",
242                                     .type             = AVMEDIA_TYPE_VIDEO,
243                                     .draw_slice       = draw_slice,
244                                     .end_frame        = end_frame,
245                                     .config_props     = config_props,
246                                     .min_perms        = AV_PERM_READ, },
247                                   { .name = NULL}},
248
249     .outputs   = (AVFilterPad[]) {{ .name             = "default",
250                                     .type             = AVMEDIA_TYPE_VIDEO, },
251                                   { .name = NULL}},
252 };