cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: VampPluginSDK: PluginWrapper.h Source File cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
VampPluginSDK cannam@50:  2.1 cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50:
PluginWrapper.h
cannam@50:
cannam@50:
cannam@50: Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@50: 00002 
cannam@50: 00003 /*
cannam@50: 00004     Vamp
cannam@50: 00005 
cannam@50: 00006     An API for audio analysis and feature extraction plugins.
cannam@50: 00007 
cannam@50: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@50: 00009     Copyright 2006-2009 Chris Cannam and QMUL.
cannam@50: 00010   
cannam@50: 00011     Permission is hereby granted, free of charge, to any person
cannam@50: 00012     obtaining a copy of this software and associated documentation
cannam@50: 00013     files (the "Software"), to deal in the Software without
cannam@50: 00014     restriction, including without limitation the rights to use, copy,
cannam@50: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@50: 00016     of the Software, and to permit persons to whom the Software is
cannam@50: 00017     furnished to do so, subject to the following conditions:
cannam@50: 00018 
cannam@50: 00019     The above copyright notice and this permission notice shall be
cannam@50: 00020     included in all copies or substantial portions of the Software.
cannam@50: 00021 
cannam@50: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@50: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@50: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@50: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@50: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@50: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@50: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@50: 00029 
cannam@50: 00030     Except as contained in this notice, the names of the Centre for
cannam@50: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@50: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@50: 00033     use or other dealings in this Software without prior written
cannam@50: 00034     authorization.
cannam@50: 00035 */
cannam@50: 00036 
cannam@50: 00037 #ifndef _VAMP_PLUGIN_WRAPPER_H_
cannam@50: 00038 #define _VAMP_PLUGIN_WRAPPER_H_
cannam@50: 00039 
cannam@50: 00040 #include "hostguard.h"
cannam@50: 00041 #include <vamp-hostsdk/Plugin.h>
cannam@50: 00042 
cannam@50: 00043 _VAMP_SDK_HOSTSPACE_BEGIN(PluginWrapper.h)
cannam@50: 00044 
cannam@50: 00045 namespace Vamp {
cannam@50: 00046 
cannam@50: 00047 namespace HostExt {
cannam@50: 00048 
cannam@50: 00062 class PluginWrapper : public Plugin
cannam@50: 00063 {
cannam@50: 00064 public:
cannam@50: 00065     virtual ~PluginWrapper();
cannam@50: 00066     
cannam@50: 00067     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@50: 00068     void reset();
cannam@50: 00069 
cannam@50: 00070     InputDomain getInputDomain() const;
cannam@50: 00071 
cannam@50: 00072     unsigned int getVampApiVersion() const;
cannam@50: 00073     std::string getIdentifier() const;
cannam@50: 00074     std::string getName() const;
cannam@50: 00075     std::string getDescription() const;
cannam@50: 00076     std::string getMaker() const;
cannam@50: 00077     int getPluginVersion() const;
cannam@50: 00078     std::string getCopyright() const;
cannam@50: 00079 
cannam@50: 00080     ParameterList getParameterDescriptors() const;
cannam@50: 00081     float getParameter(std::string) const;
cannam@50: 00082     void setParameter(std::string, float);
cannam@50: 00083 
cannam@50: 00084     ProgramList getPrograms() const;
cannam@50: 00085     std::string getCurrentProgram() const;
cannam@50: 00086     void selectProgram(std::string);
cannam@50: 00087 
cannam@50: 00088     size_t getPreferredStepSize() const;
cannam@50: 00089     size_t getPreferredBlockSize() const;
cannam@50: 00090 
cannam@50: 00091     size_t getMinChannelCount() const;
cannam@50: 00092     size_t getMaxChannelCount() const;
cannam@50: 00093 
cannam@50: 00094     OutputList getOutputDescriptors() const;
cannam@50: 00095 
cannam@50: 00096     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@50: 00097 
cannam@50: 00098     FeatureSet getRemainingFeatures();
cannam@50: 00099 
cannam@50: 00115     template <typename WrapperType>
cannam@50: 00116     WrapperType *getWrapper() {
cannam@50: 00117         WrapperType *w = dynamic_cast<WrapperType *>(this);
cannam@50: 00118         if (w) return w;
cannam@50: 00119         PluginWrapper *pw = dynamic_cast<PluginWrapper *>(m_plugin);
cannam@50: 00120         if (pw) return pw->getWrapper<WrapperType>();
cannam@50: 00121         return 0;
cannam@50: 00122     }
cannam@50: 00123 
cannam@50: 00124 protected:
cannam@50: 00125     PluginWrapper(Plugin *plugin); // I take ownership of plugin
cannam@50: 00126     Plugin *m_plugin;
cannam@50: 00127 };
cannam@50: 00128 
cannam@50: 00129 }
cannam@50: 00130 
cannam@50: 00131 }
cannam@50: 00132 
cannam@50: 00133 _VAMP_SDK_HOSTSPACE_END(PluginWrapper.h)
cannam@50: 00134 
cannam@50: 00135 #endif
cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: