FFmpeg
vf_bitplanenoise.c
Go to the documentation of this file.
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/pixdesc.h"
23 #include "avfilter.h"
24 #include "internal.h"
25 #include "video.h"
26 
27 typedef struct BPNContext {
28  const AVClass *class;
29 
30  int bitplane;
31  int filter;
32 
33  int nb_planes;
34  int planeheight[4];
35  int planewidth[4];
36  int depth;
37 } BPNContext;
38 
39 #define OFFSET(x) offsetof(BPNContext, x)
40 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
41 static const AVOption bitplanenoise_options[] = {
42  { "bitplane", "set bit plane to use for measuring noise", OFFSET(bitplane), AV_OPT_TYPE_INT, {.i64=1}, 1, 16, FLAGS},
43  { "filter", "show noisy pixels", OFFSET(filter), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
44  { NULL }
45 };
46 
47 AVFILTER_DEFINE_CLASS(bitplanenoise);
48 
49 static const enum AVPixelFormat pixfmts[] = {
65 };
66 
68 {
70  AVFilterContext *ctx = inlink->dst;
71  BPNContext *s = ctx->priv;
72 
73  s->nb_planes = desc->nb_components;
74 
75  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
76  s->planeheight[0] = s->planeheight[3] = inlink->h;
77  s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
78  s->planewidth[0] = s->planewidth[3] = inlink->w;
79 
80  s->depth = desc->comp[0].depth;
81 
82  return 0;
83 }
84 
85 #define CHECK_BIT(x, a, b, c) { \
86  bit = (((val[(x)] & mask) == (val[(x) + (a)] & mask)) + \
87  ((val[(x)] & mask) == (val[(x) + (b)] & mask)) + \
88  ((val[(x)] & mask) == (val[(x) + (c)] & mask))) > 1; \
89  if (dst) \
90  dst[(x)] = factor * bit; \
91  stats[plane] += bit; }
92 
94 {
95  AVFilterContext *ctx = inlink->dst;
96  AVFilterLink *outlink = ctx->outputs[0];
97  BPNContext *s = ctx->priv;
98  const int mask = (1 << (s->bitplane - 1));
99  const int factor = (1 << s->depth) - 1;
100  float stats[4] = { 0 };
101  char metabuf[128];
102  int plane, y, x, bit;
103  AVFrame *out = s->filter ? NULL : in;
104 
105  if (!out) {
106  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
107  if (!out) {
108  av_frame_free(&in);
109  return AVERROR(ENOMEM);
110  }
112  }
113 
114  if (s->depth <= 8) {
115  for (plane = 0; plane < s->nb_planes; plane++) {
116  const int linesize = s->planeheight[plane] > 1 ? in->linesize[plane] : 0;
117  const int dlinesize = out->linesize[plane];
118  uint8_t *val = in->data[plane];
119  uint8_t *dst = s->filter ? out->data[plane]: NULL;
120 
121  for (y = 0; y < s->planeheight[plane] - 1; y++) {
122  CHECK_BIT(0, 1, 1 + linesize, linesize)
123 
124  for (x = 1; x < s->planewidth[plane] - 1; x++) {
125  CHECK_BIT(x, -1, 1, linesize)
126  }
127 
128  CHECK_BIT(x, -1, -1 + linesize, linesize)
129 
130  val += linesize;
131  if (dst)
132  dst += dlinesize;
133  }
134 
135  CHECK_BIT(0, 1, 1 - linesize, -linesize)
136 
137  for (x = 1; x < s->planewidth[plane] - 1; x++) {
138  CHECK_BIT(x, -1, 1, -linesize)
139  }
140 
141  CHECK_BIT(x, -1, -1 - linesize, -linesize)
142  }
143  } else {
144  for (plane = 0; plane < s->nb_planes; plane++) {
145  const int linesize = s->planeheight[plane] > 1 ? in->linesize[plane] / 2 : 0;
146  const int dlinesize = out->linesize[plane] / 2;
147  uint16_t *val = (uint16_t *)in->data[plane];
148  uint16_t *dst = s->filter ? (uint16_t *)out->data[plane] : NULL;
149 
150  val = (uint16_t *)in->data[plane];
151  for (y = 0; y < s->planeheight[plane] - 1; y++) {
152  CHECK_BIT(0, 1, 1 + linesize, linesize)
153 
154  for (x = 1; x < s->planewidth[plane] - 1; x++) {
155  CHECK_BIT(x, -1, 1, linesize)
156  }
157 
158  CHECK_BIT(x, -1, -1 + linesize, linesize)
159 
160  val += linesize;
161  if (dst)
162  dst += dlinesize;
163  }
164 
165  CHECK_BIT(0, 1, 1 - linesize, -linesize)
166 
167  for (x = 1; x < s->planewidth[plane] - 1; x++) {
168  CHECK_BIT(x, -1, 1, -linesize)
169  }
170 
171  CHECK_BIT(x, -1, -1 -linesize, -linesize)
172  }
173  }
174 
175  for (plane = 0; plane < s->nb_planes; plane++) {
176  char key[32];
177 
178  stats[plane] /= s->planewidth[plane] * s->planeheight[plane];
179  snprintf(key, sizeof(key), "lavfi.bitplanenoise.%d.%d", plane, s->bitplane);
180  snprintf(metabuf, sizeof(metabuf), "%f", 1. - 2.* fabs((stats[plane] - 0.5)));
181  av_dict_set(&out->metadata, key, metabuf, 0);
182  }
183 
184  if (out != in)
185  av_frame_free(&in);
186 
187  return ff_filter_frame(outlink, out);
188 }
189 
190 static const AVFilterPad inputs[] = {
191  {
192  .name = "default",
193  .type = AVMEDIA_TYPE_VIDEO,
194  .filter_frame = filter_frame,
195  .config_props = config_input,
196  },
197 };
198 
200  .name = "bitplanenoise",
201  .description = NULL_IF_CONFIG_SMALL("Measure bit plane noise."),
202  .priv_size = sizeof(BPNContext),
206  .priv_class = &bitplanenoise_class,
208 };
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:112
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
out
FILE * out
Definition: movenc.c:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1007
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2968
FILTER_PIXFMTS_ARRAY
#define FILTER_PIXFMTS_ARRAY(array)
Definition: internal.h:162
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
ff_vf_bitplanenoise
const AVFilter ff_vf_bitplanenoise
Definition: vf_bitplanenoise.c:199
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:100
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
pixdesc.h
AVOption
AVOption.
Definition: opt.h:294
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:482
AV_PIX_FMT_YUV440P
@ AV_PIX_FMT_YUV440P
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:106
filter
filter_frame For filters that do not use the this method is called when a frame is pushed to the filter s input It can be called at any time except in a reentrant way If the input frame is enough to produce then the filter should push the output frames on the output link immediately As an exception to the previous rule if the input frame is enough to produce several output frames then the filter needs output only at least one per link The additional frames can be left buffered in the filter
Definition: filter_design.txt:228
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
video.h
inputs
static const AVFilterPad inputs[]
Definition: vf_bitplanenoise.c:190
AV_PIX_FMT_GRAY9
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:462
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:361
bit
#define bit(string, value)
Definition: cbs_mpeg2.c:56
CHECK_BIT
#define CHECK_BIT(x, a, b, c)
Definition: vf_bitplanenoise.c:85
pixfmts
static enum AVPixelFormat pixfmts[]
Definition: vf_bitplanenoise.c:49
AV_PIX_FMT_GBRP14
#define AV_PIX_FMT_GBRP14
Definition: pixfmt.h:500
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(bitplanenoise)
AV_PIX_FMT_GBRP10
#define AV_PIX_FMT_GBRP10
Definition: pixfmt.h:498
AV_PIX_FMT_YUV422P9
#define AV_PIX_FMT_YUV422P9
Definition: pixfmt.h:480
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_bitplanenoise.c:93
val
static double val(void *priv, double ch)
Definition: aeval.c:78
AV_PIX_FMT_GRAY16
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:466
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_bitplanenoise.c:67
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:485
AV_PIX_FMT_YUVJ411P
@ AV_PIX_FMT_YUVJ411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor ...
Definition: pixfmt.h:283
AV_PIX_FMT_YUV422P16
#define AV_PIX_FMT_YUV422P16
Definition: pixfmt.h:494
ff_video_default_filterpad
const AVFilterPad ff_video_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_VIDEO.
Definition: video.c:37
mask
static const uint16_t mask[17]
Definition: lzw.c:38
AV_PIX_FMT_YUVJ422P
@ AV_PIX_FMT_YUVJ422P
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:86
s
#define s(width, name)
Definition: cbs_vp9.c:198
AV_PIX_FMT_YUV444P16
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:495
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58
AV_PIX_FMT_YUV420P9
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:479
AV_PIX_FMT_YUV420P16
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:493
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_GRAY14
#define AV_PIX_FMT_GRAY14
Definition: pixfmt.h:465
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:73
key
const char * key
Definition: hwcontext_opencl.c:179
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
AV_PIX_FMT_YUVJ444P
@ AV_PIX_FMT_YUVJ444P
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:87
AV_PIX_FMT_GRAY10
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:463
AV_PIX_FMT_GBRP16
#define AV_PIX_FMT_GBRP16
Definition: pixfmt.h:501
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
fabs
static __device__ float fabs(float a)
Definition: cuda_runtime.h:182
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:736
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:85
AV_PIX_FMT_YUV440P10
#define AV_PIX_FMT_YUV440P10
Definition: pixfmt.h:484
OFFSET
#define OFFSET(x)
Definition: vf_bitplanenoise.c:39
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:483
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:81
AV_PIX_FMT_GBRP9
#define AV_PIX_FMT_GBRP9
Definition: pixfmt.h:497
stats
static void stats(AVPacket *const *in, int n_in, unsigned *_max, unsigned *_sum)
Definition: vp9_superframe.c:34
BPNContext::nb_planes
int nb_planes
Definition: vf_bitplanenoise.c:33
BPNContext
Definition: vf_bitplanenoise.c:27
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:106
BPNContext::planewidth
int planewidth[4]
Definition: vf_bitplanenoise.c:35
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:487
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:489
internal.h
AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
#define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
Some filters support a generic "enable" expression option that can be used to enable or disable a fil...
Definition: avfilter.h:147
BPNContext::filter
int filter
Definition: vf_bitplanenoise.c:31
AV_PIX_FMT_GBRP12
#define AV_PIX_FMT_GBRP12
Definition: pixfmt.h:499
AV_PIX_FMT_YUVJ440P
@ AV_PIX_FMT_YUVJ440P
planar YUV 4:4:0 full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV440P and setting color_range
Definition: pixfmt.h:107
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
AV_PIX_FMT_YUV444P9
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:481
AVFilter
Filter definition.
Definition: avfilter.h:166
FLAGS
#define FLAGS
Definition: vf_bitplanenoise.c:40
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:486
AV_PIX_FMT_YUV422P14
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:491
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:72
BPNContext::depth
int depth
Definition: vf_bitplanenoise.c:36
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
bitplanenoise_options
static const AVOption bitplanenoise_options[]
Definition: vf_bitplanenoise.c:41
avfilter.h
BPNContext::planeheight
int planeheight[4]
Definition: vf_bitplanenoise.c:34
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:78
AVFilterContext
An instance of a filter.
Definition: avfilter.h:409
factor
static const int factor[16]
Definition: vf_pp7.c:78
AV_PIX_FMT_GBRP
@ AV_PIX_FMT_GBRP
planar GBR 4:4:4 24bpp
Definition: pixfmt.h:165
desc
const char * desc
Definition: libsvtav1.c:83
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:77
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
BPNContext::bitplane
int bitplane
Definition: vf_bitplanenoise.c:30
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:244
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
av_dict_set
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:88
AV_PIX_FMT_YUV411P
@ AV_PIX_FMT_YUV411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:80
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:385
AV_PIX_FMT_YUV440P12
#define AV_PIX_FMT_YUV440P12
Definition: pixfmt.h:488
AV_PIX_FMT_YUV444P14
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:492
AV_PIX_FMT_GRAY12
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:464
snprintf
#define snprintf
Definition: snprintf.h:34
AV_PIX_FMT_YUV420P14
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:490