Skip to main content

InstrumentSource

Enum InstrumentSource 

Source
pub enum InstrumentSource {
    Sf2(PathBuf),
    Sfz(PathBuf),
    Dls(PathBuf),
    Tone,
}
Expand description

Source descriptor for an external instrument bank. Paired with MidiDecoder::with_instrument_source so a caller that only knows “I have an SF2 file at this path” doesn’t have to type the full Arc::new(Sf2Instrument::open(...)) chain.

Variants§

§

Sf2(PathBuf)

SoundFont 2 bank — loaded via Sf2Instrument::open.

§

Sfz(PathBuf)

SFZ text patch — loaded via SfzInstrument::open (samples are read off disk relative to the patch’s directory).

§

Dls(PathBuf)

DLS Level 1 / 2 bank — loaded via DlsInstrument::open.

§

Tone

Pure-tone fallback (no on-disk file).

Implementations§

Source§

impl InstrumentSource

Source

pub fn load(self) -> Result<Arc<dyn Instrument>>

Load the bank at the named path and wrap it in an Arc<dyn Instrument>. Returns the underlying error (file-not-found, invalid magic, malformed RIFF chunk, etc.) on failure.

Source

pub fn sf2(path: impl AsRef<Path>) -> Self

Convenience constructors mirroring the enum variants. Each takes anything Path-convertible.

Source

pub fn sfz(path: impl AsRef<Path>) -> Self

Source

pub fn dls(path: impl AsRef<Path>) -> Self

Trait Implementations§

Source§

impl Clone for InstrumentSource

Source§

fn clone(&self) -> InstrumentSource

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 InstrumentSource

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.