new automation state model, sort of working, but not really
[ardour.git] / libs / ardour / control_protocol_manager.cc
index 6f3cb4e457d4e7cadb56bccdc148fc1242e284a1..1ff6c28ef36482af33dc87d5fc2e860b289f4359 100644 (file)
@@ -4,13 +4,14 @@
 #include <pbd/error.h>
 #include <pbd/pathscanner.h>
 
+#include <control_protocol/control_protocol.h>
+
 #include <ardour/session.h>
-#include <ardour/control_protocol.h>
 #include <ardour/control_protocol_manager.h>
 
 using namespace ARDOUR;
-using namespace PBD;
 using namespace std;
+using namespace PBD;
 
 #include "i18n.h"
 
@@ -28,7 +29,7 @@ ControlProtocolManager::ControlProtocolManager ()
 
 ControlProtocolManager::~ControlProtocolManager()
 {
-       LockMonitor lm (protocols_lock, __LINE__, __FILE__);
+       Glib::Mutex::Lock lm (protocols_lock);
 
        for (list<ControlProtocol*>::iterator i = control_protocols.begin(); i != control_protocols.end(); ++i) {
                delete (*i);
@@ -42,12 +43,16 @@ void
 ControlProtocolManager::set_session (Session& s)
 {
        _session = &s;
-       _session->going_away.connect (mem_fun (*this, &ControlProtocolManager::drop_session));
+       _session->GoingAway.connect (mem_fun (*this, &ControlProtocolManager::drop_session));
 
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
-               if ((*i)->requested) {
+               if ((*i)->requested || (*i)->mandatory) {
                        instantiate (**i);
                        (*i)->requested = false;
+
+                       if ((*i)->protocol && (*i)->state) {
+                               (*i)->protocol->set_state (*(*i)->state);
+                       }
                }
        }
 }
@@ -58,7 +63,7 @@ ControlProtocolManager::drop_session ()
        _session = 0;
 
        {
-               LockMonitor lm (protocols_lock, __LINE__, __FILE__);
+               Glib::Mutex::Lock lm (protocols_lock);
                for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
                        delete *p;
                }
@@ -85,9 +90,13 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
                return 0;
        }
 
-       LockMonitor lm (protocols_lock, __LINE__, __FILE__);
+       Glib::Mutex::Lock lm (protocols_lock);
        control_protocols.push_back (cpi.protocol);
 
+       if (cpi.state) {
+               cpi.protocol->set_state (*cpi.state);
+       }
+
        return cpi.protocol;
 }
 
@@ -102,10 +111,14 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
                return 0;
        }
 
+       if (cpi.mandatory) {
+               return 0;
+       }
+
        cpi.descriptor->destroy (cpi.descriptor, cpi.protocol);
        
        {
-               LockMonitor lm (protocols_lock, __LINE__, __FILE__);
+               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);
@@ -124,13 +137,28 @@ static bool protocol_filter (const string& str, void *arg)
        return str[0] != '.' && (str.length() > 3 && str.find (".so") == (str.length() - 3));
 }
 
+void
+ControlProtocolManager::load_mandatory_protocols ()
+{
+       if (_session == 0) {
+               return;
+       }
+
+       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;
+                       instantiate (**i);
+               }
+       }
+}
+
 void
 ControlProtocolManager::discover_control_protocols (string path)
 {
        vector<string *> *found;
        PathScanner scanner;
 
-       cerr << "looking for control protocols in " << path << endl;
+       info << string_compose (_("looking for control protocols in %1"), path) << endmsg;
 
        found = scanner (path, protocol_filter, 0, false, true);
 
@@ -149,20 +177,27 @@ ControlProtocolManager::control_protocol_discover (string path)
 
        if ((descriptor = get_descriptor (path)) != 0) {
 
-               ControlProtocolInfo* info = new ControlProtocolInfo ();
-
-               info->descriptor = descriptor;
-               info->name = descriptor->name;
-               info->path = path;
-               info->protocol = 0;
-               info->requested = false;
-
-               control_protocol_info.push_back (info);
-
-               cerr << "discovered control surface protocol \"" << info->name << '"' << endl;
+               ControlProtocolInfo* cpi = new ControlProtocolInfo ();
+
+               if (!descriptor->probe (descriptor)) {
+                       info << string_compose (_("Control protocol %1 not usable"), descriptor->name) << endmsg;
+               } else {
+
+                       cpi->descriptor = descriptor;
+                       cpi->name = descriptor->name;
+                       cpi->path = 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;
+               }
 
                dlclose (descriptor->module);
-
        }
 
        return 0;
@@ -231,11 +266,20 @@ 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 = (*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 {
@@ -253,7 +297,7 @@ XMLNode&
 ControlProtocolManager::get_state (void)
 {
        XMLNode* root = new XMLNode (state_node_name);
-       LockMonitor lm (protocols_lock, __LINE__, __FILE__);
+       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"));
@@ -264,3 +308,34 @@ ControlProtocolManager::get_state (void)
 
        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);
+       }
+}