Allow right-click on region list to select the region. Fixes #3129.
[ardour.git] / gtk2_ardour / port_group.cc
index 3de45eee73da44a36d1b419f585cb8b471dbaca3..8dc91edb3b46ee7af4db96c42c42626ddc36b802 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2002-2009 Paul Davis 
+    Copyright (C) 2002-2009 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include "port_group.h"
-#include "i18n.h"
-#include "ardour/session.h"
+#include <cstring>
+#include <boost/shared_ptr.hpp>
+
 #include "ardour/audio_track.h"
-#include "ardour/midi_track.h"
 #include "ardour/audioengine.h"
-#include <boost/shared_ptr.hpp>
-#include <cstring>
+#include "ardour/bundle.h"
+#include "ardour/user_bundle.h"
+#include "ardour/io_processor.h"
+#include "ardour/midi_track.h"
+#include "ardour/port.h"
+#include "ardour/session.h"
+#include "ardour/auditioner.h"
+
+#include "gui_thread.h"
+#include "port_group.h"
+#include "port_matrix.h"
+#include "time_axis_view.h"
+#include "public_editor.h"
+
+#include "i18n.h"
 
 using namespace std;
 using namespace Gtk;
+using namespace ARDOUR;
 
-/** Add a port to a group.
- *  @param p Port name, with or without prefix.
+/** PortGroup constructor.
+ * @param n Name.
  */
-void
-PortGroup::add (std::string const & p)
+PortGroup::PortGroup (std::string const & n)
+       : name (n)
 {
-       if (prefix.empty() == false && p.substr (0, prefix.length()) == prefix) {
-               ports.push_back (p.substr (prefix.length()));
-       } else {
-               ports.push_back (p);
+
+}
+
+PortGroup::~PortGroup()
+{
+       for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
+               delete *i;
        }
+       _bundles.clear ();
 }
 
-/** PortGroupUI constructor.
- *  @param m PortMatrix to work for.
- *  @Param g PortGroup to represent.
+/** Add a bundle to a group.
+ *  @param b Bundle.
+ *  @param allow_dups true to allow the group to contain more than one bundle with the same port, otherwise false.
  */
+void
+PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
+{
+       add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
+}
 
-PortGroupUI::PortGroupUI (PortMatrix& m, PortGroup& g)
-       : _port_matrix (m)
-       , _port_group (g)
-       , _ignore_check_button_toggle (false)
-       , _visibility_checkbutton (g.name)
+/** Add a bundle to a group.
+ *  @param b Bundle.
+ *  @param io IO whose ports are in the bundle.
+ */
+void
+PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
 {
-       _port_group.visible = true;
-       _ignore_check_button_toggle = false;
-       _visibility_checkbutton.signal_toggled().connect (sigc::mem_fun (*this, &PortGroupUI::visibility_checkbutton_toggled));
+       add_bundle_internal (b, io, false, Gdk::Color (), false);
 }
 
-/** The visibility of a PortGroupUI has been toggled */
+/** Add a bundle to a group.
+ *  @param b Bundle.
+ *  @param c Colour to represent the bundle with.
+ */
 void
-PortGroupUI::visibility_checkbutton_toggled ()
+PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
 {
-       _port_group.visible = _visibility_checkbutton.get_active ();
+       add_bundle_internal (b, io, true, c, false);
 }
 
-/** @return Checkbutton used to toggle visibility */
-Widget&
-PortGroupUI::get_visibility_checkbutton ()
+PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
+       : bundle (b)
+       , io (iop)
+       , colour (c)
+       , has_colour (has_c)
 {
-       return _visibility_checkbutton;
 }
 
+void
+PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
+{
+       assert (b.get());
+
+       if (!allow_dups) {
+               
+               /* don't add this bundle if we already have one with the same ports */
+               
+               BundleList::iterator i = _bundles.begin ();
+               while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
+                       ++i;
+               }
+               
+               if (i != _bundles.end ()) {
+                       return;
+               }
+       }
+
+       BundleRecord* br = new BundleRecord (b, io, colour, has_colour);
+       b->Changed.connect (br->changed_connection, invalidator (*this), ui_bind (&PortGroup::bundle_changed, this, _1), gui_context());
+       _bundles.push_back (br);
+
+       Changed ();     
+}
+
+void
+PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
+{
+       assert (b.get());
+
+       BundleList::iterator i = _bundles.begin ();
+       while (i != _bundles.end() && (*i)->bundle != b) {
+               ++i;
+       }
+
+       if (i == _bundles.end()) {
+               return;
+       }
+
+       delete *i;
+       _bundles.erase (i);
+
+       Changed ();
+}
 
-/** Handle a toggle of a port check button */
 void
-PortGroupUI::port_checkbutton_toggled (CheckButton* b, int r, int c)
+PortGroup::bundle_changed (Bundle::Change c)
+{
+       BundleChanged (c);
+}
+
+
+void
+PortGroup::clear ()
+{
+       for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
+               delete *i;
+       }
+
+       _bundles.clear ();
+       Changed ();
+}
+
+bool
+PortGroup::has_port (std::string const& p) const
+{
+       for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
+               if ((*i)->bundle->offers_port_alone (p)) {
+                       return true;
+               }
+       }
+
+       return false;
+}
+
+boost::shared_ptr<Bundle>
+PortGroup::only_bundle ()
+{
+       assert (_bundles.size() == 1);
+       return _bundles.front()->bundle;
+}
+
+
+uint32_t
+PortGroup::total_channels () const
 {
-       if (_ignore_check_button_toggle == false) {
-               // _port_matrix.hide_group (_port_group);
+       uint32_t n = 0;
+       for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
+               n += (*i)->bundle->nchannels ();
        }
+
+       return n;
+}
+
+boost::shared_ptr<IO>
+PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
+{
+       BundleList::const_iterator i = _bundles.begin ();
+       while (i != _bundles.end() && (*i)->bundle != b) {
+               ++i;
+       }
+
+       if (i == _bundles.end()) {
+               return boost::shared_ptr<IO> ();
+       }
+
+       return (*i)->io;
 }
 
-/** Set up visibility of the port group according to PortGroup::visible */
+/** Remove bundles whose channels are already represented by other, larger bundles */
 void
-PortGroupUI::setup_visibility ()
+PortGroup::remove_duplicates ()
 {
-       if (_visibility_checkbutton.get_active () != _port_group.visible) {
-               _visibility_checkbutton.set_active (_port_group.visible);
+       BundleList::iterator i = _bundles.begin();
+       while (i != _bundles.end()) {
+
+               BundleList::iterator tmp = i;
+               ++tmp;
+
+               bool remove = false;
+
+               for (BundleList::iterator j = _bundles.begin(); j != _bundles.end(); ++j) {
+
+                       if ((*j)->bundle->nchannels() > (*i)->bundle->nchannels()) {
+                               /* this bundle is larger */
+
+                               uint32_t k = 0;
+                               while (k < (*i)->bundle->nchannels()) {
+                                       /* see if this channel on *i has an equivalent on *j */
+                                       uint32_t l = 0;
+                                       while (l < (*j)->bundle->nchannels() && (*i)->bundle->channel_ports (k) != (*j)->bundle->channel_ports (l)) {
+                                               ++l;
+                                       }
+
+                                       if (l == (*j)->bundle->nchannels()) {
+                                               /* it does not */
+                                               break;
+                                       }
+
+                                       ++k;
+                               }
+
+                               if (k == (*i)->bundle->nchannels ()) {
+                                       /* all channels on *i are represented by the larger bundle *j, so remove *i */
+                                       remove = true;
+                                       break;
+                               }
+                       }
+               }
+               
+               if (remove) {
+                       _bundles.erase (i);
+               }
+               
+               i = tmp;
        }
 }
 
+
 /** PortGroupList constructor.
- *  @param session Session to get ports from.
- *  @param type Type of ports to offer (audio or MIDI)
- *  @param offer_inputs true to offer output ports, otherwise false.
- *  @param mask Mask of groups to make visible by default.
  */
+PortGroupList::PortGroupList ()
+       : _type (DataType::AUDIO), _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
+{
 
-PortGroupList::PortGroupList (ARDOUR::Session & session, ARDOUR::DataType type, bool offer_inputs, Mask mask)
-       : _session (session), _type (type), _offer_inputs (offer_inputs),
-         _buss (_("Bus"), "ardour:", mask & BUSS),
-         _track (_("Track"), "ardour:", mask & TRACK),
-         _system (_("System"), "system:", mask & SYSTEM),
-         _other (_("Other"), "", mask & OTHER)
+}
+
+PortGroupList::~PortGroupList() 
 {
-       refresh ();
+       /* XXX need to clean up bundles, but ownership shared with PortGroups */
 }
 
-/** Find or re-find all our ports and set up our lists */
 void
-PortGroupList::refresh ()
+PortGroupList::set_type (DataType t)
 {
+       _type = t;
        clear ();
-       
-       _buss.ports.clear ();
-       _track.ports.clear ();
-       _system.ports.clear ();
-       _other.ports.clear ();
+}
 
-       /* Find the ports provided by ardour; we can't derive their type just from their
-          names, so we'll have to be more devious. 
-       */
+void
+PortGroupList::maybe_add_processor_to_list (
+       boost::weak_ptr<Processor> wp, list<boost::shared_ptr<Bundle> >* route_bundles, bool inputs, set<boost::shared_ptr<IO> >& used_io
+       )
+{
+       boost::shared_ptr<Processor> p (wp.lock());
+
+       if (!p) {
+               return;
+       }
+
+       boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
+
+       if (iop) {
+
+               boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
+
+               if (io && used_io.find (io) == used_io.end()) {
+                       route_bundles->push_back (io->bundle ());
+                       used_io.insert (io);
+               }
+       }
+}
+
+
+/** Gather bundles from around the system and put them in this PortGroupList */
+void
+PortGroupList::gather (ARDOUR::Session* session, bool inputs, bool allow_dups)
+{
+       clear ();
+
+       if (session == 0) {
+               return;
+       }
+
+       boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
+       boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
+       boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
+       boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
+       boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
+
+       /* Find the bundles for routes.  We use the RouteBundle class to join
+          the route's input/output and processor bundles together so that they
+          are presented as one bundle in the matrix. */
+
+       boost::shared_ptr<RouteList> routes = session->get_routes ();
+
+       for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
+
+               list<boost::shared_ptr<Bundle> > route_bundles;
 
-       boost::shared_ptr<ARDOUR::Session::RouteList> routes = _session.get_routes ();
+               /* keep track of IOs that we have taken bundles from,
+                  so that we can avoid taking the same IO from both
+                  Route::output() and the main_outs Delivery */
 
-       for (ARDOUR::Session::RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
+               set<boost::shared_ptr<IO> > used_io;
+               boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
+               used_io.insert (io);
 
-               PortGroup* g = 0;
+               route_bundles.push_back (io->bundle ());
 
-               if (_type == ARDOUR::DataType::AUDIO) {
+               (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &route_bundles, inputs, used_io));
 
-                       if (boost::dynamic_pointer_cast<ARDOUR::AudioTrack> (*i)) {
-                               g = &_track;
-                       } else if (!boost::dynamic_pointer_cast<ARDOUR::MidiTrack>(*i)) {
-                               g = &_buss;
-                       } 
+               /* Work out which group to put these bundles in */
+               boost::shared_ptr<PortGroup> g;
+               if (_type == DataType::AUDIO) {
+
+                       if (boost::dynamic_pointer_cast<AudioTrack> (*i)) {
+                               g = track;
+                       } else if (!boost::dynamic_pointer_cast<MidiTrack>(*i)) {
+                               g = bus;
+                       }
 
 
-               } else if (_type == ARDOUR::DataType::MIDI) {
+               } else if (_type == DataType::MIDI) {
 
-                       if (boost::dynamic_pointer_cast<ARDOUR::MidiTrack> (*i)) {
-                               g = &_track;
+                       if (boost::dynamic_pointer_cast<MidiTrack> (*i)) {
+                               g = track;
                        }
 
                        /* No MIDI busses yet */
-               } 
-                       
+               }
+
                if (g) {
-                       ARDOUR::PortSet const & p = _offer_inputs ? ((*i)->inputs()) : ((*i)->outputs());
-                       for (uint32_t j = 0; j < p.num_ports(); ++j) {
-                               g->add (p.port(j)->name ());
+
+                       TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (*i);
+                       for (list<boost::shared_ptr<Bundle> >::iterator i = route_bundles.begin(); i != route_bundles.end(); ++i) {
+                               if (tv) {
+                                       g->add_bundle (*i, io, tv->color ());
+                               } else {
+                                       g->add_bundle (*i, io);
+                               }
                        }
+               }
+       }
+
+       /* Bundles owned by the session; add user bundles first, then normal ones, so
+          that UserBundles that offer the same ports as a normal bundle get priority
+       */
+
+       boost::shared_ptr<BundleList> b = session->bundles ();
 
-                       std::sort (g->ports.begin(), g->ports.end());
+       for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
+               if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*i)->ports_are_inputs() == inputs && (*i)->type() == _type) {
+                       system->add_bundle (*i, allow_dups);
+               }
+       }
+
+       for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
+               if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs && (*i)->type() == _type) {
+                       system->add_bundle (*i, allow_dups);
                }
        }
        
-       /* XXX: inserts, sends, plugin inserts? */
-       
-       /* Now we need to find the non-ardour ports; we do this by first
-          finding all the ports that we can connect to. 
-       */
+       /* Ardour stuff */
+
+       if (!inputs && _type == DataType::AUDIO) {
+               ardour->add_bundle (session->the_auditioner()->output()->bundle());
+               ardour->add_bundle (session->click_io()->bundle());
+       }
 
-       const char **ports = _session.engine().get_ports ("", _type.to_jack_type(), _offer_inputs ? 
-                                                         JackPortIsInput : JackPortIsOutput);
-       if (ports) {
+       /* Now find all other ports that we haven't thought of yet */
+
+       std::vector<std::string> extra_system;
+       std::vector<std::string> extra_other;
+
+       const char **ports = session->engine().get_ports ("", _type.to_jack_type(), inputs ?
+                                                        JackPortIsInput : JackPortIsOutput);
+       if (ports) {
 
                int n = 0;
                string client_matching_string;
 
-               client_matching_string = _session.engine().client_name();
+               client_matching_string = session->engine().client_name();
                client_matching_string += ':';
 
                while (ports[n]) {
+
                        std::string const p = ports[n];
 
-                       if (p.substr(0, strlen ("system:")) == "system:") {
-                               /* system: prefix */
-                               _system.add (p);
-                       } else {
-                               if (p.substr(0, client_matching_string.length()) != client_matching_string) {
-                                       /* other (non-ardour) prefix */
-                                       _other.add (p);
+                       if (!system->has_port(p) &&
+                           !bus->has_port(p) &&
+                           !track->has_port(p) &&
+                           !ardour->has_port(p) &&
+                           !other->has_port(p)) {
+
+                               if (port_has_prefix (p, "system:") ||
+                                   port_has_prefix (p, "alsa_pcm") ||
+                                   port_has_prefix (p, "ardour:")) {
+                                       extra_system.push_back (p);
+                               } else {
+                                       extra_other.push_back (p);
                                }
                        }
 
@@ -192,56 +438,223 @@ PortGroupList::refresh ()
                free (ports);
        }
 
-       push_back (&_system);
-       push_back (&_buss);
-       push_back (&_track);
-       push_back (&_other);
+       if (!extra_system.empty()) {
+               boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_system, inputs);
+               system->add_bundle (b);
+       }
+
+       if (!extra_other.empty()) {
+               other->add_bundle (make_bundle_from_ports (extra_other, inputs));
+       }
+
+       if (!allow_dups) {
+               system->remove_duplicates ();
+       }
+
+       add_group_if_not_empty (other);
+       add_group_if_not_empty (bus);
+       add_group_if_not_empty (track);
+       add_group_if_not_empty (ardour);
+       add_group_if_not_empty (system);
+
+       emit_changed ();
 }
 
-int
-PortGroupList::n_visible_ports () const
+boost::shared_ptr<Bundle>
+PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, bool inputs) const
 {
-       int n = 0;
-       
-       for (const_iterator i = begin(); i != end(); ++i) {
-               if ((*i)->visible) {
-                       n += (*i)->ports.size();
-               }
+       boost::shared_ptr<Bundle> b (new Bundle ("", _type, inputs));
+
+       std::string const pre = common_prefix (p);
+       if (!pre.empty()) {
+               b->set_name (pre.substr (0, pre.length() - 1));
        }
 
-       return n;
+       for (uint32_t j = 0; j < p.size(); ++j) {
+               b->add_channel (p[j].substr (pre.length()));
+               b->set_port (j, p[j]);
+       }
+
+       return b;
+}
+
+bool
+PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
+{
+       return n.substr (0, p.length()) == p;
 }
 
 std::string
-PortGroupList::get_port_by_index (int n, bool with_prefix) const
+PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
 {
-       /* XXX: slightly inefficient algorithm */
+       /* we must have some strings and the first must contain the separator string */
+       if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
+               return "";
+       }
 
-       for (const_iterator i = begin(); i != end(); ++i) {
-               for (std::vector<std::string>::const_iterator j = (*i)->ports.begin(); j != (*i)->ports.end(); ++j) {
-                       if (n == 0) {
-                               if (with_prefix) {
-                                       return (*i)->prefix + *j;
-                               } else {
-                                       return *j;
-                               }
-                       }
-                       --n;
+       /* prefix of the first string */
+       std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
+
+       /* see if the other strings also start with fp */
+       uint32_t j = 1;
+       while (j < p.size()) {
+               if (p[j].substr (0, fp.length()) != fp) {
+                       break;
                }
+               ++j;
+       }
+
+       if (j != p.size()) {
+               return "";
+       }
+
+       return fp;
+}
+
+
+std::string
+PortGroupList::common_prefix (std::vector<std::string> const & p) const
+{
+       /* common prefix before '/' ? */
+       std::string cp = common_prefix_before (p, "/");
+       if (!cp.empty()) {
+               return cp;
+       }
+
+       cp = common_prefix_before (p, ":");
+       if (!cp.empty()) {
+               return cp;
        }
 
        return "";
 }
 
 void
-PortGroupList::set_type (ARDOUR::DataType t)
+PortGroupList::clear ()
 {
-       _type = t;
+       _groups.clear ();
+       _bundle_changed_connections.drop_connections ();
+       emit_changed ();
+}
+
+
+PortGroup::BundleList const &
+PortGroupList::bundles () const
+{
+       _bundles.clear ();
+
+       for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
+               std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
+       }
+
+       return _bundles;
+}
+
+uint32_t
+PortGroupList::total_channels () const
+{
+       uint32_t n = 0;
+
+       for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
+               n += (*i)->total_channels ();
+       }
+
+       return n;
+}
+
+void
+PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
+{
+       if (!g->bundles().empty ()) {
+               add_group (g);
+       }
+}
+
+void
+PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
+{
+       _groups.push_back (g);
+
+       g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
+       g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), ui_bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
+
+       emit_changed ();
 }
 
 void
-PortGroupList::set_offer_inputs (bool i)
+PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
 {
-       _offer_inputs = i;
+       for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
+               (*i)->remove_bundle (b);
+       }
+
+       emit_changed ();
+}
+
+void
+PortGroupList::emit_changed ()
+{
+       if (_signals_suspended) {
+               _pending_change = true;
+       } else {
+               Changed ();
+       }
+}
+
+void
+PortGroupList::emit_bundle_changed (Bundle::Change c)
+{
+       if (_signals_suspended) {
+               _pending_bundle_change = c;
+       } else {
+               BundleChanged (c);
+       }
+}
+void
+PortGroupList::suspend_signals ()
+{
+       _signals_suspended = true;
+}
+
+void
+PortGroupList::resume_signals ()
+{
+       if (_pending_change) {
+               Changed ();
+               _pending_change = false;
+       }
+
+       if (_pending_bundle_change != 0) {
+               BundleChanged (_pending_bundle_change);
+               _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
+       }
+
+       _signals_suspended = false;
+}
+
+boost::shared_ptr<IO>
+PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
+{
+       List::const_iterator i = _groups.begin ();
+       while (i != _groups.end()) {
+               boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
+               if (io) {
+                       return io;
+               }
+               ++i;
+       }
+
+       return boost::shared_ptr<IO> ();
+}
+
+bool
+PortGroupList::empty () const
+{
+       List::const_iterator i = _groups.begin ();
+       while (i != _groups.end() && (*i)->total_channels() == 0) {
+               ++i;
+       }
+
+       return (i == _groups.end());
 }