abl.dsp.modulator~
Modulation signal generator
Description
A modulator that morphs between basic shapes.
Arguments
frequency[number]
optional
Frequency
phase[number]
optional
Phase
shape[number]
optional
Shape
fold[number]
optional
Fold
Attributes
fold[float]
Fold [0., 1.]
frequency[float]
Sets the frequency of the modulator (in Hz). [0.01, 200.]
fx1[float]
Apply a transformer to the modulator. [0., 1.]
fx1_type[int]
Sets the type of the first modulator transformation.
Possible values:
0 = 'None'
(
None
)
No transformation
1 = 'Offset'
(
Offset
)
Offsets the input
2 = 'Attenuverter'
(
Attenuverter
)
Scales the input
3 = 'Gate'
(
Gate
)
Passes the input through for certain amount of time
4 = 'Skew unipolar'
(
Skew unipolar
)
Skews values towards -1 or 1
5 = 'Skew bipolar'
(
Skew bipolar
)
Skews values towards 0 or -1 and 1.
6 = 'Unipolarizer'
(
Unipolarizer
)
Restricts output to be unipolar. This transformer interpolates between three behaviors:
scaling from [-1, 1] to [0, 1], half-wave rectifying, and fully rectifying.
7 = 'Quantizer'
(
Quantizer
)
Quantizes steps to have equal height.
8 = 'Sample and hold'
(
Sample and hold
)
Captures and holds a value for a certain length of time
9 = 'Independent sample and hold'
(
Independent sample and hold
)
Captures and holds a value for a certain length of time, independent of the modulator's
frequency
10 = 'Clipper'
(
Clipper
)
Hard clips a signal in various ways. The transformer switches between three behaviors
depending on the macro value:
Less than 0.5: everything below threshold is zero, and the remainder is scaled
Equal to 0.5: no clipping
Greater than 0.5: boosts and clamps everything above abs(x) = 1
11 = 'Fade in'
(
Fade in
)
Fades the signal out over the length of the ramp. To restart the ramp, use the reset
message.
12 = 'Fade out'
(
Fade out
)
Fades the signal out over the length of the ramp. To restart the ramp, use the reset
message.
13 = 'Slew down'
(
Slew down
)
Limits the speed at which values decrease
14 = 'Slew up'
(
Slew up
)
Limits the speed at which values increase
15 = 'Slew up and down'
(
Slew up and down
)
Limits the speed at which values increase or decrease
16 = 'Triggered envelope'
(
Triggered envelope
)
Turns the input signal into an exponentially decaying envelope. The decay time is
controlled by the associated FX macro value. The envelope is triggered when a zero
crossing is detected in the input signal.
17 = 'Comparator'
(
Comparator
)
Outputs -1 or 1 depending on whether the input threshold has been reached. The
associated FX macro value sets the threshold.
fx2[float]
Apply a second transformer to the modulator. [0., 1.]
fx2_type[int]
Sets the type of the second modulator transformation.
Possible values:
0 = 'None'
(
None
)
No transformation
1 = 'Offset'
(
Offset
)
Offsets the input
2 = 'Attenuverter'
(
Attenuverter
)
Scales the input
3 = 'Gate'
(
Gate
)
Passes the input through for certain amount of time
4 = 'Skew unipolar'
(
Skew unipolar
)
Skews values towards -1 or 1
5 = 'Skew bipolar'
(
Skew bipolar
)
Skews values towards 0 or -1 and 1.
6 = 'Unipolarizer'
(
Unipolarizer
)
Restricts output to be unipolar. This transformer interpolates between three behaviors:
scaling from [-1, 1] to [0, 1], half-wave rectifying, and fully rectifying.
7 = 'Quantizer'
(
Quantizer
)
Quantizes steps to have equal height.
8 = 'Sample and hold'
(
Sample and hold
)
Captures and holds a value for a certain length of time
9 = 'Independent sample and hold'
(
Independent sample and hold
)
Captures and holds a value for a certain length of time, independent of the modulator's
frequency
10 = 'Clipper'
(
Clipper
)
Hard clips a signal in various ways. The transformer switches between three behaviors
depending on the macro value:
Less than 0.5: everything below threshold is zero, and the remainder is scaled
Equal to 0.5: no clipping
Greater than 0.5: boosts and clamps everything above abs(x) = 1
11 = 'Fade in'
(
Fade in
)
Fades the signal out over the length of the ramp. To restart the ramp, use the reset
message.
12 = 'Fade out'
(
Fade out
)
Fades the signal out over the length of the ramp. To restart the ramp, use the reset
message.
13 = 'Slew down'
(
Slew down
)
Limits the speed at which values decrease
14 = 'Slew up'
(
Slew up
)
Limits the speed at which values increase
15 = 'Slew up and down'
(
Slew up and down
)
Limits the speed at which values increase or decrease
16 = 'Triggered envelope'
(
Triggered envelope
)
Turns the input signal into an exponentially decaying envelope. The decay time is
controlled by the associated FX macro value. The envelope is triggered when a zero
crossing is detected in the input signal.
17 = 'Comparator'
(
Comparator
)
Outputs -1 or 1 depending on whether the input threshold has been reached. The
associated FX macro value sets the threshold.
phase[float]
Sets the normalized phase. [0., 1.]
shape[float]
Shape [0., 1.]
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
reset
Reset
signal
Function depends on inlet
See Also
| Name | Description |
|---|---|
| abl.dsp.alternate~ | Alternating modulator |
| abl.dsp.euclid~ | Euclidean rhythm ramp generator |
| abl.dsp.pulsate~ | Random pulse emitter |
| abl.dsp.ramp~ | Ramp generator |
| abl.dsp.transform~ | Signal transformer |
| abl.dsp.wander~ | Wandering modulator |