Skip to main content

Voice

Struct Voice 

Source
pub struct Voice {
    pub index: usize,
    pub state: VoiceState,
    pub note: Option<u8>,
    pub velocity: f64,
    pub voct: f64,
    pub gate: f64,
    pub trigger: f64,
    pub age: u64,
    pub release_samples: u64,
    pub envelope_level: f64,
}
Expand description

A single voice in a polyphonic context

Fields§

§index: usize

Voice index (0 to num_voices - 1)

§state: VoiceState

Current state

§note: Option<u8>

MIDI note number currently playing (if any)

§velocity: f64

Current velocity (0.0 to 1.0)

§voct: f64

Current V/Oct value

§gate: f64

Gate signal (0.0 or 1.0)

§trigger: f64

Trigger signal (momentary; asserted on the note-on sample)

§age: u64

Age counter (samples since note on)

§release_samples: u64

Samples elapsed since the gate fell (entering Releasing)

§envelope_level: f64

Current tracked envelope level (0..~1), populated by PolyPatch from the voice’s real output amplitude. Drives quiet-steal and release-tail auto-free decisions.

Implementations§

Source§

impl Voice

Source

pub fn new(index: usize) -> Self

Create a new inactive voice

Source

pub fn note_on(&mut self, note: u8, velocity: f64)

Trigger the voice with a new note

Source

pub fn note_off(&mut self)

Release the voice

Source

pub fn free(&mut self)

Mark voice as completely free

Source

pub fn tick(&mut self)

Advance the voice’s per-sample bookkeeping (age, release counter, clear the one-sample trigger). Auto-free is handled by VoiceAllocator, which knows the release threshold and grace period.

Source

pub fn is_free(&self) -> bool

Check if voice is available for allocation

Source

pub fn is_playing_note(&self, note: u8) -> bool

Check if voice is playing the given note

Trait Implementations§

Source§

impl Clone for Voice

Source§

fn clone(&self) -> Voice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Voice

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Voice

§

impl RefUnwindSafe for Voice

§

impl Send for Voice

§

impl Sync for Voice

§

impl Unpin for Voice

§

impl UnsafeUnpin for Voice

§

impl UnwindSafe for Voice

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.