com.jsyn.unitgen

Class PitchDetector

java.lang.Object

com.jsyn.unitgen.UnitGenerator

com.jsyn.unitgen.PitchDetector

public class PitchDetector
extends UnitGenerator

Estimate the fundamental frequency of a monophonic signal. Analyzes an input signal and outputs an estimated period in frames and a frequency in Hertz. The frequency is frameRate/period. The confidence tells you how accurate the estimate is. When the confidence is low, you should ignore the period. You can use a CompareUnit and a LatchUnit to hold values that you are confident of.

Note that a stable monophonic signal is required for accurate pitch tracking.

Field Summary

Fields

Modifier and Type	Field and Description
UnitOutputPort	confidence
UnitOutputPort	frequency
UnitInputPort	input
UnitOutputPort	period
UnitOutputPort	updated

Fields inherited from class com.jsyn.unitgen.UnitGenerator

FALSE, TRUE

Constructor Summary

Constructors

Constructor and Description
PitchDetector()

Method Summary

Methods

Modifier and Type	Method and Description
SignalCorrelator	createSignalCorrelator()
void	generate(int start, int limit) Perform essential synthesis function.
float[]	getDiffs() For debugging only.

Methods inherited from class com.jsyn.unitgen.UnitGenerator

addPort, addPort, convertHalfLifeToMultiplier, flattenOutputs, generate, getCircuit, getFramePeriod, getFrameRate, getPortByName, getPorts, getSynthesisEngine, getSynthesizer, getTopUnit, getUnitGenerator, isEnabled, pullData, setCircuit, setEnabled, setFrameRate, setPort, setSynthesisEngine, start, start, stop, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

input

public UnitInputPort input

period

public UnitOutputPort period

confidence

public UnitOutputPort confidence

frequency

public UnitOutputPort frequency

updated

public UnitOutputPort updated

Constructor Detail

PitchDetector

public PitchDetector()

Method Detail

createSignalCorrelator

public SignalCorrelator createSignalCorrelator()

generate

public void generate(int start,
            int limit)

Description copied from class: UnitGenerator

Perform essential synthesis function.

Specified by:

generate in class UnitGenerator

Parameters:

start - offset into port buffers

limit - limit offset into port buffers for loop

getDiffs

public float[] getDiffs()

For debugging only.

Returns:

internal array of correlation results.