be.tarsos.dsp.pitch

Enum PitchProcessor.PitchEstimationAlgorithm

java.lang.Object

java.lang.Enum<PitchProcessor.PitchEstimationAlgorithm>

be.tarsos.dsp.pitch.PitchProcessor.PitchEstimationAlgorithm

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PitchProcessor.PitchEstimationAlgorithm>

Enclosing class:

PitchProcessor

public static enum PitchProcessor.PitchEstimationAlgorithm
extends java.lang.Enum<PitchProcessor.PitchEstimationAlgorithm>

A list of pitch estimation algorithms.

Author:

Joren Six

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMDF A pitch extractor that extracts the Average Magnitude Difference (AMDF) from an audio buffer.
DYNAMIC_WAVELET An implementation of a dynamic wavelet pitch detection algorithm (See DynamicWavelet), described in a paper by Eric Larson and Ross Maddox "Real-Time Time-Domain Pitch Tracking Using Wavelets
FFT_PITCH Returns the frequency of the FFT-bin with most energy.
FFT_YIN A YIN implementation with a faster FastYin for the implementation.
MPM See McLeodPitchMethod.
YIN See Yin for the implementation.

Method Summary

Modifier and Type	Method and Description
PitchDetector	getDetector(float sampleRate, int bufferSize) Returns a new instance of a pitch detector object based on the provided values.
static PitchProcessor.PitchEstimationAlgorithm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PitchProcessor.PitchEstimationAlgorithm[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YIN

public static final PitchProcessor.PitchEstimationAlgorithm YIN

See Yin for the implementation. Or see the YIN article.

MPM

public static final PitchProcessor.PitchEstimationAlgorithm MPM

See McLeodPitchMethod. It is described in the article "A Smarter Way to Find Pitch".

FFT_YIN

public static final PitchProcessor.PitchEstimationAlgorithm FFT_YIN

A YIN implementation with a faster FastYin for the implementation. Or see the YIN article.

DYNAMIC_WAVELET

public static final PitchProcessor.PitchEstimationAlgorithm DYNAMIC_WAVELET

An implementation of a dynamic wavelet pitch detection algorithm (See DynamicWavelet), described in a paper by Eric Larson and Ross Maddox "Real-Time Time-Domain Pitch Tracking Using Wavelets

FFT_PITCH

public static final PitchProcessor.PitchEstimationAlgorithm FFT_PITCH

Returns the frequency of the FFT-bin with most energy.

AMDF

public static final PitchProcessor.PitchEstimationAlgorithm AMDF

A pitch extractor that extracts the Average Magnitude Difference (AMDF) from an audio buffer. This is a good measure of the Pitch (f0) of a signal.

Method Detail

values

public static PitchProcessor.PitchEstimationAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PitchProcessor.PitchEstimationAlgorithm c : PitchProcessor.PitchEstimationAlgorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PitchProcessor.PitchEstimationAlgorithm valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDetector

public PitchDetector getDetector(float sampleRate,
                                 int bufferSize)

Returns a new instance of a pitch detector object based on the provided values.

Parameters:

sampleRate - The sample rate of the audio buffer.

bufferSize - The size (in samples) of the audio buffer.

Returns:

A new pitch detector object.