aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md475
1 files changed, 123 insertions, 352 deletions
diff --git a/README.md b/README.md
index d2298b2..8d38565 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,18 @@ tool between multi-channel absolute-value-based control and/or bus protocols.
Currently, the MIDIMonster supports the following protocols:
-* MIDI (Linux, via ALSA)
-* ArtNet
-* sACN / E1.31
-* OSC
-* evdev input devices (Linux)
+| Protocol | Operating Systems | Notes | Backends |
+|-------------------------------|-----------------------|-------------------------------|-------------------------------|
+| MIDI | Linux, Windows, OSX | Linux: via ALSA/JACK, OSX: via JACK | [`midi`](backends/midi.md), [`winmidi`](backends/winmidi.md), [`jack`](backends/jack.md) |
+| ArtNet | Linux, Windows, OSX | Version 4 | [`artnet`](backends/artnet.md)|
+| Streaming ACN (sACN / E1.31) | Linux, Windows, OSX | | [`sacn`](backends/sacn.md) |
+| OpenSoundControl (OSC) | Linux, Windows, OSX | | [`osc`](backends/osc.md) |
+| evdev input devices | Linux | Virtual output supported | [`evdev`](backends/evdev.md) |
+| Open Lighting Architecture | Linux, OSX | | [`ola`](backends/ola.md) |
+| MA Lighting Web Remote | Linux, Windows, OSX | GrandMA and dot2 (incl. OnPC) | [`maweb`](backends/maweb.md) |
+| JACK/LV2 Control Voltage (CV) | Linux, OSX | | [`jack`](backends/jack.md) |
+
+with additional flexibility provided by a [Lua scripting environment](backends/lua.md).
The MIDIMonster allows the user to translate any channel on one protocol into channel(s)
on any other (or the same) supported protocol, for example to:
@@ -17,49 +24,19 @@ on any other (or the same) supported protocol, for example to:
* Translate MIDI Control Changes into Notes ([Example configuration](configs/unifest-17.cfg))
* Translate MIDI Notes into ArtNet or sACN ([Example configuration](configs/launchctl-sacn.cfg))
* Translate OSC messages into MIDI ([Example configuration](configs/midi-osc.cfg))
+* Dynamically generate, route and modify events using the Lua programming language ([Example configuration](configs/lua.cfg) and [Script](configs/demo.lua)) to create your own lighting controller or run effects on TouchOSC (Flying faders demo [configuration](configs/flying-faders.cfg) and [script](configs/flying-faders.lua))
* Use an OSC app as a simple lighting controller via ArtNet or sACN
* Visualize ArtNet data using OSC tools
-* Control lighting fixtures or DAWs using gamepad controllers ([Example configuration](configs/evdev.conf))
-* Play games or type using MIDI controllers
+* Control lighting fixtures or DAWs using gamepad controllers, trackballs, etc ([Example configuration](configs/evdev.cfg))
+* Play games, type, or control your mouse using MIDI controllers ([Example configuration](configs/midi-mouse.cfg))
-[![Coverity Scan Build Status](https://scan.coverity.com/projects/15168/badge.svg)](https://scan.coverity.com/projects/15168)
+[![Build Status](https://travis-ci.com/cbdevnet/midimonster.svg?branch=master)](https://travis-ci.com/cbdevnet/midimonster) [![Coverity Scan Build Status](https://scan.coverity.com/projects/15168/badge.svg)](https://scan.coverity.com/projects/15168)
# Table of Contents
* [Usage](#usage)
* [Configuration](#configuration)
* [Backend documentation](#backend-documentation)
- + [The `artnet` backend](#the-artnet-backend)
- - [Global configuration](#global-configuration)
- - [Instance configuration](#instance-configuration)
- - [Channel specification](#channel-specification)
- - [Known bugs / problems](#known-bugs--problems)
- + [The `sacn` backend](#the-sacn-backend)
- - [Global configuration](#global-configuration-1)
- - [Instance configuration](#instance-configuration-1)
- - [Channel specification](#channel-specification-1)
- - [Known bugs / problems](#known-bugs--problems-1)
- + [The `midi` backend](#the-midi-backend)
- - [Global configuration](#global-configuration-2)
- - [Instance configuration](#instance-configuration-2)
- - [Channel specification](#channel-specification-2)
- - [Known bugs / problems](#known-bugs--problems-2)
- + [The `evdev` backend](#the-evdev-backend)
- - [Global configuration](#global-configuration-3)
- - [Instance configuration](#instance-configuration-3)
- - [Channel specification](#channel-specification-3)
- - [Known bugs/problems](#known-bugs-problems)
- + [The `loopback` backend](#the-loopback-backend)
- - [Global configuration](#global-configuration-4)
- - [Instance configuration](#instance-configuration-4)
- - [Channel specification](#channel-specification-4)
- - [Known bugs / problems](#known-bugs--problems-3)
- + [The `osc` backend](#the-osc-backend)
- - [Global configuration](#global-configuration-5)
- - [Instance configuration](#instance-configuration-5)
- - [Channel specification](#channel-specification-5)
- - [Supported types & value ranges](#supported-types--value-ranges)
- - [Known bugs / problems](#known-bugs--problems-4)
* [Building](#building)
+ [Prerequisites](#prerequisites)
+ [Build](#build)
@@ -83,10 +60,24 @@ lines of the form `option = value`.
Lines starting with a semicolon are treated as comments and ignored. Inline comments
are not currently supported.
+Example configuration files may be found in [configs/](configs/).
+
+### Backend and instance configuration
+
A configuration section may either be a *backend configuration* section, started by
`[backend <backend-name>]`, an *instance configuration* section, started by
`[<backend-name> <instance-name>]` or a *mapping* section started by `[map]`.
+Backends document their global options in their [backend documentation](#backend-documentation).
+Some backends may not require global configuration, in which case the configuration
+section for that particular backend can be omitted.
+
+To make an instance available for mapping channels, it requires at least the
+`[<backend-name> <instance-name>]` configuration stanza. Most backends require
+additional configuration for their instances.
+
+### Channel mapping
+
The `[map]` section consists of lines of channel-to-channel assignments, reading like
```
@@ -103,360 +94,140 @@ output eachothers events.
The last line is a shorter way to create a bi-directional mapping.
-Example configuration files may be found in [configs/](configs/).
-
-## Backend documentation
-This section documents the configuration options supported by the various backends.
-
-### The `artnet` backend
-
-The ArtNet backend provides read-write access to the UDP-based ArtNet protocol for lighting
-fixture control.
-
-#### Global configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `bind` | `127.0.0.1 6454` | none | Binds a network address to listen for data. This option may be set multiple times, with each interface being assigned an index starting from 0 to be used with the `interface` instance configuration option. At least one interface is required for transmission. |
-| `net` | `0` | `0` | The default net to use |
-
-#### Instance configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `net` | `0` | `0` | ArtNet `net` to use |
-| `universe` | `0` | `0` | Universe identifier |
-| `destination` | `10.2.2.2` | none | Destination address for sent ArtNet frames. Setting this enables the universe for output |
-| `interface` | `1` | `0` | The bound address to use for data input/output |
-
-#### Channel specification
-
-A channel is specified by it's universe index. Channel indices start at 1 and end at 512.
-
-Example mapping:
-```
-net1.231 < net2.123
-```
-
-A 16-bit channel (spanning any two normal channels in the same universe) may be mapped with the syntax
-```
-net1.1+2 > net2.5+123
-```
-
-A normal channel that is part of a wide channel can not be mapped individually.
-
-#### Known bugs / problems
-
-The minimum inter-frame-time is disregarded, as the packet rate is determined by the rate of incoming
-channel events.
-
-### The `sacn` backend
-
-The sACN backend provides read-write access to the Multicast-UDP based streaming ACN protocol (ANSI E1.31-2016),
-used for lighting fixture control. The backend sends universe discovery frames approximately every 10 seconds,
-containing all write-enabled universes.
-
-#### Global configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `name` | `sACN source` | `MIDIMonster` | sACN source name |
-| `cid` | `0xAA 0xBB 0xCC` ... | `MIDIMonster` | Source CID (16 bytes) |
-| `bind` | `0.0.0.0 5568` | none | Binds a network address to listen for data. This option may be set multiple times, with each descriptor being assigned an index starting from 0 to be used with the `interface` instance configuration option. At least one descriptor is required for transmission. |
-
-#### Instance configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `universe` | `0` | none | Universe identifier |
-| `interface` | `1` | `0` | The bound address to use for data input/output |
-| `priority` | `100` | none | The data priority to transmit for this instance. Setting this option enables the instance for output and includes it in the universe discovery report. |
-| `destination` | `10.2.2.2` | Universe multicast | Destination address for unicast output. If unset, the multicast destination for the specified universe is used. |
-| `from` | `0xAA 0xBB` ... | none | 16-byte input source CID filter. Setting this option filters the input stream for this universe. |
-| `unicast` | `1` | `0` | Prevent this instance from joining its universe multicast group |
-
-Note that instances accepting multicast input also process unicast frames directed at them, while
-instances in `unicast` mode will not receive multicast frames.
-
-#### Channel specification
-
-A channel is specified by it's universe index. Channel indices start at 1 and end at 512.
-
-Example mapping:
-```
-sacn1.231 < sacn2.123
-```
-
-A 16-bit channel (spanning any two normal channels in the same universe) may be mapped with the syntax
-```
-sacn.1+2 > sacn2.5+123
-```
-
-A normal channel that is part of a wide channel can not be mapped individually.
-
-#### Known bugs / problems
-
-The DMX start code of transmitted and received universes is fixed as `0`.
-
-The (upper) limit on packet transmission rate mandated by section 6.6.1 of the sACN specification is disregarded.
-The rate of packet transmission is influenced by the rate of incoming mapped events on the instance.
-
-Universe synchronization is currently not supported, though this feature may be implemented in the future.
-
-To use multicast input, all networking hardware in the path must support the IGMPv2 protocol.
-
-The Linux kernel limits the number of multicast groups an interface may join to 20. An instance configured
-for input automatically joins the multicast group for its universe, unless configured in `unicast` mode.
-This limit can be raised by changing the kernel option in `/proc/sys/net/ipv4/igmp_max_memberships`.
-
-### The `midi` backend
-
-The MIDI backend provides read-write access to the MIDI protocol via virtual ports.
-
-#### Global configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `name` | `MIDIMonster` | none | MIDI client name |
-
-#### Instance configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `read` | `20:0` | none | MIDI device to connect for input |
-| `write` | `DeviceName` | none | MIDI device to connect for output |
-
-MIDI device names may either be `client:port` portnames or prefixes of MIDI device names.
-Run `aconnect -i` to list input ports and `aconnect -o` to list output ports.
-
-Each instance also provides a virtual port, so MIDI devices can also be connected with `aconnect <sender> <receiver>`.
-
-#### Channel specification
-
-The MIDI backend supports multiple channel types
-
-* `cc` - Control Changes
-* `note` - Note On/Off messages
-* `nrpn` - NRPNs (not yet implemented)
-
-A channel is specified using `<type><channel>.<index>`.
+### Multi-channel mapping
-Example mapping:
-```
-midi1.cc0.9 > midi2.note1.4
-```
-#### Known bugs / problems
-
-Currently, no Note Off messages are sent (instead, Note On messages with a velocity of 0 are
-generated, which amount to the same thing according to the spec). This may be implemented as
-a configuration option at a later time.
-
-NRPNs are not yet fully implemented, though rudimentary support is in the codebase.
-
-The channel specification syntax is currently a bit clunky.
-
-### The `evdev` backend
-
-This backend allows using Linux `evdev` devices such as mouses, keyboards, gamepads and joysticks
-as input and output devices. All buttons and axes available to the Linux system are mappable.
-Output is provided by the `uinput` kernel module, which allows creation of virtual input devices.
-This functionality may require elevated privileges (such as special group membership or root access).
-
-#### Global configuration
-
-This backend does not take any global configuration.
-
-#### Instance configuration
-
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|---------------|-------------------------------------------------------|
-| `device` | `/dev/input/event1` | none | `evdev` device to use as input device |
-| `input` | `Xbox Wireless` | none | Presentation name of evdev device to use as input (prefix-matched) |
-| `output` | `My Input Device` | none | Output device presentation name. Setting this option enables the instance for output |
-| `exclusive` | `1` | `0` | Prevent other processes from using the device |
-| `id` | `0x1 0x2 0x3` | none | Set output device bus identification (Vendor, Product and Version), optional |
-| `axis.AXISNAME`| `34300 0 65536 255 4095` | none | Specify absolute axis details (see below) for output. This is required for any absolute axis to be output.
-
-The absolute axis details configuration (e.g. `axis.ABS_X`) is required for any absolute axis on output-enabled
-instances. The configuration value contains, space-separated, the following values:
-
-* `value`: The value to assume for the axis until an event is received
-* `minimum`: The axis minimum value
-* `maximum`: The axis maximum value
-* `fuzz`: A value used for filtering the input stream
-* `flat`: An offset, below which all deviations will be ignored
-* `resolution`: Axis resolution in units per millimeter (or units per radian for rotational axes)
-
-For real devices, all of these parameters for every axis can be found by running `evtest` on the device.
-
-#### Channel specification
+To make mapping large contiguous sets of channels easier, channel names may contain
+expressions of the form `{<start>..<end>}`, with *start* and *end* being positive integers
+delimiting a range of channels. Multiple such expressions may be used in one channel
+specification, with the rightmost expression being incremented (or decremented) first for
+evaluation.
-A channel is specified by its event type and event code, separated by `.`. For a complete list of event types and codes
-see the [kernel documentation](https://www.kernel.org/doc/html/v4.12/input/event-codes.html). The most interesting event types are
+Both sides of a multi-channel assignment need to have the same number of channels, or one
+side must have exactly one channel.
-* `EV_KEY` for keys and buttons
-* `EV_ABS` for absolute axes (such as Joysticks)
-* `EV_REL` for relative axes (such as Mouses)
+Example multi-channel mapping:
-The `evtest` tool is useful to gather information on devices active on the local system, including names, types, codes
-and configuration supported by these devices.
-
-Example mapping:
```
-ev1.EV_KEY.KEY_A > ev1.EV_ABS.ABS_X
+instance-a.channel{1..10} > instance-b.{10..1}
```
-Note that to map an absolute axis on an output-enabled instance, additional information such as the axis minimum
-and maximum are required. These must be specified in the instance configuration. When only mapping the instance
-as a channel input, this is not required.
-
-#### Known bugs/problems
-
-Creating an `evdev` output device requires elevated privileges, namely, write access to the system's
-`/dev/uinput`. Usually, this is granted for users in the `input` group and the `root` user.
-
-Input devices may synchronize logically connected event types (for example, X and Y axes) via `EV_SYN`-type
-events. The MIDIMonster also generates these events after processing channel events, but may not keep the original
-event grouping.
-
-Relative axes (`EV_REL`-type events), such as generated by mouses, are currently handled in a very basic fashion,
-generating only the normalized channel values of `0`, `0.5` and `1` for any input less than, equal to and greater
-than `0`, respectively. As for output, only the values `-1`, `0` and `1` are generated for the same interval.
-
-`EV_KEY` key-down events are sent for normalized channel values over `0.9`.
-
-Extended event type values such as `EV_LED`, `EV_SND`, etc are recognized in the MIDIMonster configuration file
-but may or may not work with the internal channel mapping and normalization code.
-
-### The `loopback` backend
-
-This backend allows the user to create logical mapping channels, for example to exchange triggering
-channels easier later. All events that are input are immediately output again on the same channel.
-
-#### Global configuration
-
-All global configuration is ignored.
-
-#### Instance configuration
-
-All instance configuration is ignored
+## Backend documentation
-#### Channel specification
+Every backend includes specific documentation, including the global and instance
+configuration options, channel specification syntax and any known problems or other
+special information. These documentation files are located in the `backends/` directory.
+
+* [`midi` backend documentation](backends/midi.md)
+* [`jack` backend documentation](backends/jack.md)
+* [`winmidi` backend documentation](backends/winmidi.md)
+* [`artnet` backend documentation](backends/artnet.md)
+* [`sacn` backend documentation](backends/sacn.md)
+* [`evdev` backend documentation](backends/evdev.md)
+* [`loopback` backend documentation](backends/loopback.md)
+* [`ola` backend documentation](backends/ola.md)
+* [`osc` backend documentation](backends/osc.md)
+* [`lua` backend documentation](backends/lua.md)
+* [`maweb` backend documentation](backends/maweb.md)
-A channel may have any string for a name.
+## Building
-Example mapping:
-```
-loop.foo < loop.bar123
-```
+This section will explain how to build the provided sources to be able to run
+`midimonster`.
-#### Known bugs / problems
+### Prerequisites
-It is possible to configure loops using this backend. Triggering a loop
-will create a deadlock, preventing any other backends from generating events.
-Be careful with bidirectional channel mappings, as any input will be immediately
-output to the same channel again.
+In order to build the MIDIMonster, you'll need some libraries that provide
+support for the protocols to translate.
-### The `osc` backend
+* `libasound2-dev` (for the ALSA MIDI backend)
+* `libevdev-dev` (for the evdev backend)
+* `liblua5.3-dev` (for the lua backend)
+* `libola-dev` (for the optional OLA backend)
+* `libjack-jackd2-dev` (for the JACK backend)
+* `pkg-config` (as some projects and systems like to spread their files around)
+* `libssl-dev` (for the MA Web Remote backend)
+* A C compiler
+* GNUmake
-This backend offers read and write access to the Open Sound Control protocol,
-spoken primarily by visual interface tools and hardware such as TouchOSC.
+To build for Windows, the package `mingw-w64` provides a cross-compiler that can
+be used to build a subset of the backends as well as the core.
-#### Global configuration
+### Build
-This backend does not take any global configuration.
+For Linux and OSX, just running `make` in the source directory should do the trick.
-#### Instance configuration
+The build process accepts the following parameters, either from the environment or
+as arguments to the `make` invocation:
-| Option | Example value | Default value | Description |
-|---------------|-----------------------|-----------------------|-----------------------|
-| `root` | `/my/osc/path` | none | An OSC path prefix to be prepended to all channels |
-| `bind` | `:: 8000` | none | The host and port to listen on |
-| `destination` | `10.11.12.13 8001` | none | Remote address to send OSC data to. Setting this enables the instance for output. The special value `learn` causes the MIDImonster to always reply to the address the last incoming packet came from. A different remote port for responses can be forced with the syntax `learn@<port>` |
+| Target | Parameter | Default value | Description |
+|---------------|-----------------------|-------------------------------|-------------------------------|
+| build targets | `DEFAULT_CFG` | `monster.cfg` | Default configuration file |
+| build targets | `PLUGINS` | Linux/OSX: `./backends/`, Windows: `backends\` | Backend plugin library path |
+| `install` | `PREFIX` | `/usr` | Install prefix for binaries |
+| `install` | `DESTDIR` | empty | Destination directory for packaging builds |
+| `install` | `DEFAULT_CFG` | empty | Install path for default configuration file |
+| `install` | `PLUGINS` | `$(PREFIX)/lib/midimonster` | Install path for backend shared objects |
+| `install` | `EXAMPLES` | `$(PREFIX)/share/midimonster` | Install path for example configurations |
-Note that specifying an instance root speeds up matching, as packets not matching
-it are ignored early in processing.
+Note that the same variables may have different default values depending on the target. This implies that
+builds that are destined to be installed require those variables to be set to the same value for the
+build and `install` targets.
-Channels that are to be output or require a value range different from the default ranges (see below)
-require special configuration, as their types and limits have to be set.
+Some backends have been marked as optional as they require rather large additional software to be installed,
+for example the `ola` backend. To create a build including these, run `make full`.
-This is done in the instance configuration using an assignment of the syntax
+Backends may also be built selectively by running `make <backendfile>` in the `backends/` directory,
+for example
```
-/local/osc/path = <format> <min> <max> <min> <max> ...
+make jack.so
```
+#### Using the installer
-The OSC path to be configured must only be the local part (omitting a configured instance root).
-
-**format** may be any sequence of valid OSC type characters. See below for a table of supported
-OSC types.
-
-For each component of the path, the minimum and maximum values must be given separated by spaces.
-Components may be accessed in the mapping section as detailed in the next section.
-
-An example configuration for transmission of an OSC message with 2 floating point components with
-a range between 0.0 and 2.0 (for example, an X-Y control), would look as follows:
+For easy installation on Linux, the [installer script](installer.sh) can be used:
```
-/1/xy1 = ff 0.0 2.0 0.0 2.0
+wget https://raw.githubusercontent.com/cbdevnet/midimonster/master/installer.sh ./
+chmod +x ./installer.sh
+./installer.sh
```
-#### Channel specification
+#### Building for packaging or installation
-A channel may be any valid OSC path, to which the instance root will be prepended if
-set. Multi-value controls (such as X-Y pads) are supported by appending `:n` to the path,
-where `n` is the parameter index, with the first (and default) one being `0`.
+For system-wide install or packaging builds, the following steps are recommended:
-Example mapping:
```
-osc1./1/xy1:0 > osc2./1/fader1
+export PREFIX=/usr
+export PLUGINS=$PREFIX/lib/midimonster
+export DEFAULT_CFG=/etc/midimonster/midimonster.cfg
+make clean
+make full
+make install
```
-Note that any channel that is to be output will need to be set up in the instance
-configuration.
-
-#### Supported types & value ranges
-
-OSC allows controls to have individual value ranges and supports different parameter types.
-The following types are currently supported by the MIDImonster:
+Depending on your configuration of `DESTDIR`, the `make install` step may require root privileges to
+install the binaries to the appropriate destinations.
-* **i**: 32-bit signed integer
-* **f**: 32-bit IEEE floating point
-* **h**: 64-bit signed integer
-* **d**: 64-bit double precision floating point
+To create Debian packages, use the debianization and `git-buildpackage` configuration on the `debian/master`
+branch. Simply running `gbp buildpackage` should build a package for the last tagged release.
-For each type, there is a default value range which will be assumed if the channel is not otherwise
-configured using the instance configuration. Values out of a channels range will be clipped.
+#### Building for Windows
-The default ranges are:
+To build for Windows, you still need to compile on a Linux machine (virtual machines work well for this).
-* **i**: `0` to `255`
-* **f**: `0.0` to `1.0`
-* **h**: `0` to `1024`
-* **d**: `0.0` to `1.0`
+In a fresh Debian installation, you will need to install the following packages (using `apt-get install` as root):
-#### Known bugs / problems
+* `build-essential`
+* `pkg-config`
+* `git`
+* `mingw-w64`
-Ping requests are not yet answered. There may be some problems using broadcast output and input.
-
-## Building
-
-This section will explain how to build the provided sources to be able to run
-`midimonster`.
-
-### Prerequisites
-
-In order to build the MIDIMonster, you'll need some libraries that provide
-support for the protocols to translate.
-
-* libasound2-dev (for the MIDI backend)
-* libevdev-dev (for the evdev backend)
-* A C compiler
-* GNUmake
-
-### Build
+Clone the repository and run `make windows` in the project directory.
+This will build `midimonster.exe` as well as a set of backends as DLL files, which you can then copy
+to the Windows machine.
-Just running `make` in the source directory should do the trick.
+Note that some backends have limitations when building on Windows (refer to the backend documentation
+for detailed information).
## Development