https://github.com/geomyidia/midiserver
A MIDI CLI tool and server written in Go, focused on supporting BEAM music apps via Erlang Ports
https://github.com/geomyidia/midiserver
erlang ffi golang midi
Last synced: 4 months ago
JSON representation
A MIDI CLI tool and server written in Go, focused on supporting BEAM music apps via Erlang Ports
- Host: GitHub
- URL: https://github.com/geomyidia/midiserver
- Owner: geomyidia
- License: bsd-2-clause
- Created: 2021-07-25T18:11:11.000Z (almost 5 years ago)
- Default Branch: release/0.3.x
- Last Pushed: 2024-09-15T16:08:54.000Z (almost 2 years ago)
- Last Synced: 2026-02-14T18:47:39.264Z (4 months ago)
- Topics: erlang, ffi, golang, midi
- Language: Go
- Homepage:
- Size: 12.1 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# midiserver
[![Build Status][gh-actions-badge]][gh-actions]
[![Go Versions][go badge]][go]
[![LFE Versions][lfe badge]][lfe]
[![Erlang Versions][erlang badge]][erlang]
[![][logo]][logo-large]
*A MIDI CLI tool and server written in Go, focused on supporting BEAM music apps via Erlang Ports*
**Update:** This repo is no longer being used for the undertone and undermidi projects; those are currently being updated to use the rtmidi Erlang NIF developed by the Sonic Pi project.
## About
The executable built by this project is intended to:
* communicate via messages with BEAM (Erlang language family) clients
* to do so with messages created by [midilib](https://github.com/erlsci/midilib)
* to be controlled by a `gen_server` (e.g., see [undermidi go server](https://github.com/ut-proj/undermidi/blob/release/0.2.x/src/undermidi/supervisor.lfe))
* to be run as part of a supervision tree (e.g., see [undermidi supervisor](https://github.com/ut-proj/undermidi))
## Usage
A typical execution looks like this:
```shell
./bin/midiserver -d -l warn -p exec
```
You can use it to test your MIDI setup:
```shell
./bin/midiserver list-devices
./bin/midiserver example 0 0
```
Full usage:
```shell
./bin/midiserver -h
```
```text
Usage: ./bin/midiserver [flags] [commands] [args]
Flags:
-d Daemonise midiserver; this disables the text parser; short-form flag
-daemon
Daemonise midiserver; this disables the text parser
-epmd-host string
Set hostname of the epmd to use (default "localhost")
-epmd-port int
Set port for the epmd to use (default 4369)
-ergo.norecover
disable panic catching
-ergo.trace
enable extended debug info
-i int
This needs to be a valid ID for a MIDI device capable of receiving
MIDI data; for a list of valid IDs be sure to run the 'list-devices'
command; short-form flag (default -1)
-l string
Set the logging level; short-form flag (default "warn")
-log-reportcaller
Indicate whether the log lines contain the report caller
-loglevel string
Set the logging level (default "warn")
-midi-in int
This needs to be a valid ID for a MIDI device capable of receiving
MIDI data; for a list of valid IDs be sure to run the 'list-devices'
command (default -1)
-n string
Set the Erlang node name for remote communications; short-form flag
-p string
Set the parser to user for commands and data. Legal values are:
[exec, port, text]. Note that setting to 'text' disables
daemonisation and setting any of the other parsers automatically
enables daemonisation; short-form flag (default "text")
-parser string
Set the parser to user for commands and data. Legal values are:
[exec, port, text]. Note that setting to 'text' disables
daemonisation and setting any of the other parsers automatically
enables daemonisation (default "text")
-r Indicate whether the log lines contain the report caller; short-form flag
-remote-module string
Set the Erlang module for remote communications
-remote-node string
Set the Erlang node name for remote communications
-v Display version/build info and exit; short-form flag
-version
Display version/build info and exit
Commands:
example [args]
An example piece of music will be played on given device and channel.
Valid device numbers are any of the "out" devices in the output of
the 'list-devices' command; valid channel numbers are any of the 16
MIDI channels: 0 through 15. Default args: 0 0.
list-devices
This will list the MIDI devices currently recognised by the operating
system, grouped by input devices and output devices.
play-note [args]
A pitch will be played with the default values for the arguments,
optionally overridden. Positional args are the integer values for
device, channel, pitch, velocity, and duration. Valid device numbers
are any of the "out" devices in the output of the 'list-devices'
command; valid channel numbers are any of the 16 MIDI channels:
0 through 15. Pitch and velocity are standard MIDI integer values for
the same. Duration is in seconds. Default args: 0 0.
ping
Provided for testing purposes by Erlang Ports implementations. If the
'remote-module' flag has been set, a ping will be attempted there
instead.
remote-port
Query epmd for the port of the remote node (set with the -remote-node
flag).
version
An alternate form of the version info with concise formatting.
```
## License
Apache Version 2 License
Copyright © 2020-2022, Duncan McGreggor
[//]: ---Named-Links---
[logo]: assets/images/logo-v1-x250.png
[logo-large]: assets/images/logo-v1-x1000.png
[gh-actions-badge]: https://github.com/ut-proj/midiserver/workflows/ci%2Fcd/badge.svg
[gh-actions]: https://github.com/ut-proj/midiserver/actions
[go]: https://golang.org/
[go badge]: https://img.shields.io/badge/go-1.16-blue.svg
[lfe]: https://github.com/lfe/lfe
[lfe badge]: https://img.shields.io/badge/lfe-2.0-blue.svg
[erlang badge]: https://img.shields.io/badge/erlang-21%20to%2024-blue.svg
[erlang]: https://github.com/ut-proj/midiserver/blob/master/.github/workflows/cicd.yml