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