omx.4band~
MSP Reference
Open Help

omx.4band~

OctiMax 4-band Compressor

Description

omx.4band~ delivers the signal-processing power of Octimax in a 4-band compressor.

Examples

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] (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

choosePreset

Arguments

preset-number [int]
The word choosePreset , followed by a number in the range 0-2, selects a preset for the 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.

bypass

Arguments

bypass-flag [int]
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.4band~.

gating_threshold

Arguments

release-gate-threshold [float]
The word gating_threshold , 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.

inagc_b1_atk

Arguments

attack-rate-coefficient [int]
The word inagc_b1_atk , 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.

inagc_b1_rel

Arguments

release-rate-coefficient [int]
The word inagc_b1_rel , 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.

inagc_range

Arguments

maximum-dB [int]
The word inagc_range , 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.

mbagc_b1_atk

Arguments

b1attack-rate-coefficient [int]
The word mbagc_b1_atk , 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.

mbagc_b1_drv

Arguments

b1drive-rate-coefficient [int]
The word mbagc_b1_drv , 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.

mbagc_b1_rel

Arguments

b2release-rate-coefficient [int]
The word mbagc_b1_rel , 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.

mbagc_b2_atk

Arguments

b2attack-rate-coefficient [int]
The word mbagc_b2_atk , 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.

mbagc_b2_drv

Arguments

b2drive-rate-coefficient [int]
The word mbagc_b2_drv , 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.

mbagc_b2_rel

Arguments

b2release-rate-coefficient [int]
The word mbagc_b2_rel , 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.

mbagc_b3_atk

Arguments

b3attack-rate-coefficient [int]
The word mbagc_b3_atk , 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.

mbagc_b3_drv

Arguments

b3drive-rate-coefficient [int]
The word mbagc_b3_drv , 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.

mbagc_b3_rel

Arguments

b3release-rate-coefficient [int]
The word mbagc_b3_rel , 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.

mbagc_b4_atk

Arguments

b4attack-rate-coefficient [int]
The word mbagc_b4_atk , 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.

mbagc_b4_drv

Arguments

b4drive-rate-coefficient [int]
The word mbagc_b4_drv , 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.

mbagc_b4_rel

Arguments

b4release-rate-coefficient [int]
The word mbagc_b4_rel , 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.

meterData

The word meterData will cause output (by instantaneous command as opposed to metering-interval described by the meterRate 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

Arguments

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

meters

Arguments

metering-output-flag [int]
The word meters , 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 meterRate 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.

lim_drive

Arguments

pre-peak-limiting-gain [float]
The word lim_drive , followed by a number, sets the overall gain in dB before peak limiting is applied.

ngenabled

Arguments

noise-gate-enable-flag [int]
The word ngenabled , 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. omx.4band~ features two noise gates: one that operates on the entire signal, and one that only affects higher frequencies, such as hiss.

ngthresh1

Arguments

noise-gate-threshold [float]
The word ngthresh1 , followed by a number, sets the threshold level (in dB below full scale) at which the overall noise gate will be engaged.

ngthresh2

Arguments

treble-noise-gate-threshold [float]
The word ngthresh2 , 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.

noisegate

Arguments

dB value [int]
The word noisegate followed by a number which specifies a value in dB, sets the noisegate threshold.

mbagc_range

Arguments

maximum-dB [float]
The word mbagc_range , 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.

outmix1

Arguments

output-gain [float]
The word outmix1 , followed by a number, sets the gain in dB applied to band 1 after compression.

outmix2

Arguments

output-gain [float]
The word outmix2 , followed by a number, sets the gain in dB applied to band 2 after compression.

outmix3

Arguments

output-gain [float]
The word outmix3 , followed by a number, sets the gain in dB applied to band 3 after compression.

outmix4

Arguments

output-gain [float]
The word outmix4 , followed by a number, sets the gain in dB applied to band 4 after compression.

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.

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.5band~ OctiMax 5-band Compressor
omx.comp~ OctiMax Compressor
omx.peaklim~ OctiMax Peak Limiter
MSP Compression Tutorial 4: Compression on Real Instruments MSP Compression Tutorial 4: Compression on Real Instruments
MSP Compression Tutorial 5: Multiband Compression 1 MSP Compression Tutorial 5: Multiband Compression 1
MSP Compression Tutorial 6: Multiband Compression 2 MSP Compression Tutorial 6: Multiband Compression 2