https://github.com/RustAudio/wmidi

Rust midi encoding and decoding library.
https://github.com/RustAudio/wmidi

audio enum midi real realtime rust

Last synced: 2 months ago
JSON representation

Rust midi encoding and decoding library.

• Host: GitHub
• URL: https://github.com/RustAudio/wmidi
• Owner: RustAudio
• License: mit
• Created: 2020-09-29T04:34:24.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-09T17:03:42.000Z (11 months ago)
• Last Synced: 2024-09-09T17:48:56.931Z (4 months ago)
• Topics: audio, enum, midi, real, realtime, rust
• Language: Rust
• Homepage:
• Size: 80.1 KB
• Stars: 72
• Watchers: 7
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-open-synth - wmidi

README

        
# WMIDI

Midi encoding and decoding library.

[![crates.io](https://img.shields.io/crates/v/wmidi.svg)](https://crates.io/crates/wmidi)

[![docs.rs](https://docs.rs/wmidi/badge.svg)](https://docs.rs/wmidi)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

[![Build Status](https://github.com/RustAudio/wmidi/workflows/Rust/badge.svg)](https://github.com/RustAudio/wmidi/actions?query=branch%3Amain)

## Usage

```rust

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 {

    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`.