rpnin

Output received RPN values

Description

Output the value from a specific Registered Parameter Number (RPN) and MIDI channel.

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), optionally followed by a Null Function (2 groups) to terminate changes to the parameter.

Arguments

param-channel [list]

Optional

The initial argument is a single registered parameter number (in the range 0-16383) to be recognized by rpnin. 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 parameter number, or if the argument is a negative number, rpnin recognizes all registered parameter numbers. If a single parameter number is specified in the argument, the outlet which normally sends the parameter number is unnecessary, and is not created.

Following the controller number argument is a single channel number on which to receive parameter messages. If the channel argument is not present, rpnin receives parameter messages on all channels. In order for this argument to be used, a parameter number argument must precede it. To specify a channel number without specifying a parameter number, use -1 for the parameter number. The channel number is clipped to the range 1-16.

Attributes

hires [int] (default: 1)

When enabled, rpnin expects high resolution, 14-bit values from the registered parameter. If you know that the parameter you are monitoring only transmits 7-bit values using the MSB, set hires to 0 to avoid inaccurate output from the object. If the parameter you are monitoring transmits 'high resolution' 7-bit values using an MSB of 0 and a value in the LSB, this setting will have no effect.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

int

Arguments

input [int]
The numbers are individual bytes of a MIDI message stream, received from an object such as midiin.

list

Arguments

input [list]
The numbers are bytes of a MIDI message stream, received from an object such as midiin.

set

Arguments

parameter [int]
The message set without any arguments, or with an argument of -1, will cause rpnin to output incoming 14-bit MIDI registered parameter messages from any registered parameter. An argument between 0 and 16383 ((1 << 14) - 1) will cause rpnin to only output incoming 14-bit MIDI registered parameter messages from the parameter specified.

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.

Output

int

Out left outlet: The number is the value (if specified) of an incoming MIDI RPN message as a single 14-bit value. For any RPN message, either value or delta will be specified, but not both.

Out 2nd outlet: The number is the delta (if specified) of an incoming MIDI RPN message as a single 7-bit value. For any RPN message, either value or delta will be specified, but not both.

If a specific parameter number is not specified as an argument, the parameter number is sent out the 2nd outlet as a single 14-bit value.

If a specific channel number is not included in the argument, the channel number is sent out an additional, right, outlet.

See Also

Name Description
midiin Output raw MIDI data
ctlin Output received MIDI control values
rpnout Format 14-bit MIDI RPN messages
nrpnin Output received NRPN values
nrpnout Format 14-bit MIDI NRPN messages
xctlin Output received 14-bit MIDI control values
xbendin Interpret extra precision MIDI pitch bend values
xnotein Interpret MIDI note messages with release velocity