diff plugins/MFCCPlugin.cpp @ 52:4fe04e706839

* Add some descriptions etc
author Chris Cannam <c.cannam@qmul.ac.uk>
date Wed, 30 Jan 2008 13:33:23 +0000
parents df7a0bc46592
children 3c418314a173
line wrap: on
line diff
--- a/plugins/MFCCPlugin.cpp	Wed Jan 30 12:42:04 2008 +0000
+++ b/plugins/MFCCPlugin.cpp	Wed Jan 30 13:33:23 2008 +0000
@@ -90,7 +90,7 @@
     desc.identifier = "nceps";
     desc.name = "Number of Coefficients";
     desc.unit = "";
-    //!!! descriptions -- "including C0 if requested"
+    desc.description = "Number of MFCCs to return, starting from C0 if \"Include C0\" is specified or from C1 otherwise";
     desc.minValue = 1;
     desc.maxValue = 40;
     desc.defaultValue = 20;
@@ -101,6 +101,7 @@
     desc.identifier = "logpower";
     desc.name = "Power for Mel Amplitude Logs";
     desc.unit = "";
+    desc.description = "Power to raise the amplitude log values to before applying DCT.  Values greater than 1 may reduce contribution of noise";
     desc.minValue = 0;
     desc.maxValue = 5;
     desc.defaultValue = 1;
@@ -111,7 +112,7 @@
     desc.identifier = "wantc0";
     desc.name = "Include C0";
     desc.unit = "";
-    //!!! description
+    desc.description = "Whether to include the C0 (energy level) coefficient in the returned results";
     desc.minValue = 0;
     desc.maxValue = 1;
     desc.defaultValue = 1;
@@ -217,6 +218,7 @@
     d.identifier = "coefficients";
     d.name = "Coefficients";
     d.unit = "";
+    d.description = "MFCC values";
     d.hasFixedBinCount = true;
     d.binCount = m_bins;
     d.hasKnownExtents = false;
@@ -226,7 +228,7 @@
 
     d.identifier = "means";
     d.name = "Means of Coefficients";
-    //!!! descriptions
+    d.description = "Mean values of MFCCs across duration of audio input";
     d.sampleType = OutputDescriptor::FixedSampleRate;
     d.sampleRate = 1;
     list.push_back(d);