2 Copyright (C) 2000-2007 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <pbd/compose.h>
23 #include <pbd/error.h>
24 #include <pbd/pathscanner.h>
26 #include <control_protocol/control_protocol.h>
28 #include <ardour/session.h>
29 #include <ardour/control_protocol_manager.h>
31 using namespace ARDOUR;
37 ControlProtocolManager* ControlProtocolManager::_instance = 0;
38 const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
40 ControlProtocolManager::ControlProtocolManager ()
49 ControlProtocolManager::~ControlProtocolManager()
51 Glib::Mutex::Lock lm (protocols_lock);
53 for (list<ControlProtocol*>::iterator i = control_protocols.begin(); i != control_protocols.end(); ++i) {
57 control_protocols.clear ();
60 for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
64 control_protocol_info.clear();
68 ControlProtocolManager::set_session (Session& s)
71 _session->GoingAway.connect (mem_fun (*this, &ControlProtocolManager::drop_session));
73 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
74 if ((*i)->requested || (*i)->mandatory) {
76 (*i)->requested = false;
78 if ((*i)->protocol && (*i)->state) {
79 (*i)->protocol->set_state (*(*i)->state);
86 ControlProtocolManager::drop_session ()
91 Glib::Mutex::Lock lm (protocols_lock);
92 for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
95 control_protocols.clear ();
97 for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
98 // otherwise the ControlProtocol instances are not recreated in set_session
99 (*p)->requested = true;
105 ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
111 cpi.descriptor = get_descriptor (cpi.path);
113 if (cpi.descriptor == 0) {
114 error << string_compose (_("control protocol name \"%1\" has no descriptor"), cpi.name) << endmsg;
118 if ((cpi.protocol = cpi.descriptor->initialize (cpi.descriptor, _session)) == 0) {
119 error << string_compose (_("control protocol name \"%1\" could not be initialized"), cpi.name) << endmsg;
123 Glib::Mutex::Lock lm (protocols_lock);
124 control_protocols.push_back (cpi.protocol);
130 ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
136 if (!cpi.descriptor) {
144 cpi.descriptor->destroy (cpi.descriptor, cpi.protocol);
147 Glib::Mutex::Lock lm (protocols_lock);
148 list<ControlProtocol*>::iterator p = find (control_protocols.begin(), control_protocols.end(), cpi.protocol);
149 if (p != control_protocols.end()) {
150 control_protocols.erase (p);
152 cerr << "Programming error: ControlProtocolManager::teardown() called for " << cpi.name << ", but it was not found in control_protocols" << endl;
155 list<ControlProtocolInfo*>::iterator p2 = find (control_protocol_info.begin(), control_protocol_info.end(), &cpi);
156 if (p2 != control_protocol_info.end()) {
157 control_protocol_info.erase (p2);
159 cerr << "Programming error: ControlProtocolManager::teardown() called for " << cpi.name << ", but it was not found in control_protocol_info" << endl;
164 dlclose (cpi.descriptor->module);
168 static bool protocol_filter (const string& str, void *arg)
170 /* Not a dotfile, has a prefix before a period, suffix is "so", or "dylib" */
173 && ((str.length() > 3 && str.find (".so") == (str.length() - 3))
174 || (str.length() > 6 && str.find (".dylib") == (str.length() - 6)));
178 ControlProtocolManager::load_mandatory_protocols ()
184 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
185 if ((*i)->mandatory && ((*i)->protocol == 0)) {
186 info << string_compose (_("Instantiating mandatory control protocol %1"), (*i)->name) << endmsg;
193 ControlProtocolManager::discover_control_protocols (string path)
195 vector<string *> *found;
198 info << string_compose (_("looking for control protocols in %1"), path) << endmsg;
200 found = scanner (path, protocol_filter, 0, false, true);
202 for (vector<string*>::iterator i = found->begin(); i != found->end(); ++i) {
203 control_protocol_discover (**i);
211 ControlProtocolManager::control_protocol_discover (string path)
213 ControlProtocolDescriptor* descriptor;
215 if ((descriptor = get_descriptor (path)) != 0) {
217 ControlProtocolInfo* cpi = new ControlProtocolInfo ();
219 if (!descriptor->probe (descriptor)) {
220 info << string_compose (_("Control protocol %1 not usable"), descriptor->name) << endmsg;
223 cpi->descriptor = descriptor;
224 cpi->name = descriptor->name;
227 cpi->requested = false;
228 cpi->mandatory = descriptor->mandatory;
229 cpi->supports_feedback = descriptor->supports_feedback;
232 control_protocol_info.push_back (cpi);
234 info << string_compose(_("Control surface protocol discovered: \"%1\""), cpi->name) << endmsg;
237 dlclose (descriptor->module);
243 ControlProtocolDescriptor*
244 ControlProtocolManager::get_descriptor (string path)
247 ControlProtocolDescriptor *descriptor = 0;
248 ControlProtocolDescriptor* (*dfunc)(void);
251 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
252 error << string_compose(_("ControlProtocolManager: cannot load module \"%1\" (%2)"), path, dlerror()) << endmsg;
257 dfunc = (ControlProtocolDescriptor* (*)(void)) dlsym (module, "protocol_descriptor");
259 if ((errstr = dlerror()) != 0) {
260 error << string_compose(_("ControlProtocolManager: module \"%1\" has no descriptor function."), path) << endmsg;
261 error << errstr << endmsg;
266 descriptor = dfunc();
268 descriptor->module = module;
277 ControlProtocolManager::foreach_known_protocol (sigc::slot<void,const ControlProtocolInfo*> method)
279 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
285 ControlProtocolManager::cpi_by_name (string name)
287 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
288 if (name == (*i)->name) {
296 ControlProtocolManager::set_state (const XMLNode& node)
299 XMLNodeConstIterator citer;
302 clist = node.children();
304 for (citer = clist.begin(); citer != clist.end(); ++citer) {
305 if ((*citer)->name() == X_("Protocol")) {
307 prop = (*citer)->property (X_("active"));
309 if (prop && prop->value() == X_("yes")) {
310 if ((prop = (*citer)->property (X_("name"))) != 0) {
311 ControlProtocolInfo* cpi = cpi_by_name (prop->value());
313 if (!(*citer)->children().empty()) {
314 cpi->state = (*citer)->children().front ();
322 cpi->requested = true;
333 ControlProtocolManager::get_state (void)
335 XMLNode* root = new XMLNode (state_node_name);
336 Glib::Mutex::Lock lm (protocols_lock);
338 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
342 if ((*i)->protocol) {
343 child = &((*i)->protocol->get_state());
344 child->add_property (X_("active"), "yes");
345 // should we update (*i)->state here? probably.
346 root->add_child_nocopy (*child);
348 else if ((*i)->state) {
349 // keep ownership clear
350 root->add_child_copy (*(*i)->state);
353 child = new XMLNode (X_("Protocol"));
354 child->add_property (X_("name"), (*i)->name);
355 child->add_property (X_("active"), "no");
356 root->add_child_nocopy (*child);
364 ControlProtocolManager::set_protocol_states (const XMLNode& node)
367 XMLNodeConstIterator niter;
370 nlist = node.children();
372 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
374 XMLNode* child = (*niter);
376 if ((prop = child->property ("name")) == 0) {
377 error << _("control protocol XML node has no name property. Ignored.") << endmsg;
381 ControlProtocolInfo* cpi = cpi_by_name (prop->value());
384 warning << string_compose (_("control protocol \"%1\" is not known. Ignored"), prop->value()) << endmsg;
388 /* copy the node so that ownership is clear */
390 cpi->state = new XMLNode (*child);