cannam@0:
AmplitudeFollower.h

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 00002 
cannam@0: 00003 /*
cannam@0: 00004     Vamp
cannam@0: 00005 
cannam@0: 00006     An API for audio analysis and feature extraction plugins.
cannam@0: 00007 
cannam@0: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@0: 00009     This file copyright 2006 Dan Stowell.
cannam@0: 00010   
cannam@0: 00011     Permission is hereby granted, free of charge, to any person
cannam@0: 00012     obtaining a copy of this software and associated documentation
cannam@0: 00013     files (the "Software"), to deal in the Software without
cannam@0: 00014     restriction, including without limitation the rights to use, copy,
cannam@0: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00016     of the Software, and to permit persons to whom the Software is
cannam@0: 00017     furnished to do so, subject to the following conditions:
cannam@0: 00018 
cannam@0: 00019     The above copyright notice and this permission notice shall be
cannam@0: 00020     included in all copies or substantial portions of the Software.
cannam@0: 00021 
cannam@0: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00029 
cannam@0: 00030     Except as contained in this notice, the names of the Centre for
cannam@0: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00033     use or other dealings in this Software without prior written
cannam@0: 00034     authorization.
cannam@0: 00035 */
cannam@0: 00036 
cannam@0: 00037 #ifndef _AMPLITUDE_FOLLOWER_PLUGIN_H_
cannam@0: 00038 #define _AMPLITUDE_FOLLOWER_PLUGIN_H_
cannam@0: 00039 
cannam@21: 00040 #include "vamp-sdk/Plugin.h"
cannam@0: 00041 
cannam@0: 00047 class AmplitudeFollower : public Vamp::Plugin
cannam@0: 00048 {
cannam@0: 00049 public:
cannam@0: 00050     AmplitudeFollower(float inputSampleRate);
cannam@0: 00051     virtual ~AmplitudeFollower();
cannam@0: 00052 
cannam@0: 00053     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@0: 00054     void reset();
cannam@0: 00055 
cannam@0: 00056     InputDomain getInputDomain() const { return TimeDomain; }
cannam@0: 00057 
cannam@0: 00058     std::string getIdentifier() const;
cannam@0: 00059     std::string getName() const;
cannam@0: 00060     std::string getDescription() const;
cannam@0: 00061     std::string getMaker() const;
cannam@0: 00062     int getPluginVersion() const;
cannam@0: 00063     std::string getCopyright() const;
cannam@0: 00064         
cannam@0: 00065     OutputList getOutputDescriptors() const;
cannam@0: 00066         
cannam@0: 00067     ParameterList getParameterDescriptors() const;
cannam@0: 00068     float getParameter(std::string paramid) const;
cannam@0: 00069     void setParameter(std::string paramid, float newval);
cannam@0: 00070 
cannam@0: 00071     FeatureSet process(const float *const *inputBuffers,
cannam@0: 00072                        Vamp::RealTime timestamp);
cannam@0: 00073 
cannam@0: 00074     FeatureSet getRemainingFeatures();
cannam@0: 00075 
cannam@0: 00076 protected:
cannam@0: 00077     size_t m_stepSize;
cannam@0: 00078     float  m_previn;
cannam@0: 00079     float  m_clampcoef;
cannam@0: 00080     float  m_relaxcoef;
cannam@0: 00081 };
cannam@0: 00082 
cannam@0: 00083 
cannam@0: 00084 #endif
cannam@0: