Struct Compressor 

pub struct Compressor { /* private fields */ }

A per-channel feed-forward compressor Processor.

Implementations

impl Compressor

pub fn new(threshold_db: f32, ratio: f32) -> Self

Creates a compressor with the given threshold (dB) and ratio (clamped to >= 1.0), with default timing and unity makeup gain.

pub fn with_timing(self, attack_ms: f32, release_ms: f32) -> Self

Returns the compressor with attack and release times (ms) set.

pub fn with_makeup_gain_db(self, makeup_db: f32) -> Self

Returns the compressor with makeup gain set, in decibels.

Trait Implementations

impl Clone for Compressor

fn clone(&self) -> Compressor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compressor

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

Formats the value using the given formatter.

impl PartialEq for Compressor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Processor for Compressor

fn prepare(&mut self, cfg: PrepareConfig)

Prepares the processor for a sample rate, block size, and channel layout.

fn reset(&mut self)

Clears any internal state to a fresh start.

fn process(&mut self, block: &mut ProcessBlock<'_>)

Processes one block of audio and events in place.

fn clock_domain(&self) -> ClockDomain

Returns the processor’s clock domain (defaults to sample rate).

fn latency_class(&self) -> LatencyClass

Returns the processor’s latency class (defaults to block-local).

fn realtime_pin(&self) -> bool

Returns whether the processor must run in the realtime thread (defaults to true).

fn ports(&self, in_channels: u16, out_channels: u16) -> Vec<PortDecl>

Returns the processor’s port declarations for the given channel counts (defaults to a single audio in/out pair).

fn descriptor(&self, in_channels: u16, out_channels: u16) -> ProcessorDescriptor

Returns the full ProcessorDescriptor assembled from this processor’s clock, latency, pinning, and ports.

fn tail_frames(&self) -> u64

Returns the processor’s release tail length in frames (defaults to 0).

impl StructuralPartialEq for Compressor