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/threads.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/buffer_set.h"
38 #include "ardour/debug.h"
39 #include "ardour/io.h"
40 #include "ardour/port.h"
41 #include "ardour/profile.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 if (_session.state_of_the_state () & Session::Deletion) {
105 /* this could be called from within our own ::disconnect() method(s)
106 or from somewhere that operates directly on a port. so, we don't
107 know for sure if we can take this lock or not. if we fail,
108 we assume that its safely locked by our own ::disconnect().
111 Glib::Threads::Mutex::Lock tm (io_lock, Glib::Threads::TRY_LOCK);
114 /* we took the lock, so we cannot be here from inside
117 if (_ports.contains (a) || _ports.contains (b)) {
118 changed (IOChange (IOChange::ConnectionsChanged), this); /* EMIT SIGNAL */
121 /* we didn't get the lock, so assume that we're inside
122 * ::disconnect(), and it will call changed() appropriately.
128 IO::increment_port_buffer_offset (pframes_t offset)
130 /* io_lock, not taken: function must be called from Session::process() calltree */
132 if (_direction == Output) {
133 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
134 i->increment_port_buffer_offset (offset);
140 IO::silence (framecnt_t nframes)
142 /* io_lock, not taken: function must be called from Session::process() calltree */
144 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
145 i->get_buffer(nframes).silence (nframes);
149 /** Set _bundles_connected to those bundles that are connected such that every
150 * port on every bundle channel x is connected to port x in _ports.
153 IO::check_bundles_connected ()
155 std::vector<UserBundleInfo*> new_list;
157 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
159 uint32_t const N = (*i)->bundle->nchannels().n_total();
161 if (_ports.num_ports() < N) {
167 for (uint32_t j = 0; j < N; ++j) {
168 /* Every port on bundle channel j must be connected to our input j */
169 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
170 for (uint32_t k = 0; k < pl.size(); ++k) {
171 if (_ports.port(j)->connected_to (pl[k]) == false) {
183 new_list.push_back (*i);
189 _bundles_connected = new_list;
194 IO::disconnect (boost::shared_ptr<Port> our_port, string other_port, void* src)
196 if (other_port.length() == 0 || our_port == 0) {
201 Glib::Threads::Mutex::Lock lm (io_lock);
203 /* check that our_port is really one of ours */
205 if ( ! _ports.contains(our_port)) {
209 /* disconnect it from the source */
211 if (our_port->disconnect (other_port)) {
212 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
216 check_bundles_connected ();
219 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
221 _session.set_dirty ();
227 IO::connect (boost::shared_ptr<Port> our_port, string other_port, void* src)
229 if (other_port.length() == 0 || our_port == 0) {
234 Glib::Threads::Mutex::Lock lm (io_lock);
236 /* check that our_port is really one of ours */
238 if ( ! _ports.contains(our_port) ) {
242 /* connect it to the source */
244 if (our_port->connect (other_port)) {
248 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
249 _session.set_dirty ();
254 IO::remove_port (boost::shared_ptr<Port> port, void* src)
256 ChanCount before = _ports.count ();
257 ChanCount after = before;
258 after.set (port->type(), after.get (port->type()) - 1);
260 boost::optional<bool> const r = PortCountChanging (after); /* EMIT SIGNAL */
261 if (r.get_value_or (false)) {
268 BLOCK_PROCESS_CALLBACK ();
271 Glib::Threads::Mutex::Lock lm (io_lock);
273 if (_ports.remove(port)) {
274 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
275 change.before = before;
276 change.after = _ports.count ();
278 if (port->connected()) {
279 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
282 _session.engine().unregister_port (port);
283 check_bundles_connected ();
287 PortCountChanged (n_ports()); /* EMIT SIGNAL */
289 if (change.type != IOChange::NoChange) {
290 changed (change, src);
291 _buffers.attach_buffers (_ports);
295 if (change.type & IOChange::ConfigurationChanged) {
299 if (change.type == IOChange::NoChange) {
303 _session.set_dirty ();
310 * @param destination Name of port to connect new port to.
311 * @param src Source for emitted ConfigurationChanged signal.
312 * @param type Data type of port. Default value (NIL) will use this IO's default type.
315 IO::add_port (string destination, void* src, DataType type)
317 boost::shared_ptr<Port> our_port;
319 if (type == DataType::NIL) {
320 type = _default_type;
323 ChanCount before = _ports.count ();
324 ChanCount after = before;
325 after.set (type, after.get (type) + 1);
327 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
335 BLOCK_PROCESS_CALLBACK ();
339 Glib::Threads::Mutex::Lock lm (io_lock);
341 /* Create a new port */
343 string portname = build_legal_port_name (type);
345 if (_direction == Input) {
346 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
347 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
351 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
352 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
357 change.before = _ports.count ();
358 _ports.add (our_port);
361 PortCountChanged (n_ports()); /* EMIT SIGNAL */
362 change.type = IOChange::ConfigurationChanged;
363 change.after = _ports.count ();
364 changed (change, src); /* EMIT SIGNAL */
365 _buffers.attach_buffers (_ports);
368 if (!destination.empty()) {
369 if (our_port->connect (destination)) {
374 apply_pretty_name ();
376 _session.set_dirty ();
382 IO::disconnect (void* src)
385 Glib::Threads::Mutex::Lock lm (io_lock);
387 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
388 i->disconnect_all ();
391 check_bundles_connected ();
394 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
399 /** Caller must hold process lock */
401 IO::ensure_ports_locked (ChanCount count, bool clear, bool& changed)
403 #ifndef PLATFORM_WINDOWS
404 assert (!AudioEngine::instance()->process_lock().trylock());
407 boost::shared_ptr<Port> port;
411 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
413 const size_t n = count.get(*t);
415 /* remove unused ports */
416 for (size_t i = n_ports().get(*t); i > n; --i) {
417 port = _ports.port(*t, i-1);
421 _session.engine().unregister_port (port);
426 /* create any necessary new ports */
427 while (n_ports().get(*t) < n) {
429 string portname = build_legal_port_name (*t);
433 if (_direction == Input) {
434 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
435 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
439 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
440 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
446 catch (AudioEngine::PortRegistrationFailure& err) {
457 check_bundles_connected ();
458 PortCountChanged (n_ports()); /* EMIT SIGNAL */
459 _session.set_dirty ();
463 /* disconnect all existing ports so that we get a fresh start */
464 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
465 i->disconnect_all ();
472 /** Caller must hold process lock */
474 IO::ensure_ports (ChanCount count, bool clear, void* src)
476 #ifndef PLATFORM_WINDOWS
477 assert (!AudioEngine::instance()->process_lock().trylock());
480 bool changed = false;
482 if (count == n_ports() && !clear) {
488 change.before = _ports.count ();
491 Glib::Threads::Mutex::Lock im (io_lock);
492 if (ensure_ports_locked (count, clear, changed)) {
498 change.after = _ports.count ();
499 change.type = IOChange::ConfigurationChanged;
500 this->changed (change, src); /* EMIT SIGNAL */
501 _buffers.attach_buffers (_ports);
503 _session.set_dirty ();
509 /** Caller must hold process lock */
511 IO::ensure_io (ChanCount count, bool clear, void* src)
513 #ifndef PLATFORM_WINDOWS
514 assert (!AudioEngine::instance()->process_lock().trylock());
517 return ensure_ports (count, clear, src);
527 IO::state (bool /*full_state*/)
529 XMLNode* node = new XMLNode (state_node_name);
534 Glib::Threads::Mutex::Lock lm (io_lock);
536 node->add_property("name", _name);
537 id().print (buf, sizeof (buf));
538 node->add_property("id", buf);
539 node->add_property ("direction", enum_2_string (_direction));
540 node->add_property ("default-type", _default_type.to_string());
542 if (!_pretty_name_prefix.empty ()) {
543 node->add_property("pretty-name", _pretty_name_prefix);
546 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
547 XMLNode* n = new XMLNode ("Bundle");
548 n->add_property ("name", (*i)->bundle->name ());
549 node->add_child_nocopy (*n);
552 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
554 vector<string> connections;
556 XMLNode* pnode = new XMLNode (X_("Port"));
557 pnode->add_property (X_("type"), i->type().to_string());
558 pnode->add_property (X_("name"), i->name());
560 if (i->get_connections (connections)) {
561 vector<string>::const_iterator ci;
562 std::sort (connections.begin(), connections.end());
564 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
566 /* if its a connection to our own port,
567 return only the port name, not the
568 whole thing. this allows connections
569 to be re-established even when our
570 client name is different.
573 XMLNode* cnode = new XMLNode (X_("Connection"));
575 cnode->add_property (X_("other"), _session.engine().make_port_name_relative (*ci));
576 pnode->add_child_nocopy (*cnode);
580 node->add_child_nocopy (*pnode);
583 snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
584 node->add_property (X_("user-latency"), buf);
590 IO::set_state (const XMLNode& node, int version)
592 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
593 * are input OR output, not both, so the direction needs to be specified
596 assert (version >= 3000);
598 XMLProperty const * prop;
599 XMLNodeConstIterator iter;
602 /* force use of non-localized representation of decimal point,
603 since we use it a lot in XML files and so forth.
606 if (node.name() != state_node_name) {
607 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
611 if ((prop = node.property ("name")) != 0) {
612 set_name (prop->value());
615 if ((prop = node.property (X_("default-type"))) != 0) {
616 _default_type = DataType(prop->value());
617 assert(_default_type != DataType::NIL);
622 if ((prop = node.property ("direction")) != 0) {
623 _direction = (Direction) string_2_enum (prop->value(), _direction);
626 if (create_ports (node, version)) {
630 // after create_ports, updates names
631 if ((prop = node.property ("pretty-name")) != 0) {
632 set_pretty_name (prop->value());
635 if (connecting_legal) {
637 if (make_connections (node, version, false)) {
643 pending_state_node = new XMLNode (node);
644 pending_state_node_version = version;
645 pending_state_node_in = false;
646 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
649 if ((prop = node.property ("user-latency")) != 0) {
650 _user_latency = atoi (prop->value ());
657 IO::set_state_2X (const XMLNode& node, int version, bool in)
659 XMLProperty const * prop;
660 XMLNodeConstIterator iter;
663 /* force use of non-localized representation of decimal point,
664 since we use it a lot in XML files and so forth.
667 if (node.name() != state_node_name) {
668 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
672 if ((prop = node.property ("name")) != 0) {
673 set_name (prop->value());
676 if ((prop = node.property (X_("default-type"))) != 0) {
677 _default_type = DataType(prop->value());
678 assert(_default_type != DataType::NIL);
683 _direction = in ? Input : Output;
685 if (create_ports (node, version)) {
689 if (connecting_legal) {
691 if (make_connections_2X (node, version, in)) {
697 pending_state_node = new XMLNode (node);
698 pending_state_node_version = version;
699 pending_state_node_in = in;
700 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
707 IO::connecting_became_legal ()
711 assert (pending_state_node);
713 connection_legal_c.disconnect ();
715 // it's not required for TracksLive, as long as TracksLive's session does all the connections when it's being loaded
716 if (!Profile->get_trx() ) {
717 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
720 delete pending_state_node;
721 pending_state_node = 0;
726 boost::shared_ptr<Bundle>
727 IO::find_possible_bundle (const string &desired_name)
729 static const string digits = "0123456789";
730 const string &default_name = (_direction == Input ? _("in") : _("out"));
731 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
733 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
736 int bundle_number, mask;
737 string possible_name;
739 string::size_type last_non_digit_pos;
741 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
744 // find numeric suffix of desired name
747 last_non_digit_pos = desired_name.find_last_not_of(digits);
749 if (last_non_digit_pos != string::npos) {
751 s << desired_name.substr(last_non_digit_pos);
755 // see if it's a stereo connection e.g. "in 3+4"
757 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
758 string::size_type left_last_non_digit_pos;
760 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
762 if (left_last_non_digit_pos != string::npos) {
763 int left_bundle_number = 0;
765 s << desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
766 s >> left_bundle_number;
768 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
779 // find highest set bit
781 while ((mask <= bundle_number) && (mask <<= 1)) {}
783 // "wrap" bundle number into largest possible power of 2
788 if (bundle_number & mask) {
789 bundle_number &= ~mask;
792 s << default_name << " " << bundle_number + 1;
795 s << "+" << bundle_number + 2;
798 possible_name = s.str();
800 if ((c = _session.bundle_by_name (possible_name)) != 0) {
807 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
810 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
821 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
823 XMLProperty const * prop;
824 XMLNodeList children = node.children ();
826 uint32_t n_audio = 0;
828 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
830 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
831 n_audio = count (prop->value().begin(), prop->value().end(), '{');
832 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
834 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
835 n_audio = count (prop->value().begin(), prop->value().end(), '{');
836 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
842 cnt.set_audio (n_audio);
843 n = ChanCount::max (n, cnt);
849 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
851 if (version < 3000) {
852 return get_port_counts_2X (node, version, n, c);
855 XMLProperty const * prop;
856 XMLNodeConstIterator iter;
857 uint32_t n_audio = 0;
863 if ((prop = node.property ("connection")) != 0) {
865 if ((c = find_possible_bundle (prop->value())) != 0) {
866 n = ChanCount::max (n, c->nchannels());
871 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
873 if ((*iter)->name() == X_("Bundle")) {
874 prop = (*iter)->property ("name");
875 if ((c = find_possible_bundle (prop->value())) != 0) {
876 n = ChanCount::max (n, c->nchannels());
883 if ((*iter)->name() == X_("Port")) {
884 prop = (*iter)->property (X_("type"));
890 if (prop->value() == X_("audio")) {
891 cnt.set_audio (++n_audio);
892 } else if (prop->value() == X_("midi")) {
893 cnt.set_midi (++n_midi);
898 n = ChanCount::max (n, cnt);
903 IO::create_ports (const XMLNode& node, int version)
906 boost::shared_ptr<Bundle> c;
908 get_port_counts (node, version, n, c);
911 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
913 if (ensure_ports (n, true, this)) {
914 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
925 IO::make_connections (const XMLNode& node, int version, bool in)
927 if (version < 3000) {
928 return make_connections_2X (node, version, in);
931 XMLProperty const * prop;
933 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
935 if ((*i)->name() == "Bundle") {
936 XMLProperty const * prop = (*i)->property ("name");
938 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
940 connect_ports_to_bundle (b, true, this);
947 if ((*i)->name() == "Port") {
949 prop = (*i)->property (X_("name"));
955 boost::shared_ptr<Port> p = port_by_name (prop->value());
958 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
960 XMLNode* cnode = (*c);
962 if (cnode->name() != X_("Connection")) {
966 if ((prop = cnode->property (X_("other"))) == 0) {
971 connect (p, prop->value(), this);
982 IO::prepare_for_reset (XMLNode& node, const std::string& name)
985 node.add_property ("name", name);
987 /* now find connections and reset the name of the port
988 in one so that when we re-use it it will match
989 the name of the thing we're applying it to.
993 XMLNodeList children = node.children();
995 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
997 if ((*i)->name() == "Port") {
999 prop = (*i)->property (X_("name"));
1003 string old = prop->value();
1004 string::size_type slash = old.find ('/');
1006 if (slash != string::npos) {
1007 /* port name is of form: <IO-name>/<port-name> */
1010 new_name += old.substr (old.find ('/'));
1012 prop->set_value (new_name);
1021 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
1023 XMLProperty const * prop;
1025 /* XXX: bundles ("connections" as was) */
1027 if ((prop = node.property ("inputs")) != 0 && in) {
1029 string::size_type ostart = 0;
1030 string::size_type start = 0;
1031 string::size_type end = 0;
1034 vector<string> ports;
1036 string const str = prop->value ();
1038 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1041 if ((end = str.find_first_of ('}', start)) == string::npos) {
1042 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1046 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1047 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1054 for (int x = 0; x < n; ++x) {
1055 /* XXX: this is a bit of a hack; need to check if it's always valid */
1056 string::size_type const p = ports[x].find ("/out");
1057 if (p != string::npos) {
1058 ports[x].replace (p, 4, "/audio_out");
1060 if (NULL != nth(i).get())
1061 nth(i)->connect (ports[x]);
1071 if ((prop = node.property ("outputs")) != 0 && !in) {
1073 string::size_type ostart = 0;
1074 string::size_type start = 0;
1075 string::size_type end = 0;
1078 vector<string> ports;
1080 string const str = prop->value ();
1082 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1085 if ((end = str.find_first_of ('}', start)) == string::npos) {
1086 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
1090 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1091 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
1097 for (int x = 0; x < n; ++x) {
1098 /* XXX: this is a bit of a hack; need to check if it's always valid */
1099 string::size_type const p = ports[x].find ("/in");
1100 if (p != string::npos) {
1101 ports[x].replace (p, 3, "/audio_in");
1103 if (NULL != nth(i).get())
1104 nth(i)->connect (ports[x]);
1117 IO::set_ports (const string& str)
1119 vector<string> ports;
1123 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1128 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1130 // FIXME: audio-only
1131 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1136 string::size_type start = 0;
1137 string::size_type end = 0;
1138 string::size_type ostart = 0;
1139 for (int i = 0; (start = str.find_first_of ('{', ostart)) != string::npos; ++i) {
1142 if ((end = str.find_first_of ('}', start)) == string::npos) {
1143 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1147 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1148 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1154 for (int x = 0; x < n; ++x) {
1155 connect (nth (i), ports[x], this);
1166 IO::parse_io_string (const string& str, vector<string>& ports)
1168 string::size_type pos, opos;
1170 if (str.length() == 0) {
1178 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1179 ports.push_back (str.substr (opos, pos - opos));
1183 if (opos < str.length()) {
1184 ports.push_back (str.substr(opos));
1187 return ports.size();
1191 IO::parse_gain_string (const string& str, vector<string>& ports)
1193 string::size_type pos, opos;
1198 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1199 ports.push_back (str.substr (opos, pos - opos));
1203 if (opos < str.length()) {
1204 ports.push_back (str.substr(opos));
1207 return ports.size();
1211 IO::set_name (const string& requested_name)
1213 string name = requested_name;
1215 if (_name == name) {
1219 /* replace all colons in the name. i wish we didn't have to do this */
1221 replace_all (name, ":", "-");
1223 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1224 string current_name = i->name();
1225 current_name.replace (current_name.find (_name), _name.val().length(), name);
1226 i->set_name (current_name);
1229 bool const r = SessionObject::set_name (name);
1237 IO::set_pretty_name (const std::string& str)
1239 if (_pretty_name_prefix == str) {
1242 _pretty_name_prefix = str;
1243 apply_pretty_name ();
1247 IO::apply_pretty_name ()
1250 if (_pretty_name_prefix.empty ()) {
1253 for (PortSet::iterator i = _ports.begin (); i != _ports.end(); ++i, ++pn) {
1254 (*i)->set_pretty_name (string_compose (("%1/%2 %3"),
1255 _pretty_name_prefix,
1256 _direction == Output ? _("Out") : _("In"),
1262 IO::latency () const
1264 framecnt_t max_latency;
1269 /* io lock not taken - must be protected by other means */
1271 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1272 if ((latency = i->private_latency_range (_direction == Output).max) > max_latency) {
1273 DEBUG_TRACE (DEBUG::Latency, string_compose ("port %1 has %2 latency of %3 - use\n",
1275 ((_direction == Output) ? "PLAYBACK" : "CAPTURE"),
1277 max_latency = latency;
1281 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max %4 latency from %2 ports = %3\n",
1282 name(), _ports.num_ports(), max_latency,
1283 ((_direction == Output) ? "PLAYBACK" : "CAPTURE")));
1288 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, bool exclusive, void* src)
1290 BLOCK_PROCESS_CALLBACK ();
1293 Glib::Threads::Mutex::Lock lm2 (io_lock);
1296 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1297 i->disconnect_all ();
1301 c->connect (_bundle, _session.engine());
1303 /* If this is a UserBundle, make a note of what we've done */
1305 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1308 /* See if we already know about this one */
1309 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1310 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1314 if (i == _bundles_connected.end()) {
1315 /* We don't, so make a note */
1316 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1321 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1326 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1328 BLOCK_PROCESS_CALLBACK ();
1331 Glib::Threads::Mutex::Lock lm2 (io_lock);
1333 c->disconnect (_bundle, _session.engine());
1335 /* If this is a UserBundle, make a note of what we've done */
1337 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1340 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1341 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1345 if (i != _bundles_connected.end()) {
1347 _bundles_connected.erase (i);
1352 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1358 IO::disable_connecting ()
1360 connecting_legal = false;
1365 IO::enable_connecting ()
1367 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1368 connecting_legal = true;
1369 boost::optional<int> r = ConnectingLegal ();
1370 return r.get_value_or (0);
1374 IO::bundle_changed (Bundle::Change /*c*/)
1377 // connect_input_ports_to_bundle (_input_bundle, this);
1382 IO::build_legal_port_name (DataType type)
1384 const int name_size = AudioEngine::instance()->port_name_size();
1388 if (type == DataType::AUDIO) {
1389 suffix = X_("audio");
1390 } else if (type == DataType::MIDI) {
1391 suffix = X_("midi");
1393 throw unknown_type();
1396 /* note that if "in" or "out" are translated it will break a session
1397 across locale switches because a port's connection list will
1398 show (old) translated names, but the current port name will
1399 use the (new) translated name.
1403 if (_direction == Input) {
1404 suffix += X_("_return");
1406 suffix += X_("_send");
1409 if (_direction == Input) {
1410 suffix += X_("_in");
1412 suffix += X_("_out");
1416 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1418 limit = name_size - AudioEngine::instance()->my_name().length() - (suffix.length() + 5);
1420 std::vector<char> buf1(name_size+1);
1421 std::vector<char> buf2(name_size+1);
1423 /* colons are illegal in port names, so fix that */
1425 string nom = _name.val();
1426 replace_all (nom, ":", ";");
1428 snprintf (&buf1[0], name_size+1, ("%.*s/%s"), limit, nom.c_str(), suffix.c_str());
1430 int port_number = find_port_hole (&buf1[0]);
1431 snprintf (&buf2[0], name_size+1, "%s %d", &buf1[0], port_number);
1433 return string (&buf2[0]);
1437 IO::find_port_hole (const char* base)
1439 /* CALLER MUST HOLD IO LOCK */
1443 if (_ports.empty()) {
1447 /* we only allow up to 4 characters for the port number
1450 for (n = 1; n < 9999; ++n) {
1451 std::vector<char> buf (AudioEngine::instance()->port_name_size());
1452 PortSet::iterator i = _ports.begin();
1454 snprintf (&buf[0], buf.size()+1, _("%s %u"), base, n);
1456 for ( ; i != _ports.end(); ++i) {
1457 if (string(i->name()) == string(&buf[0])) {
1462 if (i == _ports.end()) {
1470 boost::shared_ptr<AudioPort>
1471 IO::audio(uint32_t n) const
1473 return _ports.nth_audio_port (n);
1477 boost::shared_ptr<MidiPort>
1478 IO::midi(uint32_t n) const
1480 return _ports.nth_midi_port (n);
1484 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1493 _bundle.reset (new Bundle (_direction == Input));
1496 _bundle->suspend_signals ();
1498 _bundle->remove_channels ();
1500 if (_direction == Input) {
1501 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1503 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1505 _bundle->set_name (buf);
1508 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1510 uint32_t const N = _ports.count().get (*i);
1511 for (uint32_t j = 0; j < N; ++j) {
1512 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1513 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1519 _bundle->resume_signals ();
1522 /** @return Bundles connected to our ports */
1524 IO::bundles_connected ()
1529 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1530 bundles.push_back ((*i)->bundle);
1533 /* Session bundles */
1534 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1535 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1536 if ((*i)->connected_to (_bundle, _session.engine())) {
1537 bundles.push_back (*i);
1543 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1545 if (_direction == Input) {
1546 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1547 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1548 bundles.push_back ((*i)->output()->bundle());
1552 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1553 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1554 bundles.push_back ((*i)->input()->bundle());
1563 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1566 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1570 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1574 if (t == DataType::AUDIO) {
1580 return c == 0 ? _("L") : _("R");
1582 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1588 snprintf (buf, sizeof(buf), _("%d"), (c + 1));
1597 IO::name_from_state (const XMLNode& node)
1599 XMLProperty const * prop;
1601 if ((prop = node.property ("name")) != 0) {
1602 return prop->value();
1609 IO::set_name_in_state (XMLNode& node, const string& new_name)
1611 node.add_property (X_("name"), new_name);
1612 XMLNodeList children = node.children ();
1613 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
1614 if ((*i)->name() == X_("Port")) {
1615 string const old_name = (*i)->property(X_("name"))->value();
1616 string const old_name_second_part = old_name.substr (old_name.find_first_of ("/") + 1);
1617 (*i)->add_property (X_("name"), string_compose ("%1/%2", new_name, old_name_second_part));
1623 IO::connected () const
1625 /* do we have any connections at all? */
1627 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1628 if (p->connected()) {
1637 IO::connected_to (boost::shared_ptr<const IO> other) const
1640 return connected ();
1643 assert (_direction != other->direction());
1646 uint32_t no = n_ports().n_total();
1647 uint32_t ni = other->n_ports ().n_total();
1649 for (i = 0; i < no; ++i) {
1650 for (j = 0; j < ni; ++j) {
1651 if ((NULL != nth(i).get()) && (NULL != other->nth(j).get())) {
1652 if (nth(i)->connected_to (other->nth(j)->name())) {
1663 IO::connected_to (const string& str) const
1665 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1666 if (i->connected_to (str)) {
1674 /** Call a processor's ::run() method, giving it our buffers
1675 * Caller must hold process lock.
1678 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
1680 /* don't read the data into new buffers - just use the port buffers directly */
1682 if (n_ports().n_total() == 0) {
1683 /* We have no ports, so nothing to process */
1687 _buffers.get_backend_port_addresses (_ports, nframes);
1689 proc->run (_buffers, start_frame, end_frame, nframes, true);
1694 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1696 assert(bufs.available() >= _ports.count());
1698 if (_ports.count() == ChanCount::ZERO) {
1702 bufs.set_count (_ports.count());
1704 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1705 PortSet::iterator i = _ports.begin(*t);
1706 BufferSet::iterator b = bufs.begin(*t);
1708 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1709 if (b == bufs.end(*t)) {
1714 for ( ; i != _ports.end(*t); ++i, ++b) {
1715 const Buffer& bb (i->get_buffer (nframes));
1716 b->read_from (bb, nframes);
1722 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1724 // Copy any buffers 1:1 to outputs
1726 PortSet::iterator o = _ports.begin(type);
1727 BufferSet::iterator i = bufs.begin(type);
1728 BufferSet::iterator prev = i;
1730 while (i != bufs.end(type) && o != _ports.end (type)) {
1731 Buffer& port_buffer (o->get_buffer (nframes));
1732 port_buffer.read_from (*i, nframes, offset);
1738 // Copy last buffer to any extra outputs
1740 while (o != _ports.end(type)) {
1741 Buffer& port_buffer (o->get_buffer (nframes));
1742 port_buffer.read_from (*prev, nframes, offset);
1747 boost::shared_ptr<Port>
1748 IO::port_by_name (const std::string& str) const
1750 /* to be called only from ::set_state() - no locking */
1752 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1754 if (i->name() == str) {
1755 return boost::const_pointer_cast<Port> (*i);
1759 return boost::shared_ptr<Port> ();
1763 IO::physically_connected () const
1765 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1766 if (i->physically_connected()) {
1775 IO::has_port (boost::shared_ptr<Port> p) const
1777 Glib::Threads::Mutex::Lock lm (io_lock);
1778 return _ports.contains (p);