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 "CQChromaVamp.h"
Chris@366: 
Chris@366: #include "cq/Chromagram.h"
Chris@366: 
Chris@366: #include <algorithm>
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: static const int defaultLowestOctave = 0;
Chris@366: static const int defaultOctaveCount = 7;
Chris@366: static const int defaultBPO = 36;
Chris@366: static const float defaultTuningFrequency = 440.f;
Chris@366: 
Chris@366: CQChromaVamp::CQChromaVamp(float inputSampleRate) :
Chris@366:     Vamp::Plugin(inputSampleRate),
Chris@366:     m_lowestOctave(defaultLowestOctave),
Chris@366:     m_octaveCount(defaultOctaveCount),
Chris@366:     m_tuningFrequency(defaultTuningFrequency),
Chris@366:     m_bpo(defaultBPO),
Chris@366:     m_chroma(0),
Chris@366:     m_haveStartTime(false),
Chris@366:     m_columnCount(0)
Chris@366: {
Chris@366: }
Chris@366: 
Chris@366: CQChromaVamp::~CQChromaVamp()
Chris@366: {
Chris@366:     delete m_chroma;
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQChromaVamp::getIdentifier() const
Chris@366: {
Chris@366:     return "cqchromavamp";
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQChromaVamp::getName() const
Chris@366: {
Chris@366:     return "CQ Chromagram";
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQChromaVamp::getDescription() const
Chris@366: {
Chris@366:     return "Extract a Constant-Q spectrogram with constant ratio of centre frequency to resolution from the audio, then wrap it around into a single-octave chromagram.";
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQChromaVamp::getMaker() const
Chris@366: {
Chris@366:     return "Queen Mary, University of London";
Chris@366: }
Chris@366: 
Chris@366: int
Chris@366: CQChromaVamp::getPluginVersion() const
Chris@366: {
Chris@366:     return 2;
Chris@366: }
Chris@366: 
Chris@366: string
Chris@366: CQChromaVamp::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: CQChromaVamp::ParameterList
Chris@366: CQChromaVamp::getParameterDescriptors() const
Chris@366: {
Chris@366:     ParameterList list;
Chris@366: 
Chris@366:     ParameterDescriptor desc;
Chris@366: 
Chris@366:     desc.identifier = "lowestoct";
Chris@366:     desc.name = "Lowest Contributing Octave";
Chris@366:     desc.unit = "";
Chris@366:     desc.description = "Octave number of the lowest octave to include in the chromagram. Octave numbering is ASA standard, with -1 as the first octave in the MIDI range and middle-C being C4. The octave starts at C.";
Chris@366:     desc.minValue = -1;
Chris@366:     desc.maxValue = 12;
Chris@366:     desc.defaultValue = defaultLowestOctave;
Chris@366:     desc.isQuantized = true;
Chris@366:     desc.quantizeStep = 1;
Chris@366:     list.push_back(desc);
Chris@366: 
Chris@366:     desc.identifier = "octaves";
Chris@366:     desc.name = "Contributing Octave Count";
Chris@366:     desc.unit = "octaves";
Chris@366:     desc.description = "Number of octaves to use when generating the Constant-Q transform. All octaves are wrapped around and summed to produce a single octave chromagram as output.";
Chris@366:     desc.minValue = 1;
Chris@366:     desc.maxValue = 12;
Chris@366:     desc.defaultValue = defaultOctaveCount;
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:     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:     return list;
Chris@366: }
Chris@366: 
Chris@366: float
Chris@366: CQChromaVamp::getParameter(std::string param) const
Chris@366: {
Chris@366:     if (param == "lowestoct") {
Chris@366:         return m_lowestOctave;
Chris@366:     }
Chris@366:     if (param == "octaves") {
Chris@366:         return m_octaveCount;
Chris@366:     }
Chris@366:     if (param == "tuning") {
Chris@366:         return m_tuningFrequency;
Chris@366:     }
Chris@366:     if (param == "bpo") {
Chris@366:         return m_bpo;
Chris@366:     }
Chris@366:     std::cerr << "WARNING: CQChromaVamp::getParameter: unknown parameter \""
Chris@366:               << param << "\"" << std::endl;
Chris@366:     return 0.0;
Chris@366: }
Chris@366: 
Chris@366: void
Chris@366: CQChromaVamp::setParameter(std::string param, float value)
Chris@366: {
Chris@366:     if (param == "lowestoct") {
Chris@366:         m_lowestOctave = int(value + 0.5f);
Chris@366:     } else if (param == "octaves") {
Chris@366:         m_octaveCount = int(value + 0.5f);
Chris@366:     } else if (param == "tuning") {
Chris@366:         m_tuningFrequency = value;
Chris@366:     } else if (param == "bpo") {
Chris@366:         m_bpo = int(value + 0.5f);
Chris@366:     } else {
Chris@366:         std::cerr << "WARNING: CQChromaVamp::setParameter: unknown parameter \""
Chris@366:                   << param << "\"" << std::endl;
Chris@366:     }
Chris@366: }
Chris@366: 
Chris@366: bool
Chris@366: CQChromaVamp::initialise(size_t channels, size_t stepSize, size_t blockSize)
Chris@366: {
Chris@366:     if (m_chroma) {
Chris@366: 	delete m_chroma;
Chris@366:         m_chroma = 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:     reset();
Chris@366: 
Chris@366:     if (!m_chroma || !m_chroma->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: CQChromaVamp::reset()
Chris@366: {
Chris@366:     delete m_chroma;
Chris@366:     Chromagram::Parameters p(m_inputSampleRate);
Chris@366:     p.lowestOctave = m_lowestOctave;
Chris@366:     p.octaveCount = m_octaveCount;
Chris@366:     p.binsPerOctave = m_bpo;
Chris@366:     p.tuningFrequency = m_tuningFrequency;
Chris@366: 
Chris@366:     m_chroma = new Chromagram(p);
Chris@366: 
Chris@366:     m_haveStartTime = false;
Chris@366:     m_startTime = Vamp::RealTime::zeroTime;
Chris@366:     m_columnCount = 0;
Chris@366: }
Chris@366: 
Chris@366: size_t
Chris@366: CQChromaVamp::getPreferredStepSize() const
Chris@366: {
Chris@366:     return 0;
Chris@366: }
Chris@366: 
Chris@366: size_t
Chris@366: CQChromaVamp::getPreferredBlockSize() const
Chris@366: {
Chris@366:     return 0;
Chris@366: }
Chris@366: 
Chris@366: CQChromaVamp::OutputList
Chris@366: CQChromaVamp::getOutputDescriptors() const
Chris@366: {
Chris@366:     OutputList list;
Chris@366: 
Chris@366:     OutputDescriptor d;
Chris@366:     d.identifier = "chromagram";
Chris@366:     d.name = "Chromagram";
Chris@366:     d.unit = "";
Chris@366:     d.description = "Chromagram obtained from output of constant-Q transform, folding over each process block into a single-octave vector";
Chris@366:     d.hasFixedBinCount = true;
Chris@366:     d.binCount = m_bpo;
Chris@366: 
Chris@366:     if (m_chroma) {
Chris@366:         for (int i = 0; i < (int)d.binCount; ++i) {
Chris@366:             d.binNames.push_back(m_chroma->getBinName(i));
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_chroma ? m_chroma->getColumnHop() : 256);
Chris@366:     list.push_back(d);
Chris@366: 
Chris@366:     return list;
Chris@366: }
Chris@366: 
Chris@366: CQChromaVamp::FeatureSet
Chris@366: CQChromaVamp::process(const float *const *inputBuffers,
Chris@366:                       Vamp::RealTime timestamp)
Chris@366: {
Chris@366:     if (!m_chroma) {
Chris@366: 	cerr << "ERROR: CQChromaVamp::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> > chromaout = m_chroma->process(data);
Chris@366:     return convertToFeatures(chromaout);
Chris@366: }
Chris@366: 
Chris@366: CQChromaVamp::FeatureSet
Chris@366: CQChromaVamp::getRemainingFeatures()
Chris@366: {
Chris@366:     vector<vector<double> > chromaout = m_chroma->getRemainingOutput();
Chris@366:     return convertToFeatures(chromaout);
Chris@366: }
Chris@366: 
Chris@366: CQChromaVamp::FeatureSet
Chris@366: CQChromaVamp::convertToFeatures(const vector<vector<double> > &chromaout)
Chris@366: {
Chris@366:     FeatureSet returnFeatures;
Chris@366: 
Chris@366:     int width = chromaout.size();
Chris@366: 
Chris@366:     for (int i = 0; i < width; ++i) {
Chris@366: 
Chris@366: 	vector<float> column(chromaout[i].begin(), chromaout[i].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_chroma->getColumnHop() - m_chroma->getLatency(),
Chris@366:              m_inputSampleRate);
Chris@366: 	feature.values = column;
Chris@366: 	feature.label = "";
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: