abl.device.roar~
Three-stage saturator
Description
A three-stage saturation effect with flexible modulation.
Arguments
None.
Attributes
blend[float]
Creates a blend between the first and second stages when in serial, parallel, or mid/side routing mode. [0., 1.]
compressor_amount[float]
Sets the amount of main bus compression. [0., 1.]
compressor_highpass[int]
Activates a highpass filter for the analysis signal used in the compressor's sidechain. This is useful to reduce the amount of gain reduction for low frequency signals.
crossover_high[float]
Sets the frequency of the higher crossover band. [200., 18000.]
crossover_low[float]
Sets the frequency of the lower crossover band. [20., 5000.]
enable_filter_1[int]
Enables/disables filter 1.
enable_filter_2[int]
Enables/disables filter 2.
enable_filter_3[int]
Enables/disables filter 3.
enable_shaper_1[int]
Enables/disables shaper 1.
enable_shaper_2[int]
Enables/disables shaper 2.
enable_shaper_3[int]
Enables/disables shaper 3.
enable_stage_1[int]
Enables/disables stage 1.
enable_stage_2[int]
Enables/disables stage 2.
enable_stage_3[int]
Enables/disables stage 3.
envelope_attack[float]
Sets the envelope attack time in seconds. [0., 0.1]
envelope_filter_frequency[float]
Sets the envelope filter frequency in Hz. [50., 18000.]
envelope_filter_width[float]
Sets the envelope filter bandwidth. [0.5, 9.]
envelope_gain[float]
Sets the amplitude of the envelope follower modulator in dB. [-70.6, 36.]
envelope_release[float]
Sets the envelope release time in seconds. [0.01, 3.]
envelope_threshold[float]
Sets the envelope threshold in dB. [-70.6, 0.]
feedback_amount[float]
Sets the amount of feedback. [0., 1.]
feedback_delay[float]
Sets the delay time of the feedback stage in seconds. [0.001, 0.5]
feedback_frequency[float]
Sets the frequency in Hz of the feedback filter. [50., 18000.]
feedback_gate[int]
Enables/disables the feedback gate. The feedback gate ensures that feedback is silenced once no signal is detected at the input of the object.
feedback_invert[int]
Enables/disables inverting the phase of the feedback signal.
feedback_width[float]
Sets the width of the bandpass filter in the feedback path. [0.5, 9.]
filter_frequency_1[float]
Filter 1 cutoff frequency (Hz). [20., 20000.]
filter_frequency_2[float]
Filter 2 cutoff frequency (Hz). [20., 20000.]
filter_frequency_3[float]
Filter 3 cutoff frequency (Hz). [20., 20000.]
filter_morph_1[float]
Sets the filter's position in its morph cycle. The morph filter can be continuously morphed between low-pass, high-pass, band-pass, and notch filtering. [0., 1.]
filter_morph_2[float]
Sets the filter's position in its morph cycle. The morph filter can be continuously morphed between low-pass, high-pass, band-pass, and notch filtering. [0., 1.]
filter_morph_3[float]
Sets the filter's position in its morph cycle. The morph filter can be continuously morphed between low-pass, high-pass, band-pass, and notch filtering. [0., 1.]
filter_peak_gain_1[float]
Boost or attenuate a specific frequency range for the stage 1 peak filter. [-12., 12.]
filter_peak_gain_2[float]
Boost or attenuate a specific frequency range for the stage 2 peak filter. [-12., 12.]
filter_peak_gain_3[float]
Boost or attenuate a specific frequency range for the stage 3 peak filter. [-12., 12.]
filter_resonance_1[float]
Filter 1 resonance. [0., 1.]
filter_resonance_2[float]
Filter 2 resonance. [0., 1.]
filter_resonance_3[float]
Filter 3 resonance. [0., 1.]
filter_type_1[int]
Filter 1 Type
Possible values:
0 = 'Lowpass'
1 = 'Bandpass'
2 = 'Highpass'
3 = 'Notch'
4 = 'Peak'
5 = 'Morph'
6 = 'Comb'
7 = 'Resampling'
filter_type_2[int]
Filter 2 Type
Possible values:
0 = 'Lowpass'
1 = 'Bandpass'
2 = 'Highpass'
3 = 'Notch'
4 = 'Peak'
5 = 'Morph'
6 = 'Comb'
7 = 'Resampling'
filter_type_3[int]
Filter 3 Type
Possible values:
0 = 'Lowpass'
1 = 'Bandpass'
2 = 'Highpass'
3 = 'Notch'
4 = 'Peak'
5 = 'Morph'
6 = 'Comb'
7 = 'Resampling'
filterpre1[int]
Sets whether the filter processes the input before (1) or after (0) the shaper.
filterpre2[int]
Sets whether the filter processes the input before (1) or after (0) the shaper.
filterpre3[int]
Sets whether the filter processes the input before (1) or after (0) the shaper.
input_gain[float]
Sets the input gain in dB. [-24., 24.]
lfo1waveform[int]
Sets the waveform for the LFO 1 modulator.
Possible values:
0 = 'Sine'
1 = 'Triangle'
2 = 'Square'
3 = 'Ramp up'
4 = 'Ramp down'
lfo2waveform[int]
Sets the waveform for the LFO 2 modulator.
Possible values:
0 = 'Sine'
1 = 'Triangle'
2 = 'Square'
3 = 'Ramp up'
4 = 'Ramp down'
lfo_frequency_1[float]
Sets the LFO 1 frequency in Hz. [0.01, 10.]
lfo_frequency_2[float]
Sets the LFO 2 frequency in Hz. [0.01, 10.]
lfo_morph_1[float]
Sets the amount of morph of the LFO 1 shape. [0., 1.]
lfo_morph_2[float]
Sets the amount of morph of the LFO 2 shape. [0., 1.]
lfo_smooth_1[float]
Sets the amount of smoothing of the LFO 1 shape. [0., 1.]
lfo_smooth_2[float]
Sets the amount of smoothing of the LFO 2 shape. [0., 1.]
mix[float]
Sets the dry/wet mix of the output signal.
modmatrixname[symbol]
Sets the name of the dictionary that contains the modulation matrix state.
noise_frequency[float]
Sets the noise frequency in Hz. [0.01, 10.]
noise_smoothing[float]
Sets the noise smoothing. Only affects noise when in sample and hold mode. [0., 1.]
noise_type[int]
Sets the type of noise used in the noise modulator.
Possible values:
0 = 'Simplex'
1 = 'Wander'
2 = 'Sample and hold'
3 = 'Brown'
output_gain[float]
Sets the gain of the output signal in dB. [-48., 12.]
routing[int]
Sets the stage routing.
Possible values:
0 = 'Single'
1 = 'Serial'
2 = 'Parallel'
3 = 'Multiband'
4 = 'Mid-Side'
5 = 'Feedback'
6 = 'Delay'
shaper_amount_1[float]
Shaper 1 amount. [0., 1.]
shaper_amount_2[float]
Shaper 2 amount. [0., 1.]
shaper_amount_3[float]
Shaper 3 amount. [0., 1.]
shaper_bias_1[float]
Shaper 1 amount. [0., 1.]
shaper_bias_2[float]
Shaper 2 amount. [0., 1.]
shaper_bias_3[float]
Shaper 3 amount. [0., 1.]
shaper_level_1[float]
Shaper 1 level in dB. [-24., 24.]
shaper_level_2[float]
Shaper 2 level in dB. [-24., 24.]
shaper_level_3[float]
Shaper 3 level in dB. [-24., 24.]
shaper_type_1[int]
Shaper 1 Type
Possible values:
0 = 'Soft sine'
1 = 'Hard clip'
2 = 'Bit crusher'
3 = 'Diode clipper'
4 = 'Tube preamp'
5 = 'Half wave rectifier'
6 = 'Full wave rectifier'
7 = 'Polynomial'
8 = 'Fractal'
9 = 'Fold tri'
10 = 'Noise inject'
11 = 'Shards'
shaper_type_2[int]
Shaper 2 Type
Possible values:
0 = 'Soft sine'
1 = 'Hard clip'
2 = 'Bit crusher'
3 = 'Diode clipper'
4 = 'Tube preamp'
5 = 'Half wave rectifier'
6 = 'Full wave rectifier'
7 = 'Polynomial'
8 = 'Fractal'
9 = 'Fold tri'
10 = 'Noise inject'
11 = 'Shards'
shaper_type_3[int]
Shaper 3 Type
Possible values:
0 = 'Soft sine'
1 = 'Hard clip'
2 = 'Bit crusher'
3 = 'Diode clipper'
4 = 'Tube preamp'
5 = 'Half wave rectifier'
6 = 'Full wave rectifier'
7 = 'Polynomial'
8 = 'Fractal'
9 = 'Fold tri'
10 = 'Noise inject'
11 = 'Shards'
tone_amount[float]
A positive tone amount boosts high frequencies and attenuates low frequencies when the amount. For negative tone amounts, high frequencies are attenuated and low frequencies are boosted. [-1., 1.]
tone_color_compensation[int]
Compensate the effect of the Tone attribute by applying an inverted version of the same filter to the output. When tone_color_compensation 1, positive Tone values are attenuated before the Shaper and then boosted again at the output to prevent high frequencies from distorting. When tone_color_compensation 0, negative Tone values boost low frequencies before the Shaper, while positive values boost high frequencies.
tone_frequency[float]
Sets the tone frequency for the low shelving filter used in tone control. [80., 2000.]
ins[symbol]
Declares additional inlets that can be used to control float-type attributes at either event or signal rate. Any declared attributes already mapped to inlets will be ignored. This attribute can only be set when the object is instantiated.
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. 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'
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.
Aliases: patching_position, patching_size
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.
Aliases: presentation_position, presentation_size
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'
valuepopup[int]: 0
For objects with single values, enabling valuepopup will display the object's current value in a popup caption when the mouse is over the object or it is being changed with the mouse.
valuepopuplabel[int]: 0
Sets the source of a text label shown in a value popup caption.
Possible values:
0 = 'None'
1 = 'Hint'
2 = 'Scripting Name'
3 = 'Parameter Long Name'
4 = 'Parameter Short Name'
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
float
Function depends on inlet
getmod
The modulation matrix state will be output as a dictionary from the third outlet of the object.
mod
Sets a modulation source, target, and amount.
Available sources are: 'lfo1', 'lfo2', 'env', and 'noise'. Modulation targets are 'input',
'tone_amount', 'tone_frequency', 'blend', 'stage1_amount', 'stage1_bias', 'stage1_level',
'stage1_frequency', 'stage1_resonance', 'stage1_morph', 'stage1_peak', 'stage2_amount', 'stage2_bias',
'stage2_level', 'stage2_frequency', 'stage2_resonance', 'stage2_morph',
'stage2_peak', 'stage3_amount', 'stage3_bias', 'stage3_level', 'stage3_frequency', 'stage3_resonance',
'stage3_morph', 'stage3_peak', 'lfo1_rate', 'lfo1_morph', 'lfo2_rate', 'lfo2_morph', 'noise_rate',
'feedback_amount', 'feedback_time','feedback_frequency', 'feedback_bandwidth', 'output', and 'drywet'.
reset
Reset
signal
Function depends on inlet
See Also
| Name | Description |
|---|---|
| abl.device.redux~ | Downsampling and bit-reduction effect |
| abl.dsp.saturator~ | Saturator |
| abl.dsp.waveshaper~ | Waveshaper |