annotate vamp-hostsdk/PluginLoader.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 4ab6224110ef
children
rev   line source
cannam@56 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@56 2
cannam@56 3 /*
cannam@56 4 Vamp
cannam@56 5
cannam@56 6 An API for audio analysis and feature extraction plugins.
cannam@56 7
cannam@56 8 Centre for Digital Music, Queen Mary, University of London.
cannam@56 9 Copyright 2006 Chris Cannam.
cannam@56 10
cannam@56 11 Permission is hereby granted, free of charge, to any person
cannam@56 12 obtaining a copy of this software and associated documentation
cannam@56 13 files (the "Software"), to deal in the Software without
cannam@56 14 restriction, including without limitation the rights to use, copy,
cannam@56 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@56 16 of the Software, and to permit persons to whom the Software is
cannam@56 17 furnished to do so, subject to the following conditions:
cannam@56 18
cannam@56 19 The above copyright notice and this permission notice shall be
cannam@56 20 included in all copies or substantial portions of the Software.
cannam@56 21
cannam@56 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@56 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@56 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@56 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@56 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@56 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@56 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@56 29
cannam@56 30 Except as contained in this notice, the names of the Centre for
cannam@56 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@56 32 shall not be used in advertising or otherwise to promote the sale,
cannam@56 33 use or other dealings in this Software without prior written
cannam@56 34 authorization.
cannam@56 35 */
cannam@56 36
cannam@56 37 #ifndef _VAMP_PLUGIN_LOADER_H_
cannam@56 38 #define _VAMP_PLUGIN_LOADER_H_
cannam@56 39
cannam@56 40 #include <vector>
cannam@56 41 #include <string>
cannam@56 42 #include <map>
cannam@56 43
cannam@56 44 namespace Vamp {
cannam@56 45
cannam@56 46 class Plugin;
cannam@56 47
cannam@56 48 class PluginLoader
cannam@56 49 {
cannam@56 50 public:
cannam@56 51 PluginLoader();
cannam@56 52 virtual ~PluginLoader();
cannam@56 53
cannam@56 54 typedef std::string PluginKey;
cannam@57 55 typedef std::vector<std::string> PluginCategoryHierarchy;
cannam@56 56
cannam@56 57 std::vector<PluginKey> listPlugins(); //!!! pass in version number?
cannam@56 58
cannam@56 59 //!!! want to be able to just "delete" the plugin later -- hence
cannam@56 60 //have to consider library loading issues -- do we have a wrapper
cannam@56 61 //class that tells us when it's been deleted, and keep a reference
cannam@56 62 //count for the dynamic library?
cannam@57 63 Plugin *load(PluginKey plugin, float inputSampleRate);
cannam@56 64
cannam@57 65 PluginCategoryHierarchy getPluginCategory(PluginKey plugin);
cannam@57 66
cannam@57 67 std::string getLibraryPathForPlugin(PluginKey plugin);
cannam@56 68
cannam@56 69 protected:
cannam@56 70 std::map<PluginKey, std::string> m_pluginLibraryMap;
cannam@57 71 std::map<PluginKey, PluginCategoryHierarchy> m_taxonomy;
cannam@57 72 void generateTaxonomy();
cannam@57 73 std::vector<std::string> getFilesInDir(std::string dir, std::string ext);
cannam@56 74 };
cannam@56 75
cannam@56 76 }
cannam@56 77
cannam@56 78
cannam@56 79 #endif
cannam@56 80