matthiasm@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ Chris@9: matthiasm@0: /* Chris@9: pYIN - A fundamental frequency estimator for monophonic audio Chris@9: Centre for Digital Music, Queen Mary, University of London. Chris@9: Chris@9: This program is free software; you can redistribute it and/or Chris@9: modify it under the terms of the GNU General Public License as Chris@9: published by the Free Software Foundation; either version 2 of the Chris@9: License, or (at your option) any later version. See the file Chris@9: COPYING included with this distribution for more information. matthiasm@0: */ matthiasm@0: matthiasm@36: #include "PYinVamp.h" matthiasm@0: #include "MonoNote.h" matthiasm@0: #include "MonoPitch.h" matthiasm@0: matthiasm@0: #include "vamp-sdk/FFT.h" matthiasm@0: matthiasm@0: #include matthiasm@0: #include matthiasm@0: matthiasm@0: #include matthiasm@0: #include matthiasm@0: #include matthiasm@0: matthiasm@0: using std::string; matthiasm@0: using std::vector; matthiasm@0: using Vamp::RealTime; matthiasm@0: matthiasm@0: matthiasm@36: PYinVamp::PYinVamp(float inputSampleRate) : matthiasm@0: Plugin(inputSampleRate), matthiasm@0: m_channels(0), matthiasm@0: m_stepSize(256), matthiasm@0: m_blockSize(2048), matthiasm@0: m_fmin(40), matthiasm@58: m_fmax(1600), matthiasm@0: m_yin(2048, inputSampleRate, 0.0), matthiasm@0: m_oF0Candidates(0), matthiasm@0: m_oF0Probs(0), matthiasm@0: m_oVoicedProb(0), matthiasm@0: m_oCandidateSalience(0), matthiasm@0: m_oSmoothedPitchTrack(0), matthiasm@0: m_oNotes(0), matthiasm@0: m_threshDistr(2.0f), matthiasm@6: m_outputUnvoiced(0.0f), matthiasm@0: m_pitchProb(0), matthiasm@0: m_timestamp(0) matthiasm@0: { matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::~PYinVamp() matthiasm@0: { matthiasm@0: } matthiasm@0: matthiasm@0: string matthiasm@36: PYinVamp::getIdentifier() const matthiasm@0: { matthiasm@1: return "pyin"; matthiasm@0: } matthiasm@0: matthiasm@0: string matthiasm@36: PYinVamp::getName() const matthiasm@0: { matthiasm@1: return "pYin"; matthiasm@0: } matthiasm@0: matthiasm@0: string matthiasm@36: PYinVamp::getDescription() const matthiasm@0: { matthiasm@0: return "Monophonic pitch and note tracking based on a probabilistic Yin extension."; matthiasm@0: } matthiasm@0: matthiasm@0: string matthiasm@36: PYinVamp::getMaker() const matthiasm@0: { matthiasm@0: return "Matthias Mauch"; matthiasm@0: } matthiasm@0: matthiasm@0: int matthiasm@36: PYinVamp::getPluginVersion() const matthiasm@0: { matthiasm@0: // Increment this each time you release a version that behaves matthiasm@0: // differently from the previous one matthiasm@0: return 1; matthiasm@0: } matthiasm@0: matthiasm@0: string matthiasm@36: PYinVamp::getCopyright() const matthiasm@0: { matthiasm@0: return "GPL"; matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::InputDomain matthiasm@36: PYinVamp::getInputDomain() const matthiasm@0: { matthiasm@0: return TimeDomain; matthiasm@0: } matthiasm@0: matthiasm@0: size_t matthiasm@36: PYinVamp::getPreferredBlockSize() const matthiasm@0: { matthiasm@0: return 2048; matthiasm@0: } matthiasm@0: matthiasm@0: size_t matthiasm@36: PYinVamp::getPreferredStepSize() const matthiasm@0: { matthiasm@0: return 256; matthiasm@0: } matthiasm@0: matthiasm@0: size_t matthiasm@36: PYinVamp::getMinChannelCount() const matthiasm@0: { matthiasm@0: return 1; matthiasm@0: } matthiasm@0: matthiasm@0: size_t matthiasm@36: PYinVamp::getMaxChannelCount() const matthiasm@0: { matthiasm@0: return 1; matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::ParameterList matthiasm@36: PYinVamp::getParameterDescriptors() const matthiasm@0: { matthiasm@0: ParameterList list; matthiasm@0: matthiasm@0: ParameterDescriptor d; matthiasm@0: matthiasm@0: d.identifier = "threshdistr"; matthiasm@0: d.name = "Yin threshold distribution"; matthiasm@0: d.description = "."; matthiasm@0: d.unit = ""; matthiasm@0: d.minValue = 0.0f; matthiasm@0: d.maxValue = 7.0f; matthiasm@0: d.defaultValue = 2.0f; matthiasm@0: d.isQuantized = true; matthiasm@0: d.quantizeStep = 1.0f; matthiasm@0: d.valueNames.push_back("Uniform"); matthiasm@0: d.valueNames.push_back("Beta (mean 0.10)"); matthiasm@0: d.valueNames.push_back("Beta (mean 0.15)"); matthiasm@0: d.valueNames.push_back("Beta (mean 0.20)"); matthiasm@0: d.valueNames.push_back("Beta (mean 0.30)"); matthiasm@0: d.valueNames.push_back("Single Value 0.10"); matthiasm@0: d.valueNames.push_back("Single Value 0.15"); matthiasm@0: d.valueNames.push_back("Single Value 0.20"); matthiasm@0: list.push_back(d); matthiasm@0: matthiasm@0: d.identifier = "outputunvoiced"; matthiasm@0: d.valueNames.clear(); matthiasm@0: d.name = "Output estimates classified as unvoiced?"; matthiasm@0: d.description = "."; matthiasm@0: d.unit = ""; matthiasm@0: d.minValue = 0.0f; matthiasm@0: d.maxValue = 2.0f; matthiasm@6: d.defaultValue = 0.0f; matthiasm@0: d.isQuantized = true; matthiasm@0: d.quantizeStep = 1.0f; matthiasm@0: d.valueNames.push_back("No"); matthiasm@0: d.valueNames.push_back("Yes"); matthiasm@0: d.valueNames.push_back("Yes, as negative frequencies"); matthiasm@0: list.push_back(d); matthiasm@0: matthiasm@0: return list; matthiasm@0: } matthiasm@0: matthiasm@0: float matthiasm@36: PYinVamp::getParameter(string identifier) const matthiasm@0: { matthiasm@0: if (identifier == "threshdistr") { matthiasm@0: return m_threshDistr; matthiasm@0: } matthiasm@0: if (identifier == "outputunvoiced") { matthiasm@0: return m_outputUnvoiced; matthiasm@0: } matthiasm@0: return 0.f; matthiasm@0: } matthiasm@0: matthiasm@0: void matthiasm@36: PYinVamp::setParameter(string identifier, float value) matthiasm@0: { matthiasm@0: if (identifier == "threshdistr") matthiasm@0: { matthiasm@0: m_threshDistr = value; matthiasm@0: } matthiasm@0: if (identifier == "outputunvoiced") matthiasm@0: { matthiasm@0: m_outputUnvoiced = value; matthiasm@0: } matthiasm@0: matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::ProgramList matthiasm@36: PYinVamp::getPrograms() const matthiasm@0: { matthiasm@0: ProgramList list; matthiasm@0: return list; matthiasm@0: } matthiasm@0: matthiasm@0: string matthiasm@36: PYinVamp::getCurrentProgram() const matthiasm@0: { matthiasm@0: return ""; // no programs matthiasm@0: } matthiasm@0: matthiasm@0: void matthiasm@36: PYinVamp::selectProgram(string name) matthiasm@0: { matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::OutputList matthiasm@36: PYinVamp::getOutputDescriptors() const matthiasm@0: { matthiasm@0: OutputList outputs; matthiasm@0: matthiasm@0: OutputDescriptor d; matthiasm@0: matthiasm@0: int outputNumber = 0; matthiasm@0: matthiasm@0: d.identifier = "f0candidates"; matthiasm@0: d.name = "F0 Candidates"; matthiasm@0: d.description = "Estimated fundamental frequency candidates."; matthiasm@0: d.unit = "Hz"; matthiasm@0: d.hasFixedBinCount = false; matthiasm@0: // d.binCount = 1; matthiasm@0: d.hasKnownExtents = true; matthiasm@0: d.minValue = m_fmin; matthiasm@0: d.maxValue = 500; matthiasm@0: d.isQuantized = false; matthiasm@0: d.sampleType = OutputDescriptor::FixedSampleRate; matthiasm@0: d.sampleRate = (m_inputSampleRate / m_stepSize); matthiasm@0: d.hasDuration = false; matthiasm@0: outputs.push_back(d); matthiasm@0: m_oF0Candidates = outputNumber++; matthiasm@0: matthiasm@0: d.identifier = "f0probs"; matthiasm@0: d.name = "Candidate Probabilities"; matthiasm@0: d.description = "Probabilities of estimated fundamental frequency candidates."; matthiasm@0: d.unit = ""; matthiasm@0: d.hasFixedBinCount = false; matthiasm@0: // d.binCount = 1; matthiasm@0: d.hasKnownExtents = true; matthiasm@0: d.minValue = 0; matthiasm@0: d.maxValue = 1; matthiasm@0: d.isQuantized = false; matthiasm@0: d.sampleType = OutputDescriptor::FixedSampleRate; matthiasm@0: d.sampleRate = (m_inputSampleRate / m_stepSize); matthiasm@0: d.hasDuration = false; matthiasm@0: outputs.push_back(d); matthiasm@0: m_oF0Probs = outputNumber++; matthiasm@0: matthiasm@0: d.identifier = "voicedprob"; matthiasm@0: d.name = "Voiced Probability"; matthiasm@0: d.description = "Probability that the signal is voiced according to Probabilistic Yin."; matthiasm@0: d.unit = ""; matthiasm@0: d.hasFixedBinCount = true; matthiasm@0: d.binCount = 1; matthiasm@0: d.hasKnownExtents = true; matthiasm@0: d.minValue = 0; matthiasm@0: d.maxValue = 1; matthiasm@0: d.isQuantized = false; matthiasm@0: d.sampleType = OutputDescriptor::FixedSampleRate; matthiasm@0: d.sampleRate = (m_inputSampleRate / m_stepSize); matthiasm@0: d.hasDuration = false; matthiasm@0: outputs.push_back(d); matthiasm@0: m_oVoicedProb = outputNumber++; matthiasm@0: matthiasm@0: d.identifier = "candidatesalience"; matthiasm@0: d.name = "Candidate Salience"; matthiasm@0: d.description = "Candidate Salience"; matthiasm@0: d.hasFixedBinCount = true; matthiasm@0: d.binCount = m_blockSize / 2; matthiasm@0: d.hasKnownExtents = true; matthiasm@0: d.minValue = 0; matthiasm@0: d.maxValue = 1; matthiasm@0: d.isQuantized = false; matthiasm@0: d.sampleType = OutputDescriptor::FixedSampleRate; matthiasm@0: d.sampleRate = (m_inputSampleRate / m_stepSize); matthiasm@0: d.hasDuration = false; matthiasm@0: outputs.push_back(d); matthiasm@0: m_oCandidateSalience = outputNumber++; matthiasm@0: matthiasm@0: d.identifier = "smoothedpitchtrack"; matthiasm@0: d.name = "Smoothed Pitch Track"; matthiasm@0: d.description = "."; matthiasm@0: d.unit = "Hz"; matthiasm@0: d.hasFixedBinCount = true; matthiasm@0: d.binCount = 1; matthiasm@0: d.hasKnownExtents = false; matthiasm@0: // d.minValue = 0; matthiasm@0: // d.maxValue = 1; matthiasm@0: d.isQuantized = false; matthiasm@0: d.sampleType = OutputDescriptor::FixedSampleRate; matthiasm@0: d.sampleRate = (m_inputSampleRate / m_stepSize); matthiasm@0: d.hasDuration = false; matthiasm@0: outputs.push_back(d); matthiasm@0: m_oSmoothedPitchTrack = outputNumber++; matthiasm@0: matthiasm@0: d.identifier = "notes"; matthiasm@0: d.name = "Notes"; matthiasm@0: d.description = "Derived fixed-pitch note frequencies"; matthiasm@0: // d.unit = "MIDI unit"; matthiasm@0: d.unit = "Hz"; matthiasm@0: d.hasFixedBinCount = true; matthiasm@0: d.binCount = 1; matthiasm@0: d.hasKnownExtents = false; matthiasm@0: d.isQuantized = false; matthiasm@0: d.sampleType = OutputDescriptor::VariableSampleRate; matthiasm@0: d.sampleRate = (m_inputSampleRate / m_stepSize); matthiasm@0: d.hasDuration = true; matthiasm@0: outputs.push_back(d); matthiasm@0: m_oNotes = outputNumber++; matthiasm@0: matthiasm@0: return outputs; matthiasm@0: } matthiasm@0: matthiasm@0: bool matthiasm@36: PYinVamp::initialise(size_t channels, size_t stepSize, size_t blockSize) matthiasm@0: { matthiasm@0: if (channels < getMinChannelCount() || matthiasm@0: channels > getMaxChannelCount()) return false; matthiasm@0: Chris@9: /* matthiasm@36: std::cerr << "PYinVamp::initialise: channels = " << channels matthiasm@0: << ", stepSize = " << stepSize << ", blockSize = " << blockSize matthiasm@0: << std::endl; Chris@9: */ matthiasm@0: m_channels = channels; matthiasm@0: m_stepSize = stepSize; matthiasm@0: m_blockSize = blockSize; matthiasm@0: matthiasm@0: reset(); matthiasm@0: matthiasm@0: return true; matthiasm@0: } matthiasm@0: matthiasm@0: void matthiasm@36: PYinVamp::reset() matthiasm@0: { matthiasm@0: m_yin.setThresholdDistr(m_threshDistr); matthiasm@0: m_yin.setFrameSize(m_blockSize); matthiasm@0: matthiasm@0: m_pitchProb.clear(); matthiasm@0: m_timestamp.clear(); Chris@9: /* matthiasm@36: std::cerr << "PYinVamp::reset" matthiasm@0: << ", blockSize = " << m_blockSize matthiasm@0: << std::endl; Chris@9: */ matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::FeatureSet matthiasm@36: PYinVamp::process(const float *const *inputBuffers, RealTime timestamp) matthiasm@0: { matthiasm@60: timestamp = timestamp + Vamp::RealTime::frame2RealTime(m_blockSize/2, lrintf(m_inputSampleRate)); matthiasm@0: FeatureSet fs; matthiasm@0: matthiasm@46: float rms = 0; matthiasm@46: matthiasm@0: double *dInputBuffers = new double[m_blockSize]; matthiasm@46: for (size_t i = 0; i < m_blockSize; ++i) { matthiasm@46: dInputBuffers[i] = inputBuffers[0][i]; matthiasm@46: rms += inputBuffers[0][i] * inputBuffers[0][i]; matthiasm@46: } matthiasm@46: rms /= m_blockSize; matthiasm@46: rms = sqrt(rms); matthiasm@58: float lowAmp = 0.05; matthiasm@50: bool isLowAmplitude = (rms < lowAmp); matthiasm@0: matthiasm@0: Yin::YinOutput yo = m_yin.processProbabilisticYin(dInputBuffers); matthiasm@27: delete [] dInputBuffers; matthiasm@27: matthiasm@27: // First, get the things out of the way that we don't want to output matthiasm@27: // immediately, but instead save for later. matthiasm@27: vector > tempPitchProb; matthiasm@27: for (size_t iCandidate = 0; iCandidate < yo.freqProb.size(); ++iCandidate) matthiasm@27: { matthiasm@27: double tempPitch = 12 * std::log(yo.freqProb[iCandidate].first/440)/std::log(2.) + 69; matthiasm@50: if (!isLowAmplitude) matthiasm@46: tempPitchProb.push_back(pair matthiasm@46: (tempPitch, yo.freqProb[iCandidate].second)); matthiasm@46: else matthiasm@46: tempPitchProb.push_back(pair matthiasm@58: (tempPitch, yo.freqProb[iCandidate].second*((rms+0.01*lowAmp)/(1.01*lowAmp)))); matthiasm@27: } matthiasm@27: m_pitchProb.push_back(tempPitchProb); matthiasm@27: m_timestamp.push_back(timestamp); matthiasm@27: matthiasm@27: // F0 CANDIDATES matthiasm@0: Feature f; matthiasm@0: f.hasTimestamp = true; matthiasm@0: f.timestamp = timestamp; matthiasm@0: for (size_t i = 0; i < yo.freqProb.size(); ++i) matthiasm@0: { matthiasm@0: f.values.push_back(yo.freqProb[i].first); matthiasm@0: } matthiasm@0: fs[m_oF0Candidates].push_back(f); matthiasm@0: matthiasm@27: // VOICEDPROB matthiasm@0: f.values.clear(); matthiasm@0: float voicedProb = 0; matthiasm@0: for (size_t i = 0; i < yo.freqProb.size(); ++i) matthiasm@0: { matthiasm@0: f.values.push_back(yo.freqProb[i].second); matthiasm@0: voicedProb += yo.freqProb[i].second; matthiasm@0: } matthiasm@0: fs[m_oF0Probs].push_back(f); matthiasm@0: matthiasm@0: f.values.push_back(voicedProb); matthiasm@0: fs[m_oVoicedProb].push_back(f); matthiasm@0: matthiasm@27: // SALIENCE -- maybe this should eventually disappear matthiasm@0: f.values.clear(); matthiasm@0: float salienceSum = 0; matthiasm@0: for (size_t iBin = 0; iBin < yo.salience.size(); ++iBin) matthiasm@0: { matthiasm@0: f.values.push_back(yo.salience[iBin]); matthiasm@0: salienceSum += yo.salience[iBin]; matthiasm@0: } matthiasm@0: fs[m_oCandidateSalience].push_back(f); matthiasm@0: matthiasm@0: return fs; matthiasm@0: } matthiasm@0: matthiasm@36: PYinVamp::FeatureSet matthiasm@36: PYinVamp::getRemainingFeatures() matthiasm@0: { matthiasm@0: FeatureSet fs; matthiasm@0: Feature f; matthiasm@0: f.hasTimestamp = true; matthiasm@0: f.hasDuration = false; matthiasm@0: Chris@4: if (m_pitchProb.empty()) { Chris@4: return fs; Chris@4: } Chris@4: matthiasm@0: // MONO-PITCH STUFF matthiasm@0: MonoPitch mp; matthiasm@0: vector mpOut = mp.process(m_pitchProb); matthiasm@0: for (size_t iFrame = 0; iFrame < mpOut.size(); ++iFrame) matthiasm@0: { matthiasm@0: if (mpOut[iFrame] < 0 && (m_outputUnvoiced==0)) continue; matthiasm@0: f.timestamp = m_timestamp[iFrame]; matthiasm@0: f.values.clear(); matthiasm@0: if (m_outputUnvoiced == 1) matthiasm@0: { matthiasm@26: f.values.push_back(fabs(mpOut[iFrame])); matthiasm@0: } else { matthiasm@0: f.values.push_back(mpOut[iFrame]); matthiasm@0: } matthiasm@0: matthiasm@0: fs[m_oSmoothedPitchTrack].push_back(f); matthiasm@0: } matthiasm@0: matthiasm@1: // MONO-NOTE STUFF matthiasm@58: std::cerr << "Mono Note Stuff" << std::endl; matthiasm@1: MonoNote mn; matthiasm@1: std::vector > > smoothedPitch; matthiasm@1: for (size_t iFrame = 0; iFrame < mpOut.size(); ++iFrame) { matthiasm@1: std::vector > temp; matthiasm@1: if (mpOut[iFrame] > 0) matthiasm@1: { matthiasm@1: double tempPitch = 12 * std::log(mpOut[iFrame]/440)/std::log(2.) + 69; matthiasm@1: temp.push_back(std::pair(tempPitch, .9)); matthiasm@1: } matthiasm@1: smoothedPitch.push_back(temp); matthiasm@1: } matthiasm@0: // vector mnOut = mn.process(m_pitchProb); matthiasm@1: vector mnOut = mn.process(smoothedPitch); matthiasm@1: matthiasm@6: // turning feature into a note feature matthiasm@1: f.hasTimestamp = true; matthiasm@1: f.hasDuration = true; matthiasm@1: f.values.clear(); matthiasm@6: matthiasm@6: int onsetFrame = 0; matthiasm@6: bool isVoiced = 0; matthiasm@6: bool oldIsVoiced = 0; matthiasm@6: size_t nFrame = m_pitchProb.size(); matthiasm@1: matthiasm@6: std::vector notePitchTrack; // collects pitches for one note at a time matthiasm@6: for (size_t iFrame = 0; iFrame < nFrame; ++iFrame) matthiasm@1: { matthiasm@6: isVoiced = mnOut[iFrame].noteState < 3 && smoothedPitch[iFrame].size() > 0; matthiasm@6: if (isVoiced && iFrame != nFrame-1) matthiasm@1: { matthiasm@6: if (oldIsVoiced == 0) // beginning of a note matthiasm@1: { matthiasm@6: onsetFrame = iFrame; matthiasm@6: notePitchTrack.clear(); matthiasm@1: } matthiasm@6: float pitch = smoothedPitch[iFrame][0].first; matthiasm@6: notePitchTrack.push_back(pitch); // add to the note's pitch track matthiasm@6: } else { // not currently voiced matthiasm@6: if (oldIsVoiced == 1 && notePitchTrack.size() > 4) // end of the note matthiasm@6: { matthiasm@1: std::sort(notePitchTrack.begin(), notePitchTrack.end()); matthiasm@6: float medianPitch = notePitchTrack[notePitchTrack.size()/2]; matthiasm@6: float medianFreq = std::pow(2,(medianPitch - 69) / 12) * 440; matthiasm@6: f.values.clear(); matthiasm@6: f.values.push_back(medianFreq); matthiasm@6: f.timestamp = m_timestamp[onsetFrame]; matthiasm@6: f.duration = m_timestamp[iFrame] - m_timestamp[onsetFrame]; matthiasm@5: fs[m_oNotes].push_back(f); matthiasm@1: } matthiasm@1: } matthiasm@6: oldIsVoiced = isVoiced; matthiasm@1: } matthiasm@0: return fs; matthiasm@0: }