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/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 
51 {
52  static const enum AVPixelFormat pixfmts[] = {
68  };
69 
71  if (!formats)
72  return AVERROR(ENOMEM);
74 }
75 
77 {
79  AVFilterContext *ctx = inlink->dst;
80  BPNContext *s = ctx->priv;
81 
82  s->nb_planes = desc->nb_components;
83 
84  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
85  s->planeheight[0] = s->planeheight[3] = inlink->h;
86  s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
87  s->planewidth[0] = s->planewidth[3] = inlink->w;
88 
89  s->depth = desc->comp[0].depth;
90 
91  return 0;
92 }
93 
94 #define CHECK_BIT(x, a, b, c) { \
95  bit = (((val[(x)] & mask) == (val[(x) + (a)] & mask)) + \
96  ((val[(x)] & mask) == (val[(x) + (b)] & mask)) + \
97  ((val[(x)] & mask) == (val[(x) + (c)] & mask))) > 1; \
98  if (dst) \
99  dst[(x)] = factor * bit; \
100  stats[plane] += bit; }
101 
103 {
104  AVFilterContext *ctx = inlink->dst;
105  AVFilterLink *outlink = ctx->outputs[0];
106  BPNContext *s = ctx->priv;
107  const int mask = (1 << (s->bitplane - 1));
108  const int factor = (1 << s->depth) - 1;
109  float stats[4] = { 0 };
110  char metabuf[128];
111  int plane, y, x, bit;
112  AVFrame *out = s->filter ? NULL : in;
113 
114  if (!out) {
115  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
116  if (!out) {
117  av_frame_free(&in);
118  return AVERROR(ENOMEM);
119  }
121  }
122 
123  if (s->depth <= 8) {
124  for (plane = 0; plane < s->nb_planes; plane++) {
125  const int linesize = s->planeheight[plane] > 1 ? in->linesize[plane] : 0;
126  const int dlinesize = out->linesize[plane];
127  uint8_t *val = in->data[plane];
128  uint8_t *dst = s->filter ? out->data[plane]: NULL;
129 
130  for (y = 0; y < s->planeheight[plane] - 1; y++) {
131  CHECK_BIT(0, 1, 1 + linesize, linesize)
132 
133  for (x = 1; x < s->planewidth[plane] - 1; x++) {
134  CHECK_BIT(x, -1, 1, linesize)
135  }
136 
137  CHECK_BIT(x, -1, -1 + linesize, linesize)
138 
139  val += linesize;
140  if (dst)
141  dst += dlinesize;
142  }
143 
144  CHECK_BIT(0, 1, 1 - linesize, -linesize)
145 
146  for (x = 1; x < s->planewidth[plane] - 1; x++) {
147  CHECK_BIT(x, -1, 1, -linesize)
148  }
149 
150  CHECK_BIT(x, -1, -1 - linesize, -linesize)
151  }
152  } else {
153  for (plane = 0; plane < s->nb_planes; plane++) {
154  const int linesize = s->planeheight[plane] > 1 ? in->linesize[plane] / 2 : 0;
155  const int dlinesize = out->linesize[plane] / 2;
156  uint16_t *val = (uint16_t *)in->data[plane];
157  uint16_t *dst = s->filter ? (uint16_t *)out->data[plane] : NULL;
158 
159  val = (uint16_t *)in->data[plane];
160  for (y = 0; y < s->planeheight[plane] - 1; y++) {
161  CHECK_BIT(0, 1, 1 + linesize, linesize)
162 
163  for (x = 1; x < s->planewidth[plane] - 1; x++) {
164  CHECK_BIT(x, -1, 1, linesize)
165  }
166 
167  CHECK_BIT(x, -1, -1 + linesize, linesize)
168 
169  val += linesize;
170  if (dst)
171  dst += dlinesize;
172  }
173 
174  CHECK_BIT(0, 1, 1 - linesize, -linesize)
175 
176  for (x = 1; x < s->planewidth[plane] - 1; x++) {
177  CHECK_BIT(x, -1, 1, -linesize)
178  }
179 
180  CHECK_BIT(x, -1, -1 -linesize, -linesize)
181  }
182  }
183 
184  for (plane = 0; plane < s->nb_planes; plane++) {
185  char key[32];
186 
187  stats[plane] /= s->planewidth[plane] * s->planeheight[plane];
188  snprintf(key, sizeof(key), "lavfi.bitplanenoise.%d.%d", plane, s->bitplane);
189  snprintf(metabuf, sizeof(metabuf), "%f", 1. - 2.* fabs((stats[plane] - 0.5)));
190  av_dict_set(&out->metadata, key, metabuf, 0);
191  }
192 
193  if (out != in)
194  av_frame_free(&in);
195 
196  return ff_filter_frame(outlink, out);
197 }
198 
199 static const AVFilterPad inputs[] = {
200  {
201  .name = "default",
202  .type = AVMEDIA_TYPE_VIDEO,
203  .filter_frame = filter_frame,
204  .config_props = config_input,
205  },
206  { NULL }
207 };
208 
209 static const AVFilterPad outputs[] = {
210  {
211  .name = "default",
212  .type = AVMEDIA_TYPE_VIDEO,
213  },
214  { NULL }
215 };
216 
218  .name = "bitplanenoise",
219  .description = NULL_IF_CONFIG_SMALL("Measure bit plane noise."),
220  .priv_size = sizeof(BPNContext),
222  .inputs = inputs,
223  .outputs = outputs,
224  .priv_class = &bitplanenoise_class,
226 };
formats
formats
Definition: signature.h:48
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:97
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_bitplanenoise.c:50
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
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
ff_make_format_list
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:286
out
FILE * out
Definition: movenc.c:54
stats
static void stats(AVPacket *const *in, int n_in, unsigned *_max, unsigned *_sum)
Definition: vp9_superframe_bsf.c:34
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:978
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2540
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:217
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVOption
AVOption.
Definition: opt.h:247
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:389
AV_PIX_FMT_YUV440P
@ AV_PIX_FMT_YUV440P
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:99
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:149
video.h
inputs
static const AVFilterPad inputs[]
Definition: vf_bitplanenoise.c:199
AV_PIX_FMT_GRAY9
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:369
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
formats.h
bit
#define bit(string, value)
Definition: cbs_mpeg2.c:58
CHECK_BIT
#define CHECK_BIT(x, a, b, c)
Definition: vf_bitplanenoise.c:94
AV_PIX_FMT_GBRP14
#define AV_PIX_FMT_GBRP14
Definition: pixfmt.h:407
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(bitplanenoise)
AV_PIX_FMT_GBRP10
#define AV_PIX_FMT_GBRP10
Definition: pixfmt.h:405
AV_PIX_FMT_YUV422P9
#define AV_PIX_FMT_YUV422P9
Definition: pixfmt.h:387
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_bitplanenoise.c:102
val
static double val(void *priv, double ch)
Definition: aeval.c:75
AV_PIX_FMT_GRAY16
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:373
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_bitplanenoise.c:76
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:392
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:248
AV_PIX_FMT_YUV422P16
#define AV_PIX_FMT_YUV422P16
Definition: pixfmt.h:401
ff_set_common_formats
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:580
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:79
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_PIX_FMT_YUV444P16
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:402
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
AV_PIX_FMT_YUV420P9
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:386
AV_PIX_FMT_YUV420P16
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:400
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_GRAY14
#define AV_PIX_FMT_GRAY14
Definition: pixfmt.h:372
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:66
key
const char * key
Definition: hwcontext_opencl.c:168
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:80
AV_PIX_FMT_GRAY10
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:370
AV_PIX_FMT_GBRP16
#define AV_PIX_FMT_GBRP16
Definition: pixfmt.h:408
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:537
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:78
AV_PIX_FMT_YUV440P10
#define AV_PIX_FMT_YUV440P10
Definition: pixfmt.h:391
OFFSET
#define OFFSET(x)
Definition: vf_bitplanenoise.c:40
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:390
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
AV_PIX_FMT_GBRP9
#define AV_PIX_FMT_GBRP9
Definition: pixfmt.h:404
BPNContext::nb_planes
int nb_planes
Definition: vf_bitplanenoise.c:34
for
for(j=16;j >0;--j)
Definition: h264pred_template.c:469
BPNContext
Definition: vf_bitplanenoise.c:28
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:116
BPNContext::planewidth
int planewidth[4]
Definition: vf_bitplanenoise.c:36
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:394
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:396
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:126
BPNContext::filter
int filter
Definition: vf_bitplanenoise.c:32
outputs
static const AVFilterPad outputs[]
Definition: vf_bitplanenoise.c:209
AV_PIX_FMT_GBRP12
#define AV_PIX_FMT_GBRP12
Definition: pixfmt.h:406
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:100
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
AV_PIX_FMT_YUV444P9
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:388
AVFilter
Filter definition.
Definition: avfilter.h:145
FLAGS
#define FLAGS
Definition: vf_bitplanenoise.c:41
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:393
AV_PIX_FMT_YUV422P14
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:398
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
BPNContext::depth
int depth
Definition: vf_bitplanenoise.c:37
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
bitplanenoise_options
static const AVOption bitplanenoise_options[]
Definition: vf_bitplanenoise.c:42
avfilter.h
BPNContext::planeheight
int planeheight[4]
Definition: vf_bitplanenoise.c:35
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:71
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
factor
static const int factor[16]
Definition: vf_pp7.c:76
AV_PIX_FMT_GBRP
@ AV_PIX_FMT_GBRP
planar GBR 4:4:4 24bpp
Definition: pixfmt.h:158
desc
const char * desc
Definition: libsvtav1.c:79
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:70
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:31
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:241
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:70
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:73
imgutils.h
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
AV_PIX_FMT_YUV440P12
#define AV_PIX_FMT_YUV440P12
Definition: pixfmt.h:395
AV_PIX_FMT_YUV444P14
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:399
AV_PIX_FMT_GRAY12
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:371
snprintf
#define snprintf
Definition: snprintf.h:34
AV_PIX_FMT_YUV420P14
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:397