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