Struct SampleSoundfont 

pub struct SampleSoundfont { /* private fields */ }

Represents a sample soundfont to be used within XSynth.

Supports SFZ and SF2 soundfonts.

SFZ specification support (opcodes)

• lovel & hivel
• lokey & hikey
• pitch_keycenter
• volume
• pan
• sample
• default_path
• loop_mode
• loop_start
• loop_end
• offset
• cutoff
• resonance
• fil_veltrack
• fil_keycenter
• fil_keytrack
• filter_type
• tune
• ampeg_start
• ampeg_delay
• ampeg_attack
• ampeg_hold
• ampeg_decay
• ampeg_sustain
• ampeg_release

SF2 specification support

Generators

• startAddrsOffset
• endAddrsOffset
• startloopAddrsOffset
• endloopAddrsOffset
• startAddrsCoarseOffset
• endAddrsCoarseOffset
• startloopAddrsCoarseOffset
• endloopAddrsCoarseOffset
• initialFilterFc
• initialFilterQ
• pan
• delayVolEnv
• attackVolEnv
• holdVolEnv
• decayVolEnv
• sustainVolEnv
• releaseVolEnv
• instrument
• keyRange
• velRange
• initialAttenuation
• coarseTune
• fineTune
• sampleID
• sampleModes
• overridingRootKey
• scaleTuning
• exclusiveClass
• keynum
• velocity
• keynumToVolEnvHold
• keynumToVolEnvDecay

Modulators

XSynth intentionally supports a baked subset of SF2 modulators so note-on articulation can be resolved at soundfont load time without adding runtime voice stages. Currently supported:

• sources: key number and note-on velocity
• curves: linear, concave, convex, and switch
• transforms: linear and absolute
• destinations: attenuation, filter cutoff, pan, volume envelope timings, and static pitch offsets

The following SF2 features are intentionally not supported in the runtime engine because they would add significant hot-path and binary-size cost:

• modulation envelope generators and destinations
• modulation LFO / vibrato LFO generators and destinations
• generic CC / aftertouch / pitch-wheel-driven SF2 modulators
• chorus and reverb send behavior

Implementations

impl SampleSoundfont

pub fn new( path: impl Into<PathBuf>, stream_params: AudioStreamParams, options: SoundfontInitOptions, ) -> Result<Self, LoadSfError>

Loads a new sample soundfont of an unspecified type. The type of the soundfont will be determined from the file extension.

Parameters:

• path: The path of the soundfont to be loaded.
• stream_params: Parameters of the output audio. See the AudioStreamParams documentation for the available options.
• options: The soundfont configuration. See the SoundfontInitOptions documentation for the available options.

pub fn new_sfz( sfz_path: impl Into<PathBuf>, stream_params: AudioStreamParams, options: SoundfontInitOptions, ) -> Result<Self, LoadSfzError>

Loads a new SFZ soundfont

Parameters:

• path: The path of the SFZ soundfont to be loaded.
• stream_params: Parameters of the output audio. See the AudioStreamParams documentation for the available options.
• options: The soundfont configuration. See the SoundfontInitOptions documentation for the available options.

pub fn new_sf2( sf2_path: impl Into<PathBuf>, stream_params: AudioStreamParams, options: SoundfontInitOptions, ) -> Result<Self, Sf2ParseError>

Loads a new SF2 soundfont

Parameters:

• path: The path of the SF2 soundfont to be loaded.
• stream_params: Parameters of the output audio. See the AudioStreamParams documentation for the available options.
• options: The soundfont configuration. See the SoundfontInitOptions documentation for the available options.

Trait Implementations

impl Debug for SampleSoundfont

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

Formats the value using the given formatter.

impl SoundfontBase for SampleSoundfont

fn stream_params(&self) -> &AudioStreamParams

fn get_attack_voice_spawners_at( &self, bank: u8, preset: u8, key: u8, vel: u8, ) -> Vec<Box<dyn VoiceSpawner>>

fn get_release_voice_spawners_at( &self, _bank: u8, _preset: u8, _key: u8, _vel: u8, ) -> Vec<Box<dyn VoiceSpawner>>