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 (framecnt_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 Glib::Mutex::Lock lm (io_lock);
169 /* check that our_port is really one of ours */
171 if ( ! _ports.contains(our_port)) {
175 /* disconnect it from the source */
177 if (our_port->disconnect (other_port)) {
178 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
182 check_bundles_connected ();
185 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
187 _session.set_dirty ();
193 IO::connect (Port* our_port, string other_port, void* src)
195 if (other_port.length() == 0 || our_port == 0) {
200 Glib::Mutex::Lock lm (io_lock);
202 /* check that our_port is really one of ours */
204 if ( ! _ports.contains(our_port) ) {
208 /* connect it to the source */
210 if (our_port->connect (other_port)) {
215 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
216 _session.set_dirty ();
221 IO::remove_port (Port* port, void* src)
223 ChanCount before = _ports.count ();
224 ChanCount after = before;
225 after.set (port->type(), after.get (port->type()) - 1);
227 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
235 BLOCK_PROCESS_CALLBACK ();
238 Glib::Mutex::Lock lm (io_lock);
240 if (_ports.remove(port)) {
241 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
242 change.before = before;
243 change.after = _ports.count ();
245 if (port->connected()) {
246 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
249 _session.engine().unregister_port (*port);
250 check_bundles_connected ();
254 PortCountChanged (n_ports()); /* EMIT SIGNAL */
256 if (change.type != IOChange::NoChange) {
257 changed (change, src);
258 _session.set_dirty ();
262 if (change.type & IOChange::ConfigurationChanged) {
266 if (change.type == IOChange::NoChange) {
275 * @param destination Name of port to connect new port to.
276 * @param src Source for emitted ConfigurationChanged signal.
277 * @param type Data type of port. Default value (NIL) will use this IO's default type.
280 IO::add_port (string destination, void* src, DataType type)
284 if (type == DataType::NIL) {
285 type = _default_type;
291 BLOCK_PROCESS_CALLBACK ();
295 Glib::Mutex::Lock lm (io_lock);
297 /* Create a new port */
299 string portname = build_legal_port_name (type);
301 if (_direction == Input) {
302 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
303 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
307 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
308 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
313 change.before = _ports.count ();
314 _ports.add (our_port);
317 PortCountChanged (n_ports()); /* EMIT SIGNAL */
319 // pan_changed (src); /* EMIT SIGNAL */
320 change.type = IOChange::ConfigurationChanged;
321 change.after = _ports.count ();
322 changed (change, src); /* EMIT SIGNAL */
325 if (destination.length()) {
326 if (our_port->connect (destination)) {
332 _session.set_dirty ();
338 IO::disconnect (void* src)
341 Glib::Mutex::Lock lm (io_lock);
343 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
344 i->disconnect_all ();
347 check_bundles_connected ();
350 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
355 /** Caller must hold process lock */
357 IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
359 assert (!AudioEngine::instance()->process_lock().trylock());
362 bool changed = false;
364 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
366 const size_t n = count.get(*t);
368 /* remove unused ports */
369 for (size_t i = n_ports().get(*t); i > n; --i) {
370 port = _ports.port(*t, i-1);
374 _session.engine().unregister_port (*port);
379 /* create any necessary new ports */
380 while (n_ports().get(*t) < n) {
382 string portname = build_legal_port_name (*t);
386 if (_direction == Input) {
387 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
388 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
392 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
393 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
399 catch (AudioEngine::PortRegistrationFailure& err) {
410 check_bundles_connected ();
411 PortCountChanged (n_ports()); /* EMIT SIGNAL */
412 _session.set_dirty ();
416 /* disconnect all existing ports so that we get a fresh start */
417 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
418 i->disconnect_all ();
425 /** Caller must hold process lock */
427 IO::ensure_ports (ChanCount count, bool clear, void* src)
429 assert (!AudioEngine::instance()->process_lock().trylock());
431 bool changed = false;
433 if (count == n_ports() && !clear) {
439 change.before = _ports.count ();
442 Glib::Mutex::Lock im (io_lock);
443 changed = ensure_ports_locked (count, clear, src);
447 change.after = _ports.count ();
448 change.type = IOChange::ConfigurationChanged;
449 this->changed (change, src); /* EMIT SIGNAL */
451 _session.set_dirty ();
457 /** Caller must hold process lock */
459 IO::ensure_io (ChanCount count, bool clear, void* src)
461 assert (!AudioEngine::instance()->process_lock().trylock());
463 return ensure_ports (count, clear, src);
473 IO::state (bool /*full_state*/)
475 XMLNode* node = new XMLNode (state_node_name);
478 vector<string>::iterator ci;
480 LocaleGuard lg (X_("POSIX"));
481 Glib::Mutex::Lock lm (io_lock);
483 node->add_property("name", _name);
484 id().print (buf, sizeof (buf));
485 node->add_property("id", buf);
486 node->add_property ("direction", enum_2_string (_direction));
487 node->add_property ("default-type", _default_type.to_string());
489 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
490 XMLNode* n = new XMLNode ("Bundle");
491 n->add_property ("name", (*i)->bundle->name ());
492 node->add_child_nocopy (*n);
495 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
497 vector<string> connections;
499 XMLNode* pnode = new XMLNode (X_("Port"));
500 pnode->add_property (X_("type"), i->type().to_string());
501 pnode->add_property (X_("name"), i->name());
503 if (i->get_connections (connections)) {
505 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
507 /* if its a connection to our own port,
508 return only the port name, not the
509 whole thing. this allows connections
510 to be re-established even when our
511 client name is different.
514 XMLNode* cnode = new XMLNode (X_("Connection"));
516 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
517 pnode->add_child_nocopy (*cnode);
521 node->add_child_nocopy (*pnode);
528 IO::set_state (const XMLNode& node, int version)
530 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
531 * are input OR output, not both, so the direction needs to be specified
534 assert (version >= 3000);
536 const XMLProperty* prop;
537 XMLNodeConstIterator iter;
538 LocaleGuard lg (X_("POSIX"));
540 /* force use of non-localized representation of decimal point,
541 since we use it a lot in XML files and so forth.
544 if (node.name() != state_node_name) {
545 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
549 if ((prop = node.property ("name")) != 0) {
550 set_name (prop->value());
553 if ((prop = node.property (X_("default-type"))) != 0) {
554 _default_type = DataType(prop->value());
555 assert(_default_type != DataType::NIL);
558 if ((prop = node.property ("id")) != 0) {
559 _id = prop->value ();
562 if ((prop = node.property ("direction")) != 0) {
563 _direction = (Direction) string_2_enum (prop->value(), _direction);
566 if (create_ports (node, version)) {
570 if (connecting_legal) {
572 if (make_connections (node, version, false)) {
578 pending_state_node = new XMLNode (node);
579 pending_state_node_version = version;
580 pending_state_node_in = false;
581 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
589 IO::set_state_2X (const XMLNode& node, int version, bool in)
591 const XMLProperty* prop;
592 XMLNodeConstIterator iter;
593 LocaleGuard lg (X_("POSIX"));
595 /* force use of non-localized representation of decimal point,
596 since we use it a lot in XML files and so forth.
599 if (node.name() != state_node_name) {
600 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
604 if ((prop = node.property ("name")) != 0) {
605 set_name (prop->value());
608 if ((prop = node.property (X_("default-type"))) != 0) {
609 _default_type = DataType(prop->value());
610 assert(_default_type != DataType::NIL);
613 if ((prop = node.property ("id")) != 0) {
614 _id = prop->value ();
617 _direction = in ? Input : Output;
619 if (create_ports (node, version)) {
623 if (connecting_legal) {
625 if (make_connections_2X (node, version, in)) {
631 pending_state_node = new XMLNode (node);
632 pending_state_node_version = version;
633 pending_state_node_in = in;
634 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
641 IO::connecting_became_legal ()
645 assert (pending_state_node);
647 connection_legal_c.disconnect ();
649 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
651 delete pending_state_node;
652 pending_state_node = 0;
657 boost::shared_ptr<Bundle>
658 IO::find_possible_bundle (const string &desired_name)
660 static const string digits = "0123456789";
661 const string &default_name = (_direction == Input ? _("in") : _("out"));
662 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
664 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
667 int bundle_number, mask;
668 string possible_name;
670 string::size_type last_non_digit_pos;
672 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
675 // find numeric suffix of desired name
678 last_non_digit_pos = desired_name.find_last_not_of(digits);
680 if (last_non_digit_pos != string::npos) {
682 s << desired_name.substr(last_non_digit_pos);
686 // see if it's a stereo connection e.g. "in 3+4"
688 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
689 string::size_type left_last_non_digit_pos;
691 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
693 if (left_last_non_digit_pos != string::npos) {
694 int left_bundle_number = 0;
696 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
697 s >> left_bundle_number;
699 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
710 // find highest set bit
712 while ((mask <= bundle_number) && (mask <<= 1)) {}
714 // "wrap" bundle number into largest possible power of 2
719 if (bundle_number & mask) {
720 bundle_number &= ~mask;
723 s << default_name << " " << bundle_number + 1;
726 s << "+" << bundle_number + 2;
729 possible_name = s.str();
731 if ((c = _session.bundle_by_name (possible_name)) != 0) {
738 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
741 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
752 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
754 XMLProperty const * prop;
755 XMLNodeList children = node.children ();
757 uint32_t n_audio = 0;
759 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
761 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
762 n_audio = count (prop->value().begin(), prop->value().end(), '{');
763 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
765 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
766 n_audio = count (prop->value().begin(), prop->value().end(), '{');
767 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
773 cnt.set_audio (n_audio);
774 n = ChanCount::max (n, cnt);
780 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
782 if (version < 3000) {
783 return get_port_counts_2X (node, version, n, c);
786 XMLProperty const * prop;
787 XMLNodeConstIterator iter;
788 uint32_t n_audio = 0;
794 if ((prop = node.property ("connection")) != 0) {
796 if ((c = find_possible_bundle (prop->value())) != 0) {
797 n = ChanCount::max (n, c->nchannels());
802 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
804 if ((*iter)->name() == X_("Bundle")) {
805 if ((c = find_possible_bundle (prop->value())) != 0) {
806 n = ChanCount::max (n, c->nchannels());
813 if ((*iter)->name() == X_("Port")) {
814 prop = (*iter)->property (X_("type"));
820 if (prop->value() == X_("audio")) {
821 cnt.set_audio (++n_audio);
822 } else if (prop->value() == X_("midi")) {
823 cnt.set_midi (++n_midi);
828 n = ChanCount::max (n, cnt);
833 IO::create_ports (const XMLNode& node, int version)
836 boost::shared_ptr<Bundle> c;
838 get_port_counts (node, version, n, c);
841 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
843 if (ensure_ports (n, true, this)) {
844 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
855 IO::make_connections (const XMLNode& node, int version, bool in)
857 if (version < 3000) {
858 return make_connections_2X (node, version, in);
861 const XMLProperty* prop;
863 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
865 if ((*i)->name() == "Bundle") {
866 XMLProperty const * prop = (*i)->property ("name");
868 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
870 connect_ports_to_bundle (b, this);
877 if ((*i)->name() == "Port") {
879 prop = (*i)->property (X_("name"));
885 Port* p = port_by_name (prop->value());
888 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
890 XMLNode* cnode = (*c);
892 if (cnode->name() != X_("Connection")) {
896 if ((prop = cnode->property (X_("other"))) == 0) {
901 p->connect (prop->value());
913 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
915 const XMLProperty* prop;
917 /* XXX: bundles ("connections" as was) */
919 if ((prop = node.property ("inputs")) != 0 && in) {
921 string::size_type ostart = 0;
922 string::size_type start = 0;
923 string::size_type end = 0;
926 vector<string> ports;
928 string const str = prop->value ();
930 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
933 if ((end = str.find_first_of ('}', start)) == string::npos) {
934 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
938 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
939 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
946 for (int x = 0; x < n; ++x) {
947 /* XXX: this is a bit of a hack; need to check if it's always valid */
948 string::size_type const p = ports[x].find ("/out");
949 if (p != string::npos) {
950 ports[x].replace (p, 4, "/audio_out");
952 nth(i)->connect (ports[x]);
962 if ((prop = node.property ("outputs")) != 0 && !in) {
964 string::size_type ostart = 0;
965 string::size_type start = 0;
966 string::size_type end = 0;
969 vector<string> ports;
971 string const str = prop->value ();
973 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
976 if ((end = str.find_first_of ('}', start)) == string::npos) {
977 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
981 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
982 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
988 for (int x = 0; x < n; ++x) {
989 /* XXX: this is a bit of a hack; need to check if it's always valid */
990 string::size_type const p = ports[x].find ("/in");
991 if (p != string::npos) {
992 ports[x].replace (p, 3, "/audio_in");
994 nth(i)->connect (ports[x]);
1007 IO::set_ports (const string& str)
1009 vector<string> ports;
1014 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1019 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1021 // FIXME: audio-only
1022 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1027 string::size_type start, end, ostart;
1034 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1037 if ((end = str.find_first_of ('}', start)) == string::npos) {
1038 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1042 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1043 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1049 for (int x = 0; x < n; ++x) {
1050 connect (nth (i), ports[x], this);
1062 IO::parse_io_string (const string& str, vector<string>& ports)
1064 string::size_type pos, opos;
1066 if (str.length() == 0) {
1075 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1076 ports.push_back (str.substr (opos, pos - opos));
1080 if (opos < str.length()) {
1081 ports.push_back (str.substr(opos));
1084 return ports.size();
1088 IO::parse_gain_string (const string& str, vector<string>& ports)
1090 string::size_type pos, opos;
1096 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1097 ports.push_back (str.substr (opos, pos - opos));
1101 if (opos < str.length()) {
1102 ports.push_back (str.substr(opos));
1105 return ports.size();
1109 IO::set_name (const string& requested_name)
1111 string name = requested_name;
1113 if (_name == name) {
1117 /* replace all colons in the name. i wish we didn't have to do this */
1119 replace_all (name, ":", "-");
1121 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1122 string current_name = i->name();
1123 current_name.replace (current_name.find (_name), _name.val().length(), name);
1124 i->set_name (current_name);
1127 bool const r = SessionObject::set_name (name);
1135 IO::set_port_latency (framecnt_t nframes)
1137 Glib::Mutex::Lock lm (io_lock);
1139 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1140 i->set_latency (nframes);
1145 IO::latency () const
1147 framecnt_t max_latency;
1152 /* io lock not taken - must be protected by other means */
1154 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1155 if ((latency = i->total_latency ()) > max_latency) {
1156 max_latency = latency;
1164 IO::update_port_total_latencies ()
1166 /* io_lock, not taken: function must be called from Session::process() calltree */
1168 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1169 _session.engine().update_total_latency (*i);
1174 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
1176 BLOCK_PROCESS_CALLBACK ();
1179 Glib::Mutex::Lock lm2 (io_lock);
1181 c->connect (_bundle, _session.engine());
1183 /* If this is a UserBundle, make a note of what we've done */
1185 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1188 /* See if we already know about this one */
1189 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1190 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1194 if (i == _bundles_connected.end()) {
1195 /* We don't, so make a note */
1196 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1201 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1206 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1208 BLOCK_PROCESS_CALLBACK ();
1211 Glib::Mutex::Lock lm2 (io_lock);
1213 c->disconnect (_bundle, _session.engine());
1215 /* If this is a UserBundle, make a note of what we've done */
1217 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1220 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1221 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1225 if (i != _bundles_connected.end()) {
1227 _bundles_connected.erase (i);
1232 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1238 IO::disable_connecting ()
1240 connecting_legal = false;
1245 IO::enable_connecting ()
1247 connecting_legal = true;
1248 boost::optional<int> r = ConnectingLegal ();
1249 return r.get_value_or (0);
1253 IO::bundle_changed (Bundle::Change /*c*/)
1256 // connect_input_ports_to_bundle (_input_bundle, this);
1261 IO::build_legal_port_name (DataType type)
1263 const int name_size = jack_port_name_size();
1267 if (type == DataType::AUDIO) {
1268 suffix = _("audio");
1269 } else if (type == DataType::MIDI) {
1272 throw unknown_type();
1275 /* note that if "in" or "out" are translated it will break a session
1276 across locale switches because a port's connection list will
1277 show (old) translated names, but the current port name will
1278 use the (new) translated name.
1281 if (_direction == Input) {
1282 suffix += X_("_in");
1284 suffix += X_("_out");
1287 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1289 limit = name_size - _session.engine().client_name().length() - (suffix.length() + 5);
1291 char buf1[name_size+1];
1292 char buf2[name_size+1];
1294 snprintf (buf1, name_size+1, ("%.*s/%s"), limit, _name.val().c_str(), suffix.c_str());
1296 int port_number = find_port_hole (buf1);
1297 snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
1299 return string (buf2);
1303 IO::find_port_hole (const char* base)
1305 /* CALLER MUST HOLD IO LOCK */
1309 if (_ports.empty()) {
1313 /* we only allow up to 4 characters for the port number
1316 for (n = 1; n < 9999; ++n) {
1317 char buf[jack_port_name_size()];
1318 PortSet::iterator i = _ports.begin();
1320 snprintf (buf, jack_port_name_size(), _("%s %u"), base, n);
1322 for ( ; i != _ports.end(); ++i) {
1323 if (i->name() == buf) {
1328 if (i == _ports.end()) {
1337 IO::audio(uint32_t n) const
1339 return _ports.nth_audio_port (n);
1344 IO::midi(uint32_t n) const
1346 return _ports.nth_midi_port (n);
1350 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1359 _bundle.reset (new Bundle (_direction == Input));
1362 _bundle->suspend_signals ();
1364 _bundle->remove_channels ();
1366 if (_direction == Input) {
1367 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1369 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1371 _bundle->set_name (buf);
1374 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1376 uint32_t const N = _ports.count().get (*i);
1377 for (uint32_t j = 0; j < N; ++j) {
1378 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1379 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1385 _bundle->resume_signals ();
1388 /** @return Bundles connected to our ports */
1390 IO::bundles_connected ()
1395 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1396 bundles.push_back ((*i)->bundle);
1399 /* Session bundles */
1400 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1401 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1402 if ((*i)->connected_to (_bundle, _session.engine())) {
1403 bundles.push_back (*i);
1409 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1411 if (_direction == Input) {
1412 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1413 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1414 bundles.push_back ((*i)->output()->bundle());
1418 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1419 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1420 bundles.push_back ((*i)->input()->bundle());
1429 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1432 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1436 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1440 if (t == DataType::AUDIO) {
1446 return c == 0 ? _("L") : _("R");
1448 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1454 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1463 IO::name_from_state (const XMLNode& node)
1465 const XMLProperty* prop;
1467 if ((prop = node.property ("name")) != 0) {
1468 return prop->value();
1475 IO::set_name_in_state (XMLNode& node, const string& new_name)
1477 const XMLProperty* prop;
1479 if ((prop = node.property ("name")) != 0) {
1480 node.add_property ("name", new_name);
1485 IO::connected () const
1487 /* do we have any connections at all? */
1489 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1490 if (p->connected()) {
1499 IO::connected_to (boost::shared_ptr<const IO> other) const
1502 return connected ();
1505 assert (_direction != other->direction());
1508 uint32_t no = n_ports().n_total();
1509 uint32_t ni = other->n_ports ().n_total();
1511 for (i = 0; i < no; ++i) {
1512 for (j = 0; j < ni; ++j) {
1513 if (nth(i)->connected_to (other->nth(j)->name())) {
1523 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
1527 /* don't read the data into new buffers - just use the port buffers directly */
1529 bufs.attach_buffers (_ports, nframes, 0);
1530 proc->run (bufs, start_frame, end_frame, nframes, true);
1534 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1536 assert(bufs.available() >= _ports.count());
1538 if (_ports.count() == ChanCount::ZERO) {
1542 bufs.set_count (_ports.count());
1544 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1545 PortSet::iterator i = _ports.begin(*t);
1546 BufferSet::iterator b = bufs.begin(*t);
1548 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1549 if (b == bufs.end(*t)) {
1554 for ( ; i != _ports.end(*t); ++i, ++b) {
1555 Buffer& bb (i->get_buffer (nframes));
1556 b->read_from (bb, nframes);
1562 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1564 // Copy any buffers 1:1 to outputs
1566 PortSet::iterator o = _ports.begin(type);
1567 BufferSet::iterator i = bufs.begin(type);
1568 BufferSet::iterator prev = i;
1570 while (i != bufs.end(type) && o != _ports.end (type)) {
1571 Buffer& port_buffer (o->get_buffer (nframes));
1572 port_buffer.read_from (*i, nframes, offset);
1578 // Copy last buffer to any extra outputs
1580 while (o != _ports.end(type)) {
1581 Buffer& port_buffer (o->get_buffer (nframes));
1582 port_buffer.read_from (*prev, nframes, offset);
1588 IO::port_by_name (const std::string& str) const
1590 /* to be called only from ::set_state() - no locking */
1592 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1596 if (p.name() == str) {
1597 return const_cast<Port*>(&p);
1605 IO::physically_connected () const
1607 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1608 if (i->physically_connected()) {