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         void set_tags (ARDOUR::PluginType type, std::string unique_id, std::string tags, bool factory, bool force = false);
  89         void reset_tags (PluginInfoPtr const&);
  90         std::string get_tags_as_string (PluginInfoPtr const&) const;
  91         std::vector<std::string> get_tags (PluginInfoPtr const&) const;
  92
  93         enum TagFilter {
  94                 All,
  95                 OnlyFavorites,
  96                 NoHidden
  97         };
  98         std::vector<std::string> get_all_tags (enum TagFilter) const;
  99
 100         /** plugins were added to or removed from one of the PluginInfoLists, OR the user has made changes to the status/tags */
 101         PBD::Signal0<void> PluginListChanged;
 102
 103         /** A single plugin's Hidden/Favorite status changed */
 104         PBD::Signal3<void, ARDOUR::PluginType, std::string, PluginStatusType> PluginStatusChanged; //PluginType t, string id, string tag
 105
 106         /** A single plugin's Tags status changed */
 107         PBD::Signal3<void, ARDOUR::PluginType, std::string, std::string> PluginTagChanged; //PluginType t, string id, string tag
 108
 109 private:
 110
 111         struct PluginTag {
 112             ARDOUR::PluginType type;
 113             std::string unique_id;
 114             std::string tags;
 115                         bool user_set;
 116
 117             PluginTag (ARDOUR::PluginType t, std::string id, std::string s, bool user_set)
 118             : type (t), unique_id (id), tags (s), user_set (user_set) {}
 119
 120             bool operator== (PluginTag const& other) const {
 121                     return other.type == type && other.unique_id == unique_id;
 122             }
 123
 124             bool operator< (PluginTag const& other) const {
 125                     if (other.type < type) {
 126                             return true;
 127                     } else if (other.type == type && other.unique_id < unique_id) {
 128                             return true;
 129                     }
 130                     return false;
 131             }
 132         };
 133
 134         typedef std::set<PluginTag> PluginTagList;
 135         PluginTagList ptags;
 136
 137         std::string sanitize_tag (const std::string) const;
 138
 139         struct PluginStatus {
 140             ARDOUR::PluginType type;
 141             std::string unique_id;
 142             PluginStatusType status;
 143
 144             PluginStatus (ARDOUR::PluginType t, std::string id, PluginStatusType s = Normal)
 145             : type (t), unique_id (id), status (s) {}
 146
 147             bool operator==(const PluginStatus& other) const {
 148                     return other.type == type && other.unique_id == unique_id;
 149             }
 150
 151             bool operator<(const PluginStatus& other) const {
 152                     if (other.type < type) {
 153                             return true;
 154                     } else if (other.type == type && other.unique_id < unique_id) {
 155                             return true;
 156                     }
 157                     return false;
 158             }
 159         };
 160         typedef std::set<PluginStatus> PluginStatusList;
 161         PluginStatusList statuses;
 162
 163         ARDOUR::PluginInfoList  _empty_plugin_info;
 164         ARDOUR::PluginInfoList* _windows_vst_plugin_info;
 165         ARDOUR::PluginInfoList* _lxvst_plugin_info;
 166         ARDOUR::PluginInfoList* _mac_vst_plugin_info;
 167         ARDOUR::PluginInfoList* _ladspa_plugin_info;
 168         ARDOUR::PluginInfoList* _lv2_plugin_info;
 169         ARDOUR::PluginInfoList* _au_plugin_info;
 170         ARDOUR::PluginInfoList* _lua_plugin_info;
 171
 172         std::map<uint32_t, std::string> rdf_type;
 173
 174         std::string windows_vst_path;
 175         std::string lxvst_path;
 176
 177         bool _cancel_scan;
 178         bool _cancel_timeout;
 179
 180         void ladspa_refresh ();
 181         void lua_refresh ();
 182         void lua_refresh_cb ();
 183         void windows_vst_refresh (bool cache_only = false);
 184         void mac_vst_refresh (bool cache_only = false);
 185         void lxvst_refresh (bool cache_only = false);
 186
 187         void add_lrdf_data (const std::string &path);
 188         void add_ladspa_presets ();
 189         void add_windows_vst_presets ();
 190         void add_mac_vst_presets ();
 191         void add_lxvst_presets ();
 192         void add_presets (std::string domain);
 193
 194         void au_refresh (bool cache_only = false);
 195
 196         void lv2_refresh ();
 197
 198         int windows_vst_discover_from_path (std::string path, bool cache_only = false);
 199         int windows_vst_discover (std::string path, bool cache_only = false);
 200
 201         int mac_vst_discover_from_path (std::string path, bool cache_only = false);
 202         int mac_vst_discover (std::string path, bool cache_only = false);
 203
 204         int lxvst_discover_from_path (std::string path, bool cache_only = false);
 205         int lxvst_discover (std::string path, bool cache_only = false);
 206
 207         int ladspa_discover (std::string path);
 208
 209         std::string get_ladspa_category (uint32_t id);
 210         std::vector<uint32_t> ladspa_plugin_whitelist;
 211
 212         PBD::ScopedConnection lua_refresh_connection;
 213         Glib::Threads::Mutex _lock;
 214
 215         static PluginManager* _instance; // singleton
 216         PluginManager ();
 217 };
 218
 219 } /* namespace ARDOUR */
 220
 221 #endif /* __ardour_plugin_manager_h__ */
 222