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.
29 #include <glibmm/threads.h>
31 #include "pbd/xml++.h"
32 #include "pbd/replace_all.h"
33 #include "pbd/unknown_type.h"
34 #include "pbd/enumwriter.h"
36 #include "ardour/audioengine.h"
37 #include "ardour/buffer.h"
38 #include "ardour/buffer_set.h"
39 #include "ardour/debug.h"
40 #include "ardour/io.h"
41 #include "ardour/port.h"
42 #include "ardour/route.h"
43 #include "ardour/session.h"
44 #include "ardour/user_bundle.h"
48 #define BLOCK_PROCESS_CALLBACK() Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock())
51 using namespace ARDOUR;
54 const string IO::state_node_name = "IO";
55 bool IO::connecting_legal = false;
56 PBD::Signal0<int> IO::ConnectingLegal;
57 PBD::Signal1<void,ChanCount> IO::PortCountChanged;
59 /** @param default_type The type of port that will be created by ensure_io
60 * and friends if no type is explicitly requested (to avoid breakage).
62 IO::IO (Session& s, const string& name, Direction dir, DataType default_type, bool sendish)
63 : SessionObject (s, name)
65 , _default_type (default_type)
69 Port::PostDisconnect.connect_same_thread (*this, boost::bind (&IO::disconnect_check, this, _1, _2));
70 pending_state_node = 0;
74 IO::IO (Session& s, const XMLNode& node, DataType dt, bool sendish)
75 : SessionObject(s, "unnamed io")
81 pending_state_node = 0;
82 Port::PostDisconnect.connect_same_thread (*this, boost::bind (&IO::disconnect_check, this, _1, _2));
84 set_state (node, Stateful::loading_state_version);
90 Glib::Threads::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::disconnect_check (boost::shared_ptr<Port> a, boost::shared_ptr<Port> b)
102 /* this could be called from within our own ::disconnect() method(s)
103 or from somewhere that operates directly on a port. so, we don't
104 know for sure if we can take this lock or not. if we fail,
105 we assume that its safely locked by our own ::disconnect().
108 Glib::Threads::Mutex::Lock tm (io_lock, Glib::Threads::TRY_LOCK);
111 /* we took the lock, so we cannot be here from inside
114 if (_ports.contains (a) || _ports.contains (b)) {
115 changed (IOChange (IOChange::ConnectionsChanged), this); /* EMIT SIGNAL */
118 /* we didn't get the lock, so assume that we're inside
119 * ::disconnect(), and it will call changed() appropriately.
125 IO::increment_port_buffer_offset (pframes_t offset)
127 /* io_lock, not taken: function must be called from Session::process() calltree */
129 if (_direction == Output) {
130 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
131 i->increment_port_buffer_offset (offset);
137 IO::silence (framecnt_t nframes)
139 /* io_lock, not taken: function must be called from Session::process() calltree */
141 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
142 i->get_buffer(nframes).silence (nframes);
146 /** Set _bundles_connected to those bundles that are connected such that every
147 * port on every bundle channel x is connected to port x in _ports.
150 IO::check_bundles_connected ()
152 std::vector<UserBundleInfo*> new_list;
154 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
156 uint32_t const N = (*i)->bundle->nchannels().n_total();
158 if (_ports.num_ports() < N) {
164 for (uint32_t j = 0; j < N; ++j) {
165 /* Every port on bundle channel j must be connected to our input j */
166 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
167 for (uint32_t k = 0; k < pl.size(); ++k) {
168 if (_ports.port(j)->connected_to (pl[k]) == false) {
180 new_list.push_back (*i);
186 _bundles_connected = new_list;
191 IO::disconnect (boost::shared_ptr<Port> our_port, string other_port, void* src)
193 if (other_port.length() == 0 || our_port == 0) {
198 Glib::Threads::Mutex::Lock lm (io_lock);
200 /* check that our_port is really one of ours */
202 if ( ! _ports.contains(our_port)) {
206 /* disconnect it from the source */
208 if (our_port->disconnect (other_port)) {
209 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
213 check_bundles_connected ();
216 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
218 _session.set_dirty ();
224 IO::connect (boost::shared_ptr<Port> our_port, string other_port, void* src)
226 if (other_port.length() == 0 || our_port == 0) {
231 Glib::Threads::Mutex::Lock lm (io_lock);
233 /* check that our_port is really one of ours */
235 if ( ! _ports.contains(our_port) ) {
239 /* connect it to the source */
241 if (our_port->connect (other_port)) {
245 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
246 _session.set_dirty ();
251 IO::remove_port (boost::shared_ptr<Port> port, void* src)
253 ChanCount before = _ports.count ();
254 ChanCount after = before;
255 after.set (port->type(), after.get (port->type()) - 1);
257 boost::optional<bool> const r = PortCountChanging (after); /* EMIT SIGNAL */
258 if (r.get_value_or (false)) {
265 BLOCK_PROCESS_CALLBACK ();
268 Glib::Threads::Mutex::Lock lm (io_lock);
270 if (_ports.remove(port)) {
271 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
272 change.before = before;
273 change.after = _ports.count ();
275 if (port->connected()) {
276 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
279 _session.engine().unregister_port (port);
280 check_bundles_connected ();
284 PortCountChanged (n_ports()); /* EMIT SIGNAL */
286 if (change.type != IOChange::NoChange) {
287 changed (change, src);
288 _buffers.attach_buffers (_ports);
292 if (change.type & IOChange::ConfigurationChanged) {
296 if (change.type == IOChange::NoChange) {
300 _session.set_dirty ();
307 * @param destination Name of port to connect new port to.
308 * @param src Source for emitted ConfigurationChanged signal.
309 * @param type Data type of port. Default value (NIL) will use this IO's default type.
312 IO::add_port (string destination, void* src, DataType type)
314 boost::shared_ptr<Port> our_port;
316 if (type == DataType::NIL) {
317 type = _default_type;
320 ChanCount before = _ports.count ();
321 ChanCount after = before;
322 after.set (type, after.get (type) + 1);
324 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
332 BLOCK_PROCESS_CALLBACK ();
336 Glib::Threads::Mutex::Lock lm (io_lock);
338 /* Create a new port */
340 string portname = build_legal_port_name (type);
342 if (_direction == Input) {
343 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
344 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
348 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
349 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
354 change.before = _ports.count ();
355 _ports.add (our_port);
358 PortCountChanged (n_ports()); /* EMIT SIGNAL */
359 change.type = IOChange::ConfigurationChanged;
360 change.after = _ports.count ();
361 changed (change, src); /* EMIT SIGNAL */
362 _buffers.attach_buffers (_ports);
365 if (!destination.empty()) {
366 if (our_port->connect (destination)) {
372 _session.set_dirty ();
378 IO::disconnect (void* src)
381 Glib::Threads::Mutex::Lock lm (io_lock);
383 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
384 i->disconnect_all ();
387 check_bundles_connected ();
390 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
395 /** Caller must hold process lock */
397 IO::ensure_ports_locked (ChanCount count, bool clear, bool& changed)
399 #ifndef PLATFORM_WINDOWS
400 assert (!AudioEngine::instance()->process_lock().trylock());
403 boost::shared_ptr<Port> port;
407 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
409 const size_t n = count.get(*t);
411 /* remove unused ports */
412 for (size_t i = n_ports().get(*t); i > n; --i) {
413 port = _ports.port(*t, i-1);
417 _session.engine().unregister_port (port);
422 /* create any necessary new ports */
423 while (n_ports().get(*t) < n) {
425 string portname = build_legal_port_name (*t);
429 if (_direction == Input) {
430 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
431 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
435 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
436 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
442 catch (AudioEngine::PortRegistrationFailure& err) {
453 check_bundles_connected ();
454 PortCountChanged (n_ports()); /* EMIT SIGNAL */
455 _session.set_dirty ();
459 /* disconnect all existing ports so that we get a fresh start */
460 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
461 i->disconnect_all ();
468 /** Caller must hold process lock */
470 IO::ensure_ports (ChanCount count, bool clear, void* src)
472 #ifndef PLATFORM_WINDOWS
473 assert (!AudioEngine::instance()->process_lock().trylock());
476 bool changed = false;
478 if (count == n_ports() && !clear) {
484 change.before = _ports.count ();
487 Glib::Threads::Mutex::Lock im (io_lock);
488 if (ensure_ports_locked (count, clear, changed)) {
494 change.after = _ports.count ();
495 change.type = IOChange::ConfigurationChanged;
496 this->changed (change, src); /* EMIT SIGNAL */
497 _buffers.attach_buffers (_ports);
499 _session.set_dirty ();
505 /** Caller must hold process lock */
507 IO::ensure_io (ChanCount count, bool clear, void* src)
509 #ifndef PLATFORM_WINDOWS
510 assert (!AudioEngine::instance()->process_lock().trylock());
513 return ensure_ports (count, clear, src);
523 IO::state (bool /*full_state*/)
525 XMLNode* node = new XMLNode (state_node_name);
528 vector<string>::iterator ci;
530 LocaleGuard lg (X_("POSIX"));
531 Glib::Threads::Mutex::Lock lm (io_lock);
533 node->add_property("name", _name);
534 id().print (buf, sizeof (buf));
535 node->add_property("id", buf);
536 node->add_property ("direction", enum_2_string (_direction));
537 node->add_property ("default-type", _default_type.to_string());
539 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
540 XMLNode* n = new XMLNode ("Bundle");
541 n->add_property ("name", (*i)->bundle->name ());
542 node->add_child_nocopy (*n);
545 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
547 vector<string> connections;
549 XMLNode* pnode = new XMLNode (X_("Port"));
550 pnode->add_property (X_("type"), i->type().to_string());
551 pnode->add_property (X_("name"), i->name());
553 if (i->get_connections (connections)) {
555 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
557 /* if its a connection to our own port,
558 return only the port name, not the
559 whole thing. this allows connections
560 to be re-established even when our
561 client name is different.
564 XMLNode* cnode = new XMLNode (X_("Connection"));
566 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
567 pnode->add_child_nocopy (*cnode);
571 node->add_child_nocopy (*pnode);
574 snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
575 node->add_property (X_("user-latency"), buf);
581 IO::set_state (const XMLNode& node, int version)
583 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
584 * are input OR output, not both, so the direction needs to be specified
587 assert (version >= 3000);
589 const XMLProperty* prop;
590 XMLNodeConstIterator iter;
591 LocaleGuard lg (X_("POSIX"));
593 /* force use of non-localized representation of decimal point,
594 since we use it a lot in XML files and so forth.
597 if (node.name() != state_node_name) {
598 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
602 if ((prop = node.property ("name")) != 0) {
603 set_name (prop->value());
606 if ((prop = node.property (X_("default-type"))) != 0) {
607 _default_type = DataType(prop->value());
608 assert(_default_type != DataType::NIL);
613 if ((prop = node.property ("direction")) != 0) {
614 _direction = (Direction) string_2_enum (prop->value(), _direction);
617 if (create_ports (node, version)) {
621 if (connecting_legal) {
623 if (make_connections (node, version, false)) {
629 pending_state_node = new XMLNode (node);
630 pending_state_node_version = version;
631 pending_state_node_in = false;
632 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
635 if ((prop = node.property ("user-latency")) != 0) {
636 _user_latency = atoi (prop->value ());
643 IO::set_state_2X (const XMLNode& node, int version, bool in)
645 const XMLProperty* prop;
646 XMLNodeConstIterator iter;
647 LocaleGuard lg (X_("POSIX"));
649 /* force use of non-localized representation of decimal point,
650 since we use it a lot in XML files and so forth.
653 if (node.name() != state_node_name) {
654 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
658 if ((prop = node.property ("name")) != 0) {
659 set_name (prop->value());
662 if ((prop = node.property (X_("default-type"))) != 0) {
663 _default_type = DataType(prop->value());
664 assert(_default_type != DataType::NIL);
669 _direction = in ? Input : Output;
671 if (create_ports (node, version)) {
675 if (connecting_legal) {
677 if (make_connections_2X (node, version, in)) {
683 pending_state_node = new XMLNode (node);
684 pending_state_node_version = version;
685 pending_state_node_in = in;
686 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
693 IO::connecting_became_legal ()
697 assert (pending_state_node);
699 connection_legal_c.disconnect ();
701 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
703 delete pending_state_node;
704 pending_state_node = 0;
709 boost::shared_ptr<Bundle>
710 IO::find_possible_bundle (const string &desired_name)
712 static const string digits = "0123456789";
713 const string &default_name = (_direction == Input ? _("in") : _("out"));
714 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
716 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
719 int bundle_number, mask;
720 string possible_name;
722 string::size_type last_non_digit_pos;
724 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
727 // find numeric suffix of desired name
730 last_non_digit_pos = desired_name.find_last_not_of(digits);
732 if (last_non_digit_pos != string::npos) {
734 s << desired_name.substr(last_non_digit_pos);
738 // see if it's a stereo connection e.g. "in 3+4"
740 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
741 string::size_type left_last_non_digit_pos;
743 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
745 if (left_last_non_digit_pos != string::npos) {
746 int left_bundle_number = 0;
748 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
749 s >> left_bundle_number;
751 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
762 // find highest set bit
764 while ((mask <= bundle_number) && (mask <<= 1)) {}
766 // "wrap" bundle number into largest possible power of 2
771 if (bundle_number & mask) {
772 bundle_number &= ~mask;
775 s << default_name << " " << bundle_number + 1;
778 s << "+" << bundle_number + 2;
781 possible_name = s.str();
783 if ((c = _session.bundle_by_name (possible_name)) != 0) {
790 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
793 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
804 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
806 XMLProperty const * prop;
807 XMLNodeList children = node.children ();
809 uint32_t n_audio = 0;
811 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
813 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
814 n_audio = count (prop->value().begin(), prop->value().end(), '{');
815 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
817 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
818 n_audio = count (prop->value().begin(), prop->value().end(), '{');
819 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
825 cnt.set_audio (n_audio);
826 n = ChanCount::max (n, cnt);
832 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
834 if (version < 3000) {
835 return get_port_counts_2X (node, version, n, c);
838 XMLProperty const * prop;
839 XMLNodeConstIterator iter;
840 uint32_t n_audio = 0;
846 if ((prop = node.property ("connection")) != 0) {
848 if ((c = find_possible_bundle (prop->value())) != 0) {
849 n = ChanCount::max (n, c->nchannels());
854 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
856 if ((*iter)->name() == X_("Bundle")) {
857 if ((c = find_possible_bundle (prop->value())) != 0) {
858 n = ChanCount::max (n, c->nchannels());
865 if ((*iter)->name() == X_("Port")) {
866 prop = (*iter)->property (X_("type"));
872 if (prop->value() == X_("audio")) {
873 cnt.set_audio (++n_audio);
874 } else if (prop->value() == X_("midi")) {
875 cnt.set_midi (++n_midi);
880 n = ChanCount::max (n, cnt);
885 IO::create_ports (const XMLNode& node, int version)
888 boost::shared_ptr<Bundle> c;
890 get_port_counts (node, version, n, c);
893 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
895 if (ensure_ports (n, true, this)) {
896 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
907 IO::make_connections (const XMLNode& node, int version, bool in)
909 if (version < 3000) {
910 return make_connections_2X (node, version, in);
913 const XMLProperty* prop;
915 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
917 if ((*i)->name() == "Bundle") {
918 XMLProperty const * prop = (*i)->property ("name");
920 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
922 connect_ports_to_bundle (b, true, this);
929 if ((*i)->name() == "Port") {
931 prop = (*i)->property (X_("name"));
937 boost::shared_ptr<Port> p = port_by_name (prop->value());
940 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
942 XMLNode* cnode = (*c);
944 if (cnode->name() != X_("Connection")) {
948 if ((prop = cnode->property (X_("other"))) == 0) {
953 connect (p, prop->value(), this);
964 IO::prepare_for_reset (XMLNode& node, const std::string& name)
967 node.add_property ("name", name);
969 /* now find connections and reset the name of the port
970 in one so that when we re-use it it will match
971 the name of the thing we're applying it to.
975 XMLNodeList children = node.children();
977 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
979 if ((*i)->name() == "Port") {
981 prop = (*i)->property (X_("name"));
985 string old = prop->value();
986 string::size_type slash = old.find ('/');
988 if (slash != string::npos) {
989 /* port name is of form: <IO-name>/<port-name> */
992 new_name += old.substr (old.find ('/'));
994 prop->set_value (new_name);
1003 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
1005 const XMLProperty* prop;
1007 /* XXX: bundles ("connections" as was) */
1009 if ((prop = node.property ("inputs")) != 0 && in) {
1011 string::size_type ostart = 0;
1012 string::size_type start = 0;
1013 string::size_type end = 0;
1016 vector<string> ports;
1018 string const str = prop->value ();
1020 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1023 if ((end = str.find_first_of ('}', start)) == string::npos) {
1024 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1028 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1029 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1036 for (int x = 0; x < n; ++x) {
1037 /* XXX: this is a bit of a hack; need to check if it's always valid */
1038 string::size_type const p = ports[x].find ("/out");
1039 if (p != string::npos) {
1040 ports[x].replace (p, 4, "/audio_out");
1042 nth(i)->connect (ports[x]);
1052 if ((prop = node.property ("outputs")) != 0 && !in) {
1054 string::size_type ostart = 0;
1055 string::size_type start = 0;
1056 string::size_type end = 0;
1059 vector<string> ports;
1061 string const str = prop->value ();
1063 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1066 if ((end = str.find_first_of ('}', start)) == string::npos) {
1067 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
1071 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1072 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
1078 for (int x = 0; x < n; ++x) {
1079 /* XXX: this is a bit of a hack; need to check if it's always valid */
1080 string::size_type const p = ports[x].find ("/in");
1081 if (p != string::npos) {
1082 ports[x].replace (p, 3, "/audio_in");
1084 nth(i)->connect (ports[x]);
1097 IO::set_ports (const string& str)
1099 vector<string> ports;
1104 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1109 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1111 // FIXME: audio-only
1112 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1117 string::size_type start, end, ostart;
1124 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1127 if ((end = str.find_first_of ('}', start)) == string::npos) {
1128 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1132 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1133 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1139 for (int x = 0; x < n; ++x) {
1140 connect (nth (i), ports[x], this);
1152 IO::parse_io_string (const string& str, vector<string>& ports)
1154 string::size_type pos, opos;
1156 if (str.length() == 0) {
1165 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1166 ports.push_back (str.substr (opos, pos - opos));
1170 if (opos < str.length()) {
1171 ports.push_back (str.substr(opos));
1174 return ports.size();
1178 IO::parse_gain_string (const string& str, vector<string>& ports)
1180 string::size_type pos, opos;
1186 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1187 ports.push_back (str.substr (opos, pos - opos));
1191 if (opos < str.length()) {
1192 ports.push_back (str.substr(opos));
1195 return ports.size();
1199 IO::set_name (const string& requested_name)
1201 string name = requested_name;
1203 if (_name == name) {
1207 /* replace all colons in the name. i wish we didn't have to do this */
1209 replace_all (name, ":", "-");
1211 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1212 string current_name = i->name();
1213 current_name.replace (current_name.find (_name), _name.val().length(), name);
1214 i->set_name (current_name);
1217 bool const r = SessionObject::set_name (name);
1225 IO::latency () const
1227 framecnt_t max_latency;
1232 /* io lock not taken - must be protected by other means */
1234 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1235 if ((latency = i->private_latency_range (_direction == Output).max) > max_latency) {
1236 DEBUG_TRACE (DEBUG::Latency, string_compose ("port %1 has %2 latency of %3 - use\n",
1238 ((_direction == Output) ? "PLAYBACK" : "CAPTURE"),
1240 max_latency = latency;
1244 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max %4 latency from %2 ports = %3\n",
1245 name(), _ports.num_ports(), max_latency,
1246 ((_direction == Output) ? "PLAYBACK" : "CAPTURE")));
1251 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, bool exclusive, void* src)
1253 BLOCK_PROCESS_CALLBACK ();
1256 Glib::Threads::Mutex::Lock lm2 (io_lock);
1259 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1260 i->disconnect_all ();
1264 c->connect (_bundle, _session.engine());
1266 /* If this is a UserBundle, make a note of what we've done */
1268 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1271 /* See if we already know about this one */
1272 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1273 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1277 if (i == _bundles_connected.end()) {
1278 /* We don't, so make a note */
1279 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1284 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1289 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1291 BLOCK_PROCESS_CALLBACK ();
1294 Glib::Threads::Mutex::Lock lm2 (io_lock);
1296 c->disconnect (_bundle, _session.engine());
1298 /* If this is a UserBundle, make a note of what we've done */
1300 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1303 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1304 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1308 if (i != _bundles_connected.end()) {
1310 _bundles_connected.erase (i);
1315 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1321 IO::disable_connecting ()
1323 connecting_legal = false;
1328 IO::enable_connecting ()
1330 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1331 connecting_legal = true;
1332 boost::optional<int> r = ConnectingLegal ();
1333 return r.get_value_or (0);
1337 IO::bundle_changed (Bundle::Change /*c*/)
1340 // connect_input_ports_to_bundle (_input_bundle, this);
1345 IO::build_legal_port_name (DataType type)
1347 const int name_size = AudioEngine::instance()->port_name_size();
1351 if (type == DataType::AUDIO) {
1352 suffix = X_("audio");
1353 } else if (type == DataType::MIDI) {
1354 suffix = X_("midi");
1356 throw unknown_type();
1359 /* note that if "in" or "out" are translated it will break a session
1360 across locale switches because a port's connection list will
1361 show (old) translated names, but the current port name will
1362 use the (new) translated name.
1366 if (_direction == Input) {
1367 suffix += X_("_return");
1369 suffix += X_("_send");
1372 if (_direction == Input) {
1373 suffix += X_("_in");
1375 suffix += X_("_out");
1379 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1381 limit = name_size - AudioEngine::instance()->my_name().length() - (suffix.length() + 5);
1383 std::vector<char> buf1(name_size+1);
1384 std::vector<char> buf2(name_size+1);
1386 /* colons are illegal in port names, so fix that */
1388 string nom = _name.val();
1389 replace_all (nom, ":", ";");
1391 snprintf (&buf1[0], name_size+1, ("%.*s/%s"), limit, nom.c_str(), suffix.c_str());
1393 int port_number = find_port_hole (&buf1[0]);
1394 snprintf (&buf2[0], name_size+1, "%s %d", &buf1[0], port_number);
1396 return string (&buf2[0]);
1400 IO::find_port_hole (const char* base)
1402 /* CALLER MUST HOLD IO LOCK */
1406 if (_ports.empty()) {
1410 /* we only allow up to 4 characters for the port number
1413 for (n = 1; n < 9999; ++n) {
1414 std::vector<char> buf (AudioEngine::instance()->port_name_size());
1415 PortSet::iterator i = _ports.begin();
1417 snprintf (&buf[0], buf.size()+1, _("%s %u"), base, n);
1419 for ( ; i != _ports.end(); ++i) {
1420 if (string(i->name()) == string(&buf[0])) {
1425 if (i == _ports.end()) {
1433 boost::shared_ptr<AudioPort>
1434 IO::audio(uint32_t n) const
1436 return _ports.nth_audio_port (n);
1440 boost::shared_ptr<MidiPort>
1441 IO::midi(uint32_t n) const
1443 return _ports.nth_midi_port (n);
1447 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1456 _bundle.reset (new Bundle (_direction == Input));
1459 _bundle->suspend_signals ();
1461 _bundle->remove_channels ();
1463 if (_direction == Input) {
1464 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1466 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1468 _bundle->set_name (buf);
1471 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1473 uint32_t const N = _ports.count().get (*i);
1474 for (uint32_t j = 0; j < N; ++j) {
1475 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1476 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1482 _bundle->resume_signals ();
1485 /** @return Bundles connected to our ports */
1487 IO::bundles_connected ()
1492 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1493 bundles.push_back ((*i)->bundle);
1496 /* Session bundles */
1497 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1498 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1499 if ((*i)->connected_to (_bundle, _session.engine())) {
1500 bundles.push_back (*i);
1506 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1508 if (_direction == Input) {
1509 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1510 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1511 bundles.push_back ((*i)->output()->bundle());
1515 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1516 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1517 bundles.push_back ((*i)->input()->bundle());
1526 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1529 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1533 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1537 if (t == DataType::AUDIO) {
1543 return c == 0 ? _("L") : _("R");
1545 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1551 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1560 IO::name_from_state (const XMLNode& node)
1562 const XMLProperty* prop;
1564 if ((prop = node.property ("name")) != 0) {
1565 return prop->value();
1572 IO::set_name_in_state (XMLNode& node, const string& new_name)
1574 node.add_property (X_("name"), new_name);
1575 XMLNodeList children = node.children ();
1576 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
1577 if ((*i)->name() == X_("Port")) {
1578 string const old_name = (*i)->property(X_("name"))->value();
1579 string const old_name_second_part = old_name.substr (old_name.find_first_of ("/") + 1);
1580 (*i)->add_property (X_("name"), string_compose ("%1/%2", new_name, old_name_second_part));
1586 IO::connected () const
1588 /* do we have any connections at all? */
1590 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1591 if (p->connected()) {
1600 IO::connected_to (boost::shared_ptr<const IO> other) const
1603 return connected ();
1606 assert (_direction != other->direction());
1609 uint32_t no = n_ports().n_total();
1610 uint32_t ni = other->n_ports ().n_total();
1612 for (i = 0; i < no; ++i) {
1613 for (j = 0; j < ni; ++j) {
1614 if (nth(i)->connected_to (other->nth(j)->name())) {
1624 IO::connected_to (const string& str) const
1626 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1627 if (i->connected_to (str)) {
1635 /** Call a processor's ::run() method, giving it our buffers
1636 * Caller must hold process lock.
1639 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
1641 /* don't read the data into new buffers - just use the port buffers directly */
1643 if (n_ports().n_total() == 0) {
1644 /* We have no ports, so nothing to process */
1648 _buffers.get_backend_port_addresses (_ports, nframes);
1650 proc->run (_buffers, start_frame, end_frame, nframes, true);
1655 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1657 assert(bufs.available() >= _ports.count());
1659 if (_ports.count() == ChanCount::ZERO) {
1663 bufs.set_count (_ports.count());
1665 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1666 PortSet::iterator i = _ports.begin(*t);
1667 BufferSet::iterator b = bufs.begin(*t);
1669 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1670 if (b == bufs.end(*t)) {
1675 for ( ; i != _ports.end(*t); ++i, ++b) {
1676 Buffer& bb (i->get_buffer (nframes));
1677 b->read_from (bb, nframes);
1683 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1685 // Copy any buffers 1:1 to outputs
1687 PortSet::iterator o = _ports.begin(type);
1688 BufferSet::iterator i = bufs.begin(type);
1689 BufferSet::iterator prev = i;
1691 while (i != bufs.end(type) && o != _ports.end (type)) {
1692 Buffer& port_buffer (o->get_buffer (nframes));
1693 port_buffer.read_from (*i, nframes, offset);
1699 // Copy last buffer to any extra outputs
1701 while (o != _ports.end(type)) {
1702 Buffer& port_buffer (o->get_buffer (nframes));
1703 port_buffer.read_from (*prev, nframes, offset);
1708 boost::shared_ptr<Port>
1709 IO::port_by_name (const std::string& str) const
1711 /* to be called only from ::set_state() - no locking */
1713 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1715 if (i->name() == str) {
1716 return boost::const_pointer_cast<Port> (*i);
1720 return boost::shared_ptr<Port> ();
1724 IO::physically_connected () const
1726 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1727 if (i->physically_connected()) {
1736 IO::has_port (boost::shared_ptr<Port> p) const
1738 Glib::Threads::Mutex::Lock lm (io_lock);
1739 return _ports.contains (p);