VampPluginSDK 2.1

- Main Page
- Namespaces
- Classes
- Files
- Directories

- File List
- File Members

PowerSpectrum.h
Go to the documentation of this file.

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