Struct SCDistortion 

pub struct SCDistortion { /* private fields */ }

Implementations

impl SCDistortion

pub fn new( id: u32, name: String, is_active: bool, threshold: f32, level: f32, smoothing: f32, color: String, ) -> Self

pub fn threshold(&self) -> f32

Returns the current clipping threshold in range [0.0, 1.0].

Returns

The threshold value; lower values produce heavier clipping.

pub fn set_threshold(&self, threshold: f32)

Sets the clipping threshold. Value is clamped to [0.001, 1.0].

The change takes effect on the very next audio sample — no synchronisation needed.

Parameters

• threshold — New clipping level in (0.0, 1.0]

pub fn level(&self) -> f32

Returns the normalised output level in range [0.0, 1.0].

Internally the gain is stored as [1.0, 2.0]; this method reverses that mapping to give the external normalised value.

Returns

Normalised level: 0.0 = no boost (unity gain), 1.0 = ×2.0 boost

pub fn set_level(&self, level: f32)

Sets the output level from a normalised value [0.0, 1.0].

Internally maps to gain [1.0, 2.0] and stores it in the atomic. The change takes effect on the very next audio sample — no synchronisation needed.

Parameters

• level — Normalised level in [0.0, 1.0]. Will be clamped.

pub fn smoothing(&self) -> f32

pub fn set_smoothing(&self, smoothing: f32)

Trait Implementations

impl AudioProcessor for SCDistortion

fn process(&mut self, sample: f32) -> f32

Processes a single audio sample through soft clipping and level boost.

Algorithm

1. Load clipping threshold & the smoothing factor atomically (lock-free)
2. Normalize the sample to the clipping threshold. Needs to be done because smoothing algorithm smooths towards 1.0 and -1.0
3. Smooth the curve towards the limit
4. Denormalize the sample to get back to the desired amplitude
5. Apply gain boost via the GainProcessor with smoothed transitions

Parameters

• sample — audio sample, typically -1.0 to 1.0

Returns

Processed sample: clipped, smoothed and boosted by the level knob

impl Effect for SCDistortion

fn to_dto(&self) -> EffectDto

Converts this effect into its serialisable DTO representation.

Called when sending effect state to the frontend or external clients.

Returns

EffectDto::SCDistortion with all current parameters

fn f32_params(&self) -> HashMap<&'static str, Arc<AtomicF32>>

Returns a map of named f32 parameters for command infrastructure.

This enables the generic command dispatcher to update effect parameters without needing to know about specific effect types.

Returns

HashMap with keys:

• "threshold" — points to limit atomic; external code can write new thresholds
• "level" — points to internal gain atomic [1.0, 2.0]

Note

The "level" key stores the raw gain value. Command handlers should convert the external normalised [0, 1] range to internal gain [1, 2] before writing.

fn id(&self) -> u32

Returns the unique numeric identifier for this specific effect instance.

fn name(&self) -> &str

Returns the human-readable name of the effect (e.g., “Overdrive”, “Delay”).

fn get_color(&self) -> String

Returns a color code (hex) associated with this effect for UI representation.

fn active_flag(&self) -> Arc<AtomicBool>

Returns the shared Arc<AtomicBool> that drives process_if_active. Command handlers write to it; the audio thread reads it lock-free.

fn is_active(&self) -> bool

Returns true if the effect is currently enabled and processing audio.

fn set_active(&self, active: bool)

Sets whether the effect is active or bypassed.

fn u32_params(&self) -> HashMap<&'static str, Arc<AtomicU32>>

Returns named u32 parameter Arcs shared with the audio thread. Defaults to an empty map — override for effects with extra parameters.

fn process_if_active(&mut self, sample: f32) -> f32

Processes a single audio sample only if the effect is currently active.