MIDIOut : Object

Description

a MIDIOut is bound to a specific MIDIEndPoint as defined by the operating system.

Linux users, or any users who require cross-platform compatibility with Linux, should read Linux specific: Connecting and disconnecting ports carefully.

Class Methods

MIDIOut.new(port, uid)

MIDIOut.newByName(deviceName, portName, dieIfNotFound: true)

MIDIOut.findPort(deviceName, portName)

MIDIOut.connect(outport: 0, device: 0)

MIDIOut.disconnect(outport: 0, device: 0)

Inherited class methods

Instance Methods

.sysex(packet)

.latency

.latency = value

Inherited instance methods

Undocumented instance methods

.allNotesOff(chan)

.bend(chan, val: 8192)

.connect(device: 0)

.continue

.control(chan, ctlNum: 7, val: 64)

.disconnect(cuid)

.midiClock

.noteOff(chan, note: 60, veloc: 64)

.noteOn(chan, note: 60, veloc: 64)

.polyTouch(chan, note: 60, val: 64)

.port

.port = value

.program(chan, num: 1)

.reset

.smpte(frames: 0, seconds: 0, minutes: 0, hours: 0, frameRate: 3)

.songPtr(songPtr)

.songSelect(song)

.start

.stop

.touch(chan, val: 64)

.uid

.uid = value

.write(len, hiStatus, loStatus, a: 0, b: 0)

Examples

Using patterns for sending MIDI events

See Pattern Guide 08: Event Types and Parameters: MIDI output for a list of midi commands supported by the 'midi' event type.

Linux specific: Connecting and disconnecting ports

In Linux, the MIDIOut architecture is different from other operating systems.

In macOS and Windows, a MIDIOut instance is bound to a specific destination MIDI device.

SuperCollider in Linux uses the ALSA MIDI layer. ALSA MIDI applications send messages out through a "virtual output port," which is one of the members of MIDIClient.sources.MIDIClient.init;

MIDI Sources:
    MIDIEndPoint("System", "Timer")
    MIDIEndPoint("System", "Announce")
    MIDIEndPoint("Midi Through", "Midi Through Port-0")
    MIDIEndPoint("SuperCollider", "out0")
    MIDIEndPoint("SuperCollider", "out1")

At this point, creating MIDIOut(0) tells SuperCollider that this MIDIOut object should direct messages to MIDIEndPoint("SuperCollider", "out0"). (It seems strange, if you think of SuperCollider sending messages to this MIDI source. It is more accurate to think of SuperCollider sending messages through this port. The port is, then, a source for the rest of the system.)

A MIDIOut(0) object, then, will not reach any destinations by default. The user needs to connect destination devices to the virtual source port, using either a graphical tool such as Qjackctl, or by MIDIOut's connect method.m = MIDIOut(0); // use virtual source port "out0" m.connect(1); // connect to MIDIClient.destinations[1]

MIDIOut: *new optionally takes a second argument, for the uid of the MIDI destination device. If the uid is non-zero, then: 1/ all connections in the ALSA MIDI patchbay are ignored, and 2/ individual messages will be sent directly to the specified device.

MIDIOut: *newByName locates a device by name and populates the uid in the new MIDIOut object. After successful completion, a MIDIOut object created using this method will have a non-zero uid.

Compatibility

• MIDIOut.newByName("device", "port") -- Should be compatible on all systems.
• MIDIOut(index) -- macOS, Windows (index is the device's index in MIDIClient.destinations). Note that this usage is not compatible with Linux! macOS and Windows users should not expect Linux users to be able to run this style of connection.
• MIDIOut(0, MIDIClient.destinations[index].uid) -- Linux only (index is the device's index in MIDIClient.destinations).

macOS specific: Sending MIDI to other applications

Open the Audio MIDI Setup application. Double-click on IAC Driver and check "device is online".

reinitialize:

MIDIClient.init(numIns,numOuts)

The IAC Bus will now appear in MIDIClient.destinations. It will appear first, which means that any code that you have written that addresses the first physical bus as 0 will now have to be changed.

For this reason, it is always safer to find the port by name :MIDIOut.newByName("RemoteSL IN","Port 1");

The IAC Bus will now also appear to other applications.

MIDIMonitor (freeware) can be very useful for troubleshooting:

http://www.snoize.com/MIDIMonitor/

Sysex example

a machinedrum manual say sysex commands should be formatted like this...$f0,$00,$20,$3c,$02,$00,command,...,$f7

and to set the tempo the machinedrum expects this command...$61 | Set tempo ID %0aaaaaaa | Upper bits %0bbbbbbb | Lower bits $f7 | SYSEX end Note: Tempo = %aaaaaaabbbbbbb / 24, max 300 BPM, min 30 BPM

so to create and send a valid set tempo sysex command from SuperCollider to this machinedrum do...MIDIClient.init; m = MIDIOut(0); // Linux users: MIDIOut(0, MIDIClient.destinations[0].uid) m.sysex(Int8Array[0xf0, 0x00, 0x20, 0x3c, 0x02, 0x00, 0x61, 21, 54, 0xf7]);

This will set the tempo to 114.23 bpm. One can calculate the upper and lower 7bit values like this...( var bpm, val, upper, lower; bpm = 114.23; val = (bpm*24).round.asInteger; upper = val&2r11111110000000>>7; lower = val&2r00000001111111; [upper, lower].postln; )

where the resulting 21 and 54 are the same as 2r0010101 and 2r0110110 in binary notation.