2 Copyright (C) 2013 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.
21 #include <io.h> // Microsoft's nearest equivalent to <unistd.h>
22 #include <ardourext/misc.h>
27 #include <glibmm/fileutils.h>
28 #include <glibmm/miscutils.h>
30 #include "pbd/error.h"
32 #include "ardour/async_midi_port.h"
33 #include "ardour/audio_backend.h"
34 #include "ardour/audio_port.h"
35 #include "ardour/debug.h"
36 #include "ardour/filesystem_paths.h"
37 #include "ardour/midi_port.h"
38 #include "ardour/midiport_manager.h"
39 #include "ardour/port_manager.h"
40 #include "ardour/profile.h"
41 #include "ardour/rt_tasklist.h"
42 #include "ardour/session.h"
43 #include "ardour/types_convert.h"
47 using namespace ARDOUR;
52 PortManager::PortManager ()
54 , _port_remove_in_progress (false)
55 , _port_deletions_pending (8192) /* ick, arbitrary sizing */
56 , midi_info_dirty (true)
58 load_midi_port_info ();
62 PortManager::clear_pending_port_deletions ()
66 DEBUG_TRACE (DEBUG::Ports, string_compose ("pending port deletions: %1\n", _port_deletions_pending.read_space()));
68 while (_port_deletions_pending.read (&p, 1) == 1) {
74 PortManager::remove_all_ports ()
76 /* make sure that JACK callbacks that will be invoked as we cleanup
77 * ports know that they have nothing to do.
80 _port_remove_in_progress = true;
82 /* process lock MUST be held by caller
86 RCUWriter<Ports> writer (ports);
87 boost::shared_ptr<Ports> ps = writer.get_copy ();
91 /* clear dead wood list in RCU */
95 /* clear out pending port deletion list. we know this is safe because
96 * the auto connect thread in Session is already dead when this is
97 * done. It doesn't use shared_ptr<Port> anyway.
100 _port_deletions_pending.reset ();
102 _port_remove_in_progress = false;
107 PortManager::make_port_name_relative (const string& portname) const
113 string::size_type colon = portname.find (':');
115 if (colon == string::npos) {
119 if (portname.substr (0, colon) == _backend->my_name()) {
120 return portname.substr (colon+1);
127 PortManager::make_port_name_non_relative (const string& portname) const
131 if (portname.find_first_of (':') != string::npos) {
135 str = _backend->my_name();
143 PortManager::get_pretty_name_by_name(const std::string& portname) const
145 PortEngine::PortHandle ph = _backend->get_port_by_name (portname);
149 if (0 == _backend->get_port_property (ph,
150 "http://jackaudio.org/metadata/pretty-name",
160 PortManager::port_is_mine (const string& portname) const
166 string self = _backend->my_name();
168 if (portname.find_first_of (':') != string::npos) {
169 if (portname.substr (0, self.length ()) != self) {
178 PortManager::port_is_physical (const std::string& portname) const
184 PortEngine::PortHandle ph = _backend->get_port_by_name (portname);
189 return _backend->port_is_physical (ph);
193 PortManager::filter_midi_ports (vector<string>& ports, MidiPortFlags include, MidiPortFlags exclude)
195 if (!include && !exclude) {
199 for (vector<string>::iterator si = ports.begin(); si != ports.end(); ) {
201 PortManager::MidiPortInformation mpi = midi_port_information (*si);
203 if (mpi.pretty_name.empty()) {
204 /* no information !!! */
210 if ((mpi.properties & include) != include) {
211 /* properties do not include requested ones */
212 si = ports.erase (si);
218 if ((mpi.properties & exclude)) {
219 /* properties include ones to avoid */
220 si = ports.erase (si);
230 PortManager::get_physical_outputs (DataType type, std::vector<std::string>& s, MidiPortFlags include, MidiPortFlags exclude)
236 _backend->get_physical_outputs (type, s);
237 filter_midi_ports (s, include, exclude);
241 PortManager::get_physical_inputs (DataType type, std::vector<std::string>& s, MidiPortFlags include, MidiPortFlags exclude)
248 _backend->get_physical_inputs (type, s);
249 filter_midi_ports (s, include, exclude);
253 PortManager::n_physical_outputs () const
256 return ChanCount::ZERO;
259 return _backend->n_physical_outputs ();
263 PortManager::n_physical_inputs () const
266 return ChanCount::ZERO;
268 return _backend->n_physical_inputs ();
271 /** @param name Full or short name of port
272 * @return Corresponding Port or 0.
274 boost::shared_ptr<Port>
275 PortManager::get_port_by_name (const string& portname)
278 return boost::shared_ptr<Port>();
281 if (!port_is_mine (portname)) {
282 /* not an ardour port */
283 return boost::shared_ptr<Port> ();
286 boost::shared_ptr<Ports> pr = ports.reader();
287 std::string rel = make_port_name_relative (portname);
288 Ports::iterator x = pr->find (rel);
290 if (x != pr->end()) {
291 /* its possible that the port was renamed by some 3rd party and
292 * we don't know about it. check for this (the check is quick
293 * and cheap), and if so, rename the port (which will alter
294 * the port map as a side effect).
296 const std::string check = make_port_name_relative (_backend->get_port_name (x->second->port_handle()));
298 x->second->set_name (check);
303 return boost::shared_ptr<Port> ();
307 PortManager::port_renamed (const std::string& old_relative_name, const std::string& new_relative_name)
309 RCUWriter<Ports> writer (ports);
310 boost::shared_ptr<Ports> p = writer.get_copy();
311 Ports::iterator x = p->find (old_relative_name);
314 boost::shared_ptr<Port> port = x->second;
316 p->insert (make_pair (new_relative_name, port));
321 PortManager::get_ports (DataType type, PortList& pl)
323 boost::shared_ptr<Ports> plist = ports.reader();
324 for (Ports::iterator p = plist->begin(); p != plist->end(); ++p) {
325 if (p->second->type() == type) {
326 pl.push_back (p->second);
333 PortManager::get_ports (const string& port_name_pattern, DataType type, PortFlags flags, vector<string>& s)
341 return _backend->get_ports (port_name_pattern, type, flags, s);
345 PortManager::port_registration_failure (const std::string& portname)
351 string full_portname = _backend->my_name();
352 full_portname += ':';
353 full_portname += portname;
356 PortEngine::PortHandle p = _backend->get_port_by_name (full_portname);
360 reason = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
362 reason = string_compose (_("No more ports are available. You will need to stop %1 and restart with more ports if you need this many tracks."), PROGRAM_NAME);
365 throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
370 void operator() (Port* p) {
371 AudioEngine::instance()->add_pending_port_deletion (p);
375 boost::shared_ptr<Port>
376 PortManager::register_port (DataType dtype, const string& portname, bool input, bool async, PortFlags flags)
378 boost::shared_ptr<Port> newport;
380 /* limit the possible flags that can be set */
382 flags = PortFlags (flags & (Hidden|Shadow|IsTerminal));
385 if (dtype == DataType::AUDIO) {
386 DEBUG_TRACE (DEBUG::Ports, string_compose ("registering AUDIO port %1, input %2\n",
388 newport.reset (new AudioPort (portname, PortFlags ((input ? IsInput : IsOutput) | flags)),
390 } else if (dtype == DataType::MIDI) {
392 DEBUG_TRACE (DEBUG::Ports, string_compose ("registering ASYNC MIDI port %1, input %2\n",
394 newport.reset (new AsyncMIDIPort (portname, PortFlags ((input ? IsInput : IsOutput) | flags)),
397 DEBUG_TRACE (DEBUG::Ports, string_compose ("registering MIDI port %1, input %2\n",
399 newport.reset (new MidiPort (portname, PortFlags ((input ? IsInput : IsOutput) | flags)),
403 throw PortRegistrationFailure("unable to create port (unknown type)");
406 RCUWriter<Ports> writer (ports);
407 boost::shared_ptr<Ports> ps = writer.get_copy ();
408 ps->insert (make_pair (make_port_name_relative (portname), newport));
410 /* writer goes out of scope, forces update */
414 catch (PortRegistrationFailure& err) {
416 } catch (std::exception& e) {
417 throw PortRegistrationFailure(string_compose(
418 _("unable to create port: %1"), e.what()).c_str());
420 throw PortRegistrationFailure("unable to create port (unknown error)");
423 DEBUG_TRACE (DEBUG::Ports, string_compose ("\t%2 port registration success, ports now = %1\n", ports.reader()->size(), this));
427 boost::shared_ptr<Port>
428 PortManager::register_input_port (DataType type, const string& portname, bool async, PortFlags extra_flags)
430 return register_port (type, portname, true, async, extra_flags);
433 boost::shared_ptr<Port>
434 PortManager::register_output_port (DataType type, const string& portname, bool async, PortFlags extra_flags)
436 return register_port (type, portname, false, async, extra_flags);
440 PortManager::unregister_port (boost::shared_ptr<Port> port)
442 /* This is a little subtle. We do not call the backend's port
443 * unregistration code from here. That is left for the Port
444 * destructor. We are trying to drop references to the Port object
445 * here, so that its destructor will run and it will unregister itself.
448 /* caller must hold process lock */
451 RCUWriter<Ports> writer (ports);
452 boost::shared_ptr<Ports> ps = writer.get_copy ();
453 Ports::iterator x = ps->find (make_port_name_relative (port->name()));
455 if (x != ps->end()) {
456 DEBUG_TRACE (DEBUG::Ports, string_compose ("removing %1 from port map (uc=%2)\n", port->name(), port.use_count()));
460 /* writer goes out of scope, forces update */
469 PortManager::connected (const string& port_name)
475 PortEngine::PortHandle handle = _backend->get_port_by_name (port_name);
481 return _backend->connected (handle);
485 PortManager::physically_connected (const string& port_name)
491 PortEngine::PortHandle handle = _backend->get_port_by_name (port_name);
497 return _backend->physically_connected (handle);
501 PortManager::get_connections (const string& port_name, std::vector<std::string>& s)
508 PortEngine::PortHandle handle = _backend->get_port_by_name (port_name);
515 return _backend->get_connections (handle, s);
519 PortManager::connect (const string& source, const string& destination)
523 string s = make_port_name_non_relative (source);
524 string d = make_port_name_non_relative (destination);
526 boost::shared_ptr<Port> src = get_port_by_name (s);
527 boost::shared_ptr<Port> dst = get_port_by_name (d);
530 ret = src->connect (d);
532 ret = dst->connect (s);
534 /* neither port is known to us ...hand-off to the PortEngine
537 ret = _backend->connect (s, d);
544 /* already exists - no error, no warning */
545 } else if (ret < 0) {
546 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
547 source, s, destination, d)
555 PortManager::disconnect (const string& source, const string& destination)
559 string s = make_port_name_non_relative (source);
560 string d = make_port_name_non_relative (destination);
562 boost::shared_ptr<Port> src = get_port_by_name (s);
563 boost::shared_ptr<Port> dst = get_port_by_name (d);
566 ret = src->disconnect (d);
568 ret = dst->disconnect (s);
570 /* neither port is known to us ...hand-off to the PortEngine
573 ret = _backend->disconnect (s, d);
582 PortManager::disconnect (boost::shared_ptr<Port> port)
584 return port->disconnect_all ();
588 PortManager::disconnect (std::string const & name)
590 PortEngine::PortHandle ph = _backend->get_port_by_name (name);
592 return _backend->disconnect_all (ph);
598 PortManager::reestablish_ports ()
602 boost::shared_ptr<Ports> p = ports.reader ();
604 DEBUG_TRACE (DEBUG::Ports, string_compose ("reestablish %1 ports\n", p->size()));
606 for (i = p->begin(); i != p->end(); ++i) {
607 if (i->second->reestablish ()) {
608 error << string_compose (_("Re-establising port %1 failed"), i->second->name()) << endmsg;
609 std::cerr << string_compose (_("Re-establising port %1 failed"), i->second->name()) << std::endl;
624 PortManager::reconnect_ports ()
626 boost::shared_ptr<Ports> p = ports.reader ();
628 if (!Profile->get_trx()) {
629 /* re-establish connections */
631 DEBUG_TRACE (DEBUG::Ports, string_compose ("reconnect %1 ports\n", p->size()));
633 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
634 i->second->reconnect ();
642 PortManager::connect_callback (const string& a, const string& b, bool conn)
644 boost::shared_ptr<Port> port_a;
645 boost::shared_ptr<Port> port_b;
647 boost::shared_ptr<Ports> pr = ports.reader ();
649 x = pr->find (make_port_name_relative (a));
650 if (x != pr->end()) {
654 x = pr->find (make_port_name_relative (b));
655 if (x != pr->end()) {
659 PortConnectedOrDisconnected (
667 PortManager::registration_callback ()
669 if (!_port_remove_in_progress) {
672 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
673 midi_info_dirty = true;
676 PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
681 PortManager::can_request_input_monitoring () const
687 return _backend->can_monitor_input ();
691 PortManager::request_input_monitoring (const string& name, bool yn) const
697 PortEngine::PortHandle ph = _backend->get_port_by_name (name);
700 _backend->request_input_monitoring (ph, yn);
705 PortManager::ensure_input_monitoring (const string& name, bool yn) const
711 PortEngine::PortHandle ph = _backend->get_port_by_name (name);
714 _backend->ensure_input_monitoring (ph, yn);
719 PortManager::port_name_size() const
725 return _backend->port_name_size ();
729 PortManager::my_name() const
735 return _backend->my_name();
739 PortManager::graph_order_callback ()
741 if (!_port_remove_in_progress) {
742 GraphReordered(); /* EMIT SIGNAL */
749 PortManager::cycle_start (pframes_t nframes, Session* s)
751 Port::set_global_port_buffer_offset (0);
752 Port::set_cycle_samplecnt (nframes);
754 _cycle_ports = ports.reader ();
757 * - when speed == 1.0, the resampler copies data without processing
758 * it may (or may not) be more efficient to just run all in sequence.
760 * - single sequential task for 'lightweight' tasks would make sense
761 * (run it in parallel with 'heavy' resampling.
762 * * output ports (sends_output()) only set a flag
763 * * midi-ports only scale event timestamps
765 * - a threshold parallel vs searial processing may be appropriate.
766 * amount of work (how many connected ports are there, how
767 * many resamplers need to run) vs. available CPU cores and semaphore
768 * synchronization overhead.
770 * - input ports: it would make sense to resample each input only once
771 * (rather than resample into each ardour-owned input port).
772 * A single external source-port may be connected to many ardour
773 * input-ports. Currently re-sampling is per input.
775 if (s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
776 RTTaskList::TaskList tl;
777 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
778 tl.push_back (boost::bind (&Port::cycle_start, p->second, nframes));
780 s->rt_tasklist()->process (tl);
782 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
783 p->second->cycle_start (nframes);
789 PortManager::cycle_end (pframes_t nframes, Session* s)
791 // see optimzation note in ::cycle_start()
792 if (s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
793 RTTaskList::TaskList tl;
794 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
795 tl.push_back (boost::bind (&Port::cycle_end, p->second, nframes));
797 s->rt_tasklist()->process (tl);
799 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
800 p->second->cycle_end (nframes);
804 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
805 p->second->flush_buffers (nframes);
808 _cycle_ports.reset ();
814 PortManager::silence (pframes_t nframes, Session *s)
816 for (Ports::iterator i = _cycle_ports->begin(); i != _cycle_ports->end(); ++i) {
817 if (s && i->second == s->mtc_output_port ()) {
820 if (s && i->second == s->midi_clock_output_port ()) {
823 if (s && i->second == s->ltc_output_port ()) {
826 if (boost::dynamic_pointer_cast<AsyncMIDIPort>(i->second)) {
829 if (i->second->sends_output()) {
830 i->second->get_buffer(nframes).silence(nframes);
836 PortManager::silence_outputs (pframes_t nframes)
838 std::vector<std::string> port_names;
839 if (get_ports("", DataType::AUDIO, IsOutput, port_names)) {
840 for (std::vector<std::string>::iterator p = port_names.begin(); p != port_names.end(); ++p) {
841 if (!port_is_mine(*p)) {
844 PortEngine::PortHandle ph = _backend->get_port_by_name (*p);
848 void *buf = _backend->get_buffer(ph, nframes);
852 memset (buf, 0, sizeof(float) * nframes);
856 if (get_ports("", DataType::MIDI, IsOutput, port_names)) {
857 for (std::vector<std::string>::iterator p = port_names.begin(); p != port_names.end(); ++p) {
858 if (!port_is_mine(*p)) {
861 PortEngine::PortHandle ph = _backend->get_port_by_name (*p);
865 void *buf = _backend->get_buffer(ph, nframes);
869 _backend->midi_clear (buf);
875 PortManager::check_monitoring ()
877 for (Ports::iterator i = _cycle_ports->begin(); i != _cycle_ports->end(); ++i) {
881 if (i->second->last_monitor() != (x = i->second->monitoring_input ())) {
882 i->second->set_last_monitor (x);
883 /* XXX I think this is dangerous, due to
884 a likely mutex in the signal handlers ...
886 i->second->MonitorInputChanged (x); /* EMIT SIGNAL */
892 PortManager::cycle_end_fade_out (gain_t base_gain, gain_t gain_step, pframes_t nframes, Session* s)
894 // see optimzation note in ::cycle_start()
895 if (s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
896 RTTaskList::TaskList tl;
897 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
898 tl.push_back (boost::bind (&Port::cycle_end, p->second, nframes));
900 s->rt_tasklist()->process (tl);
902 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
903 p->second->cycle_end (nframes);
907 for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
908 p->second->flush_buffers (nframes);
910 if (p->second->sends_output()) {
912 boost::shared_ptr<AudioPort> ap = boost::dynamic_pointer_cast<AudioPort> (p->second);
914 Sample* s = ap->engine_get_whole_audio_buffer ();
915 gain_t g = base_gain;
917 for (pframes_t n = 0; n < nframes; ++n) {
924 _cycle_ports.reset ();
929 PortManager::port_engine()
936 PortManager::port_is_control_only (std::string const& name)
938 static regex_t compiled_pattern;
939 static string pattern;
941 if (pattern.empty()) {
943 /* This is a list of regular expressions that match ports
944 * related to physical MIDI devices that we do not want to
945 * expose as normal physical ports.
948 const char * const control_only_ports[] = {
949 X_(".*Ableton Push.*"),
950 X_(".*FaderPort .*"),
951 X_(".*FaderPort8 .*"),
957 for (size_t n = 0; n < sizeof (control_only_ports)/sizeof (control_only_ports[0]); ++n) {
961 pattern += control_only_ports[n];
965 regcomp (&compiled_pattern, pattern.c_str(), REG_EXTENDED|REG_NOSUB);
968 return regexec (&compiled_pattern, name.c_str(), 0, 0, 0) == 0;
971 PortManager::MidiPortInformation
972 PortManager::midi_port_information (std::string const & name)
974 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
976 fill_midi_port_info_locked ();
978 MidiPortInfo::iterator x = midi_port_info.find (name);
980 if (x != midi_port_info.end()) {
984 return MidiPortInformation ();
988 PortManager::get_known_midi_ports (vector<string>& copy)
990 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
992 fill_midi_port_info_locked ();
994 for (MidiPortInfo::const_iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
995 copy.push_back (x->first);
1000 PortManager::get_midi_selection_ports (vector<string>& copy)
1002 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
1004 fill_midi_port_info_locked ();
1006 for (MidiPortInfo::const_iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
1007 if (x->second.properties & MidiPortSelection) {
1008 copy.push_back (x->first);
1014 PortManager::set_midi_port_pretty_name (string const & port, string const & pretty)
1017 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
1019 fill_midi_port_info_locked ();
1021 MidiPortInfo::iterator x = midi_port_info.find (port);
1022 if (x == midi_port_info.end()) {
1025 x->second.pretty_name = pretty;
1028 /* push into back end */
1030 PortEngine::PortHandle ph = _backend->get_port_by_name (port);
1033 _backend->set_port_property (ph, "http://jackaudio.org/metadata/pretty-name", pretty, string());
1036 MidiPortInfoChanged (); /* EMIT SIGNAL*/
1040 PortManager::add_midi_port_flags (string const & port, MidiPortFlags flags)
1045 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
1047 fill_midi_port_info_locked ();
1049 MidiPortInfo::iterator x = midi_port_info.find (port);
1050 if (x != midi_port_info.end()) {
1051 if ((x->second.properties & flags) != flags) { // at least one missing
1052 x->second.properties = MidiPortFlags (x->second.properties | flags);
1059 if (flags & MidiPortSelection) {
1060 MidiSelectionPortsChanged (); /* EMIT SIGNAL */
1063 if (flags != MidiPortSelection) {
1064 MidiPortInfoChanged (); /* EMIT SIGNAL */
1067 save_midi_port_info ();
1072 PortManager::remove_midi_port_flags (string const & port, MidiPortFlags flags)
1077 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
1079 fill_midi_port_info_locked ();
1081 MidiPortInfo::iterator x = midi_port_info.find (port);
1082 if (x != midi_port_info.end()) {
1083 if (x->second.properties & flags) { // at least one is set
1084 x->second.properties = MidiPortFlags (x->second.properties & ~flags);
1091 if (flags & MidiPortSelection) {
1092 MidiSelectionPortsChanged (); /* EMIT SIGNAL */
1095 if (flags != MidiPortSelection) {
1096 MidiPortInfoChanged (); /* EMIT SIGNAL */
1099 save_midi_port_info ();
1104 PortManager::midi_port_info_file ()
1106 return Glib::build_filename (user_config_directory(), X_("midi_port_info"));
1110 PortManager::save_midi_port_info ()
1112 string path = midi_port_info_file ();
1114 XMLNode* root = new XMLNode (X_("MidiPortInfo"));
1117 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
1119 if (midi_port_info.empty()) {
1124 for (MidiPortInfo::iterator i = midi_port_info.begin(); i != midi_port_info.end(); ++i) {
1125 XMLNode* node = new XMLNode (X_("port"));
1126 node->set_property (X_("name"), i->first);
1127 node->set_property (X_("input"), i->second.input);
1128 node->set_property (X_("properties"), i->second.properties);
1129 root->add_child_nocopy (*node);
1135 tree.set_root (root);
1137 if (!tree.write (path)) {
1138 error << string_compose (_("Could not save MIDI port info to %1"), path) << endmsg;
1143 PortManager::load_midi_port_info ()
1145 string path = midi_port_info_file ();
1148 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1152 if (!tree.read (path)) {
1153 error << string_compose (_("Cannot load MIDI port info from %1"), path) << endmsg;
1157 midi_port_info.clear ();
1159 for (XMLNodeConstIterator i = tree.root()->children().begin(); i != tree.root()->children().end(); ++i) {
1160 MidiPortInformation mpi;
1163 if (!(*i)->get_property (X_("name"), name) ||
1164 !(*i)->get_property (X_("input"), mpi.input) ||
1165 !(*i)->get_property (X_("properties"), mpi.properties)) {
1169 midi_port_info.insert (make_pair (name, mpi));
1174 PortManager::fill_midi_port_info ()
1176 Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
1177 fill_midi_port_info_locked ();
1181 PortManager::fill_midi_port_info_locked ()
1183 /* MIDI info mutex MUST be held */
1185 if (!midi_info_dirty) {
1189 std::vector<string> ports;
1191 AudioEngine::instance()->get_ports (string(), DataType::MIDI, IsOutput, ports);
1193 for (vector<string>::iterator p = ports.begin(); p != ports.end(); ++p) {
1195 if (port_is_mine (*p)) {
1199 if (midi_port_info.find (*p) == midi_port_info.end()) {
1200 MidiPortInformation mpi;
1201 mpi.pretty_name = *p;
1204 if (port_is_control_only (*p)) {
1205 mpi.properties = MidiPortFlags (mpi.properties | MidiPortControl);
1208 if ((*p.find (X_("Midi Through")) != string::npos ||
1209 (*p).find (X_("Midi-Through")) != string::npos))
1211 mpi.properties = MidiPortFlags (mpi.properties | MidiPortVirtual);
1214 midi_port_info.insert (make_pair (*p, mpi));
1218 AudioEngine::instance()->get_ports (string(), DataType::MIDI, IsInput, ports);
1220 for (vector<string>::iterator p = ports.begin(); p != ports.end(); ++p) {
1222 if (port_is_mine (*p)) {
1226 if (midi_port_info.find (*p) == midi_port_info.end()) {
1227 MidiPortInformation mpi;
1228 mpi.pretty_name = *p;
1231 if (port_is_control_only (*p)) {
1232 mpi.properties = MidiPortFlags (mpi.properties | MidiPortControl);
1235 if ((*p.find (X_("Midi Through")) != string::npos ||
1236 (*p).find (X_("Midi-Through")) != string::npos))
1238 mpi.properties = MidiPortFlags (mpi.properties | MidiPortVirtual);
1241 midi_port_info.insert (make_pair (*p, mpi));
1245 /* now push/pull pretty name information between backend and the
1249 // rg: I don't understand what this attempts to solve
1251 // Naming ports should be left to the backend:
1252 // Ardour cannot associate numeric IDs with corresponding hardware.
1253 // (see also 7dde6c3b)
1255 for (MidiPortInfo::iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
1256 PortEngine::PortHandle ph = _backend->get_port_by_name (x->first);
1259 /* port info saved from some condition where this port
1260 * existed, but no longer does (i.e. device unplugged
1266 if (!x->second.pretty_name.empty () && x->second.pretty_name != x->first) {
1267 /* name set in port info ... propagate */
1268 _backend->set_port_property (ph, "http://jackaudio.org/metadata/pretty-name", x->second.pretty_name, string());
1270 /* check with backend for pre-existing pretty name */
1273 if (0 == _backend->get_port_property (ph,
1274 "http://jackaudio.org/metadata/pretty-name",
1276 x->second.pretty_name = value;
1281 midi_info_dirty = false;