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 */
332 change.type = IOChange::ConfigurationChanged;
333 change.after = _ports.count ();
334 changed (change, src); /* EMIT SIGNAL */
335 _buffers.attach_buffers (_ports);
338 if (!destination.empty()) {
339 if (our_port->connect (destination)) {
345 _session.set_dirty ();
351 IO::disconnect (void* src)
354 Glib::Mutex::Lock lm (io_lock);
356 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
357 i->disconnect_all ();
360 check_bundles_connected ();
363 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
368 /** Caller must hold process lock */
370 IO::ensure_ports_locked (ChanCount count, bool clear, bool& changed)
372 assert (!AudioEngine::instance()->process_lock().trylock());
378 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
380 const size_t n = count.get(*t);
382 /* remove unused ports */
383 for (size_t i = n_ports().get(*t); i > n; --i) {
384 port = _ports.port(*t, i-1);
388 _session.engine().unregister_port (*port);
393 /* create any necessary new ports */
394 while (n_ports().get(*t) < n) {
396 string portname = build_legal_port_name (*t);
400 if (_direction == Input) {
401 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
402 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
406 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
407 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
413 catch (AudioEngine::PortRegistrationFailure& err) {
424 check_bundles_connected ();
425 PortCountChanged (n_ports()); /* EMIT SIGNAL */
426 _session.set_dirty ();
430 /* disconnect all existing ports so that we get a fresh start */
431 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
432 i->disconnect_all ();
439 /** Caller must hold process lock */
441 IO::ensure_ports (ChanCount count, bool clear, void* src)
443 assert (!AudioEngine::instance()->process_lock().trylock());
445 bool changed = false;
447 if (count == n_ports() && !clear) {
453 change.before = _ports.count ();
456 Glib::Mutex::Lock im (io_lock);
457 if (ensure_ports_locked (count, clear, changed)) {
463 change.after = _ports.count ();
464 change.type = IOChange::ConfigurationChanged;
465 this->changed (change, src); /* EMIT SIGNAL */
466 _buffers.attach_buffers (_ports);
468 _session.set_dirty ();
474 /** Caller must hold process lock */
476 IO::ensure_io (ChanCount count, bool clear, void* src)
478 assert (!AudioEngine::instance()->process_lock().trylock());
480 return ensure_ports (count, clear, src);
490 IO::state (bool /*full_state*/)
492 XMLNode* node = new XMLNode (state_node_name);
495 vector<string>::iterator ci;
497 LocaleGuard lg (X_("POSIX"));
498 Glib::Mutex::Lock lm (io_lock);
500 node->add_property("name", _name);
501 id().print (buf, sizeof (buf));
502 node->add_property("id", buf);
503 node->add_property ("direction", enum_2_string (_direction));
504 node->add_property ("default-type", _default_type.to_string());
506 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
507 XMLNode* n = new XMLNode ("Bundle");
508 n->add_property ("name", (*i)->bundle->name ());
509 node->add_child_nocopy (*n);
512 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
514 vector<string> connections;
516 XMLNode* pnode = new XMLNode (X_("Port"));
517 pnode->add_property (X_("type"), i->type().to_string());
518 pnode->add_property (X_("name"), i->name());
520 if (i->get_connections (connections)) {
522 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
524 /* if its a connection to our own port,
525 return only the port name, not the
526 whole thing. this allows connections
527 to be re-established even when our
528 client name is different.
531 XMLNode* cnode = new XMLNode (X_("Connection"));
533 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
534 pnode->add_child_nocopy (*cnode);
538 node->add_child_nocopy (*pnode);
541 snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
542 node->add_property (X_("user-latency"), buf);
548 IO::set_state (const XMLNode& node, int version)
550 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
551 * are input OR output, not both, so the direction needs to be specified
554 assert (version >= 3000);
556 const XMLProperty* prop;
557 XMLNodeConstIterator iter;
558 LocaleGuard lg (X_("POSIX"));
560 /* force use of non-localized representation of decimal point,
561 since we use it a lot in XML files and so forth.
564 if (node.name() != state_node_name) {
565 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
569 if ((prop = node.property ("name")) != 0) {
570 set_name (prop->value());
573 if ((prop = node.property (X_("default-type"))) != 0) {
574 _default_type = DataType(prop->value());
575 assert(_default_type != DataType::NIL);
578 if ((prop = node.property ("id")) != 0) {
579 _id = prop->value ();
582 if ((prop = node.property ("direction")) != 0) {
583 _direction = (Direction) string_2_enum (prop->value(), _direction);
586 if (create_ports (node, version)) {
590 if (connecting_legal) {
592 if (make_connections (node, version, false)) {
598 pending_state_node = new XMLNode (node);
599 pending_state_node_version = version;
600 pending_state_node_in = false;
601 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
604 if ((prop = node.property ("user-latency")) != 0) {
605 _user_latency = atoi (prop->value ());
612 IO::set_state_2X (const XMLNode& node, int version, bool in)
614 const XMLProperty* prop;
615 XMLNodeConstIterator iter;
616 LocaleGuard lg (X_("POSIX"));
618 /* force use of non-localized representation of decimal point,
619 since we use it a lot in XML files and so forth.
622 if (node.name() != state_node_name) {
623 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
627 if ((prop = node.property ("name")) != 0) {
628 set_name (prop->value());
631 if ((prop = node.property (X_("default-type"))) != 0) {
632 _default_type = DataType(prop->value());
633 assert(_default_type != DataType::NIL);
636 if ((prop = node.property ("id")) != 0) {
637 _id = prop->value ();
640 _direction = in ? Input : Output;
642 if (create_ports (node, version)) {
646 if (connecting_legal) {
648 if (make_connections_2X (node, version, in)) {
654 pending_state_node = new XMLNode (node);
655 pending_state_node_version = version;
656 pending_state_node_in = in;
657 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
664 IO::connecting_became_legal ()
668 assert (pending_state_node);
670 connection_legal_c.disconnect ();
672 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
674 delete pending_state_node;
675 pending_state_node = 0;
680 boost::shared_ptr<Bundle>
681 IO::find_possible_bundle (const string &desired_name)
683 static const string digits = "0123456789";
684 const string &default_name = (_direction == Input ? _("in") : _("out"));
685 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
687 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
690 int bundle_number, mask;
691 string possible_name;
693 string::size_type last_non_digit_pos;
695 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
698 // find numeric suffix of desired name
701 last_non_digit_pos = desired_name.find_last_not_of(digits);
703 if (last_non_digit_pos != string::npos) {
705 s << desired_name.substr(last_non_digit_pos);
709 // see if it's a stereo connection e.g. "in 3+4"
711 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
712 string::size_type left_last_non_digit_pos;
714 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
716 if (left_last_non_digit_pos != string::npos) {
717 int left_bundle_number = 0;
719 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
720 s >> left_bundle_number;
722 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
733 // find highest set bit
735 while ((mask <= bundle_number) && (mask <<= 1)) {}
737 // "wrap" bundle number into largest possible power of 2
742 if (bundle_number & mask) {
743 bundle_number &= ~mask;
746 s << default_name << " " << bundle_number + 1;
749 s << "+" << bundle_number + 2;
752 possible_name = s.str();
754 if ((c = _session.bundle_by_name (possible_name)) != 0) {
761 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
764 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
775 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
777 XMLProperty const * prop;
778 XMLNodeList children = node.children ();
780 uint32_t n_audio = 0;
782 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
784 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
785 n_audio = count (prop->value().begin(), prop->value().end(), '{');
786 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
788 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
789 n_audio = count (prop->value().begin(), prop->value().end(), '{');
790 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
796 cnt.set_audio (n_audio);
797 n = ChanCount::max (n, cnt);
803 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
805 if (version < 3000) {
806 return get_port_counts_2X (node, version, n, c);
809 XMLProperty const * prop;
810 XMLNodeConstIterator iter;
811 uint32_t n_audio = 0;
817 if ((prop = node.property ("connection")) != 0) {
819 if ((c = find_possible_bundle (prop->value())) != 0) {
820 n = ChanCount::max (n, c->nchannels());
825 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
827 if ((*iter)->name() == X_("Bundle")) {
828 if ((c = find_possible_bundle (prop->value())) != 0) {
829 n = ChanCount::max (n, c->nchannels());
836 if ((*iter)->name() == X_("Port")) {
837 prop = (*iter)->property (X_("type"));
843 if (prop->value() == X_("audio")) {
844 cnt.set_audio (++n_audio);
845 } else if (prop->value() == X_("midi")) {
846 cnt.set_midi (++n_midi);
851 n = ChanCount::max (n, cnt);
856 IO::create_ports (const XMLNode& node, int version)
859 boost::shared_ptr<Bundle> c;
861 get_port_counts (node, version, n, c);
864 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
866 if (ensure_ports (n, true, this)) {
867 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
878 IO::make_connections (const XMLNode& node, int version, bool in)
880 if (version < 3000) {
881 return make_connections_2X (node, version, in);
884 const XMLProperty* prop;
886 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
888 if ((*i)->name() == "Bundle") {
889 XMLProperty const * prop = (*i)->property ("name");
891 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
893 connect_ports_to_bundle (b, this);
900 if ((*i)->name() == "Port") {
902 prop = (*i)->property (X_("name"));
908 Port* p = port_by_name (prop->value());
911 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
913 XMLNode* cnode = (*c);
915 if (cnode->name() != X_("Connection")) {
919 if ((prop = cnode->property (X_("other"))) == 0) {
924 connect (p, prop->value(), this);
936 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
938 const XMLProperty* prop;
940 /* XXX: bundles ("connections" as was) */
942 if ((prop = node.property ("inputs")) != 0 && in) {
944 string::size_type ostart = 0;
945 string::size_type start = 0;
946 string::size_type end = 0;
949 vector<string> ports;
951 string const str = prop->value ();
953 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
956 if ((end = str.find_first_of ('}', start)) == string::npos) {
957 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
961 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
962 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
969 for (int x = 0; x < n; ++x) {
970 /* XXX: this is a bit of a hack; need to check if it's always valid */
971 string::size_type const p = ports[x].find ("/out");
972 if (p != string::npos) {
973 ports[x].replace (p, 4, "/audio_out");
975 nth(i)->connect (ports[x]);
985 if ((prop = node.property ("outputs")) != 0 && !in) {
987 string::size_type ostart = 0;
988 string::size_type start = 0;
989 string::size_type end = 0;
992 vector<string> ports;
994 string const str = prop->value ();
996 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
999 if ((end = str.find_first_of ('}', start)) == string::npos) {
1000 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
1004 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1005 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
1011 for (int x = 0; x < n; ++x) {
1012 /* XXX: this is a bit of a hack; need to check if it's always valid */
1013 string::size_type const p = ports[x].find ("/in");
1014 if (p != string::npos) {
1015 ports[x].replace (p, 3, "/audio_in");
1017 nth(i)->connect (ports[x]);
1030 IO::set_ports (const string& str)
1032 vector<string> ports;
1037 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1042 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1044 // FIXME: audio-only
1045 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1050 string::size_type start, end, ostart;
1057 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1060 if ((end = str.find_first_of ('}', start)) == string::npos) {
1061 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1065 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1066 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1072 for (int x = 0; x < n; ++x) {
1073 connect (nth (i), ports[x], this);
1085 IO::parse_io_string (const string& str, vector<string>& ports)
1087 string::size_type pos, opos;
1089 if (str.length() == 0) {
1098 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1099 ports.push_back (str.substr (opos, pos - opos));
1103 if (opos < str.length()) {
1104 ports.push_back (str.substr(opos));
1107 return ports.size();
1111 IO::parse_gain_string (const string& str, vector<string>& ports)
1113 string::size_type pos, opos;
1119 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1120 ports.push_back (str.substr (opos, pos - opos));
1124 if (opos < str.length()) {
1125 ports.push_back (str.substr(opos));
1128 return ports.size();
1132 IO::set_name (const string& requested_name)
1134 string name = requested_name;
1136 if (_name == name) {
1140 /* replace all colons in the name. i wish we didn't have to do this */
1142 replace_all (name, ":", "-");
1144 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1145 string current_name = i->name();
1146 current_name.replace (current_name.find (_name), _name.val().length(), name);
1147 i->set_name (current_name);
1150 bool const r = SessionObject::set_name (name);
1158 IO::latency () const
1160 framecnt_t max_latency;
1165 /* io lock not taken - must be protected by other means */
1167 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1168 if ((latency = i->private_latency_range (_direction == Output).max) > max_latency) {
1169 DEBUG_TRACE (DEBUG::Latency, string_compose ("port %1 has %2 latency of %3 - use\n",
1171 ((_direction == Output) ? "PLAYBACK" : "CAPTURE"),
1173 max_latency = latency;
1177 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max %4 latency from %2 ports = %3\n",
1178 name(), _ports.num_ports(), max_latency,
1179 ((_direction == Output) ? "PLAYBACK" : "CAPTURE")));
1184 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
1186 BLOCK_PROCESS_CALLBACK ();
1189 Glib::Mutex::Lock lm2 (io_lock);
1191 c->connect (_bundle, _session.engine());
1193 /* If this is a UserBundle, make a note of what we've done */
1195 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1198 /* See if we already know about this one */
1199 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1200 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1204 if (i == _bundles_connected.end()) {
1205 /* We don't, so make a note */
1206 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1211 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1216 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1218 BLOCK_PROCESS_CALLBACK ();
1221 Glib::Mutex::Lock lm2 (io_lock);
1223 c->disconnect (_bundle, _session.engine());
1225 /* If this is a UserBundle, make a note of what we've done */
1227 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1230 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1231 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1235 if (i != _bundles_connected.end()) {
1237 _bundles_connected.erase (i);
1242 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1248 IO::disable_connecting ()
1250 connecting_legal = false;
1255 IO::enable_connecting ()
1257 connecting_legal = true;
1258 boost::optional<int> r = ConnectingLegal ();
1259 return r.get_value_or (0);
1263 IO::bundle_changed (Bundle::Change /*c*/)
1266 // connect_input_ports_to_bundle (_input_bundle, this);
1271 IO::build_legal_port_name (DataType type)
1273 const int name_size = jack_port_name_size();
1277 if (type == DataType::AUDIO) {
1278 suffix = _("audio");
1279 } else if (type == DataType::MIDI) {
1282 throw unknown_type();
1285 /* note that if "in" or "out" are translated it will break a session
1286 across locale switches because a port's connection list will
1287 show (old) translated names, but the current port name will
1288 use the (new) translated name.
1291 if (_direction == Input) {
1292 suffix += X_("_in");
1294 suffix += X_("_out");
1297 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1299 limit = name_size - _session.engine().client_name().length() - (suffix.length() + 5);
1301 char buf1[name_size+1];
1302 char buf2[name_size+1];
1304 /* colons are illegal in port names, so fix that */
1306 string nom = _name.val();
1307 replace_all (nom, ":", ";");
1309 snprintf (buf1, name_size+1, ("%.*s/%s"), limit, nom.c_str(), suffix.c_str());
1311 int port_number = find_port_hole (buf1);
1312 snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
1314 return string (buf2);
1318 IO::find_port_hole (const char* base)
1320 /* CALLER MUST HOLD IO LOCK */
1324 if (_ports.empty()) {
1328 /* we only allow up to 4 characters for the port number
1331 for (n = 1; n < 9999; ++n) {
1332 char buf[jack_port_name_size()];
1333 PortSet::iterator i = _ports.begin();
1335 snprintf (buf, jack_port_name_size(), _("%s %u"), base, n);
1337 for ( ; i != _ports.end(); ++i) {
1338 if (i->name() == buf) {
1343 if (i == _ports.end()) {
1352 IO::audio(uint32_t n) const
1354 return _ports.nth_audio_port (n);
1359 IO::midi(uint32_t n) const
1361 return _ports.nth_midi_port (n);
1365 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1374 _bundle.reset (new Bundle (_direction == Input));
1377 _bundle->suspend_signals ();
1379 _bundle->remove_channels ();
1381 if (_direction == Input) {
1382 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1384 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1386 _bundle->set_name (buf);
1389 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1391 uint32_t const N = _ports.count().get (*i);
1392 for (uint32_t j = 0; j < N; ++j) {
1393 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1394 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1400 _bundle->resume_signals ();
1403 /** @return Bundles connected to our ports */
1405 IO::bundles_connected ()
1410 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1411 bundles.push_back ((*i)->bundle);
1414 /* Session bundles */
1415 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1416 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1417 if ((*i)->connected_to (_bundle, _session.engine())) {
1418 bundles.push_back (*i);
1424 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1426 if (_direction == Input) {
1427 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1428 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1429 bundles.push_back ((*i)->output()->bundle());
1433 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1434 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1435 bundles.push_back ((*i)->input()->bundle());
1444 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1447 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1451 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1455 if (t == DataType::AUDIO) {
1461 return c == 0 ? _("L") : _("R");
1463 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1469 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1478 IO::name_from_state (const XMLNode& node)
1480 const XMLProperty* prop;
1482 if ((prop = node.property ("name")) != 0) {
1483 return prop->value();
1490 IO::set_name_in_state (XMLNode& node, const string& new_name)
1492 const XMLProperty* prop;
1494 if ((prop = node.property ("name")) != 0) {
1495 node.add_property ("name", new_name);
1500 IO::connected () const
1502 /* do we have any connections at all? */
1504 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1505 if (p->connected()) {
1514 IO::connected_to (boost::shared_ptr<const IO> other) const
1517 return connected ();
1520 assert (_direction != other->direction());
1523 uint32_t no = n_ports().n_total();
1524 uint32_t ni = other->n_ports ().n_total();
1526 for (i = 0; i < no; ++i) {
1527 for (j = 0; j < ni; ++j) {
1528 if (nth(i)->connected_to (other->nth(j)->name())) {
1538 IO::connected_to (const string& str) const
1540 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1541 if (i->connected_to (str)) {
1549 /** Caller must hold process lock */
1551 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
1553 /* don't read the data into new buffers - just use the port buffers directly */
1555 _buffers.get_jack_port_addresses (_ports, nframes);
1556 proc->run (_buffers, start_frame, end_frame, nframes, true);
1560 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1562 assert(bufs.available() >= _ports.count());
1564 if (_ports.count() == ChanCount::ZERO) {
1568 bufs.set_count (_ports.count());
1570 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1571 PortSet::iterator i = _ports.begin(*t);
1572 BufferSet::iterator b = bufs.begin(*t);
1574 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1575 if (b == bufs.end(*t)) {
1580 for ( ; i != _ports.end(*t); ++i, ++b) {
1581 Buffer& bb (i->get_buffer (nframes));
1582 b->read_from (bb, nframes);
1588 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1590 // Copy any buffers 1:1 to outputs
1592 PortSet::iterator o = _ports.begin(type);
1593 BufferSet::iterator i = bufs.begin(type);
1594 BufferSet::iterator prev = i;
1596 while (i != bufs.end(type) && o != _ports.end (type)) {
1597 Buffer& port_buffer (o->get_buffer (nframes));
1598 port_buffer.read_from (*i, nframes, offset);
1604 // Copy last buffer to any extra outputs
1606 while (o != _ports.end(type)) {
1607 Buffer& port_buffer (o->get_buffer (nframes));
1608 port_buffer.read_from (*prev, nframes, offset);
1614 IO::port_by_name (const std::string& str) const
1616 /* to be called only from ::set_state() - no locking */
1618 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1622 if (p.name() == str) {
1623 return const_cast<Port*>(&p);
1631 IO::physically_connected () const
1633 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1634 if (i->physically_connected()) {
1643 IO::has_port (Port* p) const
1645 Glib::Mutex::Lock lm (io_lock);
1646 return _ports.contains (p);