Struct oddio::Adapt

source ·
pub struct Adapt<T: ?Sized> { /* private fields */ }
Expand description

Smoothly adjusts gain over time to keep average (RMS) signal level within a target range

Useful for allowing both quiet and loud sounds to be heard without severe distortion.

Rapid changes in input amplitude can cause the output to rise above 1. If a hard limit on output is required, a stateless compressor like Reinhard should be chained afterwards.

This filter is configured in terms of signal root mean square values. For reference, the RMS value of a sine wave is amplitude / 2.0f32.sqrt(). Note that these are linear units, whereas perception of loudness is logarithmic.

Implementations§

source§

impl<T> Adapt<T>

source

pub fn new(signal: T, initial_rms: f32, options: AdaptOptions) -> Self

Apply adaptation to signal

Initialized as if an infinite signal with root mean squared level initial_rms had been processed.

Trait Implementations§

source§

impl<T: Signal> Signal for Adapt<T>
where T::Frame: Frame,

§

type Frame = <T as Signal>::Frame

Type of frames yielded by sample, e.g. [Sample; 2] for stereo
source§

fn sample(&mut self, interval: f32, out: &mut [T::Frame])

Sample frames separated by interval seconds each
source§

fn is_finished(&self) -> bool

Whether future calls to sample with a nonnegative interval will only produce zeroes Read more

Auto Trait Implementations§

§

impl<T: ?Sized> RefUnwindSafe for Adapt<T>
where T: RefUnwindSafe,

§

impl<T: ?Sized> Send for Adapt<T>
where T: Send,

§

impl<T: ?Sized> Sync for Adapt<T>
where T: Sync,

§

impl<T: ?Sized> Unpin for Adapt<T>
where T: Unpin,

§

impl<T: ?Sized> UnwindSafe for Adapt<T>
where T: UnwindSafe,

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.