adamstark@5: //=======================================================================
adamstark@5: /** @file OnsetDetectionFunction.h
adamstark@5:  *  @brief A class for calculating onset detection functions
adamstark@5:  *  @author Adam Stark
adamstark@5:  *  @copyright Copyright (C) 2008-2014  Queen Mary University of London
adamstark@5:  *
adamstark@5:  * This program is free software: you can redistribute it and/or modify
adamstark@5:  * it under the terms of the GNU General Public License as published by
adamstark@5:  * the Free Software Foundation, either version 3 of the License, or
adamstark@5:  * (at your option) any later version.
adamstark@5:  *
adamstark@5:  * This program is distributed in the hope that it will be useful,
adamstark@5:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
adamstark@5:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
adamstark@5:  * GNU General Public License for more details.
adamstark@5:  *
adamstark@5:  * You should have received a copy of the GNU General Public License
adamstark@5:  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
adamstark@5:  */
adamstark@5: //=======================================================================
adamstark@5: 
adamstark@5: #ifndef __RTONSETDF_H
adamstark@5: #define __RTONSETDF_H
adamstark@5: 
adamstark@5: #include "fftw3.h"
adamstark@5: 
adamstark@5: class OnsetDetectionFunction
adamstark@5: {
adamstark@5: public:
adamstark@15:     
adamstark@15:     /** Constructor */
adamstark@15: 	OnsetDetectionFunction(int arg_hsize,int arg_fsize,int arg_df_type,int arg_win_type);
adamstark@15:     
adamstark@15:     /** Destructor */
adamstark@15: 	~OnsetDetectionFunction();
adamstark@15:     
adamstark@15:     /** Initialisation Function */
adamstark@15: 	void initialise(int arg_hsize,int arg_fsize,int arg_df_type,int arg_win_type);
adamstark@5: 	
adamstark@15:     /** process input buffer and calculate detection function sample */
adamstark@15: 	double getDFsample(double inputbuffer[]);
adamstark@15:     
adamstark@15:     /** set the detection function type */
adamstark@15: 	void set_df_type(int arg_df_type);
adamstark@5: 	
adamstark@5: private:
adamstark@5: 	
adamstark@15:     /** perform the FFT on the data in 'frame' */
adamstark@15: 	void perform_FFT();
adamstark@5: 
adamstark@15:     /** calculate energy envelope detection function sample */
adamstark@15: 	double energy_envelope();
adamstark@15:     
adamstark@15:     /** calculate energy difference detection function sample */
adamstark@15: 	double energy_difference();
adamstark@15:     
adamstark@15:     /** calculate spectral difference detection function sample */
adamstark@15: 	double spectral_difference();
adamstark@15:     
adamstark@15:     /** calculate spectral difference (half wave rectified) detection function sample */
adamstark@15: 	double spectral_difference_hwr();
adamstark@15:     
adamstark@15:     /** calculate phase deviation detection function sample */
adamstark@15: 	double phase_deviation();
adamstark@15:     
adamstark@15:     /** calculate complex spectral difference detection function sample */
adamstark@15: 	double complex_spectral_difference();
adamstark@15:     
adamstark@15:     /** calculate complex spectral difference detection function sample (half-wave rectified) */
adamstark@15: 	double complex_spectral_difference_hwr();
adamstark@15:     
adamstark@15:     /** calculate high frequency content detection function sample */
adamstark@15: 	double high_frequency_content();
adamstark@15:     
adamstark@15:     /** calculate high frequency spectral difference detection function sample */
adamstark@15: 	double high_frequency_spectral_difference();
adamstark@15:     
adamstark@15:     /** calculate high frequency spectral difference detection function sample (half-wave rectified) */
adamstark@15: 	double high_frequency_spectral_difference_hwr();
adamstark@5: 
adamstark@15:     /** calculate a Rectangular window */
adamstark@15: 	void set_win_rectangular();
adamstark@15:     
adamstark@15:     /** calculate a Hanning window */
adamstark@15: 	void set_win_hanning();
adamstark@15:     
adamstark@15:     /** calculate a Hamming window */
adamstark@15: 	void set_win_hamming();
adamstark@15:     
adamstark@15:     /** calculate a Blackman window */
adamstark@15: 	void set_win_blackman();
adamstark@15:     
adamstark@15:     /** calculate a Tukey window */
adamstark@15: 	void set_win_tukey();
adamstark@5: 
adamstark@15: 	/** set phase values between [-pi, pi] */
adamstark@15: 	double princarg(double phaseval);
adamstark@5: 	
adamstark@5: 	
adamstark@15: 	double pi;							/**< pi, the constant */
adamstark@5: 	
adamstark@15: 	int framesize;						/**< audio framesize */
adamstark@15: 	int hopsize;						/**< audio hopsize */
adamstark@15: 	int df_type;						/**< type of detection function */
adamstark@5: 	
adamstark@15: 	fftw_plan p;						/**< create fft plan */
adamstark@15: 	fftw_complex *in;					/**< to hold complex fft values for input */
adamstark@15: 	fftw_complex *out;					/**< to hold complex fft values for output */
adamstark@5: 	
adamstark@15: 	int initialised;					/**< flag indicating whether buffers and FFT plans are initialised */
adamstark@15: 
adamstark@15: 	double *frame;						/**< audio frame */
adamstark@15: 	double *window;						/**< window */
adamstark@15: 	double *wframe;						/**< windowed frame */
adamstark@5: 	
adamstark@15: 	double energy_sum_old;				/**< to hold the previous energy sum value */
adamstark@5: 	
adamstark@15: 	double *mag;						/**< magnitude spectrum */
adamstark@15: 	double *mag_old;					/**< previous magnitude spectrum */
adamstark@5: 	
adamstark@15: 	double *phase;						/**< FFT phase values */
adamstark@15: 	double *phase_old;					/**< previous phase values */
adamstark@15: 	double *phase_old_2;				/**< second order previous phase values */
adamstark@5: 
adamstark@5: };
adamstark@5: 
adamstark@5: 
adamstark@5: #endif