avfilter: add bitplanenoise filter
[ffmpeg.git] / libavfilter / vf_bitplanenoise.c
1 /*
2  * Copyright (c) 2016 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include "libavutil/opt.h"
22 #include "libavutil/imgutils.h"
23 #include "avfilter.h"
24 #include "formats.h"
25 #include "internal.h"
26 #include "video.h"
27
28 typedef struct BPNContext {
29     const AVClass *class;
30
31     int bitplane;
32     int filter;
33
34     int nb_planes;
35     int planeheight[4];
36     int planewidth[4];
37     int depth;
38 } BPNContext;
39
40 #define OFFSET(x) offsetof(BPNContext, x)
41 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
42 static const AVOption bitplanenoise_options[] = {
43     { "bitplane", "set bit plane to use for measuring noise",  OFFSET(bitplane), AV_OPT_TYPE_INT,  {.i64=1}, 1, 16, FLAGS},
44     { "filter",   "show noisy pixels",                         OFFSET(filter),   AV_OPT_TYPE_BOOL, {.i64=0}, 0,  1, FLAGS},
45     { NULL }
46 };
47
48 AVFILTER_DEFINE_CLASS(bitplanenoise);
49
50 static int query_formats(AVFilterContext *ctx)
51 {
52     static const enum AVPixelFormat pixfmts[] = {
53         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV411P,
54         AV_PIX_FMT_YUV440P,
55         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ411P,
56         AV_PIX_FMT_YUVJ440P,
57         AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV420P9,
58         AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV420P10,
59         AV_PIX_FMT_YUV440P10,
60         AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
61         AV_PIX_FMT_YUV440P12,
62         AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
63         AV_PIX_FMT_YUV444P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV420P16,
64         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
65         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
66         AV_PIX_FMT_GRAY8,
67         AV_PIX_FMT_GRAY16,
68         AV_PIX_FMT_NONE
69     };
70
71     AVFilterFormats *formats = ff_make_format_list(pixfmts);
72     if (!formats)
73         return AVERROR(ENOMEM);
74     return ff_set_common_formats(ctx, formats);
75 }
76
77 static int config_input(AVFilterLink *inlink)
78 {
79     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
80     AVFilterContext *ctx = inlink->dst;
81     BPNContext *s = ctx->priv;
82
83     s->nb_planes = desc->nb_components;
84
85     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
86     s->planeheight[0] = s->planeheight[3] = inlink->h;
87     s->planewidth[1]  = s->planewidth[2]  = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
88     s->planewidth[0]  = s->planewidth[3]  = inlink->w;
89
90     s->depth = desc->comp[0].depth;
91
92     return 0;
93 }
94
95 #define CHECK_BIT(x, a, b, c) { \
96     bit = (((val[(x)] & mask) == (val[(x) + (a)] & mask)) + \
97            ((val[(x)] & mask) == (val[(x) + (b)] & mask)) + \
98            ((val[(x)] & mask) == (val[(x) + (c)] & mask))) > 1; \
99     if (dst) \
100         dst[(x)] = factor * bit; \
101     stats[plane] += bit; }
102
103 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
104 {
105     AVFilterContext *ctx = inlink->dst;
106     AVFilterLink *outlink = ctx->outputs[0];
107     BPNContext *s = ctx->priv;
108     const int mask = (1 << (s->bitplane - 1));
109     const int factor = (1 << s->depth) - 1;
110     float stats[4] = { 0 };
111     char metabuf[128];
112     int plane, y, x, bit;
113     AVFrame *out = s->filter ? NULL : in;
114
115     if (!out) {
116         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
117         if (!out) {
118             av_frame_free(&in);
119             return AVERROR(ENOMEM);
120         }
121         av_frame_copy_props(out, in);
122     }
123
124     if (s->depth <= 8) {
125         for (plane = 0; plane < s->nb_planes; plane++) {
126             const int linesize = in->linesize[plane];
127             const int dlinesize = out->linesize[plane];
128             uint8_t *val = in->data[plane];
129             uint8_t *dst = s->filter ? out->data[plane]: NULL;
130
131             for (y = 0; y < s->planeheight[plane] - 1; y++) {
132                 CHECK_BIT(0, 1, 1 + linesize, linesize)
133
134                 for (x = 1; x < s->planewidth[plane] - 1; x++) {
135                     CHECK_BIT(x, -1, 1, linesize)
136                 }
137
138                 CHECK_BIT(x, -1, -1 + linesize, linesize)
139
140                 val += linesize;
141                 if (dst)
142                     dst += dlinesize;
143             }
144
145             CHECK_BIT(0, 1, 1 - linesize, -linesize)
146
147             for (x = 1; x < s->planewidth[plane] - 1; x++) {
148                 CHECK_BIT(x, -1, 1, -linesize)
149             }
150
151             CHECK_BIT(x, -1, -1 - linesize, -linesize)
152         }
153     } else {
154         for (plane = 0; plane < s->nb_planes; plane++) {
155             const int linesize = in->linesize[plane] / 2;
156             const int dlinesize = out->linesize[plane] / 2;
157             uint16_t *val = (uint16_t *)in->data[plane];
158             uint16_t *dst = s->filter ? (uint16_t *)out->data[plane] : NULL;
159
160             val = (uint16_t *)in->data[plane];
161             for (y = 0; y < s->planeheight[plane] - 1; y++) {
162                 CHECK_BIT(0, 1, 1 + linesize, linesize)
163
164                 for (x = 1; x < s->planewidth[plane] - 1; x++) {
165                     CHECK_BIT(x, -1, 1, linesize)
166                 }
167
168                 CHECK_BIT(x, -1, -1 + linesize, linesize)
169
170                 val += linesize;
171                 if (dst)
172                     dst += dlinesize;
173             }
174
175             CHECK_BIT(0, 1, 1 - linesize, -linesize)
176
177             for (x = 1; x < s->planewidth[plane] - 1; x++) {
178                 CHECK_BIT(x, -1, 1, -linesize)
179             }
180
181             CHECK_BIT(x, -1, -1 -linesize, -linesize)
182         }
183     }
184
185     for (plane = 0; plane < s->nb_planes; plane++) {
186         char key[32];
187
188         stats[plane] /= s->planewidth[plane] * s->planeheight[plane];
189         snprintf(key, sizeof(key), "lavfi.bitplanenoise.%d.%d", plane, s->bitplane);
190         snprintf(metabuf, sizeof(metabuf), "%f", 1. - 2.* fabsf((stats[plane] - 0.5)));
191         av_dict_set(&out->metadata, key, metabuf, 0);
192     }
193
194     if (out != in)
195         av_frame_free(&in);
196
197     return ff_filter_frame(outlink, out);
198 }
199
200 static const AVFilterPad inputs[] = {
201     {
202         .name           = "default",
203         .type           = AVMEDIA_TYPE_VIDEO,
204         .filter_frame   = filter_frame,
205         .config_props   = config_input,
206     },
207     { NULL }
208 };
209
210 static const AVFilterPad outputs[] = {
211     {
212         .name = "default",
213         .type = AVMEDIA_TYPE_VIDEO,
214     },
215     { NULL }
216 };
217
218 AVFilter ff_vf_bitplanenoise = {
219     .name           = "bitplanenoise",
220     .description    = NULL_IF_CONFIG_SMALL("Measure bit plane noise."),
221     .priv_size      = sizeof(BPNContext),
222     .query_formats  = query_formats,
223     .inputs         = inputs,
224     .outputs        = outputs,
225     .priv_class     = &bitplanenoise_class,
226     .flags          = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
227 };