zawz
e61163da88
~ rework midi backend structure + add documentation + implement connect by address + add log_devices and log_events options
40 lines
880 B
Markdown
40 lines
880 B
Markdown
# rmidimap
|
|
|
|
Map MIDI signals to command with a simple yaml file.
|
|
|
|
See [format]() and [examples](/examples/).
|
|
|
|
# Usage
|
|
|
|
Simply execute `rmidimap <FILE>` to start with the desired map file.
|
|
|
|
# Features
|
|
|
|
### MIDI backends
|
|
|
|
Only Linux+ALSA currently.
|
|
|
|
### Performance
|
|
|
|
rmidimap runs with very low processing overhead.
|
|
Processing overhead has been measured at 100-200µs, while execution spawning was measured to 1-4ms.
|
|
|
|
### Device connection
|
|
|
|
Connect to devices by name or regex, and run commands on connect or disconnect.
|
|
|
|
### Command queue and interval
|
|
|
|
With the parameters `queue_length` and `interval`,
|
|
you can limit event throughput to reduce system load associated with the command being run.
|
|
|
|
# Building from source
|
|
|
|
You need rustc and cargo to build the project.
|
|
|
|
Steps:
|
|
- Clone this repository
|
|
- `cargo build -r`
|
|
- `sudo mv target/release/rmidimap /usr/local/bin/rmidimap`
|
|
|
|
|