Add comment and fix type.

[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 e94829898af15311bc5239ee8c083ca7154268e5..6a8dd77d55c21a890c14f912c06640bba2c37599 100644 (file)
--- a/libs/ardour/control_protocol_manager.cc
+++ b/libs/ardour/control_protocol_manager.cc
@@ -25,6 +25,7 @@
 
 #include "control_protocol/control_protocol.h"
 
+#include "ardour/debug.h"
 #include "ardour/session.h"
 #include "ardour/control_protocol_manager.h"
 #include "ardour/control_protocol_search_path.h"
@@ -39,7 +40,6 @@ ControlProtocolManager* ControlProtocolManager::_instance = 0;
 const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
 
 ControlProtocolManager::ControlProtocolManager ()
-       : _session (0)
 {
 
 }
@@ -63,36 +63,42 @@ ControlProtocolManager::~ControlProtocolManager()
 }
 
 void
-ControlProtocolManager::set_session (Session& s)
+ControlProtocolManager::set_session (Session* s)
 {
-       _session = &s;
-       _session->GoingAway.connect (mem_fun (*this, &ControlProtocolManager::drop_session));
+       SessionHandlePtr::set_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 (_session) {
+               Glib::Mutex::Lock lm (protocols_lock);
 
-                       if ((*i)->protocol && (*i)->state) {
-                               (*i)->protocol->set_state (*(*i)->state, Stateful::loading_state_version);
+               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 && (*i)->state) {
+                                       (*i)->protocol->set_state (*(*i)->state, Stateful::loading_state_version);
+                               }
                        }
                }
        }
 }
 
 void
-ControlProtocolManager::drop_session ()
+ControlProtocolManager::session_going_away()
 {
-       _session = 0;
+       SessionHandlePtr::session_going_away ();
 
        {
                Glib::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
                        if ((*p)->protocol) {
                                (*p)->requested = true;
@@ -105,6 +111,8 @@ ControlProtocolManager::drop_session ()
 ControlProtocol*
 ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
 {
+       /* CALLER MUST HOLD LOCK */
+
        if (_session == 0) {
                return 0;
        }
@@ -121,8 +129,6 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
                return 0;
        }
 
-
-       Glib::Mutex::Lock lm (protocols_lock);
        control_protocols.push_back (cpi.protocol);
 
        return cpi.protocol;
@@ -167,9 +173,12 @@ ControlProtocolManager::load_mandatory_protocols ()
                return;
        }
 
+       Glib::Mutex::Lock lm (protocols_lock);
+
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
                if ((*i)->mandatory && ((*i)->protocol == 0)) {
-                       info << string_compose (_("Instantiating mandatory control protocol %1"), (*i)->name) << endmsg;
+                       DEBUG_TRACE (DEBUG::ControlProtocols,
+                                    string_compose (_("Instantiating mandatory control protocol %1"), (*i)->name));
                        instantiate (**i);
                }
        }
@@ -189,8 +198,9 @@ ControlProtocolManager::discover_control_protocols ()
        find_matching_files_in_search_path (control_protocol_search_path (),
                        dylib_extension_pattern, cp_modules);
 
-       info << string_compose (_("looking for control protocols in %1"), control_protocol_search_path().to_string()) << endmsg;
-
+       DEBUG_TRACE (DEBUG::ControlProtocols, 
+                    string_compose (_("looking for control protocols in %1"), control_protocol_search_path().to_string()));
+       
        for (vector<sys::path>::iterator i = cp_modules.begin(); i != cp_modules.end(); ++i) {
                control_protocol_discover ((*i).to_string());
        }
@@ -203,12 +213,13 @@ ControlProtocolManager::control_protocol_discover (string path)
 
        if ((descriptor = get_descriptor (path)) != 0) {
 
-               ControlProtocolInfo* cpi = new ControlProtocolInfo ();
-
                if (!descriptor->probe (descriptor)) {
-                       info << string_compose (_("Control protocol %1 not usable"), descriptor->name) << endmsg;
+                       DEBUG_TRACE (DEBUG::ControlProtocols,
+                                    string_compose (_("Control protocol %1 not usable"), descriptor->name));
                } else {
 
+                       ControlProtocolInfo* cpi = new ControlProtocolInfo ();
+
                        cpi->descriptor = descriptor;
                        cpi->name = descriptor->name;
                        cpi->path = path;
@@ -220,7 +231,8 @@ ControlProtocolManager::control_protocol_discover (string path)
 
                        control_protocol_info.push_back (cpi);
 
-                       info << string_compose(_("Control surface protocol discovered: \"%1\""), cpi->name) << endmsg;
+                       DEBUG_TRACE (DEBUG::ControlProtocols, 
+                                    string_compose(_("Control surface protocol discovered: \"%1\""), cpi->name));
                }
 
                dlclose (descriptor->module);
@@ -263,7 +275,7 @@ ControlProtocolManager::get_descriptor (string path)
 }
 
 void
-ControlProtocolManager::foreach_known_protocol (sigc::slot<void,const ControlProtocolInfo*> method)
+ControlProtocolManager::foreach_known_protocol (boost::function<void(const ControlProtocolInfo*)> method)
 {
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
                method (*i);
@@ -288,6 +300,8 @@ ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
        XMLNodeConstIterator citer;
        XMLProperty* prop;
 
+       Glib::Mutex::Lock lm (protocols_lock);
+
        clist = node.children();
 
        for (citer = clist.begin(); citer != clist.end(); ++citer) {
@@ -319,7 +333,7 @@ ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
 }
 
 XMLNode&
-ControlProtocolManager::get_state (void)
+ControlProtocolManager::get_state ()
 {
        XMLNode* root = new XMLNode (state_node_name);
        Glib::Mutex::Lock lm (protocols_lock);
@@ -333,12 +347,10 @@ ControlProtocolManager::get_state (void)
                        child->add_property (X_("active"), "yes");
                        // should we update (*i)->state here?  probably.
                        root->add_child_nocopy (*child);
-               }
-               else if ((*i)->state) {
+               } else if ((*i)->state) {
                        // keep ownership clear
                        root->add_child_copy (*(*i)->state);
-               }
-               else {
+               } else {
                        child = new XMLNode (X_("Protocol"));
                        child->add_property (X_("name"), (*i)->name);
                        child->add_property (X_("active"), "no");