comparison plugins/ChromagramPlugin.cpp @ 52:4fe04e706839

* Add some descriptions etc

 
     ParameterDescriptor desc;
     desc.identifier = "minpitch";
     desc.name = "Minimum Pitch";
     desc.unit = "MIDI units";
-    //!!! descriptions
+    desc.description = "MIDI pitch corresponding to the lowest frequency to be included in the chromagram";
     desc.minValue = 0;
     desc.maxValue = 127;
     desc.defaultValue = 12;
     desc.isQuantized = true;
     desc.quantizeStep = 1;
     list.push_back(desc);
 
     desc.identifier = "maxpitch";
     desc.name = "Maximum Pitch";
     desc.unit = "MIDI units";
+    desc.description = "MIDI pitch corresponding to the highest frequency to be included in the chromagram";
     desc.minValue = 0;
     desc.maxValue = 127;
     desc.defaultValue = 96;
     desc.isQuantized = true;
     desc.quantizeStep = 1;
     list.push_back(desc);
 
     desc.identifier = "tuning";
     desc.name = "Tuning Frequency";
     desc.unit = "Hz";
+    desc.description = "Frequency of concert A";
     desc.minValue = 420;
     desc.maxValue = 460;
     desc.defaultValue = 440;
     desc.isQuantized = false;
     list.push_back(desc);
     
     desc.identifier = "bpo";
     desc.name = "Bins per Octave";
     desc.unit = "bins";
+    desc.description = "Number of constant-Q transform bins per octave, and the number of bins for the chromagram outputs";
     desc.minValue = 2;
     desc.maxValue = 36;
     desc.defaultValue = 12;
     desc.isQuantized = true;
     desc.quantizeStep = 1;
     list.push_back(desc);
 
     desc.identifier = "normalization";
     desc.name = "Normalization";
     desc.unit = "";
+    desc.description = "Normalization for each chromagram output column";
     desc.minValue = 0;
     desc.maxValue = 2;
     desc.defaultValue = 2;
     desc.isQuantized = true;
     desc.quantizeStep = 1;

     }
 
     if (channels < getMinChannelCount() ||
 	channels > getMaxChannelCount()) return false;
 
-    std::cerr << "ChromagramPlugin::initialise: step " << stepSize << ", block "
-	      << blockSize << std::endl;
-
     m_chromagram = new Chromagram(m_config);
     m_binsums = vector<double>(m_config.BPO);
 
     for (int i = 0; i < m_config.BPO; ++i) {
         m_binsums[i] = 0.0;

     m_count = 0;
 
     m_step = m_chromagram->getHopSize();
     m_block = m_chromagram->getFrameSize();
 
-    //!!! stepSize != m_step should not be an error
-
-    if (stepSize != m_step ||
-        blockSize != m_block) {
+    if (blockSize != m_block) {
+        std::cerr << "ChromagramPlugin::initialise: ERROR: supplied block size " << blockSize << " differs from required block size " << m_block << ", initialise failing" << std::endl;
         delete m_chromagram;
         m_chromagram = 0;
         return false;
+    }
+
+    if (stepSize != m_step) {
+        std::cerr << "ChromagramPlugin::initialise: NOTE: supplied step size " << stepSize << " differs from expected step size " << m_step << " (for block size = " << m_block << ")" << std::endl;
     }
 
     return true;
 }
 

 
     OutputDescriptor d;
     d.identifier = "chromagram";
     d.name = "Chromagram";
     d.unit = "";
+    d.description = "Output of chromagram, as a single vector per process block";
     d.hasFixedBinCount = true;
     d.binCount = m_config.BPO;
     
     const char *names[] =
 	{ "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" };

     d.sampleType = OutputDescriptor::OneSamplePerStep;
     list.push_back(d);
 
     d.identifier = "chromameans";
     d.name = "Chroma Means";
-    //!!! descriptions
+    d.description = "Mean values of chromagram bins across the duration of the input audio";
     d.sampleType = OutputDescriptor::FixedSampleRate;
     d.sampleRate = 1;
     list.push_back(d);
 
     return list;