fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / plugin_manager.cc
index e88541317c586ff42fc7c3dce307878d461688d4..23515a2e2e67867556cc4e167501358408fab5db 100644 (file)
@@ -26,7 +26,9 @@
 #include <sys/types.h>
 #include <cstdio>
 #include <cstdlib>
-#include <fstream>
+
+#include <glib.h>
+#include "pbd/gstdio_compat.h"
 
 #ifdef HAVE_LRDF
 #include <lrdf.h>
 #include "fst.h"
 #include "pbd/basename.h"
 #include <cstring>
+
+// dll-info
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <stdint.h>
+
 #endif // WINDOWS_VST_SUPPORT
 
 #ifdef LXVST_SUPPORT
@@ -46,7 +55,6 @@
 #include <cstring>
 #endif //LXVST_SUPPORT
 
-#include <glib/gstdio.h>
 #include <glibmm/miscutils.h>
 #include <glibmm/pattern.h>
 #include <glibmm/fileutils.h>
@@ -59,6 +67,8 @@
 #include "ardour/filesystem_paths.h"
 #include "ardour/ladspa.h"
 #include "ardour/ladspa_plugin.h"
+#include "ardour/luascripting.h"
+#include "ardour/luaproc.h"
 #include "ardour/plugin.h"
 #include "ardour/plugin_manager.h"
 #include "ardour/rc_configuration.h"
@@ -85,7 +95,7 @@
 #include "pbd/error.h"
 #include "pbd/stl_delete.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #include "ardour/debug.h"
 
@@ -111,6 +121,7 @@ PluginManager::PluginManager ()
        , _ladspa_plugin_info(0)
        , _lv2_plugin_info(0)
        , _au_plugin_info(0)
+       , _lua_plugin_info(0)
        , _cancel_scan(false)
        , _cancel_timeout(false)
 {
@@ -123,7 +134,7 @@ PluginManager::PluginManager ()
 
 #ifdef PLATFORM_WINDOWS
        // on windows the .exe needs to be in the same folder with libardour.dll
-       vstsp += Glib::build_filename(g_win32_get_package_installation_directory_of_module (0), "bin");
+       vstsp += Glib::build_filename(windows_package_directory_path(), "bin");
 #else
        // on Unices additional internal-use binaries are deployed to $libdir
        vstsp += ARDOUR::ardour_dll_directory();
@@ -207,6 +218,8 @@ PluginManager::PluginManager ()
        }
 
        BootMessage (_("Discovering Plugins"));
+
+       LuaScripting::instance().scripts_changed.connect_same_thread (lua_refresh_connection, boost::bind (&PluginManager::lua_refresh_cb, this));
 }
 
 
@@ -219,37 +232,75 @@ PluginManager::~PluginManager()
                delete _ladspa_plugin_info;
                delete _lv2_plugin_info;
                delete _au_plugin_info;
+               delete _lua_plugin_info;
        }
 }
 
 void
 PluginManager::refresh (bool cache_only)
 {
+       Glib::Threads::Mutex::Lock lm (_lock, Glib::Threads::TRY_LOCK);
+
+       if (!lm.locked()) {
+               return;
+       }
+
        DEBUG_TRACE (DEBUG::PluginManager, "PluginManager::refresh\n");
        _cancel_scan = false;
 
        BootMessage (_("Scanning LADSPA Plugins"));
        ladspa_refresh ();
+       BootMessage (_("Scanning Lua DSP Processors"));
+       lua_refresh ();
 #ifdef LV2_SUPPORT
        BootMessage (_("Scanning LV2 Plugins"));
        lv2_refresh ();
 #endif
 #ifdef WINDOWS_VST_SUPPORT
        if (Config->get_use_windows_vst()) {
-               BootMessage (_("Scanning Windows VST Plugins"));
+               if (cache_only) {
+                       BootMessage (_("Scanning Windows VST Plugins"));
+               } else {
+                       BootMessage (_("Discovering Windows VST Plugins"));
+               }
                windows_vst_refresh (cache_only);
        }
 #endif // WINDOWS_VST_SUPPORT
 
 #ifdef LXVST_SUPPORT
        if(Config->get_use_lxvst()) {
-               BootMessage (_("Scanning Linux VST Plugins"));
+               if (cache_only) {
+                       BootMessage (_("Scanning Linux VST Plugins"));
+               } else {
+                       BootMessage (_("Discovering Linux VST Plugins"));
+               }
                lxvst_refresh(cache_only);
        }
 #endif //Native linuxVST SUPPORT
 
+#if (defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT)
+               if (!cache_only) {
+                       string fn = Glib::build_filename (ARDOUR::user_cache_directory(), VST_BLACKLIST);
+                       if (Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
+                               gchar *bl = NULL;
+                               if (g_file_get_contents(fn.c_str (), &bl, NULL, NULL)) {
+                                       if (Config->get_verbose_plugin_scan()) {
+                                               PBD::info << _("VST Blacklist: ") << fn << "\n" << bl << "-----" << endmsg;
+                                       } else {
+                                               PBD::info << _("VST Blacklist:") << "\n" << bl << "-----" << endmsg;
+                                       }
+                                       g_free (bl);
+                               }
+                       }
+               }
+#endif
+
 #ifdef AUDIOUNIT_SUPPORT
-       BootMessage (_("Scanning AU Plugins"));
+       if (cache_only) {
+               BootMessage (_("Scanning AU Plugins"));
+       } else {
+               BootMessage (_("Discovering AU Plugins"));
+       }
        au_refresh (cache_only);
 #endif
 
@@ -274,8 +325,15 @@ PluginManager::cancel_plugin_timeout ()
 void
 PluginManager::clear_vst_cache ()
 {
-       // see also libs/ardour/vst_info_file.cc - vstfx_infofile_path()
+#if 1 // clean old cache and error files. (remove this code after 4.3 or 5.0)
 #ifdef WINDOWS_VST_SUPPORT
+       {
+               vector<string> fsi_files;
+               find_files_matching_regex (fsi_files, Config->get_plugin_path_vst(), "\\" VST_EXT_INFOFILE "$", true);
+               for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
+                       ::g_unlink(i->c_str());
+               }
+       }
        {
                vector<string> fsi_files;
                find_files_matching_regex (fsi_files, Config->get_plugin_path_vst(), "\\.fsi$", true);
@@ -283,9 +341,23 @@ PluginManager::clear_vst_cache ()
                        ::g_unlink(i->c_str());
                }
        }
+       {
+               vector<string> fsi_files;
+               find_files_matching_regex (fsi_files, Config->get_plugin_path_vst(), "\\.err$", true);
+               for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
+                       ::g_unlink(i->c_str());
+               }
+       }
 #endif
 
 #ifdef LXVST_SUPPORT
+       {
+               vector<string> fsi_files;
+               find_files_matching_regex (fsi_files, Config->get_plugin_path_lxvst(), "\\" VST_EXT_INFOFILE "$", true);
+               for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
+                       ::g_unlink(i->c_str());
+               }
+       }
        {
                vector<string> fsi_files;
                find_files_matching_regex (fsi_files, Config->get_plugin_path_lxvst(), "\\.fsi$", true);
@@ -293,13 +365,29 @@ PluginManager::clear_vst_cache ()
                        ::g_unlink(i->c_str());
                }
        }
+       {
+               vector<string> fsi_files;
+               find_files_matching_regex (fsi_files, Config->get_plugin_path_lxvst(), "\\.err$", true);
+               for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
+                       ::g_unlink(i->c_str());
+               }
+       }
+#endif
+#if (defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT)
+       {
+               string dir = Glib::build_filename (ARDOUR::user_cache_directory(), "fst_info");
+               if (Glib::file_test (dir, Glib::FILE_TEST_IS_DIR)) {
+                       PBD::remove_directory (dir);
+               }
+       }
 #endif
+#endif // old cache cleanup
 
 #if (defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT)
        {
-               string personal = get_personal_vst_info_cache_dir();
+               string dn = Glib::build_filename (ARDOUR::user_cache_directory(), "vst");
                vector<string> fsi_files;
-               find_files_matching_regex (fsi_files, personal, "\\.fsi$", /* user cache is flat, no recursion */ false);
+               find_files_matching_regex (fsi_files, dn, "\\" VST_EXT_INFOFILE "$", /* user cache is flat, no recursion */ false);
                for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
                        ::g_unlink(i->c_str());
                }
@@ -310,10 +398,12 @@ PluginManager::clear_vst_cache ()
 void
 PluginManager::clear_vst_blacklist ()
 {
+#if 1 // remove old blacklist files. (remove this code after 4.3 or 5.0)
+
 #ifdef WINDOWS_VST_SUPPORT
        {
                vector<string> fsi_files;
-               find_files_matching_regex (fsi_files, Config->get_plugin_path_vst(), "\\.fsb$", true);
+               find_files_matching_regex (fsi_files, Config->get_plugin_path_vst(), "\\" VST_EXT_BLACKLIST "$", true);
                for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
                        ::g_unlink(i->c_str());
                }
@@ -323,35 +413,39 @@ PluginManager::clear_vst_blacklist ()
 #ifdef LXVST_SUPPORT
        {
                vector<string> fsi_files;
-               find_files_matching_regex (fsi_files, Config->get_plugin_path_lxvst(), "\\.fsb$", true);
+               find_files_matching_regex (fsi_files, Config->get_plugin_path_lxvst(), "\\" VST_EXT_BLACKLIST "$", true);
                for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
                        ::g_unlink(i->c_str());
                }
        }
 #endif
-
 #if (defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT)
        {
-               string personal = get_personal_vst_blacklist_dir();
+               string dir = Glib::build_filename (ARDOUR::user_cache_directory(), "fst_blacklist");
+               if (Glib::file_test (dir, Glib::FILE_TEST_IS_DIR)) {
+                       PBD::remove_directory (dir);
+               }
+       }
+#endif
 
-               vector<string> fsi_files;
-               find_files_matching_regex (fsi_files, personal, "\\.fsb$", /* flat user cache */ false);
-               for (vector<string>::iterator i = fsi_files.begin(); i != fsi_files.end (); ++i) {
-                       ::g_unlink(i->c_str());
+#endif // old blacklist cleanup
+
+#if (defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT)
+       {
+               string fn = Glib::build_filename (ARDOUR::user_cache_directory(), VST_BLACKLIST);
+               if (Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
+                       ::g_unlink (fn.c_str());
                }
        }
 #endif
+
 }
 
 void
 PluginManager::clear_au_cache ()
 {
 #ifdef AUDIOUNIT_SUPPORT
-       // AUPluginInfo::au_cache_path ()
-       string fn = Glib::build_filename (ARDOUR::user_config_directory(), "au_cache");
-       if (Glib::file_test (fn, Glib::FILE_TEST_EXISTS)) {
-               ::g_unlink(fn.c_str());
-       }
+       AUPluginInfo::clear_cache ();
 #endif
 }
 
@@ -366,6 +460,32 @@ PluginManager::clear_au_blacklist ()
 #endif
 }
 
+void
+PluginManager::lua_refresh ()
+{
+       if (_lua_plugin_info) {
+               _lua_plugin_info->clear ();
+       } else {
+               _lua_plugin_info = new ARDOUR::PluginInfoList ();
+       }
+       ARDOUR::LuaScriptList & _scripts (LuaScripting::instance ().scripts (LuaScriptInfo::DSP));
+       for (LuaScriptList::const_iterator s = _scripts.begin(); s != _scripts.end(); ++s) {
+               LuaPluginInfoPtr lpi (new LuaPluginInfo(*s));
+               _lua_plugin_info->push_back (lpi);
+       }
+}
+
+void
+PluginManager::lua_refresh_cb ()
+{
+       Glib::Threads::Mutex::Lock lm (_lock, Glib::Threads::TRY_LOCK);
+       if (!lm.locked()) {
+               return;
+       }
+       lua_refresh ();
+       PluginListChanged (); /* EMIT SIGNAL */
+}
+
 void
 PluginManager::ladspa_refresh ()
 {
@@ -496,6 +616,11 @@ PluginManager::ladspa_discover (string path)
        DEBUG_TRACE (DEBUG::PluginManager, string_compose ("LADSPA plugin found at %1\n", path));
 
        for (uint32_t i = 0; ; ++i) {
+               /* if a ladspa plugin allocates memory here
+                * it is never free()ed (or plugin-dependent only when unloading).
+                * For some plugins memory allocated is incremental, we should
+                * avoid re-scanning plugins and file bug reports.
+                */
                if ((descriptor = dfunc (i)) == 0) {
                        break;
                }
@@ -639,31 +764,17 @@ void
 PluginManager::au_refresh (bool cache_only)
 {
        DEBUG_TRACE (DEBUG::PluginManager, "AU: refresh\n");
-       if (cache_only && !Config->get_discover_audio_units ()) {
-               return;
-       }
-       delete _au_plugin_info;
-       _au_plugin_info = AUPluginInfo::discover();
 
-       // disable automatic scan in case we crash
+       // disable automatic discovery in case we crash
+       bool discover_at_start = Config->get_discover_audio_units ();
        Config->set_discover_audio_units (false);
        Config->save_state();
 
-       /* note: AU require a CAComponentDescription pointer provided by the OS.
-        * Ardour only caches port and i/o config. It can't just 'scan' without
-        * 'discovering' (like we do for VST).
-        *
-        * So in case discovery fails, we assume the worst: the Description
-        * is broken (malicious plugins) and even a simple 'scan' would always
-        * crash ardour on startup. Hence we disable Auto-Scan on start.
-        *
-        * If the crash happens at any later time (description is available),
-        * Ardour will blacklist the plugin in question -- unless
-        * the crash happens during realtime-run.
-        */
+       delete _au_plugin_info;
+       _au_plugin_info = AUPluginInfo::discover(cache_only && !discover_at_start);
 
-       // successful scan re-enabled automatic discovery
-       Config->set_discover_audio_units (true);
+       // successful scan re-enabled automatic discovery if it was set
+       Config->set_discover_audio_units (discover_at_start);
        Config->save_state();
 }
 
@@ -686,8 +797,7 @@ PluginManager::windows_vst_refresh (bool cache_only)
 static bool windows_vst_filter (const string& str, void * /*arg*/)
 {
        /* Not a dotfile, has a prefix before a period, suffix is "dll" */
-
-       return str[0] != '.' && (str.length() > 4 && str.find (".dll") == (str.length() - 4));
+       return str[0] != '.' && str.length() > 4 && strings_equal_ignore_case (".dll", str.substr(str.length() - 4));
 }
 
 int
@@ -697,7 +807,11 @@ PluginManager::windows_vst_discover_from_path (string path, bool cache_only)
        vector<string>::iterator x;
        int ret = 0;
 
-       DEBUG_TRACE (DEBUG::PluginManager, string_compose ("detecting Windows VST plugins along %1\n", path));
+       DEBUG_TRACE (DEBUG::PluginManager, string_compose ("Discovering Windows VST plugins along %1\n", path));
+
+       if (Config->get_verbose_plugin_scan()) {
+               info << string_compose (_("--- Windows VST plugins Scan: %1"), path) << endmsg;
+       }
 
        find_files_matching_filter (plugin_objects, Config->get_plugin_path_vst(), windows_vst_filter, 0, false, true, true);
 
@@ -706,20 +820,98 @@ PluginManager::windows_vst_discover_from_path (string path, bool cache_only)
                windows_vst_discover (*x, cache_only || cancelled());
        }
 
+       if (Config->get_verbose_plugin_scan()) {
+               info << _("--- Windows VST plugins Scan Done") << endmsg;
+       }
+
        return ret;
 }
 
+static std::string dll_info (std::string path) {
+       std::string rv;
+       uint8_t buf[68];
+       uint16_t type = 0;
+       off_t pe_hdr_off = 0;
+
+       int fd = g_open(path.c_str(), O_RDONLY, 0444);
+
+       if (fd < 0) {
+               return _("cannot open dll"); // TODO strerror()
+       }
+
+       if (68 != read (fd, buf, 68)) {
+               rv = _("invalid dll, file too small");
+               goto errorout;
+       }
+       if (buf[0] != 'M' && buf[1] != 'Z') {
+               rv = _("not a dll");
+               goto errorout;
+       }
+
+       pe_hdr_off = *((int32_t*) &buf[60]);
+       if (pe_hdr_off !=lseek (fd, pe_hdr_off, SEEK_SET)) {
+               rv = _("cannot determine dll type");
+               goto errorout;
+       }
+       if (6 != read (fd, buf, 6)) {
+               rv = _("cannot read dll PE header");
+               goto errorout;
+       }
+
+       if (buf[0] != 'P' && buf[1] != 'E') {
+               rv = _("invalid dll PE header");
+               goto errorout;
+       }
+
+       type = *((uint16_t*) &buf[4]);
+       switch (type) {
+               case 0x014c:
+                       rv = _("i386 (32-bit)");
+                       break;
+               case  0x0200:
+                       rv = _("Itanium");
+                       break;
+               case 0x8664:
+                       rv = _("x64 (64-bit)");
+                       break;
+               case 0:
+                       rv = _("Native Architecture");
+                       break;
+               default:
+                       rv = _("Unknown Architecture");
+                       break;
+       }
+errorout:
+       assert (rv.length() > 0);
+       close (fd);
+       return rv;
+}
+
 int
 PluginManager::windows_vst_discover (string path, bool cache_only)
 {
        DEBUG_TRACE (DEBUG::PluginManager, string_compose ("windows_vst_discover '%1'\n", path));
 
+       if (Config->get_verbose_plugin_scan()) {
+               if (cache_only) {
+                       info << string_compose (_(" *  %1 (cache only)"), path) << endmsg;
+               } else {
+                       info << string_compose (_(" *  %1 - %2"), path, dll_info (path)) << endmsg;
+               }
+       }
+
        _cancel_timeout = false;
        vector<VSTInfo*> * finfos = vstfx_get_info_fst (const_cast<char *> (path.c_str()),
                        cache_only ? VST_SCAN_CACHE_ONLY : VST_SCAN_USE_APP);
 
+       // TODO  get extended error messae from vstfx_get_info_fst() e.g  blacklisted, 32/64bit compat,
+       // .err file scanner output etc.
+
        if (finfos->empty()) {
                DEBUG_TRACE (DEBUG::PluginManager, string_compose ("Cannot get Windows VST information from '%1'\n", path));
+               if (Config->get_verbose_plugin_scan()) {
+                       info << _(" -> Cannot get Windows VST information, plugin ignored.") << endmsg;
+               }
                return -1;
        }
 
@@ -729,7 +921,7 @@ PluginManager::windows_vst_discover (string path, bool cache_only)
                char buf[32];
 
                if (!finfo->canProcessReplacing) {
-                       warning << string_compose (_("VST plugin %1 does not support processReplacing, and so cannot be used in %2 at this time"),
+                       warning << string_compose (_("VST plugin %1 does not support processReplacing, and cannot be used in %2 at this time"),
                                                         finfo->name, PROGRAM_NAME)
                                << endl;
                        continue;
@@ -763,8 +955,8 @@ PluginManager::windows_vst_discover (string path, bool cache_only)
 
                if (!_windows_vst_plugin_info->empty()) {
                        for (PluginInfoList::iterator i =_windows_vst_plugin_info->begin(); i != _windows_vst_plugin_info->end(); ++i) {
-                               if ((info->type == (*i)->type)&&(info->unique_id == (*i)->unique_id)) {
-                                       warning << "Ignoring duplicate Windows VST plugin " << info->name << "\n";
+                               if ((info->type == (*i)->type) && (info->unique_id == (*i)->unique_id)) {
+                                       warning << string_compose (_("Ignoring duplicate Windows VST plugin \"%1\""), info->name) << endmsg;
                                        duplicate = true;
                                        break;
                                }
@@ -775,6 +967,9 @@ PluginManager::windows_vst_discover (string path, bool cache_only)
                        DEBUG_TRACE (DEBUG::PluginManager, string_compose ("Windows VST plugin ID '%1'\n", info->unique_id));
                        _windows_vst_plugin_info->push_back (info);
                        discovered++;
+                       if (Config->get_verbose_plugin_scan()) {
+                               PBD::info << string_compose (_(" -> OK (VST Plugin \"%1\" was added)."), info->name) << endmsg;
+                       }
                }
        }
 
@@ -922,14 +1117,8 @@ PluginManager::get_status (const PluginInfoPtr& pi)
 void
 PluginManager::save_statuses ()
 {
-       ofstream ofs;
        std::string path = Glib::build_filename (user_config_directory(), "plugin_statuses");
-
-       ofs.open (path.c_str(), ios_base::openmode (ios::out|ios::trunc));
-
-       if (!ofs) {
-               return;
-       }
+       stringstream ofs;
 
        for (PluginStatusList::iterator i = statuses.begin(); i != statuses.end(); ++i) {
                switch ((*i).type) {
@@ -948,6 +1137,9 @@ PluginManager::save_statuses ()
                case LXVST:
                        ofs << "LXVST";
                        break;
+               case Lua:
+                       ofs << "Lua";
+                       break;
                }
 
                ofs << ' ';
@@ -968,19 +1160,20 @@ PluginManager::save_statuses ()
                ofs << (*i).unique_id;;
                ofs << endl;
        }
-
-       ofs.close ();
+       g_file_set_contents (path.c_str(), ofs.str().c_str(), -1, NULL);
+       PluginStatusesChanged (); /* EMIT SIGNAL */
 }
 
 void
 PluginManager::load_statuses ()
 {
        std::string path = Glib::build_filename (user_config_directory(), "plugin_statuses");
-       ifstream ifs (path.c_str());
-
-       if (!ifs) {
+       gchar *fbuf = NULL;
+       if (!g_file_get_contents (path.c_str(), &fbuf, NULL, NULL))  {
                return;
        }
+       stringstream ifs (fbuf);
+       g_free (fbuf);
 
        std::string stype;
        std::string sstatus;
@@ -1033,6 +1226,8 @@ PluginManager::load_statuses ()
                        type = Windows_VST;
                } else if (stype == "LXVST") {
                        type = LXVST;
+               } else if (stype == "Lua") {
+                       type = Lua;
                } else {
                        error << string_compose (_("unknown plugin type \"%1\" - ignored"), stype)
                              << endmsg;
@@ -1043,8 +1238,6 @@ PluginManager::load_statuses ()
                strip_whitespace_edges (id);
                set_status (type, id, status);
        }
-
-       ifs.close ();
 }
 
 void
@@ -1112,3 +1305,10 @@ PluginManager::au_plugin_info ()
 #endif
        return _empty_plugin_info;
 }
+
+ARDOUR::PluginInfoList&
+PluginManager::lua_plugin_info ()
+{
+       assert(_lua_plugin_info);
+       return *_lua_plugin_info;
+}