annotate examples/SpectralCentroid.h @ 49:aa64a46320d4

* Rename "name" and "description" to "identifier" and "name"; add new "description" that actually contains a description
author cannam
date Mon, 26 Feb 2007 18:08:48 +0000
parents be8fdfe25693
children 933fee59d33a
rev   line source
cannam@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@0 2
cannam@0 3 /*
cannam@0 4 Vamp
cannam@0 5
cannam@0 6 An API for audio analysis and feature extraction plugins.
cannam@0 7
cannam@0 8 Centre for Digital Music, Queen Mary, University of London.
cannam@0 9 Copyright 2006 Chris Cannam.
cannam@0 10
cannam@0 11 Permission is hereby granted, free of charge, to any person
cannam@0 12 obtaining a copy of this software and associated documentation
cannam@0 13 files (the "Software"), to deal in the Software without
cannam@0 14 restriction, including without limitation the rights to use, copy,
cannam@0 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0 16 of the Software, and to permit persons to whom the Software is
cannam@0 17 furnished to do so, subject to the following conditions:
cannam@0 18
cannam@0 19 The above copyright notice and this permission notice shall be
cannam@0 20 included in all copies or substantial portions of the Software.
cannam@0 21
cannam@0 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@6 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0 29
cannam@0 30 Except as contained in this notice, the names of the Centre for
cannam@0 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0 32 shall not be used in advertising or otherwise to promote the sale,
cannam@0 33 use or other dealings in this Software without prior written
cannam@0 34 authorization.
cannam@0 35 */
cannam@0 36
cannam@0 37 #ifndef _SPECTRAL_CENTROID_PLUGIN_H_
cannam@0 38 #define _SPECTRAL_CENTROID_PLUGIN_H_
cannam@0 39
cannam@0 40 #include "Plugin.h"
cannam@0 41
cannam@0 42 class SpectralCentroid : public Vamp::Plugin
cannam@0 43 {
cannam@0 44 public:
cannam@0 45 SpectralCentroid(float inputSampleRate);
cannam@0 46 virtual ~SpectralCentroid();
cannam@0 47
cannam@0 48 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@0 49 void reset();
cannam@0 50
cannam@0 51 InputDomain getInputDomain() const { return FrequencyDomain; }
cannam@0 52
cannam@49 53 std::string getIdentifier() const;
cannam@0 54 std::string getName() const;
cannam@0 55 std::string getDescription() const;
cannam@0 56 std::string getMaker() const;
cannam@0 57 int getPluginVersion() const;
cannam@0 58 std::string getCopyright() const;
cannam@0 59
cannam@0 60 OutputList getOutputDescriptors() const;
cannam@0 61
cannam@47 62 FeatureSet process(const float *const *inputBuffers,
cannam@47 63 Vamp::RealTime timestamp);
cannam@0 64
cannam@0 65 FeatureSet getRemainingFeatures();
cannam@0 66
cannam@0 67 protected:
cannam@0 68 size_t m_stepSize;
cannam@0 69 size_t m_blockSize;
cannam@0 70 };
cannam@0 71
cannam@0 72
cannam@0 73 #endif