+/*
+ 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/file_utils.h>
#include <pbd/error.h>
-#include <pbd/pathscanner.h>
-#include <ardour/control_protocol.h>
+#include <control_protocol/control_protocol.h>
+
+#include <ardour/session.h>
#include <ardour/control_protocol_manager.h>
+#include <ardour/control_protocol_search_path.h>
using namespace ARDOUR;
-using namespace PBD;
using namespace std;
+using namespace PBD;
#include "i18n.h"
ControlProtocolManager* ControlProtocolManager::_instance = 0;
+const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
ControlProtocolManager::ControlProtocolManager ()
{
if (_instance == 0) {
_instance = this;
}
+
+ _session = 0;
}
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);
}
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
-ControlProtocolManager::startup (Session& s)
+ControlProtocolManager::set_session (Session& s)
{
- list<ControlProtocolInfo *>::iterator i;
-
- for (i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
+ _session = &s;
+ _session->GoingAway.connect (mem_fun (*this, &ControlProtocolManager::drop_session));
- ControlProtocolInfo* cpi = (*i);
+ 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 (cpi->name == "Tranzport") {
-
- cpi->descriptor = get_descriptor ((*i)->path);
-
- if (cpi->descriptor == 0) {
- error << string_compose (_("control protocol name \"%1\" has no descriptor"), cpi->name) << endmsg;
- continue;
- }
-
- if ((cpi->protocol = cpi->descriptor->initialize (cpi->descriptor, &s)) == 0) {
- error << string_compose (_("control protocol name \"%1\" could not be initialized"), cpi->name) << endmsg;
- continue;
- }
-
- {
- LockMonitor lm (protocols_lock, __LINE__, __FILE__);
- control_protocols.push_back (cpi->protocol);
+ if ((*i)->protocol && (*i)->state) {
+ (*i)->protocol->set_state (*(*i)->state);
}
-
- cpi->protocol->init ();
- cpi->protocol->set_active (true);
}
}
}
-ControlProtocol*
-ControlProtocolManager::instantiate (Session& session, string name)
+void
+ControlProtocolManager::drop_session ()
{
- list<ControlProtocolInfo *>::iterator i;
+ _session = 0;
- for (i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
- if ((*i)->name == name) {
- break;
+ {
+ 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) {
+ // otherwise the ControlProtocol instances are not recreated in set_session
+ if ((*p)->protocol) {
+ (*p)->requested = true;
+ (*p)->protocol = 0;
+ }
}
}
+}
- if (i == control_protocol_info.end()) {
- error << string_compose (_("control protocol name \"%1\" is unknown"), name) << endmsg;
+ControlProtocol*
+ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
+{
+ if (_session == 0) {
return 0;
}
- ControlProtocolInfo* cpi = (*i);
+ cpi.descriptor = get_descriptor (cpi.path);
- cpi->descriptor = get_descriptor ((*i)->path);
-
- if (cpi->descriptor == 0) {
- error << string_compose (_("control protocol name \"%1\" has no descriptor"), name) << endmsg;
+ if (cpi.descriptor == 0) {
+ error << string_compose (_("control protocol name \"%1\" has no descriptor"), cpi.name) << endmsg;
return 0;
}
- if ((cpi->protocol = cpi->descriptor->initialize (cpi->descriptor, &session)) == 0) {
- error << string_compose (_("control protocol name \"%1\" could not be initialized"), name) << endmsg;
+ if ((cpi.protocol = cpi.descriptor->initialize (cpi.descriptor, _session)) == 0) {
+ error << string_compose (_("control protocol name \"%1\" could not be initialized"), cpi.name) << endmsg;
return 0;
}
- LockMonitor lm (protocols_lock, __LINE__, __FILE__);
- control_protocols.push_back (cpi->protocol);
- return cpi->protocol;
+ Glib::Mutex::Lock lm (protocols_lock);
+ control_protocols.push_back (cpi.protocol);
+
+ return cpi.protocol;
}
int
-ControlProtocolManager::teardown (string name)
+ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
{
- for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
- ControlProtocolInfo* cpi = *i;
+ if (!cpi.protocol) {
+ return 0;
+ }
- if (cpi->name == name && cpi->descriptor && cpi->protocol) {
- cpi->descriptor->destroy (cpi->descriptor, cpi->protocol);
-
- {
- LockMonitor lm (protocols_lock, __LINE__, __FILE__);
- list<ControlProtocol*>::iterator p = find (control_protocols.begin(), control_protocols.end(), cpi->protocol);
- if (p != control_protocols.end()) {
- control_protocols.erase (p);
- }
- }
+ if (!cpi.descriptor) {
+ return 0;
+ }
- cpi->protocol = 0;
- return 0;
- }
+ if (cpi.mandatory) {
+ return 0;
}
- return -1;
+ 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)
+void
+ControlProtocolManager::load_mandatory_protocols ()
{
- /* Not a dotfile, has a prefix before a period, suffix is "so" */
-
- return str[0] != '.' && (str.length() > 3 && str.find (".so") == (str.length() - 3));
+ 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)
+ControlProtocolManager::discover_control_protocols ()
{
- vector<string *> *found;
- PathScanner scanner;
+ vector<sys::path> cp_modules;
- cerr << "CP Manager looking for surfaces\n";
+ 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) {
- cerr << "CP Manager looking at " << **i << endl;
- 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
if ((descriptor = get_descriptor (path)) != 0) {
- ControlProtocolInfo* info = new ControlProtocolInfo ();
+ ControlProtocolInfo* cpi = new ControlProtocolInfo ();
- info->descriptor = descriptor;
- info->name = descriptor->name;
- info->path = path;
-
- control_protocol_info.push_back (info);
+ if (!descriptor->probe (descriptor)) {
+ info << string_compose (_("Control protocol %1 not usable"), descriptor->name) << endmsg;
+ } else {
- cerr << "Found \"" << info->name << "\"\n";
+ 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);
-
- } else {
- cerr << "no descriptor\n";
}
return 0;
return descriptor;
}
+
+void
+ControlProtocolManager::foreach_known_protocol (sigc::slot<void,const ControlProtocolInfo*> method)
+{
+ for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
+ method (*i);
+ }
+}
+
+ControlProtocolInfo*
+ControlProtocolManager::cpi_by_name (string name)
+{
+ for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
+ if (name == (*i)->name) {
+ return *i;
+ }
+ }
+ return 0;
+}
+
+int
+ControlProtocolManager::set_state (const XMLNode& node)
+{
+ XMLNodeList clist;
+ XMLNodeConstIterator citer;
+ XMLProperty* prop;
+
+ clist = node.children();
+
+ 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 {
+ cpi->requested = true;
+ }
+ }
+ }
+ }
+ }
+ }
+ return 0;
+}
+
+XMLNode&
+ControlProtocolManager::get_state (void)
+{
+ XMLNode* root = new XMLNode (state_node_name);
+ Glib::Mutex::Lock lm (protocols_lock);
+
+ for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
+
+ 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);
+ }
+}
projects / ardour.git / blobdiff