Part 1 of loading 2.X sessions; some things work, some things don't, hacks a-plenty.
[ardour.git] / libs / ardour / control_protocol_manager.cc
index 5c02936ba03acebb72e30c5599ff0092dd3d2519..8546a41e6652cfda426bd1a10c24dcd32f3bcbaa 100644 (file)
@@ -1,13 +1,33 @@
+/*
+    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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
 #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/session.h"
+#include "ardour/control_protocol_manager.h"
+#include "ardour/control_protocol_search_path.h"
 
 using namespace ARDOUR;
 using namespace std;
@@ -19,12 +39,9 @@ ControlProtocolManager* ControlProtocolManager::_instance = 0;
 const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
 
 ControlProtocolManager::ControlProtocolManager ()
+       : _session (0)
 {
-       if (_instance == 0) {
-               _instance = this;
-       }
 
-       _session = 0;
 }
 
 ControlProtocolManager::~ControlProtocolManager()
@@ -36,7 +53,13 @@ ControlProtocolManager::~ControlProtocolManager()
        }
 
        control_protocols.clear ();
-               
+
+
+       for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
+               delete (*p);
+       }
+
+       control_protocol_info.clear();
 }
 
 void
@@ -50,7 +73,7 @@ ControlProtocolManager::set_session (Session& s)
                        instantiate (**i);
                        (*i)->requested = false;
 
-                       if ((*i)->state) {
+                       if ((*i)->protocol && (*i)->state) {
                                (*i)->protocol->set_state (*(*i)->state);
                        }
                }
@@ -68,6 +91,14 @@ ControlProtocolManager::drop_session ()
                        delete *p;
                }
                control_protocols.clear ();
+
+               for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
+                       // otherwise the ControlProtocol instances are not recreated in set_session
+                       if ((*p)->protocol) {
+                               (*p)->requested = true;
+                               (*p)->protocol = 0;
+                       }
+               }
        }
 }
 
@@ -112,27 +143,29 @@ 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);
                if (p != control_protocols.end()) {
                        control_protocols.erase (p);
+               } 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" */
-       
-       return str[0] != '.' && (str.length() > 3 && str.find (".so") == (str.length() - 3));
-}
-
 void
 ControlProtocolManager::load_mandatory_protocols ()
 {
@@ -149,21 +182,24 @@ ControlProtocolManager::load_mandatory_protocols ()
 }
 
 void
-ControlProtocolManager::discover_control_protocols (string path)
+ControlProtocolManager::discover_control_protocols ()
 {
-       vector<string *> *found;
-       PathScanner scanner;
+       vector<sys::path> cp_modules;
 
-       cerr << "looking for control protocols in " << path << endl;
+       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);
+
+       info << string_compose (_("looking for control protocols in %1"), control_protocol_search_path().to_string()) << endmsg;
 
-       delete found;
+       for (vector<sys::path>::iterator i = cp_modules.begin(); i != cp_modules.end(); ++i) {
+               control_protocol_discover ((*i).to_string());
+       }
 }
 
 int
@@ -185,10 +221,11 @@ ControlProtocolManager::control_protocol_discover (string path)
                        cpi->protocol = 0;
                        cpi->requested = false;
                        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;
                }
 
@@ -251,7 +288,7 @@ 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;
@@ -261,11 +298,19 @@ ControlProtocolManager::set_state (const XMLNode& node)
 
        for (citer = clist.begin(); citer != clist.end(); ++citer) {
                if ((*citer)->name() == X_("Protocol")) {
+
                        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) {
+                                               if (!(*citer)->children().empty()) {
+                                                       cpi->state = (*citer)->children().front ();
+                                               } else {
+                                                       cpi->state = 0;
+                                               }
+
                                                if (_session) {
                                                        instantiate (*cpi);
                                                } else {
@@ -274,7 +319,7 @@ ControlProtocolManager::set_state (const XMLNode& node)
                                        }
                                }
                        }
-               }    
+               }
        }
        return 0;
 }
@@ -286,11 +331,67 @@ ControlProtocolManager::get_state (void)
        Glib::Mutex::Lock lm (protocols_lock);
 
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
-               XMLNode* child = new XMLNode (X_("Protocol"));
-               child->add_property (X_("name"), (*i)->name);
-               child->add_property (X_("active"), (*i)->protocol ? "yes" : "no");
-               root->add_child_nocopy (*child);
+
+               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);
+               }
+               else if ((*i)->state) {
+                       // keep ownership clear
+                       root->add_child_copy (*(*i)->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);
+               }
        }
 
        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 ()
+{
+       if (_instance == 0) {
+               _instance = new ControlProtocolManager ();
+       }
+
+       return *_instance;
+}