fzero~
MSP Reference
Open Help

fzero~

Fundamental frequency and pitch estimator

Description

The fzero~ object estimates the fundamental frequency of an an incoming, monophonic audio signal. It performs multiple layers of wavelet transforms on an incoming vector, comparing the spacing between the peaks in each.

Examples

detecting an f-sharp

Arguments

None.

Attributes

freqmax [int]

The maximum frequency, in Hertz, that the object will report.

freqmin [int]

The minimum frequency, in Hertz, that the object will report.

onsetamp [float]

fzero~ gives a bang or list out the right outlet when a new event crosses this amplitude threshold.

onsetlist [int]

Onset detector output: bang or list(pitch, amplitude)

onsetperiod [atom_long]

This attribute sets the minimum number of samples between reporting any offsets.

Possible values:

'16' ( samples )
'32' ( samples )
'64' ( samples )
'128' ( samples )
'256' ( samples )
'512' ( samples )
'1024' ( samples )
'2048' ( samples )
'4096' ( samples )

onsetpitch [float]

fzero~ gives a bang or list out the right outlet when the frequency changes by this amount, in in MIDI notes.

period [atom_long]

Sets the time period between analyses in samples.

Possible values:

'16' ( samples )
'32' ( samples )
'64' ( samples )
'128' ( samples )
'256' ( samples )
'512' ( samples )
'1024' ( samples )
'2048' ( samples )
'4096' ( samples )

size [atom_long]

Sets the buffer size to specify how many samples are analyzed each time.

Possible values:

'128' ( samples )
'256' ( samples )
'512' ( samples )
'1024' ( samples )
'2048' ( samples )
'4096' ( samples )

threshold [float]

If the peak amplitude of the buffer is below this threshold, then fzero~ will report nothing.

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

signal

audio signal to be analyzed.

Output

bang

Out right outlet: New note onset detected.

float

Out left outlet: Estimated fundamental frequency in Hertz.

Out middle outlet: Peak amplitude of the analysis buffer at the time of the last analysis.

See Also

Name Description
ftom Convert frequency to a MIDI note number
mtof Convert a MIDI note number to frequency
peakamp~ Report the maximum amplitude of a signal
retune~ Ztx-based pitch detection and pitchshift
thresh~ Detect signal above a set level