Package MSP

normalize~

Scale on the basis of maximum amplitude

Description

normalize~ performs real-time normalization of its input by multiplying each input sample value by a scaling factor - computed as the maximum output value (sent either as a signal or a float in the right inlet) over the maximum signal input value received thus far.

Discussion

You can change the maximum input value with the reset message or with a float in the left input. If no argument follows "reset" the new maximum input value (and the initial maximum input value) is 0.000001.

Arguments

initial-maximum-output-amplitude[float]
optional

The initial maximum output amplitude. The default is 1.

Attributes

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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'

hidden[int]: 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]: 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.

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

int

Converted to float .

Arguments:
  • maximum-output-amplitude [int]

float

In right inlet: The maximum output amplitude may be sent as a float instead of a signal . If a signal is connected to the right inlet, a float received in the right inlet is ignored.

Arguments:
  • maximum-output-amplitude [float]

reset

In left inlet: The word reset , followed by a number, resets the maximum input amplitude to the number. If no number follows reset , or if the number is 0, the maximum input amplitude is set to 0.000001.

Arguments:
  • maximum-input-amplitude [float]

signal

In left inlet: The input signal is normalized -- scaled so that its peak amplitude is equal to a specified maximum.

In right inlet: The maximum output amplitude; an over-all scaling of the output.

Output

signal

The input signal is scaled by the maximum output amplitude divided by the maximum input amplitude.

See Also

Name Description
*~ Multiply two signals