Struct Synthesizer 

#[non_exhaustive]
pub struct Synthesizer {

    pub(crate) sound_font: Arc<SoundFont>,
    pub(crate) sample_rate: i32,
    pub(crate) block_size: usize,
    pub(crate) maximum_polyphony: usize,
    preset_lookup: HashMap<i32, usize>,
    default_preset: usize,
    channels: Vec<Channel>,
    voices: VoiceCollection,
    block_left: Vec<f32>,
    block_right: Vec<f32>,
    inverse_block_size: f32,
    block_read: usize,
    master_volume: f32,
    effects: Option<Effects>,
}

An instance of the SoundFont synthesizer.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sound_font: Arc<SoundFont>

sample_rate: i32

block_size: usize

maximum_polyphony: usize

preset_lookup: HashMap<i32, usize>

default_preset: usize

channels: Vec<Channel>

voices: VoiceCollection

block_left: Vec<f32>

block_right: Vec<f32>

inverse_block_size: f32

block_read: usize

master_volume: f32

effects: Option<Effects>

Implementations

impl Synthesizer

pub const CHANNEL_COUNT: usize = 16

The number of channels.

pub const PERCUSSION_CHANNEL: usize = 9

The percussion channel.

pub fn new( sound_font: &Arc<SoundFont>, settings: &SynthesizerSettings, ) -> Result<Synthesizer, SynthesizerError>

Initializes a new synthesizer using a specified SoundFont and settings.

Arguments

• sound_font - The SoundFont instance.
• settings - The settings for synthesis.

pub fn process_midi_message( &mut self, channel: i32, command: i32, data1: i32, data2: i32, )

Processes a MIDI message.

Arguments

• channel - The channel to which the message will be sent.
• command - The type of the message.
• data1 - The first data part of the message.
• data2 - The second data part of the message.

pub fn note_off(&mut self, channel: i32, key: i32)

Stops a note.

Arguments

• channel - The channel of the note.
• key - The key of the note.

pub fn note_on(&mut self, channel: i32, key: i32, velocity: i32)

Starts a note.

Arguments

• channel - The channel of the note.
• key - The key of the note.
• velocity - The velocity of the note.

pub fn note_off_all(&mut self, immediate: bool)

Stops all the notes in the specified channel.

Arguments

• immediate - If true, notes will stop immediately without the release sound.

pub fn note_off_all_channel(&mut self, channel: i32, immediate: bool)

Stops all the notes in the specified channel.

Arguments

• channel - The channel in which the notes will be stopped.
• immediate - If true, notes will stop immediately without the release sound.

pub fn reset_all_controllers(&mut self)

Resets all the controllers.

pub fn reset_all_controllers_channel(&mut self, channel: i32)

Resets all the controllers of the specified channel.

Arguments

• channel - The channel to be reset.

pub fn reset(&mut self)

Resets the synthesizer.

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

Renders the waveform.

Arguments

• left - The buffer of the left channel to store the rendered waveform.
• right - The buffer of the right channel to store the rendered waveform.

Remarks

The output buffers for the left and right must be the same length.

pub fn get_sound_font(&self) -> &SoundFont

Gets the SoundFont used as the audio source.

pub fn get_sample_rate(&self) -> i32

Gets the sample rate for synthesis.

pub fn get_block_size(&self) -> usize

Gets the block size for rendering waveform.

pub fn get_maximum_polyphony(&self) -> usize

Gets the number of maximum polyphony.

pub fn get_enable_reverb_and_chorus(&self) -> bool

Gets the value indicating whether reverb and chorus are enabled.

pub fn get_master_volume(&self) -> f32

Gets the master volume.

pub fn set_master_volume(&mut self, value: f32)

Sets the master volume.

Arguments

• value - The new value of the master volume.

Trait Implementations

impl Debug for Synthesizer

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

Formats the value using the given formatter.