bm3dvk2

Block-Matching and 3D filtering, using Vulkan compute.

Ported from VapourSynth-BM3D. BM3D (spatial) and V-BM3D (temporal), basic and final estimates are consolidated into a single function. Temporal results are aggregated internally, so no separate aggregation call is needed.

Parameters

bm3dvk2.BM3D(vnode clip[, vnode ref=None, str profile="fast", float[] sigma=[10, 10, 10], int radius, int block_size, int block_step, int group_size, int bm_range, int bm_step, int ps_num, int ps_range, int ps_step, float th_mse, float hard_thr, int matrix=2])

• clip: Clip to process. Gray or RGB of 16/32 bit float is supported. RGB is converted to the opponent color space internally and converted back for output. 16 bit float input is processed with half precision arithmetic where the device supports it.

• ref: Reference clip, of the same format, dimensions and length as clip. When omitted, the basic estimate (collaborative hard-thresholding) is produced. When specified, the final estimate (collaborative Wiener filtering) is produced, with ref (usually a basic estimate) guiding block-matching and the Wiener filter.

• profile: Preset of the defaults below: "fast", "lc" (low complexity), "np" (normal), "high" or "vn" (very noisy).

• sigma: Strength of denoising per plane, in 8 bit scale, valid range [0, +inf). Unassigned planes take the value of the previous one. For Gray input, 0 returns the input unprocessed.

• radius: Temporal radius, valid range [0, 16]. 0 denoises spatially (BM3D), greater values denoise temporally over radius * 2 + 1 frames (V-BM3D). Defaults to the radius of the profile, and the defaults of the other parameters follow the selected mode.

• block_size: Size of a block, valid range [1, 64].

• block_step: Step between reference blocks, valid range [1, block_size].

• group_size: Maximum number of blocks in a group, valid range [1, 256].

• bm_range: Radius of the block-matching search window, valid range [1, +inf).

• bm_step: Step between block-matching search positions, valid range [1, bm_range].

• ps_num: Number of the best matches of a frame that center the predictive search in the next frame, valid range [1, group_size]. Temporal only.

• ps_range: Radius of the predictive search window, valid range [1, +inf). Temporal only.

• ps_step: Step between predictive search positions, valid range [1, ps_range]. Temporal only.

• th_mse: Threshold of mean square error for block-matching, valid range [0, +inf). Defaults depend on the profile and sigma[0].

• hard_thr: Threshold of hard-thresholding, valid range (0, +inf). Basic estimate only.

• matrix: Matrix coefficients of Gray input, used to normalize sigma and th_mse: 0 (GBR), 1 (BT.709), 2 (unspecified, chosen by resolution), 4 (FCC), 5 (BT.470BG), 6 (SMPTE 170M), 7 (SMPTE 240M), 9 (BT.2020 NCL), 10 (BT.2020 CL) or 100 (opponent color space). RGB input always uses the opponent color space.

Profile defaults

Values are basic / final.

bm_step and ps_step default to 1. th_mse defaults to sigma[0] * 80 + 400 / sigma[0] * 10 + 200, or sigma[0] * 150 + 1000 / sigma[0] * 40 + 400 for "vn".

Installation

pip install -U vapoursynth-bm3dvk2