changeset 50:df7a0bc46592

* Harmonise the Maker and Copyright notices
* A bit more documentation

--- a/README.txt	Tue Jan 22 17:27:48 2008 +0000
+++ b/README.txt	Fri Jan 25 17:56:49 2008 +0000
@@ -22,7 +22,7 @@
 Digital Music at Queen Mary, University of London.
 
 Copyright (c) 2006-2008 Queen Mary, University of London.  All rights
-reserved.
+reserved except as described above.
 
 
 New In This Release
@@ -33,8 +33,8 @@
 segmentation of music audio, and a Mel-frequency cepstral coefficients
 calculation plugin.
 
-This release also includes fixes to the existing key detector and
-chromagram plugins.
+This release also includes significant fixes to the existing key
+detector and chromagram plugins.
 
 
 To Install
@@ -133,7 +133,6 @@
 beat positions.
 
 
-
 Key Detector
 ------------
 
@@ -168,11 +167,25 @@
 Authors:	Chris Harte and Martin Gasser
 Category:	Key and Tonality
 
-References:	C. A. Harte and M. Sandler.
+References:	C. A. Harte, M. Gasser, and M. Sandler.
+		Detecting harmonic change in musical audio.
+		In Proceedings of the 1st ACM workshop on Audio and Music
+		Computing Multimedia, Santa Barbara, 2006.
+
+		C. A. Harte and M. Sandler.
 		Automatic chord identification using a quantised chromagram.
 		In Proceedings of the 118th Convention of the Audio
 		Engineering Society, Barcelona, Spain, May 28-31 2005.
 
+The Tonal Change plugin analyses a single channel of audio, detecting
+harmonic changes such as chord boundaries.
+
+It has three outputs: a representation of the musical content in a
+six-dimensional tonal space onto which the algorithm maps 12-bin
+chroma vectors extracted from the audio; a function representing the
+estimated likelihood of a tonal change occurring in each spectral
+frame; and the resulting estimated positions of tonal changes.
+
 
 Segmenter
 ---------
@@ -187,8 +200,17 @@
 		IEEE Transactions on Audio, Speech, and Language Processing,
 		February 2008.
 
+The Segmenter plugin divides a single channel of music up into
+structurally consistent segments.  Its single output contains a
+numeric value (the segment classifier) for each moment at which a new
+segment starts.  For music with clearly tonally distinguishable
+sections such as verse, chorus, etc., the segments with the same
+classifier number are expected to be similar to one another in some
+structural sense (e.g. all repetitions of the chorus).
 
-
+Note that this plugin consumes a significant amount of processing time
+after receiving all of the input audio data, before it produces any
+result.
 
 
 Similarity

--- a/plugins/BeatTrack.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/BeatTrack.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -75,7 +75,7 @@
 string
 BeatTracker::getMaker() const
 {
-    return "Christian Landone and Matthew Davies, Queen Mary, University of London";
+    return "Queen Mary, University of London";
 }
 
 int
@@ -87,7 +87,7 @@
 string
 BeatTracker::getCopyright() const
 {
-    return "Copyright (c) 2006-2008 - All Rights Reserved";
+    return "Plugin by Christian Landone and Matthew Davies.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 BeatTracker::ParameterList

--- a/plugins/ChromagramPlugin.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/ChromagramPlugin.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -68,8 +68,7 @@
 string
 ChromagramPlugin::getDescription() const
 {
-    //!!!
-    return "";
+    return "Extract a series of tonal chroma vectors from the audio";
 }
 
 string
@@ -87,8 +86,7 @@
 string
 ChromagramPlugin::getCopyright() const
 {
-    //!!! update
-    return "Copyright (c) 2006 - All Rights Reserved";
+    return "Plugin by Chris Cannam and Christian Landone.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 ChromagramPlugin::ParameterList

--- a/plugins/ConstantQSpectrogram.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/ConstantQSpectrogram.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -68,7 +68,7 @@
 string
 ConstantQSpectrogram::getDescription() const
 {
-    return "";
+    return "Extract a constant pitch bin spectrogram from the input audio";
 }
 
 string
@@ -80,13 +80,13 @@
 int
 ConstantQSpectrogram::getPluginVersion() const
 {
-    return 1;
+    return 2;
 }
 
 string
 ConstantQSpectrogram::getCopyright() const
 {
-    return "Copyright (c) 2006 - All Rights Reserved";
+    return "Plugin by Chris Cannam and Christian Landone.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 ConstantQSpectrogram::ParameterList
@@ -209,7 +209,7 @@
     setupConfig();
 
     m_cq = new ConstantQ(m_config);
-    m_bins = m_cq->getK(); //!!! (int)ceil(m_bpo * log(m_config.max / m_config.min) / log(2.0));
+    m_bins = m_cq->getK();
     m_cq->sparsekernel();
     m_step = m_cq->gethop();
     m_block = m_cq->getfftlength();

--- a/plugins/KeyDetect.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/KeyDetect.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -52,14 +52,13 @@
 string
 KeyDetector::getDescription() const
 {
-    //!!!
-    return "";
+    return "Estimate the key of the music";
 }
 
 string
 KeyDetector::getMaker() const
 {
-    return "Katy Noland and Christian Landone, Queen Mary, University of London";
+    return "Queen Mary, University of London";
 }
 
 int
@@ -71,7 +70,7 @@
 string
 KeyDetector::getCopyright() const
 {
-    return "Copyright (c) 2006-2008 - All Rights Reserved";
+    return "Plugin by Katy Noland and Christian Landone.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 KeyDetector::ParameterList

--- a/plugins/MFCCPlugin.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/MFCCPlugin.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -60,8 +60,7 @@
 string
 MFCCPlugin::getDescription() const
 {
-    //!!!
-    return "";
+    return "Calculate a series of MFCC vectors from the audio";
 }
 
 string
@@ -79,8 +78,7 @@
 string
 MFCCPlugin::getCopyright() const
 {
-    //!!! update
-    return "Copyright (c) 2008 - All Rights Reserved";
+    return "Plugin by Nicolas Chetry and Chris Cannam.  Copyright (c) 2008 QMUL - All Rights Reserved";
 }
 
 MFCCPlugin::ParameterList

--- a/plugins/OnsetDetect.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/OnsetDetect.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -76,7 +76,7 @@
 string
 OnsetDetector::getMaker() const
 {
-    return "Christian Landone, Chris Duxbury and Juan Pablo Bello, Queen Mary, University of London";
+    return "Queen Mary, University of London";
 }
 
 int
@@ -88,7 +88,7 @@
 string
 OnsetDetector::getCopyright() const
 {
-    return "Copyright (c) 2006-2007 - All Rights Reserved";
+    return "Plugin by Christian Landone, Chris Duxbury and Juan Pablo Bello.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 OnsetDetector::ParameterList

--- a/plugins/SegmenterPlugin.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/SegmenterPlugin.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -53,7 +53,7 @@
 string
 SegmenterPlugin::getMaker() const
 {
-    return "Mark Levy, Queen Mary, University of London";
+    return "Queen Mary, University of London";
 }
 
 int
@@ -65,7 +65,7 @@
 string
 SegmenterPlugin::getCopyright() const
 {
-    return "Copyright (c) 2006-2008 - All Rights Reserved";
+    return "Plugin by Mark Levy.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 bool

--- a/plugins/SimilarityPlugin.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/SimilarityPlugin.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -92,7 +92,7 @@
 string
 SimilarityPlugin::getMaker() const
 {
-    return "Mark Levy, Kurt Jacobson and Chris Cannam, Queen Mary, University of London";
+    return "Queen Mary, University of London";
 }
 
 int
@@ -104,7 +104,7 @@
 string
 SimilarityPlugin::getCopyright() const
 {
-    return "Copyright (c) 2008 - All Rights Reserved";
+    return "Plugin by Mark Levy, Kurt Jacobson and Chris Cannam.  Copyright (c) 2008 QMUL - All Rights Reserved";
 }
 
 size_t

--- a/plugins/TonalChangeDetect.cpp	Tue Jan 22 17:27:48 2008 +0000
+++ b/plugins/TonalChangeDetect.cpp	Fri Jan 25 17:56:49 2008 +0000
@@ -93,7 +93,7 @@
 
 std::string TonalChangeDetect::getMaker() const
 {
-    return "Martin Gasser and Christopher Harte, Queen Mary, University of London";
+    return "Queen Mary, University of London";
 }
 
 int TonalChangeDetect::getPluginVersion() const
@@ -103,7 +103,7 @@
 
 std::string TonalChangeDetect::getCopyright() const
 {
-    return "Copyright (c) 2006 - All Rights Reserved";
+    return "Plugin by Martin Gasser and Christopher Harte.  Copyright (c) 2006-2008 QMUL - All Rights Reserved";
 }
 
 TonalChangeDetect::ParameterList TonalChangeDetect::getParameterDescriptors() const