Skip to main content

GainProcessor

Struct GainProcessor 

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

Reference gain processor implementation for VstKit.

This struct maintains processing state and provides a simple gain effect. All methods are designed to be real-time safe (no allocations, no locks, no syscalls).

This serves as a reference implementation for the Processor trait.

Implementations§

Source§

impl GainProcessor

Source

pub fn new(sample_rate: f32) -> Self

Create a new gain processor with the given sample rate.

§Arguments
  • sample_rate - The audio sample rate in Hz (e.g., 44100.0)
Source

pub fn set_sample_rate(&mut self, sample_rate: f32)

Update the sample rate.

Call this when the host changes sample rate (e.g., in initialize()).

§Arguments
  • sample_rate - The new sample rate in Hz
Source

pub fn sample_rate(&self) -> f32

Get the current sample rate.

Source

pub fn process(&self, left: &mut [f32], right: &mut [f32], gain_db: f32)

Process stereo audio buffers in-place.

§Arguments
  • left - Left channel audio buffer (modified in-place)
  • right - Right channel audio buffer (modified in-place)
  • gain_db - Gain to apply in decibels
§Real-Time Safety

This method is real-time safe:

  • No allocations
  • No locks
  • No syscalls
  • No panics (uses debug_assert only)

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

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.