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-2007 Chris Cannam and QMUL. 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 _VAMP_PLUGIN_WRAPPER_H_ 00038 #define _VAMP_PLUGIN_WRAPPER_H_ 00039 00040 #include <vamp-sdk/Plugin.h> 00041 00042 namespace Vamp { 00043 00044 namespace HostExt { 00045 00059 class PluginWrapper : public Plugin 00060 { 00061 public: 00062 virtual ~PluginWrapper(); 00063 00064 bool initialise(size_t channels, size_t stepSize, size_t blockSize); 00065 void reset(); 00066 00067 InputDomain getInputDomain() const; 00068 00069 unsigned int getVampApiVersion() const; 00070 std::string getIdentifier() const; 00071 std::string getName() const; 00072 std::string getDescription() const; 00073 std::string getMaker() const; 00074 int getPluginVersion() const; 00075 std::string getCopyright() const; 00076 00077 ParameterList getParameterDescriptors() const; 00078 float getParameter(std::string) const; 00079 void setParameter(std::string, float); 00080 00081 ProgramList getPrograms() const; 00082 std::string getCurrentProgram() const; 00083 void selectProgram(std::string); 00084 00085 size_t getPreferredStepSize() const; 00086 size_t getPreferredBlockSize() const; 00087 00088 size_t getMinChannelCount() const; 00089 size_t getMaxChannelCount() const; 00090 00091 OutputList getOutputDescriptors() const; 00092 00093 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); 00094 00095 FeatureSet getRemainingFeatures(); 00096 00097 protected: 00098 PluginWrapper(Plugin *plugin); // I take ownership of plugin 00099 Plugin *m_plugin; 00100 }; 00101 00102 } 00103 00104 } 00105 00106 #endif