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"
34 #include "pbd/locale_guard.h"
35 #include "pbd/types_convert.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/buffer.h"
39 #include "ardour/buffer_set.h"
40 #include "ardour/debug.h"
41 #include "ardour/io.h"
42 #include "ardour/port.h"
43 #include "ardour/profile.h"
44 #include "ardour/route.h"
45 #include "ardour/session.h"
46 #include "ardour/types_convert.h"
47 #include "ardour/user_bundle.h"
51 #define BLOCK_PROCESS_CALLBACK() Glib::Threads::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, bool sendish)
66 : SessionObject (s, name)
68 , _default_type (default_type)
72 Port::PostDisconnect.connect_same_thread (*this, boost::bind (&IO::disconnect_check, this, _1, _2));
73 pending_state_node = 0;
77 IO::IO (Session& s, const XMLNode& node, DataType dt, bool sendish)
78 : SessionObject(s, "unnamed io")
84 pending_state_node = 0;
85 Port::PostDisconnect.connect_same_thread (*this, boost::bind (&IO::disconnect_check, this, _1, _2));
87 set_state (node, Stateful::loading_state_version);
93 Glib::Threads::Mutex::Lock lm (io_lock);
95 DEBUG_TRACE (DEBUG::Ports, string_compose ("IO %1 unregisters %2 ports\n", name(), _ports.num_ports()));
97 BLOCK_PROCESS_CALLBACK ();
99 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
100 _session.engine().unregister_port (*i);
102 delete pending_state_node; pending_state_node = 0;
106 IO::disconnect_check (boost::shared_ptr<Port> a, boost::shared_ptr<Port> b)
108 if (_session.state_of_the_state () & Session::Deletion) {
111 /* this could be called from within our own ::disconnect() method(s)
112 or from somewhere that operates directly on a port. so, we don't
113 know for sure if we can take this lock or not. if we fail,
114 we assume that its safely locked by our own ::disconnect().
117 Glib::Threads::Mutex::Lock tm (io_lock, Glib::Threads::TRY_LOCK);
120 /* we took the lock, so we cannot be here from inside
123 if (_ports.contains (a) || _ports.contains (b)) {
124 changed (IOChange (IOChange::ConnectionsChanged), this); /* EMIT SIGNAL */
127 /* we didn't get the lock, so assume that we're inside
128 * ::disconnect(), and it will call changed() appropriately.
134 IO::increment_port_buffer_offset (pframes_t offset)
136 /* io_lock, not taken: function must be called from Session::process() calltree */
138 if (_direction == Output) {
139 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
140 i->increment_port_buffer_offset (offset);
146 IO::silence (framecnt_t nframes)
148 /* io_lock, not taken: function must be called from Session::process() calltree */
150 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
151 if (i->port_handle ()) {
152 i->get_buffer(nframes).silence (nframes);
157 /** Set _bundles_connected to those bundles that are connected such that every
158 * port on every bundle channel x is connected to port x in _ports.
161 IO::check_bundles_connected ()
163 std::vector<UserBundleInfo*> new_list;
165 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
167 uint32_t const N = (*i)->bundle->nchannels().n_total();
169 if (_ports.num_ports() < N) {
175 for (uint32_t j = 0; j < N; ++j) {
176 /* Every port on bundle channel j must be connected to our input j */
177 Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
178 for (uint32_t k = 0; k < pl.size(); ++k) {
179 if (_ports.port(j)->connected_to (pl[k]) == false) {
191 new_list.push_back (*i);
197 _bundles_connected = new_list;
202 IO::disconnect (boost::shared_ptr<Port> our_port, string other_port, void* src)
204 if (other_port.length() == 0 || our_port == 0) {
209 Glib::Threads::Mutex::Lock lm (io_lock);
211 /* check that our_port is really one of ours */
213 if ( ! _ports.contains(our_port)) {
217 /* disconnect it from the source */
219 if (our_port->disconnect (other_port)) {
220 error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
224 check_bundles_connected ();
227 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
229 _session.set_dirty ();
235 IO::connect (boost::shared_ptr<Port> our_port, string other_port, void* src)
237 if (other_port.length() == 0 || our_port == 0) {
242 Glib::Threads::Mutex::Lock lm (io_lock);
244 /* check that our_port is really one of ours */
246 if ( ! _ports.contains(our_port) ) {
250 /* connect it to the source */
252 if (our_port->connect (other_port)) {
256 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
257 _session.set_dirty ();
262 IO::remove_port (boost::shared_ptr<Port> port, void* src)
264 ChanCount before = _ports.count ();
265 ChanCount after = before;
266 after.set (port->type(), after.get (port->type()) - 1);
268 boost::optional<bool> const r = PortCountChanging (after); /* EMIT SIGNAL */
269 if (r.get_value_or (false)) {
276 BLOCK_PROCESS_CALLBACK ();
279 Glib::Threads::Mutex::Lock lm (io_lock);
281 if (_ports.remove(port)) {
282 change.type = IOChange::Type (change.type | IOChange::ConfigurationChanged);
283 change.before = before;
284 change.after = _ports.count ();
286 if (port->connected()) {
287 change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
290 _session.engine().unregister_port (port);
291 check_bundles_connected ();
295 PortCountChanged (n_ports()); /* EMIT SIGNAL */
297 if (change.type != IOChange::NoChange) {
298 changed (change, src);
299 _buffers.attach_buffers (_ports);
303 if (change.type & IOChange::ConfigurationChanged) {
307 if (change.type == IOChange::NoChange) {
311 _session.set_dirty ();
318 * @param destination Name of port to connect new port to.
319 * @param src Source for emitted ConfigurationChanged signal.
320 * @param type Data type of port. Default value (NIL) will use this IO's default type.
323 IO::add_port (string destination, void* src, DataType type)
325 boost::shared_ptr<Port> our_port;
327 if (type == DataType::NIL) {
328 type = _default_type;
331 ChanCount before = _ports.count ();
332 ChanCount after = before;
333 after.set (type, after.get (type) + 1);
335 bool const r = PortCountChanging (after); /* EMIT SIGNAL */
343 BLOCK_PROCESS_CALLBACK ();
347 Glib::Threads::Mutex::Lock lm (io_lock);
349 /* Create a new port */
351 string portname = build_legal_port_name (type);
353 if (_direction == Input) {
354 if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
355 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
359 if ((our_port = _session.engine().register_output_port (type, portname)) == 0) {
360 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
365 change.before = _ports.count ();
366 _ports.add (our_port);
369 PortCountChanged (n_ports()); /* EMIT SIGNAL */
370 change.type = IOChange::ConfigurationChanged;
371 change.after = _ports.count ();
372 changed (change, src); /* EMIT SIGNAL */
373 _buffers.attach_buffers (_ports);
376 if (!destination.empty()) {
377 if (our_port->connect (destination)) {
382 apply_pretty_name ();
384 _session.set_dirty ();
390 IO::disconnect (void* src)
393 Glib::Threads::Mutex::Lock lm (io_lock);
395 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
396 i->disconnect_all ();
399 check_bundles_connected ();
402 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
407 /** Caller must hold process lock */
409 IO::ensure_ports_locked (ChanCount count, bool clear, bool& changed)
411 #ifndef PLATFORM_WINDOWS
412 assert (!AudioEngine::instance()->process_lock().trylock());
415 boost::shared_ptr<Port> port;
416 vector<boost::shared_ptr<Port> > deleted_ports;
420 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
422 const size_t n = count.get(*t);
424 /* remove unused ports */
425 for (size_t i = n_ports().get(*t); i > n; --i) {
426 port = _ports.port(*t, i-1);
431 /* hold a reference to the port so that we can ensure
432 * that this thread, and not a JACK notification thread,
433 * holds the final reference.
436 deleted_ports.push_back (port);
437 _session.engine().unregister_port (port);
442 /* this will drop the final reference to the deleted ports,
443 * which will in turn call their destructors, which will in
444 * turn call the backend to unregister them.
446 * There will no connect/disconnect or register/unregister
447 * callbacks from the backend until we get here, because
448 * they are driven by the Port destructor. The destructor
449 * will not execute until we drop the final reference,
450 * which all happens right .... here.
452 deleted_ports.clear ();
454 /* create any necessary new ports */
455 while (n_ports().get(*t) < n) {
457 string portname = build_legal_port_name (*t);
461 if (_direction == Input) {
462 if ((port = _session.engine().register_input_port (*t, portname)) == 0) {
463 error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
467 if ((port = _session.engine().register_output_port (*t, portname)) == 0) {
468 error << string_compose(_("IO: cannot register output port %1"), portname) << endmsg;
474 catch (AudioEngine::PortRegistrationFailure& err) {
485 check_bundles_connected ();
486 PortCountChanged (n_ports()); /* EMIT SIGNAL */
487 _session.set_dirty ();
491 /* disconnect all existing ports so that we get a fresh start */
492 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
493 i->disconnect_all ();
500 /** Caller must hold process lock */
502 IO::ensure_ports (ChanCount count, bool clear, void* src)
504 #ifndef PLATFORM_WINDOWS
505 assert (!AudioEngine::instance()->process_lock().trylock());
508 bool changed = false;
510 if (count == n_ports() && !clear) {
516 change.before = _ports.count ();
519 Glib::Threads::Mutex::Lock im (io_lock);
520 if (ensure_ports_locked (count, clear, changed)) {
526 change.after = _ports.count ();
527 change.type = IOChange::ConfigurationChanged;
528 this->changed (change, src); /* EMIT SIGNAL */
529 _buffers.attach_buffers (_ports);
531 _session.set_dirty ();
537 /** Caller must hold process lock */
539 IO::ensure_io (ChanCount count, bool clear, void* src)
541 #ifndef PLATFORM_WINDOWS
542 assert (!AudioEngine::instance()->process_lock().trylock());
545 return ensure_ports (count, clear, src);
555 IO::state (bool /*full_state*/)
557 XMLNode* node = new XMLNode (state_node_name);
559 Glib::Threads::Mutex::Lock lm (io_lock);
561 node->set_property ("name", name());
562 node->set_property ("id", id ());
563 node->set_property ("direction", _direction);
564 node->set_property ("default-type", _default_type);
566 if (!_pretty_name_prefix.empty ()) {
567 node->set_property("pretty-name", _pretty_name_prefix);
570 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
571 XMLNode* n = new XMLNode ("Bundle");
572 n->set_property ("name", (*i)->bundle->name ());
573 node->add_child_nocopy (*n);
576 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
578 vector<string> connections;
580 XMLNode* pnode = new XMLNode (X_("Port"));
581 pnode->set_property (X_("type"), i->type());
582 pnode->set_property (X_("name"), i->name());
584 if (i->get_connections (connections)) {
585 vector<string>::const_iterator ci;
586 std::sort (connections.begin(), connections.end());
588 for (n = 0, ci = connections.begin(); ci != connections.end(); ++ci, ++n) {
590 /* if its a connection to our own port,
591 return only the port name, not the
592 whole thing. this allows connections
593 to be re-established even when our
594 client name is different.
597 XMLNode* cnode = new XMLNode (X_("Connection"));
599 cnode->set_property (X_("other"), _session.engine().make_port_name_relative (*ci));
600 pnode->add_child_nocopy (*cnode);
604 node->add_child_nocopy (*pnode);
607 node->set_property (X_("user-latency"), _user_latency);
613 IO::set_state (const XMLNode& node, int version)
615 /* callers for version < 3000 need to call set_state_2X directly, as A3 IOs
616 * are input OR output, not both, so the direction needs to be specified
619 assert (version >= 3000);
621 /* force use of non-localized representation of decimal point,
622 since we use it a lot in XML files and so forth.
625 if (node.name() != state_node_name) {
626 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
630 bool ignore_name = node.property ("ignore-name");
632 if (node.get_property ("name", name) && !ignore_name) {
636 if (node.get_property (X_("default-type"), _default_type)) {
637 assert(_default_type != DataType::NIL);
642 node.get_property ("direction", _direction);
644 if (create_ports (node, version)) {
648 // after create_ports, updates names
649 if (node.get_property ("pretty-name", name)) {
650 set_pretty_name (name);
653 if (connecting_legal) {
655 if (make_connections (node, version, false)) {
661 delete pending_state_node;
662 pending_state_node = new XMLNode (node);
663 pending_state_node_version = version;
664 pending_state_node_in = false;
665 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
668 node.get_property ("user-latency", _user_latency);
674 IO::set_state_2X (const XMLNode& node, int version, bool in)
676 XMLProperty const * prop;
677 XMLNodeConstIterator iter;
680 /* force use of non-localized representation of decimal point,
681 since we use it a lot in XML files and so forth.
684 if (node.name() != state_node_name) {
685 error << string_compose(_("incorrect XML node \"%1\" passed to IO object"), node.name()) << endmsg;
689 if ((prop = node.property ("name")) != 0) {
690 set_name (prop->value());
693 if ((prop = node.property (X_("default-type"))) != 0) {
694 _default_type = DataType(prop->value());
695 assert(_default_type != DataType::NIL);
700 _direction = in ? Input : Output;
702 if (create_ports (node, version)) {
706 if (connecting_legal) {
708 if (make_connections_2X (node, version, in)) {
714 delete pending_state_node;
715 pending_state_node = new XMLNode (node);
716 pending_state_node_version = version;
717 pending_state_node_in = in;
718 ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
725 IO::connecting_became_legal ()
729 assert (pending_state_node);
731 connection_legal_c.disconnect ();
733 // it's not required for TracksLive, as long as TracksLive's session does all the connections when it's being loaded
734 if (!Profile->get_trx() ) {
735 ret = make_connections (*pending_state_node, pending_state_node_version, pending_state_node_in);
738 delete pending_state_node;
739 pending_state_node = 0;
744 boost::shared_ptr<Bundle>
745 IO::find_possible_bundle (const string &desired_name)
747 static const string digits = "0123456789";
748 const string &default_name = (_direction == Input ? _("in") : _("out"));
749 const string &bundle_type_name = (_direction == Input ? _("input") : _("output"));
751 boost::shared_ptr<Bundle> c = _session.bundle_by_name (desired_name);
754 int bundle_number, mask;
755 string possible_name;
757 string::size_type last_non_digit_pos;
758 std::string bundle_number_str;
760 error << string_compose(_("Unknown bundle \"%1\" listed for %2 of %3"), desired_name, bundle_type_name, _name)
763 // find numeric suffix of desired name
766 last_non_digit_pos = desired_name.find_last_not_of(digits);
768 if (last_non_digit_pos != string::npos) {
769 bundle_number_str = desired_name.substr(last_non_digit_pos);
770 bundle_number = string_to<int32_t>(bundle_number_str);
773 // see if it's a stereo connection e.g. "in 3+4"
775 if (last_non_digit_pos > 1 && desired_name[last_non_digit_pos] == '+') {
776 string::size_type left_last_non_digit_pos;
778 left_last_non_digit_pos = desired_name.find_last_not_of(digits, last_non_digit_pos-1);
780 if (left_last_non_digit_pos != string::npos) {
781 int left_bundle_number = 0;
782 bundle_number_str = desired_name.substr(left_last_non_digit_pos, last_non_digit_pos-1);
783 left_bundle_number = string_to<int32_t>(bundle_number_str);
785 if (left_bundle_number > 0 && left_bundle_number + 1 == bundle_number) {
796 // find highest set bit
798 while ((mask <= bundle_number) && (mask <<= 1)) {}
800 // "wrap" bundle number into largest possible power of 2
805 if (bundle_number & mask) {
806 bundle_number &= ~mask;
808 std::string possible_name = default_name + " " + to_string(bundle_number + 1);
811 possible_name += "+" + to_string(bundle_number + 2);
814 if ((c = _session.bundle_by_name (possible_name)) != 0) {
821 info << string_compose (_("Bundle %1 was not available - \"%2\" used instead"), desired_name, possible_name)
824 error << string_compose(_("No %1 bundles available as a replacement"), bundle_type_name)
835 IO::get_port_counts_2X (XMLNode const & node, int /*version*/, ChanCount& n, boost::shared_ptr<Bundle>& /*c*/)
837 XMLProperty const * prop;
838 XMLNodeList children = node.children ();
840 uint32_t n_audio = 0;
842 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
844 if ((prop = node.property ("inputs")) != 0 && _direction == Input) {
845 n_audio = count (prop->value().begin(), prop->value().end(), '{');
846 } else if ((prop = node.property ("input-connection")) != 0 && _direction == Input) {
848 } else if ((prop = node.property ("outputs")) != 0 && _direction == Output) {
849 n_audio = count (prop->value().begin(), prop->value().end(), '{');
850 } else if ((prop = node.property ("output-connection")) != 0 && _direction == Output) {
856 cnt.set_audio (n_audio);
857 n = ChanCount::max (n, cnt);
863 IO::get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c)
865 if (version < 3000) {
866 return get_port_counts_2X (node, version, n, c);
869 XMLProperty const * prop;
870 XMLNodeConstIterator iter;
871 uint32_t n_audio = 0;
877 if ((prop = node.property ("connection")) != 0) {
879 if ((c = find_possible_bundle (prop->value())) != 0) {
880 n = ChanCount::max (n, c->nchannels());
885 for (iter = node.children().begin(); iter != node.children().end(); ++iter) {
887 if ((*iter)->name() == X_("Bundle")) {
888 prop = (*iter)->property ("name");
889 if ((c = find_possible_bundle (prop->value())) != 0) {
890 n = ChanCount::max (n, c->nchannels());
897 if ((*iter)->name() == X_("Port")) {
898 prop = (*iter)->property (X_("type"));
904 if (prop->value() == X_("audio")) {
905 cnt.set_audio (++n_audio);
906 } else if (prop->value() == X_("midi")) {
907 cnt.set_midi (++n_midi);
912 n = ChanCount::max (n, cnt);
917 IO::create_ports (const XMLNode& node, int version)
920 boost::shared_ptr<Bundle> c;
922 get_port_counts (node, version, n, c);
925 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
927 if (ensure_ports (n, true, this)) {
928 error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
939 IO::make_connections (const XMLNode& node, int version, bool in)
941 if (version < 3000) {
942 return make_connections_2X (node, version, in);
945 XMLProperty const * prop;
947 for (XMLNodeConstIterator i = node.children().begin(); i != node.children().end(); ++i) {
949 if ((*i)->name() == "Bundle") {
950 XMLProperty const * prop = (*i)->property ("name");
952 boost::shared_ptr<Bundle> b = find_possible_bundle (prop->value());
954 connect_ports_to_bundle (b, true, this);
961 if ((*i)->name() == "Port") {
963 prop = (*i)->property (X_("name"));
969 boost::shared_ptr<Port> p = port_by_name (prop->value());
972 for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
974 XMLNode* cnode = (*c);
976 if (cnode->name() != X_("Connection")) {
980 if ((prop = cnode->property (X_("other"))) == 0) {
985 connect (p, prop->value(), this);
996 IO::prepare_for_reset (XMLNode& node, const std::string& name)
999 node.set_property ("name", name);
1001 /* now find connections and reset the name of the port
1002 in one so that when we re-use it it will match
1003 the name of the thing we're applying it to.
1007 XMLNodeList children = node.children();
1009 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
1011 if ((*i)->name() == "Port") {
1013 prop = (*i)->property (X_("name"));
1017 string old = prop->value();
1018 string::size_type slash = old.find ('/');
1020 if (slash != string::npos) {
1021 /* port name is of form: <IO-name>/<port-name> */
1024 new_name += old.substr (old.find ('/'));
1026 prop->set_value (new_name);
1035 IO::make_connections_2X (const XMLNode& node, int /*version*/, bool in)
1037 XMLProperty const * prop;
1039 /* XXX: bundles ("connections" as was) */
1041 if ((prop = node.property ("inputs")) != 0 && in) {
1043 string::size_type ostart = 0;
1044 string::size_type start = 0;
1045 string::size_type end = 0;
1048 vector<string> ports;
1050 string const str = prop->value ();
1052 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1055 if ((end = str.find_first_of ('}', start)) == string::npos) {
1056 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1060 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1061 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1068 for (int x = 0; x < n; ++x) {
1069 /* XXX: this is a bit of a hack; need to check if it's always valid */
1070 string::size_type const p = ports[x].find ("/out");
1071 if (p != string::npos) {
1072 ports[x].replace (p, 4, "/audio_out");
1074 if (NULL != nth(i).get())
1075 nth(i)->connect (ports[x]);
1085 if ((prop = node.property ("outputs")) != 0 && !in) {
1087 string::size_type ostart = 0;
1088 string::size_type start = 0;
1089 string::size_type end = 0;
1092 vector<string> ports;
1094 string const str = prop->value ();
1096 while ((start = str.find_first_of ('{', ostart)) != string::npos) {
1099 if ((end = str.find_first_of ('}', start)) == string::npos) {
1100 error << string_compose(_("IO: badly formed string in XML node for outputs \"%1\""), str) << endmsg;
1104 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1105 error << string_compose(_("IO: bad output string in XML node \"%1\""), str) << endmsg;
1111 for (int x = 0; x < n; ++x) {
1112 /* XXX: this is a bit of a hack; need to check if it's always valid */
1113 string::size_type const p = ports[x].find ("/in");
1114 if (p != string::npos) {
1115 ports[x].replace (p, 3, "/audio_in");
1117 if (NULL != nth(i).get())
1118 nth(i)->connect (ports[x]);
1131 IO::set_ports (const string& str)
1133 vector<string> ports;
1137 if ((nports = count (str.begin(), str.end(), '{')) == 0) {
1142 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1144 // FIXME: audio-only
1145 if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
1150 string::size_type start = 0;
1151 string::size_type end = 0;
1152 string::size_type ostart = 0;
1153 for (int i = 0; (start = str.find_first_of ('{', ostart)) != string::npos; ++i) {
1156 if ((end = str.find_first_of ('}', start)) == string::npos) {
1157 error << string_compose(_("IO: badly formed string in XML node for inputs \"%1\""), str) << endmsg;
1161 if ((n = parse_io_string (str.substr (start, end - start), ports)) < 0) {
1162 error << string_compose(_("bad input string in XML node \"%1\""), str) << endmsg;
1168 for (int x = 0; x < n; ++x) {
1169 connect (nth (i), ports[x], this);
1180 IO::parse_io_string (const string& str, vector<string>& ports)
1182 string::size_type pos, opos;
1184 if (str.length() == 0) {
1192 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1193 ports.push_back (str.substr (opos, pos - opos));
1197 if (opos < str.length()) {
1198 ports.push_back (str.substr(opos));
1201 return ports.size();
1205 IO::parse_gain_string (const string& str, vector<string>& ports)
1207 string::size_type pos, opos;
1212 while ((pos = str.find_first_of (',', opos)) != string::npos) {
1213 ports.push_back (str.substr (opos, pos - opos));
1217 if (opos < str.length()) {
1218 ports.push_back (str.substr(opos));
1221 return ports.size();
1225 IO::set_name (const string& requested_name)
1227 string name = requested_name;
1229 if (_name == name) {
1233 /* replace all colons in the name. i wish we didn't have to do this */
1235 replace_all (name, ":", "-");
1237 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1238 string current_name = i->name();
1239 current_name.replace (current_name.find (_name), _name.val().length(), name);
1240 i->set_name (current_name);
1243 bool const r = SessionObject::set_name (name);
1251 IO::set_pretty_name (const std::string& str)
1253 if (_pretty_name_prefix == str) {
1256 _pretty_name_prefix = str;
1257 apply_pretty_name ();
1261 IO::apply_pretty_name ()
1264 if (_pretty_name_prefix.empty ()) {
1267 for (PortSet::iterator i = _ports.begin (); i != _ports.end(); ++i, ++pn) {
1268 (*i)->set_pretty_name (string_compose (("%1/%2 %3"),
1269 _pretty_name_prefix,
1270 _direction == Output ? _("Out") : _("In"),
1276 IO::latency () const
1278 framecnt_t max_latency;
1283 /* io lock not taken - must be protected by other means */
1285 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1286 if ((latency = i->private_latency_range (_direction == Output).max) > max_latency) {
1287 DEBUG_TRACE (DEBUG::Latency, string_compose ("port %1 has %2 latency of %3 - use\n",
1289 ((_direction == Output) ? "PLAYBACK" : "CAPTURE"),
1291 max_latency = latency;
1295 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max %4 latency from %2 ports = %3\n",
1296 name(), _ports.num_ports(), max_latency,
1297 ((_direction == Output) ? "PLAYBACK" : "CAPTURE")));
1302 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, bool exclusive, void* src) {
1303 return connect_ports_to_bundle(c, exclusive, false, src);
1307 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, bool exclusive,
1308 bool allow_partial, void* src)
1310 BLOCK_PROCESS_CALLBACK ();
1313 Glib::Threads::Mutex::Lock lm2 (io_lock);
1316 for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
1317 i->disconnect_all ();
1321 c->connect (_bundle, _session.engine(), allow_partial);
1323 /* If this is a UserBundle, make a note of what we've done */
1325 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1328 /* See if we already know about this one */
1329 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1330 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1334 if (i == _bundles_connected.end()) {
1335 /* We don't, so make a note */
1336 _bundles_connected.push_back (new UserBundleInfo (this, ub));
1341 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1346 IO::disconnect_ports_from_bundle (boost::shared_ptr<Bundle> c, void* src)
1348 BLOCK_PROCESS_CALLBACK ();
1351 Glib::Threads::Mutex::Lock lm2 (io_lock);
1353 c->disconnect (_bundle, _session.engine());
1355 /* If this is a UserBundle, make a note of what we've done */
1357 boost::shared_ptr<UserBundle> ub = boost::dynamic_pointer_cast<UserBundle> (c);
1360 std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin();
1361 while (i != _bundles_connected.end() && (*i)->bundle != ub) {
1365 if (i != _bundles_connected.end()) {
1367 _bundles_connected.erase (i);
1372 changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
1378 IO::disable_connecting ()
1380 connecting_legal = false;
1385 IO::enable_connecting ()
1387 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1388 connecting_legal = true;
1389 boost::optional<int> r = ConnectingLegal ();
1390 return r.get_value_or (0);
1394 IO::bundle_changed (Bundle::Change /*c*/)
1397 // connect_input_ports_to_bundle (_input_bundle, this);
1402 IO::build_legal_port_name (DataType type)
1404 const int name_size = AudioEngine::instance()->port_name_size();
1408 if (type == DataType::AUDIO) {
1409 suffix = X_("audio");
1410 } else if (type == DataType::MIDI) {
1411 suffix = X_("midi");
1413 throw unknown_type();
1416 /* note that if "in" or "out" are translated it will break a session
1417 across locale switches because a port's connection list will
1418 show (old) translated names, but the current port name will
1419 use the (new) translated name.
1423 if (_direction == Input) {
1424 suffix += X_("_return");
1426 suffix += X_("_send");
1429 if (_direction == Input) {
1430 suffix += X_("_in");
1432 suffix += X_("_out");
1436 // allow up to 4 digits for the output port number, plus the slash, suffix and extra space
1438 limit = name_size - AudioEngine::instance()->my_name().length() - (suffix.length() + 5);
1440 std::vector<char> buf1(name_size+1);
1441 std::vector<char> buf2(name_size+1);
1443 /* colons are illegal in port names, so fix that */
1445 string nom = _name.val();
1446 replace_all (nom, ":", ";");
1448 snprintf (&buf1[0], name_size+1, ("%.*s/%s"), limit, nom.c_str(), suffix.c_str());
1450 int port_number = find_port_hole (&buf1[0]);
1451 snprintf (&buf2[0], name_size+1, "%s %d", &buf1[0], port_number);
1453 return string (&buf2[0]);
1457 IO::find_port_hole (const char* base)
1459 /* CALLER MUST HOLD IO LOCK */
1463 if (_ports.empty()) {
1467 /* we only allow up to 4 characters for the port number
1470 for (n = 1; n < 9999; ++n) {
1471 std::vector<char> buf (AudioEngine::instance()->port_name_size());
1472 PortSet::iterator i = _ports.begin();
1474 snprintf (&buf[0], buf.size()+1, _("%s %u"), base, n);
1476 for ( ; i != _ports.end(); ++i) {
1477 if (string(i->name()) == string(&buf[0])) {
1482 if (i == _ports.end()) {
1490 boost::shared_ptr<AudioPort>
1491 IO::audio(uint32_t n) const
1493 return _ports.nth_audio_port (n);
1497 boost::shared_ptr<MidiPort>
1498 IO::midi(uint32_t n) const
1500 return _ports.nth_midi_port (n);
1504 * Setup a bundle that describe our inputs or outputs. Also creates the bundle if necessary.
1513 _bundle.reset (new Bundle (_direction == Input));
1516 _bundle->suspend_signals ();
1518 _bundle->remove_channels ();
1520 if (_direction == Input) {
1521 snprintf(buf, sizeof (buf), _("%s in"), _name.val().c_str());
1523 snprintf(buf, sizeof (buf), _("%s out"), _name.val().c_str());
1525 _bundle->set_name (buf);
1528 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1530 uint32_t const N = _ports.count().get (*i);
1531 for (uint32_t j = 0; j < N; ++j) {
1532 _bundle->add_channel (bundle_channel_name (j, N, *i), *i);
1533 _bundle->set_port (c, _session.engine().make_port_name_non_relative (_ports.port(*i, j)->name()));
1539 _bundle->resume_signals ();
1542 /** @return Bundles connected to our ports */
1544 IO::bundles_connected ()
1549 for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
1550 bundles.push_back ((*i)->bundle);
1553 /* Session bundles */
1554 boost::shared_ptr<ARDOUR::BundleList> b = _session.bundles ();
1555 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
1556 if ((*i)->connected_to (_bundle, _session.engine())) {
1557 bundles.push_back (*i);
1563 boost::shared_ptr<ARDOUR::RouteList> r = _session.get_routes ();
1565 if (_direction == Input) {
1566 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1567 if ((*i)->output()->bundle()->connected_to (_bundle, _session.engine())) {
1568 bundles.push_back ((*i)->output()->bundle());
1572 for (ARDOUR::RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1573 if ((*i)->input()->bundle()->connected_to (_bundle, _session.engine())) {
1574 bundles.push_back ((*i)->input()->bundle());
1583 IO::UserBundleInfo::UserBundleInfo (IO* io, boost::shared_ptr<UserBundle> b)
1586 b->Changed.connect_same_thread (changed, boost::bind (&IO::bundle_changed, io, _1));
1590 IO::bundle_channel_name (uint32_t c, uint32_t n, DataType t) const
1594 if (t == DataType::AUDIO) {
1600 return c == 0 ? _("L") : _("R");
1602 snprintf (buf, sizeof(buf), "%d", (c + 1));
1608 snprintf (buf, sizeof(buf), "%d", (c + 1));
1617 IO::name_from_state (const XMLNode& node)
1619 XMLProperty const * prop;
1621 if ((prop = node.property ("name")) != 0) {
1622 return prop->value();
1629 IO::set_name_in_state (XMLNode& node, const string& new_name)
1631 node.set_property (X_("name"), new_name);
1632 XMLNodeList children = node.children ();
1633 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
1634 if ((*i)->name() == X_("Port")) {
1635 string const old_name = (*i)->property(X_("name"))->value();
1636 string const old_name_second_part = old_name.substr (old_name.find_first_of ("/") + 1);
1637 (*i)->set_property (X_("name"), string_compose ("%1/%2", new_name, old_name_second_part));
1643 IO::connected () const
1645 /* do we have any connections at all? */
1647 for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
1648 if (p->connected()) {
1657 IO::connected_to (boost::shared_ptr<const IO> other) const
1660 return connected ();
1663 assert (_direction != other->direction());
1666 uint32_t no = n_ports().n_total();
1667 uint32_t ni = other->n_ports ().n_total();
1669 for (i = 0; i < no; ++i) {
1670 for (j = 0; j < ni; ++j) {
1671 if ((NULL != nth(i).get()) && (NULL != other->nth(j).get())) {
1672 if (nth(i)->connected_to (other->nth(j)->name())) {
1683 IO::connected_to (const string& str) const
1685 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1686 if (i->connected_to (str)) {
1694 /** Call a processor's ::run() method, giving it our buffers
1695 * Caller must hold process lock.
1698 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes)
1700 /* don't read the data into new buffers - just use the port buffers directly */
1702 if (n_ports().n_total() == 0) {
1703 /* We have no ports, so nothing to process */
1707 _buffers.get_backend_port_addresses (_ports, nframes);
1709 proc->run (_buffers, start_frame, end_frame, speed, nframes, true);
1714 IO::collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset)
1716 assert(bufs.available() >= _ports.count());
1718 if (_ports.count() == ChanCount::ZERO) {
1722 bufs.set_count (_ports.count());
1724 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
1725 PortSet::iterator i = _ports.begin(*t);
1726 BufferSet::iterator b = bufs.begin(*t);
1728 for (uint32_t off = 0; off < offset.get(*t); ++off, ++b) {
1729 if (b == bufs.end(*t)) {
1734 for ( ; i != _ports.end(*t); ++i, ++b) {
1735 const Buffer& bb (i->get_buffer (nframes));
1736 b->read_from (bb, nframes);
1742 IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset)
1744 PortSet::iterator o = _ports.begin(type);
1745 BufferSet::iterator i = bufs.begin(type);
1746 BufferSet::iterator prev = i;
1748 assert(i != bufs.end(type)); // or second loop will crash
1750 // Copy any buffers 1:1 to outputs
1752 while (i != bufs.end(type) && o != _ports.end (type)) {
1753 Buffer& port_buffer (o->get_buffer (nframes));
1754 port_buffer.read_from (*i, nframes, offset);
1760 // Copy last buffer to any extra outputs
1762 while (o != _ports.end(type)) {
1763 Buffer& port_buffer (o->get_buffer (nframes));
1764 port_buffer.read_from (*prev, nframes, offset);
1769 boost::shared_ptr<Port>
1770 IO::port_by_name (const std::string& str) const
1772 /* to be called only from ::set_state() - no locking */
1774 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1776 if (i->name() == str) {
1777 return boost::const_pointer_cast<Port> (*i);
1781 return boost::shared_ptr<Port> ();
1785 IO::physically_connected () const
1787 for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
1788 if (i->physically_connected()) {
1797 IO::has_port (boost::shared_ptr<Port> p) const
1799 Glib::Threads::Mutex::Lock lm (io_lock);
1800 return _ports.contains (p);