Make Bundle::connected_to() able to check only a single DataType
[ardour.git] / libs / ardour / bundle.cc
index 1948024d91f7b1bc0100382529844eafaea653a7..33f71dcecd2149cca3341aca399cdc51bf0408f9 100644 (file)
 
 #include <algorithm>
 
-#include "pbd/failed_constructor.h"
-#include "ardour/ardour.h"
 #include "ardour/bundle.h"
 #include "ardour/audioengine.h"
 #include "ardour/port.h"
-#include "pbd/xml++.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -70,7 +67,7 @@ Bundle::Bundle (boost::shared_ptr<Bundle> other)
 ChanCount
 Bundle::nchannels () const
 {
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
 
        ChanCount c;
        for (vector<Channel>::const_iterator i = _channel.begin(); i != _channel.end(); ++i) {
@@ -80,12 +77,19 @@ Bundle::nchannels () const
        return c;
 }
 
+uint32_t
+Bundle::n_total () const
+{
+    /* Simpler and far more efficient than nchannels.n_total() */
+    return _channel.size();
+}
+
 Bundle::PortList const &
 Bundle::channel_ports (uint32_t c) const
 {
-       assert (c < nchannels().n_total());
+       assert (c < n_total());
 
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
        return _channel[c].ports;
 }
 
@@ -96,11 +100,11 @@ Bundle::channel_ports (uint32_t c) const
 void
 Bundle::add_port_to_channel (uint32_t ch, string portname)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
        assert (portname.find_first_of (':') != string::npos);
 
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel[ch].ports.push_back (portname);
        }
 
@@ -114,12 +118,12 @@ Bundle::add_port_to_channel (uint32_t ch, string portname)
 void
 Bundle::remove_port_from_channel (uint32_t ch, string portname)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
 
        bool changed = false;
 
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                PortList& pl = _channel[ch].ports;
                PortList::iterator i = find (pl.begin(), pl.end(), portname);
 
@@ -141,11 +145,11 @@ Bundle::remove_port_from_channel (uint32_t ch, string portname)
 void
 Bundle::set_port (uint32_t ch, string portname)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
        assert (portname.find_first_of (':') != string::npos);
 
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel[ch].ports.clear ();
                _channel[ch].ports.push_back (portname);
        }
@@ -158,7 +162,7 @@ void
 Bundle::add_channel (std::string const & n, DataType t)
 {
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel.push_back (Channel (n, t));
        }
 
@@ -170,7 +174,7 @@ void
 Bundle::add_channel (std::string const & n, DataType t, PortList p)
 {
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel.push_back (Channel (n, t, p));
        }
 
@@ -182,7 +186,7 @@ void
 Bundle::add_channel (std::string const & n, DataType t, std::string const & p)
 {
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel.push_back (Channel (n, t, p));
        }
 
@@ -192,9 +196,9 @@ Bundle::add_channel (std::string const & n, DataType t, std::string const & p)
 bool
 Bundle::port_attached_to_channel (uint32_t ch, std::string portname)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
 
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
        return (std::find (_channel[ch].ports.begin (), _channel[ch].ports.end (), portname) != _channel[ch].ports.end ());
 }
 
@@ -204,19 +208,25 @@ Bundle::port_attached_to_channel (uint32_t ch, std::string portname)
 void
 Bundle::remove_channel (uint32_t ch)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
 
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
        _channel.erase (_channel.begin () + ch);
+
+       lm.release();
+       emit_changed (ConfigurationChanged);
 }
 
 /** Remove all channels */
 void
 Bundle::remove_channels ()
 {
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
 
        _channel.clear ();
+
+       lm.release();
+       emit_changed (ConfigurationChanged);
 }
 
 /** @param p Port name.
@@ -225,7 +235,7 @@ Bundle::remove_channels ()
 bool
 Bundle::offers_port (std::string p) const
 {
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
 
        for (std::vector<Channel>::const_iterator i = _channel.begin(); i != _channel.end(); ++i) {
                for (PortList::const_iterator j = i->ports.begin(); j != i->ports.end(); ++j) {
@@ -244,7 +254,7 @@ Bundle::offers_port (std::string p) const
 bool
 Bundle::offers_port_alone (std::string p) const
 {
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
 
        for (std::vector<Channel>::const_iterator i = _channel.begin(); i != _channel.end(); ++i) {
                if (i->ports.size() == 1 && i->ports[0] == p) {
@@ -262,9 +272,9 @@ Bundle::offers_port_alone (std::string p) const
 std::string
 Bundle::channel_name (uint32_t ch) const
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
 
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
        return _channel[ch].name;
 }
 
@@ -275,10 +285,10 @@ Bundle::channel_name (uint32_t ch) const
 void
 Bundle::set_channel_name (uint32_t ch, std::string const & n)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
 
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel[ch].name = n;
        }
 
@@ -292,9 +302,9 @@ Bundle::set_channel_name (uint32_t ch, std::string const & n)
 void
 Bundle::add_channels_from_bundle (boost::shared_ptr<Bundle> other)
 {
-       uint32_t const ch = nchannels().n_total();
+       uint32_t const ch = n_total();
 
-       for (uint32_t i = 0; i < other->nchannels().n_total(); ++i) {
+       for (uint32_t i = 0; i < other->n_total(); ++i) {
 
                std::stringstream s;
                s << other->name() << " " << other->channel_name(i);
@@ -312,20 +322,37 @@ Bundle::add_channels_from_bundle (boost::shared_ptr<Bundle> other)
  *  with another bundle's channels.
  *  @param other Other bundle.
  *  @param engine AudioEngine to use to make the connections.
+ *  @param allow_partial whether to allow leaving unconnected channels types,
+ *              or require that the ChanCounts match exactly (default false).
  */
 void
-Bundle::connect (boost::shared_ptr<Bundle> other, AudioEngine & engine)
+Bundle::connect (boost::shared_ptr<Bundle> other, AudioEngine & engine,
+                 bool allow_partial)
 {
-       uint32_t const N = nchannels().n_total();
-       assert (N == other->nchannels().n_total());
+       ChanCount our_count = nchannels();
+       ChanCount other_count = other->nchannels();
 
-       for (uint32_t i = 0; i < N; ++i) {
-               Bundle::PortList const & our_ports = channel_ports (i);
-               Bundle::PortList const & other_ports = other->channel_ports (i);
+       if (!allow_partial && our_count != other_count) {
+               assert (our_count == other_count);
+               return;
+       }
 
-               for (Bundle::PortList::const_iterator j = our_ports.begin(); j != our_ports.end(); ++j) {
-                       for (Bundle::PortList::const_iterator k = other_ports.begin(); k != other_ports.end(); ++k) {
-                               engine.connect (*j, *k);
+       for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
+               uint32_t N = our_count.n(*t);
+               if (N != other_count.n(*t))
+                       continue;
+               for (uint32_t i = 0; i < N; ++i) {
+                       Bundle::PortList const & our_ports =
+                               channel_ports (type_channel_to_overall(*t, i));
+                       Bundle::PortList const & other_ports =
+                               other->channel_ports (other->type_channel_to_overall(*t, i));
+
+                       for (Bundle::PortList::const_iterator j = our_ports.begin();
+                                               j != our_ports.end(); ++j) {
+                               for (Bundle::PortList::const_iterator k = other_ports.begin();
+                                                       k != other_ports.end(); ++k) {
+                                       engine.connect (*j, *k);
+                               }
                        }
                }
        }
@@ -334,8 +361,8 @@ Bundle::connect (boost::shared_ptr<Bundle> other, AudioEngine & engine)
 void
 Bundle::disconnect (boost::shared_ptr<Bundle> other, AudioEngine & engine)
 {
-       uint32_t const N = nchannels().n_total();
-       assert (N == other->nchannels().n_total());
+       uint32_t const N = n_total();
+       assert (N == other->n_total());
 
        for (uint32_t i = 0; i < N; ++i) {
                Bundle::PortList const & our_ports = channel_ports (i);
@@ -354,8 +381,8 @@ void
 Bundle::remove_ports_from_channels ()
 {
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
-               for (uint32_t c = 0; c < _channel.size(); ++c) {
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
+               for (uint32_t c = 0; c < n_total(); ++c) {
                        _channel[c].ports.clear ();
                }
 
@@ -370,10 +397,10 @@ Bundle::remove_ports_from_channels ()
 void
 Bundle::remove_ports_from_channel (uint32_t ch)
 {
-       assert (ch < nchannels().n_total());
+       assert (ch < n_total());
 
        {
-               Glib::Mutex::Lock lm (_channel_mutex);
+               Glib::Threads::Mutex::Lock lm (_channel_mutex);
                _channel[ch].ports.clear ();
        }
 
@@ -407,30 +434,49 @@ Bundle::emit_changed (Change c)
        }
 }
 
+/* @return true if a Bundle is connected to another.
+ * @param type: if not NIL, restrict the check to channels of that type. */
 bool
-Bundle::connected_to (boost::shared_ptr<Bundle> other, AudioEngine & engine)
+Bundle::connected_to (boost::shared_ptr<Bundle> other, AudioEngine & engine,
+                      DataType type, bool exclusive)
 {
-       if (_ports_are_inputs == other->_ports_are_inputs || nchannels() != other->nchannels()) {
+       if (_ports_are_inputs == other->_ports_are_inputs)
                return false;
+
+       if (type == DataType::NIL) {
+               for (DataType::iterator t = DataType::begin();
+                                       t != DataType::end(); ++t) {
+                       if (!connected_to(other, engine, *t))
+                               return false;
+               }
+               return true;
        }
 
-       for (uint32_t i = 0; i < nchannels().n_total(); ++i) {
-               Bundle::PortList const & A = channel_ports (i);
-               Bundle::PortList const & B = other->channel_ports (i);
+       uint32_t N = nchannels().n(type);
+       if (other->nchannels().n(type) != N)
+               return false;
+
+       for (uint32_t i = 0; i < N; ++i) {
+               Bundle::PortList const & our_ports =
+                       channel_ports (type_channel_to_overall(type, i));
+               Bundle::PortList const & other_ports =
+                       other->channel_ports (other->type_channel_to_overall(type, i));
 
-               for (uint32_t j = 0; j < A.size(); ++j) {
-                       for (uint32_t k = 0; k < B.size(); ++k) {
+               for (Bundle::PortList::const_iterator j = our_ports.begin();
+                                                     j != our_ports.end(); ++j) {
+                       boost::shared_ptr<Port> p = engine.get_port_by_name(*j);
 
-                               boost::shared_ptr<Port> p = engine.get_port_by_name (A[j]);
-                               boost::shared_ptr<Port> q = engine.get_port_by_name (B[k]);
+                       for (Bundle::PortList::const_iterator k = other_ports.begin();
+                                                          k != other_ports.end(); ++k) {
+                               boost::shared_ptr<Port> q = engine.get_port_by_name(*k);
 
                                if (!p && !q) {
                                        return false;
                                }
 
-                               if (p && !p->connected_to (B[k])) {
+                               if (p && !p->connected_to (*k)) {
                                        return false;
-                               } else if (q && !q->connected_to (A[j])) {
+                               } else if (q && !q->connected_to (*j)) {
                                        return false;
                                }
                        }
@@ -440,6 +486,33 @@ Bundle::connected_to (boost::shared_ptr<Bundle> other, AudioEngine & engine)
        return true;
 }
 
+/** This must not be called in code executed as a response to a backend event,
+ *  as it uses the backend port_get_all_connections().
+ *  @return true if any of this bundle's channels are connected to anything.
+ */
+bool
+Bundle::connected_to_anything (AudioEngine& engine)
+{
+       PortManager& pm (engine);
+
+       for (uint32_t i = 0; i < n_total(); ++i) {
+               Bundle::PortList const & ports = channel_ports (i);
+
+               for (uint32_t j = 0; j < ports.size(); ++j) {
+
+                       /* ports[j] may not be an Ardour port, so use the port manager directly
+                          rather than doing it with Port.
+                       */
+
+                       if (pm.connected (ports[j])) {
+                               return true;
+                       }
+               }
+       }
+
+       return false;
+}
+
 void
 Bundle::set_ports_are_inputs ()
 {
@@ -470,9 +543,9 @@ Bundle::set_name (string const & n)
 bool
 Bundle::has_same_ports (boost::shared_ptr<Bundle> b) const
 {
-       uint32_t const N = nchannels().n_total();
+       uint32_t const N = n_total();
 
-       if (b->nchannels().n_total() != N) {
+       if (b->n_total() != N) {
                return false;
        }
 
@@ -490,9 +563,9 @@ Bundle::has_same_ports (boost::shared_ptr<Bundle> b) const
 DataType
 Bundle::channel_type (uint32_t c) const
 {
-       assert (c < nchannels().n_total());
+       assert (c < n_total());
 
-       Glib::Mutex::Lock lm (_channel_mutex);
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
        return _channel[c].type;
 }
 
@@ -500,7 +573,7 @@ ostream &
 operator<< (ostream& os, Bundle const & b)
 {
        os << "BUNDLE " << b.nchannels() << " channels: ";
-       for (uint32_t i = 0; i < b.nchannels().n_total(); ++i) {
+       for (uint32_t i = 0; i < b.n_total(); ++i) {
                os << "( ";
                Bundle::PortList const & pl = b.channel_ports (i);
                for (Bundle::PortList::const_iterator j = pl.begin(); j != pl.end(); ++j) {
@@ -511,3 +584,79 @@ operator<< (ostream& os, Bundle const & b)
 
        return os;
 }
+
+bool
+Bundle::operator== (Bundle const & other)
+{
+       return _channel == other._channel;
+}
+
+/** Given an index of a channel as the nth channel of a particular type,
+ *  return an index of that channel when considering channels of all types.
+ *
+ *  e.g. given a bundle with channels:
+ *          fred   [audio]
+ *          jim    [audio]
+ *          sheila [midi]
+ *
+ * If t == MIDI and c == 0, then we would return 2, as 2 is the index of the
+ * 0th MIDI channel.
+ *
+ * If t == NIL, we just return c.
+ */
+
+uint32_t
+Bundle::type_channel_to_overall (DataType t, uint32_t c) const
+{
+       if (t == DataType::NIL) {
+               return c;
+       }
+
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
+
+       vector<Channel>::const_iterator i = _channel.begin ();
+
+       uint32_t o = 0;
+
+       while (1) {
+
+               assert (i != _channel.end ());
+
+               if (i->type != t) {
+                       ++i;
+               } else {
+                       if (c == 0) {
+                               return o;
+                       }
+                       --c;
+               }
+
+               ++o;
+       }
+
+       abort(); /* NOTREACHED */
+       return -1;
+}
+
+/** Perform the reverse of type_channel_to_overall */
+uint32_t
+Bundle::overall_channel_to_type (DataType t, uint32_t c) const
+{
+       if (t == DataType::NIL) {
+               return c;
+       }
+
+       Glib::Threads::Mutex::Lock lm (_channel_mutex);
+
+       uint32_t s = 0;
+
+       vector<Channel>::const_iterator i = _channel.begin ();
+       for (uint32_t j = 0; j < c; ++j) {
+               if (i->type == t) {
+                       ++s;
+               }
+               ++i;
+       }
+
+       return s;
+}