cannam@241: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@241: 
cannam@241: /*
cannam@241:     Vamp
cannam@241: 
cannam@241:     An API for audio analysis and feature extraction plugins.
cannam@241: 
cannam@241:     Centre for Digital Music, Queen Mary, University of London.
cannam@241:     Copyright 2006 Chris Cannam.
cannam@241:   
cannam@241:     Permission is hereby granted, free of charge, to any person
cannam@241:     obtaining a copy of this software and associated documentation
cannam@241:     files (the "Software"), to deal in the Software without
cannam@241:     restriction, including without limitation the rights to use, copy,
cannam@241:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@241:     of the Software, and to permit persons to whom the Software is
cannam@241:     furnished to do so, subject to the following conditions:
cannam@241: 
cannam@241:     The above copyright notice and this permission notice shall be
cannam@241:     included in all copies or substantial portions of the Software.
cannam@241: 
cannam@241:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@241:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@241:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@241:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@241:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@241:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@241:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@241: 
cannam@241:     Except as contained in this notice, the names of the Centre for
cannam@241:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@241:     shall not be used in advertising or otherwise to promote the sale,
cannam@241:     use or other dealings in this Software without prior written
cannam@241:     authorization.
cannam@241: */
cannam@241: 
cannam@241: #ifndef _POWER_SPECTRUM_PLUGIN_H_
cannam@241: #define _POWER_SPECTRUM_PLUGIN_H_
cannam@241: 
cannam@241: #include "vamp-sdk/Plugin.h"
cannam@241: 
cannam@241: /**
cannam@241:  * Example plugin that returns a power spectrum calculated (trivially)
cannam@241:  * from the frequency domain representation of each block of audio.
cannam@241:  * This is one of the simplest possible Vamp plugins, included as an
cannam@241:  * example of how to return the appropriate value structure for this
cannam@241:  * sort of visualisation.
cannam@241:  */
cannam@241: 
cannam@241: class PowerSpectrum : public Vamp::Plugin
cannam@241: {
cannam@241: public:
cannam@241:     PowerSpectrum(float inputSampleRate);
cannam@241:     virtual ~PowerSpectrum();
cannam@241: 
cannam@241:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@241:     void reset();
cannam@241: 
cannam@241:     InputDomain getInputDomain() const { return FrequencyDomain; }
cannam@241: 
cannam@241:     std::string getIdentifier() const;
cannam@241:     std::string getName() const;
cannam@241:     std::string getDescription() const;
cannam@241:     std::string getMaker() const;
cannam@241:     int getPluginVersion() const;
cannam@241:     std::string getCopyright() const;
cannam@241: 
cannam@241:     OutputList getOutputDescriptors() const;
cannam@241: 
cannam@241:     FeatureSet process(const float *const *inputBuffers,
cannam@241:                        Vamp::RealTime timestamp);
cannam@241: 
cannam@241:     FeatureSet getRemainingFeatures();
cannam@241: 
cannam@241: protected:
cannam@241:     size_t m_blockSize;
cannam@241: };
cannam@241: 
cannam@241: 
cannam@241: #endif