annotate examples/AmplitudeFollower.h @ 47:be8fdfe25693

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