Skip to main content

EnvelopeGenerator

Struct EnvelopeGenerator 

Source
pub struct EnvelopeGenerator<T: Transcendental> { /* private fields */ }
Expand description

Multi-stage envelope generator (ADSR, AR, ASR).

Processes an audio-rate gate signal: values > 0.5 trigger the attack phase, values ≤ 0.5 trigger the release phase. Output ramps smoothly between stages.

Implementations§

Source§

impl<T: Transcendental> EnvelopeGenerator<T>

Source

pub fn adsr(attack: f32, decay: f32, sustain: T, release: f32) -> Self

Create a new ADSR envelope.

  • attack — attack time in seconds.
  • decay — decay time in seconds.
  • sustain — sustain level (0..1).
  • release — release time in seconds.
Source

pub fn ar(attack: f32, release: f32) -> Self

Create a new AR (Attack-Release) envelope for percussive sounds.

Source

pub fn asr(attack: f32, sustain: T, release: f32) -> Self

Create a new ASR (Attack-Sustain-Release) envelope for organ-like sounds.

Source

pub fn trigger(&mut self)

Start the envelope (gate on). Resets to the attack phase.

Source

pub fn release(&mut self)

Release the envelope (gate off). Enters the release phase.

Source

pub fn stage(&self) -> EnvelopeStage

Current envelope stage.

Source

pub fn is_active(&self) -> bool

Returns true if the envelope is not in the Off stage.

Trait Implementations§

Source§

impl<T: Transcendental> Algorithm<T> for EnvelopeGenerator<T>

Source§

fn init(&mut self, sample_rate: f32)

Initialise the algorithm with a sample rate. Read more
Source§

fn reset(&mut self)

Reset the algorithm to its initial state. Read more
Source§

fn process( &mut self, input: Option<&[T]>, output: &mut [T], ) -> ProcessResult<()>

Process one block of signal. Read more
Source§

fn metadata(&self) -> AlgorithmMetadata

Descriptive metadata (defaults to empty).
Source§

fn apply_command(&mut self, _value: T)

Receive a real-time command value from the control path. Read more
Source§

impl<T: Transcendental> Generator<T> for EnvelopeGenerator<T>

Source§

fn phase(&self) -> T

Get current phase (0.0 - 1.0)
Source§

fn set_phase(&mut self, _phase: T)

Set phase
Source§

fn frequency(&self) -> f32

Get frequency in Hz
Source§

fn set_frequency(&mut self, _freq: f32)

Set frequency
Source§

fn amplitude(&self) -> T

Get amplitude
Source§

fn set_amplitude(&mut self, _amp: T)

Set amplitude
Source§

fn reset_phase(&mut self)

Reset phase to 0

Auto Trait Implementations§

§

impl<T> Freeze for EnvelopeGenerator<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for EnvelopeGenerator<T>
where T: RefUnwindSafe,

§

impl<T> Send for EnvelopeGenerator<T>

§

impl<T> Sync for EnvelopeGenerator<T>

§

impl<T> Unpin for EnvelopeGenerator<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for EnvelopeGenerator<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for EnvelopeGenerator<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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V