rpnout Reference

Format 14-bit MIDI RPN messages

rpnout

Description

Format 14-bit MIDI Registered Parameter Number messages to be transmitted using the midiout object.

Discussion

A Registered Parameter message comprises several groups of bytes to specify a 14-bit parameter number (2 groups for the for the most significant byte of the parameter number (MSB) and one for the least significant byte of the parameter number (LSB)), a 14-bit value (2 groups for the MSB and LSB of the value) or a 7-bit delta value (1 group), followed by a Null Function (2 groups) to terminate changes to the parameter.

Arguments

parameter-channel [list]

Optional

The initial argument is an initial registered parameter number (in the range 0-16383) to be used in parameter changes messages formatted by nrpnout. registered parameter numbers are automatically limited between 0 and 16383. The parameter number can also be expressed as a symbol formatted 'MSB:LSB' (for instance, '1:0' would specify parameter 128). If there is no controller number specified, the initial controller number is 0.

Following the controller number argument is an initial value for the channel number with which to format control messages. If the channel argument is not present, rpnout initially formats control messages on channel 1. In order for this argument to be used, a controller number argument must precede it. The channel number is clipped to the range 1-16.

Attributes

hires [int] (default: 1)

When enabled, rpnout formats high resolution, 14-bit RPN messages for the provided input. If you know that the parameter you are working with only responds to 7-bit values using the MSB, set hires to 0 to avoid inaccurate output from the object. If the parameter you are working with responds to 'high resolution' 7-bit values using an MSB of 0 and a value in the LSB, this setting will have no effect.

running [int] (default: 0)

If running status is enabled, the status byte of all but the first group of bytes in the formatted RPN messages will be eliminated.

Common Box Attributes

Messages

bang

Sends out a registered parameter message using the numbers currently stored in rpnout

int

Arguments

input [int]
The number is a 14-bit registered parameter value to be formatted into a complete MIDI registered parameter number message by rpnout.

  (inlet1)

Arguments

delta [int]
In middle-left inlet: The delta will be formatted into a complete MIDI registered parameter number message by rpnout. Deltas outside of the range -127-127 will be ignored.

  (inlet2)

Arguments

parameter [int]
In middle-right inlet: The number is stored as the registered parameter number of the messages transmitted by rpnout. Parameter numbers outside of the range 0-16383 will be ignored.

  (inlet3)

Arguments

channel [int]
In right inlet: The number is stored as the MIDI channel for the continuous controller message sent out by rpnout. Channel numbers will be clipped to stay within the 1-16 range.

list

Arguments

msb [int]
lsb [int]
A pair of two 7-bit values, most significant byte (MSB) followed by least significant byte (LSB). The 7-bit MSB will be bitshifted and ORd with the 7-bit LSB to specify a 14-bit registered parameter value. The 14-bit value will be formatted into a complete MIDI registered parameter number message by rpnout.

set

Arguments

parameter [list]
An argument between 0 and 16383 ((1 << 14) - 1) will be stored as the registered parameter number of the messages transmitted by rpnout.

The set message also accepts an argument list comprising most signficant byte (MSB) followed by least significant byte (LSB). The 7-bit MSB will be bitshifted and ORd with the 7-bit LSB to specify a 14-bit parameter number. For instance, set 1 0 would specify registered parameter number 128.

The parameter number argument can also be expressed as a symbol formatted 'MSB:LSB'. For instance, set 1:0 would specify registered parameter number 128.

Registered parameter numbers outside of the range 0-16383 will be ignored.

Output

int

When a value is received in the left inlet or 2nd inlet (value or delta), the complete MIDI RPN message is sent out the outlet, byte-by-byte.

See Also

Name Description
midiout
ctlout
rpnin
nrpnin
nrpnout
xctlout
xbendout
xnoteout