Struct MidiFile 

#[non_exhaustive]
pub struct MidiFile {
    pub(crate) messages: Vec<MidiMessage>,
    pub(crate) times: Vec<f64>,
}

Represents a standard MIDI file.

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.

messages: Vec<MidiMessage>

times: Vec<f64>

Implementations

impl MidiFile

pub fn new<R>(reader: &mut R) -> Result<MidiFile, MidiFileError>

where R: Read,

Loads a MIDI file from the stream.

Arguments

• reader - The data stream used to load the MIDI file.

pub fn new_with_loop_type<R>( reader: &mut R, loop_type: MidiFileLoopType, ) -> Result<MidiFile, MidiFileError>

where R: Read,

Loads a MIDI file from the stream with a specified loop type.

Arguments

• reader - The data stream used to load the MIDI file.
• loop_type - The type of the loop extension to be used.

Remarks

MidiFileLoopType has the following variants:

• LoopPoint(usize) - Specifies the loop start point by a tick value.
• RpgMaker - The RPG Maker style loop. CC #111 will be the loop start point.
• IncredibleMachine - The Incredible Machine style loop. CC #110 and #111 will be the start and end points of the loop.
• FinalFantasy - The Final Fantasy style loop. CC #116 and #117 will be the start and end points of the loop.

pub fn get_length(&self) -> f64

Get the length of the MIDI file in seconds.

pub fn get_messages(&self) -> &[MidiMessage]

Get the merged message list of the MIDI file.

Parallel to get_times: message i occurs at get_times()[i]. Tempo changes are already folded into the times.

pub fn get_times(&self) -> &[f64]

Get the time of every message in absolute seconds.

Parallel to get_messages.

pub fn new_with_events<I>(events: I) -> Result<MidiFile, MidiFileError>

where I: IntoIterator<Item = (f64, MidiMessage)>,

Creates a MIDI file from an event list without parsing.

Times must be in non-decreasing order (same-time events allowed); returns [MidiFileError::InvalidEventList] otherwise. Accepts any iterator of (time, message) pairs.

pub fn extend_events<I>(&mut self, events: I) -> Result<(), MidiFileError>

where I: IntoIterator<Item = (f64, MidiMessage)>,

Appends events to the end of the MIDI file.

Appended times must be non-decreasing and not earlier than the last existing time; otherwise returns [MidiFileError::InvalidEventList] and leaves the file unchanged. To replace all events, call clear first.

pub fn clear(&mut self)

Removes all events from the MIDI file.

Trait Implementations

impl Debug for MidiFile

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

Formats the value using the given formatter.

impl Default for MidiFile

fn default() -> MidiFile

Creates an empty MIDI file.