annotate vamp-hostsdk/PluginWrapper.h @ 57:09a1aac6c362 host-factory-stuff

* add wrapper base * make loader able to look up categories
author cannam
date Wed, 09 May 2007 15:21:37 +0000
parents
children
rev   line source
cannam@57 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@57 2
cannam@57 3 /*
cannam@57 4 Vamp
cannam@57 5
cannam@57 6 An API for audio analysis and feature extraction plugins.
cannam@57 7
cannam@57 8 Centre for Digital Music, Queen Mary, University of London.
cannam@57 9 Copyright 2006 Chris Cannam.
cannam@57 10
cannam@57 11 Permission is hereby granted, free of charge, to any person
cannam@57 12 obtaining a copy of this software and associated documentation
cannam@57 13 files (the "Software"), to deal in the Software without
cannam@57 14 restriction, including without limitation the rights to use, copy,
cannam@57 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@57 16 of the Software, and to permit persons to whom the Software is
cannam@57 17 furnished to do so, subject to the following conditions:
cannam@57 18
cannam@57 19 The above copyright notice and this permission notice shall be
cannam@57 20 included in all copies or substantial portions of the Software.
cannam@57 21
cannam@57 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@57 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@57 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@57 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@57 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@57 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@57 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@57 29
cannam@57 30 Except as contained in this notice, the names of the Centre for
cannam@57 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@57 32 shall not be used in advertising or otherwise to promote the sale,
cannam@57 33 use or other dealings in this Software without prior written
cannam@57 34 authorization.
cannam@57 35 */
cannam@57 36
cannam@57 37 #ifndef _PLUGIN_WRAPPER_H_
cannam@57 38
cannam@57 39 #include <vamp-sdk/Plugin.h>
cannam@57 40
cannam@57 41 namespace Vamp {
cannam@57 42
cannam@57 43 class PluginWrapper : public Plugin
cannam@57 44 {
cannam@57 45 public:
cannam@57 46 virtual ~PluginWrapper();
cannam@57 47
cannam@57 48 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@57 49 void reset();
cannam@57 50
cannam@57 51 InputDomain getInputDomain() const;
cannam@57 52
cannam@57 53 unsigned int getVampApiVersion() const;
cannam@57 54 std::string getIdentifier() const;
cannam@57 55 std::string getName() const;
cannam@57 56 std::string getDescription() const;
cannam@57 57 std::string getMaker() const;
cannam@57 58 int getPluginVersion() const;
cannam@57 59 std::string getCopyright() const;
cannam@57 60
cannam@57 61 ParameterList getParameterDescriptors() const;
cannam@57 62 float getParameter(std::string) const;
cannam@57 63 void setParameter(std::string, float);
cannam@57 64
cannam@57 65 ProgramList getPrograms() const;
cannam@57 66 std::string getCurrentProgram() const;
cannam@57 67 void selectProgram(std::string);
cannam@57 68
cannam@57 69 size_t getPreferredStepSize() const;
cannam@57 70 size_t getPreferredBlockSize() const;
cannam@57 71
cannam@57 72 size_t getMinChannelCount() const;
cannam@57 73 size_t getMaxChannelCount() const;
cannam@57 74
cannam@57 75 OutputList getOutputDescriptors() const;
cannam@57 76
cannam@57 77 FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@57 78
cannam@57 79 FeatureSet getRemainingFeatures();
cannam@57 80
cannam@57 81 protected:
cannam@57 82 PluginWrapper(Plugin *plugin); // I take ownership of plugin
cannam@57 83 Plugin *m_plugin;
cannam@57 84 };
cannam@57 85
cannam@57 86 }
cannam@57 87
cannam@57 88 #endif