// =============================================================================
// About the driver
// =============================================================================
This is a Javascript test driver which allows for automated collection of data
from the different methods of frequency/pitch detection in the microphone.js 
library. It can be accessed via the index.html file included in this folder,
which is simply a page with a button - clicking that button runs the test
driver. The test driver writes the note data to a file "notes.txt" which shows
the FFT and autocorrelate results for each note detection side by side.

// =============================================================================
// General usage
// =============================================================================
1. Move the sound file (mp3) you wish to test into a directory with the given
	 index.html and test_driver.js.
	 
2. In the given index.html file, change the parameter of "loadAndTestWithFile"
	 to the name of the sound file you chose to test.
	 
3. Run the given index.html file. This should generate a web page with a simple
	 "TEST" button on it.
	 
4. Click the "TEST" button. This will automatically run both FFT and 
	 autocorrelate tests on the sound file you chose to test.
	 
5. DOES THIS DOWNLOAD AUTOMATICALLY? ASK PATRICK
	 
// =============================================================================
// About the sample output
// =============================================================================
The sample output folder included in the test harness contains the following:

1. autocorr_vs_fft.png: a graphical representation of the results of the FFT and
	 autocorrelate functions on the default sound file (see #2)
	 
2. cdefgfedcgegc.mp3: the default sound file for the test harness

3. freqs.txt: a text file containing the frequencies calculated via FFT and
	 autocorrelate for the default sound file (see #2)
	 
4. method_compare.m: ASK PATRICK

5. notes.txt: a text file containing the notes calculated via FFT and 
	 autocorrelate for the default sound file (see #2)

// =============================================================================
// License information
// =============================================================================
This code is released under the MIT Open Source License.

Copyright (c) 2013 Patrick Yukman and Max Deibel

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.