Add comment and fix type.
[ardour.git] / libs / ardour / control_protocol_manager.cc
index 00c05b280039fef867b74767bd9f1700f65ebee1..6a8dd77d55c21a890c14f912c06640bba2c37599 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2007 Paul Davis 
+    Copyright (C) 2000-2007 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include <dlfcn.h>
 
-#include <pbd/compose.h>
-#include <pbd/error.h>
-#include <pbd/pathscanner.h>
+#include "pbd/compose.h"
+#include "pbd/file_utils.h"
+#include "pbd/error.h"
 
-#include <control_protocol/control_protocol.h>
+#include "control_protocol/control_protocol.h"
 
-#include <ardour/session.h>
-#include <ardour/control_protocol_manager.h>
+#include "ardour/debug.h"
+#include "ardour/session.h"
+#include "ardour/control_protocol_manager.h"
+#include "ardour/control_protocol_search_path.h"
 
 using namespace ARDOUR;
 using namespace std;
@@ -39,11 +41,7 @@ const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
 
 ControlProtocolManager::ControlProtocolManager ()
 {
-       if (_instance == 0) {
-               _instance = this;
-       }
 
-       _session = 0;
 }
 
 ControlProtocolManager::~ControlProtocolManager()
@@ -56,7 +54,7 @@ ControlProtocolManager::~ControlProtocolManager()
 
        control_protocols.clear ();
 
-       
+
        for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
                delete (*p);
        }
@@ -65,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);
+
+               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);
+                               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;
@@ -107,6 +111,8 @@ ControlProtocolManager::drop_session ()
 ControlProtocol*
 ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
 {
+       /* CALLER MUST HOLD LOCK */
+
        if (_session == 0) {
                return 0;
        }
@@ -123,7 +129,6 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
                return 0;
        }
 
-       Glib::Mutex::Lock lm (protocols_lock);
        control_protocols.push_back (cpi.protocol);
 
        return cpi.protocol;
@@ -145,7 +150,7 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
        }
 
        cpi.descriptor->destroy (cpi.descriptor, cpi.protocol);
-       
+
        {
                Glib::Mutex::Lock lm (protocols_lock);
                list<ControlProtocol*>::iterator p = find (control_protocols.begin(), control_protocols.end(), cpi.protocol);
@@ -154,29 +159,13 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
                } else {
                        cerr << "Programming error: ControlProtocolManager::teardown() called for " << cpi.name << ", but it was not found in control_protocols" << endl;
                }
-
-               list<ControlProtocolInfo*>::iterator p2 = find (control_protocol_info.begin(), control_protocol_info.end(), &cpi);
-               if (p2 != control_protocol_info.end()) {
-                       control_protocol_info.erase (p2);
-               } else {
-                       cerr << "Programming error: ControlProtocolManager::teardown() called for " << cpi.name << ", but it was not found in control_protocol_info" << endl;
-               }
        }
-       
+
        cpi.protocol = 0;
        dlclose (cpi.descriptor->module);
        return 0;
 }
 
-static bool protocol_filter (const string& str, void *arg)
-{
-       /* Not a dotfile, has a prefix before a period, suffix is "so", or "dylib" */
-       
-       return str[0] != '.' 
-         && ((str.length() > 3 && str.find (".so") == (str.length() - 3))
-             || (str.length() > 6 && str.find (".dylib") == (str.length() - 6)));
-}
-
 void
 ControlProtocolManager::load_mandatory_protocols ()
 {
@@ -184,30 +173,37 @@ 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);
                }
        }
 }
 
 void
-ControlProtocolManager::discover_control_protocols (string path)
+ControlProtocolManager::discover_control_protocols ()
 {
-       vector<string *> *found;
-       PathScanner scanner;
+       vector<sys::path> cp_modules;
 
-       info << string_compose (_("looking for control protocols in %1"), path) << endmsg;
+       Glib::PatternSpec so_extension_pattern("*.so");
+       Glib::PatternSpec dylib_extension_pattern("*.dylib");
 
-       found = scanner (path, protocol_filter, 0, false, true);
+       find_matching_files_in_search_path (control_protocol_search_path (),
+                       so_extension_pattern, cp_modules);
 
-       for (vector<string*>::iterator i = found->begin(); i != found->end(); ++i) {
-               control_protocol_discover (**i);
-               delete *i;
-       }
+       find_matching_files_in_search_path (control_protocol_search_path (),
+                       dylib_extension_pattern, cp_modules);
 
-       delete found;
+       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());
+       }
 }
 
 int
@@ -217,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;
@@ -231,10 +228,11 @@ ControlProtocolManager::control_protocol_discover (string path)
                        cpi->mandatory = descriptor->mandatory;
                        cpi->supports_feedback = descriptor->supports_feedback;
                        cpi->state = 0;
-                       
+
                        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);
@@ -277,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);
@@ -296,12 +294,14 @@ ControlProtocolManager::cpi_by_name (string name)
 }
 
 int
-ControlProtocolManager::set_state (const XMLNode& node)
+ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
 {
        XMLNodeList clist;
        XMLNodeConstIterator citer;
        XMLProperty* prop;
 
+       Glib::Mutex::Lock lm (protocols_lock);
+
        clist = node.children();
 
        for (citer = clist.begin(); citer != clist.end(); ++citer) {
@@ -309,7 +309,7 @@ ControlProtocolManager::set_state (const XMLNode& node)
 
                        prop = (*citer)->property (X_("active"));
 
-                       if (prop && prop->value() == X_("yes")) {
+                       if (prop && string_is_affirmative (prop->value())) {
                                if ((prop = (*citer)->property (X_("name"))) != 0) {
                                        ControlProtocolInfo* cpi = cpi_by_name (prop->value());
                                        if (cpi) {
@@ -318,7 +318,7 @@ ControlProtocolManager::set_state (const XMLNode& node)
                                                } else {
                                                        cpi->state = 0;
                                                }
-                                               
+
                                                if (_session) {
                                                        instantiate (*cpi);
                                                } else {
@@ -327,13 +327,13 @@ ControlProtocolManager::set_state (const XMLNode& node)
                                        }
                                }
                        }
-               }    
+               }
        }
        return 0;
 }
 
 XMLNode&
-ControlProtocolManager::get_state (void)
+ControlProtocolManager::get_state ()
 {
        XMLNode* root = new XMLNode (state_node_name);
        Glib::Mutex::Lock lm (protocols_lock);
@@ -347,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");
@@ -393,3 +391,13 @@ ControlProtocolManager::set_protocol_states (const XMLNode& node)
                cpi->state = new XMLNode (*child);
        }
 }
+
+ControlProtocolManager&
+ControlProtocolManager::instance ()
+{
+       if (_instance == 0) {
+               _instance = new ControlProtocolManager ();
+       }
+
+       return *_instance;
+}