comparison examples/PercussionOnsetDetector.cpp @ 49:aa64a46320d4

* Rename "name" and "description" to "identifier" and "name"; add new
  "description" that actually contains a description

 {
     delete[] m_priorMagnitudes;
 }
 
 string
+PercussionOnsetDetector::getIdentifier() const
+{
+    return "percussiononsets";
+}
+
+string
 PercussionOnsetDetector::getName() const
 {
-    return "percussiononsets";
+    return "Simple Percussion Onset Detector";
 }
 
 string
 PercussionOnsetDetector::getDescription() const
 {
-    return "Simple Percussion Onset Detector";
+    return "Detect percussive note onsets by identifying broadband energy rises";
 }
 
 string
 PercussionOnsetDetector::getMaker() const
 {

 PercussionOnsetDetector::getParameterDescriptors() const
 {
     ParameterList list;
 
     ParameterDescriptor d;
-    d.name = "threshold";
-    d.description = "Broadband energy rise threshold";
+    d.identifier = "threshold";
+    d.name = "Energy rise threshold";
+    d.description = "Energy rise within a frequency bin necessary to count toward broadband total";
     d.unit = "dB";
     d.minValue = 0;
     d.maxValue = 20;
     d.defaultValue = 3;
     d.isQuantized = false;
     list.push_back(d);
 
-    d.name = "sensitivity";
-    d.description = "Peak detection sensitivity";
+    d.identifier = "sensitivity";
+    d.name = "Sensitivity";
+    d.description = "Sensitivity of peak detector applied to broadband detection function";
     d.unit = "%";
     d.minValue = 0;
     d.maxValue = 100;
     d.defaultValue = 40;
     d.isQuantized = false;

 
     return list;
 }
 
 float
-PercussionOnsetDetector::getParameter(std::string name) const
-{
-    if (name == "threshold") return m_threshold;
-    if (name == "sensitivity") return m_sensitivity;
+PercussionOnsetDetector::getParameter(std::string id) const
+{
+    if (id == "threshold") return m_threshold;
+    if (id == "sensitivity") return m_sensitivity;
     return 0.f;
 }
 
 void
-PercussionOnsetDetector::setParameter(std::string name, float value)
-{
-    if (name == "threshold") {
+PercussionOnsetDetector::setParameter(std::string id, float value)
+{
+    if (id == "threshold") {
         if (value < 0) value = 0;
         if (value > 20) value = 20;
         m_threshold = value;
-    } else if (name == "sensitivity") {
+    } else if (id == "sensitivity") {
         if (value < 0) value = 0;
         if (value > 100) value = 100;
         m_sensitivity = value;
     }
 }

 PercussionOnsetDetector::getOutputDescriptors() const
 {
     OutputList list;
 
     OutputDescriptor d;
-    d.name = "onsets";
+    d.identifier = "onsets";
+    d.name = "Onsets";
+    d.description = "Percussive note onset locations";
     d.unit = "";
-    d.description = "Onsets";
     d.hasFixedBinCount = true;
     d.binCount = 0;
     d.hasKnownExtents = false;
     d.isQuantized = false;
     d.sampleType = OutputDescriptor::VariableSampleRate;
     d.sampleRate = m_inputSampleRate;
     list.push_back(d);
 
-    d.name = "detectionfunction";
-    d.description = "Onset Detection Function";
+    d.identifier = "detectionfunction";
+    d.name = "Detection Function";
+    d.description = "Broadband energy rise detection function";
     d.binCount = 1;
     d.isQuantized = true;
     d.quantizeStep = 1.0;
     d.sampleType = OutputDescriptor::OneSamplePerStep;
     list.push_back(d);