2 Copyright (C) 2000-2007 Paul Davis
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.
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.
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.
20 #ifndef __ardour_plugin_manager_h__
21 #define __ardour_plugin_manager_h__
24 #include "libardour-config.h"
31 #include <boost/utility.hpp>
33 #include "ardour/libardour_visibility.h"
34 #include "ardour/types.h"
35 #include "ardour/plugin.h"
41 class LIBARDOUR_API PluginManager : public boost::noncopyable {
43 static PluginManager& instance();
44 static std::string scanner_bin_path;
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 ();
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 ();
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; }
67 /* always return LXVST for any VST subtype */
68 static PluginType to_generic_vst (PluginType);
70 bool cancelled () { return _cancel_scan; }
71 bool no_timeout () { return _cancel_timeout; }
73 enum PluginStatusType {
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;
88 bool load_plugin_order_file (XMLNode &n) const; //returns TRUE if the passed-in node has valid info
89 void save_plugin_order_file (XMLNode &elem) const;
92 FromPlug, //tag info is being set from plugin metadata
93 FromFactoryFile, // ... from the factory metadata file
94 FromUserFile, // ... from the user's config data
95 FromGui // ... from the UI, in realtime: will emit a signal so ui can show "sanitized" string as it is generated
97 void set_tags (ARDOUR::PluginType type, std::string unique_id, std::string tags, std::string name, TagType tagtype);
98 void reset_tags (PluginInfoPtr const&);
99 std::string get_tags_as_string (PluginInfoPtr const&) const;
100 std::vector<std::string> get_tags (PluginInfoPtr const&) const;
107 std::vector<std::string> get_all_tags (enum TagFilter) const;
109 /** plugins were added to or removed from one of the PluginInfoLists, OR the user has made changes to the status/tags */
110 PBD::Signal0<void> PluginListChanged;
112 /** A single plugin's Hidden/Favorite status changed */
113 PBD::Signal3<void, ARDOUR::PluginType, std::string, PluginStatusType> PluginStatusChanged; //PluginType t, string id, string tag
115 /** A single plugin's Tags status changed */
116 PBD::Signal3<void, ARDOUR::PluginType, std::string, std::string> PluginTagChanged; //PluginType t, string id, string tag
121 ARDOUR::PluginType type;
122 std::string unique_id;
127 PluginTag (ARDOUR::PluginType t, std::string id, std::string tag, std::string n, TagType tt)
128 : type (t), unique_id (id), tags (tag), name(n), tagtype (tt) {}
130 bool operator== (PluginTag const& other) const {
131 return other.type == type && other.unique_id == unique_id;
134 bool operator< (PluginTag const& other) const {
135 if (other.type < type) {
137 } else if (other.type == type && other.unique_id < unique_id) {
144 typedef std::set<PluginTag> PluginTagList;
147 std::string sanitize_tag (const std::string) const;
149 struct PluginStatus {
150 ARDOUR::PluginType type;
151 std::string unique_id;
152 PluginStatusType status;
154 PluginStatus (ARDOUR::PluginType t, std::string id, PluginStatusType s = Normal)
155 : type (t), unique_id (id), status (s) {}
157 bool operator==(const PluginStatus& other) const {
158 return other.type == type && other.unique_id == unique_id;
161 bool operator<(const PluginStatus& other) const {
162 if (other.type < type) {
164 } else if (other.type == type && other.unique_id < unique_id) {
170 typedef std::set<PluginStatus> PluginStatusList;
171 PluginStatusList statuses;
173 ARDOUR::PluginInfoList _empty_plugin_info;
174 ARDOUR::PluginInfoList* _windows_vst_plugin_info;
175 ARDOUR::PluginInfoList* _lxvst_plugin_info;
176 ARDOUR::PluginInfoList* _mac_vst_plugin_info;
177 ARDOUR::PluginInfoList* _ladspa_plugin_info;
178 ARDOUR::PluginInfoList* _lv2_plugin_info;
179 ARDOUR::PluginInfoList* _au_plugin_info;
180 ARDOUR::PluginInfoList* _lua_plugin_info;
182 std::map<uint32_t, std::string> rdf_type;
184 std::string windows_vst_path;
185 std::string lxvst_path;
188 bool _cancel_timeout;
190 void ladspa_refresh ();
192 void lua_refresh_cb ();
193 void windows_vst_refresh (bool cache_only = false);
194 void mac_vst_refresh (bool cache_only = false);
195 void lxvst_refresh (bool cache_only = false);
197 void add_lrdf_data (const std::string &path);
198 void add_ladspa_presets ();
199 void add_windows_vst_presets ();
200 void add_mac_vst_presets ();
201 void add_lxvst_presets ();
202 void add_presets (std::string domain);
204 void au_refresh (bool cache_only = false);
208 int windows_vst_discover_from_path (std::string path, bool cache_only = false);
209 int windows_vst_discover (std::string path, bool cache_only = false);
211 int mac_vst_discover_from_path (std::string path, bool cache_only = false);
212 int mac_vst_discover (std::string path, bool cache_only = false);
214 int lxvst_discover_from_path (std::string path, bool cache_only = false);
215 int lxvst_discover (std::string path, bool cache_only = false);
217 int ladspa_discover (std::string path);
219 std::string get_ladspa_category (uint32_t id);
220 std::vector<uint32_t> ladspa_plugin_whitelist;
222 PBD::ScopedConnection lua_refresh_connection;
223 Glib::Threads::Mutex _lock;
225 static PluginManager* _instance; // singleton
229 } /* namespace ARDOUR */
231 #endif /* __ardour_plugin_manager_h__ */