Skip to main content

SmfFile

Struct SmfFile 

Source
pub struct SmfFile {
    pub format: SmfFormat,
    pub division: SmfDivision,
    pub tracks: Vec<SmfTrack>,
}
Expand description

A parsed Standard MIDI File: its format, time division, and tracks.

Fields§

§format: SmfFormat

Header format field.

§division: SmfDivision

Lossless metrical or SMPTE time division.

§tracks: Vec<SmfTrack>

Tracks in file order.

Implementations§

Source§

impl SmfFile

Source

pub const fn ticks_per_quarter(&self) -> Option<u32>

Returns this file’s metrical ticks per quarter note, or None when its division is SMPTE.

Source

pub fn tempo_maps(&self) -> Result<SmfTempoMaps, MidiError>

Builds exact tempo maps from the file’s ordered tempo meta events.

Metrical formats 0 and 1 produce one shared map. Format 2 produces one map per independent track. SMPTE divisions have a direct timecode chart rather than a tempo map and return MidiError::MetricalTempoRequired.

Source

pub fn canonicalize(&mut self)

Sorts every track into canonical order and ensures each ends with an end-of-track meta event.

Source

pub fn merge_cursor(&self) -> Result<SmfMergeCursor<'_>, SmfError>

Returns a cursor that merges tracks sharing one timeline.

Format-2 tracks are independent patterns, so merging them would invent a relationship between their local time origins and is rejected.

Source

pub fn merged_events(&self) -> Result<Vec<TrackedMidiEvent>, SmfError>

Collects every track’s events into a single time-ordered, track-tagged vector.

Format-2 files return SmfError::IndependentPatternsCannotMerge; callers must choose and process a track as an independent pattern.

Trait Implementations§

Source§

impl Clone for SmfFile

Source§

fn clone(&self) -> SmfFile

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 SmfFile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SmfFile

Source§

impl PartialEq for SmfFile

Source§

fn eq(&self, other: &SmfFile) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SmfFile

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.