Struct oddio::Gain

pub struct Gain<T: ?Sized> { /* private fields */ }

Amplifies a signal dynamically

To implement a volume control, place a gain combinator near the end of your pipeline where the input amplitude is initially in the range [0, 1] and pass decibels to GainControl::set_gain, mapping the maximum volume to 0 decibels, and the minimum to e.g. -60.

Implementations

impl<T> Gain<T>

pub fn new(signal: T) -> (GainControl, Self)

Apply dynamic amplification to signal

pub fn set_gain(&mut self, db: f32)

Set the initial amplification to db decibels

Perceptually linear. Negative values make the signal quieter.

Equivalent to self.set_amplitude_ratio(10.0f32.powf(db / 20.0)).

pub fn set_amplitude_ratio(&mut self, factor: f32)

Set the initial amplitude scaling of the signal directly

This is nonlinear in terms of both perception and power. Most users should prefer set_gain. Unlike set_gain, this method allows a signal to be completely zeroed out if needed, or even have its phase inverted with a negative factor.

Trait Implementations

impl<T: Signal> Signal for Gain<T>

where T::Frame: Frame,

type Frame = <T as Signal>::Frame

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

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

Sample frames separated by interval seconds each

fn is_finished(&self) -> bool

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