cannam@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 
cannam@0: /*
cannam@0:     Vamp feature extraction plugins using Paul Brossier's Aubio library.
cannam@0: 
cannam@0:     Centre for Digital Music, Queen Mary, University of London.
cannam@0:     This file copyright 2006 Chris Cannam.
cannam@0:     
piem@112:     This file is part of vamp-aubio-plugins.
piem@112: 
piem@112:     vamp-aubio is free software: you can redistribute it and/or modify
piem@112:     it under the terms of the GNU General Public License as published by
piem@112:     the Free Software Foundation, either version 3 of the License, or
piem@112:     (at your option) any later version.
piem@112: 
piem@112:     vamp-aubio is distributed in the hope that it will be useful,
piem@112:     but WITHOUT ANY WARRANTY; without even the implied warranty of
piem@112:     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
piem@112:     GNU General Public License for more details.
piem@112: 
piem@112:     You should have received a copy of the GNU General Public License
piem@112:     along with aubio.  If not, see <http://www.gnu.org/licenses/>.
cannam@0: 
cannam@0: */
cannam@0: 
piem@2: #include <math.h>
cannam@0: #include "Pitch.h"
cannam@0: 
cannam@0: using std::string;
cannam@0: using std::vector;
cannam@0: using std::cerr;
cannam@0: using std::endl;
cannam@0: 
cannam@0: Pitch::Pitch(float inputSampleRate) :
cannam@0:     Plugin(inputSampleRate),
cannam@0:     m_ibuf(0),
cannam@35:     m_obuf(0),
cannam@0:     m_pitchdet(0),
cannam@31:     m_pitchtype(PitchYinFFT),
piem@61:     m_minfreq(aubio_miditofreq(32)),
piem@61:     m_maxfreq(aubio_miditofreq(95)),
cannam@23:     m_silence(-90),
cannam@23:     m_wrapRange(false),
cannam@23:     m_stepSize(0),
cannam@32:     m_blockSize(0)
cannam@0: {
cannam@0: }
cannam@0: 
cannam@0: Pitch::~Pitch()
cannam@0: {
cannam@31:     if (m_pitchdet) del_aubio_pitch(m_pitchdet);
cannam@0:     if (m_ibuf) del_fvec(m_ibuf);
cannam@33:     if (m_obuf) del_fvec(m_obuf);
cannam@0: }
cannam@0: 
cannam@0: string
cannam@13: Pitch::getIdentifier() const
cannam@0: {
cannam@0:     return "aubiopitch";
cannam@0: }
cannam@0: 
cannam@0: string
cannam@13: Pitch::getName() const
cannam@13: {
cannam@13:     return "Aubio Pitch Detector";
cannam@13: }
cannam@13: 
cannam@13: string
cannam@0: Pitch::getDescription() const
cannam@0: {
cannam@13:     return "Track estimated note pitches";
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Pitch::getMaker() const
cannam@0: {
cannam@0:     return "Paul Brossier (plugin by Chris Cannam)";
cannam@0: }
cannam@0: 
cannam@0: int
cannam@0: Pitch::getPluginVersion() const
cannam@0: {
cannam@31:     return 3;
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Pitch::getCopyright() const
cannam@0: {
cannam@0:     return "GPL";
cannam@0: }
cannam@0: 
cannam@0: bool
cannam@0: Pitch::initialise(size_t channels, size_t stepSize, size_t blockSize)
cannam@0: {
cannam@32:     if (channels != 1) {
cannam@32:         std::cerr << "Pitch::initialise: channels must be 1" << std::endl;
cannam@32:         return false;
cannam@32:     }
cannam@32: 
cannam@0:     m_stepSize = stepSize;
cannam@0:     m_blockSize = blockSize;
cannam@0: 
cannam@32:     m_ibuf = new_fvec(stepSize);
cannam@33:     m_obuf = new_fvec(1);
cannam@0: 
cannam@37:     reset();
cannam@0: 
cannam@0:     return true;
cannam@0: }
cannam@0: 
cannam@0: void
cannam@0: Pitch::reset()
cannam@0: {
cannam@37:     if (m_pitchdet) del_aubio_pitch(m_pitchdet);
cannam@37: 
cannam@37:     m_pitchdet = new_aubio_pitch
cannam@37:         (const_cast<char *>(getAubioNameForPitchType(m_pitchtype)),
cannam@37:          m_blockSize,
cannam@37:          m_stepSize,
cannam@37:          lrintf(m_inputSampleRate));
cannam@37: 
cannam@37:     aubio_pitch_set_unit(m_pitchdet, const_cast<char *>("freq"));
cannam@0: }
cannam@0: 
cannam@0: size_t
cannam@0: Pitch::getPreferredStepSize() const
cannam@0: {
cannam@0:     return 512;
cannam@0: }
cannam@0: 
cannam@0: size_t
cannam@0: Pitch::getPreferredBlockSize() const
cannam@0: {
piem@2:     return 2048;
cannam@0: }
cannam@0: 
cannam@0: Pitch::ParameterList
cannam@0: Pitch::getParameterDescriptors() const
cannam@0: {
cannam@0:     ParameterList list;
cannam@0:     
cannam@0:     ParameterDescriptor desc;
cannam@13:     desc.identifier = "pitchtype";
cannam@13:     desc.name = "Pitch Detection Function Type";
piem@65:     desc.description = "Type of pitch detection function to use";
cannam@0:     desc.minValue = 0;
cannam@0:     desc.maxValue = 4;
cannam@33:     desc.defaultValue = (int)PitchYinFFT;
cannam@0:     desc.isQuantized = true;
cannam@0:     desc.quantizeStep = 1;
cannam@0:     desc.valueNames.push_back("YIN Frequency Estimator");
cannam@0:     desc.valueNames.push_back("Spectral Comb");
cannam@0:     desc.valueNames.push_back("Schmitt");
cannam@0:     desc.valueNames.push_back("Fast Harmonic Comb");
cannam@0:     desc.valueNames.push_back("YIN with FFT");
cannam@0:     list.push_back(desc);
cannam@0: 
cannam@23:     desc = ParameterDescriptor();
cannam@23:     desc.identifier = "minfreq";
cannam@23:     desc.name = "Minimum Fundamental Frequency";
piem@78:     desc.description = "Lowest frequency to look for";
cannam@23:     desc.minValue = 1;
cannam@23:     desc.maxValue = m_inputSampleRate/2;
piem@61:     desc.defaultValue = aubio_miditofreq(32);
cannam@23:     desc.unit = "Hz";
cannam@23:     desc.isQuantized = false;
cannam@23:     list.push_back(desc);
cannam@23: 
cannam@23:     desc = ParameterDescriptor();
cannam@23:     desc.identifier = "maxfreq";
cannam@23:     desc.name = "Maximum Fundamental Frequency";
piem@65:     desc.description = "Highest frequency to look for";
cannam@23:     desc.minValue = 1;
cannam@23:     desc.maxValue = m_inputSampleRate/2;
piem@61:     desc.defaultValue = aubio_miditofreq(95);
cannam@23:     desc.unit = "Hz";
cannam@23:     desc.isQuantized = false;
cannam@23:     list.push_back(desc);
cannam@23: 
cannam@23:     desc = ParameterDescriptor();
cannam@23:     desc.identifier = "wraprange";
cannam@23:     desc.name = "Fold Higher or Lower Frequencies into Range";
piem@65:     desc.description = "Frequencies detected outside the range will be transposed to higher or lower octaves";
cannam@23:     desc.minValue = 0;
cannam@23:     desc.maxValue = 1;
cannam@23:     desc.defaultValue = 0;
cannam@23:     desc.isQuantized = true;
cannam@23:     desc.quantizeStep = 1;
cannam@23:     list.push_back(desc);
cannam@23: 
cannam@23:     desc = ParameterDescriptor();
cannam@23:     desc.identifier = "silencethreshold";
cannam@23:     desc.name = "Silence Threshold";
piem@65:     desc.description = "Silence threshold, the higher the least detection";
cannam@23:     desc.minValue = -120;
cannam@23:     desc.maxValue = 0;
cannam@23:     desc.defaultValue = -90;
cannam@23:     desc.unit = "dB";
cannam@23:     desc.isQuantized = false;
cannam@23:     list.push_back(desc);
cannam@23: 
cannam@0:     return list;
cannam@0: }
cannam@0: 
cannam@0: float
cannam@0: Pitch::getParameter(std::string param) const
cannam@0: {
cannam@0:     if (param == "pitchtype") {
cannam@0:         return m_pitchtype;
cannam@23:     } else if (param == "minfreq") {
cannam@23:         return m_minfreq;
cannam@23:     } else if (param == "maxfreq") {
cannam@23:         return m_maxfreq;
cannam@23:     } else if (param == "wraprange") {
cannam@23:         return m_wrapRange ? 1.0 : 0.0;
cannam@23:     } else if (param == "silencethreshold") {
cannam@23:         return m_silence;
cannam@0:     } else {
cannam@0:         return 0.0;
cannam@0:     }
cannam@0: }
cannam@0: 
cannam@0: void
cannam@0: Pitch::setParameter(std::string param, float value)
cannam@0: {
cannam@0:     if (param == "pitchtype") {
cannam@0:         switch (lrintf(value)) {
cannam@33:         case 0: m_pitchtype = PitchYin; break;
cannam@33:         case 1: m_pitchtype = PitchMComb; break;
cannam@33:         case 2: m_pitchtype = PitchSchmitt; break;
cannam@33:         case 3: m_pitchtype = PitchFComb; break;
cannam@33:         case 4: m_pitchtype = PitchYinFFT; break;
cannam@0:         }
cannam@23:     } else if (param == "minfreq") {
cannam@23:         m_minfreq = value;
cannam@23:     } else if (param == "maxfreq") {
cannam@23:         m_maxfreq = value;
cannam@23:     } else if (param == "wraprange") {
cannam@23:         m_wrapRange = (value > 0.5);
cannam@23:     } else if (param == "silencethreshold") {
cannam@23:         m_silence = value;
cannam@0:     }
cannam@0: }
cannam@0: 
cannam@0: Pitch::OutputList
cannam@0: Pitch::getOutputDescriptors() const
cannam@0: {
cannam@0:     OutputList list;
cannam@0: 
cannam@0:     OutputDescriptor d;
cannam@13:     d.identifier = "frequency";
cannam@23:     d.name = "Fundamental Frequency";
piem@65:     d.description = "List of detected frequencies";
cannam@0:     d.unit = "Hz";
cannam@0:     d.hasFixedBinCount = true;
cannam@0:     d.binCount = 1;
cannam@0:     d.hasKnownExtents = false;
cannam@0:     d.isQuantized = false;
cannam@23:     d.sampleType = OutputDescriptor::VariableSampleRate;
cannam@23:     d.sampleRate = 0;
cannam@23:     if (m_stepSize != 0) {
cannam@23:         d.sampleRate = m_inputSampleRate / m_stepSize;
cannam@23:     }
cannam@0:     list.push_back(d);
cannam@0: 
cannam@0:     return list;
cannam@0: }
cannam@0: 
cannam@0: Pitch::FeatureSet
cannam@12: Pitch::process(const float *const *inputBuffers,
cannam@23:                Vamp::RealTime timestamp)
cannam@0: {
cannam@23:     FeatureSet returnFeatures;
cannam@23: 
cannam@23:     if (m_stepSize == 0) {
cannam@23:         std::cerr << "Pitch::process: Pitch plugin not initialised" << std::endl;
cannam@23:         return returnFeatures;
cannam@23:     }
cannam@23: 
cannam@0:     for (size_t i = 0; i < m_stepSize; ++i) {
piem@52:         fvec_set_sample(m_ibuf, inputBuffers[0][i], i);
cannam@0:     }
cannam@0: 
cannam@33:     aubio_pitch_do(m_pitchdet, m_ibuf, m_obuf);
cannam@33:     
cannam@33:     float freq = m_obuf->data[0];
cannam@23: 
cannam@23:     bool silent = aubio_silence_detection(m_ibuf, m_silence);
cannam@23:     if (silent) {
cannam@23: //        std::cerr << "(silent)" << std::endl;
cannam@23:         return returnFeatures;
cannam@23:     }
cannam@23: 
cannam@23:     if (m_wrapRange) {
cannam@23:         while (freq > 0 && freq < m_minfreq) {
cannam@23:             freq = freq * 2.0;
cannam@23:         }
cannam@23:         while (freq > m_maxfreq) {
cannam@23:             freq = freq / 2.0;
cannam@23:         }
cannam@23:     }
cannam@23: 
cannam@23:     if (freq < m_minfreq || freq > m_maxfreq) {
cannam@23:         return returnFeatures;
cannam@23:     }
cannam@0: 
cannam@0:     Feature feature;
cannam@23:     feature.hasTimestamp = true;
cannam@23:     feature.timestamp = timestamp;
cannam@23:     feature.values.push_back(freq);
cannam@0: 
cannam@0:     returnFeatures[0].push_back(feature);
cannam@0:     return returnFeatures;
cannam@0: }
cannam@0: 
cannam@0: Pitch::FeatureSet
cannam@0: Pitch::getRemainingFeatures()
cannam@0: {
cannam@0:     return FeatureSet();
cannam@0: }
cannam@0: