adamstark@24: /**
adamstark@24: * \mainpage BTrack - A Real-Time Beat Tracker
adamstark@24: *
adamstark@24: * A real-time beat tracker, implemented in C++.
adamstark@24: * 
adamstark@24: * Written by Adam Stark, Matthew Davies and Mark Plumbley.
adamstark@24: * 
adamstark@24: * License
adamstark@24: * -------
adamstark@24: * 
adamstark@24: * BTrack is made available under the GNU General Public License, version 3. Please see the included  LICENSE.txt for more details.
adamstark@24: * 
adamstark@24: * Usage - C++
adamstark@24: * -----------
adamstark@24: * 
adamstark@24: * **STEP 1**
adamstark@24: * 
adamstark@24: * Include the BTrack header file as follows:
adamstark@24: *
adamstark@24: * 		#include "BTrack.h"
adamstark@24: *	
adamstark@24: * **STEP 2**
adamstark@24: *
adamstark@24: * Instantiate the algorithm by one of the following:
adamstark@24: * 
adamstark@24: *
adamstark@24: *		// to use the default 512 hop size and 1024 frame size
adamstark@24: *		BTrack b; 
adamstark@24: *
adamstark@24: * or:	
adamstark@24: *	
adamstark@24: *		// to specify a hop size (e.g. 512) and have a frame size of 2 x the hop size
adamstark@24: *		BTrack b(512); 
adamstark@24: *	
adamstark@24: * or:
adamstark@24: *
adamstark@24: *		// to specify both the hop size and frame size
adamstark@24: *		BTrack b(512,1024);
adamstark@24: *	
adamstark@24: * **STEP 3.1 - Audio Input**
adamstark@24: * 
adamstark@24: * In the processing loop, fill a double precision array with one frame of audio samples (as determined in step 2): 
adamstark@24: * 
adamstark@24: *		double *frame; 
adamstark@24: *	
adamstark@24: *		// !
adamstark@24: *		// do something here to fill the frame with audio samples
adamstark@24: *		// !
adamstark@24: *
adamstark@24: * and then call:
adamstark@24: *
adamstark@24: *		b.processAudioFrame(frame);
adamstark@24: *	
adamstark@24: * and to check for beats, simply call:
adamstark@24: *
adamstark@24: *		if (b.beatDueInCurrentFrame())
adamstark@24: *		{
adamstark@24: *			// do something on the beat
adamstark@24: *		}
adamstark@24: *
adamstark@24: * **STEP 3.2 - Onset Detection Function Input**	
adamstark@24: *
adamstark@24: * The algorithm can process onset detection function samples. Given a double precision onset detection function sample called 'newSamples', at each step, call:
adamstark@24: *
adamstark@24: *		b.processOnsetDetectionFunctionSample(newSample);
adamstark@24: *	
adamstark@24: * and then check for beats with:
adamstark@24: *
adamstark@24: *		if (b.beatDueInCurrentFrame())
adamstark@24: *		{
adamstark@24: *			// do something on the beat
adamstark@24: *		}
adamstark@24: *
adamstark@24: * For any questions, please email Adam Stark (email at http://www.adamstark.co.uk).
adamstark@24: */