plugins/Pitch.cpp: add parameters and output descriptions
[vamp-aubio-plugins.git] / plugins / Pitch.cpp
index 5fd3730..20189fc 100644 (file)
@@ -22,20 +22,14 @@ using std::vector;
 using std::cerr;
 using std::endl;
 
-static float
-getFrequencyForMIDIPitch(int midiPitch)
-{
-    return 440.f * powf(2.0, (float(midiPitch) - 69.0) / 12.0);
-}
-
 Pitch::Pitch(float inputSampleRate) :
     Plugin(inputSampleRate),
     m_ibuf(0),
     m_obuf(0),
     m_pitchdet(0),
     m_pitchtype(PitchYinFFT),
-    m_minfreq(getFrequencyForMIDIPitch(32)),
-    m_maxfreq(getFrequencyForMIDIPitch(95)),
+    m_minfreq(aubio_miditofreq(32)),
+    m_maxfreq(aubio_miditofreq(95)),
     m_silence(-90),
     m_wrapRange(false),
     m_stepSize(0),
@@ -139,6 +133,7 @@ Pitch::getParameterDescriptors() const
     ParameterDescriptor desc;
     desc.identifier = "pitchtype";
     desc.name = "Pitch Detection Function Type";
+    desc.description = "Type of pitch detection function to use";
     desc.minValue = 0;
     desc.maxValue = 4;
     desc.defaultValue = (int)PitchYinFFT;
@@ -154,9 +149,10 @@ Pitch::getParameterDescriptors() const
     desc = ParameterDescriptor();
     desc.identifier = "minfreq";
     desc.name = "Minimum Fundamental Frequency";
+    desc.description = "Lower frequency to look for";
     desc.minValue = 1;
     desc.maxValue = m_inputSampleRate/2;
-    desc.defaultValue = getFrequencyForMIDIPitch(32);
+    desc.defaultValue = aubio_miditofreq(32);
     desc.unit = "Hz";
     desc.isQuantized = false;
     list.push_back(desc);
@@ -164,9 +160,10 @@ Pitch::getParameterDescriptors() const
     desc = ParameterDescriptor();
     desc.identifier = "maxfreq";
     desc.name = "Maximum Fundamental Frequency";
+    desc.description = "Highest frequency to look for";
     desc.minValue = 1;
     desc.maxValue = m_inputSampleRate/2;
-    desc.defaultValue = getFrequencyForMIDIPitch(95);
+    desc.defaultValue = aubio_miditofreq(95);
     desc.unit = "Hz";
     desc.isQuantized = false;
     list.push_back(desc);
@@ -174,6 +171,7 @@ Pitch::getParameterDescriptors() const
     desc = ParameterDescriptor();
     desc.identifier = "wraprange";
     desc.name = "Fold Higher or Lower Frequencies into Range";
+    desc.description = "Frequencies detected outside the range will be transposed to higher or lower octaves";
     desc.minValue = 0;
     desc.maxValue = 1;
     desc.defaultValue = 0;
@@ -184,6 +182,7 @@ Pitch::getParameterDescriptors() const
     desc = ParameterDescriptor();
     desc.identifier = "silencethreshold";
     desc.name = "Silence Threshold";
+    desc.description = "Silence threshold, the higher the least detection";
     desc.minValue = -120;
     desc.maxValue = 0;
     desc.defaultValue = -90;
@@ -242,6 +241,7 @@ Pitch::getOutputDescriptors() const
     OutputDescriptor d;
     d.identifier = "frequency";
     d.name = "Fundamental Frequency";
+    d.description = "List of detected frequencies";
     d.unit = "Hz";
     d.hasFixedBinCount = true;
     d.binCount = 1;
@@ -269,7 +269,7 @@ Pitch::process(const float *const *inputBuffers,
     }
 
     for (size_t i = 0; i < m_stepSize; ++i) {
-        fvec_write_sample(m_ibuf, inputBuffers[0][i], i);
+        fvec_set_sample(m_ibuf, inputBuffers[0][i], i);
     }
 
     aubio_pitch_do(m_pitchdet, m_ibuf, m_obuf);