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/io.h"
38 #include "ardour/route.h"
39 #include "ardour/port.h"
40 #include "ardour/audio_port.h"
41 #include "ardour/midi_port.h"
42 #include "ardour/session.h"
43 #include "ardour/cycle_timer.h"
44 #include "ardour/buffer_set.h"
45 #include "ardour/meter.h"
46 #include "ardour/amp.h"
47 #include "ardour/user_bundle.h"
51 #define BLOCK_PROCESS_CALLBACK() Glib::Mutex::Lock em (AudioEngine::instance()->process_lock())
54 using namespace ARDOUR;
57 const string IO::state_node_name = "IO";
58 bool IO::connecting_legal = false;
59 PBD::Signal0<int> IO::ConnectingLegal;
60 PBD::Signal1<void,ChanCount> IO::PortCountChanged;
62 /** @param default_type The type of port that will be created by ensure_io
63 * and friends if no type is explicitly requested (to avoid breakage).
65 IO::IO (Session& s, const string& name, Direction dir, DataType default_type)
66 : SessionObject (s, name)
68 , _default_type (default_type)
71 pending_state_node = 0;
75 IO::IO (Session& s, const XMLNode& node, DataType dt)
76 : SessionObject(s, "unnamed io")
81 pending_state_node = 0;
83 set_state (node, Stateful::loading_state_version);
89 Glib::Mutex::Lock lm (io_lock);
91 BLOCK_PROCESS_CALLBACK ();
93 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
94 _session.engine().unregister_port (*i);
99 IO::silence (nframes_t nframes)
101 /* io_lock, not taken: function must be called from Session::process() calltree */
103 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
104 i->get_buffer(nframes).silence (nframes);
109 IO::check_bundles_connected ()
111 check_bundles (_bundles_connected, ports());
114 /** Check the bundles in list to see which are connected to a given PortSet,
115 * and update list with those that are connected such that every port on every
116 * bundle channel x is connected to port x in ports.
119 IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
121 std::vector<UserBundleInfo*> new_list;
123 for (std::vector<UserBundleInfo*>::iterator i = list.begin(); i != list.end(); ++i) {
125 uint32_t const N = (*i)->bundle->nchannels().n_total();
127 if (_ports.num_ports() < N) {
133 for (uint32_t j = 0; j < N; ++j) {
134 /* Every port on bundle channel j must be connected to our input j */
135 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
136 for (uint32_t k = 0; k < pl.size(); ++k) {
137 if (ports.port(j)->connected_to (pl[k]) == false) {
149 new_list.push_back (*i);
160 IO::disconnect (Port* our_port, string other_port, void* src)
162 if (other_port.length() == 0 || our_port == 0) {
167 BLOCK_PROCESS_CALLBACK ();
170 Glib::Mutex::Lock lm (io_lock);
172 /* check that our_port is really one of ours */
174 if ( ! _ports.contains(our_port)) {
178 /* disconnect it from the source */
180 if (our_port->disconnect (other_port)) {
181 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
185 check_bundles_connected ();
188 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
191 _session.set_dirty ();
196 /** Caller must hold process lock */
198 IO::connect (Port* our_port, string other_port, void* src)
200 assert (!AudioEngine::instance()->process_lock().trylock());
202 if (other_port.length() == 0 || our_port == 0) {
207 Glib::Mutex::Lock lm (io_lock);
209 /* check that our_port is really one of ours */
211 if ( ! _ports.contains(our_port) ) {
215 /* connect it to the source */
217 if (our_port->connect (other_port)) {
222 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
223 _session.set_dirty ();
228 IO::remove_port (Port* port, void* src)
230 ChanCount before = _ports.count ();
231 ChanCount after = before;
232 after.set (port->type(), after.get (port->type()) - 1);
234 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
242 BLOCK_PROCESS_CALLBACK ();
245 Glib::Mutex::Lock lm (io_lock);
247 if (_ports.remove(port)) {
248 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
249 change.before = before;
250 change.after = _ports.count ();
252 if (port->connected()) {
253 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
256 _session.engine().unregister_port (*port);
257 check_bundles_connected ();
261 PortCountChanged (n_ports()); /* EMIT SIGNAL */
263 if (change.type != IOChange::NoChange) {
264 changed (change, src);
265 _session.set_dirty ();
269 if (change.type & IOChange::ConfigurationChanged) {
273 if (change.type == IOChange::NoChange) {
282 * @param destination Name of port to connect new port to.
283 * @param src Source for emitted ConfigurationChanged signal.
284 * @param type Data type of port. Default value (NIL) will use this IO's default type.
287 IO::add_port (string destination, void* src, DataType type)
291 if (type == DataType::NIL) {
292 type = _default_type;
298 BLOCK_PROCESS_CALLBACK ();
302 Glib::Mutex::Lock lm (io_lock);
304 /* Create a new port */
306 string portname = build_legal_port_name (type);
308 if (_direction == Input) {
309 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
310 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
314 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
315 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
320 change.before = _ports.count ();
321 _ports.add (our_port);
324 PortCountChanged (n_ports()); /* EMIT SIGNAL */
326 // pan_changed (src); /* EMIT SIGNAL */
327 change.type = IOChange::ConfigurationChanged;
328 change.after = _ports.count ();
329 changed (change, src); /* EMIT SIGNAL */
332 if (destination.length()) {
333 if (our_port->connect (destination)) {
339 _session.set_dirty ();
345 IO::disconnect (void* src)
347 BLOCK_PROCESS_CALLBACK ();
350 Glib::Mutex::Lock lm (io_lock);
352 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
353 i->disconnect_all ();
356 check_bundles_connected ();
359 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
364 /** Caller must hold process lock */
366 IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
368 assert (!AudioEngine::instance()->process_lock().trylock());
371 bool changed = false;
373 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
375 const size_t n = count.get(*t);
377 /* remove unused ports */
378 for (size_t i = n_ports().get(*t); i > n; --i) {
379 port = _ports.port(*t, i-1);
383 _session.engine().unregister_port (*port);
388 /* create any necessary new ports */
389 while (n_ports().get(*t) < n) {
391 string portname = build_legal_port_name (*t);
395 if (_direction == Input) {
396 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
397 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
401 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
402 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
408 catch (AudioEngine::PortRegistrationFailure& err) {
419 check_bundles_connected ();
420 PortCountChanged (n_ports()); /* EMIT SIGNAL */
421 _session.set_dirty ();
425 /* disconnect all existing ports so that we get a fresh start */
426 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
427 i->disconnect_all ();
434 /** Caller must hold process lock */
436 IO::ensure_ports (ChanCount count, bool clear, void* src)
438 assert (!AudioEngine::instance()->process_lock().trylock());
440 bool changed = false;
442 if (count == n_ports() && !clear) {
448 change.before = _ports.count ();
451 Glib::Mutex::Lock im (io_lock);
452 changed = ensure_ports_locked (count, clear, src);
456 change.after = _ports.count ();
457 change.type = IOChange::ConfigurationChanged;
458 this->changed (change, src); /* EMIT SIGNAL */
460 _session.set_dirty ();
466 /** Caller must hold process lock */
468 IO::ensure_io (ChanCount count, bool clear, void* src)
470 assert (!AudioEngine::instance()->process_lock().trylock());
472 return ensure_ports (count, clear, src);
482 IO::state (bool /*full_state*/)
484 XMLNode* node = new XMLNode (state_node_name);
487 vector<string>::iterator ci;
489 LocaleGuard lg (X_("POSIX"));
490 Glib::Mutex::Lock lm (io_lock);
492 node->add_property("name", _name);
493 id().print (buf, sizeof (buf));
494 node->add_property("id", buf);
495 node->add_property ("direction", enum_2_string (_direction));
496 node->add_property ("default-type", _default_type.to_string());
498 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
499 XMLNode* n = new XMLNode ("Bundle");
500 n->add_property ("name", (*i)->bundle->name ());
501 node->add_child_nocopy (*n);
504 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
506 vector<string> connections;
508 XMLNode* pnode = new XMLNode (X_("Port"));
509 pnode->add_property (X_("type"), i->type().to_string());
510 pnode->add_property (X_("name"), i->name());
512 if (i->get_connections (connections)) {
514 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
516 /* if its a connection to our own port,
517 return only the port name, not the
518 whole thing. this allows connections
519 to be re-established even when our
520 client name is different.
523 XMLNode* cnode = new XMLNode (X_("Connection"));
525 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
526 pnode->add_child_nocopy (*cnode);
530 node->add_child_nocopy (*pnode);
537 IO::set_state (const XMLNode& node, int version)
539 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
540 * are input OR output, not both, so the direction needs to be specified
543 assert (version >= 3000);
545 const XMLProperty* prop;
546 XMLNodeConstIterator iter;
547 LocaleGuard lg (X_("POSIX"));
549 /* force use of non-localized representation of decimal point,
550 since we use it a lot in XML files and so forth.
553 if (node.name() != state_node_name) {
554 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
558 if ((prop = node.property ("name")) != 0) {
559 set_name (prop->value());
562 if ((prop = node.property (X_("default-type"))) != 0) {
563 _default_type = DataType(prop->value());
564 assert(_default_type != DataType::NIL);
567 if ((prop = node.property ("id")) != 0) {
568 _id = prop->value ();
571 if ((prop = node.property ("direction")) != 0) {
572 _direction = (Direction) string_2_enum (prop->value(), _direction);
575 if (create_ports (node, version)) {
579 if (connecting_legal) {
581 if (make_connections (node, version, false)) {
587 pending_state_node = new XMLNode (node);
588 pending_state_node_version = version;
589 pending_state_node_in = false;
590 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
598 IO::set_state_2X (const XMLNode& node, int version, bool in)
600 const XMLProperty* prop;
601 XMLNodeConstIterator iter;
602 LocaleGuard lg (X_("POSIX"));
604 /* force use of non-localized representation of decimal point,
605 since we use it a lot in XML files and so forth.
608 if (node.name() != state_node_name) {
609 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
613 if ((prop = node.property ("name")) != 0) {
614 set_name (prop->value());
617 if ((prop = node.property (X_("default-type"))) != 0) {
618 _default_type = DataType(prop->value());
619 assert(_default_type != DataType::NIL);
622 if ((prop = node.property ("id")) != 0) {
623 _id = prop->value ();
626 _direction = in ? Input : Output;
628 if (create_ports (node, version)) {
632 if (connecting_legal) {
634 if (make_connections_2X (node, version, in)) {
640 pending_state_node = new XMLNode (node);
641 pending_state_node_version = version;
642 pending_state_node_in = in;
643 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
650 IO::connecting_became_legal ()
654 assert (pending_state_node);
656 connection_legal_c.disconnect ();
658 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
660 delete pending_state_node;
661 pending_state_node = 0;
666 boost::shared_ptr<Bundle>
667 IO::find_possible_bundle (const string &desired_name)
669 static const string digits = "0123456789";
670 const string &default_name = (_direction == Input ? _("in") : _("out"));
671 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
673 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
676 int bundle_number, mask;
677 string possible_name;
679 string::size_type last_non_digit_pos;
681 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
684 // find numeric suffix of desired name
687 last_non_digit_pos = desired_name.find_last_not_of(digits);
689 if (last_non_digit_pos != string::npos) {
691 s << desired_name.substr(last_non_digit_pos);
695 // see if it's a stereo connection e.g. "in 3+4"
697 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
698 string::size_type left_last_non_digit_pos;
700 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
702 if (left_last_non_digit_pos != string::npos) {
703 int left_bundle_number = 0;
705 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
706 s >> left_bundle_number;
708 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
719 // find highest set bit
721 while ((mask <= bundle_number) && (mask <<= 1)) {}
723 // "wrap" bundle number into largest possible power of 2
728 if (bundle_number & mask) {
729 bundle_number &= ~mask;
732 s << default_name << " " << bundle_number + 1;
735 s << "+" << bundle_number + 2;
738 possible_name = s.str();
740 if ((c = _session.bundle_by_name (possible_name)) != 0) {
747 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
750 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
761 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
763 XMLProperty const * prop;
764 XMLNodeList children = node.children ();
766 uint32_t n_audio = 0;
768 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
770 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
771 n_audio = count (prop->value().begin(), prop->value().end(), '{');
772 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
774 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
775 n_audio = count (prop->value().begin(), prop->value().end(), '{');
776 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
782 cnt.set_audio (n_audio);
783 n = ChanCount::max (n, cnt);
789 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
791 if (version < 3000) {
792 return get_port_counts_2X (node, version, n, c);
795 XMLProperty const * prop;
796 XMLNodeConstIterator iter;
797 uint32_t n_audio = 0;
803 if ((prop = node.property ("connection")) != 0) {
805 if ((c = find_possible_bundle (prop->value())) != 0) {
806 n = ChanCount::max (n, c->nchannels());
811 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
813 if ((*iter)->name() == X_("Bundle")) {
814 if ((c = find_possible_bundle (prop->value())) != 0) {
815 n = ChanCount::max (n, c->nchannels());
822 if ((*iter)->name() == X_("Port")) {
823 prop = (*iter)->property (X_("type"));
829 if (prop->value() == X_("audio")) {
830 cnt.set_audio (++n_audio);
831 } else if (prop->value() == X_("midi")) {
832 cnt.set_midi (++n_midi);
837 n = ChanCount::max (n, cnt);
842 IO::create_ports (const XMLNode& node, int version)
845 boost::shared_ptr<Bundle> c;
847 get_port_counts (node, version, n, c);
850 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
852 if (ensure_ports (n, true, this)) {
853 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
864 IO::make_connections (const XMLNode& node, int version, bool in)
866 if (version < 3000) {
867 return make_connections_2X (node, version, in);
870 const XMLProperty* prop;
872 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
874 if ((*i)->name() == "Bundle") {
875 XMLProperty const * prop = (*i)->property ("name");
877 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
879 connect_ports_to_bundle (b, this);
886 if ((*i)->name() == "Port") {
888 prop = (*i)->property (X_("name"));
894 Port* p = port_by_name (prop->value());
897 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
899 XMLNode* cnode = (*c);
901 if (cnode->name() != X_("Connection")) {
905 if ((prop = cnode->property (X_("other"))) == 0) {
910 p->connect (prop->value());
922 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
924 const XMLProperty* prop;
926 /* XXX: bundles ("connections" as was) */
928 if ((prop = node.property ("inputs")) != 0 && in) {
930 string::size_type ostart = 0;
931 string::size_type start = 0;
932 string::size_type end = 0;
935 vector<string> ports;
937 string const str = prop->value ();
939 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
942 if ((end = str.find_first_of ('}', start)) == string::npos) {
943 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
947 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
948 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
955 for (int x = 0; x < n; ++x) {
956 /* XXX: this is a bit of a hack; need to check if it's always valid */
957 string::size_type const p = ports[x].find ("/out");
958 if (p != string::npos) {
959 ports[x].replace (p, 4, "/audio_out");
961 nth(i)->connect (ports[x]);
971 if ((prop = node.property ("outputs")) != 0 && !in) {
973 string::size_type ostart = 0;
974 string::size_type start = 0;
975 string::size_type end = 0;
978 vector<string> ports;
980 string const str = prop->value ();
982 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
985 if ((end = str.find_first_of ('}', start)) == string::npos) {
986 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
990 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
991 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
997 for (int x = 0; x < n; ++x) {
998 /* XXX: this is a bit of a hack; need to check if it's always valid */
999 string::size_type const p = ports[x].find ("/in");
1000 if (p != string::npos) {
1001 ports[x].replace (p, 3, "/audio_in");
1003 nth(i)->connect (ports[x]);
1016 IO::set_ports (const string& str)
1018 vector<string> ports;
1023 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1028 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1030 // FIXME: audio-only
1031 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1036 string::size_type start, end, ostart;
1043 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1046 if ((end = str.find_first_of ('}', start)) == string::npos) {
1047 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1051 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1052 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1058 for (int x = 0; x < n; ++x) {
1059 connect (nth (i), ports[x], this);
1071 IO::parse_io_string (const string& str, vector<string>& ports)
1073 string::size_type pos, opos;
1075 if (str.length() == 0) {
1084 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1085 ports.push_back (str.substr (opos, pos - opos));
1089 if (opos < str.length()) {
1090 ports.push_back (str.substr(opos));
1093 return ports.size();
1097 IO::parse_gain_string (const string& str, vector<string>& ports)
1099 string::size_type pos, opos;
1105 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1106 ports.push_back (str.substr (opos, pos - opos));
1110 if (opos < str.length()) {
1111 ports.push_back (str.substr(opos));
1114 return ports.size();
1118 IO::set_name (const string& requested_name)
1120 string name = requested_name;
1122 if (_name == name) {
1126 /* replace all colons in the name. i wish we didn't have to do this */
1128 replace_all (name, ":", "-");
1130 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1131 string current_name = i->name();
1132 current_name.replace (current_name.find (_name), _name.val().length(), name);
1133 i->set_name (current_name);
1136 bool const r = SessionObject::set_name (name);
1144 IO::set_port_latency (nframes_t nframes)
1146 Glib::Mutex::Lock lm (io_lock);
1148 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1149 i->set_latency (nframes);
1154 IO::latency () const
1156 nframes_t max_latency;
1161 /* io lock not taken - must be protected by other means */
1163 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1164 if ((latency = i->total_latency ()) > max_latency) {
1165 max_latency = latency;
1173 IO::update_port_total_latencies ()
1175 /* io_lock, not taken: function must be called from Session::process() calltree */
1177 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1178 _session.engine().update_total_latency (*i);
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::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, nframes_t nframes)
1536 /* don't read the data into new buffers - just use the port buffers directly */
1538 bufs.attach_buffers (_ports, nframes, 0);
1539 proc->run (bufs, start_frame, end_frame, nframes, true);
1543 IO::collect_input (BufferSet& bufs, nframes_t nframes, ChanCount offset)
1545 assert(bufs.available() >= _ports.count());
1547 if (_ports.count() == ChanCount::ZERO) {
1551 bufs.set_count (_ports.count());
1553 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1554 PortSet::iterator i = _ports.begin(*t);
1555 BufferSet::iterator b = bufs.begin(*t);
1557 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1558 if (b == bufs.end(*t)) {
1563 for ( ; i != _ports.end(*t); ++i, ++b) {
1564 Buffer& bb (i->get_buffer (nframes));
1565 b->read_from (bb, nframes);
1571 IO::copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes, nframes_t offset)
1573 // Copy any buffers 1:1 to outputs
1575 PortSet::iterator o = _ports.begin(type);
1576 BufferSet::iterator i = bufs.begin(type);
1577 BufferSet::iterator prev = i;
1579 while (i != bufs.end(type) && o != _ports.end (type)) {
1580 Buffer& port_buffer (o->get_buffer (nframes));
1581 port_buffer.read_from (*i, nframes, offset);
1587 // Copy last buffer to any extra outputs
1589 while (o != _ports.end(type)) {
1590 Buffer& port_buffer (o->get_buffer (nframes));
1591 port_buffer.read_from (*prev, nframes, offset);
1597 IO::port_by_name (const std::string& str) const
1599 /* to be called only from ::set_state() - no locking */
1601 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1605 if (p.name() == str) {
1606 return const_cast<Port*>(&p);
1614 IO::physically_connected () const
1616 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1617 if (i->physically_connected()) {