wmidi

Crates.iowmidi
lib.rswmidi
version4.0.10
sourcesrc
created_at2018-01-15 06:12:14.208152
updated_at2023-12-20 01:48:29.181926
descriptionMidi parsing library.
homepage
repositoryhttps://github.com/RustAudio/wmidi
max_upload_size
id46870
size89,520
Will (wmedrano)

documentation

https://docs.rs/wmidi

README

WMIDI

Midi encoding and decoding library.

crates.io docs.rs

License: MIT Build Status

Usage

use std::convert::TryFrom;

// Decoding messages from bytes.
fn handle_midi_message(bytes: &[u8]) -> Result<(), wmidi::FromBytesError> {
    let message = wmidi::MidiMessage::try_from(bytes)?;
    if let wmidi::MidiMessage::NoteOn(_, note, val) = message {
        let volume = u8::from(val) as u8 / 127.0;
        println!("Singing {} at volume {}", note, volume);
    }
    Ok(())
}

// Encoding messages to bytes.
fn midi_to_bytes(message: wmidi::MidiMessage<'_>) -> Vec<u8> {
    let mut bytes = vec![0u8; message.bytes_size()];
    message.copy_to_slice(bytes.as_mut_slice()).unwrap();
    bytes
}

Features

  • Supports no_std environments.
  • No memory allocations (therefore realtime safe) for parsing and encoding.
  • No memory allocations for creating MidiMessage, except for MidiMessage::OwnedSysEx.

Testing & Benchmarking

  • Build with cargo build.
  • Test with cargo test.
  • Benchmark with cargo bench. The results will be under ./target/criterion/report/index.html.

Changelog

4.0.0

  • New ControlFunction type which simply wraps a U7.
  • Constants and documentation for all ControlFunction values.
  • Renumber Note enums/consts to be more consistent with midi; for example, C0 is now C1.

3.1.0

  • Rename MidiMessage::wire_size() to MidiMessage::bytes_size().
  • Introduce MidiMessage::copy_to_slice() method.

3.0.0

  • Instances of U7 and U14 now have bounds checking.
  • Note is now an enum instead of a u8. Can be converted with Note::try_from and u8::from.
Commit count: 75

cargo fmt