X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fcontrol_protocol_manager.cc;h=9f6216062adb6a54bdf3758db5d84577a7cdf68e;hb=91ab5e31751105d59386aab6a6e16ac5582904dc;hp=475781f3c57296287e050f9193d919f645c25f4c;hpb=6fa6514cfdb0ce38d93b51197f599dfd091bad1d;p=ardour.git diff --git a/libs/ardour/control_protocol_manager.cc b/libs/ardour/control_protocol_manager.cc index 475781f3c5..9f6216062a 100644 --- a/libs/ardour/control_protocol_manager.cc +++ b/libs/ardour/control_protocol_manager.cc @@ -17,11 +17,12 @@ */ -#include +#include #include #include "pbd/compose.h" +#include "pbd/event_loop.h" #include "pbd/file_utils.h" #include "pbd/error.h" @@ -29,7 +30,9 @@ #include "ardour/debug.h" #include "ardour/control_protocol_manager.h" -#include "ardour/control_protocol_search_path.h" + +#include "ardour/search_paths.h" + using namespace ARDOUR; using namespace std; @@ -46,7 +49,7 @@ ControlProtocolManager::ControlProtocolManager () ControlProtocolManager::~ControlProtocolManager() { - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); for (list::iterator i = control_protocols.begin(); i != control_protocols.end(); ++i) { delete (*i); @@ -68,50 +71,88 @@ ControlProtocolManager::set_session (Session* s) SessionHandlePtr::set_session (s); if (_session) { - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); for (list::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) { if ((*i)->requested || (*i)->mandatory) { - instantiate (**i); - (*i)->requested = false; - - if ((*i)->protocol) { - if ((*i)->state) { - (*i)->protocol->set_state (*(*i)->state, Stateful::loading_state_version); - } else { - /* guarantee a call to - set_state() whether we have - existing state or not - */ - (*i)->protocol->set_state (XMLNode(""), Stateful::loading_state_version); - } - } + (void) activate (**i); } } } } +int +ControlProtocolManager::activate (ControlProtocolInfo& cpi) +{ + ControlProtocol* cp; + + cpi.requested = true; + + if ((cp = instantiate (cpi)) == 0) { + return -1; + } + + /* we split the set_state() and set_active() operations so that + protocols that need state to configure themselves (e.g. "What device + is connected, or supposed to be connected?") can get it before + actually starting any interaction. + */ + + if (cpi.state) { + /* force this by tweaking the internals of the state + * XMLNode. Ugh. + */ + cp->set_state (*cpi.state, Stateful::loading_state_version); + } else { + /* guarantee a call to + set_state() whether we have + existing state or not + */ + cp->set_state (XMLNode(""), Stateful::loading_state_version); + } + + cp->set_active (true); + + return 0; +} + +int +ControlProtocolManager::deactivate (ControlProtocolInfo& cpi) +{ + cpi.requested = false; + return teardown (cpi); +} + void ControlProtocolManager::session_going_away() { SessionHandlePtr::session_going_away (); + /* Session::destroy() will explicitly call drop_protocols() so we don't + * have to worry about that here. + */ +} - { - Glib::Mutex::Lock lm (protocols_lock); +void +ControlProtocolManager::drop_protocols () +{ + /* called explicitly by Session::destroy() so that we can clean up + * before the process cycle stops and ports vanish. + */ - for (list::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) { - delete *p; - } + Glib::Threads::Mutex::Lock lm (protocols_lock); - control_protocols.clear (); + for (list::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) { + delete *p; + } - for (list::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) { - // mark existing protocols as requested - // otherwise the ControlProtocol instances are not recreated in set_session - if ((*p)->protocol) { - (*p)->requested = true; - (*p)->protocol = 0; - } + control_protocols.clear (); + + for (list::iterator p = control_protocol_info.begin(); p != control_protocol_info.end(); ++p) { + // mark existing protocols as requested + // otherwise the ControlProtocol instances are not recreated in set_session + if ((*p)->protocol) { + (*p)->requested = true; + (*p)->protocol = 0; } } } @@ -127,11 +168,15 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi) cpi.descriptor = get_descriptor (cpi.path); + DEBUG_TRACE (DEBUG::ControlProtocols, string_compose ("instantiating %1\n", cpi.name)); + if (cpi.descriptor == 0) { error << string_compose (_("control protocol name \"%1\" has no descriptor"), cpi.name) << endmsg; return 0; } + DEBUG_TRACE (DEBUG::ControlProtocols, string_compose ("initializing %1\n", cpi.name)); + 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; @@ -139,6 +184,8 @@ ControlProtocolManager::instantiate (ControlProtocolInfo& cpi) control_protocols.push_back (cpi.protocol); + ProtocolStatusChange (&cpi); + return cpi.protocol; } @@ -146,6 +193,18 @@ int ControlProtocolManager::teardown (ControlProtocolInfo& cpi) { if (!cpi.protocol) { + + /* we could still have a descriptor even if the protocol was + never instantiated. Close the associated module (shared + object/DLL) and make sure we forget about it. + */ + + if (cpi.descriptor) { + cerr << "Closing descriptor for CPI anyway\n"; + delete (Glib::Module*) cpi.descriptor->module; + cpi.descriptor = 0; + } + return 0; } @@ -157,10 +216,16 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi) return 0; } + /* save current state */ + + delete cpi.state; + cpi.state = new XMLNode (cpi.protocol->get_state()); + cpi.state->add_property (X_("active"), "no"); + cpi.descriptor->destroy (cpi.descriptor, cpi.protocol); { - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); list::iterator p = find (control_protocols.begin(), control_protocols.end(), cpi.protocol); if (p != control_protocols.end()) { control_protocols.erase (p); @@ -170,9 +235,18 @@ ControlProtocolManager::teardown (ControlProtocolInfo& cpi) } cpi.protocol = 0; + delete cpi.state; cpi.state = 0; - dlclose (cpi.descriptor->module); + 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 + * object made accessible by dlopen(). + */ + cpi.descriptor = 0; + + ProtocolStatusChange (&cpi); + return 0; } @@ -183,7 +257,7 @@ ControlProtocolManager::load_mandatory_protocols () return; } - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); for (list::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) { if ((*i)->mandatory && ((*i)->protocol == 0)) { @@ -197,22 +271,45 @@ ControlProtocolManager::load_mandatory_protocols () void ControlProtocolManager::discover_control_protocols () { - vector cp_modules; + vector cp_modules; + +#ifdef COMPILER_MSVC + /** + * Different build targets (Debug / Release etc) use different versions + * of the 'C' runtime (which can't be 'mixed & matched'). Therefore, in + * case the supplied search path contains multiple version(s) of a given + * module, only select the one(s) which match the current build target + */ + #if defined (_DEBUG) + Glib::PatternSpec dll_extension_pattern("*D.dll"); + #elif defined (RDC_BUILD) + Glib::PatternSpec dll_extension_pattern("*RDC.dll"); + #elif defined (_WIN64) + Glib::PatternSpec dll_extension_pattern("*64.dll"); + #else + Glib::PatternSpec dll_extension_pattern("*32.dll"); + #endif +#else + Glib::PatternSpec dll_extension_pattern("*.dll"); +#endif Glib::PatternSpec so_extension_pattern("*.so"); Glib::PatternSpec dylib_extension_pattern("*.dylib"); - find_matching_files_in_search_path (control_protocol_search_path (), - so_extension_pattern, cp_modules); + find_files_matching_pattern (cp_modules, control_protocol_search_path (), + dll_extension_pattern); - find_matching_files_in_search_path (control_protocol_search_path (), - dylib_extension_pattern, cp_modules); + find_files_matching_pattern (cp_modules, control_protocol_search_path (), + so_extension_pattern); - DEBUG_TRACE (DEBUG::ControlProtocols, + find_files_matching_pattern (cp_modules, control_protocol_search_path (), + dylib_extension_pattern); + + DEBUG_TRACE (DEBUG::ControlProtocols, string_compose (_("looking for control protocols in %1\n"), control_protocol_search_path().to_string())); - - for (vector::iterator i = cp_modules.begin(); i != cp_modules.end(); ++i) { - control_protocol_discover ((*i).to_string()); + + for (vector::iterator i = cp_modules.begin(); i != cp_modules.end(); ++i) { + control_protocol_discover (*i); } } @@ -250,11 +347,9 @@ ControlProtocolManager::control_protocol_discover (string path) control_protocol_info.push_back (cpi); - DEBUG_TRACE (DEBUG::ControlProtocols, - string_compose(_("Control surface protocol discovered: \"%1\""), cpi->name)); + DEBUG_TRACE (DEBUG::ControlProtocols, + string_compose(_("Control surface protocol discovered: \"%1\"\n"), cpi->name)); } - - dlclose (descriptor->module); } return 0; @@ -263,31 +358,29 @@ ControlProtocolManager::control_protocol_discover (string path) ControlProtocolDescriptor* ControlProtocolManager::get_descriptor (string path) { - void *module; + Glib::Module* module = new Glib::Module(path); ControlProtocolDescriptor *descriptor = 0; ControlProtocolDescriptor* (*dfunc)(void); - const char *errstr; + void* func = 0; - if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) { - error << string_compose(_("ControlProtocolManager: cannot load module \"%1\" (%2)"), path, dlerror()) << endmsg; + if (!(*module)) { + error << string_compose(_("ControlProtocolManager: cannot load module \"%1\" (%2)"), path, Glib::Module::get_last_error()) << endmsg; + delete module; return 0; } - - dfunc = (ControlProtocolDescriptor* (*)(void)) dlsym (module, "protocol_descriptor"); - - if ((errstr = dlerror()) != 0) { + if (!module->get_symbol("protocol_descriptor", func)) { error << string_compose(_("ControlProtocolManager: module \"%1\" has no descriptor function."), path) << endmsg; - error << errstr << endmsg; - dlclose (module); + error << Glib::Module::get_last_error() << endmsg; + delete module; return 0; } + dfunc = (ControlProtocolDescriptor* (*)(void))func; descriptor = dfunc(); + if (descriptor) { - descriptor->module = module; - } else { - dlclose (module); + descriptor->module = (void*)module; } return descriptor; @@ -317,39 +410,49 @@ ControlProtocolManager::set_state (const XMLNode& node, int /*version*/) { XMLNodeList clist; XMLNodeConstIterator citer; - XMLProperty* prop; + XMLProperty const * prop; - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); clist = node.children(); for (citer = clist.begin(); citer != clist.end(); ++citer) { - if ((*citer)->name() == X_("Protocol")) { + XMLNode const * child = *citer; + + if (child->name() == X_("Protocol")) { - prop = (*citer)->property (X_("active")); + if ((prop = child->property (X_("active"))) == 0) { + continue; + } - if (prop && string_is_affirmative (prop->value())) { - if ((prop = (*citer)->property (X_("name"))) != 0) { - ControlProtocolInfo* cpi = cpi_by_name (prop->value()); + bool active = string_is_affirmative (prop->value()); - if (cpi) { + if ((prop = child->property (X_("name"))) == 0) { + continue; + } - if (cpi->state) { - delete cpi->state; - } + ControlProtocolInfo* cpi = cpi_by_name (prop->value()); - cpi->state = new XMLNode (**citer); + if (cpi) { + cpi->state = new XMLNode (**citer); - if (_session) { - instantiate (*cpi); - } else { - cpi->requested = true; - } + if (active) { + if (_session) { + instantiate (*cpi); + } else { + cpi->requested = true; + } + } else { + if (_session) { + teardown (*cpi); + } else { + cpi->requested = false; } } } } } + return 0; } @@ -357,61 +460,30 @@ XMLNode& ControlProtocolManager::get_state () { XMLNode* root = new XMLNode (state_node_name); - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); for (list::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); + XMLNode& child_state ((*i)->protocol->get_state()); + child_state.add_property (X_("active"), "yes"); + root->add_child_nocopy (child_state); } else if ((*i)->state) { - // keep ownership clear - root->add_child_copy (*(*i)->state); + XMLNode* child_state = new XMLNode (*(*i)->state); + child_state->add_property (X_("active"), "no"); + root->add_child_nocopy (*child_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); + XMLNode* child_state = new XMLNode (X_("Protocol")); + child_state->add_property (X_("name"), (*i)->name); + child_state->add_property (X_("active"), "no"); + root->add_child_nocopy (*child_state); } + } 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); - } -} ControlProtocolManager& ControlProtocolManager::instance () @@ -426,9 +498,27 @@ ControlProtocolManager::instance () void ControlProtocolManager::midi_connectivity_established () { - Glib::Mutex::Lock lm (protocols_lock); + Glib::Threads::Mutex::Lock lm (protocols_lock); for (list::iterator p = control_protocols.begin(); p != control_protocols.end(); ++p) { (*p)->midi_connectivity_established (); } } + +void +ControlProtocolManager::register_request_buffer_factories () +{ + Glib::Threads::Mutex::Lock lm (protocols_lock); + + for (list::iterator i = control_protocol_info.begin(); i != control_protocol_info.end(); ++i) { + + if ((*i)->descriptor == 0) { + warning << string_compose (_("Control protocol \"%1\" has no descriptor"), (*i)->name) << endmsg; + continue; + } + + if ((*i)->descriptor->request_buffer_factory) { + EventLoop::register_request_buffer_factory ((*i)->descriptor->name, (*i)->descriptor->request_buffer_factory); + } + } +}