Chris@366: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@366: /*
Chris@366:     Constant-Q library
Chris@366:     Copyright (c) 2013-2014 Queen Mary, University of London
Chris@366: 
Chris@366:     Permission is hereby granted, free of charge, to any person
Chris@366:     obtaining a copy of this software and associated documentation
Chris@366:     files (the "Software"), to deal in the Software without
Chris@366:     restriction, including without limitation the rights to use, copy,
Chris@366:     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@366:     of the Software, and to permit persons to whom the Software is
Chris@366:     furnished to do so, subject to the following conditions:
Chris@366: 
Chris@366:     The above copyright notice and this permission notice shall be
Chris@366:     included in all copies or substantial portions of the Software.
Chris@366: 
Chris@366:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@366:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@366:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@366:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
Chris@366:     CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@366:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@366:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@366: 
Chris@366:     Except as contained in this notice, the names of the Centre for
Chris@366:     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@366:     shall not be used in advertising or otherwise to promote the sale,
Chris@366:     use or other dealings in this Software without prior written
Chris@366:     authorization.
Chris@366: */
Chris@366: 
Chris@366: #include "CQVamp.h"
Chris@366: 
Chris@366: #include "Pitch.h"
Chris@366: 
Chris@366: #include <algorithm>
Chris@366: #include <cstdio>
Chris@366: 
Chris@366: using std::string;
Chris@366: using std::vector;
Chris@366: using std::cerr;
Chris@366: using std::endl;
Chris@366: 
Chris@366: // The plugin offers either MIDI pitch or frequency range parameters,
Chris@366: // depending on the midiPitchParameters option given to the
Chris@366: // constructor. It never offers both. So they can have different
Chris@366: // defaults; if we're using MIDI pitch, the min and max frequencies
Chris@366: // will come from those rather than from the m_minFrequency and
Chris@366: // m_maxFrequency members.
Chris@366: static const int defaultMinMIDIPitch = 36;
Chris@366: static const int defaultMaxMIDIPitch = 96;
Chris@366: static const int defaultBPO = 36;
Chris@366: static const float defaultMinFrequency = 110;
Chris@366: static const float defaultMaxFrequency = 14700;
Chris@366: static const float defaultTuningFrequency = 440.f;
Chris@366: 
Chris@366: CQVamp::CQVamp(float inputSampleRate, bool midiPitchParameters) :
Chris@366:     Vamp::Plugin(inputSampleRate),
Chris@366:     m_midiPitchParameters(midiPitchParameters),
Chris@366:     m_minMIDIPitch(defaultMinMIDIPitch),
Chris@366:     m_maxMIDIPitch(defaultMaxMIDIPitch),
Chris@366:     m_tuningFrequency(defaultTuningFrequency),
Chris@366:     m_bpo(defaultBPO),
Chris@366:     m_interpolation(CQSpectrogram::InterpolateLinear),
Chris@366:     m_cq(0),
Chris@366:     m_maxFrequency(defaultMaxFrequency),
Chris@366:     m_minFrequency(defaultMinFrequency),
Chris@366:     m_haveStartTime(false),
Chris@366:     m_columnCount(0)
Chris@366: {
Chris@366: }
Chris@366: 
Chris@366: CQVamp::~CQVamp()
Chris@366: {
Chris@366:     delete m_cq;
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQVamp::getIdentifier() const
Chris@366: {
Chris@366:     if (m_midiPitchParameters) {
Chris@366:         return "cqvampmidi";
Chris@366:     } else {
Chris@366:         return "cqvamp";
Chris@366:     }
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQVamp::getName() const
Chris@366: {
Chris@366:     if (m_midiPitchParameters) {
Chris@366:         return "CQ Constant-Q Spectrogram (MIDI pitch range)";
Chris@366:     } else {
Chris@366:         return "CQ Constant-Q Spectrogram (Hz range)";
Chris@366:     }
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQVamp::getDescription() const
Chris@366: {
Chris@366:     if (m_midiPitchParameters) {
Chris@366:         return "Extract a spectrogram with constant ratio of centre frequency to resolution from the input audio, specifying the frequency range in MIDI pitch units.";
Chris@366:     } else {
Chris@366:         return "Extract a spectrogram with constant ratio of centre frequency to resolution from the input audio, specifying the frequency range in Hz.";
Chris@366:     }
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQVamp::getMaker() const
Chris@366: {
Chris@366:     return "Queen Mary, University of London";
Chris@366: }
Chris@366: 
Chris@366: int
Chris@366: CQVamp::getPluginVersion() const
Chris@366: {
Chris@366:     return 2;
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQVamp::getCopyright() const
Chris@366: {
Chris@366:     return "Plugin by Chris Cannam. Method by Christian Schörkhuber and Anssi Klapuri. Copyright (c) 2015 QMUL. BSD/MIT licence.";
Chris@366: }
Chris@366: 
Chris@366: CQVamp::ParameterList
Chris@366: CQVamp::getParameterDescriptors() const
Chris@366: {
Chris@366:     ParameterList list;
Chris@366: 
Chris@366:     ParameterDescriptor desc;
Chris@366: 
Chris@366:     if (m_midiPitchParameters) {
Chris@366: 
Chris@366:         desc.identifier = "minpitch";
Chris@366:         desc.name = "Minimum Pitch";
Chris@366:         desc.unit = "MIDI units";
Chris@366:         desc.description = "MIDI pitch corresponding to the lowest frequency to be included in the constant-Q transform. (The actual minimum frequency may be lower, as the range always covers an integral number of octaves below the highest frequency.)";
Chris@366:         desc.minValue = 0;
Chris@366:         desc.maxValue = 127;
Chris@366:         desc.defaultValue = defaultMinMIDIPitch;
Chris@366:         desc.isQuantized = true;
Chris@366:         desc.quantizeStep = 1;
Chris@366:         list.push_back(desc);
Chris@366: 
Chris@366:         desc.identifier = "maxpitch";
Chris@366:         desc.name = "Maximum Pitch";
Chris@366:         desc.unit = "MIDI units";
Chris@366:         desc.description = "MIDI pitch corresponding to the highest frequency to be included in the constant-Q transform";
Chris@366:         desc.minValue = 0;
Chris@366:         desc.maxValue = 127;
Chris@366:         desc.defaultValue = defaultMaxMIDIPitch;
Chris@366:         desc.isQuantized = true;
Chris@366:         desc.quantizeStep = 1;
Chris@366:         list.push_back(desc);
Chris@366: 
Chris@366:         desc.identifier = "tuning";
Chris@366:         desc.name = "Tuning Frequency";
Chris@366:         desc.unit = "Hz";
Chris@366:         desc.description = "Frequency of concert A";
Chris@366:         desc.minValue = 360;
Chris@366:         desc.maxValue = 500;
Chris@366:         desc.defaultValue = defaultTuningFrequency;
Chris@366:         desc.isQuantized = false;
Chris@366:         list.push_back(desc);
Chris@366: 
Chris@366:     } else {
Chris@366: 
Chris@366:         desc.identifier = "minfreq";
Chris@366:         desc.name = "Minimum Frequency";
Chris@366:         desc.unit = "Hz";
Chris@366:         desc.description = "Lowest frequency to be included in the constant-Q transform. (The actual minimum frequency may be lower, as the range always covers an integral number of octaves below the highest frequency.)";
Chris@366:         desc.minValue = 1;
Chris@366:         desc.maxValue = 22050;
Chris@366:         desc.defaultValue = defaultMinFrequency;
Chris@366:         desc.isQuantized = false;
Chris@366:         list.push_back(desc);
Chris@366: 
Chris@366:         desc.identifier = "maxfreq";
Chris@366:         desc.name = "Maximum Frequency";
Chris@366:         desc.unit = "Hz";
Chris@366:         desc.description = "MIDI pitch corresponding to the highest frequency to be included in the constant-Q transform";
Chris@366:         desc.minValue = 1;
Chris@366:         desc.maxValue = 22050;
Chris@366:         desc.defaultValue = defaultMaxFrequency;
Chris@366:         desc.isQuantized = false;
Chris@366:         list.push_back(desc);
Chris@366:     }
Chris@366:     
Chris@366:     desc.identifier = "bpo";
Chris@366:     desc.name = "Bins per Octave";
Chris@366:     desc.unit = "bins";
Chris@366:     desc.description = "Number of constant-Q transform bins per octave";
Chris@366:     desc.minValue = 2;
Chris@366:     desc.maxValue = 480;
Chris@366:     desc.defaultValue = defaultBPO;
Chris@366:     desc.isQuantized = true;
Chris@366:     desc.quantizeStep = 1;
Chris@366:     list.push_back(desc);
Chris@366: 
Chris@366:     desc.identifier = "interpolation";
Chris@366:     desc.name = "Interpolation";
Chris@366:     desc.unit = "";
Chris@366:     desc.description = "Interpolation method used to fill empty cells in lower octaves";
Chris@366:     desc.minValue = 0;
Chris@366:     desc.maxValue = 2;
Chris@366:     desc.defaultValue = 2;
Chris@366:     desc.isQuantized = true;
Chris@366:     desc.quantizeStep = 1;
Chris@366:     desc.valueNames.push_back("None, leave as zero");
Chris@366:     desc.valueNames.push_back("None, repeat prior value");
Chris@366:     desc.valueNames.push_back("Linear interpolation");
Chris@366:     list.push_back(desc);
Chris@366: 
Chris@366:     return list;
Chris@366: }
Chris@366: 
Chris@366: float
Chris@366: CQVamp::getParameter(std::string param) const
Chris@366: {
Chris@366:     if (param == "minpitch" && m_midiPitchParameters) {
Chris@366:         return m_minMIDIPitch;
Chris@366:     }
Chris@366:     if (param == "maxpitch" && m_midiPitchParameters) {
Chris@366:         return m_maxMIDIPitch;
Chris@366:     }
Chris@366:     if (param == "tuning" && m_midiPitchParameters) {
Chris@366:         return m_tuningFrequency;
Chris@366:     }
Chris@366:     if (param == "bpo") {
Chris@366:         return m_bpo;
Chris@366:     }
Chris@366:     if (param == "interpolation") {
Chris@366:         return (float)m_interpolation;
Chris@366:     }
Chris@366:     if (param == "minfreq" && !m_midiPitchParameters) {
Chris@366:         return m_minFrequency;
Chris@366:     }
Chris@366:     if (param == "maxfreq" && !m_midiPitchParameters) {
Chris@366:         return m_maxFrequency;
Chris@366:     }
Chris@366:     std::cerr << "WARNING: CQVamp::getParameter: unknown parameter \""
Chris@366:               << param << "\"" << std::endl;
Chris@366:     return 0.0;
Chris@366: }
Chris@366: 
Chris@366: void
Chris@366: CQVamp::setParameter(std::string param, float value)
Chris@366: {
Chris@366:     if (param == "minpitch" && m_midiPitchParameters) {
Chris@366:         m_minMIDIPitch = int(value + 0.5f);
Chris@366:     } else if (param == "maxpitch" && m_midiPitchParameters) {
Chris@366:         m_maxMIDIPitch = int(value + 0.5f);
Chris@366:     } else if (param == "tuning" && m_midiPitchParameters) {
Chris@366:         m_tuningFrequency = value;
Chris@366:     } else if (param == "bpo") {
Chris@366:         m_bpo = int(value + 0.5f);
Chris@366:     } else if (param == "interpolation") {
Chris@366:         m_interpolation = (CQSpectrogram::Interpolation)int(value + 0.5f);
Chris@366:     } else if (param == "minfreq" && !m_midiPitchParameters) {
Chris@366:         m_minFrequency = value;
Chris@366:     } else if (param == "maxfreq" && !m_midiPitchParameters) {
Chris@366:         m_maxFrequency = value;
Chris@366:     } else {
Chris@366:         std::cerr << "WARNING: CQVamp::setParameter: unknown parameter \""
Chris@366:                   << param << "\"" << std::endl;
Chris@366:     }
Chris@366: }
Chris@366: 
Chris@366: bool
Chris@366: CQVamp::initialise(size_t channels, size_t stepSize, size_t blockSize)
Chris@366: {
Chris@366:     if (m_cq) {
Chris@366: 	delete m_cq;
Chris@366:         m_cq = 0;
Chris@366:     }
Chris@366: 
Chris@366:     if (channels < getMinChannelCount() ||
Chris@366: 	channels > getMaxChannelCount()) return false;
Chris@366: 
Chris@366:     m_stepSize = stepSize;
Chris@366:     m_blockSize = blockSize;
Chris@366: 
Chris@366:     if (m_midiPitchParameters) {
Chris@366:         m_minFrequency = Pitch::getFrequencyForPitch
Chris@366:             (m_minMIDIPitch, 0, m_tuningFrequency);
Chris@366:         m_maxFrequency = Pitch::getFrequencyForPitch
Chris@366:             (m_maxMIDIPitch, 0, m_tuningFrequency);
Chris@366:     }
Chris@366: 
Chris@366:     reset();
Chris@366: 
Chris@366:     if (!m_cq || !m_cq->isValid()) {
Chris@366:         cerr << "CQVamp::initialise: Constant-Q parameters not valid! Not initialising" << endl;
Chris@366:         return false;
Chris@366:     }
Chris@366: 
Chris@366:     return true;
Chris@366: }
Chris@366: 
Chris@366: void
Chris@366: CQVamp::reset()
Chris@366: {
Chris@366:     delete m_cq;
Chris@366:     CQParameters p(m_inputSampleRate, m_minFrequency, m_maxFrequency, m_bpo);
Chris@366:     m_cq = new CQSpectrogram(p, m_interpolation);
Chris@366:     m_haveStartTime = false;
Chris@366:     m_columnCount = 0;
Chris@366: }
Chris@366: 
Chris@366: size_t
Chris@366: CQVamp::getPreferredStepSize() const
Chris@366: {
Chris@366:     return 0;
Chris@366: }
Chris@366: 
Chris@366: size_t
Chris@366: CQVamp::getPreferredBlockSize() const
Chris@366: {
Chris@366:     return 0;
Chris@366: }
Chris@366: 
Chris@366: std::string
Chris@366: CQVamp::noteName(int i) const
Chris@366: {
Chris@366:     static const char *names[] = {
Chris@366:         "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"
Chris@366:     };
Chris@366: 
Chris@366:     const char *n = names[i % 12];
Chris@366:     int oct = i / 12 - 1;
Chris@366:     char buf[20];
Chris@366:     sprintf(buf, "%d %s%d", i, n, oct);
Chris@366: 
Chris@366:     return buf;
Chris@366: }
Chris@366: 
Chris@366: CQVamp::OutputList
Chris@366: CQVamp::getOutputDescriptors() const
Chris@366: {
Chris@366:     OutputList list;
Chris@366: 
Chris@366:     OutputDescriptor d;
Chris@366:     d.identifier = "constantq";
Chris@366:     d.name = "Constant-Q Spectrogram";
Chris@366:     d.unit = "";
Chris@366:     d.description = "Output of constant-Q transform, as a single vector per process block";
Chris@366:     d.hasFixedBinCount = true;
Chris@366:     d.binCount = (m_cq ? m_cq->getTotalBins() : (9 * 24));
Chris@366: 
Chris@366:     if (m_cq) {
Chris@366:         char name[20];
Chris@366:         for (int i = 0; i < (int)d.binCount; ++i) {
Chris@366:             float freq = m_cq->getBinFrequency(d.binCount - i - 1);
Chris@366:             sprintf(name, "%.1f Hz", freq);
Chris@366:             int note = Pitch::getPitchForFrequency(freq, 0, m_tuningFrequency);
Chris@366:             float nearestFreq =
Chris@366:                 Pitch::getFrequencyForPitch(note, 0, m_tuningFrequency);
Chris@366:             if (fabs(freq - nearestFreq) < 0.01) {
Chris@366:                 d.binNames.push_back(name + std::string(" ") + noteName(note));
Chris@366:             } else {
Chris@366:                 d.binNames.push_back(name);
Chris@366:             }
Chris@366:         }
Chris@366:     }
Chris@366: 
Chris@366:     d.hasKnownExtents = false;
Chris@366:     d.isQuantized = false;
Chris@366:     d.sampleType = OutputDescriptor::FixedSampleRate;
Chris@366:     d.sampleRate = m_inputSampleRate / (m_cq ? m_cq->getColumnHop() : 256);
Chris@366:     list.push_back(d);
Chris@366: 
Chris@366:     return list;
Chris@366: }
Chris@366: 
Chris@366: CQVamp::FeatureSet
Chris@366: CQVamp::process(const float *const *inputBuffers,
Chris@366: 		Vamp::RealTime timestamp)
Chris@366: {
Chris@366:     if (!m_cq) {
Chris@366: 	cerr << "ERROR: CQVamp::process: "
Chris@366: 	     << "Plugin has not been initialised"
Chris@366: 	     << endl;
Chris@366: 	return FeatureSet();
Chris@366:     }
Chris@366: 
Chris@366:     if (!m_haveStartTime) {
Chris@366:         m_startTime = timestamp;
Chris@366:         m_haveStartTime = true;
Chris@366:     }
Chris@366: 
Chris@366:     vector<double> data;
Chris@366:     for (int i = 0; i < m_blockSize; ++i) data.push_back(inputBuffers[0][i]);
Chris@366:     
Chris@366:     vector<vector<double> > cqout = m_cq->process(data);
Chris@366:     return convertToFeatures(cqout);
Chris@366: }
Chris@366: 
Chris@366: CQVamp::FeatureSet
Chris@366: CQVamp::getRemainingFeatures()
Chris@366: {
Chris@366:     vector<vector<double> > cqout = m_cq->getRemainingOutput();
Chris@366:     return convertToFeatures(cqout);
Chris@366: }
Chris@366: 
Chris@366: CQVamp::FeatureSet
Chris@366: CQVamp::convertToFeatures(const vector<vector<double> > &cqout)
Chris@366: {
Chris@366:     FeatureSet returnFeatures;
Chris@366: 
Chris@366:     int width = cqout.size();
Chris@366:     int height = m_cq->getTotalBins();
Chris@366: 
Chris@366:     for (int i = 0; i < width; ++i) {
Chris@366: 
Chris@366: 	vector<float> column(height, 0.f);
Chris@366:         int thisHeight = cqout[i].size();
Chris@366: 	for (int j = 0; j < thisHeight; ++j) {
Chris@366: 	    column[j] = cqout[i][j];
Chris@366: 	}
Chris@366: 
Chris@366:         // put low frequencies at the start
Chris@366:         std::reverse(column.begin(), column.end());
Chris@366: 
Chris@366: 	Feature feature;
Chris@366: 	feature.hasTimestamp = true;
Chris@366:         feature.timestamp = m_startTime + Vamp::RealTime::frame2RealTime
Chris@366:             (m_columnCount * m_cq->getColumnHop() - m_cq->getLatency(),
Chris@366:              m_inputSampleRate);
Chris@366: 	feature.values = column;
Chris@366: 	feature.label = "";
Chris@366: 
Chris@366: //        cerr << "timestamp = " << feature.timestamp << " (start time = " << m_startTime << ", column count = " << m_columnCount << ", latency = " << m_cq->getLatency() << ", sample rate " << m_inputSampleRate << ")" << endl;
Chris@366: 
Chris@366:         if (feature.timestamp >= m_startTime) {
Chris@366:             returnFeatures[0].push_back(feature);
Chris@366:         }
Chris@366: 
Chris@366:         ++m_columnCount;
Chris@366:     }
Chris@366: 
Chris@366:     return returnFeatures;
Chris@366: }
Chris@366: