/*
* _______ _____ _____ _____
* |__ __| | __ \ / ____| __ \
* | | __ _ _ __ ___ ___ ___| | | | (___ | |__) |
* | |/ _` | '__/ __|/ _ \/ __| | | |\___ \| ___/
* | | (_| | | \__ \ (_) \__ \ |__| |____) | |
* |_|\__,_|_| |___/\___/|___/_____/|_____/|_|
*
* -------------------------------------------------------------
*
* TarsosDSP is developed by Joren Six at IPEM, University Ghent
*
* -------------------------------------------------------------
*
* Info: http://0110.be/tag/TarsosDSP
* Github: https://github.com/JorenSix/TarsosDSP
* Releases: http://0110.be/releases/TarsosDSP/
*
* TarsosDSP includes modified source code by various authors,
* for credits and info, see README.
*
*/
package be.tarsos.dsp.pitch;
/**
* A pitch detector is capable of analyzing a buffer with audio information
* and return a pitch estimation in Hz.
*
* @author Joren Six
*/
public interface PitchDetector {
/**
* Analyzes a buffer with audio information and estimates a pitch in Hz.
* Currently this interface only allows one pitch per buffer.
*
* @param audioBuffer
* The buffer with audio information. The information in the
* buffer is not modified so it can be (re)used for e.g. FFT
* analysis.
* @return An estimation of the pitch in Hz or -1 if no pitch is detected or
* present in the buffer.
*/
PitchDetectionResult getPitch(final float[] audioBuffer);
}