Struct Saturation 

pub struct Saturation { /* private fields */ }

Tube Saturation processor with configurable drive and mix

When highpass_mode is enabled, only high frequencies (>4kHz) are saturated, creating a more transparent “exciter” effect without muddying the low end.

Configuration is done through the set_* methods; current values can be read back with Saturation::get_settings. For shared mutable access from another thread, wrap this in Arc<Mutex<Saturation>>.

Implementations

impl Saturation

pub fn new() -> Self

Create a new saturation processor with default settings

pub fn with_type(sat_type: SaturationType) -> Self

Create with specific saturation type

pub fn set_drive(&mut self, drive: f64)

Set drive amount (0.0 - 2.0)

pub fn set_threshold(&mut self, threshold: f64)

Set threshold (0.0 - 1.0)

pub fn set_mix(&mut self, mix: f64)

Set mix amount (0.0 - 1.0)

pub fn set_input_gain(&mut self, gain_db: f64)

Set input gain (dB) - applied before saturation

pub fn set_output_gain(&mut self, gain_db: f64)

Set output gain (dB) - applied only to saturated samples for compensation

pub fn set_enabled(&mut self, enabled: bool)

Enable/disable saturation

pub fn set_type(&mut self, sat_type: SaturationType)

Set saturation type

pub fn set_highpass_mode(&mut self, enabled: bool)

Enable/disable high-pass mode (exciter mode)

pub fn set_highpass_cutoff(&mut self, hz: f64)

Set high-pass cutoff frequency in Hz

pub fn set_sample_rate(&mut self, sr: f64)

Update sample rate and recalculate HPF coefficient

pub fn set_channel_count(&mut self, channels: usize)

Pre-size the per-channel HPF state for channels, off the audio thread.

Call this during setup (when the processor is built for a stream) so process_highpass never resizes hpf_states/prev_inputs on the realtime audio thread. Defaults keep the stereo size when channels == 0.

pub fn process(&mut self, samples: &mut [f64])

Process interleaved f64 samples in-place

pub fn process_with_channels(&mut self, samples: &mut [f64], channels: usize)

Process interleaved f64 samples with specified channel count

pub fn process_with_sr( &mut self, samples: &mut [f64], channels: usize, sample_rate: f64, )

Process with explicit sample rate (for cases where SR differs from cached value)

pub fn reset(&mut self)

Reset filter state

pub fn get_settings(&self) -> SaturationSettings

Get current settings as a struct

Trait Implementations

impl Default for Saturation

fn default() -> Self

Returns the “default value” for a type.