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 assert (!AudioEngine::instance()->process_lock().trylock());
164 if (other_port.length() == 0 || our_port == 0) {
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 */
190 _session.set_dirty ();
195 /** Caller must hold process lock */
197 IO::connect (Port* our_port, string other_port, void* src)
199 assert (!AudioEngine::instance()->process_lock().trylock());
201 if (other_port.length() == 0 || our_port == 0) {
206 Glib::Mutex::Lock lm (io_lock);
208 /* check that our_port is really one of ours */
210 if ( ! _ports.contains(our_port) ) {
214 /* connect it to the source */
216 if (our_port->connect (other_port)) {
221 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
222 _session.set_dirty ();
227 IO::remove_port (Port* port, void* src)
229 ChanCount before = _ports.count ();
230 ChanCount after = before;
231 after.set (port->type(), after.get (port->type()) - 1);
233 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
241 BLOCK_PROCESS_CALLBACK ();
244 Glib::Mutex::Lock lm (io_lock);
246 if (_ports.remove(port)) {
247 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
248 change.before = before;
249 change.after = _ports.count ();
251 if (port->connected()) {
252 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
255 _session.engine().unregister_port (*port);
256 check_bundles_connected ();
260 PortCountChanged (n_ports()); /* EMIT SIGNAL */
262 if (change.type != IOChange::NoChange) {
263 changed (change, src);
264 _session.set_dirty ();
268 if (change.type & IOChange::ConfigurationChanged) {
272 if (change.type == IOChange::NoChange) {
281 * @param destination Name of port to connect new port to.
282 * @param src Source for emitted ConfigurationChanged signal.
283 * @param type Data type of port. Default value (NIL) will use this IO's default type.
286 IO::add_port (string destination, void* src, DataType type)
290 if (type == DataType::NIL) {
291 type = _default_type;
297 BLOCK_PROCESS_CALLBACK ();
301 Glib::Mutex::Lock lm (io_lock);
303 /* Create a new port */
305 string portname = build_legal_port_name (type);
307 if (_direction == Input) {
308 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
309 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
313 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
314 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
319 change.before = _ports.count ();
320 _ports.add (our_port);
323 PortCountChanged (n_ports()); /* EMIT SIGNAL */
325 // pan_changed (src); /* EMIT SIGNAL */
326 change.type = IOChange::ConfigurationChanged;
327 change.after = _ports.count ();
328 changed (change, src); /* EMIT SIGNAL */
331 if (destination.length()) {
332 if (our_port->connect (destination)) {
338 _session.set_dirty ();
344 IO::disconnect (void* src)
346 BLOCK_PROCESS_CALLBACK ();
349 Glib::Mutex::Lock lm (io_lock);
351 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
352 i->disconnect_all ();
355 check_bundles_connected ();
358 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
363 /** Caller must hold process lock */
365 IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
367 assert (!AudioEngine::instance()->process_lock().trylock());
370 bool changed = false;
372 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
374 const size_t n = count.get(*t);
376 /* remove unused ports */
377 for (size_t i = n_ports().get(*t); i > n; --i) {
378 port = _ports.port(*t, i-1);
382 _session.engine().unregister_port (*port);
387 /* create any necessary new ports */
388 while (n_ports().get(*t) < n) {
390 string portname = build_legal_port_name (*t);
394 if (_direction == Input) {
395 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
396 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
400 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
401 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
407 catch (AudioEngine::PortRegistrationFailure& err) {
418 check_bundles_connected ();
419 PortCountChanged (n_ports()); /* EMIT SIGNAL */
420 _session.set_dirty ();
424 /* disconnect all existing ports so that we get a fresh start */
425 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
426 i->disconnect_all ();
433 /** Caller must hold process lock */
435 IO::ensure_ports (ChanCount count, bool clear, void* src)
437 assert (!AudioEngine::instance()->process_lock().trylock());
439 bool changed = false;
441 if (count == n_ports() && !clear) {
447 change.before = _ports.count ();
450 Glib::Mutex::Lock im (io_lock);
451 changed = ensure_ports_locked (count, clear, src);
455 change.after = _ports.count ();
456 change.type = IOChange::ConfigurationChanged;
457 this->changed (change, src); /* EMIT SIGNAL */
459 _session.set_dirty ();
465 /** Caller must hold process lock */
467 IO::ensure_io (ChanCount count, bool clear, void* src)
469 assert (!AudioEngine::instance()->process_lock().trylock());
471 return ensure_ports (count, clear, src);
481 IO::state (bool /*full_state*/)
483 XMLNode* node = new XMLNode (state_node_name);
486 vector<string>::iterator ci;
488 LocaleGuard lg (X_("POSIX"));
489 Glib::Mutex::Lock lm (io_lock);
491 node->add_property("name", _name);
492 id().print (buf, sizeof (buf));
493 node->add_property("id", buf);
494 node->add_property ("direction", enum_2_string (_direction));
495 node->add_property ("default-type", _default_type.to_string());
497 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
498 XMLNode* n = new XMLNode ("Bundle");
499 n->add_property ("name", (*i)->bundle->name ());
500 node->add_child_nocopy (*n);
503 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
505 vector<string> connections;
507 XMLNode* pnode = new XMLNode (X_("Port"));
508 pnode->add_property (X_("type"), i->type().to_string());
509 pnode->add_property (X_("name"), i->name());
511 if (i->get_connections (connections)) {
513 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
515 /* if its a connection to our own port,
516 return only the port name, not the
517 whole thing. this allows connections
518 to be re-established even when our
519 client name is different.
522 XMLNode* cnode = new XMLNode (X_("Connection"));
524 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
525 pnode->add_child_nocopy (*cnode);
529 node->add_child_nocopy (*pnode);
536 IO::set_state (const XMLNode& node, int version)
538 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
539 * are input OR output, not both, so the direction needs to be specified
542 assert (version >= 3000);
544 const XMLProperty* prop;
545 XMLNodeConstIterator iter;
546 LocaleGuard lg (X_("POSIX"));
548 /* force use of non-localized representation of decimal point,
549 since we use it a lot in XML files and so forth.
552 if (node.name() != state_node_name) {
553 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
557 if ((prop = node.property ("name")) != 0) {
558 set_name (prop->value());
561 if ((prop = node.property (X_("default-type"))) != 0) {
562 _default_type = DataType(prop->value());
563 assert(_default_type != DataType::NIL);
566 if ((prop = node.property ("id")) != 0) {
567 _id = prop->value ();
570 if ((prop = node.property ("direction")) != 0) {
571 _direction = (Direction) string_2_enum (prop->value(), _direction);
574 if (create_ports (node, version)) {
578 if (connecting_legal) {
580 if (make_connections (node, version, false)) {
586 pending_state_node = new XMLNode (node);
587 pending_state_node_version = version;
588 pending_state_node_in = false;
589 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
597 IO::set_state_2X (const XMLNode& node, int version, bool in)
599 const XMLProperty* prop;
600 XMLNodeConstIterator iter;
601 LocaleGuard lg (X_("POSIX"));
603 /* force use of non-localized representation of decimal point,
604 since we use it a lot in XML files and so forth.
607 if (node.name() != state_node_name) {
608 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
612 if ((prop = node.property ("name")) != 0) {
613 set_name (prop->value());
616 if ((prop = node.property (X_("default-type"))) != 0) {
617 _default_type = DataType(prop->value());
618 assert(_default_type != DataType::NIL);
621 if ((prop = node.property ("id")) != 0) {
622 _id = prop->value ();
625 _direction = in ? Input : Output;
627 if (create_ports (node, version)) {
631 if (connecting_legal) {
633 if (make_connections_2X (node, version, in)) {
639 pending_state_node = new XMLNode (node);
640 pending_state_node_version = version;
641 pending_state_node_in = in;
642 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
649 IO::connecting_became_legal ()
653 assert (pending_state_node);
655 connection_legal_c.disconnect ();
657 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
659 delete pending_state_node;
660 pending_state_node = 0;
665 boost::shared_ptr<Bundle>
666 IO::find_possible_bundle (const string &desired_name)
668 static const string digits = "0123456789";
669 const string &default_name = (_direction == Input ? _("in") : _("out"));
670 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
672 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
675 int bundle_number, mask;
676 string possible_name;
678 string::size_type last_non_digit_pos;
680 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
683 // find numeric suffix of desired name
686 last_non_digit_pos = desired_name.find_last_not_of(digits);
688 if (last_non_digit_pos != string::npos) {
690 s << desired_name.substr(last_non_digit_pos);
694 // see if it's a stereo connection e.g. "in 3+4"
696 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
697 string::size_type left_last_non_digit_pos;
699 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
701 if (left_last_non_digit_pos != string::npos) {
702 int left_bundle_number = 0;
704 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
705 s >> left_bundle_number;
707 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
718 // find highest set bit
720 while ((mask <= bundle_number) && (mask <<= 1)) {}
722 // "wrap" bundle number into largest possible power of 2
727 if (bundle_number & mask) {
728 bundle_number &= ~mask;
731 s << default_name << " " << bundle_number + 1;
734 s << "+" << bundle_number + 2;
737 possible_name = s.str();
739 if ((c = _session.bundle_by_name (possible_name)) != 0) {
746 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
749 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
760 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
762 XMLProperty const * prop;
763 XMLNodeList children = node.children ();
765 uint32_t n_audio = 0;
767 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
769 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
770 n_audio = count (prop->value().begin(), prop->value().end(), '{');
771 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
773 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
774 n_audio = count (prop->value().begin(), prop->value().end(), '{');
775 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
781 cnt.set_audio (n_audio);
782 n = ChanCount::max (n, cnt);
788 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
790 if (version < 3000) {
791 return get_port_counts_2X (node, version, n, c);
794 XMLProperty const * prop;
795 XMLNodeConstIterator iter;
796 uint32_t n_audio = 0;
802 if ((prop = node.property ("connection")) != 0) {
804 if ((c = find_possible_bundle (prop->value())) != 0) {
805 n = ChanCount::max (n, c->nchannels());
810 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
812 if ((*iter)->name() == X_("Bundle")) {
813 if ((c = find_possible_bundle (prop->value())) != 0) {
814 n = ChanCount::max (n, c->nchannels());
821 if ((*iter)->name() == X_("Port")) {
822 prop = (*iter)->property (X_("type"));
828 if (prop->value() == X_("audio")) {
829 cnt.set_audio (++n_audio);
830 } else if (prop->value() == X_("midi")) {
831 cnt.set_midi (++n_midi);
836 n = ChanCount::max (n, cnt);
841 IO::create_ports (const XMLNode& node, int version)
844 boost::shared_ptr<Bundle> c;
846 get_port_counts (node, version, n, c);
849 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
851 if (ensure_ports (n, true, this)) {
852 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
863 IO::make_connections (const XMLNode& node, int version, bool in)
865 if (version < 3000) {
866 return make_connections_2X (node, version, in);
869 const XMLProperty* prop;
871 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
873 if ((*i)->name() == "Bundle") {
874 XMLProperty const * prop = (*i)->property ("name");
876 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
878 connect_ports_to_bundle (b, this);
885 if ((*i)->name() == "Port") {
887 prop = (*i)->property (X_("name"));
893 Port* p = port_by_name (prop->value());
896 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
898 XMLNode* cnode = (*c);
900 if (cnode->name() != X_("Connection")) {
904 if ((prop = cnode->property (X_("other"))) == 0) {
909 p->connect (prop->value());
921 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
923 const XMLProperty* prop;
925 /* XXX: bundles ("connections" as was) */
927 if ((prop = node.property ("inputs")) != 0 && in) {
929 string::size_type ostart = 0;
930 string::size_type start = 0;
931 string::size_type end = 0;
934 vector<string> ports;
936 string const str = prop->value ();
938 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
941 if ((end = str.find_first_of ('}', start)) == string::npos) {
942 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
946 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
947 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
954 for (int x = 0; x < n; ++x) {
955 /* XXX: this is a bit of a hack; need to check if it's always valid */
956 string::size_type const p = ports[x].find ("/out");
957 if (p != string::npos) {
958 ports[x].replace (p, 4, "/audio_out");
960 nth(i)->connect (ports[x]);
970 if ((prop = node.property ("outputs")) != 0 && !in) {
972 string::size_type ostart = 0;
973 string::size_type start = 0;
974 string::size_type end = 0;
977 vector<string> ports;
979 string const str = prop->value ();
981 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
984 if ((end = str.find_first_of ('}', start)) == string::npos) {
985 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
989 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
990 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
996 for (int x = 0; x < n; ++x) {
997 /* XXX: this is a bit of a hack; need to check if it's always valid */
998 string::size_type const p = ports[x].find ("/in");
999 if (p != string::npos) {
1000 ports[x].replace (p, 3, "/audio_in");
1002 nth(i)->connect (ports[x]);
1015 IO::set_ports (const string& str)
1017 vector<string> ports;
1022 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1027 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1029 // FIXME: audio-only
1030 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1035 string::size_type start, end, ostart;
1042 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1045 if ((end = str.find_first_of ('}', start)) == string::npos) {
1046 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1050 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1051 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1057 for (int x = 0; x < n; ++x) {
1058 connect (nth (i), ports[x], this);
1070 IO::parse_io_string (const string& str, vector<string>& ports)
1072 string::size_type pos, opos;
1074 if (str.length() == 0) {
1083 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1084 ports.push_back (str.substr (opos, pos - opos));
1088 if (opos < str.length()) {
1089 ports.push_back (str.substr(opos));
1092 return ports.size();
1096 IO::parse_gain_string (const string& str, vector<string>& ports)
1098 string::size_type pos, opos;
1104 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1105 ports.push_back (str.substr (opos, pos - opos));
1109 if (opos < str.length()) {
1110 ports.push_back (str.substr(opos));
1113 return ports.size();
1117 IO::set_name (const string& requested_name)
1119 string name = requested_name;
1121 if (_name == name) {
1125 /* replace all colons in the name. i wish we didn't have to do this */
1127 replace_all (name, ":", "-");
1129 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1130 string current_name = i->name();
1131 current_name.replace (current_name.find (_name), _name.val().length(), name);
1132 i->set_name (current_name);
1135 bool const r = SessionObject::set_name (name);
1143 IO::set_port_latency (nframes_t nframes)
1145 Glib::Mutex::Lock lm (io_lock);
1147 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1148 i->set_latency (nframes);
1153 IO::latency () const
1155 nframes_t max_latency;
1160 /* io lock not taken - must be protected by other means */
1162 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1163 if ((latency = i->total_latency ()) > max_latency) {
1164 max_latency = latency;
1172 IO::update_port_total_latencies ()
1174 /* io_lock, not taken: function must be called from Session::process() calltree */
1176 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1177 _session.engine().update_total_latency (*i);
1182 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
1184 BLOCK_PROCESS_CALLBACK ();
1187 Glib::Mutex::Lock lm2 (io_lock);
1189 c->connect (_bundle, _session.engine());
1191 /* If this is a UserBundle, make a note of what we've done */
1193 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1196 /* See if we already know about this one */
1197 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1198 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1202 if (i == _bundles_connected.end()) {
1203 /* We don't, so make a note */
1204 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1209 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1214 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1216 BLOCK_PROCESS_CALLBACK ();
1219 Glib::Mutex::Lock lm2 (io_lock);
1221 c->disconnect (_bundle, _session.engine());
1223 /* If this is a UserBundle, make a note of what we've done */
1225 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1228 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1229 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1233 if (i != _bundles_connected.end()) {
1235 _bundles_connected.erase (i);
1240 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1246 IO::disable_connecting ()
1248 connecting_legal = false;
1253 IO::enable_connecting ()
1255 connecting_legal = true;
1256 boost::optional<int> r = ConnectingLegal ();
1257 return r.get_value_or (0);
1261 IO::bundle_changed (Bundle::Change /*c*/)
1264 // connect_input_ports_to_bundle (_input_bundle, this);
1269 IO::build_legal_port_name (DataType type)
1271 const int name_size = jack_port_name_size();
1275 if (type == DataType::AUDIO) {
1276 suffix = _("audio");
1277 } else if (type == DataType::MIDI) {
1280 throw unknown_type();
1283 /* note that if "in" or "out" are translated it will break a session
1284 across locale switches because a port's connection list will
1285 show (old) translated names, but the current port name will
1286 use the (new) translated name.
1289 if (_direction == Input) {
1290 suffix += X_("_in");
1292 suffix += X_("_out");
1295 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1297 limit = name_size - _session.engine().client_name().length() - (suffix.length() + 5);
1299 char buf1[name_size+1];
1300 char buf2[name_size+1];
1302 snprintf (buf1, name_size+1, ("%.*s/%s"), limit, _name.val().c_str(), suffix.c_str());
1304 int port_number = find_port_hole (buf1);
1305 snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
1307 return string (buf2);
1311 IO::find_port_hole (const char* base)
1313 /* CALLER MUST HOLD IO LOCK */
1317 if (_ports.empty()) {
1321 /* we only allow up to 4 characters for the port number
1324 for (n = 1; n < 9999; ++n) {
1325 char buf[jack_port_name_size()];
1326 PortSet::iterator i = _ports.begin();
1328 snprintf (buf, jack_port_name_size(), _("%s %u"), base, n);
1330 for ( ; i != _ports.end(); ++i) {
1331 if (i->name() == buf) {
1336 if (i == _ports.end()) {
1345 IO::audio(uint32_t n) const
1347 return _ports.nth_audio_port (n);
1352 IO::midi(uint32_t n) const
1354 return _ports.nth_midi_port (n);
1358 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1367 _bundle.reset (new Bundle (_direction == Input));
1370 _bundle->suspend_signals ();
1372 _bundle->remove_channels ();
1374 if (_direction == Input) {
1375 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1377 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1379 _bundle->set_name (buf);
1382 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1384 uint32_t const N = _ports.count().get (*i);
1385 for (uint32_t j = 0; j < N; ++j) {
1386 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1387 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1393 _bundle->resume_signals ();
1396 /** @return Bundles connected to our ports */
1398 IO::bundles_connected ()
1403 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1404 bundles.push_back ((*i)->bundle);
1407 /* Session bundles */
1408 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1409 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1410 if ((*i)->connected_to (_bundle, _session.engine())) {
1411 bundles.push_back (*i);
1417 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1419 if (_direction == Input) {
1420 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1421 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1422 bundles.push_back ((*i)->output()->bundle());
1426 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1427 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1428 bundles.push_back ((*i)->input()->bundle());
1437 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1440 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1444 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1448 if (t == DataType::AUDIO) {
1454 return c == 0 ? _("L") : _("R");
1456 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1462 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1471 IO::name_from_state (const XMLNode& node)
1473 const XMLProperty* prop;
1475 if ((prop = node.property ("name")) != 0) {
1476 return prop->value();
1483 IO::set_name_in_state (XMLNode& node, const string& new_name)
1485 const XMLProperty* prop;
1487 if ((prop = node.property ("name")) != 0) {
1488 node.add_property ("name", new_name);
1493 IO::connected () const
1495 /* do we have any connections at all? */
1497 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1498 if (p->connected()) {
1507 IO::connected_to (boost::shared_ptr<const IO> other) const
1510 return connected ();
1513 assert (_direction != other->direction());
1516 uint32_t no = n_ports().n_total();
1517 uint32_t ni = other->n_ports ().n_total();
1519 for (i = 0; i < no; ++i) {
1520 for (j = 0; j < ni; ++j) {
1521 if (nth(i)->connected_to (other->nth(j)->name())) {
1531 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, nframes_t nframes)
1535 /* don't read the data into new buffers - just use the port buffers directly */
1537 bufs.attach_buffers (_ports, nframes, 0);
1538 proc->run (bufs, start_frame, end_frame, nframes, true);
1542 IO::collect_input (BufferSet& bufs, nframes_t nframes, ChanCount offset)
1544 assert(bufs.available() >= _ports.count());
1546 if (_ports.count() == ChanCount::ZERO) {
1550 bufs.set_count (_ports.count());
1552 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1553 PortSet::iterator i = _ports.begin(*t);
1554 BufferSet::iterator b = bufs.begin(*t);
1556 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1557 if (b == bufs.end(*t)) {
1562 for ( ; i != _ports.end(*t); ++i, ++b) {
1563 Buffer& bb (i->get_buffer (nframes));
1564 b->read_from (bb, nframes);
1570 IO::copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes, nframes_t offset)
1572 // Copy any buffers 1:1 to outputs
1574 PortSet::iterator o = _ports.begin(type);
1575 BufferSet::iterator i = bufs.begin(type);
1576 BufferSet::iterator prev = i;
1578 while (i != bufs.end(type) && o != _ports.end (type)) {
1579 Buffer& port_buffer (o->get_buffer (nframes));
1580 port_buffer.read_from (*i, nframes, offset);
1586 // Copy last buffer to any extra outputs
1588 while (o != _ports.end(type)) {
1589 Buffer& port_buffer (o->get_buffer (nframes));
1590 port_buffer.read_from (*prev, nframes, offset);
1596 IO::port_by_name (const std::string& str) const
1598 /* to be called only from ::set_state() - no locking */
1600 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1604 if (p.name() == str) {
1605 return const_cast<Port*>(&p);
1613 IO::physically_connected () const
1615 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1616 if (i->physically_connected()) {