Struct PeakLimiter 

pub struct PeakLimiter { /* private fields */ }

Linked-channel peak limiter with instantaneous attack and exponential release.

Implementations

impl PeakLimiter

pub fn new(threshold: f32, release_ms: f32) -> Self

Creates a limiter with a positive linear threshold and release time.

A non-finite or non-positive threshold becomes 1.0 and such a release becomes 50 ms.

Trait Implementations

impl Clone for PeakLimiter

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PeakLimiter

impl Debug for PeakLimiter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PeakLimiter

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Processor for PeakLimiter

fn prepare(&mut self, sample_rate: u32, _max_block: usize)

Configures non-real-time state before processing begins.

fn process( &mut self, _ctx: &ProcessCtx, inputs: &[&[f32]], outputs: &mut [&mut [f32]], )

Processes planar channel slices supplied by the host.

fn reset(&mut self)

Clears signal history without changing authored parameters.

fn history_samples(&self) -> u32

Additional source history for a cold seek, excluding algorithmic delay. Built-in recursive processors use a finite settling horizon; this is an approximation to uninterrupted playback, not a bit-exact state snapshot.

fn save_state(&self) -> StateBlob

Serializes history at an offline chunk boundary.

fn load_state(&mut self, state: &StateBlob) -> Result<(), StateError>

Restores history saved by a processor of the same type, prepared alike, whole or not at all.

fn inputs_per_output(&self) -> usize

How many input channels the processor reads for each output channel: 1 for an effect, 2 for one that also reads a second bus after the first (a sidechain, or the other side of a crossfade). A crate::ProcessorChain gives each node only its own channels, so it takes only processors that read one.

fn latency_samples(&self) -> u32

Algorithmic delay that the graph host must compensate.

impl StructuralPartialEq for PeakLimiter