Skip to main content

GainProcessor

Struct GainProcessor 

Source
pub struct GainProcessor { /* private fields */ }
Expand description

An audio processor that applies gain with smooth transitions.

GainProcessor implements the AudioProcessor trait and applies a gain factor to audio samples. When the gain value changes, it smoothly transitions from the current value to the new target using a simple one-pole low-pass filter, preventing audible clicks and pops.

The gain value is read from an Arc<AtomicF32> that can be safely updated from other threads (e.g., the UI thread) without requiring locks.

Implementations§

Source§

impl GainProcessor

Source

pub fn new(gain: Arc<AtomicF32>) -> Self

Creates a new GainProcessor with the given atomic gain value.

Initializes the internal smoothing state (current) to the initial gain value loaded from the atomic.

§Arguments
  • gain - An Arc<AtomicF32> that holds the target gain value. This value can be updated from other threads, and changes will be smoothly transitioned.

Trait Implementations§

Source§

impl AudioProcessor for GainProcessor

Source§

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

Processes a single audio sample with the current gain factor.

Reads the target gain value from the atomic and smoothly transitions the internal state toward it using a one-pole smoothing algorithm.

§Gain Smoothing Visualization

The red line shows the instantaneous jump (Target), while the curve shows the gradual adjustment of the multiplier (Current).

xychart-beta title "Instantaneous Jump vs. One-Pole Smoothing" x-axis "Time (Samples)" [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] y-axis "Gain Factor" 0 --> 1.2 line [0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0] line [0.0, 0.4, 0.64, 0.78, 0.87, 0.92, 0.95, 0.97, 0.98, 0.99, 1.0]
§Arguments
  • sample - The input audio sample to be scaled by the gain.
§Returns

The gain-scaled audio sample.

Auto Trait Implementations§

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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

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

Source§

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>,

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,