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());
115 IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
117 std::vector<UserBundleInfo*> new_list;
119 for (std::vector<UserBundleInfo*>::iterator i = list.begin(); i != list.end(); ++i) {
121 uint32_t const N = (*i)->bundle->nchannels ();
123 if (_ports.num_ports (default_type()) < N) {
129 for (uint32_t j = 0; j < N; ++j) {
130 /* Every port on bundle channel j must be connected to our input j */
131 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
132 for (uint32_t k = 0; k < pl.size(); ++k) {
133 if (ports.port(j)->connected_to (pl[k]) == false) {
145 new_list.push_back (*i);
156 IO::disconnect (Port* our_port, string other_port, void* src)
158 if (other_port.length() == 0 || our_port == 0) {
163 BLOCK_PROCESS_CALLBACK ();
166 Glib::Mutex::Lock lm (io_lock);
168 /* check that our_port is really one of ours */
170 if ( ! _ports.contains(our_port)) {
174 /* disconnect it from the source */
176 if (our_port->disconnect (other_port)) {
177 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
181 check_bundles_connected ();
185 changed (ConnectionsChanged, src); /* EMIT SIGNAL */
186 _session.set_dirty ();
192 IO::connect (Port* our_port, string other_port, void* src)
194 if (other_port.length() == 0 || our_port == 0) {
199 BLOCK_PROCESS_CALLBACK ();
202 Glib::Mutex::Lock lm (io_lock);
204 /* check that our_port is really one of ours */
206 if ( ! _ports.contains(our_port) ) {
210 /* connect it to the source */
212 if (our_port->connect (other_port)) {
218 changed (ConnectionsChanged, src); /* EMIT SIGNAL */
219 _session.set_dirty ();
224 IO::remove_port (Port* port, void* src)
226 IOChange change (NoChange);
229 BLOCK_PROCESS_CALLBACK ();
233 Glib::Mutex::Lock lm (io_lock);
235 if (_ports.remove(port)) {
236 change = IOChange (change|ConfigurationChanged);
238 if (port->connected()) {
239 change = IOChange (change|ConnectionsChanged);
242 _session.engine().unregister_port (*port);
243 check_bundles_connected ();
247 PortCountChanged (n_ports()); /* EMIT SIGNAL */
250 if (change & ConfigurationChanged) {
254 if (change != NoChange) {
255 changed (change, src);
256 _session.set_dirty ();
263 /** Add an output port.
265 * @param destination Name of input port to connect new port to.
266 * @param src Source for emitted ConfigurationChanged signal.
267 * @param type Data type of port. Default value (NIL) will use this IO's default type.
270 IO::add_port (string destination, void* src, DataType type)
274 if (type == DataType::NIL) {
275 type = _default_type;
279 BLOCK_PROCESS_CALLBACK ();
283 Glib::Mutex::Lock lm (io_lock);
285 /* Create a new output port */
287 string portname = build_legal_port_name (type);
289 if (_direction == Input) {
290 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
291 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
295 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
296 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
301 _ports.add (our_port);
304 PortCountChanged (n_ports()); /* EMIT SIGNAL */
307 if (destination.length()) {
308 if (our_port->connect (destination)) {
313 // pan_changed (src); /* EMIT SIGNAL */
314 changed (ConfigurationChanged, src); /* EMIT SIGNAL */
316 _session.set_dirty ();
322 IO::disconnect (void* src)
325 BLOCK_PROCESS_CALLBACK ();
328 Glib::Mutex::Lock lm (io_lock);
330 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
331 i->disconnect_all ();
334 check_bundles_connected ();
338 changed (ConnectionsChanged, src); /* EMIT SIGNAL */
344 IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
347 bool changed = false;
349 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
351 const size_t n = count.get(*t);
353 /* remove unused ports */
354 for (size_t i = n_ports().get(*t); i > n; --i) {
355 port = _ports.port(*t, i-1);
359 _session.engine().unregister_port (*port);
364 /* create any necessary new ports */
365 while (n_ports().get(*t) < n) {
367 string portname = build_legal_port_name (*t);
371 if (_direction == Input) {
372 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
373 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
377 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
378 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
384 catch (AudioEngine::PortRegistrationFailure& err) {
386 throw AudioEngine::PortRegistrationFailure();
395 check_bundles_connected ();
396 PortCountChanged (n_ports()); /* EMIT SIGNAL */
397 _session.set_dirty ();
401 /* disconnect all existing ports so that we get a fresh start */
402 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
403 i->disconnect_all ();
412 IO::ensure_ports (ChanCount count, bool clear, bool lockit, void* src)
414 bool changed = false;
416 if (count == n_ports() && !clear) {
421 BLOCK_PROCESS_CALLBACK ();
422 Glib::Mutex::Lock im (io_lock);
423 changed = ensure_ports_locked (count, clear, src);
425 changed = ensure_ports_locked (count, clear, src);
429 this->changed (ConfigurationChanged, src); /* EMIT SIGNAL */
431 _session.set_dirty ();
438 IO::ensure_io (ChanCount count, bool clear, void* src)
440 return ensure_ports (count, clear, true, src);
450 IO::state (bool /*full_state*/)
452 XMLNode* node = new XMLNode (state_node_name);
455 vector<string>::iterator ci;
457 LocaleGuard lg (X_("POSIX"));
458 Glib::Mutex::Lock lm (io_lock);
460 node->add_property("name", _name);
461 id().print (buf, sizeof (buf));
462 node->add_property("id", buf);
463 node->add_property ("direction", enum_2_string (_direction));
464 node->add_property ("default-type", _default_type.to_string());
466 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
467 XMLNode* n = new XMLNode ("Bundle");
468 n->add_property ("name", (*i)->bundle->name ());
469 node->add_child_nocopy (*n);
472 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
474 vector<string> connections;
476 XMLNode* pnode = new XMLNode (X_("Port"));
477 pnode->add_property (X_("type"), i->type().to_string());
478 pnode->add_property (X_("name"), i->name());
480 if (i->get_connections (connections)) {
482 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
484 /* if its a connection to our own port,
485 return only the port name, not the
486 whole thing. this allows connections
487 to be re-established even when our
488 client name is different.
491 XMLNode* cnode = new XMLNode (X_("Connection"));
493 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
494 pnode->add_child_nocopy (*cnode);
498 node->add_child_nocopy (*pnode);
505 IO::set_state (const XMLNode& node, int version)
507 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
508 * are input OR output, not both, so the direction needs to be specified
511 assert (version >= 3000);
513 const XMLProperty* prop;
514 XMLNodeConstIterator iter;
515 LocaleGuard lg (X_("POSIX"));
517 /* force use of non-localized representation of decimal point,
518 since we use it a lot in XML files and so forth.
521 if (node.name() != state_node_name) {
522 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
526 if ((prop = node.property ("name")) != 0) {
527 set_name (prop->value());
530 if ((prop = node.property (X_("default-type"))) != 0) {
531 _default_type = DataType(prop->value());
532 assert(_default_type != DataType::NIL);
535 if ((prop = node.property ("id")) != 0) {
536 _id = prop->value ();
539 if ((prop = node.property ("direction")) != 0) {
540 _direction = (Direction) string_2_enum (prop->value(), _direction);
543 if (create_ports (node, version)) {
547 if (connecting_legal) {
549 if (make_connections (node, version, false)) {
555 pending_state_node = new XMLNode (node);
556 pending_state_node_version = version;
557 pending_state_node_in = false;
558 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
566 IO::set_state_2X (const XMLNode& node, int version, bool in)
568 const XMLProperty* prop;
569 XMLNodeConstIterator iter;
570 LocaleGuard lg (X_("POSIX"));
572 /* force use of non-localized representation of decimal point,
573 since we use it a lot in XML files and so forth.
576 if (node.name() != state_node_name) {
577 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
581 if ((prop = node.property ("name")) != 0) {
582 set_name (prop->value());
585 if ((prop = node.property (X_("default-type"))) != 0) {
586 _default_type = DataType(prop->value());
587 assert(_default_type != DataType::NIL);
590 if ((prop = node.property ("id")) != 0) {
591 _id = prop->value ();
594 _direction = in ? Input : Output;
596 if (create_ports (node, version)) {
600 if (connecting_legal) {
602 if (make_connections_2X (node, version, in)) {
608 pending_state_node = new XMLNode (node);
609 pending_state_node_version = version;
610 pending_state_node_in = in;
611 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
618 IO::connecting_became_legal ()
622 assert (pending_state_node);
624 connection_legal_c.disconnect ();
626 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
628 delete pending_state_node;
629 pending_state_node = 0;
634 boost::shared_ptr<Bundle>
635 IO::find_possible_bundle (const string &desired_name)
637 static const string digits = "0123456789";
638 const string &default_name = (_direction == Input ? _("in") : _("out"));
639 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
641 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
644 int bundle_number, mask;
645 string possible_name;
647 string::size_type last_non_digit_pos;
649 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
652 // find numeric suffix of desired name
655 last_non_digit_pos = desired_name.find_last_not_of(digits);
657 if (last_non_digit_pos != string::npos) {
659 s << desired_name.substr(last_non_digit_pos);
663 // see if it's a stereo connection e.g. "in 3+4"
665 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
666 string::size_type left_last_non_digit_pos;
668 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
670 if (left_last_non_digit_pos != string::npos) {
671 int left_bundle_number = 0;
673 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
674 s >> left_bundle_number;
676 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
687 // find highest set bit
689 while ((mask <= bundle_number) && (mask <<= 1)) {}
691 // "wrap" bundle number into largest possible power of 2
696 if (bundle_number & mask) {
697 bundle_number &= ~mask;
700 s << default_name << " " << bundle_number + 1;
703 s << "+" << bundle_number + 2;
706 possible_name = s.str();
708 if ((c = _session.bundle_by_name (possible_name)) != 0) {
715 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
718 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
729 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
731 XMLProperty const * prop;
732 XMLNodeList children = node.children ();
734 uint32_t n_audio = 0;
736 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
738 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
739 n_audio = count (prop->value().begin(), prop->value().end(), '{');
740 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
742 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
743 n_audio = count (prop->value().begin(), prop->value().end(), '{');
744 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
750 cnt.set_audio (n_audio);
751 n = ChanCount::max (n, cnt);
757 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
759 if (version < 3000) {
760 return get_port_counts_2X (node, version, n, c);
763 XMLProperty const * prop;
764 XMLNodeConstIterator iter;
765 uint32_t n_audio = 0;
771 if ((prop = node.property ("connection")) != 0) {
773 if ((c = find_possible_bundle (prop->value())) != 0) {
774 n = ChanCount::max (n, ChanCount(c->type(), c->nchannels()));
779 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
781 if ((*iter)->name() == X_("Bundle")) {
782 if ((c = find_possible_bundle (prop->value())) != 0) {
783 n = ChanCount::max (n, ChanCount(c->type(), c->nchannels()));
790 if ((*iter)->name() == X_("Port")) {
791 prop = (*iter)->property (X_("type"));
797 if (prop->value() == X_("audio")) {
798 cnt.set_audio (++n_audio);
799 } else if (prop->value() == X_("midi")) {
800 cnt.set_midi (++n_midi);
805 n = ChanCount::max (n, cnt);
810 IO::create_ports (const XMLNode& node, int version)
813 boost::shared_ptr<Bundle> c;
815 get_port_counts (node, version, n, c);
817 if (ensure_ports (n, true, true, this)) {
818 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
828 IO::make_connections (const XMLNode& node, int version, bool in)
830 if (version < 3000) {
831 return make_connections_2X (node, version, in);
834 const XMLProperty* prop;
836 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
838 if ((*i)->name() == "Bundle") {
839 XMLProperty const * prop = (*i)->property ("name");
841 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
843 connect_ports_to_bundle (b, this);
850 if ((*i)->name() == "Port") {
852 prop = (*i)->property (X_("name"));
858 Port* p = port_by_name (prop->value());
861 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
863 XMLNode* cnode = (*c);
865 if (cnode->name() != X_("Connection")) {
869 if ((prop = cnode->property (X_("other"))) == 0) {
874 p->connect (prop->value());
886 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
888 const XMLProperty* prop;
890 /* XXX: bundles ("connections" as was) */
892 if ((prop = node.property ("inputs")) != 0 && in) {
894 string::size_type ostart = 0;
895 string::size_type start = 0;
896 string::size_type end = 0;
899 vector<string> ports;
901 string const str = prop->value ();
903 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
906 if ((end = str.find_first_of ('}', start)) == string::npos) {
907 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
911 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
912 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
919 for (int x = 0; x < n; ++x) {
920 /* XXX: this is a bit of a hack; need to check if it's always valid */
921 string::size_type const p = ports[x].find ("/out");
922 if (p != string::npos) {
923 ports[x].replace (p, 4, "/audio_out");
925 nth(i)->connect (ports[x]);
935 if ((prop = node.property ("outputs")) != 0 && !in) {
937 string::size_type ostart = 0;
938 string::size_type start = 0;
939 string::size_type end = 0;
942 vector<string> ports;
944 string const str = prop->value ();
946 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
949 if ((end = str.find_first_of ('}', start)) == string::npos) {
950 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
954 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
955 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
961 for (int x = 0; x < n; ++x) {
962 /* XXX: this is a bit of a hack; need to check if it's always valid */
963 string::size_type const p = ports[x].find ("/in");
964 if (p != string::npos) {
965 ports[x].replace (p, 3, "/audio_in");
967 nth(i)->connect (ports[x]);
980 IO::set_ports (const string& str)
982 vector<string> ports;
987 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
992 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, true, this)) {
996 string::size_type start, end, ostart;
1003 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1006 if ((end = str.find_first_of ('}', start)) == string::npos) {
1007 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1011 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1012 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1018 for (int x = 0; x < n; ++x) {
1019 connect (nth (i), ports[x], this);
1031 IO::parse_io_string (const string& str, vector<string>& ports)
1033 string::size_type pos, opos;
1035 if (str.length() == 0) {
1044 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1045 ports.push_back (str.substr (opos, pos - opos));
1049 if (opos < str.length()) {
1050 ports.push_back (str.substr(opos));
1053 return ports.size();
1057 IO::parse_gain_string (const string& str, vector<string>& ports)
1059 string::size_type pos, opos;
1065 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1066 ports.push_back (str.substr (opos, pos - opos));
1070 if (opos < str.length()) {
1071 ports.push_back (str.substr(opos));
1074 return ports.size();
1078 IO::set_name (const string& requested_name)
1080 string name = requested_name;
1082 if (_name == name) {
1086 /* replace all colons in the name. i wish we didn't have to do this */
1088 if (replace_all (name, ":", "-")) {
1089 warning << _("you cannot use colons to name objects with I/O connections") << endmsg;
1092 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1093 string current_name = i->name();
1094 current_name.replace (current_name.find (_name), _name.val().length(), name);
1095 i->set_name (current_name);
1098 bool const r = SessionObject::set_name (name);
1106 IO::set_port_latency (nframes_t nframes)
1108 Glib::Mutex::Lock lm (io_lock);
1110 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1111 i->set_latency (nframes);
1116 IO::latency () const
1118 nframes_t max_latency;
1123 /* io lock not taken - must be protected by other means */
1125 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1126 if ((latency = i->total_latency ()) > max_latency) {
1127 max_latency = latency;
1135 IO::update_port_total_latencies ()
1137 /* io_lock, not taken: function must be called from Session::process() calltree */
1139 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1140 _session.engine().update_total_latency (*i);
1145 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
1148 BLOCK_PROCESS_CALLBACK ();
1149 Glib::Mutex::Lock lm2 (io_lock);
1151 c->connect (_bundle, _session.engine());
1153 /* If this is a UserBundle, make a note of what we've done */
1155 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1158 /* See if we already know about this one */
1159 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1160 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1164 if (i == _bundles_connected.end()) {
1165 /* We don't, so make a note */
1166 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1171 changed (IOChange (ConfigurationChanged|ConnectionsChanged), src); /* EMIT SIGNAL */
1176 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1179 BLOCK_PROCESS_CALLBACK ();
1180 Glib::Mutex::Lock lm2 (io_lock);
1182 c->disconnect (_bundle, _session.engine());
1184 /* If this is a UserBundle, make a note of what we've done */
1186 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1189 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1190 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1194 if (i != _bundles_connected.end()) {
1196 _bundles_connected.erase (i);
1201 changed (IOChange (ConfigurationChanged|ConnectionsChanged), src); /* EMIT SIGNAL */
1207 IO::disable_connecting ()
1209 connecting_legal = false;
1214 IO::enable_connecting ()
1216 connecting_legal = true;
1217 boost::optional<int> r = ConnectingLegal ();
1218 return r.get_value_or (0);
1222 IO::bundle_changed (Bundle::Change /*c*/)
1225 // connect_input_ports_to_bundle (_input_bundle, this);
1230 IO::build_legal_port_name (DataType type)
1232 const int name_size = jack_port_name_size();
1236 if (type == DataType::AUDIO) {
1237 suffix = _("audio");
1238 } else if (type == DataType::MIDI) {
1241 throw unknown_type();
1244 /* note that if "in" or "out" are translated it will break a session
1245 across locale switches because a port's connection list will
1246 show (old) translated names, but the current port name will
1247 use the (new) translated name.
1250 if (_direction == Input) {
1251 suffix += X_("_in");
1253 suffix += X_("_out");
1256 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1258 limit = name_size - _session.engine().client_name().length() - (suffix.length() + 5);
1260 char buf1[name_size+1];
1261 char buf2[name_size+1];
1263 snprintf (buf1, name_size+1, ("%.*s/%s"), limit, _name.val().c_str(), suffix.c_str());
1265 int port_number = find_port_hole (buf1);
1266 snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
1268 return string (buf2);
1272 IO::find_port_hole (const char* base)
1274 /* CALLER MUST HOLD IO LOCK */
1278 if (_ports.empty()) {
1282 /* we only allow up to 4 characters for the port number
1285 for (n = 1; n < 9999; ++n) {
1286 char buf[jack_port_name_size()];
1287 PortSet::iterator i = _ports.begin();
1289 snprintf (buf, jack_port_name_size(), _("%s %u"), base, n);
1291 for ( ; i != _ports.end(); ++i) {
1292 if (i->name() == buf) {
1297 if (i == _ports.end()) {
1306 IO::audio(uint32_t n) const
1308 return _ports.nth_audio_port (n);
1313 IO::midi(uint32_t n) const
1315 return _ports.nth_midi_port (n);
1319 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1328 _bundle.reset (new Bundle (_direction == Input));
1331 _bundle->suspend_signals ();
1333 _bundle->set_type (default_type ());
1335 _bundle->remove_channels ();
1337 if (_direction == Input) {
1338 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1340 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1342 _bundle->set_name (buf);
1343 uint32_t const ni = _ports.num_ports();
1344 for (uint32_t i = 0; i < ni; ++i) {
1345 _bundle->add_channel (bundle_channel_name (i, ni));
1346 _bundle->set_port (i, _session.engine().make_port_name_non_relative (_ports.port(i)->name()));
1349 _bundle->resume_signals ();
1352 /** @return Bundles connected to our ports */
1354 IO::bundles_connected ()
1359 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1360 bundles.push_back ((*i)->bundle);
1363 /* Session bundles */
1364 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1365 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1366 if ((*i)->connected_to (_bundle, _session.engine())) {
1367 bundles.push_back (*i);
1373 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1375 if (_direction == Input) {
1376 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1377 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1378 bundles.push_back ((*i)->output()->bundle());
1382 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1383 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1384 bundles.push_back ((*i)->input()->bundle());
1393 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1396 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1400 IO::bundle_channel_name (uint32_t c, uint32_t n) const
1408 return c == 0 ? _("L") : _("R");
1410 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1418 IO::name_from_state (const XMLNode& node)
1420 const XMLProperty* prop;
1422 if ((prop = node.property ("name")) != 0) {
1423 return prop->value();
1430 IO::set_name_in_state (XMLNode& node, const string& new_name)
1432 const XMLProperty* prop;
1434 if ((prop = node.property ("name")) != 0) {
1435 node.add_property ("name", new_name);
1440 IO::connected () const
1442 /* do we have any connections at all? */
1444 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1445 if (p->connected()) {
1454 IO::connected_to (boost::shared_ptr<const IO> other) const
1457 return connected ();
1460 assert (_direction != other->direction());
1463 uint32_t no = n_ports().n_total();
1464 uint32_t ni = other->n_ports ().n_total();
1466 for (i = 0; i < no; ++i) {
1467 for (j = 0; j < ni; ++j) {
1468 if (nth(i)->connected_to (other->nth(j)->name())) {
1478 IO::process_input (boost::shared_ptr<Processor> proc, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
1482 /* don't read the data into new buffers - just use the port buffers directly */
1484 bufs.attach_buffers (_ports, nframes, 0);
1485 proc->run (bufs, start_frame, end_frame, nframes, true);
1489 IO::collect_input (BufferSet& bufs, nframes_t nframes, ChanCount offset)
1491 assert(bufs.available() >= _ports.count());
1493 if (_ports.count() == ChanCount::ZERO) {
1497 bufs.set_count (_ports.count());
1499 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1500 PortSet::iterator i = _ports.begin(*t);
1501 BufferSet::iterator b = bufs.begin(*t);
1503 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1504 if (b == bufs.end(*t)) {
1509 for ( ; i != _ports.end(*t); ++i, ++b) {
1510 Buffer& bb (i->get_buffer (nframes));
1511 b->read_from (bb, nframes);
1517 IO::copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes, nframes_t offset)
1519 // Copy any buffers 1:1 to outputs
1521 PortSet::iterator o = _ports.begin(type);
1522 BufferSet::iterator i = bufs.begin(type);
1523 BufferSet::iterator prev = i;
1525 while (i != bufs.end(type) && o != _ports.end (type)) {
1526 Buffer& port_buffer (o->get_buffer (nframes));
1527 port_buffer.read_from (*i, nframes, offset);
1533 // Copy last buffer to any extra outputs
1535 while (o != _ports.end(type)) {
1536 Buffer& port_buffer (o->get_buffer (nframes));
1537 port_buffer.read_from (*prev, nframes, offset);
1543 IO::port_by_name (const std::string& str) const
1545 /* to be called only from ::set_state() - no locking */
1547 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1551 if (p.name() == str) {
1552 return const_cast<Port*>(&p);