FFmpeg
Data Structures | Macros | Functions | Variables
vf_nlmeans.c File Reference
#include "libavutil/avassert.h"
#include "libavutil/opt.h"
#include "libavutil/pixdesc.h"
#include "avfilter.h"
#include "formats.h"
#include "internal.h"
#include "vf_nlmeans.h"
#include "video.h"

Go to the source code of this file.

Data Structures

struct  weighted_avg
 
struct  NLMeansContext
 
struct  thread_data
 

Macros

#define OFFSET(x)   offsetof(NLMeansContext, x)
 
#define FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 
#define CHECK_ODD_FIELD(field, name)
 

Functions

 AVFILTER_DEFINE_CLASS (nlmeans)
 
static int query_formats (AVFilterContext *ctx)
 
static void compute_safe_ssd_integral_image_c (uint32_t *dst, ptrdiff_t dst_linesize_32, const uint8_t *s1, ptrdiff_t linesize1, const uint8_t *s2, ptrdiff_t linesize2, int w, int h)
 Compute squared difference of the safe area (the zone where s1 and s2 overlap). More...
 
static void compute_unsafe_ssd_integral_image (uint32_t *dst, ptrdiff_t dst_linesize_32, int startx, int starty, const uint8_t *src, ptrdiff_t linesize, int offx, int offy, int r, int sw, int sh, int w, int h)
 Compute squared difference of an unsafe area (the zone nor s1 nor s2 could be readable). More...
 
static void compute_ssd_integral_image (const NLMeansDSPContext *dsp, uint32_t *ii, ptrdiff_t ii_linesize_32, const uint8_t *src, ptrdiff_t linesize, int offx, int offy, int e, int w, int h)
 
static int config_input (AVFilterLink *inlink)
 
static int nlmeans_slice (AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 
static void weight_averages (uint8_t *dst, ptrdiff_t dst_linesize, const uint8_t *src, ptrdiff_t src_linesize, struct weighted_avg *wa, ptrdiff_t wa_linesize, int w, int h)
 
static int nlmeans_plane (AVFilterContext *ctx, int w, int h, int p, int r, uint8_t *dst, ptrdiff_t dst_linesize, const uint8_t *src, ptrdiff_t src_linesize)
 
static int filter_frame (AVFilterLink *inlink, AVFrame *in)
 
void ff_nlmeans_init (NLMeansDSPContext *dsp)
 
static av_cold int init (AVFilterContext *ctx)
 
static av_cold void uninit (AVFilterContext *ctx)
 

Variables

static const AVOption nlmeans_options []
 
static const AVFilterPad nlmeans_inputs []
 
static const AVFilterPad nlmeans_outputs []
 
AVFilter ff_vf_nlmeans
 

Macro Definition Documentation

◆ OFFSET

#define OFFSET (   x)    offsetof(NLMeansContext, x)

Definition at line 67 of file vf_nlmeans.c.

◆ FLAGS

Definition at line 68 of file vf_nlmeans.c.

◆ CHECK_ODD_FIELD

#define CHECK_ODD_FIELD (   field,
  name 
)
Value:
do { \
if (!(s->field & 1)) { \
s->field |= 1; \
av_log(ctx, AV_LOG_WARNING, name " size must be odd, " \
"setting it to %d\n", s->field); \
} \
} while (0)

Definition at line 501 of file vf_nlmeans.c.

Function Documentation

◆ AVFILTER_DEFINE_CLASS()

AVFILTER_DEFINE_CLASS ( nlmeans  )

◆ query_formats()

static int query_formats ( AVFilterContext ctx)
static

Definition at line 80 of file vf_nlmeans.c.

◆ compute_safe_ssd_integral_image_c()

static void compute_safe_ssd_integral_image_c ( uint32_t *  dst,
ptrdiff_t  dst_linesize_32,
const uint8_t s1,
ptrdiff_t  linesize1,
const uint8_t s2,
ptrdiff_t  linesize2,
int  w,
int  h 
)
static

Compute squared difference of the safe area (the zone where s1 and s2 overlap).

It is likely the largest integral zone, so it is interesting to do as little checks as possible; contrary to the unsafe version of this function, we do not need any clipping here.

The line above dst and the column to its left are always readable.

Definition at line 107 of file vf_nlmeans.c.

Referenced by ff_nlmeans_init().

◆ compute_unsafe_ssd_integral_image()

static void compute_unsafe_ssd_integral_image ( uint32_t *  dst,
ptrdiff_t  dst_linesize_32,
int  startx,
int  starty,
const uint8_t src,
ptrdiff_t  linesize,
int  offx,
int  offy,
int  r,
int  sw,
int  sh,
int  w,
int  h 
)
inlinestatic

Compute squared difference of an unsafe area (the zone nor s1 nor s2 could be readable).

On the other hand, the line above dst and the column to its left are always readable.

There is little point in having this function SIMDified as it is likely too complex and only handle small portions of the image.

Parameters
dstintegral image
dst_linesize_32integral image linesize (in 32-bit integers unit)
startxintegral starting x position
startyintegral starting y position
srcsource plane buffer
linesizesource plane linesize
offxsource offsetting in x
offysource offsetting in y @paran r absolute maximum source offsetting
swsource width
shsource height
wwidth to compute
hheight to compute

Definition at line 166 of file vf_nlmeans.c.

Referenced by compute_ssd_integral_image(), and main().

◆ compute_ssd_integral_image()

static void compute_ssd_integral_image ( const NLMeansDSPContext dsp,
uint32_t *  ii,
ptrdiff_t  ii_linesize_32,
const uint8_t src,
ptrdiff_t  linesize,
int  offx,
int  offy,
int  e,
int  w,
int  h 
)
static

Definition at line 208 of file vf_nlmeans.c.

Referenced by main(), and nlmeans_plane().

◆ config_input()

static int config_input ( AVFilterLink inlink)
static

Definition at line 280 of file vf_nlmeans.c.

◆ nlmeans_slice()

static int nlmeans_slice ( AVFilterContext ctx,
void *  arg,
int  jobnr,
int  nb_jobs 
)
static

Definition at line 343 of file vf_nlmeans.c.

Referenced by nlmeans_plane().

◆ weight_averages()

static void weight_averages ( uint8_t dst,
ptrdiff_t  dst_linesize,
const uint8_t src,
ptrdiff_t  src_linesize,
struct weighted_avg wa,
ptrdiff_t  wa_linesize,
int  w,
int  h 
)
static

Definition at line 410 of file vf_nlmeans.c.

Referenced by nlmeans_plane().

◆ nlmeans_plane()

static int nlmeans_plane ( AVFilterContext ctx,
int  w,
int  h,
int  p,
int  r,
uint8_t dst,
ptrdiff_t  dst_linesize,
const uint8_t src,
ptrdiff_t  src_linesize 
)
static

Definition at line 430 of file vf_nlmeans.c.

Referenced by filter_frame().

◆ filter_frame()

static int filter_frame ( AVFilterLink inlink,
AVFrame in 
)
static

Definition at line 473 of file vf_nlmeans.c.

◆ ff_nlmeans_init()

void ff_nlmeans_init ( NLMeansDSPContext dsp)

Definition at line 509 of file vf_nlmeans.c.

Referenced by checkasm_check_nlmeans(), init(), and main().

◆ init()

static av_cold int init ( AVFilterContext ctx)
static

Definition at line 517 of file vf_nlmeans.c.

◆ uninit()

static av_cold void uninit ( AVFilterContext ctx)
static

Definition at line 554 of file vf_nlmeans.c.

Variable Documentation

◆ nlmeans_options

const AVOption nlmeans_options[]
static
Initial value:
= {
{ "s", "denoising strength", OFFSET(sigma), AV_OPT_TYPE_DOUBLE, { .dbl = 1.0 }, 1.0, 30.0, FLAGS },
{ "p", "patch size", OFFSET(patch_size), AV_OPT_TYPE_INT, { .i64 = 3*2+1 }, 0, 99, FLAGS },
{ "pc", "patch size for chroma planes", OFFSET(patch_size_uv), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 99, FLAGS },
{ "r", "research window", OFFSET(research_size), AV_OPT_TYPE_INT, { .i64 = 7*2+1 }, 0, 99, FLAGS },
{ "rc", "research window for chroma planes", OFFSET(research_size_uv), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 99, FLAGS },
{ NULL }
}

Definition at line 69 of file vf_nlmeans.c.

◆ nlmeans_inputs

const AVFilterPad nlmeans_inputs[]
static
Initial value:
= {
{
.name = "default",
.config_props = config_input,
.filter_frame = filter_frame,
},
{ NULL }
}

Definition at line 562 of file vf_nlmeans.c.

◆ nlmeans_outputs

const AVFilterPad nlmeans_outputs[]
static
Initial value:
= {
{
.name = "default",
},
{ NULL }
}

Definition at line 572 of file vf_nlmeans.c.

◆ ff_vf_nlmeans

AVFilter ff_vf_nlmeans
Initial value:
= {
.name = "nlmeans",
.description = NULL_IF_CONFIG_SMALL("Non-local means denoiser."),
.priv_size = sizeof(NLMeansContext),
.init = init,
.priv_class = &nlmeans_class,
}

Definition at line 580 of file vf_nlmeans.c.

AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
name
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option name
Definition: writing_filters.txt:88
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_nlmeans.c:80
nlmeans_outputs
static const AVFilterPad nlmeans_outputs[]
Definition: vf_nlmeans.c:572
nlmeans_inputs
static const AVFilterPad nlmeans_inputs[]
Definition: vf_nlmeans.c:562
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:225
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
ctx
AVFormatContext * ctx
Definition: movenc.c:48
NULL
#define NULL
Definition: coverity.c:32
NLMeansContext
Definition: vf_nlmeans.c:46
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:243
FLAGS
#define FLAGS
Definition: vf_nlmeans.c:68
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_nlmeans.c:554
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:188
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_nlmeans.c:280
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:125
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_nlmeans.c:517
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:223
AVFILTER_FLAG_SLICE_THREADS
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:116
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_nlmeans.c:473
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:565
OFFSET
#define OFFSET(x)
Definition: vf_nlmeans.c:67