A newer version of Max is available. Click here to access the latest version of the Max documentation

overdrive~

Soft-clipping signal distortion

Description

The overdrive~ object uses a waveshaping function to distort audio signals. It amplifies signals, limiting the maximum value of the signal to +/- 1. Values outside of this range are removed using "soft clipping" somewhat like that of an overdriven tube-based circuit.

Examples

Waveshape a signal similar to an overdriven amplifier

Arguments

drive-factor [float]

Optional

A single number can be provided to set the drive factor. If no argument is provided, the drive factor is set to 1.0.

drive-factor [int]

Integer inputs are converted to float and set the drive factor.

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

int

Arguments

drive-factor [int]
Integer inputs are converted to float and set the drive factor. The drive factor should usually be in the range 1 - 10. Using a factor of 1 creates a linear response without distortion, and higher values increase the distortion. Values less than 1, including negative values, produce very heavily distorted signals. Use with caution.

float

Arguments

drive-factor [float]
In right inlet: The overdrive~ object accepts a floating-point "drive factor". The drive factor should usually be in the range 1.0-10.0. Using a factor of 1.0 creates a linear response without distortion, and higher values increase the distortion. Values less than 1, including negative values, produce very heavily distorted signals. Use with caution, this behavior was originally considered a bug until friends of the object's creator insisted that it should be considered a feature and left intact.)

signal

In left inlet: the signal to be distorted.

In right inlet: the drive factor as a signal value.

Output

signal

The distorted signal.

See Also

Name Description
kink~ Distort a sawtooth waveform
lookup~ Transfer function lookup table