Expand description
§av-denoise-core
The core library and kernels for the av-denoise system.
You should use either the av-denoise library, binary or VapourSynth plugin, not this crate directly.
Re-exports§
pub use cache::COMPILATION_CACHE_ENV;pub use cache::CacheAlreadyInitialisedError;pub use cache::install_compilation_cache;pub use device::Device;pub use frame::ChannelIntent;pub use frame::FrameLayout;pub use frame::PlanarDenoiser;pub use frame::PlaneOptions;pub use frame::Planes;pub use frame::Subsampling;pub use frame::push_needs_retry;
Modules§
- accelerate
- The hardware backends kernels can run on.
- cache
- Where CubeCL keeps its compiled kernels.
- device
- Which physical device to run on.
- enumerate
- frame
- sniff
- Picking a backend that actually works on this machine.
Structs§
- Denoiser
- A stateful denoiser that cleans a stream of frames.
- Denoiser
Options - How a
Denoisershould be set up. - HqParams
- Parameters for the quality-focused
nlmeans-hqvariant. - Motion
Search - The motion search’s tuning, for a denoiser that always tracks motion.
- Nl4d
Options - Settings for
Algorithm::Nl4d. - NlmTuning
- NLM tuning knobs.
- Nlmeans
HqOptions - Settings for
Algorithm::NlmeansHq. - Nlmeans
Options - Settings for
Algorithm::Nlmeans. - Unsupported
Depth Error - Returned when a source declares a bit depth the denoiser does not handle.
- Window
Span - How many source frames a windowed operation needs behind and ahead of its target frame, target frame itself not counted in either number.
Enums§
- Algorithm
- Which denoising algorithm to run.
- Channel
Mode - Which channels of a frame the denoiser works on.
- Denoiser
Error - Errors reported by the high-level
Denoiser. - Denoising
Mode - Whether a frame is cleaned on its own or alongside its neighbours.
- Depth
- Bit depth of a source’s samples.
- Motion
Compensation Mode - How motion compensation is set up for a denoise pass.
- Motion
Estimation - How motion toward a temporal neighbour is estimated.
- Nlmeans
Variant - Which nlmeans implementation a preset, or an explicit choice, selects.
- Prefilter
Mode - How the reference image for each frame is produced.
- Preset
- Speed vs quality dial.
Constants§
- DEFAULT_
PILOT_ STRENGTH_ SCALE - The measured default strength for the pilot pass, as a multiplier on the main pass strength.
- MAX_
PENDING - How many readbacks the high-level
Denoiserkeeps in flight at once.
Functions§
- denormalize
- Reverse of
normalize. - nl4d_
default_ lambda_ ht - The default
lambda_htfor nl4d’s hard-threshold stage, per plane. - nl4d_
spatial_ radius_ for - How wide the centre frame’s candidate search is at each preset, for
nl4d. - nl4d_
temporal_ radius_ for - How far the temporal window reaches at each preset, for
nl4d. - nlmeans_
search_ radius_ for - How far
nlmeanslooks for similar patches inside a frame, at a preset. - nlmeans_
temporal_ radius_ for - How many neighbouring frames on each side
nlmeanslooks at, at a preset. - nlmeans_
variant_ for - Which
NlmeansVarianta preset runs. - normalize
- Scales native-depth samples into normalised
[0, 1]f32. - parse_
prefilter - Parses a
--prefilter-style string into aPrefilterMode.