Bug 1861709 replace AudioCallbackDriver::ThreadRunning() assertions that mean to...
[gecko.git] / third_party / rust / midir / README.md
blob42e1012411b47f5de28272d7a5b42a445eda5353
1 # midir [![crates.io](https://img.shields.io/crates/v/midir.svg)](https://crates.io/crates/midir) [![Build Status](https://dev.azure.com/Boddlnagg/midir/_apis/build/status/Boddlnagg.midir?branchName=master)](https://dev.azure.com/Boddlnagg/midir/_build/latest?definitionId=1)
3 Cross-platform, realtime MIDI processing in Rust. This is a friendly fork with
4 small changes required for vendoring the crate in Firefox. It will go away as
5 soon as we will be able to vendor the upstream crate.
7 ## Features
8 **midir** is inspired by [RtMidi](https://github.com/thestk/rtmidi) and supports the same features*, including virtual ports (except on Windows) and full SysEx support – but with a rust-y API!
10 <sup>* With the exception of message queues, but these can be implemented on top of callbacks using e.g. Rust's channels.</sup>
12 **midir** currently supports the following platforms/backends: 
13 - [x] ALSA (Linux)
14 - [x] WinMM (Windows)
15 - [x] CoreMIDI (macOS, iOS (untested))
16 - [x] WinRT (Windows 8+), enable the `winrt` feature
17 - [x] Jack (Linux, macOS), enable the `jack` feature
18 - [x] Web MIDI (Chrome, Opera, perhaps others browsers)
20 A higher-level API for parsing and assembling MIDI messages might be added in the future.
22 ## Documentation & Example
23 API docs can be found at [docs.rs](https://docs.rs/crate/midir/). You can find some examples in the [`examples`](examples/) directory. Or simply run `cargo run --example test_play` after cloning this repository.