VampPluginSDK: PluginWrapper.h Source File

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