2 Copyright (C) 2000-2006 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.
28 #include <glibmm/thread.h>
30 #include "pbd/xml++.h"
31 #include "pbd/replace_all.h"
32 #include "pbd/unknown_type.h"
33 #include "pbd/enumwriter.h"
35 #include "ardour/audioengine.h"
36 #include "ardour/buffer.h"
37 #include "ardour/debug.h"
38 #include "ardour/io.h"
39 #include "ardour/route.h"
40 #include "ardour/port.h"
41 #include "ardour/audio_port.h"
42 #include "ardour/midi_port.h"
43 #include "ardour/session.h"
44 #include "ardour/cycle_timer.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/meter.h"
47 #include "ardour/amp.h"
48 #include "ardour/user_bundle.h"
52 #define BLOCK_PROCESS_CALLBACK() Glib::Mutex::Lock em (AudioEngine::instance()->process_lock())
55 using namespace ARDOUR;
58 const string IO::state_node_name = "IO";
59 bool IO::connecting_legal = false;
60 PBD::Signal0<int> IO::ConnectingLegal;
61 PBD::Signal1<void,ChanCount> IO::PortCountChanged;
63 /** @param default_type The type of port that will be created by ensure_io
64 * and friends if no type is explicitly requested (to avoid breakage).
66 IO::IO (Session& s, const string& name, Direction dir, DataType default_type)
67 : SessionObject (s, name)
69 , _default_type (default_type)
72 pending_state_node = 0;
76 IO::IO (Session& s, const XMLNode& node, DataType dt)
77 : SessionObject(s, "unnamed io")
82 pending_state_node = 0;
84 set_state (node, Stateful::loading_state_version);
90 Glib::Mutex::Lock lm (io_lock);
92 BLOCK_PROCESS_CALLBACK ();
94 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
95 _session.engine().unregister_port (*i);
100 IO::increment_port_buffer_offset (pframes_t offset)
102 /* io_lock, not taken: function must be called from Session::process() calltree */
104 if (_direction == Output) {
105 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
106 i->increment_port_buffer_offset (offset);
112 IO::silence (framecnt_t nframes)
114 /* io_lock, not taken: function must be called from Session::process() calltree */
116 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
117 i->get_buffer(nframes).silence (nframes);
122 IO::check_bundles_connected ()
124 check_bundles (_bundles_connected, ports());
127 /** Check the bundles in list to see which are connected to a given PortSet,
128 * and update list with those that are connected such that every port on every
129 * bundle channel x is connected to port x in ports.
132 IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
134 std::vector<UserBundleInfo*> new_list;
136 for (std::vector<UserBundleInfo*>::iterator i = list.begin(); i != list.end(); ++i) {
138 uint32_t const N = (*i)->bundle->nchannels().n_total();
140 if (_ports.num_ports() < N) {
146 for (uint32_t j = 0; j < N; ++j) {
147 /* Every port on bundle channel j must be connected to our input j */
148 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
149 for (uint32_t k = 0; k < pl.size(); ++k) {
150 if (ports.port(j)->connected_to (pl[k]) == false) {
162 new_list.push_back (*i);
173 IO::disconnect (Port* our_port, string other_port, void* src)
175 if (other_port.length() == 0 || our_port == 0) {
180 Glib::Mutex::Lock lm (io_lock);
182 /* check that our_port is really one of ours */
184 if ( ! _ports.contains(our_port)) {
188 /* disconnect it from the source */
190 if (our_port->disconnect (other_port)) {
191 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
195 check_bundles_connected ();
198 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
200 _session.set_dirty ();
206 IO::connect (Port* our_port, string other_port, void* src)
208 if (other_port.length() == 0 || our_port == 0) {
213 Glib::Mutex::Lock lm (io_lock);
215 /* check that our_port is really one of ours */
217 if ( ! _ports.contains(our_port) ) {
221 /* connect it to the source */
223 if (our_port->connect (other_port)) {
227 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
228 _session.set_dirty ();
233 IO::remove_port (Port* port, void* src)
235 ChanCount before = _ports.count ();
236 ChanCount after = before;
237 after.set (port->type(), after.get (port->type()) - 1);
239 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
247 BLOCK_PROCESS_CALLBACK ();
250 Glib::Mutex::Lock lm (io_lock);
252 if (_ports.remove(port)) {
253 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
254 change.before = before;
255 change.after = _ports.count ();
257 if (port->connected()) {
258 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
261 _session.engine().unregister_port (*port);
262 check_bundles_connected ();
266 PortCountChanged (n_ports()); /* EMIT SIGNAL */
268 if (change.type != IOChange::NoChange) {
269 changed (change, src);
270 _buffers.attach_buffers (_ports);
274 if (change.type & IOChange::ConfigurationChanged) {
278 if (change.type == IOChange::NoChange) {
282 _session.set_dirty ();
289 * @param destination Name of port to connect new port to.
290 * @param src Source for emitted ConfigurationChanged signal.
291 * @param type Data type of port. Default value (NIL) will use this IO's default type.
294 IO::add_port (string destination, void* src, DataType type)
298 if (type == DataType::NIL) {
299 type = _default_type;
305 BLOCK_PROCESS_CALLBACK ();
309 Glib::Mutex::Lock lm (io_lock);
311 /* Create a new port */
313 string portname = build_legal_port_name (type);
315 if (_direction == Input) {
316 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
317 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
321 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
322 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
327 change.before = _ports.count ();
328 _ports.add (our_port);
331 PortCountChanged (n_ports()); /* EMIT SIGNAL */
333 // pan_changed (src); /* EMIT SIGNAL */
334 change.type = IOChange::ConfigurationChanged;
335 change.after = _ports.count ();
336 changed (change, src); /* EMIT SIGNAL */
337 _buffers.attach_buffers (_ports);
340 if (destination.length()) {
341 if (our_port->connect (destination)) {
347 _session.set_dirty ();
353 IO::disconnect (void* src)
356 Glib::Mutex::Lock lm (io_lock);
358 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
359 i->disconnect_all ();
362 check_bundles_connected ();
365 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
370 /** Caller must hold process lock */
372 IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
374 assert (!AudioEngine::instance()->process_lock().trylock());
377 bool changed = false;
379 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
381 const size_t n = count.get(*t);
383 /* remove unused ports */
384 for (size_t i = n_ports().get(*t); i > n; --i) {
385 port = _ports.port(*t, i-1);
389 _session.engine().unregister_port (*port);
394 /* create any necessary new ports */
395 while (n_ports().get(*t) < n) {
397 string portname = build_legal_port_name (*t);
401 if (_direction == Input) {
402 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
403 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
407 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
408 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
414 catch (AudioEngine::PortRegistrationFailure& err) {
425 check_bundles_connected ();
426 PortCountChanged (n_ports()); /* EMIT SIGNAL */
427 _session.set_dirty ();
431 /* disconnect all existing ports so that we get a fresh start */
432 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
433 i->disconnect_all ();
440 /** Caller must hold process lock */
442 IO::ensure_ports (ChanCount count, bool clear, void* src)
444 assert (!AudioEngine::instance()->process_lock().trylock());
446 bool changed = false;
448 if (count == n_ports() && !clear) {
454 change.before = _ports.count ();
457 Glib::Mutex::Lock im (io_lock);
458 changed = ensure_ports_locked (count, clear, src);
462 change.after = _ports.count ();
463 change.type = IOChange::ConfigurationChanged;
464 this->changed (change, src); /* EMIT SIGNAL */
465 _buffers.attach_buffers (_ports);
467 _session.set_dirty ();
473 /** Caller must hold process lock */
475 IO::ensure_io (ChanCount count, bool clear, void* src)
477 assert (!AudioEngine::instance()->process_lock().trylock());
479 return ensure_ports (count, clear, src);
489 IO::state (bool /*full_state*/)
491 XMLNode* node = new XMLNode (state_node_name);
494 vector<string>::iterator ci;
496 LocaleGuard lg (X_("POSIX"));
497 Glib::Mutex::Lock lm (io_lock);
499 node->add_property("name", _name);
500 id().print (buf, sizeof (buf));
501 node->add_property("id", buf);
502 node->add_property ("direction", enum_2_string (_direction));
503 node->add_property ("default-type", _default_type.to_string());
505 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
506 XMLNode* n = new XMLNode ("Bundle");
507 n->add_property ("name", (*i)->bundle->name ());
508 node->add_child_nocopy (*n);
511 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
513 vector<string> connections;
515 XMLNode* pnode = new XMLNode (X_("Port"));
516 pnode->add_property (X_("type"), i->type().to_string());
517 pnode->add_property (X_("name"), i->name());
519 if (i->get_connections (connections)) {
521 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
523 /* if its a connection to our own port,
524 return only the port name, not the
525 whole thing. this allows connections
526 to be re-established even when our
527 client name is different.
530 XMLNode* cnode = new XMLNode (X_("Connection"));
532 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
533 pnode->add_child_nocopy (*cnode);
537 node->add_child_nocopy (*pnode);
540 snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
541 node->add_property (X_("user-latency"), buf);
547 IO::set_state (const XMLNode& node, int version)
549 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
550 * are input OR output, not both, so the direction needs to be specified
553 assert (version >= 3000);
555 const XMLProperty* prop;
556 XMLNodeConstIterator iter;
557 LocaleGuard lg (X_("POSIX"));
559 /* force use of non-localized representation of decimal point,
560 since we use it a lot in XML files and so forth.
563 if (node.name() != state_node_name) {
564 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
568 if ((prop = node.property ("name")) != 0) {
569 set_name (prop->value());
572 if ((prop = node.property (X_("default-type"))) != 0) {
573 _default_type = DataType(prop->value());
574 assert(_default_type != DataType::NIL);
577 if ((prop = node.property ("id")) != 0) {
578 _id = prop->value ();
581 if ((prop = node.property ("direction")) != 0) {
582 _direction = (Direction) string_2_enum (prop->value(), _direction);
585 if (create_ports (node, version)) {
589 if (connecting_legal) {
591 if (make_connections (node, version, false)) {
597 pending_state_node = new XMLNode (node);
598 pending_state_node_version = version;
599 pending_state_node_in = false;
600 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
603 if ((prop = node.property ("user-latency")) != 0) {
604 _user_latency = atoi (prop->value ());
611 IO::set_state_2X (const XMLNode& node, int version, bool in)
613 const XMLProperty* prop;
614 XMLNodeConstIterator iter;
615 LocaleGuard lg (X_("POSIX"));
617 /* force use of non-localized representation of decimal point,
618 since we use it a lot in XML files and so forth.
621 if (node.name() != state_node_name) {
622 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
626 if ((prop = node.property ("name")) != 0) {
627 set_name (prop->value());
630 if ((prop = node.property (X_("default-type"))) != 0) {
631 _default_type = DataType(prop->value());
632 assert(_default_type != DataType::NIL);
635 if ((prop = node.property ("id")) != 0) {
636 _id = prop->value ();
639 _direction = in ? Input : Output;
641 if (create_ports (node, version)) {
645 if (connecting_legal) {
647 if (make_connections_2X (node, version, in)) {
653 pending_state_node = new XMLNode (node);
654 pending_state_node_version = version;
655 pending_state_node_in = in;
656 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
663 IO::connecting_became_legal ()
667 assert (pending_state_node);
669 connection_legal_c.disconnect ();
671 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
673 delete pending_state_node;
674 pending_state_node = 0;
679 boost::shared_ptr<Bundle>
680 IO::find_possible_bundle (const string &desired_name)
682 static const string digits = "0123456789";
683 const string &default_name = (_direction == Input ? _("in") : _("out"));
684 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
686 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
689 int bundle_number, mask;
690 string possible_name;
692 string::size_type last_non_digit_pos;
694 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
697 // find numeric suffix of desired name
700 last_non_digit_pos = desired_name.find_last_not_of(digits);
702 if (last_non_digit_pos != string::npos) {
704 s << desired_name.substr(last_non_digit_pos);
708 // see if it's a stereo connection e.g. "in 3+4"
710 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
711 string::size_type left_last_non_digit_pos;
713 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
715 if (left_last_non_digit_pos != string::npos) {
716 int left_bundle_number = 0;
718 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
719 s >> left_bundle_number;
721 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
732 // find highest set bit
734 while ((mask <= bundle_number) && (mask <<= 1)) {}
736 // "wrap" bundle number into largest possible power of 2
741 if (bundle_number & mask) {
742 bundle_number &= ~mask;
745 s << default_name << " " << bundle_number + 1;
748 s << "+" << bundle_number + 2;
751 possible_name = s.str();
753 if ((c = _session.bundle_by_name (possible_name)) != 0) {
760 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
763 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
774 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
776 XMLProperty const * prop;
777 XMLNodeList children = node.children ();
779 uint32_t n_audio = 0;
781 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
783 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
784 n_audio = count (prop->value().begin(), prop->value().end(), '{');
785 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
787 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
788 n_audio = count (prop->value().begin(), prop->value().end(), '{');
789 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
795 cnt.set_audio (n_audio);
796 n = ChanCount::max (n, cnt);
802 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
804 if (version < 3000) {
805 return get_port_counts_2X (node, version, n, c);
808 XMLProperty const * prop;
809 XMLNodeConstIterator iter;
810 uint32_t n_audio = 0;
816 if ((prop = node.property ("connection")) != 0) {
818 if ((c = find_possible_bundle (prop->value())) != 0) {
819 n = ChanCount::max (n, c->nchannels());
824 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
826 if ((*iter)->name() == X_("Bundle")) {
827 if ((c = find_possible_bundle (prop->value())) != 0) {
828 n = ChanCount::max (n, c->nchannels());
835 if ((*iter)->name() == X_("Port")) {
836 prop = (*iter)->property (X_("type"));
842 if (prop->value() == X_("audio")) {
843 cnt.set_audio (++n_audio);
844 } else if (prop->value() == X_("midi")) {
845 cnt.set_midi (++n_midi);
850 n = ChanCount::max (n, cnt);
855 IO::create_ports (const XMLNode& node, int version)
858 boost::shared_ptr<Bundle> c;
860 get_port_counts (node, version, n, c);
863 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
865 if (ensure_ports (n, true, this)) {
866 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
877 IO::make_connections (const XMLNode& node, int version, bool in)
879 if (version < 3000) {
880 return make_connections_2X (node, version, in);
883 const XMLProperty* prop;
885 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
887 if ((*i)->name() == "Bundle") {
888 XMLProperty const * prop = (*i)->property ("name");
890 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
892 connect_ports_to_bundle (b, this);
899 if ((*i)->name() == "Port") {
901 prop = (*i)->property (X_("name"));
907 Port* p = port_by_name (prop->value());
910 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
912 XMLNode* cnode = (*c);
914 if (cnode->name() != X_("Connection")) {
918 if ((prop = cnode->property (X_("other"))) == 0) {
923 connect (p, prop->value(), this);
935 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
937 const XMLProperty* prop;
939 /* XXX: bundles ("connections" as was) */
941 if ((prop = node.property ("inputs")) != 0 && in) {
943 string::size_type ostart = 0;
944 string::size_type start = 0;
945 string::size_type end = 0;
948 vector<string> ports;
950 string const str = prop->value ();
952 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
955 if ((end = str.find_first_of ('}', start)) == string::npos) {
956 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
960 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
961 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
968 for (int x = 0; x < n; ++x) {
969 /* XXX: this is a bit of a hack; need to check if it's always valid */
970 string::size_type const p = ports[x].find ("/out");
971 if (p != string::npos) {
972 ports[x].replace (p, 4, "/audio_out");
974 nth(i)->connect (ports[x]);
984 if ((prop = node.property ("outputs")) != 0 && !in) {
986 string::size_type ostart = 0;
987 string::size_type start = 0;
988 string::size_type end = 0;
991 vector<string> ports;
993 string const str = prop->value ();
995 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
998 if ((end = str.find_first_of ('}', start)) == string::npos) {
999 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
1003 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1004 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
1010 for (int x = 0; x < n; ++x) {
1011 /* XXX: this is a bit of a hack; need to check if it's always valid */
1012 string::size_type const p = ports[x].find ("/in");
1013 if (p != string::npos) {
1014 ports[x].replace (p, 3, "/audio_in");
1016 nth(i)->connect (ports[x]);
1029 IO::set_ports (const string& str)
1031 vector<string> ports;
1036 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1041 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1043 // FIXME: audio-only
1044 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1049 string::size_type start, end, ostart;
1056 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1059 if ((end = str.find_first_of ('}', start)) == string::npos) {
1060 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1064 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1065 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1071 for (int x = 0; x < n; ++x) {
1072 connect (nth (i), ports[x], this);
1084 IO::parse_io_string (const string& str, vector<string>& ports)
1086 string::size_type pos, opos;
1088 if (str.length() == 0) {
1097 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1098 ports.push_back (str.substr (opos, pos - opos));
1102 if (opos < str.length()) {
1103 ports.push_back (str.substr(opos));
1106 return ports.size();
1110 IO::parse_gain_string (const string& str, vector<string>& ports)
1112 string::size_type pos, opos;
1118 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1119 ports.push_back (str.substr (opos, pos - opos));
1123 if (opos < str.length()) {
1124 ports.push_back (str.substr(opos));
1127 return ports.size();
1131 IO::set_name (const string& requested_name)
1133 string name = requested_name;
1135 if (_name == name) {
1139 /* replace all colons in the name. i wish we didn't have to do this */
1141 replace_all (name, ":", "-");
1143 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1144 string current_name = i->name();
1145 current_name.replace (current_name.find (_name), _name.val().length(), name);
1146 i->set_name (current_name);
1149 bool const r = SessionObject::set_name (name);
1157 IO::latency () const
1159 framecnt_t max_latency;
1164 /* io lock not taken - must be protected by other means */
1166 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1167 if ((latency = i->private_latency_range (_direction == Output).max) > max_latency) {
1168 DEBUG_TRACE (DEBUG::Latency, string_compose ("port %1 has %2 latency of %3 - use\n",
1170 ((_direction == Output) ? "PLAYBACK" : "CAPTURE"),
1172 max_latency = latency;
1176 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max %4 latency from %2 ports = %3\n",
1177 name(), _ports.num_ports(), max_latency,
1178 ((_direction == Output) ? "PLAYBACK" : "CAPTURE")));
1183 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
1185 BLOCK_PROCESS_CALLBACK ();
1188 Glib::Mutex::Lock lm2 (io_lock);
1190 c->connect (_bundle, _session.engine());
1192 /* If this is a UserBundle, make a note of what we've done */
1194 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1197 /* See if we already know about this one */
1198 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1199 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1203 if (i == _bundles_connected.end()) {
1204 /* We don't, so make a note */
1205 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1210 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1215 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1217 BLOCK_PROCESS_CALLBACK ();
1220 Glib::Mutex::Lock lm2 (io_lock);
1222 c->disconnect (_bundle, _session.engine());
1224 /* If this is a UserBundle, make a note of what we've done */
1226 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1229 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1230 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1234 if (i != _bundles_connected.end()) {
1236 _bundles_connected.erase (i);
1241 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1247 IO::disable_connecting ()
1249 connecting_legal = false;
1254 IO::enable_connecting ()
1256 connecting_legal = true;
1257 boost::optional<int> r = ConnectingLegal ();
1258 return r.get_value_or (0);
1262 IO::bundle_changed (Bundle::Change /*c*/)
1265 // connect_input_ports_to_bundle (_input_bundle, this);
1270 IO::build_legal_port_name (DataType type)
1272 const int name_size = jack_port_name_size();
1276 if (type == DataType::AUDIO) {
1277 suffix = _("audio");
1278 } else if (type == DataType::MIDI) {
1281 throw unknown_type();
1284 /* note that if "in" or "out" are translated it will break a session
1285 across locale switches because a port's connection list will
1286 show (old) translated names, but the current port name will
1287 use the (new) translated name.
1290 if (_direction == Input) {
1291 suffix += X_("_in");
1293 suffix += X_("_out");
1296 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1298 limit = name_size - _session.engine().client_name().length() - (suffix.length() + 5);
1300 char buf1[name_size+1];
1301 char buf2[name_size+1];
1303 snprintf (buf1, name_size+1, ("%.*s/%s"), limit, _name.val().c_str(), suffix.c_str());
1305 int port_number = find_port_hole (buf1);
1306 snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
1308 return string (buf2);
1312 IO::find_port_hole (const char* base)
1314 /* CALLER MUST HOLD IO LOCK */
1318 if (_ports.empty()) {
1322 /* we only allow up to 4 characters for the port number
1325 for (n = 1; n < 9999; ++n) {
1326 char buf[jack_port_name_size()];
1327 PortSet::iterator i = _ports.begin();
1329 snprintf (buf, jack_port_name_size(), _("%s %u"), base, n);
1331 for ( ; i != _ports.end(); ++i) {
1332 if (i->name() == buf) {
1337 if (i == _ports.end()) {
1346 IO::audio(uint32_t n) const
1348 return _ports.nth_audio_port (n);
1353 IO::midi(uint32_t n) const
1355 return _ports.nth_midi_port (n);
1359 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1368 _bundle.reset (new Bundle (_direction == Input));
1371 _bundle->suspend_signals ();
1373 _bundle->remove_channels ();
1375 if (_direction == Input) {
1376 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1378 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1380 _bundle->set_name (buf);
1383 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1385 uint32_t const N = _ports.count().get (*i);
1386 for (uint32_t j = 0; j < N; ++j) {
1387 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1388 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1394 _bundle->resume_signals ();
1397 /** @return Bundles connected to our ports */
1399 IO::bundles_connected ()
1404 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1405 bundles.push_back ((*i)->bundle);
1408 /* Session bundles */
1409 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1410 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1411 if ((*i)->connected_to (_bundle, _session.engine())) {
1412 bundles.push_back (*i);
1418 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1420 if (_direction == Input) {
1421 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1422 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1423 bundles.push_back ((*i)->output()->bundle());
1427 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1428 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1429 bundles.push_back ((*i)->input()->bundle());
1438 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1441 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1445 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1449 if (t == DataType::AUDIO) {
1455 return c == 0 ? _("L") : _("R");
1457 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1463 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1472 IO::name_from_state (const XMLNode& node)
1474 const XMLProperty* prop;
1476 if ((prop = node.property ("name")) != 0) {
1477 return prop->value();
1484 IO::set_name_in_state (XMLNode& node, const string& new_name)
1486 const XMLProperty* prop;
1488 if ((prop = node.property ("name")) != 0) {
1489 node.add_property ("name", new_name);
1494 IO::connected () const
1496 /* do we have any connections at all? */
1498 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1499 if (p->connected()) {
1508 IO::connected_to (boost::shared_ptr<const IO> other) const
1511 return connected ();
1514 assert (_direction != other->direction());
1517 uint32_t no = n_ports().n_total();
1518 uint32_t ni = other->n_ports ().n_total();
1520 for (i = 0; i < no; ++i) {
1521 for (j = 0; j < ni; ++j) {
1522 if (nth(i)->connected_to (other->nth(j)->name())) {
1532 IO::connected_to (const string& str) const
1534 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1535 if (i->connected_to (str)) {
1543 /** Caller must hold process lock */
1545 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
1547 /* don't read the data into new buffers - just use the port buffers directly */
1549 _buffers.get_jack_port_addresses (_ports, nframes);
1550 proc->run (_buffers, start_frame, end_frame, nframes, true);
1554 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1556 assert(bufs.available() >= _ports.count());
1558 if (_ports.count() == ChanCount::ZERO) {
1562 bufs.set_count (_ports.count());
1564 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1565 PortSet::iterator i = _ports.begin(*t);
1566 BufferSet::iterator b = bufs.begin(*t);
1568 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1569 if (b == bufs.end(*t)) {
1574 for ( ; i != _ports.end(*t); ++i, ++b) {
1575 Buffer& bb (i->get_buffer (nframes));
1576 b->read_from (bb, nframes);
1582 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1584 // Copy any buffers 1:1 to outputs
1586 PortSet::iterator o = _ports.begin(type);
1587 BufferSet::iterator i = bufs.begin(type);
1588 BufferSet::iterator prev = i;
1590 while (i != bufs.end(type) && o != _ports.end (type)) {
1591 Buffer& port_buffer (o->get_buffer (nframes));
1592 port_buffer.read_from (*i, nframes, offset);
1598 // Copy last buffer to any extra outputs
1600 while (o != _ports.end(type)) {
1601 Buffer& port_buffer (o->get_buffer (nframes));
1602 port_buffer.read_from (*prev, nframes, offset);
1608 IO::port_by_name (const std::string& str) const
1610 /* to be called only from ::set_state() - no locking */
1612 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1616 if (p.name() == str) {
1617 return const_cast<Port*>(&p);
1625 IO::physically_connected () const
1627 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1628 if (i->physically_connected()) {
1637 IO::has_port (Port* p) const
1639 Glib::Mutex::Lock lm (io_lock);
1640 return _ports.contains (p);