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/file_utils.h"
24 #include "pbd/error.h"
26 #include "control_protocol/control_protocol.h"
28 #include "ardour/session.h"
29 #include "ardour/control_protocol_manager.h"
30 #include "ardour/control_protocol_search_path.h"
32 using namespace ARDOUR;
38 ControlProtocolManager* ControlProtocolManager::_instance = 0;
39 const string ControlProtocolManager::state_node_name = X_("ControlProtocols");
41 ControlProtocolManager::ControlProtocolManager ()
47 ControlProtocolManager::~ControlProtocolManager()
49 Glib::Mutex::Lock lm (protocols_lock);
51 for (list<ControlProtocol*>::iterator i = control_protocols.begin(); i != control_protocols.end(); ++i) {
55 control_protocols.clear ();
58 for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
62 control_protocol_info.clear();
66 ControlProtocolManager::set_session (Session& s)
69 _session->GoingAway.connect (mem_fun (*this, &ControlProtocolManager::drop_session));
71 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
72 if ((*i)->requested || (*i)->mandatory) {
74 (*i)->requested = false;
76 if ((*i)->protocol && (*i)->state) {
77 (*i)->protocol->set_state (*(*i)->state, Stateful::loading_state_version);
84 ControlProtocolManager::drop_session ()
89 Glib::Mutex::Lock lm (protocols_lock);
90 for (list<ControlProtocol*>::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) {
93 control_protocols.clear ();
95 for (list<ControlProtocolInfo*>::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) {
96 // otherwise the ControlProtocol instances are not recreated in set_session
98 (*p)->requested = true;
106 ControlProtocolManager::instantiate (ControlProtocolInfo& cpi)
112 cpi.descriptor = get_descriptor (cpi.path);
114 if (cpi.descriptor == 0) {
115 error << string_compose (_("control protocol name \"%1\" has no descriptor"), cpi.name) << endmsg;
119 if ((cpi.protocol = cpi.descriptor->initialize (cpi.descriptor, _session)) == 0) {
120 error << string_compose (_("control protocol name \"%1\" could not be initialized"), cpi.name) << endmsg;
124 Glib::Mutex::Lock lm (protocols_lock);
125 control_protocols.push_back (cpi.protocol);
131 ControlProtocolManager::teardown (ControlProtocolInfo& cpi)
137 if (!cpi.descriptor) {
145 cpi.descriptor->destroy (cpi.descriptor, cpi.protocol);
148 Glib::Mutex::Lock lm (protocols_lock);
149 list<ControlProtocol*>::iterator p = find (control_protocols.begin(), control_protocols.end(), cpi.protocol);
150 if (p != control_protocols.end()) {
151 control_protocols.erase (p);
153 cerr << "Programming error: ControlProtocolManager::teardown() called for " << cpi.name << ", but it was not found in control_protocols" << endl;
156 list<ControlProtocolInfo*>::iterator p2 = find (control_protocol_info.begin(), control_protocol_info.end(), &cpi);
157 if (p2 != control_protocol_info.end()) {
158 control_protocol_info.erase (p2);
160 cerr << "Programming error: ControlProtocolManager::teardown() called for " << cpi.name << ", but it was not found in control_protocol_info" << endl;
165 dlclose (cpi.descriptor->module);
170 ControlProtocolManager::load_mandatory_protocols ()
176 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
177 if ((*i)->mandatory && ((*i)->protocol == 0)) {
178 info << string_compose (_("Instantiating mandatory control protocol %1"), (*i)->name) << endmsg;
185 ControlProtocolManager::discover_control_protocols ()
187 vector<sys::path> cp_modules;
189 Glib::PatternSpec so_extension_pattern("*.so");
190 Glib::PatternSpec dylib_extension_pattern("*.dylib");
192 find_matching_files_in_search_path (control_protocol_search_path (),
193 so_extension_pattern, cp_modules);
195 find_matching_files_in_search_path (control_protocol_search_path (),
196 dylib_extension_pattern, cp_modules);
198 info << string_compose (_("looking for control protocols in %1"), control_protocol_search_path().to_string()) << endmsg;
200 for (vector<sys::path>::iterator i = cp_modules.begin(); i != cp_modules.end(); ++i) {
201 control_protocol_discover ((*i).to_string());
206 ControlProtocolManager::control_protocol_discover (string path)
208 ControlProtocolDescriptor* descriptor;
210 if ((descriptor = get_descriptor (path)) != 0) {
212 ControlProtocolInfo* cpi = new ControlProtocolInfo ();
214 if (!descriptor->probe (descriptor)) {
215 info << string_compose (_("Control protocol %1 not usable"), descriptor->name) << endmsg;
218 cpi->descriptor = descriptor;
219 cpi->name = descriptor->name;
222 cpi->requested = false;
223 cpi->mandatory = descriptor->mandatory;
224 cpi->supports_feedback = descriptor->supports_feedback;
227 control_protocol_info.push_back (cpi);
229 info << string_compose(_("Control surface protocol discovered: \"%1\""), cpi->name) << endmsg;
232 dlclose (descriptor->module);
238 ControlProtocolDescriptor*
239 ControlProtocolManager::get_descriptor (string path)
242 ControlProtocolDescriptor *descriptor = 0;
243 ControlProtocolDescriptor* (*dfunc)(void);
246 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
247 error << string_compose(_("ControlProtocolManager: cannot load module \"%1\" (%2)"), path, dlerror()) << endmsg;
252 dfunc = (ControlProtocolDescriptor* (*)(void)) dlsym (module, "protocol_descriptor");
254 if ((errstr = dlerror()) != 0) {
255 error << string_compose(_("ControlProtocolManager: module \"%1\" has no descriptor function."), path) << endmsg;
256 error << errstr << endmsg;
261 descriptor = dfunc();
263 descriptor->module = module;
272 ControlProtocolManager::foreach_known_protocol (sigc::slot<void,const ControlProtocolInfo*> method)
274 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
280 ControlProtocolManager::cpi_by_name (string name)
282 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
283 if (name == (*i)->name) {
291 ControlProtocolManager::set_state (const XMLNode& node, int version)
294 XMLNodeConstIterator citer;
297 clist = node.children();
299 for (citer = clist.begin(); citer != clist.end(); ++citer) {
300 if ((*citer)->name() == X_("Protocol")) {
302 prop = (*citer)->property (X_("active"));
304 if (prop && string_is_affirmative (prop->value())) {
305 if ((prop = (*citer)->property (X_("name"))) != 0) {
306 ControlProtocolInfo* cpi = cpi_by_name (prop->value());
308 if (!(*citer)->children().empty()) {
309 cpi->state = (*citer)->children().front ();
317 cpi->requested = true;
328 ControlProtocolManager::get_state (void)
330 XMLNode* root = new XMLNode (state_node_name);
331 Glib::Mutex::Lock lm (protocols_lock);
333 for (list<ControlProtocolInfo*>::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) {
337 if ((*i)->protocol) {
338 child = &((*i)->protocol->get_state());
339 child->add_property (X_("active"), "yes");
340 // should we update (*i)->state here? probably.
341 root->add_child_nocopy (*child);
343 else if ((*i)->state) {
344 // keep ownership clear
345 root->add_child_copy (*(*i)->state);
348 child = new XMLNode (X_("Protocol"));
349 child->add_property (X_("name"), (*i)->name);
350 child->add_property (X_("active"), "no");
351 root->add_child_nocopy (*child);
359 ControlProtocolManager::set_protocol_states (const XMLNode& node)
362 XMLNodeConstIterator niter;
365 nlist = node.children();
367 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
369 XMLNode* child = (*niter);
371 if ((prop = child->property ("name")) == 0) {
372 error << _("control protocol XML node has no name property. Ignored.") << endmsg;
376 ControlProtocolInfo* cpi = cpi_by_name (prop->value());
379 warning << string_compose (_("control protocol \"%1\" is not known. Ignored"), prop->value()) << endmsg;
383 /* copy the node so that ownership is clear */
385 cpi->state = new XMLNode (*child);
389 ControlProtocolManager&
390 ControlProtocolManager::instance ()
392 if (_instance == 0) {
393 _instance = new ControlProtocolManager ();