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:     
cannam@0:     This program is free software; you can redistribute it and/or
cannam@0:     modify it under the terms of the GNU General Public License as
cannam@0:     published by the Free Software Foundation; either version 2 of the
cannam@0:     License, or (at your option) any later version.  See the file
cannam@0:     COPYING included with this distribution for more information.
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@0:     m_pitchdet(0),
piem@2:     m_pitchtype(aubio_pitch_yinfft),
cannam@0:     m_pitchmode(aubio_pitchm_freq)
cannam@0: {
cannam@0: }
cannam@0: 
cannam@0: Pitch::~Pitch()
cannam@0: {
cannam@0:     if (m_pitchdet) del_aubio_pitchdetection(m_pitchdet);
cannam@0:     if (m_ibuf) del_fvec(m_ibuf);
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Pitch::getName() const
cannam@0: {
cannam@0:     return "aubiopitch";
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Pitch::getDescription() const
cannam@0: {
cannam@0:     return "Aubio Pitch Detector";
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@0:     return 1;
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@0:     m_channelCount = channels;
cannam@0:     m_stepSize = stepSize;
cannam@0:     m_blockSize = blockSize;
cannam@0: 
cannam@0:     m_ibuf = new_fvec(stepSize, channels);
cannam@0: 
piem@2:     m_pitchdet = new_aubio_pitchdetection(blockSize,
cannam@0:                                           stepSize,
cannam@0:                                           channels,
cannam@0:                                           lrintf(m_inputSampleRate),
cannam@0:                                           m_pitchtype,
cannam@0:                                           m_pitchmode);
cannam@0: 
cannam@0:     return true;
cannam@0: }
cannam@0: 
cannam@0: void
cannam@0: Pitch::reset()
cannam@0: {
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@0:     desc.name = "pitchtype";
cannam@0:     desc.description = "Pitch Detection Function Type";
cannam@0:     desc.minValue = 0;
cannam@0:     desc.maxValue = 4;
piem@2:     desc.defaultValue = (int)aubio_pitch_yinfft;
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@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@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@0:         case 0: m_pitchtype = aubio_pitch_yin; break;
cannam@0:         case 1: m_pitchtype = aubio_pitch_mcomb; break;
cannam@0:         case 2: m_pitchtype = aubio_pitch_schmitt; break;
cannam@0:         case 3: m_pitchtype = aubio_pitch_fcomb; break;
cannam@0:         case 4: m_pitchtype = aubio_pitch_yinfft; break;
cannam@0:         }
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@0:     d.name = "frequency";
cannam@0:     d.unit = "Hz";
cannam@0:     d.description = "Frequency";
cannam@0:     d.hasFixedBinCount = true;
cannam@0:     d.binCount = 1;
cannam@0:     d.hasKnownExtents = false;
cannam@0:     d.isQuantized = false;
cannam@0:     d.sampleType = OutputDescriptor::OneSamplePerStep;
cannam@0:     list.push_back(d);
cannam@0: 
cannam@0:     return list;
cannam@0: }
cannam@0: 
cannam@0: Pitch::FeatureSet
cannam@0: Pitch::process(float **inputBuffers, Vamp::RealTime /* timestamp */)
cannam@0: {
cannam@0:     for (size_t i = 0; i < m_stepSize; ++i) {
cannam@0:         for (size_t j = 0; j < m_channelCount; ++j) {
cannam@0:             fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
cannam@0:         }
cannam@0:     }
cannam@0: 
cannam@0:     float pitch = aubio_pitchdetection(m_pitchdet, m_ibuf);
cannam@0: 
cannam@0:     Feature feature;
cannam@0:     feature.hasTimestamp = false;
cannam@0:     feature.values.push_back(pitch);
cannam@0: 
cannam@0:     FeatureSet returnFeatures;
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: