annotate vamp/CQVamp.h @ 69:27007f8302f4

Copyrights, licence
author Chris Cannam <c.cannam@qmul.ac.uk>
date Wed, 12 Mar 2014 08:53:45 +0000
parents 2a21b4506d7f
children f4fb0ac6120a
rev   line source
c@35 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
c@69 2 /*
c@69 3 Constant-Q library
c@69 4 Copyright (c) 2013-2014 Queen Mary, University of London
c@69 5
c@69 6 Permission is hereby granted, free of charge, to any person
c@69 7 obtaining a copy of this software and associated documentation
c@69 8 files (the "Software"), to deal in the Software without
c@69 9 restriction, including without limitation the rights to use, copy,
c@69 10 modify, merge, publish, distribute, sublicense, and/or sell copies
c@69 11 of the Software, and to permit persons to whom the Software is
c@69 12 furnished to do so, subject to the following conditions:
c@69 13
c@69 14 The above copyright notice and this permission notice shall be
c@69 15 included in all copies or substantial portions of the Software.
c@69 16
c@69 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
c@69 18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
c@69 19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
c@69 20 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
c@69 21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
c@69 22 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
c@69 23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
c@69 24
c@69 25 Except as contained in this notice, the names of the Centre for
c@69 26 Digital Music; Queen Mary, University of London; and Chris Cannam
c@69 27 shall not be used in advertising or otherwise to promote the sale,
c@69 28 use or other dealings in this Software without prior written
c@69 29 authorization.
c@69 30 */
c@35 31
c@35 32 #ifndef CQVAMP_H
c@35 33 #define CQVAMP_H
c@35 34
c@35 35 #include <vamp-sdk/Plugin.h>
c@35 36
c@35 37 class ConstantQ;
c@35 38
c@35 39 class CQVamp : public Vamp::Plugin
c@35 40 {
c@35 41 public:
c@35 42 CQVamp(float inputSampleRate);
c@35 43 virtual ~CQVamp();
c@35 44
c@35 45 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
c@35 46 void reset();
c@35 47
c@35 48 InputDomain getInputDomain() const { return TimeDomain; }
c@35 49
c@35 50 std::string getIdentifier() const;
c@35 51 std::string getName() const;
c@35 52 std::string getDescription() const;
c@35 53 std::string getMaker() const;
c@35 54 int getPluginVersion() const;
c@35 55 std::string getCopyright() const;
c@35 56
c@35 57 ParameterList getParameterDescriptors() const;
c@35 58 float getParameter(std::string) const;
c@35 59 void setParameter(std::string, float);
c@35 60
c@35 61 size_t getPreferredStepSize() const;
c@35 62 size_t getPreferredBlockSize() const;
c@35 63
c@35 64 OutputList getOutputDescriptors() const;
c@35 65
c@35 66 FeatureSet process(const float *const *inputBuffers,
c@35 67 Vamp::RealTime timestamp);
c@35 68
c@35 69 FeatureSet getRemainingFeatures();
c@35 70
c@35 71 protected:
c@55 72 int m_minMIDIPitch;
c@55 73 int m_maxMIDIPitch;
c@55 74 float m_tuningFrequency;
c@55 75 int m_bpo;
c@55 76
c@35 77 ConstantQ *m_cq;
c@35 78 float m_maxFrequency;
c@35 79 float m_minFrequency;
c@35 80 int m_stepSize;
c@35 81 int m_blockSize;
c@36 82
c@53 83 Vamp::RealTime m_startTime;
c@53 84 bool m_haveStartTime;
c@53 85 int m_columnCount;
c@53 86
c@36 87 std::vector<float> m_prevFeature;
c@36 88 FeatureSet convertToFeatures(const std::vector<std::vector<double> > &);
c@35 89 };
c@35 90
c@35 91
c@35 92 #endif