revert inadvertently committed debug settings
[ardour.git] / libs / ardour / control_protocol_manager.cc
index 974258a5c23071f6565da4c71ab12f031e76b95e..2b0a4dce4cd71e5fb8ddb822cdbbbb9d718e35d6 100644 (file)
 
 */
 
-#include <dlfcn.h>
+#include <glibmm/module.h>
 
 #include <glibmm/fileutils.h>
 
 #include "pbd/compose.h"
+#include "pbd/event_loop.h"
 #include "pbd/file_utils.h"
 #include "pbd/error.h"
 
 
 #include "ardour/debug.h"
 #include "ardour/control_protocol_manager.h"
-#include "ardour/control_protocol_search_path.h"
+
+#include "ardour/search_paths.h"
+
 
 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");
@@ -111,7 +114,7 @@ ControlProtocolManager::activate (ControlProtocolInfo& cpi)
        cp->set_active (true);
 
        return 0;
-}      
+}
 
 int
 ControlProtocolManager::deactivate (ControlProtocolInfo& cpi)
@@ -124,23 +127,32 @@ void
 ControlProtocolManager::session_going_away()
 {
        SessionHandlePtr::session_going_away ();
+       /* Session::destroy() will explicitly call drop_protocols() so we don't
+        * have to worry about that here.
+        */
+}
 
-       {
-               Glib::Threads::Mutex::Lock lm (protocols_lock);
+void
+ControlProtocolManager::drop_protocols ()
+{
+       /* called explicitly by Session::destroy() so that we can clean up
+        * before the process cycle stops and ports vanish.
+        */
 
-               for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
-                       delete *p;
-               }
+       Glib::Threads::Mutex::Lock lm (protocols_lock);
 
-               control_protocols.clear ();
+       for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
+               delete *p;
+       }
 
-               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
-                       if ((*p)->protocol) {
-                               (*p)->requested = true;
-                               (*p)->protocol = 0;
-                       }
+       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
+               if ((*p)->protocol) {
+                       (*p)->requested = true;
+                       (*p)->protocol = 0;
                }
        }
 }
@@ -156,7 +168,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;
@@ -181,6 +193,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;
        }
 
@@ -191,7 +215,7 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        if (cpi.mandatory) {
                return 0;
        }
-       
+
        /* save current state */
 
        delete cpi.state;
@@ -211,7 +235,15 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        }
 
        cpi.protocol = 0;
-       dlclose (cpi.descriptor->module);
+
+       delete cpi.state;
+       cpi.state = 0;
+       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);
 
@@ -241,18 +273,41 @@ ControlProtocolManager::discover_control_protocols ()
 {
        vector<std::string> cp_modules;
 
+#ifdef COMPILER_MSVC
+   /**
+    * Different build targets (Debug / Release etc) use different versions
+    * of the 'C' runtime (which can't be 'mixed & matched'). Therefore, in
+    * case the supplied search path contains multiple version(s) of a given
+    * module, only select the one(s) which match the current build target
+    */
+       #if defined (_DEBUG)
+               Glib::PatternSpec dll_extension_pattern("*D.dll");
+       #elif defined (RDC_BUILD)
+               Glib::PatternSpec dll_extension_pattern("*RDC.dll");
+       #elif defined (_WIN64)
+               Glib::PatternSpec dll_extension_pattern("*64.dll");
+       #else
+               Glib::PatternSpec dll_extension_pattern("*32.dll");
+       #endif
+#else
+       Glib::PatternSpec dll_extension_pattern("*.dll");
+#endif
+
        Glib::PatternSpec so_extension_pattern("*.so");
        Glib::PatternSpec dylib_extension_pattern("*.dylib");
 
-       find_matching_files_in_search_path (control_protocol_search_path (),
-                                           so_extension_pattern, cp_modules);
+       find_files_matching_pattern (cp_modules, control_protocol_search_path (),
+                                    dll_extension_pattern);
 
-       find_matching_files_in_search_path (control_protocol_search_path (),
-                                           dylib_extension_pattern, cp_modules);
+       find_files_matching_pattern (cp_modules, control_protocol_search_path (),
+                                    so_extension_pattern);
 
-       DEBUG_TRACE (DEBUG::ControlProtocols, 
+       find_files_matching_pattern (cp_modules, control_protocol_search_path (),
+                                    dylib_extension_pattern);
+
+       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);
        }
@@ -292,11 +347,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));
                }
-
-               dlclose (descriptor->module);
        }
 
        return 0;
@@ -305,31 +358,29 @@ ControlProtocolManager::control_protocol_discover (string path)
 ControlProtocolDescriptor*
 ControlProtocolManager::get_descriptor (string path)
 {
-       void *module;
+       Glib::Module* module = new Glib::Module(path);
        ControlProtocolDescriptor *descriptor = 0;
        ControlProtocolDescriptor* (*dfunc)(void);
-       const char *errstr;
+       void* func = 0;
 
-       if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
-               error << string_compose(_("ControlProtocolManager: cannot load module \"%1\" (%2)"), path, dlerror()) << endmsg;
+       if (!(*module)) {
+               error << string_compose(_("ControlProtocolManager: cannot load module \"%1\" (%2)"), path, Glib::Module::get_last_error()) << endmsg;
+               delete module;
                return 0;
        }
 
-
-       dfunc = (ControlProtocolDescriptor* (*)(void)) dlsym (module, "protocol_descriptor");
-
-       if ((errstr = dlerror()) != 0) {
+       if (!module->get_symbol("protocol_descriptor", func)) {
                error << string_compose(_("ControlProtocolManager: module \"%1\" has no descriptor function."), path) << endmsg;
-               error << errstr << endmsg;
-               dlclose (module);
+               error << Glib::Module::get_last_error() << endmsg;
+               delete module;
                return 0;
        }
 
+       dfunc = (ControlProtocolDescriptor* (*)(void))func;
        descriptor = dfunc();
+
        if (descriptor) {
-               descriptor->module = module;
-       } else {
-               dlclose (module);
+               descriptor->module = (void*)module;
        }
 
        return descriptor;
@@ -359,30 +410,32 @@ 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) {
                                cpi->state = new XMLNode (**citer);
-                               
+
                                if (active) {
                                        if (_session) {
                                                instantiate (*cpi);
@@ -451,3 +504,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);
+               }
+       }
+}