Package MSP

omx.peaklim~

OctiMax Peak Limiter

Description

omx.peaklim~ is a peak-limiter which allows for the specified control of signal amplitude.

Arguments

None.

Attributes

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

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

background[int]: 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]: 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]: 0

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

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

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

position[2 floats]
write-only

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]: 0

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

presentation_rect[4 floats]: 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]
write-only

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]
write-only

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[4 floats]

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

textjustification[int]

Sets the justification for the object's text. 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

bypass

The word bypass followed by a non-zero number will output the dry unchanged input signal straight out the outlet without any processing; followed by a 0, will output the signal effected by omx.peaklim~.

Arguments:
  • bypass-flag [int]

ingain

The word ingain , followed by a number 0-100, sets the gain (-24 to +24 dB) applied to the signal before limiting.

Arguments:
  • pre-limiter-gain [float]

meterData

When metering is on, the word meterData will cause a list of two values to be sent from the rightmost outlet at a rate specified by the meterRate message . These values describe the gain reduction in dB currently applied to the two input signals.

meterRate

The word meterRate , followed by a number, specifies the interval (in milliseconds) at which the meter data described above will be sent.

Arguments:
  • data-output-interval [int]

meters

The word meters , followed by a 1 or 0, turns the metering output on or off. Whe N metering is on, a list of two values will be sent from the rightmost outlet at a rate specified by the meterRate message . These values describe the gain reduction in dB currently applied to the two input signals.

Arguments:
  • metering-flag [int]

mode

The word mode , followed by a number, sets the limiter response mode as follows: 0 = punchy, 1 = smooth. Punchy response yields extremely short attack and release times, useful for transparent limiting, or to create loudness. However, if over-used, intermodulation distortion may result. Smooth response uses longer attack and release times. The result is still a fast look-ahead limiter, but with less intermodulation distortion and less punch.

Arguments:
  • response-mode-flag [int]

outgain

The word outgain , followed by a number (0-100), sets the gain (-24 to +24 dB) applied to the signal after limiting.

Arguments:
  • post-limiter-gain [float]

saveSettings

The word saveSettings causes all parameter values to be sent out the third outlet.

signal

Audio input, the signal or pair of signals to be compressed.

threshold

The word threshold , followed by a number (0-100), sets the limiter threshold (-24 to +24 dB below full scale). When the input signal level exceeds this threshold, it will be attenuated as necessary to keep the level below the threshold.

Arguments:
  • limiter-threshold [float]

Output

list

Out third outlet: parameter values in response to saveSettings message.

Out fourth outlet: meter data. When metering is turned on, lists of values will be output that describe various internal levels. See the description of the meters message.

signal

Out leftmost two outlets: the input signals (if present), with dynamics processing applied.

See Also

Name Description
omx.4band~ OctiMax 4-band Compressor
omx.5band~ OctiMax 5-band Compressor
omx.comp~ OctiMax Compressor