Defer plugin discovery until actually needed (significant startup time improvement...
[ardour.git] / libs / ardour / plugin_manager.cc
index bc0e18debaf2b35c3e2a7be3042ce49bd8777da8..8315397fe85bbaa30f0243175b8c21b9e0d404a2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2006 Paul Davis 
+    Copyright (C) 2000-2006 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
+#define __STDC_FORMAT_MACROS 1
+#include <stdint.h>
+
 #include <sys/types.h>
 #include <cstdio>
 #include <lrdf.h>
 #include <dlfcn.h>
+#include <cstdlib>
+#include <fstream>
 
 #ifdef VST_SUPPORT
 #include <fst.h>
-#include <pbd/basename.h>
-#include <string.h>
+#include "pbd/basename.h"
+#include <cstring>
 #endif // VST_SUPPORT
 
-#include <pbd/pathscanner.h>
+#include <glibmm/miscutils.h>
+
+#include "pbd/pathscanner.h"
 
-#include <ardour/ladspa.h>
-#include <ardour/session.h>
-#include <ardour/plugin_manager.h>
-#include <ardour/plugin.h>
-#include <ardour/ladspa_plugin.h>
+#include "ardour/ladspa.h"
+#include "ardour/session.h"
+#include "ardour/plugin_manager.h"
+#include "ardour/plugin.h"
+#include "ardour/ladspa_plugin.h"
+#include "ardour/filesystem_paths.h"
+
+#ifdef HAVE_SLV2
+#include <slv2/slv2.h>
+#include "ardour/lv2_plugin.h"
+#endif
 
 #ifdef VST_SUPPORT
-#include <ardour/vst_plugin.h>
+#include "ardour/vst_plugin.h"
+#endif
+
+#ifdef HAVE_AUDIOUNITS
+#include "ardour/audio_unit.h"
+#include <Carbon/Carbon.h>
 #endif
 
-#include <pbd/error.h>
-#include <pbd/stl_delete.h>
+#include "pbd/error.h"
+#include "pbd/stl_delete.h"
 
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
+using namespace std;
 
 PluginManager* PluginManager::_manager = 0;
 
 PluginManager::PluginManager ()
+       : _vst_plugin_info(0)
+       , _ladspa_plugin_info(0)
+       , _lv2_plugin_info(0)
+       , _au_plugin_info(0)
 {
        char* s;
        string lrdf_path;
 
+       load_favorites ();
+
+#ifdef HAVE_AUDIOUNITS
+       ProcessSerialNumber psn = { 0, kCurrentProcess };
+       OSStatus returnCode = TransformProcessType(& psn, kProcessTransformToForegroundApplication);
+       if( returnCode != 0) {
+               error << _("Cannot become GUI app") << endmsg;
+       }
+#endif
+
        if ((s = getenv ("LADSPA_RDF_PATH"))){
                lrdf_path = s;
        }
@@ -82,35 +118,95 @@ PluginManager::PluginManager ()
                vst_path = s;
        }
 
-       refresh ();
        if (_manager == 0) {
                _manager = this;
        }
+
+       /* the plugin manager is constructed too early to use Profile */
+
+       if (getenv ("ARDOUR_SAE")) {
+               ladspa_plugin_whitelist.push_back (1203); // single band parametric
+               ladspa_plugin_whitelist.push_back (1772); // caps compressor
+               ladspa_plugin_whitelist.push_back (1913); // fast lookahead limiter
+               ladspa_plugin_whitelist.push_back (1075); // simple RMS expander
+               ladspa_plugin_whitelist.push_back (1061); // feedback delay line (max 5s)
+               ladspa_plugin_whitelist.push_back (1216); // gverb
+               ladspa_plugin_whitelist.push_back (2150); // tap pitch shifter
+       }
+
+#ifdef HAVE_SLV2
+       _lv2_world = new LV2World();
+#endif
+
+       BootMessage (_("Discovering Plugins"));
 }
 
 void
 PluginManager::refresh ()
 {
        ladspa_refresh ();
+#ifdef HAVE_SLV2
+       lv2_refresh ();
+#endif
 #ifdef VST_SUPPORT
        if (Config->get_use_vst()) {
                vst_refresh ();
        }
 #endif // VST_SUPPORT
+#ifdef HAVE_AUDIOUNITS
+       au_refresh ();
+#endif
 }
 
 void
 PluginManager::ladspa_refresh ()
 {
-       _ladspa_plugin_info.clear ();
+       if (_ladspa_plugin_info)
+               _ladspa_plugin_info->clear ();
+       else
+               _ladspa_plugin_info = new ARDOUR::PluginInfoList ();
+
+       static const char *standard_paths[] = {
+               "/usr/local/lib64/ladspa",
+               "/usr/local/lib/ladspa",
+               "/usr/lib64/ladspa",
+               "/usr/lib/ladspa",
+               "/Library/Audio/Plug-Ins/LADSPA",
+               ""
+       };
+
+       /* allow LADSPA_PATH to augment, not override standard locations */
+
+       /* Only add standard locations to ladspa_path if it doesn't
+        * already contain them. Check for trailing '/'s too.
+        */
+
+       int i;
+       for (i = 0; standard_paths[i][0]; i++) {
+               size_t found = ladspa_path.find(standard_paths[i]);
+               if (found != ladspa_path.npos) {
+                       switch (ladspa_path[found + strlen(standard_paths[i])]) {
+                               case ':' :
+                               case '\0':
+                                       continue;
+                               case '/' :
+                                       if (ladspa_path[found + strlen(standard_paths[i]) + 1] == ':' ||
+                                           ladspa_path[found + strlen(standard_paths[i]) + 1] == '\0') {
+                                               continue;
+                                       }
+                       }
+               }
+               if (!ladspa_path.empty())
+                       ladspa_path += ":";
+
+               ladspa_path += standard_paths[i];
 
-       if (ladspa_path.length() == 0) {
-               ladspa_path = "/usr/local/lib64/ladspa:/usr/local/lib/ladspa:/usr/lib64/ladspa:/usr/lib/ladspa:/Library/Audio/Plug-Ins/LADSPA";
        }
 
        ladspa_discover_from_path (ladspa_path);
 }
 
+
 int
 PluginManager::add_ladspa_directory (string path)
 {
@@ -118,19 +214,19 @@ PluginManager::add_ladspa_directory (string path)
                ladspa_path += ':';
                ladspa_path += path;
                return 0;
-       } 
+       }
        return -1;
 }
 
-static bool ladspa_filter (const string& str, void *arg)
+static bool ladspa_filter (const string& str, void */*arg*/)
 {
        /* Not a dotfile, has a prefix before a period, suffix is "so" */
-       
+
        return str[0] != '.' && (str.length() > 3 && str.find (".so") == (str.length() - 3));
 }
 
 int
-PluginManager::ladspa_discover_from_path (string path)
+PluginManager::ladspa_discover_from_path (string /*path*/)
 {
        PathScanner scanner;
        vector<string *> *plugin_objects;
@@ -149,12 +245,13 @@ PluginManager::ladspa_discover_from_path (string path)
        return ret;
 }
 
-static bool rdf_filter (const string &str, void *arg)
+static bool rdf_filter (const string &str, void* /*arg*/)
 {
-       return str[0] != '.' && 
+       return str[0] != '.' &&
                   ((str.find(".rdf")  == (str.length() - 4)) ||
             (str.find(".rdfs") == (str.length() - 5)) ||
-                   (str.find(".n3")   == (str.length() - 3)));
+                   (str.find(".n3")   == (str.length() - 3)) ||
+                   (str.find(".ttl")  == (str.length() - 4)));
 }
 
 void
@@ -219,7 +316,7 @@ PluginManager::add_lrdf_data (const string &path)
        vector_delete (rdf_files);
 }
 
-int 
+int
 PluginManager::ladspa_discover (string path)
 {
        void *module;
@@ -246,28 +343,54 @@ PluginManager::ladspa_discover (string path)
                        break;
                }
 
+               if (!ladspa_plugin_whitelist.empty()) {
+                       if (find (ladspa_plugin_whitelist.begin(), ladspa_plugin_whitelist.end(), descriptor->UniqueID) == ladspa_plugin_whitelist.end()) {
+                               continue;
+                       }
+               }
+
                PluginInfoPtr info(new LadspaPluginInfo);
                info->name = descriptor->Name;
                info->category = get_ladspa_category(descriptor->UniqueID);
+               info->creator = descriptor->Maker;
                info->path = path;
                info->index = i;
-               info->n_inputs = 0;
-               info->n_outputs = 0;
+               info->n_inputs = ChanCount();
+               info->n_outputs = ChanCount();
                info->type = ARDOUR::LADSPA;
-               info->unique_id = descriptor->UniqueID;
-               
+
+               char buf[32];
+               snprintf (buf, sizeof (buf), "%lu", descriptor->UniqueID);
+               info->unique_id = buf;
+
                for (uint32_t n=0; n < descriptor->PortCount; ++n) {
                        if ( LADSPA_IS_PORT_AUDIO (descriptor->PortDescriptors[n]) ) {
                                if ( LADSPA_IS_PORT_INPUT (descriptor->PortDescriptors[n]) ) {
-                                       info->n_inputs++;
+                                       info->n_inputs.set_audio(info->n_inputs.n_audio() + 1);
                                }
                                else if ( LADSPA_IS_PORT_OUTPUT (descriptor->PortDescriptors[n]) ) {
-                                       info->n_outputs++;
+                                       info->n_outputs.set_audio(info->n_outputs.n_audio() + 1);
                                }
                        }
                }
 
-               _ladspa_plugin_info.push_back (info);
+               if(_ladspa_plugin_info->empty()){
+                       _ladspa_plugin_info->push_back (info);
+               }
+
+               //Ensure that the plugin is not already in the plugin list.
+
+               bool found = false;
+
+               for (PluginInfoList::const_iterator i = _ladspa_plugin_info->begin(); i != _ladspa_plugin_info->end(); ++i) {
+                       if(0 == info->unique_id.compare((*i)->unique_id)){
+                             found = true;
+                       }
+               }
+
+               if(!found){
+                   _ladspa_plugin_info->push_back (info);
+               }
        }
 
 // GDB WILL NOT LIKE YOU IF YOU DO THIS
@@ -284,18 +407,18 @@ PluginManager::get_ladspa_category (uint32_t plugin_id)
 
        snprintf(buf, sizeof(buf), "%s%" PRIu32, LADSPA_BASE, plugin_id);
        pattern.subject = buf;
-       pattern.predicate = RDF_TYPE;
+       pattern.predicate = (char*)RDF_TYPE;
        pattern.object = 0;
        pattern.object_type = lrdf_uri;
 
        lrdf_statement* matches1 = lrdf_matches (&pattern);
 
        if (!matches1) {
-               return _("Unknown");
+               return "";
        }
 
        pattern.subject = matches1->object;
-       pattern.predicate = LADSPA_BASE "hasLabel";
+       pattern.predicate = (char*)(LADSPA_BASE "hasLabel");
        pattern.object = 0;
        pattern.object_type = lrdf_literal;
 
@@ -303,7 +426,7 @@ PluginManager::get_ladspa_category (uint32_t plugin_id)
        lrdf_free_statements(matches1);
 
        if (!matches2) {
-               return _("Unknown");
+               return ("");
        }
 
        string label = matches2->object;
@@ -312,12 +435,34 @@ PluginManager::get_ladspa_category (uint32_t plugin_id)
        return label;
 }
 
+#ifdef HAVE_SLV2
+void
+PluginManager::lv2_refresh ()
+{
+       delete _lv2_plugin_info;
+       _lv2_plugin_info = LV2PluginInfo::discover(_lv2_world);
+}
+#endif
+
+#ifdef HAVE_AUDIOUNITS
+void
+PluginManager::au_refresh ()
+{
+       delete _au_plugin_info;
+       _au_plugin_info = AUPluginInfo::discover();
+}
+
+#endif
+
 #ifdef VST_SUPPORT
 
 void
 PluginManager::vst_refresh ()
 {
-       _vst_plugin_info.clear ();
+       if (_vst_plugin_info)
+               _vst_plugin_info->clear ();
+       else
+               _vst_plugin_info = new ARDOUR::PluginInfoList();
 
        if (vst_path.length() == 0) {
                vst_path = "/usr/local/lib/vst:/usr/lib/vst";
@@ -333,7 +478,7 @@ PluginManager::add_vst_directory (string path)
                vst_path += ':';
                vst_path += path;
                return 0;
-       } 
+       }
        return -1;
 }
 
@@ -341,8 +486,6 @@ static bool vst_filter (const string& str, void *arg)
 {
        /* Not a dotfile, has a prefix before a period, suffix is "dll" */
 
-       cerr << "VST filter: looking at " << str << endl;
-       
        return str[0] != '.' && (str.length() > 4 && str.find (".dll") == (str.length() - 4));
 }
 
@@ -358,15 +501,8 @@ PluginManager::vst_discover_from_path (string path)
 
        plugin_objects = scanner (vst_path, vst_filter, 0, true, true);
 
-       if (plugin_objects) {
-               cerr << "Discovered " << plugin_objects->size() << " possible plugins\n";
-       } else {
-               cerr << "No plugins discovered at all\n";
-       }
-
        if (plugin_objects) {
                for (x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
-                       cerr << "checking out " << **x << endl;
                        vst_discover (**x);
                }
        }
@@ -379,8 +515,10 @@ int
 PluginManager::vst_discover (string path)
 {
        FSTInfo* finfo;
+       char buf[32];
 
        if ((finfo = fst_get_info (const_cast<char *> (path.c_str()))) == 0) {
+               warning << "Cannot get VST information from " << path << endmsg;
                return -1;
        }
 
@@ -389,10 +527,10 @@ PluginManager::vst_discover (string path)
                                    finfo->name)
                        << endl;
        }
-       
+
        PluginInfoPtr info(new VSTPluginInfo);
 
-       /* what a goddam joke freeware VST is */
+       /* what a joke freeware VST is */
 
        if (!strcasecmp ("The Unnamed plugin", finfo->name)) {
                info->name = PBD::basename_nosuffix (path);
@@ -400,17 +538,169 @@ PluginManager::vst_discover (string path)
                info->name = finfo->name;
        }
 
+
+       snprintf (buf, sizeof (buf), "%d", finfo->UniqueID);
+       info->unique_id = buf;
        info->category = "VST";
        info->path = path;
+       info->creator = finfo->creator;
        info->index = 0;
-       info->n_inputs = finfo->numInputs;
-       info->n_outputs = finfo->numOutputs;
+       info->n_inputs.set_audio (finfo->numInputs);
+       info->n_outputs.set_audio (finfo->numOutputs);
        info->type = ARDOUR::VST;
-       
-       _vst_plugin_info.push_back (info);
+
+       _vst_plugin_info->push_back (info);
        fst_free_info (finfo);
 
        return 0;
 }
 
 #endif // VST_SUPPORT
+
+bool
+PluginManager::is_a_favorite_plugin (const PluginInfoPtr& pi)
+{
+       FavoritePlugin fp (pi->type, pi->unique_id);
+       return find (favorites.begin(), favorites.end(), fp) !=  favorites.end();
+}
+
+void
+PluginManager::save_favorites ()
+{
+       ofstream ofs;
+       sys::path path = user_config_directory();
+       path /= "favorite_plugins";
+
+       ofs.open (path.to_string().c_str(), ios_base::openmode (ios::out|ios::trunc));
+
+       if (!ofs) {
+               return;
+       }
+
+       for (FavoritePluginList::iterator i = favorites.begin(); i != favorites.end(); ++i) {
+               switch ((*i).type) {
+               case LADSPA:
+                       ofs << "LADSPA";
+                       break;
+               case AudioUnit:
+                       ofs << "AudioUnit";
+                       break;
+               case LV2:
+                       ofs << "LV2";
+                       break;
+               case VST:
+                       ofs << "VST";
+                       break;
+               }
+
+               ofs << ' ' << (*i).unique_id << endl;
+       }
+
+       ofs.close ();
+}
+
+void
+PluginManager::load_favorites ()
+{
+       sys::path path = user_config_directory();
+       path /= "favorite_plugins";
+       ifstream ifs (path.to_string().c_str());
+
+       if (!ifs) {
+               return;
+       }
+
+       std::string stype;
+       std::string id;
+       PluginType type;
+
+       while (ifs) {
+
+               ifs >> stype;
+               if (!ifs) {
+                       break;
+
+               }
+               ifs >> id;
+               if (!ifs) {
+                       break;
+               }
+
+               if (stype == "LADSPA") {
+                       type = LADSPA;
+               } else if (stype == "AudioUnit") {
+                       type = AudioUnit;
+               } else if (stype == "LV2") {
+                       type = LV2;
+               } else if (stype == "VST") {
+                       type = VST;
+               } else {
+                       error << string_compose (_("unknown favorite plugin type \"%1\" - ignored"), stype)
+                             << endmsg;
+                       continue;
+               }
+
+               add_favorite (type, id);
+       }
+
+       ifs.close ();
+}
+
+void
+PluginManager::add_favorite (PluginType t, string id)
+{
+       FavoritePlugin fp (t, id);
+       pair<FavoritePluginList::iterator,bool> res = favorites.insert (fp);
+       //cerr << "Added " << t << " " << id << " success ? " << res.second << endl;
+}
+
+void
+PluginManager::remove_favorite (PluginType t, string id)
+{
+       FavoritePlugin fp (t, id);
+       favorites.erase (fp);
+}
+
+ARDOUR::PluginInfoList&
+PluginManager::vst_plugin_info ()
+{
+#ifdef VST_SUPPORT
+       if (!_vst_plugin_info)
+               vst_refresh();
+       return *_vst_plugin_info;
+#else
+       return _empty_plugin_info;
+#endif
+}
+
+ARDOUR::PluginInfoList&
+PluginManager::ladspa_plugin_info ()
+{
+       if (!_ladspa_plugin_info)
+               ladspa_refresh();
+       return *_ladspa_plugin_info;
+}
+
+ARDOUR::PluginInfoList&
+PluginManager::lv2_plugin_info ()
+{
+#ifdef HAVE_SLV2
+       if (!_lv2_plugin_info)
+               lv2_refresh();
+       return *_lv2_plugin_info;
+#else
+       return _empty_plugin_info;
+#endif
+}
+
+ARDOUR::PluginInfoList&
+PluginManager::au_plugin_info ()
+{
+#ifdef HAVE_AUDIOUNITS
+       if (!_au_plugin_info)
+               au_refresh();
+       return *_au_plugin_info;
+#else
+       return _empty_plugin_info;
+#endif
+}