Tag_reset() should be FromPlug, not FromGui.
[ardour.git] / libs / ardour / ardour / plugin_manager.h
index 2464368ae7b84b31bbd47ac09f4532178961beaf..a66e2d0674e38863152daa5968bc438290140d4b 100644 (file)
@@ -30,6 +30,7 @@
 #include <set>
 #include <boost/utility.hpp>
 
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/plugin.h"
 
@@ -37,22 +38,37 @@ namespace ARDOUR {
 
 class Plugin;
 
-class PluginManager : public boost::noncopyable {
-  public:
+class LIBARDOUR_API PluginManager : public boost::noncopyable {
+public:
        static PluginManager& instance();
+       static std::string scanner_bin_path;
 
        ~PluginManager ();
 
-       ARDOUR::PluginInfoList &windows_vst_plugin_info ();
-       ARDOUR::PluginInfoList &lxvst_plugin_info ();
-       ARDOUR::PluginInfoList &ladspa_plugin_info ();
-       ARDOUR::PluginInfoList &lv2_plugin_info ();
-       ARDOUR::PluginInfoList &au_plugin_info ();
+       const ARDOUR::PluginInfoList& windows_vst_plugin_info ();
+       const ARDOUR::PluginInfoList& lxvst_plugin_info ();
+       const ARDOUR::PluginInfoList& mac_vst_plugin_info ();
+       const ARDOUR::PluginInfoList& ladspa_plugin_info ();
+       const ARDOUR::PluginInfoList& lv2_plugin_info ();
+       const ARDOUR::PluginInfoList& au_plugin_info ();
+       const ARDOUR::PluginInfoList& lua_plugin_info ();
 
-       void refresh ();
+       void refresh (bool cache_only = false);
+       void cancel_plugin_scan();
+       void cancel_plugin_timeout();
+       void clear_vst_cache ();
+       void clear_vst_blacklist ();
+       void clear_au_cache ();
+       void clear_au_blacklist ();
 
-       int add_windows_vst_directory (std::string dirpath);
-       int add_lxvst_directory (std::string dirpath);
+       const std::string get_default_windows_vst_path() const { return windows_vst_path; }
+       const std::string get_default_lxvst_path() const { return lxvst_path; }
+
+       /* always return LXVST for any VST subtype */
+       static PluginType to_generic_vst (PluginType);
+
+       bool cancelled () { return _cancel_scan; }
+       bool no_timeout () { return _cancel_timeout; }
 
        enum PluginStatusType {
                Normal = 0,
@@ -60,15 +76,73 @@ class PluginManager : public boost::noncopyable {
                Hidden
        };
 
+       std::string user_plugin_metadata_dir () const;
        void load_statuses ();
        void save_statuses ();
        void set_status (ARDOUR::PluginType type, std::string unique_id, PluginStatusType status);
-       PluginStatusType get_status (const PluginInfoPtr&);
+       PluginStatusType get_status (const PluginInfoPtr&) const;
+
+       void load_tags ();
+       void save_tags ();
+
+       enum TagType {
+               FromPlug,           //tag info is being set from plugin metadata
+               FromFactoryFile,    // ... from the factory metadata file
+               FromUserFile,       // ... from the user's config data
+               FromGui             // ... from the UI, in realtime: will emit a signal so ui can show "sanitized" string as it is generated
+       };
+       void set_tags (ARDOUR::PluginType type, std::string unique_id, std::string tags, std::string name, TagType tagtype);
+       void reset_tags (PluginInfoPtr const&);
+       std::string get_tags_as_string (PluginInfoPtr const&) const;
+       std::vector<std::string> get_tags (PluginInfoPtr const&) const;
+
+       enum TagFilter {
+               All,
+               OnlyFavorites,
+               NoHidden
+       };
+       std::vector<std::string> get_all_tags (enum TagFilter) const;
 
-       /** plugins were added to or removed from one of the PluginInfoLists */
+       /** plugins were added to or removed from one of the PluginInfoLists, OR the user has made changes to the status/tags */
        PBD::Signal0<void> PluginListChanged;
 
-  private:
+       /** A single plugin's Hidden/Favorite status changed */
+       PBD::Signal3<void, ARDOUR::PluginType, std::string, PluginStatusType> PluginStatusChanged; //PluginType t, string id, string tag
+
+       /** A single plugin's Tags status changed */
+       PBD::Signal3<void, ARDOUR::PluginType, std::string, std::string> PluginTagChanged; //PluginType t, string id, string tag
+
+private:
+
+       struct PluginTag {
+           ARDOUR::PluginType type;
+           std::string unique_id;
+           std::string tags;
+           std::string name;
+               TagType tagtype;
+
+           PluginTag (ARDOUR::PluginType t, std::string id, std::string tag, std::string n, TagType tt)
+           : type (t), unique_id (id), tags (tag), name(n), tagtype (tt) {}
+
+           bool operator== (PluginTag const& other) const {
+                   return other.type == type && other.unique_id == unique_id;
+           }
+
+           bool operator< (PluginTag const& other) const {
+                   if (other.type < type) {
+                           return true;
+                   } else if (other.type == type && other.unique_id < unique_id) {
+                           return true;
+                   }
+                   return false;
+           }
+       };
+
+       typedef std::set<PluginTag> PluginTagList;
+       PluginTagList ptags;
+
+       std::string sanitize_tag (const std::string) const;
+
        struct PluginStatus {
            ARDOUR::PluginType type;
            std::string unique_id;
@@ -96,40 +170,55 @@ class PluginManager : public boost::noncopyable {
        ARDOUR::PluginInfoList  _empty_plugin_info;
        ARDOUR::PluginInfoList* _windows_vst_plugin_info;
        ARDOUR::PluginInfoList* _lxvst_plugin_info;
+       ARDOUR::PluginInfoList* _mac_vst_plugin_info;
        ARDOUR::PluginInfoList* _ladspa_plugin_info;
        ARDOUR::PluginInfoList* _lv2_plugin_info;
        ARDOUR::PluginInfoList* _au_plugin_info;
+       ARDOUR::PluginInfoList* _lua_plugin_info;
 
        std::map<uint32_t, std::string> rdf_type;
 
        std::string windows_vst_path;
        std::string lxvst_path;
 
+       bool _cancel_scan;
+       bool _cancel_timeout;
+
        void ladspa_refresh ();
-       void windows_vst_refresh ();
-       void lxvst_refresh ();
+       void lua_refresh ();
+       void lua_refresh_cb ();
+       void windows_vst_refresh (bool cache_only = false);
+       void mac_vst_refresh (bool cache_only = false);
+       void lxvst_refresh (bool cache_only = false);
 
        void add_lrdf_data (const std::string &path);
        void add_ladspa_presets ();
        void add_windows_vst_presets ();
+       void add_mac_vst_presets ();
        void add_lxvst_presets ();
        void add_presets (std::string domain);
 
-       void au_refresh ();
+       void au_refresh (bool cache_only = false);
 
        void lv2_refresh ();
 
-       int windows_vst_discover_from_path (std::string path);
-       int windows_vst_discover (std::string path);
-       
-       int lxvst_discover_from_path (std::string path);
-       int lxvst_discover (std::string path);
+       int windows_vst_discover_from_path (std::string path, bool cache_only = false);
+       int windows_vst_discover (std::string path, bool cache_only = false);
+
+       int mac_vst_discover_from_path (std::string path, bool cache_only = false);
+       int mac_vst_discover (std::string path, bool cache_only = false);
+
+       int lxvst_discover_from_path (std::string path, bool cache_only = false);
+       int lxvst_discover (std::string path, bool cache_only = false);
 
        int ladspa_discover (std::string path);
 
        std::string get_ladspa_category (uint32_t id);
        std::vector<uint32_t> ladspa_plugin_whitelist;
 
+       PBD::ScopedConnection lua_refresh_connection;
+       Glib::Threads::Mutex _lock;
+
        static PluginManager* _instance; // singleton
        PluginManager ();
 };