libs/ardour/ardour/plugin_manager.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_plugin_manager_h__
  21 #define __ardour_plugin_manager_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "libardour-config.h"
  25 #endif
  26
  27 #include <list>
  28 #include <map>
  29 #include <string>
  30 #include <set>
  31 #include <boost/utility.hpp>
  32
  33 #include "ardour/libardour_visibility.h"
  34 #include "ardour/types.h"
  35 #include "ardour/plugin.h"
  36
  37 namespace ARDOUR {
  38
  39 class Plugin;
  40
  41 class LIBARDOUR_API PluginManager : public boost::noncopyable {
  42 public:
  43         static PluginManager& instance();
  44         static std::string scanner_bin_path;
  45
  46         ~PluginManager ();
  47
  48         const ARDOUR::PluginInfoList& windows_vst_plugin_info ();
  49         const ARDOUR::PluginInfoList& lxvst_plugin_info ();
  50         const ARDOUR::PluginInfoList& mac_vst_plugin_info ();
  51         const ARDOUR::PluginInfoList& ladspa_plugin_info ();
  52         const ARDOUR::PluginInfoList& lv2_plugin_info ();
  53         const ARDOUR::PluginInfoList& au_plugin_info ();
  54         const ARDOUR::PluginInfoList& lua_plugin_info ();
  55
  56         void refresh (bool cache_only = false);
  57         void cancel_plugin_scan();
  58         void cancel_plugin_timeout();
  59         void clear_vst_cache ();
  60         void clear_vst_blacklist ();
  61         void clear_au_cache ();
  62         void clear_au_blacklist ();
  63
  64         const std::string get_default_windows_vst_path() const { return windows_vst_path; }
  65         const std::string get_default_lxvst_path() const { return lxvst_path; }
  66
  67         /* always return LXVST for any VST subtype */
  68         static PluginType to_generic_vst (PluginType);
  69
  70         bool cancelled () { return _cancel_scan; }
  71         bool no_timeout () { return _cancel_timeout; }
  72
  73         enum PluginStatusType {
  74                 Normal = 0,
  75                 Favorite,
  76                 Hidden
  77         };
  78
  79         std::string user_plugin_metadata_dir () const;
  80         void load_statuses ();
  81         void save_statuses ();
  82         void set_status (ARDOUR::PluginType type, std::string unique_id, PluginStatusType status);
  83         PluginStatusType get_status (const PluginInfoPtr&) const;
  84
  85         void load_tags ();
  86         void save_tags ();
  87
  88         enum TagType {
  89                 FromPlug,           //tag info is being set from plugin metadata
  90                 FromFactoryFile,    // ... from the factory metadata file
  91                 FromUserFile,       // ... from the user's config data
  92                 FromGui             // ... from the UI, in realtime: will emit a signal so ui can show "sanitized" string as it is generated
  93         };
  94         void set_tags (ARDOUR::PluginType type, std::string unique_id, std::string tags, std::string name, TagType tagtype);
  95         void reset_tags (PluginInfoPtr const&, TagType);
  96         std::string get_tags_as_string (PluginInfoPtr const&) const;
  97         std::vector<std::string> get_tags (PluginInfoPtr const&) const;
  98
  99         enum TagFilter {
 100                 All,
 101                 OnlyFavorites,
 102                 NoHidden
 103         };
 104         std::vector<std::string> get_all_tags (enum TagFilter) const;
 105
 106         /** plugins were added to or removed from one of the PluginInfoLists, OR the user has made changes to the status/tags */
 107         PBD::Signal0<void> PluginListChanged;
 108
 109         /** A single plugin's Hidden/Favorite status changed */
 110         PBD::Signal3<void, ARDOUR::PluginType, std::string, PluginStatusType> PluginStatusChanged; //PluginType t, string id, string tag
 111
 112         /** A single plugin's Tags status changed */
 113         PBD::Signal3<void, ARDOUR::PluginType, std::string, std::string> PluginTagChanged; //PluginType t, string id, string tag
 114
 115 private:
 116
 117         struct PluginTag {
 118             ARDOUR::PluginType type;
 119             std::string unique_id;
 120             std::string tags;
 121             std::string name;
 122                 TagType tagtype;
 123
 124             PluginTag (ARDOUR::PluginType t, std::string id, std::string tag, std::string n, TagType tt)
 125             : type (t), unique_id (id), tags (tag), name(n), tagtype (tt) {}
 126
 127             bool operator== (PluginTag const& other) const {
 128                     return other.type == type && other.unique_id == unique_id;
 129             }
 130
 131             bool operator< (PluginTag const& other) const {
 132                     if (other.type < type) {
 133                             return true;
 134                     } else if (other.type == type && other.unique_id < unique_id) {
 135                             return true;
 136                     }
 137                     return false;
 138             }
 139         };
 140
 141         typedef std::set<PluginTag> PluginTagList;
 142         PluginTagList ptags;
 143
 144         std::string sanitize_tag (const std::string) const;
 145
 146         struct PluginStatus {
 147             ARDOUR::PluginType type;
 148             std::string unique_id;
 149             PluginStatusType status;
 150
 151             PluginStatus (ARDOUR::PluginType t, std::string id, PluginStatusType s = Normal)
 152             : type (t), unique_id (id), status (s) {}
 153
 154             bool operator==(const PluginStatus& other) const {
 155                     return other.type == type && other.unique_id == unique_id;
 156             }
 157
 158             bool operator<(const PluginStatus& other) const {
 159                     if (other.type < type) {
 160                             return true;
 161                     } else if (other.type == type && other.unique_id < unique_id) {
 162                             return true;
 163                     }
 164                     return false;
 165             }
 166         };
 167         typedef std::set<PluginStatus> PluginStatusList;
 168         PluginStatusList statuses;
 169
 170         ARDOUR::PluginInfoList  _empty_plugin_info;
 171         ARDOUR::PluginInfoList* _windows_vst_plugin_info;
 172         ARDOUR::PluginInfoList* _lxvst_plugin_info;
 173         ARDOUR::PluginInfoList* _mac_vst_plugin_info;
 174         ARDOUR::PluginInfoList* _ladspa_plugin_info;
 175         ARDOUR::PluginInfoList* _lv2_plugin_info;
 176         ARDOUR::PluginInfoList* _au_plugin_info;
 177         ARDOUR::PluginInfoList* _lua_plugin_info;
 178
 179         std::map<uint32_t, std::string> rdf_type;
 180
 181         std::string windows_vst_path;
 182         std::string lxvst_path;
 183
 184         bool _cancel_scan;
 185         bool _cancel_timeout;
 186
 187         void ladspa_refresh ();
 188         void lua_refresh ();
 189         void lua_refresh_cb ();
 190         void windows_vst_refresh (bool cache_only = false);
 191         void mac_vst_refresh (bool cache_only = false);
 192         void lxvst_refresh (bool cache_only = false);
 193
 194         void add_lrdf_data (const std::string &path);
 195         void add_ladspa_presets ();
 196         void add_windows_vst_presets ();
 197         void add_mac_vst_presets ();
 198         void add_lxvst_presets ();
 199         void add_presets (std::string domain);
 200
 201         void au_refresh (bool cache_only = false);
 202
 203         void lv2_refresh ();
 204
 205         int windows_vst_discover_from_path (std::string path, bool cache_only = false);
 206         int windows_vst_discover (std::string path, bool cache_only = false);
 207
 208         int mac_vst_discover_from_path (std::string path, bool cache_only = false);
 209         int mac_vst_discover (std::string path, bool cache_only = false);
 210
 211         int lxvst_discover_from_path (std::string path, bool cache_only = false);
 212         int lxvst_discover (std::string path, bool cache_only = false);
 213
 214         int ladspa_discover (std::string path);
 215
 216         std::string get_ladspa_category (uint32_t id);
 217         std::vector<uint32_t> ladspa_plugin_whitelist;
 218
 219         PBD::ScopedConnection lua_refresh_connection;
 220         Glib::Threads::Mutex _lock;
 221
 222         static PluginManager* _instance; // singleton
 223         PluginManager ();
 224 };
 225
 226 } /* namespace ARDOUR */
 227
 228 #endif /* __ardour_plugin_manager_h__ */
 229