Add option to limit automatable control parmaters
[ardour.git] / libs / ardour / control_protocol_manager.cc
index a0a36c17dd2150480e4262d4caea12dd51a8fa14..048ff3f7d5dac16bc7fca17fbe7ea96dad430610 100644 (file)
@@ -32,7 +32,8 @@
 #include "ardour/control_protocol_manager.h"
 
 #include "ardour/search_paths.h"
-
+#include "ardour/selection.h"
+#include "ardour/session.h"
 
 using namespace ARDOUR;
 using namespace std;
@@ -42,7 +43,7 @@ using namespace PBD;
 
 ControlProtocolManager* ControlProtocolManager::_instance = 0;
 const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
-
+PBD::Signal1<void,StripableNotificationListPtr> ControlProtocolManager::StripableSelectionChanged;
 
 ControlProtocolInfo::~ControlProtocolInfo ()
 {
@@ -65,7 +66,7 @@ ControlProtocolManager::ControlProtocolManager ()
 
 ControlProtocolManager::~ControlProtocolManager()
 {
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::WriterLock lm (protocols_lock);
 
        for (list<ControlProtocol*>::iterator i = control_protocols.begin(); i != control_protocols.end(); ++i) {
                delete (*i);
@@ -75,6 +76,7 @@ ControlProtocolManager::~ControlProtocolManager()
 
 
        for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
+               (*p)->protocol = 0; // protocol was already destroyed above.
                delete (*p);
        }
 
@@ -86,8 +88,12 @@ ControlProtocolManager::set_session (Session* s)
 {
        SessionHandlePtr::set_session (s);
 
-       if (_session) {
-               Glib::Threads::Mutex::Lock lm (protocols_lock);
+       if (!_session) {
+               return;
+       }
+
+       {
+               Glib::Threads::RWLock::ReaderLock lm (protocols_lock);
 
                for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
                        if ((*i)->requested || (*i)->mandatory) {
@@ -95,6 +101,21 @@ ControlProtocolManager::set_session (Session* s)
                        }
                }
        }
+
+       CoreSelection::StripableAutomationControls sac;
+       _session->selection().get_stripables (sac);
+
+       if (!sac.empty()) {
+               StripableNotificationListPtr v (new StripableNotificationList);
+               for (CoreSelection::StripableAutomationControls::iterator i = sac.begin(); i != sac.end(); ++i) {
+                       if ((*i).stripable) {
+                               v->push_back (boost::weak_ptr<Stripable> ((*i).stripable));
+                       }
+               }
+               if (!v->empty()) {
+                       StripableSelectionChanged (v); /* EMIT SIGNAL */
+               }
+       }
 }
 
 int
@@ -127,7 +148,10 @@ ControlProtocolManager::activate (ControlProtocolInfo& cpi)
                cp->set_state (XMLNode(""), Stateful::loading_state_version);
        }
 
-       cp->set_active (true);
+       if (cp->set_active (true)) {
+               error << string_compose (_("Control protocol support for %1 failed to activate"), cpi.name) << endmsg;
+               teardown (cpi, false);
+       }
 
        return 0;
 }
@@ -136,7 +160,7 @@ int
 ControlProtocolManager::deactivate (ControlProtocolInfo& cpi)
 {
        cpi.requested = false;
-       return teardown (cpi);
+       return teardown (cpi, true);
 }
 
 void
@@ -155,7 +179,7 @@ ControlProtocolManager::drop_protocols ()
         * before the process cycle stops and ports vanish.
         */
 
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::WriterLock lm (protocols_lock);
 
        for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
                delete *p;
@@ -169,6 +193,7 @@ ControlProtocolManager::drop_protocols ()
                if ((*p)->protocol) {
                        (*p)->requested = true;
                        (*p)->protocol = 0;
+                       ProtocolStatusChange (*p); /* EMIT SIGNAL */
                }
        }
 }
@@ -206,7 +231,7 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
 }
 
 int
-ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
+ControlProtocolManager::teardown (ControlProtocolInfo& cpi, bool lock_required)
 {
        if (!cpi.protocol) {
 
@@ -236,12 +261,20 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
 
        delete cpi.state;
        cpi.state = new XMLNode (cpi.protocol->get_state());
-       cpi.state->add_property (X_("active"), "no");
+       cpi.state->set_property (X_("active"), false);
 
        cpi.descriptor->destroy (cpi.descriptor, cpi.protocol);
 
-       {
-               Glib::Threads::Mutex::Lock lm (protocols_lock);
+       if (lock_required) {
+               /* the lock is required when the protocol is torn down by a user from the GUI. */
+               Glib::Threads::RWLock::WriterLock 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;
+               }
+       } else {
                list<ControlProtocol*>::iterator p = find (control_protocols.begin(), control_protocols.end(), cpi.protocol);
                if (p != control_protocols.end()) {
                        control_protocols.erase (p);
@@ -252,8 +285,6 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
 
        cpi.protocol = 0;
 
-       delete cpi.state;
-       cpi.state = 0;
        delete (Glib::Module*) cpi.descriptor->module;
        /* cpi->descriptor is now inaccessible since dlclose() or equivalent
         * has been performed, and the descriptor is (or could be) a static
@@ -273,7 +304,7 @@ ControlProtocolManager::load_mandatory_protocols ()
                return;
        }
 
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::ReaderLock lm (protocols_lock);
 
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
                if ((*i)->mandatory && ((*i)->protocol == 0)) {
@@ -346,8 +377,7 @@ ControlProtocolManager::control_protocol_discover (string path)
        if ((descriptor = get_descriptor (path)) != 0) {
 
                if (!descriptor->probe (descriptor)) {
-                       DEBUG_TRACE (DEBUG::ControlProtocols,
-                                    string_compose (_("Control protocol %1 not usable"), descriptor->name));
+                       warning << string_compose (_("Control protocol %1 not usable"), descriptor->name) << endmsg;
                } else {
 
                        ControlProtocolInfo* cpi = new ControlProtocolInfo ();
@@ -422,13 +452,12 @@ ControlProtocolManager::cpi_by_name (string name)
 }
 
 int
-ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
+ControlProtocolManager::set_state (const XMLNode& node, int session_specific_state /* here: not version */)
 {
        XMLNodeList clist;
        XMLNodeConstIterator citer;
-       XMLProperty const * prop;
 
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::WriterLock lm (protocols_lock);
 
        clist = node.children();
 
@@ -437,35 +466,42 @@ ControlProtocolManager::set_state (const XMLNode& node, int /*version*/)
 
                if (child->name() == X_("Protocol")) {
 
-                       if ((prop = child->property (X_("active"))) == 0) {
-                               continue;
-                       }
-
-                       bool active = string_is_affirmative (prop->value());
-
-                       if ((prop = child->property (X_("name"))) == 0) {
+                       bool active;
+                       std::string name;
+                       if (!child->get_property (X_("active"), active) ||
+                           !child->get_property (X_("name"), name)) {
                                continue;
                        }
 
-                       ControlProtocolInfo* cpi = cpi_by_name (prop->value());
+                       ControlProtocolInfo* cpi = cpi_by_name (name);
 
                        if (cpi) {
-                               delete cpi->state;
-                               cpi->state = new XMLNode (**citer);
+#ifndef NDEBUG
+                               std::cerr << "protocol " << name << " active ? " << active << std::endl;
+#endif
 
                                if (active) {
+                                       delete cpi->state;
+                                       cpi->state = new XMLNode (**citer);
+                                       cpi->state->set_property (X_("session-state"), session_specific_state ? true : false);
                                        if (_session) {
                                                instantiate (*cpi);
                                        } else {
                                                cpi->requested = true;
                                        }
                                } else {
+                                       if (!cpi->state) {
+                                               cpi->state = new XMLNode (**citer);
+                                               cpi->state->set_property (X_("active"), false);
+                                               cpi->state->set_property (X_("session-state"), session_specific_state ? true : false);
+                                       }
+                                       cpi->requested = false;
                                        if (_session) {
-                                               teardown (*cpi);
-                                       } else {
-                                               cpi->requested = false;
+                                               teardown (*cpi, false);
                                        }
                                }
+                       } else {
+                               std::cerr << "protocol " << name << " not found\n";
                        }
                }
        }
@@ -477,22 +513,24 @@ XMLNode&
 ControlProtocolManager::get_state ()
 {
        XMLNode* root = new XMLNode (state_node_name);
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::ReaderLock lm (protocols_lock);
 
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
 
                if ((*i)->protocol) {
                        XMLNode& child_state ((*i)->protocol->get_state());
-                       child_state.add_property (X_("active"), "yes");
+                       child_state.set_property (X_("active"), true);
+                       delete ((*i)->state);
+                       (*i)->state = new XMLNode (child_state);
                        root->add_child_nocopy (child_state);
                } else if ((*i)->state) {
                        XMLNode* child_state = new XMLNode (*(*i)->state);
-                       child_state->add_property (X_("active"), "no");
+                       child_state->set_property (X_("active"), false);
                        root->add_child_nocopy (*child_state);
                } else {
                        XMLNode* child_state = new XMLNode (X_("Protocol"));
-                       child_state->add_property (X_("name"), (*i)->name);
-                       child_state->add_property (X_("active"), "no");
+                       child_state->set_property (X_("name"), (*i)->name);
+                       child_state->set_property (X_("active"), false);
                        root->add_child_nocopy (*child_state);
                }
 
@@ -515,7 +553,7 @@ ControlProtocolManager::instance ()
 void
 ControlProtocolManager::midi_connectivity_established ()
 {
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::ReaderLock lm (protocols_lock);
 
        for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
                (*p)->midi_connectivity_established ();
@@ -525,7 +563,7 @@ ControlProtocolManager::midi_connectivity_established ()
 void
 ControlProtocolManager::register_request_buffer_factories ()
 {
-       Glib::Threads::Mutex::Lock lm (protocols_lock);
+       Glib::Threads::RWLock::ReaderLock lm (protocols_lock);
 
        for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
 
@@ -539,3 +577,26 @@ ControlProtocolManager::register_request_buffer_factories ()
                }
        }
 }
+
+void
+ControlProtocolManager::stripable_selection_changed (StripableNotificationListPtr sp)
+{
+       /* this sets up the (static) data structures owned by ControlProtocol
+          that are "shared" across all control protocols.
+       */
+
+       DEBUG_TRACE (DEBUG::Selection, string_compose ("Surface manager: selection changed, now %1 stripables\n", sp ? sp->size() : -1));
+       StripableSelectionChanged (sp); /* EMIT SIGNAL */
+
+       /* now give each protocol the chance to respond to the selection change
+        */
+
+       {
+               Glib::Threads::RWLock::ReaderLock lm (protocols_lock);
+
+               for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
+                       DEBUG_TRACE (DEBUG::Selection, string_compose ("selection change notification for surface \"%1\"\n", (*p)->name()));
+                       (*p)->stripable_selection_changed ();
+               }
+       }
+}