mc.fzero~ Reference

Fundamental frequency and pitch estimator (multichannel)

mc.fzero~

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.

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

Multichannel Group Attributes

Messages

signal

audio signal to be analyzed.

Multichannel Group Messages

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
mtof
peakamp~
retune~
thresh~