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::silence (framecnt_t nframes)
102 /* io_lock, not taken: function must be called from Session::process() calltree */
104 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
105 i->get_buffer(nframes).silence (nframes);
110 IO::check_bundles_connected ()
112 check_bundles (_bundles_connected, ports());
115 /** Check the bundles in list to see which are connected to a given PortSet,
116 * and update list with those that are connected such that every port on every
117 * bundle channel x is connected to port x in ports.
120 IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
122 std::vector<UserBundleInfo*> new_list;
124 for (std::vector<UserBundleInfo*>::iterator i = list.begin(); i != list.end(); ++i) {
126 uint32_t const N = (*i)->bundle->nchannels().n_total();
128 if (_ports.num_ports() < N) {
134 for (uint32_t j = 0; j < N; ++j) {
135 /* Every port on bundle channel j must be connected to our input j */
136 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
137 for (uint32_t k = 0; k < pl.size(); ++k) {
138 if (ports.port(j)->connected_to (pl[k]) == false) {
150 new_list.push_back (*i);
161 IO::disconnect (Port* our_port, string other_port, void* src)
163 if (other_port.length() == 0 || our_port == 0) {
168 Glib::Mutex::Lock lm (io_lock);
170 /* check that our_port is really one of ours */
172 if ( ! _ports.contains(our_port)) {
176 /* disconnect it from the source */
178 if (our_port->disconnect (other_port)) {
179 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
183 check_bundles_connected ();
186 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
188 _session.set_dirty ();
194 IO::connect (Port* our_port, string other_port, void* src)
196 if (other_port.length() == 0 || our_port == 0) {
201 Glib::Mutex::Lock lm (io_lock);
203 /* check that our_port is really one of ours */
205 if ( ! _ports.contains(our_port) ) {
209 /* connect it to the source */
211 if (our_port->connect (other_port)) {
216 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
217 _session.set_dirty ();
222 IO::remove_port (Port* port, void* src)
224 ChanCount before = _ports.count ();
225 ChanCount after = before;
226 after.set (port->type(), after.get (port->type()) - 1);
228 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
236 BLOCK_PROCESS_CALLBACK ();
239 Glib::Mutex::Lock lm (io_lock);
241 if (_ports.remove(port)) {
242 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
243 change.before = before;
244 change.after = _ports.count ();
246 if (port->connected()) {
247 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
250 _session.engine().unregister_port (*port);
251 check_bundles_connected ();
255 PortCountChanged (n_ports()); /* EMIT SIGNAL */
257 if (change.type != IOChange::NoChange) {
258 changed (change, src);
259 _session.set_dirty ();
263 if (change.type & IOChange::ConfigurationChanged) {
267 if (change.type == IOChange::NoChange) {
276 * @param destination Name of port to connect new port to.
277 * @param src Source for emitted ConfigurationChanged signal.
278 * @param type Data type of port. Default value (NIL) will use this IO's default type.
281 IO::add_port (string destination, void* src, DataType type)
285 if (type == DataType::NIL) {
286 type = _default_type;
292 BLOCK_PROCESS_CALLBACK ();
296 Glib::Mutex::Lock lm (io_lock);
298 /* Create a new port */
300 string portname = build_legal_port_name (type);
302 if (_direction == Input) {
303 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
304 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
308 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
309 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
314 change.before = _ports.count ();
315 _ports.add (our_port);
318 PortCountChanged (n_ports()); /* EMIT SIGNAL */
320 // pan_changed (src); /* EMIT SIGNAL */
321 change.type = IOChange::ConfigurationChanged;
322 change.after = _ports.count ();
323 changed (change, src); /* EMIT SIGNAL */
326 if (destination.length()) {
327 if (our_port->connect (destination)) {
333 _session.set_dirty ();
339 IO::disconnect (void* src)
342 Glib::Mutex::Lock lm (io_lock);
344 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
345 i->disconnect_all ();
348 check_bundles_connected ();
351 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
356 /** Caller must hold process lock */
358 IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
360 assert (!AudioEngine::instance()->process_lock().trylock());
363 bool changed = false;
365 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
367 const size_t n = count.get(*t);
369 /* remove unused ports */
370 for (size_t i = n_ports().get(*t); i > n; --i) {
371 port = _ports.port(*t, i-1);
375 _session.engine().unregister_port (*port);
380 /* create any necessary new ports */
381 while (n_ports().get(*t) < n) {
383 string portname = build_legal_port_name (*t);
387 if (_direction == Input) {
388 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
389 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
393 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
394 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
400 catch (AudioEngine::PortRegistrationFailure& err) {
411 check_bundles_connected ();
412 PortCountChanged (n_ports()); /* EMIT SIGNAL */
413 _session.set_dirty ();
417 /* disconnect all existing ports so that we get a fresh start */
418 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
419 i->disconnect_all ();
426 /** Caller must hold process lock */
428 IO::ensure_ports (ChanCount count, bool clear, void* src)
430 assert (!AudioEngine::instance()->process_lock().trylock());
432 bool changed = false;
434 if (count == n_ports() && !clear) {
440 change.before = _ports.count ();
443 Glib::Mutex::Lock im (io_lock);
444 changed = ensure_ports_locked (count, clear, src);
448 change.after = _ports.count ();
449 change.type = IOChange::ConfigurationChanged;
450 this->changed (change, src); /* EMIT SIGNAL */
451 _buffers.attach_buffers (_ports);
453 _session.set_dirty ();
459 /** Caller must hold process lock */
461 IO::ensure_io (ChanCount count, bool clear, void* src)
463 assert (!AudioEngine::instance()->process_lock().trylock());
465 return ensure_ports (count, clear, src);
475 IO::state (bool /*full_state*/)
477 XMLNode* node = new XMLNode (state_node_name);
480 vector<string>::iterator ci;
482 LocaleGuard lg (X_("POSIX"));
483 Glib::Mutex::Lock lm (io_lock);
485 node->add_property("name", _name);
486 id().print (buf, sizeof (buf));
487 node->add_property("id", buf);
488 node->add_property ("direction", enum_2_string (_direction));
489 node->add_property ("default-type", _default_type.to_string());
491 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
492 XMLNode* n = new XMLNode ("Bundle");
493 n->add_property ("name", (*i)->bundle->name ());
494 node->add_child_nocopy (*n);
497 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
499 vector<string> connections;
501 XMLNode* pnode = new XMLNode (X_("Port"));
502 pnode->add_property (X_("type"), i->type().to_string());
503 pnode->add_property (X_("name"), i->name());
505 if (i->get_connections (connections)) {
507 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
509 /* if its a connection to our own port,
510 return only the port name, not the
511 whole thing. this allows connections
512 to be re-established even when our
513 client name is different.
516 XMLNode* cnode = new XMLNode (X_("Connection"));
518 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
519 pnode->add_child_nocopy (*cnode);
523 node->add_child_nocopy (*pnode);
530 IO::set_state (const XMLNode& node, int version)
532 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
533 * are input OR output, not both, so the direction needs to be specified
536 assert (version >= 3000);
538 const XMLProperty* prop;
539 XMLNodeConstIterator iter;
540 LocaleGuard lg (X_("POSIX"));
542 /* force use of non-localized representation of decimal point,
543 since we use it a lot in XML files and so forth.
546 if (node.name() != state_node_name) {
547 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
551 if ((prop = node.property ("name")) != 0) {
552 set_name (prop->value());
555 if ((prop = node.property (X_("default-type"))) != 0) {
556 _default_type = DataType(prop->value());
557 assert(_default_type != DataType::NIL);
560 if ((prop = node.property ("id")) != 0) {
561 _id = prop->value ();
564 if ((prop = node.property ("direction")) != 0) {
565 _direction = (Direction) string_2_enum (prop->value(), _direction);
568 if (create_ports (node, version)) {
572 if (connecting_legal) {
574 if (make_connections (node, version, false)) {
580 pending_state_node = new XMLNode (node);
581 pending_state_node_version = version;
582 pending_state_node_in = false;
583 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
591 IO::set_state_2X (const XMLNode& node, int version, bool in)
593 const XMLProperty* prop;
594 XMLNodeConstIterator iter;
595 LocaleGuard lg (X_("POSIX"));
597 /* force use of non-localized representation of decimal point,
598 since we use it a lot in XML files and so forth.
601 if (node.name() != state_node_name) {
602 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
606 if ((prop = node.property ("name")) != 0) {
607 set_name (prop->value());
610 if ((prop = node.property (X_("default-type"))) != 0) {
611 _default_type = DataType(prop->value());
612 assert(_default_type != DataType::NIL);
615 if ((prop = node.property ("id")) != 0) {
616 _id = prop->value ();
619 _direction = in ? Input : Output;
621 if (create_ports (node, version)) {
625 if (connecting_legal) {
627 if (make_connections_2X (node, version, in)) {
633 pending_state_node = new XMLNode (node);
634 pending_state_node_version = version;
635 pending_state_node_in = in;
636 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
643 IO::connecting_became_legal ()
647 assert (pending_state_node);
649 connection_legal_c.disconnect ();
651 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
653 delete pending_state_node;
654 pending_state_node = 0;
659 boost::shared_ptr<Bundle>
660 IO::find_possible_bundle (const string &desired_name)
662 static const string digits = "0123456789";
663 const string &default_name = (_direction == Input ? _("in") : _("out"));
664 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
666 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
669 int bundle_number, mask;
670 string possible_name;
672 string::size_type last_non_digit_pos;
674 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
677 // find numeric suffix of desired name
680 last_non_digit_pos = desired_name.find_last_not_of(digits);
682 if (last_non_digit_pos != string::npos) {
684 s << desired_name.substr(last_non_digit_pos);
688 // see if it's a stereo connection e.g. "in 3+4"
690 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
691 string::size_type left_last_non_digit_pos;
693 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
695 if (left_last_non_digit_pos != string::npos) {
696 int left_bundle_number = 0;
698 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
699 s >> left_bundle_number;
701 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
712 // find highest set bit
714 while ((mask <= bundle_number) && (mask <<= 1)) {}
716 // "wrap" bundle number into largest possible power of 2
721 if (bundle_number & mask) {
722 bundle_number &= ~mask;
725 s << default_name << " " << bundle_number + 1;
728 s << "+" << bundle_number + 2;
731 possible_name = s.str();
733 if ((c = _session.bundle_by_name (possible_name)) != 0) {
740 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
743 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
754 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
756 XMLProperty const * prop;
757 XMLNodeList children = node.children ();
759 uint32_t n_audio = 0;
761 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
763 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
764 n_audio = count (prop->value().begin(), prop->value().end(), '{');
765 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
767 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
768 n_audio = count (prop->value().begin(), prop->value().end(), '{');
769 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
775 cnt.set_audio (n_audio);
776 n = ChanCount::max (n, cnt);
782 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
784 if (version < 3000) {
785 return get_port_counts_2X (node, version, n, c);
788 XMLProperty const * prop;
789 XMLNodeConstIterator iter;
790 uint32_t n_audio = 0;
796 if ((prop = node.property ("connection")) != 0) {
798 if ((c = find_possible_bundle (prop->value())) != 0) {
799 n = ChanCount::max (n, c->nchannels());
804 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
806 if ((*iter)->name() == X_("Bundle")) {
807 if ((c = find_possible_bundle (prop->value())) != 0) {
808 n = ChanCount::max (n, c->nchannels());
815 if ((*iter)->name() == X_("Port")) {
816 prop = (*iter)->property (X_("type"));
822 if (prop->value() == X_("audio")) {
823 cnt.set_audio (++n_audio);
824 } else if (prop->value() == X_("midi")) {
825 cnt.set_midi (++n_midi);
830 n = ChanCount::max (n, cnt);
835 IO::create_ports (const XMLNode& node, int version)
838 boost::shared_ptr<Bundle> c;
840 get_port_counts (node, version, n, c);
843 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
845 if (ensure_ports (n, true, this)) {
846 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
857 IO::make_connections (const XMLNode& node, int version, bool in)
859 if (version < 3000) {
860 return make_connections_2X (node, version, in);
863 const XMLProperty* prop;
865 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
867 if ((*i)->name() == "Bundle") {
868 XMLProperty const * prop = (*i)->property ("name");
870 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
872 connect_ports_to_bundle (b, this);
879 if ((*i)->name() == "Port") {
881 prop = (*i)->property (X_("name"));
887 Port* p = port_by_name (prop->value());
890 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
892 XMLNode* cnode = (*c);
894 if (cnode->name() != X_("Connection")) {
898 if ((prop = cnode->property (X_("other"))) == 0) {
903 p->connect (prop->value());
915 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
917 const XMLProperty* prop;
919 /* XXX: bundles ("connections" as was) */
921 if ((prop = node.property ("inputs")) != 0 && in) {
923 string::size_type ostart = 0;
924 string::size_type start = 0;
925 string::size_type end = 0;
928 vector<string> ports;
930 string const str = prop->value ();
932 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
935 if ((end = str.find_first_of ('}', start)) == string::npos) {
936 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
940 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
941 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
948 for (int x = 0; x < n; ++x) {
949 /* XXX: this is a bit of a hack; need to check if it's always valid */
950 string::size_type const p = ports[x].find ("/out");
951 if (p != string::npos) {
952 ports[x].replace (p, 4, "/audio_out");
954 nth(i)->connect (ports[x]);
964 if ((prop = node.property ("outputs")) != 0 && !in) {
966 string::size_type ostart = 0;
967 string::size_type start = 0;
968 string::size_type end = 0;
971 vector<string> ports;
973 string const str = prop->value ();
975 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
978 if ((end = str.find_first_of ('}', start)) == string::npos) {
979 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
983 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
984 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
990 for (int x = 0; x < n; ++x) {
991 /* XXX: this is a bit of a hack; need to check if it's always valid */
992 string::size_type const p = ports[x].find ("/in");
993 if (p != string::npos) {
994 ports[x].replace (p, 3, "/audio_in");
996 nth(i)->connect (ports[x]);
1009 IO::set_ports (const string& str)
1011 vector<string> ports;
1016 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1021 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1023 // FIXME: audio-only
1024 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1029 string::size_type start, end, ostart;
1036 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1039 if ((end = str.find_first_of ('}', start)) == string::npos) {
1040 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1044 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1045 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1051 for (int x = 0; x < n; ++x) {
1052 connect (nth (i), ports[x], this);
1064 IO::parse_io_string (const string& str, vector<string>& ports)
1066 string::size_type pos, opos;
1068 if (str.length() == 0) {
1077 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1078 ports.push_back (str.substr (opos, pos - opos));
1082 if (opos < str.length()) {
1083 ports.push_back (str.substr(opos));
1086 return ports.size();
1090 IO::parse_gain_string (const string& str, vector<string>& ports)
1092 string::size_type pos, opos;
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::set_name (const string& requested_name)
1113 string name = requested_name;
1115 if (_name == name) {
1119 /* replace all colons in the name. i wish we didn't have to do this */
1121 replace_all (name, ":", "-");
1123 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1124 string current_name = i->name();
1125 current_name.replace (current_name.find (_name), _name.val().length(), name);
1126 i->set_name (current_name);
1129 bool const r = SessionObject::set_name (name);
1137 IO::set_port_latency (framecnt_t nframes)
1139 Glib::Mutex::Lock lm (io_lock);
1141 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1142 i->set_latency (nframes);
1147 IO::latency () const
1149 framecnt_t max_latency;
1154 /* io lock not taken - must be protected by other means */
1156 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1157 if ((latency = i->total_latency ()) > max_latency) {
1158 max_latency = latency;
1162 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max latency from %2 ports = %3\n",
1163 name(), _ports.num_ports(), max_latency));
1168 IO::update_port_total_latencies ()
1170 /* io_lock, not taken: function must be called from Session::process() calltree */
1172 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1173 _session.engine().update_total_latency (*i);
1178 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
1180 BLOCK_PROCESS_CALLBACK ();
1183 Glib::Mutex::Lock lm2 (io_lock);
1185 c->connect (_bundle, _session.engine());
1187 /* If this is a UserBundle, make a note of what we've done */
1189 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1192 /* See if we already know about this one */
1193 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1194 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1198 if (i == _bundles_connected.end()) {
1199 /* We don't, so make a note */
1200 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1205 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1210 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1212 BLOCK_PROCESS_CALLBACK ();
1215 Glib::Mutex::Lock lm2 (io_lock);
1217 c->disconnect (_bundle, _session.engine());
1219 /* If this is a UserBundle, make a note of what we've done */
1221 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1224 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1225 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1229 if (i != _bundles_connected.end()) {
1231 _bundles_connected.erase (i);
1236 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1242 IO::disable_connecting ()
1244 connecting_legal = false;
1249 IO::enable_connecting ()
1251 connecting_legal = true;
1252 boost::optional<int> r = ConnectingLegal ();
1253 return r.get_value_or (0);
1257 IO::bundle_changed (Bundle::Change /*c*/)
1260 // connect_input_ports_to_bundle (_input_bundle, this);
1265 IO::build_legal_port_name (DataType type)
1267 const int name_size = jack_port_name_size();
1271 if (type == DataType::AUDIO) {
1272 suffix = _("audio");
1273 } else if (type == DataType::MIDI) {
1276 throw unknown_type();
1279 /* note that if "in" or "out" are translated it will break a session
1280 across locale switches because a port's connection list will
1281 show (old) translated names, but the current port name will
1282 use the (new) translated name.
1285 if (_direction == Input) {
1286 suffix += X_("_in");
1288 suffix += X_("_out");
1291 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1293 limit = name_size - _session.engine().client_name().length() - (suffix.length() + 5);
1295 char buf1[name_size+1];
1296 char buf2[name_size+1];
1298 snprintf (buf1, name_size+1, ("%.*s/%s"), limit, _name.val().c_str(), suffix.c_str());
1300 int port_number = find_port_hole (buf1);
1301 snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
1303 return string (buf2);
1307 IO::find_port_hole (const char* base)
1309 /* CALLER MUST HOLD IO LOCK */
1313 if (_ports.empty()) {
1317 /* we only allow up to 4 characters for the port number
1320 for (n = 1; n < 9999; ++n) {
1321 char buf[jack_port_name_size()];
1322 PortSet::iterator i = _ports.begin();
1324 snprintf (buf, jack_port_name_size(), _("%s %u"), base, n);
1326 for ( ; i != _ports.end(); ++i) {
1327 if (i->name() == buf) {
1332 if (i == _ports.end()) {
1341 IO::audio(uint32_t n) const
1343 return _ports.nth_audio_port (n);
1348 IO::midi(uint32_t n) const
1350 return _ports.nth_midi_port (n);
1354 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1363 _bundle.reset (new Bundle (_direction == Input));
1366 _bundle->suspend_signals ();
1368 _bundle->remove_channels ();
1370 if (_direction == Input) {
1371 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1373 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1375 _bundle->set_name (buf);
1378 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1380 uint32_t const N = _ports.count().get (*i);
1381 for (uint32_t j = 0; j < N; ++j) {
1382 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1383 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1389 _bundle->resume_signals ();
1392 /** @return Bundles connected to our ports */
1394 IO::bundles_connected ()
1399 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1400 bundles.push_back ((*i)->bundle);
1403 /* Session bundles */
1404 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1405 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1406 if ((*i)->connected_to (_bundle, _session.engine())) {
1407 bundles.push_back (*i);
1413 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1415 if (_direction == Input) {
1416 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1417 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1418 bundles.push_back ((*i)->output()->bundle());
1422 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1423 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1424 bundles.push_back ((*i)->input()->bundle());
1433 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1436 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1440 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1444 if (t == DataType::AUDIO) {
1450 return c == 0 ? _("L") : _("R");
1452 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1458 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1467 IO::name_from_state (const XMLNode& node)
1469 const XMLProperty* prop;
1471 if ((prop = node.property ("name")) != 0) {
1472 return prop->value();
1479 IO::set_name_in_state (XMLNode& node, const string& new_name)
1481 const XMLProperty* prop;
1483 if ((prop = node.property ("name")) != 0) {
1484 node.add_property ("name", new_name);
1489 IO::connected () const
1491 /* do we have any connections at all? */
1493 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1494 if (p->connected()) {
1503 IO::connected_to (boost::shared_ptr<const IO> other) const
1506 return connected ();
1509 assert (_direction != other->direction());
1512 uint32_t no = n_ports().n_total();
1513 uint32_t ni = other->n_ports ().n_total();
1515 for (i = 0; i < no; ++i) {
1516 for (j = 0; j < ni; ++j) {
1517 if (nth(i)->connected_to (other->nth(j)->name())) {
1527 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
1529 /* don't read the data into new buffers - just use the port buffers directly */
1531 _buffers.get_jack_port_addresses (_ports, nframes);
1532 proc->run (_buffers, start_frame, end_frame, nframes, true);
1536 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1538 assert(bufs.available() >= _ports.count());
1540 if (_ports.count() == ChanCount::ZERO) {
1544 bufs.set_count (_ports.count());
1546 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1547 PortSet::iterator i = _ports.begin(*t);
1548 BufferSet::iterator b = bufs.begin(*t);
1550 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1551 if (b == bufs.end(*t)) {
1556 for ( ; i != _ports.end(*t); ++i, ++b) {
1557 Buffer& bb (i->get_buffer (nframes));
1558 b->read_from (bb, nframes);
1564 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1566 // Copy any buffers 1:1 to outputs
1568 PortSet::iterator o = _ports.begin(type);
1569 BufferSet::iterator i = bufs.begin(type);
1570 BufferSet::iterator prev = i;
1572 while (i != bufs.end(type) && o != _ports.end (type)) {
1573 Buffer& port_buffer (o->get_buffer (nframes));
1574 port_buffer.read_from (*i, nframes, offset);
1580 // Copy last buffer to any extra outputs
1582 while (o != _ports.end(type)) {
1583 Buffer& port_buffer (o->get_buffer (nframes));
1584 port_buffer.read_from (*prev, nframes, offset);
1590 IO::port_by_name (const std::string& str) const
1592 /* to be called only from ::set_state() - no locking */
1594 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1598 if (p.name() == str) {
1599 return const_cast<Port*>(&p);
1607 IO::physically_connected () const
1609 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1610 if (i->physically_connected()) {
1619 IO::has_port (Port* p) const
1621 Glib::Mutex::Lock lm (io_lock);
1622 return _ports.contains (p);