forward port 2.X changes up to and including rev 6909
[ardour.git] / libs / ardour / plugin_manager.cc
index c0c854180f85dc3ecf6b4aa904794bb1847775df..91c4d715d5f80f4625d1fc32dcebd9ff364fe20d 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
 
 */
 
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
 #define __STDC_FORMAT_MACROS 1
 #include <stdint.h>
 
@@ -36,6 +40,7 @@
 #include <glibmm/miscutils.h>
 
 #include "pbd/pathscanner.h"
+#include "pbd/whitespace.h"
 
 #include "ardour/ladspa.h"
 #include "ardour/session.h"
@@ -70,14 +75,18 @@ 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 ();
+       load_statuses ();
 
-#ifdef GTKOSX
-       ProcessSerialNumber psn = { 0, kCurrentProcess }; 
+#ifdef HAVE_AUDIOUNITS
+       ProcessSerialNumber psn = { 0, kCurrentProcess };
        OSStatus returnCode = TransformProcessType(& psn, kProcessTransformToForegroundApplication);
        if( returnCode != 0) {
                error << _("Cannot become GUI app") << endmsg;
@@ -124,17 +133,24 @@ PluginManager::PluginManager ()
                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"));
+}
+
 
-       refresh ();
+PluginManager::~PluginManager()
+{
+#ifdef HAVE_SLV2
+       delete _lv2_world;
+#endif
 }
 
+
 void
 PluginManager::refresh ()
 {
@@ -150,50 +166,55 @@ PluginManager::refresh ()
 #ifdef HAVE_AUDIOUNITS
        au_refresh ();
 #endif
+
+       PluginListChanged (); /* EMIT SIGNAL */
 }
 
 void
 PluginManager::ladspa_refresh ()
 {
-       _ladspa_plugin_info.clear ();
-       
-       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_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 G_DIR_SEPARATOR :
+                                       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];
+
+       }
+
        ladspa_discover_from_path (ladspa_path);
 }
 
@@ -205,19 +226,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;
@@ -236,12 +257,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
@@ -289,13 +311,12 @@ PluginManager::add_lrdf_data (const string &path)
        PathScanner scanner;
        vector<string *>* rdf_files;
        vector<string *>::iterator x;
-       string uri;
 
        rdf_files = scanner (path, rdf_filter, 0, true, true);
 
        if (rdf_files) {
                for (x = rdf_files->begin(); x != rdf_files->end (); ++x) {
-                       uri = "file://" + **x;
+                       const string uri(string("file://") + **x);
 
                        if (lrdf_read_file(uri.c_str())) {
                                warning << "Could not parse rdf file: " << uri << endmsg;
@@ -306,7 +327,7 @@ PluginManager::add_lrdf_data (const string &path)
        vector_delete (rdf_files);
 }
 
-int 
+int
 PluginManager::ladspa_discover (string path)
 {
        void *module;
@@ -337,7 +358,7 @@ PluginManager::ladspa_discover (string path)
                        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;
@@ -348,11 +369,11 @@ PluginManager::ladspa_discover (string path)
                info->n_inputs = ChanCount();
                info->n_outputs = ChanCount();
                info->type = ARDOUR::LADSPA;
-               
+
                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]) ) {
@@ -364,22 +385,22 @@ PluginManager::ladspa_discover (string path)
                        }
                }
 
-               if(_ladspa_plugin_info.empty()){
-                       _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) {
+               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);
+                   _ladspa_plugin_info->push_back (info);
                }
        }
 
@@ -404,7 +425,7 @@ PluginManager::get_ladspa_category (uint32_t plugin_id)
        lrdf_statement* matches1 = lrdf_matches (&pattern);
 
        if (!matches1) {
-               return "";
+               return "Unknown";
        }
 
        pattern.subject = matches1->object;
@@ -416,7 +437,7 @@ PluginManager::get_ladspa_category (uint32_t plugin_id)
        lrdf_free_statements(matches1);
 
        if (!matches2) {
-               return ("");
+               return ("Unknown");
        }
 
        string label = matches2->object;
@@ -429,14 +450,8 @@ PluginManager::get_ladspa_category (uint32_t plugin_id)
 void
 PluginManager::lv2_refresh ()
 {
-       lv2_discover();
-}
-
-int
-PluginManager::lv2_discover ()
-{
+       delete _lv2_plugin_info;
        _lv2_plugin_info = LV2PluginInfo::discover(_lv2_world);
-       return 0;
 }
 #endif
 
@@ -444,14 +459,8 @@ PluginManager::lv2_discover ()
 void
 PluginManager::au_refresh ()
 {
-       au_discover();
-}
-
-int
-PluginManager::au_discover ()
-{
+       delete _au_plugin_info;
        _au_plugin_info = AUPluginInfo::discover();
-       return 0;
 }
 
 #endif
@@ -461,7 +470,10 @@ PluginManager::au_discover ()
 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";
@@ -477,7 +489,7 @@ PluginManager::add_vst_directory (string path)
                vst_path += ':';
                vst_path += path;
                return 0;
-       } 
+       }
        return -1;
 }
 
@@ -526,7 +538,7 @@ PluginManager::vst_discover (string path)
                                    finfo->name)
                        << endl;
        }
-       
+
        PluginInfoPtr info(new VSTPluginInfo);
 
        /* what a joke freeware VST is */
@@ -537,7 +549,7 @@ PluginManager::vst_discover (string path)
                info->name = finfo->name;
        }
 
-       
+
        snprintf (buf, sizeof (buf), "%d", finfo->UniqueID);
        info->unique_id = buf;
        info->category = "VST";
@@ -546,9 +558,10 @@ PluginManager::vst_discover (string path)
        info->index = 0;
        info->n_inputs.set_audio (finfo->numInputs);
        info->n_outputs.set_audio (finfo->numOutputs);
+       info->n_inputs.set_midi (finfo->wantMidi ? 1 : 0);
        info->type = ARDOUR::VST;
-       
-       _vst_plugin_info.push_back (info);
+
+       _vst_plugin_info->push_back (info);
        fst_free_info (finfo);
 
        return 0;
@@ -556,19 +569,24 @@ PluginManager::vst_discover (string path)
 
 #endif // VST_SUPPORT
 
-bool
-PluginManager::is_a_favorite_plugin (const PluginInfoPtr& pi)
+PluginManager::PluginStatusType
+PluginManager::get_status (const PluginInfoPtr& pi)
 {
-       FavoritePlugin fp (pi->type, pi->unique_id);
-       return find (favorites.begin(), favorites.end(), fp) !=  favorites.end();
+       PluginStatus ps (pi->type, pi->unique_id);
+       PluginStatusList::const_iterator i =  find (statuses.begin(), statuses.end(), ps);
+       if (i ==  statuses.end() ) {
+               return Normal;
+       } else {
+               return i->status;
+       }
 }
 
 void
-PluginManager::save_favorites ()
+PluginManager::save_statuses ()
 {
        ofstream ofs;
        sys::path path = user_config_directory();
-       path /= "favorite_plugins";
+       path /= "plugin_statuses";
 
        ofs.open (path.to_string().c_str(), ios_base::openmode (ios::out|ios::trunc));
 
@@ -576,7 +594,7 @@ PluginManager::save_favorites ()
                return;
        }
 
-       for (FavoritePluginList::iterator i = favorites.begin(); i != favorites.end(); ++i) {
+       for (PluginStatusList::iterator i = statuses.begin(); i != statuses.end(); ++i) {
                switch ((*i).type) {
                case LADSPA:
                        ofs << "LADSPA";
@@ -591,18 +609,34 @@ PluginManager::save_favorites ()
                        ofs << "VST";
                        break;
                }
-               
-               ofs << ' ' << (*i).unique_id << endl;
+
+               ofs << ' ';
+
+               switch ((*i).status) {
+               case Normal:
+                       ofs << "Normal";
+                       break;
+               case Favorite:
+                       ofs << "Favorite";
+                       break;
+               case Hidden:
+                       ofs << "Hidden";
+                       break;
+               }
+       
+               ofs << ' ';
+               ofs << (*i).unique_id;;
+               ofs << endl;
        }
 
        ofs.close ();
 }
 
 void
-PluginManager::load_favorites ()
+PluginManager::load_statuses ()
 {
        sys::path path = user_config_directory();
-       path /= "favorite_plugins";
+       path /= "plugin_statuses";
        ifstream ifs (path.to_string().c_str());
 
        if (!ifs) {
@@ -610,8 +644,11 @@ PluginManager::load_favorites ()
        }
        
        std::string stype;
+       std::string sstatus;
        std::string id;
        PluginType type;
+       PluginStatusType status;
+       char buf[1024];
 
        while (ifs) {
 
@@ -620,11 +657,33 @@ PluginManager::load_favorites ()
                        break;
 
                }
-               ifs >> id;
+
+               ifs >> sstatus;
+               if (!ifs) {
+                       break;
+
+               }
+
+               /* rest of the line is the plugin ID */
+
+               ifs.getline (buf, sizeof (buf), '\n');
                if (!ifs) {
                        break;
                }
 
+               if (sstatus == "Normal") {
+                       status = Normal;
+               } else if (sstatus == "Favorite") {
+                       status = Favorite;
+               } else if (sstatus == "Hidden") {
+                       status = Hidden;
+               } else {
+                       error << string_compose (_("unknown plugin status type \"%1\" - all entries ignored"), sstatus)
+                                 << endmsg;
+                       statuses.clear ();
+                       break;
+               }
+
                if (stype == "LADSPA") {
                        type = LADSPA;
                } else if (stype == "AudioUnit") {
@@ -634,28 +693,73 @@ PluginManager::load_favorites ()
                } else if (stype == "VST") {
                        type = VST;
                } else {
-                       error << string_compose (_("unknown favorite plugin type \"%1\" - ignored"), stype)
+                       error << string_compose (_("unknown plugin type \"%1\" - ignored"), stype)
                              << endmsg;
                        continue;
                }
                
-               add_favorite (type, id);
+               id = buf;
+               strip_whitespace_edges (id);
+               set_status (type, id, status);
        }
        
        ifs.close ();
 }
 
 void
-PluginManager::add_favorite (PluginType t, string id)
+PluginManager::set_status (PluginType t, string id, PluginStatusType status)
 {
-       FavoritePlugin fp (t, id);
-       pair<FavoritePluginList::iterator,bool> res = favorites.insert (fp);
-       //cerr << "Added " << t << " " << id << " success ? " << res.second << endl;
+       PluginStatus ps (t, id, status);
+       statuses.erase (ps);
+
+       if (status == Normal) {
+               return;
+       }
+
+       pair<PluginStatusList::iterator, bool> res = statuses.insert (ps);
+       //cerr << "Added " << t << " " << id << " " << status << " success ? " << res.second << endl;
 }
 
-void
-PluginManager::remove_favorite (PluginType t, string id)
+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 ()
 {
-       FavoritePlugin fp (t, id);
-       favorites.erase (fp);
+       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
 }