5c2683745b33/code-docs/PluginWrapper_8h_source.html

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