cannam@56: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@56: 
cannam@56: /*
cannam@56:     Vamp
cannam@56: 
cannam@56:     An API for audio analysis and feature extraction plugins.
cannam@56: 
cannam@56:     Centre for Digital Music, Queen Mary, University of London.
cannam@56:     Copyright 2006 Chris Cannam.
cannam@56:   
cannam@56:     Permission is hereby granted, free of charge, to any person
cannam@56:     obtaining a copy of this software and associated documentation
cannam@56:     files (the "Software"), to deal in the Software without
cannam@56:     restriction, including without limitation the rights to use, copy,
cannam@56:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@56:     of the Software, and to permit persons to whom the Software is
cannam@56:     furnished to do so, subject to the following conditions:
cannam@56: 
cannam@56:     The above copyright notice and this permission notice shall be
cannam@56:     included in all copies or substantial portions of the Software.
cannam@56: 
cannam@56:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@56:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@56:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@56:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@56:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@56:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@56:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@56: 
cannam@56:     Except as contained in this notice, the names of the Centre for
cannam@56:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@56:     shall not be used in advertising or otherwise to promote the sale,
cannam@56:     use or other dealings in this Software without prior written
cannam@56:     authorization.
cannam@56: */
cannam@56: 
cannam@56: #ifndef _PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@56: 
cannam@56: #include <vamp-sdk/Plugin.h>
cannam@56: 
cannam@56: namespace Vamp {
cannam@56: 
cannam@56: /**
cannam@56:  * An adapter that converts time-domain input into frequency-domain
cannam@56:  * input for plugins that need it.  In every other respect this
cannam@56:  * adapter behaves like the plugin it wraps.  The wrapped plugin may
cannam@56:  * be a time-domain plugin, in which case this wrapper does nothing.
cannam@56:  *
cannam@56:  * Uses a Hanning windowed FFT.  The FFT implementation is not the
cannam@56:  * fastest, so a host can do much better if it cares enough, but it is
cannam@56:  * simple and self-contained.
cannam@56:  *
cannam@56:  * Note that this adapter does not support non-power-of-two block
cannam@56:  * sizes.
cannam@56:  */
cannam@56: 
cannam@56: //!!! It would also be nice to have a channel wrapper, which deals
cannam@56: //with mixing down channels if the plugin needs a different number
cannam@56: //from the input source.  It would have some sort of mixdown/channel
cannam@56: //input policy selection.  Probably this class and that one should
cannam@56: //both inherit a PluginAdapter class which contains a plugin and
cannam@56: //delegates all calls through to it; the subclass can then override
cannam@56: //only the ones it needs to handle.
cannam@56: 
cannam@56: class PluginInputDomainAdapter : public Plugin
cannam@56: {
cannam@56: public:
cannam@56:     PluginInputDomainAdapter(Plugin *plugin); // I take ownership of plugin
cannam@56:     virtual ~PluginInputDomainAdapter();
cannam@56:     
cannam@56:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@56:     void reset();
cannam@56: 
cannam@56:     InputDomain getInputDomain() const { return Plugin::TimeDomain; }
cannam@56: 
cannam@56:     unsigned int getVampApiVersion() const;
cannam@56:     std::string getIdentifier() const;
cannam@56:     std::string getName() const;
cannam@56:     std::string getDescription() const;
cannam@56:     std::string getMaker() const;
cannam@56:     int getPluginVersion() const;
cannam@56:     std::string getCopyright() const;
cannam@56: 
cannam@56:     ParameterList getParameterDescriptors() const;
cannam@56:     float getParameter(std::string) const;
cannam@56:     void setParameter(std::string, float);
cannam@56: 
cannam@56:     ProgramList getPrograms() const;
cannam@56:     std::string getCurrentProgram() const;
cannam@56:     void selectProgram(std::string);
cannam@56: 
cannam@56:     size_t getPreferredStepSize() const;
cannam@56:     size_t getPreferredBlockSize() const;
cannam@56: 
cannam@56:     size_t getMinChannelCount() const;
cannam@56:     size_t getMaxChannelCount() const;
cannam@56: 
cannam@56:     OutputList getOutputDescriptors() const;
cannam@56: 
cannam@56:     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@56: 
cannam@56:     FeatureSet getRemainingFeatures();
cannam@56: 
cannam@56: protected:
cannam@56:     Plugin *m_plugin;
cannam@56:     size_t m_channels;
cannam@56:     size_t m_blockSize;
cannam@56:     float **m_freqbuf;
cannam@56:     double *m_ri;
cannam@56:     double *m_ro;
cannam@56:     double *m_io;
cannam@56: 
cannam@56:     void fft(unsigned int n, bool inverse,
cannam@56:              double *ri, double *ii, double *ro, double *io);
cannam@56: };
cannam@56: 
cannam@56: }
cannam@56: 
cannam@56: #endif