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         ARDOUR::PluginInfoList &windows_vst_plugin_info ();
  49         ARDOUR::PluginInfoList &lxvst_plugin_info ();
  50         ARDOUR::PluginInfoList &ladspa_plugin_info ();
  51         ARDOUR::PluginInfoList &lv2_plugin_info ();
  52         ARDOUR::PluginInfoList &au_plugin_info ();
  53
  54         void refresh (bool cache_only = false);
  55         void cancel_plugin_scan();
  56         void cancel_plugin_timeout();
  57         void clear_vst_cache ();
  58         void clear_vst_blacklist ();
  59
  60         const std::string get_default_windows_vst_path() const { return windows_vst_path; }
  61         const std::string get_default_lxvst_path() const { return lxvst_path; }
  62
  63         bool cancelled () { return _cancel_scan; }
  64         bool no_timeout () { return _cancel_timeout; }
  65
  66         enum PluginStatusType {
  67                 Normal = 0,
  68                 Favorite,
  69                 Hidden
  70         };
  71
  72         void load_statuses ();
  73         void save_statuses ();
  74         void set_status (ARDOUR::PluginType type, std::string unique_id, PluginStatusType status);
  75         PluginStatusType get_status (const PluginInfoPtr&);
  76
  77         /** plugins were added to or removed from one of the PluginInfoLists */
  78         PBD::Signal0<void> PluginListChanged;
  79
  80   private:
  81         struct PluginStatus {
  82             ARDOUR::PluginType type;
  83             std::string unique_id;
  84             PluginStatusType status;
  85
  86             PluginStatus (ARDOUR::PluginType t, std::string id, PluginStatusType s = Normal)
  87             : type (t), unique_id (id), status (s) {}
  88
  89             bool operator==(const PluginStatus& other) const {
  90                     return other.type == type && other.unique_id == unique_id;
  91             }
  92
  93             bool operator<(const PluginStatus& other) const {
  94                     if (other.type < type) {
  95                             return true;
  96                     } else if (other.type == type && other.unique_id < unique_id) {
  97                             return true;
  98                     }
  99                     return false;
 100             }
 101         };
 102         typedef std::set<PluginStatus> PluginStatusList;
 103         PluginStatusList statuses;
 104
 105         ARDOUR::PluginInfoList  _empty_plugin_info;
 106         ARDOUR::PluginInfoList* _windows_vst_plugin_info;
 107         ARDOUR::PluginInfoList* _lxvst_plugin_info;
 108         ARDOUR::PluginInfoList* _ladspa_plugin_info;
 109         ARDOUR::PluginInfoList* _lv2_plugin_info;
 110         ARDOUR::PluginInfoList* _au_plugin_info;
 111
 112         std::map<uint32_t, std::string> rdf_type;
 113
 114         std::string windows_vst_path;
 115         std::string lxvst_path;
 116
 117         bool _cancel_scan;
 118         bool _cancel_timeout;
 119
 120         void ladspa_refresh ();
 121         void windows_vst_refresh (bool cache_only = false);
 122         void lxvst_refresh (bool cache_only = false);
 123
 124         void add_lrdf_data (const std::string &path);
 125         void add_ladspa_presets ();
 126         void add_windows_vst_presets ();
 127         void add_lxvst_presets ();
 128         void add_presets (std::string domain);
 129
 130         void au_refresh (bool cache_only = false);
 131
 132         void lv2_refresh ();
 133
 134         int windows_vst_discover_from_path (std::string path, bool cache_only = false);
 135         int windows_vst_discover (std::string path, bool cache_only = false);
 136
 137         int lxvst_discover_from_path (std::string path, bool cache_only = false);
 138         int lxvst_discover (std::string path, bool cache_only = false);
 139
 140         int ladspa_discover (std::string path);
 141
 142         std::string get_ladspa_category (uint32_t id);
 143         std::vector<uint32_t> ladspa_plugin_whitelist;
 144
 145         static PluginManager* _instance; // singleton
 146         PluginManager ();
 147 };
 148
 149 } /* namespace ARDOUR */
 150
 151 #endif /* __ardour_plugin_manager_h__ */
 152