vf_noise: remove low quality mode
[ffmpeg.git] / libavfilter / vf_noise.c
1 /*
2  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (c) 2013 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * noise generator
25  */
26
27 #include "libavutil/opt.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/lfg.h"
30 #include "libavutil/parseutils.h"
31 #include "libavutil/pixdesc.h"
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "internal.h"
35 #include "video.h"
36
37 #define MAX_NOISE 4096
38 #define MAX_SHIFT 1024
39 #define MAX_RES (MAX_NOISE-MAX_SHIFT)
40
41 #define NOISE_UNIFORM  1
42 #define NOISE_TEMPORAL 2
43 #define NOISE_AVERAGED 8
44 #define NOISE_PATTERN  16
45
46 typedef struct {
47     int strength;
48     unsigned flags;
49     int shiftptr;
50     AVLFG lfg;
51     int seed;
52     int8_t *noise;
53     int8_t *prev_shift[MAX_RES][3];
54 } FilterParams;
55
56 typedef struct {
57     const AVClass *class;
58     int nb_planes;
59     int linesize[4];
60     int height[4];
61     FilterParams all;
62     FilterParams param[4];
63     int rand_shift[MAX_RES];
64     int rand_shift_init;
65 } NoiseContext;
66
67 #define OFFSET(x) offsetof(NoiseContext, x)
68 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
69
70 #define NOISE_PARAMS(name, x, param)                                                                                             \
71     {#name"_seed", "set component #"#x" noise seed", OFFSET(param.seed), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, FLAGS},        \
72     {#name"_strength", "set component #"#x" strength", OFFSET(param.strength), AV_OPT_TYPE_INT, {.i64=0}, 0, 100, FLAGS},        \
73     {#name"s",         "set component #"#x" strength", OFFSET(param.strength), AV_OPT_TYPE_INT, {.i64=0}, 0, 100, FLAGS},        \
74     {#name"_flags", "set component #"#x" flags", OFFSET(param.flags), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, 31, FLAGS, #name"_flags"}, \
75     {#name"f", "set component #"#x" flags", OFFSET(param.flags), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, 31, FLAGS, #name"_flags"},      \
76     {"a", "averaged noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_AVERAGED}, 0, 0, FLAGS, #name"_flags"},                            \
77     {"p", "(semi)regular pattern", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_PATTERN},  0, 0, FLAGS, #name"_flags"},                     \
78     {"t", "temporal noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_TEMPORAL}, 0, 0, FLAGS, #name"_flags"},                            \
79     {"u", "uniform noise",  0, AV_OPT_TYPE_CONST, {.i64=NOISE_UNIFORM},  0, 0, FLAGS, #name"_flags"},
80
81 static const AVOption noise_options[] = {
82     NOISE_PARAMS(all, 0, all)
83     NOISE_PARAMS(c0,  0, param[0])
84     NOISE_PARAMS(c1,  1, param[1])
85     NOISE_PARAMS(c2,  2, param[2])
86     NOISE_PARAMS(c3,  3, param[3])
87     {NULL}
88 };
89
90 AVFILTER_DEFINE_CLASS(noise);
91
92 static const int8_t patt[4] = { -1, 0, 1, 0 };
93
94 #define RAND_N(range) ((int) ((double) range * av_lfg_get(lfg) / (UINT_MAX + 1.0)))
95 static int init_noise(NoiseContext *n, int comp)
96 {
97     int8_t *noise = av_malloc(MAX_NOISE * sizeof(int8_t));
98     FilterParams *fp = &n->param[comp];
99     AVLFG *lfg = &n->param[comp].lfg;
100     int strength = fp->strength;
101     int flags = fp->flags;
102     int i, j;
103
104     if (!noise)
105         return AVERROR(ENOMEM);
106
107     av_lfg_init(&fp->lfg, fp->seed);
108
109     for (i = 0, j = 0; i < MAX_NOISE; i++, j++) {
110         if (flags & NOISE_UNIFORM) {
111             if (flags & NOISE_AVERAGED) {
112                 if (flags & NOISE_PATTERN) {
113                     noise[i] = (RAND_N(strength) - strength / 2) / 6
114                         + patt[j % 4] * strength * 0.25 / 3;
115                 } else {
116                     noise[i] = (RAND_N(strength) - strength / 2) / 3;
117                 }
118             } else {
119                 if (flags & NOISE_PATTERN) {
120                     noise[i] = (RAND_N(strength) - strength / 2) / 2
121                         + patt[j % 4] * strength * 0.25;
122                 } else {
123                     noise[i] = RAND_N(strength) - strength / 2;
124                 }
125             }
126         } else {
127             double x1, x2, w, y1;
128             do {
129                 x1 = 2.0 * av_lfg_get(lfg) / (float)RAND_MAX - 1.0;
130                 x2 = 2.0 * av_lfg_get(lfg) / (float)RAND_MAX - 1.0;
131                 w = x1 * x1 + x2 * x2;
132             } while (w >= 1.0);
133
134             w   = sqrt((-2.0 * log(w)) / w);
135             y1  = x1 * w;
136             y1 *= strength / sqrt(3.0);
137             if (flags & NOISE_PATTERN) {
138                 y1 /= 2;
139                 y1 += patt[j % 4] * strength * 0.35;
140             }
141             y1 = av_clipf(y1, -128, 127);
142             if (flags & NOISE_AVERAGED)
143                 y1 /= 3.0;
144             noise[i] = (int)y1;
145         }
146         if (RAND_N(6) == 0)
147             j--;
148     }
149
150     for (i = 0; i < MAX_RES; i++)
151         for (j = 0; j < 3; j++)
152             fp->prev_shift[i][j] = noise + (av_lfg_get(lfg) & (MAX_SHIFT - 1));
153
154     if (!n->rand_shift_init) {
155         for (i = 0; i < MAX_RES; i++)
156             n->rand_shift[i] = av_lfg_get(lfg) & (MAX_SHIFT - 1);
157         n->rand_shift_init = 1;
158     }
159
160     fp->noise = noise;
161     fp->shiftptr = 0;
162     return 0;
163 }
164
165 static av_cold int init(AVFilterContext *ctx, const char *args)
166 {
167     NoiseContext *n = ctx->priv;
168     int ret, i;
169
170     for (i = 0; i < 4; i++) {
171         if (n->all.seed >= 0)
172             n->param[i].seed = n->all.seed;
173         else
174             n->param[i].seed = 123457;
175         if (n->all.strength)
176             n->param[i].strength = n->all.strength;
177         if (n->all.flags)
178             n->param[i].flags = n->all.flags;
179     }
180
181     for (i = 0; i < 4; i++) {
182         if (n->param[i].strength && ((ret = init_noise(n, i)) < 0))
183             return ret;
184     }
185
186     return 0;
187 }
188
189 static int query_formats(AVFilterContext *ctx)
190 {
191     AVFilterFormats *formats = NULL;
192     int fmt;
193
194     for (fmt = 0; fmt < AV_PIX_FMT_NB; fmt++) {
195         const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
196         if (desc->flags & PIX_FMT_PLANAR && !((desc->comp[0].depth_minus1 + 1) & 7))
197             ff_add_format(&formats, fmt);
198     }
199
200     ff_set_common_formats(ctx, formats);
201     return 0;
202 }
203
204 static int config_input(AVFilterLink *inlink)
205 {
206     NoiseContext *n = inlink->dst->priv;
207     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
208     int i, ret;
209
210     for (i = 0; i < desc->nb_components; i++)
211         n->nb_planes = FFMAX(n->nb_planes, desc->comp[i].plane);
212     n->nb_planes++;
213
214     if ((ret = av_image_fill_linesizes(n->linesize, inlink->format, inlink->w)) < 0)
215         return ret;
216
217     n->height[1] = n->height[2] = inlink->h >> desc->log2_chroma_h;
218     n->height[0] = n->height[3] = inlink->h;
219
220     return 0;
221 }
222
223 static void line_noise(uint8_t *dst, const uint8_t *src, int8_t *noise,
224                        int len, int shift)
225 {
226     int i;
227
228     noise += shift;
229     for (i = 0; i < len; i++) {
230         int v = src[i] + noise[i];
231
232         dst[i] = av_clip_uint8(v);
233     }
234 }
235
236 static void line_noise_avg(uint8_t *dst, const uint8_t *src,
237                            int len, int8_t **shift)
238 {
239     int i;
240     int8_t *src2 = (int8_t*)src;
241
242     for (i = 0; i < len; i++) {
243         const int n = shift[0][i] + shift[1][i] + shift[2][i];
244         dst[i] = src2[i] + ((n * src2[i]) >> 7);
245     }
246 }
247
248 static void noise(uint8_t *dst, const uint8_t *src,
249                   int dst_linesize, int src_linesize,
250                   int width, int height, NoiseContext *n, int comp)
251 {
252     int8_t *noise = n->param[comp].noise;
253     int flags = n->param[comp].flags;
254     AVLFG *lfg = &n->param[comp].lfg;
255     int shift, y;
256
257     if (!noise) {
258         if (dst != src) {
259             for (y = 0; y < height; y++) {
260                 memcpy(dst, src, width);
261                 dst += dst_linesize;
262                 src += src_linesize;
263             }
264         }
265
266         return;
267     }
268
269     for (y = 0; y < height; y++) {
270         if (flags & NOISE_TEMPORAL)
271             shift = av_lfg_get(lfg) & (MAX_SHIFT - 1);
272         else
273             shift = n->rand_shift[y];
274
275         if (flags & NOISE_AVERAGED) {
276             line_noise_avg(dst, src, width, n->param[comp].prev_shift[y]);
277             n->param[comp].prev_shift[y][n->param[comp].shiftptr] = noise + shift;
278         } else {
279             line_noise(dst, src, noise, width, shift);
280         }
281         dst += dst_linesize;
282         src += src_linesize;
283     }
284
285     n->param[comp].shiftptr++;
286     if (n->param[comp].shiftptr == 3)
287         n->param[comp].shiftptr = 0;
288 }
289
290 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
291 {
292     NoiseContext *n = inlink->dst->priv;
293     AVFilterLink *outlink = inlink->dst->outputs[0];
294     AVFrame *out;
295     int ret, i;
296
297     if (av_frame_is_writable(inpicref)) {
298         out = inpicref;
299     } else {
300         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
301         if (!out) {
302             av_frame_free(&inpicref);
303             return AVERROR(ENOMEM);
304         }
305         av_frame_copy_props(out, inpicref);
306     }
307
308     for (i = 0; i < n->nb_planes; i++)
309         noise(out->data[i], inpicref->data[i], out->linesize[i],
310               inpicref->linesize[i], n->linesize[i], n->height[i], n, i);
311
312     ret = ff_filter_frame(outlink, out);
313     if (inpicref != out)
314         av_frame_free(&inpicref);
315     return ret;
316 }
317
318 static av_cold void uninit(AVFilterContext *ctx)
319 {
320     NoiseContext *n = ctx->priv;
321     int i;
322
323     for (i = 0; i < 4; i++)
324         av_freep(&n->param[i].noise);
325     av_opt_free(n);
326 }
327
328 static const AVFilterPad noise_inputs[] = {
329     {
330         .name             = "default",
331         .type             = AVMEDIA_TYPE_VIDEO,
332         .get_video_buffer = ff_null_get_video_buffer,
333         .filter_frame     = filter_frame,
334         .config_props     = config_input,
335     },
336     { NULL }
337 };
338
339 static const AVFilterPad noise_outputs[] = {
340     {
341         .name          = "default",
342         .type          = AVMEDIA_TYPE_VIDEO,
343     },
344     { NULL }
345 };
346
347 static const char *const shorthand[] = { NULL };
348
349 AVFilter avfilter_vf_noise = {
350     .name          = "noise",
351     .description   = NULL_IF_CONFIG_SMALL("Add noise."),
352     .priv_size     = sizeof(NoiseContext),
353     .init          = init,
354     .uninit        = uninit,
355     .query_formats = query_formats,
356     .inputs        = noise_inputs,
357     .outputs       = noise_outputs,
358     .priv_class    = &noise_class,
359     .shorthand     = shorthand,
360 };