Struct SynthVoice 

pub struct SynthVoice {
    font: Option<Arc<SoundFont>>,
    pub synthesizer: Option<Synthesizer>,
    queued: Vec<(f64, MidiMessage)>,
    left: Vec<f32>,
    right: Vec<f32>,
    gave_up: bool,
}

A loaded soundfont and the synthesizer playing it, as one object.

Spawning it also spawns the OnAudioFill that renders it, so the voice is a source of the world’s mix: midi_job presses its keys and the audio thread turns them into samples. A voice on its own would never be asked for samples, and a fill source without one would have nothing to render, so the two are spawned together.

Fields

font: Option<Arc<SoundFont>>

The soundfont to build the synthesizer from, until it is built. Taken away when building fails, which is what makes a voice that cannot sound fail once instead of on every fill.

synthesizer: Option<Synthesizer>

The synthesizer that turns messages into samples, built on the first fill from the rate that fill reports.

queued: Vec<(f64, MidiMessage)>

Messages waiting for their moment, in seconds from the next fill’s start.

left: Vec<f32>

The left channel’s block, reused across fills.

right: Vec<f32>

The right channel’s block, reused across fills.

gave_up: bool

Whether building gave up, so no queue is kept for it any more.

Implementations

impl SynthVoice

pub fn from_font(world: &mut World, font: &Arc<SoundFont>) -> Entity

Spawns a voice playing font, and its fill source.

pub fn from_bytes(world: &mut World, bytes: &[u8]) -> Result<Entity, VoiceError>

Parses bytes as a soundfont and spawns a voice playing it.

Errors

Returns the soundfont error when the bytes are malformed.

fn build(&mut self, rate: i32) -> bool

Builds the synthesizer at rate, or gives the voice up for good.

Returns whether the voice can render now.

fn give_up(&mut self, reason: impl Display)

Stops trying to sound, naming reason once: a failure that would repeat on every fill belongs in the log once, not sixty times a second.

Trait Implementations

impl Bundle for SynthVoice

fn into_bundle(self) -> DynamicBundle

The dynamic bundle holding exactly this bundle’s components.

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

The name the spawned entity takes: the bundle’s own type by default.