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

gizmo~ Reference

Frequency-domain pitch shifter for pfft~

gizmo~

Description

The gizmo~ object implements a frequency-domain pitch shifter. It works by analyzing the frequency bins of an FFT'd signal, finding the peaks in the spectrum, and shifting them along the frequency axis to transpose the sound.

Examples

gizmo~ shifts the pitch of an incoming sound so you can use it for harmonization effects

Discussion

The gizmo~ object must be used inside a pfft~ with an overlap of 4 or more -- using an overlap of 2 will produce quite audible amplitude modulation. When used outside a pfft~ it does nothing.

Arguments

default-pitch-scalar [float or int]

Optional

A numerical argument will be used as the default pitch shift scalar. The default is 1.0 (no pitch scaling).

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.

jspainterfile [symbol]

JS Painter File

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 [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

clip

Arguments

frequency-clipping-flag (0 or nonzero) [int]
In left inlet: The word clip, followed by a zero or one, disables or enables the clipping of clips any out-of-range peaks caused by transposition rather than of folding them over. The default is off (equivalent to the message clip 0, so the gizmo~ object behaves like a time-domain transposer. Clipping may be turned off to avoid unwanted aliasing, and its use will probably depend on the sound being transposed and the range of transposition.

freqshift

Arguments

frequency-shift [float]
In left inlet: The word freqshift followed by a numerical value representing a positive or negative frequency in Hertz will be used as a frequency offet for the scaled amplitude peaks in the frequency spectrum. This corresponds to a frequency-shift of the transposed signal (see the freqshift~ or fbinshift~ objects for additional information).

signal

In left inlet: The signal present at the left inlet is the real part of a frequencydomain signal coming from a fftin~ object inside a pfft~.

In middle inlet: The signal input to the middle inlet is the imaginary part of a frequency-domain signal coming from a fftin~ object inside a pfft~. Both real and imaginary inputs must be connected for gizmo~ to work.

Output

signal

The output is the pitch-shifted complex signal. The left outlet is the real component, and the right outlet is the imaginary component. These may be connected to the real and imaginary inputs of a fftout~ object inside a pfft~.

See Also

Name Description
Sound Processing Techniques Sound Processing Techniques
fbinshift~ Frequency domain frequency shifter for pfft~
freqshift~ Time-domain frequency shifter
hilbert~ Phase quadrature filter
pitchshift~ Ztx-based real-time pitchshifting
retune~ Ztx-based pitch detection and pitchshift