fix crash when copy'ing latent plugins

[ardour.git] / libs / ardour / control_protocol_manager.cc

diff --git a/libs/ardour/control_protocol_manager.cc b/libs/ardour/control_protocol_manager.cc
index 376152c139e6b80a9daefd7a413431718fd3e7e9..a0a36c17dd2150480e4262d4caea12dd51a8fa14 100644 (file)
--- a/libs/ardour/control_protocol_manager.cc
+++ b/libs/ardour/control_protocol_manager.cc
@@ -22,6 +22,7 @@
 #include <glibmm/fileutils.h>
 
 #include "pbd/compose.h"
+#include "pbd/event_loop.h"
 #include "pbd/file_utils.h"
 #include "pbd/error.h"
 
@@ -37,11 +38,27 @@ using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 ControlProtocolManager* ControlProtocolManager::_instance = 0;
 const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
 
+
+ControlProtocolInfo::~ControlProtocolInfo ()
+{
+       if (protocol && descriptor) {
+               descriptor->destroy (descriptor, protocol);
+               protocol = 0;
+       }
+
+       delete state; state = 0;
+
+       if (descriptor) {
+               delete (Glib::Module*) descriptor->module;
+               descriptor = 0;
+       }
+}
+
 ControlProtocolManager::ControlProtocolManager ()
 {
 }
@@ -113,7 +130,7 @@ ControlProtocolManager::activate (ControlProtocolInfo& cpi)
        cp->set_active (true);
 
        return 0;
-}      
+}
 
 int
 ControlProtocolManager::deactivate (ControlProtocolInfo& cpi)
@@ -137,15 +154,15 @@ ControlProtocolManager::drop_protocols ()
        /* called explicitly by Session::destroy() so that we can clean up
         * before the process cycle stops and ports vanish.
         */
-       
+
        Glib::Threads::Mutex::Lock lm (protocols_lock);
-       
+
        for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
                delete *p;
        }
-       
+
        control_protocols.clear ();
-       
+
        for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
                // mark existing protocols as requested
                // otherwise the ControlProtocol instances are not recreated in set_session
@@ -154,7 +171,7 @@ ControlProtocolManager::drop_protocols ()
                        (*p)->protocol = 0;
                }
        }
-}      
+}
 
 ControlProtocol*
 ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
@@ -167,7 +184,7 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
 
        cpi.descriptor = get_descriptor (cpi.path);
 
-       DEBUG_TRACE (DEBUG::ControlProtocols, string_compose ("instantiating %1\n", cpi.name));
+       DEBUG_TRACE (DEBUG::ControlProtocols, string_compose ("instantiating %1\n", cpi.name));
 
        if (cpi.descriptor == 0) {
                error << string_compose (_("control protocol name \"%1\" has no descriptor"), cpi.name) << endmsg;
@@ -192,6 +209,18 @@ int
 ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
 {
        if (!cpi.protocol) {
+
+               /* we could still have a descriptor even if the protocol was
+                  never instantiated. Close the associated module (shared
+                  object/DLL) and make sure we forget about it.
+               */
+
+               if (cpi.descriptor) {
+                       cerr << "Closing descriptor for CPI anyway\n";
+                       delete (Glib::Module*) cpi.descriptor->module;
+                       cpi.descriptor = 0;
+               }
+
                return 0;
        }
 
@@ -202,7 +231,7 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        if (cpi.mandatory) {
                return 0;
        }
-       
+
        /* save current state */
 
        delete cpi.state;
@@ -222,9 +251,15 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        }
 
        cpi.protocol = 0;
+
        delete cpi.state;
        cpi.state = 0;
-       delete (Glib::Module*)cpi.descriptor->module;
+       delete (Glib::Module*) cpi.descriptor->module;
+       /* cpi->descriptor is now inaccessible since dlclose() or equivalent
+        * has been performed, and the descriptor is (or could be) a static
+        * object made accessible by dlopen().
+        */
+       cpi.descriptor = 0;
 
        ProtocolStatusChange (&cpi);
 
@@ -286,9 +321,9 @@ ControlProtocolManager::discover_control_protocols ()
        find_files_matching_pattern (cp_modules, control_protocol_search_path (),
                                     dylib_extension_pattern);
 
-       DEBUG_TRACE (DEBUG::ControlProtocols, 
+       DEBUG_TRACE (DEBUG::ControlProtocols,
                     string_compose (_("looking for control protocols in %1\n"), control_protocol_search_path().to_string()));
-       
+
        for (vector<std::string>::iterator i = cp_modules.begin(); i != cp_modules.end(); ++i) {
                control_protocol_discover (*i);
        }
@@ -328,11 +363,9 @@ ControlProtocolManager::control_protocol_discover (string path)
 
                        control_protocol_info.push_back (cpi);
 
-                       DEBUG_TRACE (DEBUG::ControlProtocols, 
+                       DEBUG_TRACE (DEBUG::ControlProtocols,
                                     string_compose(_("Control surface protocol discovered: \"%1\"\n"), cpi->name));
                }
-
-               delete (Glib::Module*)descriptor->module;
        }
 
        return 0;
@@ -364,8 +397,6 @@ ControlProtocolManager::get_descriptor (string path)
 
        if (descriptor) {
                descriptor->module = (void*)module;
-       } else {
-               delete module;
        }
 
        return descriptor;
@@ -395,30 +426,33 @@ ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
 {
        XMLNodeList clist;
        XMLNodeConstIterator citer;
-       XMLProperty* prop;
+       XMLProperty const * prop;
 
        Glib::Threads::Mutex::Lock lm (protocols_lock);
 
        clist = node.children();
 
        for (citer = clist.begin(); citer != clist.end(); ++citer) {
-               if ((*citer)->name() == X_("Protocol")) {
+               XMLNode const * child = *citer;
 
-                       if ((prop = (*citer)->property (X_("active"))) == 0) {
+               if (child->name() == X_("Protocol")) {
+
+                       if ((prop = child->property (X_("active"))) == 0) {
                                continue;
                        }
 
                        bool active = string_is_affirmative (prop->value());
-                       
-                       if ((prop = (*citer)->property (X_("name"))) == 0) {
+
+                       if ((prop = child->property (X_("name"))) == 0) {
                                continue;
                        }
 
                        ControlProtocolInfo* cpi = cpi_by_name (prop->value());
-                       
+
                        if (cpi) {
+                               delete cpi->state;
                                cpi->state = new XMLNode (**citer);
-                               
+
                                if (active) {
                                        if (_session) {
                                                instantiate (*cpi);
@@ -487,3 +521,21 @@ ControlProtocolManager::midi_connectivity_established ()
                (*p)->midi_connectivity_established ();
        }
 }
+
+void
+ControlProtocolManager::register_request_buffer_factories ()
+{
+       Glib::Threads::Mutex::Lock lm (protocols_lock);
+
+       for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
+
+               if ((*i)->descriptor == 0) {
+                       warning << string_compose (_("Control protocol \"%1\" has no descriptor"), (*i)->name) << endmsg;
+                       continue;
+               }
+
+               if ((*i)->descriptor->request_buffer_factory) {
+                       EventLoop::register_request_buffer_factory ((*i)->descriptor->name, (*i)->descriptor->request_buffer_factory);
+               }
+       }
+}