omx.4band~
OctiMax 4-band Compressor
Description
omx.4band~ delivers the signal-processing power of Octimax in a 4-band compressor.
Arguments
None.
Attributes
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]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, 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'
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]
JS Painter File
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 omx.4band~.
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- bypass-flag
[int]
choosePreset
The word omx.4band~ object. These presets are to be considered "starting points" and should be tweaked for your particular purpose or desired sound. The preset options are:
0: Standard - Appropriate for anything, all genres of music, movies, television viewing, etc.
1; Pop - Great for any modern genre including rock, country, trance.
2; Movies - Similar to standard but optimized for dynamic movie soundtracks.
- preset-number
[int]
gating_threshold
The word
, followed by a number, sets the release gate threshold (in dB below full scale). When the signal is below this threshold, the release time of the compressor will be slowed by a factor of 3.- release-gate-threshold
[float]
inagc_b1_atk
The word
, followed by a number, sets the attack rate for the input compressor. The attack rate determines how quickly the compressor applies gain reduction. The value range is 0-150 on a logarithmic scale, with larger values indicating faster attack.- attack-rate-coefficient
[int]
inagc_b1_rel
The word
, followed by a number, sets the release rate for the input compressor. The release rate determines how quickly the compressor returns to unity gain. The value range is 0-150 on a logarithmic scale, with larger values indicating faster release.- release-rate-coefficient
[int]
inagc_range
The word
, followed by a number, sets the maximum amount of gain in dB applied by the input compressor . The compression ratio is fixed at infinity:1.- maximum-dB
[int]
lim_drive
The word
, followed by a number, sets the overall gain in dB before peak limiting is applied.- pre-peak-limiting-gain
[float]
mbagc_b1_atk
The word
, followed by a number, sets the attack rate for band 1. The attack rate determines how quickly the compressor applies gain reduction. The value range is 0-150 on a logarithmic scale, with larger values indicating faster attack.- b1attack-rate-coefficient
[int]
mbagc_b1_drv
The word
, followed by a number, sets the gain in dB applied to band 1 before compression. Increasing the drive for a particular band applies more compression to those frequencies.- b1drive-rate-coefficient
[int]
mbagc_b1_rel
The word
, followed by a number, sets the release rate for band 1. The release rate determines how quickly the compressor returns to unity gain. The value range is 0-150 on a logarithmic scale, with larger values indicating faster release.- b2release-rate-coefficient
[int]
mbagc_b2_atk
The word
, followed by a number, sets the attack rate for band 2. The attack rate determines how quickly the compressor applies gain reduction. The value range is 0-150 on a logarithmic scale, with larger values indicating faster attack.- b2attack-rate-coefficient
[int]
mbagc_b2_drv
The word
, followed by a number, sets the gain in dB applied to band 2 before compression. Increasing the drive for a particular band applies more compression to those frequencies.- b2drive-rate-coefficient
[int]
mbagc_b2_rel
The word
, followed by a number, sets the release rate for band 2. The release rate determines how quickly the compressor returns to unity gain. The value range is 0-150 on a logarithmic scale, with larger values indicating faster release.- b2release-rate-coefficient
[int]
mbagc_b3_atk
The word
, followed by a number, sets the attack rate for band 3. The attack rate determines how quickly the compressor applies gain reduction. The value range is 0-150 on a logarithmic scale, with larger values indicating faster attack.- b3attack-rate-coefficient
[int]
mbagc_b3_drv
The word
, followed by a number, sets the gain in dB applied to band 3 before compression. Increasing the drive for a particular band applies more compression to those frequencies.- b3drive-rate-coefficient
[int]
mbagc_b3_rel
The word
, followed by a number, sets the release rate for band 3. The release rate determines how quickly the compressor returns to unity gain. The value range is 0-150 on a logarithmic scale, with larger values indicating faster release.- b3release-rate-coefficient
[int]
mbagc_b4_atk
The word
, followed by a number, sets the attack rate for band 4. The attack rate determines how quickly the compressor applies gain reduction. The value range is 0-150 on a logarithmic scale, with larger values indicating faster attack.- b4attack-rate-coefficient
[int]
mbagc_b4_drv
The word
, followed by a number, sets the gain in dB applied to band 4 before compression. Increasing the drive for a particular band applies more compression to those frequencies.- b4drive-rate-coefficient
[int]
mbagc_b4_rel
The word
, followed by a number, sets the release rate for band 4. The release rate determines how quickly the compressor returns to unity gain. The value range is 0-150 on a logarithmic scale, with larger values indicating faster release.- b4release-rate-coefficient
[int]
mbagc_range
The word
, followed by a number, sets the maximum amount of gain in dB applied by the multiband compressor. This affects all four frequency bands. The compression ratio is fixed at infinity:1.- maximum-dB
[float]
meterData
The word
will cause output (by instantaneous command as opposed to metering-interval described by the message) of values which describe the current state of various internal levels of the compressor, and can be used to drive GUI objects to provide visual feedback.
meterRate
The word
, followed by a number, specifies the interval (in milliseconds) at which the meter data described above will be sent.- output-interval
[int]
meters
The word
, followed by a 1 or 0, turns the metering output on or off. When metering is on, a list of values will be sent from the rightmost outlet at a rate specified by the message. These values describe the current state of various internal levels of the compressor, and can be used to drive GUI objects to provide visual feedback.- metering-output-flag
[int]
ngenabled
The word omx.4band~ features two noise gates: one that operates on the entire signal, and one that only affects higher frequencies, such as hiss.
, followed by a 1 or 0, turns the noise gate on or off. A noise gate is effective for reducing background hiss when no other signal is present.- noise-gate-enable-flag
[int]
ngthresh1
The word
, followed by a number, sets the threshold level (in dB below full scale) at which the overall noise gate will be engaged.- noise-gate-threshold
[float]
ngthresh2
The word
, followed by a number, sets the threshold level (in dB below full scale) at which a noise gate will be applied to the treble frequencies only.- treble-noise-gate-threshold
[float]
noisegate
The word
followed by a number which specifies a value in dB, sets the noisegate threshold.- dB value
[int]
outmix1
The word
, followed by a number, sets the gain in dB applied to band 1 after compression.- output-gain
[float]
outmix2
The word
, followed by a number, sets the gain in dB applied to band 2 after compression.- output-gain
[float]
outmix3
The word
, followed by a number, sets the gain in dB applied to band 3 after compression.- output-gain
[float]
outmix4
The word
, followed by a number, sets the gain in dB applied to band 4 after compression.- output-gain
[float]
saveSettings
The word
causes all parameter values to be sent out the third outlet.
signal
Audio input, the signal or pair of signals to be compressed.
Output
list
Out third outlet: parameter values in response to
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 message.
signal
Out leftmost two outlets: the input signals (if present), with dynamics processing applied.
See Also
Name | Description |
---|---|
omx.5band~ | OctiMax 5-band Compressor |
omx.comp~ | OctiMax Compressor |
omx.peaklim~ | OctiMax Peak Limiter |