Skip to main content

Duck

Struct Duck 

Source
pub struct Duck {
    pub threshold_db: f64,
    pub depth_db: f64,
    pub ratio: f64,
    pub attack: Duration,
    pub release: Duration,
    pub lookahead: Duration,
}
Expand description

Sidechain ducking parameters. The trigger’s peak-hold envelope is converted to a gain reduction in dB, smoothed by attack/release and applied to the ducked signal.

Fields§

§threshold_db: f64

Trigger level above which ducking starts, in -96..=0 dBFS.

§depth_db: f64

Maximum gain reduction, in 0..=96 dB.

§ratio: f64

Compression ratio above the threshold, in 1..=100; reduction is capped by depth_db.

§attack: Duration

Time to reach a deeper reduction, in 0..=5 seconds.

§release: Duration

Time to recover after the trigger falls, in 0..=10 seconds.

§lookahead: Duration

Interval by which ducking anticipates the trigger, in 0..=500 milliseconds.

Implementations§

Source§

impl Duck

Source

pub fn new(threshold_db: f64, depth_db: f64) -> Self

Creates ducking with the given threshold and depth and default timing.

Source

pub fn ratio(self, ratio: f64) -> Self

Sets the compression ratio above the threshold.

Source

pub fn timing(self, attack: Duration, release: Duration) -> Self

Sets attack and release times.

Source

pub fn lookahead(self, lookahead: Duration) -> Self

Sets the anticipation interval.

Source

pub fn validate(self) -> Result<(), ValidationError>

Checks finite bounded parameters.

Trait Implementations§

Source§

impl Clone for Duck

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Duck

Source§

impl Debug for Duck

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Duck

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Duck

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Duck

Auto Trait Implementations§

§

impl Forget for Duck

§

impl Freeze for Duck

§

impl RefUnwindSafe for Duck

§

impl Send for Duck

§

impl Sync for Duck

§

impl Unpin for Duck

§

impl UnsafeUnpin for Duck

§

impl UnwindSafe for Duck

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.