Merge branch 'windows+cc' into cairocanvas
[ardour.git] / libs / ardour / control_protocol_manager.cc
index 8611447a93592a33397fdda846e1ced9e5397ff2..d9cefb44f27eec403f08838b19e405babe2c4cdc 100644 (file)
@@ -17,7 +17,7 @@
 
 */
 
-#include <dlfcn.h>
+#include <glibmm/module.h>
 
 #include <glibmm/fileutils.h>
 
 
 #include "ardour/debug.h"
 #include "ardour/control_protocol_manager.h"
+
 #include "ardour/control_protocol_search_path.h"
 
+
 using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
@@ -72,25 +74,54 @@ ControlProtocolManager::set_session (Session* s)
 
                for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
                        if ((*i)->requested || (*i)->mandatory) {
-                               instantiate (**i);
-                               (*i)->requested = false;
-
-                               if ((*i)->protocol) {
-                                       if ((*i)->state) {
-                                               (*i)->protocol->set_state (*(*i)->state, Stateful::loading_state_version);
-                                       } else {
-                                               /* guarantee a call to
-                                                  set_state() whether we have
-                                                  existing state or not
-                                               */
-                                               (*i)->protocol->set_state (XMLNode(""), Stateful::loading_state_version);
-                                       }
-                               }
+                               (void) activate (**i);
                        }
                }
        }
 }
 
+int
+ControlProtocolManager::activate (ControlProtocolInfo& cpi)
+{
+       ControlProtocol* cp;
+
+       cpi.requested = true;
+
+       if ((cp = instantiate (cpi)) == 0) {
+               return -1;
+       }
+
+       /* we split the set_state() and set_active() operations so that
+          protocols that need state to configure themselves (e.g. "What device
+          is connected, or supposed to be connected?") can get it before
+          actually starting any interaction.
+       */
+
+       if (cpi.state) {
+               /* force this by tweaking the internals of the state
+                * XMLNode. Ugh.
+                */
+               cp->set_state (*cpi.state, Stateful::loading_state_version);
+       } else {
+               /* guarantee a call to
+                  set_state() whether we have
+                  existing state or not
+               */
+               cp->set_state (XMLNode(""), Stateful::loading_state_version);
+       }
+
+       cp->set_active (true);
+
+       return 0;
+}      
+
+int
+ControlProtocolManager::deactivate (ControlProtocolInfo& cpi)
+{
+       cpi.requested = false;
+       return teardown (cpi);
+}
+
 void
 ControlProtocolManager::session_going_away()
 {
@@ -127,11 +158,15 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
 
        cpi.descriptor = get_descriptor (cpi.path);
 
+       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;
                return 0;
        }
 
+       DEBUG_TRACE (DEBUG::ControlProtocols, string_compose ("initializing %1\n", cpi.name));
+
        if ((cpi.protocol = cpi.descriptor->initialize (cpi.descriptor, _session)) == 0) {
                error << string_compose (_("control protocol name \"%1\" could not be initialized"), cpi.name) << endmsg;
                return 0;
@@ -139,6 +174,8 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
 
        control_protocols.push_back (cpi.protocol);
 
+       ProtocolStatusChange (&cpi);
+
        return cpi.protocol;
 }
 
@@ -156,6 +193,12 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        if (cpi.mandatory) {
                return 0;
        }
+       
+       /* save current state */
+
+       delete cpi.state;
+       cpi.state = new XMLNode (cpi.protocol->get_state());
+       cpi.state->add_property (X_("active"), "no");
 
        cpi.descriptor->destroy (cpi.descriptor, cpi.protocol);
 
@@ -172,7 +215,10 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        cpi.protocol = 0;
        delete cpi.state;
        cpi.state = 0;
-       dlclose (cpi.descriptor->module);
+       delete (Glib::Module*)cpi.descriptor->module;
+
+       ProtocolStatusChange (&cpi);
+
        return 0;
 }
 
@@ -251,10 +297,10 @@ ControlProtocolManager::control_protocol_discover (string path)
                        control_protocol_info.push_back (cpi);
 
                        DEBUG_TRACE (DEBUG::ControlProtocols, 
-                                    string_compose(_("Control surface protocol discovered: \"%1\""), cpi->name));
+                                    string_compose(_("Control surface protocol discovered: \"%1\"\n"), cpi->name));
                }
 
-               dlclose (descriptor->module);
+               delete (Glib::Module*)descriptor->module;
        }
 
        return 0;
@@ -263,31 +309,31 @@ 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;
+               descriptor->module = (void*)module;
        } else {
-               dlclose (module);
+               delete module;
        }
 
        return descriptor;
@@ -326,30 +372,38 @@ ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
        for (citer = clist.begin(); citer != clist.end(); ++citer) {
                if ((*citer)->name() == X_("Protocol")) {
 
-                       prop = (*citer)->property (X_("active"));
-
-                       if (prop && string_is_affirmative (prop->value())) {
-                               if ((prop = (*citer)->property (X_("name"))) != 0) {
-                                       ControlProtocolInfo* cpi = cpi_by_name (prop->value());
-
-                                       if (cpi) {
-
-                                               if (cpi->state) {
-                                                       delete cpi->state;
-                                               }
+                       if ((prop = (*citer)->property (X_("active"))) == 0) {
+                               continue;
+                       }
 
-                                               cpi->state = new XMLNode (**citer);
+                       bool active = string_is_affirmative (prop->value());
+                       
+                       if ((prop = (*citer)->property (X_("name"))) == 0) {
+                               continue;
+                       }
 
-                                               if (_session) {
-                                                       instantiate (*cpi);
-                                               } else {
-                                                       cpi->requested = true;
-                                               }
+                       ControlProtocolInfo* cpi = cpi_by_name (prop->value());
+                       
+                       if (cpi) {
+                               cpi->state = new XMLNode (**citer);
+                               
+                               if (active) {
+                                       if (_session) {
+                                               instantiate (*cpi);
+                                       } else {
+                                               cpi->requested = true;
+                                       }
+                               } else {
+                                       if (_session) {
+                                               teardown (*cpi);
+                                       } else {
+                                               cpi->requested = false;
                                        }
                                }
                        }
                }
        }
+
        return 0;
 }
 
@@ -361,57 +415,26 @@ ControlProtocolManager::get_state ()
 
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
 
-               XMLNode * child;
-
                if ((*i)->protocol) {
-                       child = &((*i)->protocol->get_state());
-                       child->add_property (X_("active"), "yes");
-                       // should we update (*i)->state here?  probably.
-                       root->add_child_nocopy (*child);
+                       XMLNode& child_state ((*i)->protocol->get_state());
+                       child_state.add_property (X_("active"), "yes");
+                       root->add_child_nocopy (child_state);
                } else if ((*i)->state) {
-                       // keep ownership clear
-                       root->add_child_copy (*(*i)->state);
+                       XMLNode* child_state = new XMLNode (*(*i)->state);
+                       child_state->add_property (X_("active"), "no");
+                       root->add_child_nocopy (*child_state);
                } else {
-                       child = new XMLNode (X_("Protocol"));
-                       child->add_property (X_("name"), (*i)->name);
-                       child->add_property (X_("active"), "no");
-                       root->add_child_nocopy (*child);
+                       XMLNode* child_state = new XMLNode (X_("Protocol"));
+                       child_state->add_property (X_("name"), (*i)->name);
+                       child_state->add_property (X_("active"), "no");
+                       root->add_child_nocopy (*child_state);
                }
+
        }
 
        return *root;
 }
 
-void
-ControlProtocolManager::set_protocol_states (const XMLNode& node)
-{
-       XMLNodeList nlist;
-       XMLNodeConstIterator niter;
-       XMLProperty* prop;
-
-       nlist = node.children();
-
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-
-               XMLNode* child = (*niter);
-
-               if ((prop = child->property ("name")) == 0) {
-                       error << _("control protocol XML node has no name property. Ignored.") << endmsg;
-                       continue;
-               }
-
-               ControlProtocolInfo* cpi = cpi_by_name (prop->value());
-
-               if (!cpi) {
-                       warning << string_compose (_("control protocol \"%1\" is not known. Ignored"), prop->value()) << endmsg;
-                       continue;
-               }
-
-               /* copy the node so that ownership is clear */
-
-               cpi->state = new XMLNode (*child);
-       }
-}
 
 ControlProtocolManager&
 ControlProtocolManager::instance ()