pay attention to MIDI channel selector when creating notes with GUI (fixes #3233)
[ardour.git] / gtk2_ardour / port_group.cc
index 240e03eb0fac13aa2393c846a88455c0983108ad..a010b3c184b4be91743ca6820d020e178142c003 100644 (file)
@@ -30,6 +30,7 @@
 #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"
@@ -45,55 +46,81 @@ using namespace ARDOUR;
  * @param n Name.
  */
 PortGroup::PortGroup (std::string const & n)
-       : name (n), _visible (true)
+       : name (n)
 {
 
 }
 
+PortGroup::~PortGroup()
+{
+       for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
+               delete *i;
+       }
+       _bundles.clear ();
+}
+
+/** 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)
+PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
 {
-       add_bundle (b, boost::shared_ptr<IO> ());
+       add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
 }
 
 /** 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)
 {
-       assert (b.get());
-
-       BundleRecord r;
-       r.bundle = b;
-       r.io = io;
-       r.has_colour = false;
-       r.changed_connection = b->Changed.connect (sigc::mem_fun (*this, &PortGroup::bundle_changed));
-
-       _bundles.push_back (r);
-
-       Changed ();
+       add_bundle_internal (b, io, false, Gdk::Color (), false);
 }
 
 /** Add a bundle to a group.
  *  @param b Bundle.
- *  @param c Colour to represent the group with.
+ *  @param c Colour to represent the bundle with.
  */
 void
 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
+{
+       add_bundle_internal (b, io, true, c, false);
+}
+
+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)
+{
+}
+
+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());
 
-       BundleRecord r;
-       r.bundle = b;
-       r.io = io;
-       r.colour = c;
-       r.has_colour = true;
-       r.changed_connection = b->Changed.connect (sigc::mem_fun (*this, &PortGroup::bundle_changed));
+       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;
+               }
+       }
 
-       _bundles.push_back (r);
+       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 ();
+       Changed ();     
 }
 
 void
@@ -102,7 +129,7 @@ PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
        assert (b.get());
 
        BundleList::iterator i = _bundles.begin ();
-       while (i != _bundles.end() && i->bundle != b) {
+       while (i != _bundles.end() && (*i)->bundle != b) {
                ++i;
        }
 
@@ -110,7 +137,7 @@ PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
                return;
        }
 
-       i->changed_connection.disconnect ();
+       delete *i;
        _bundles.erase (i);
 
        Changed ();
@@ -127,7 +154,7 @@ void
 PortGroup::clear ()
 {
        for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
-               i->changed_connection.disconnect ();
+               delete *i;
        }
 
        _bundles.clear ();
@@ -138,7 +165,7 @@ 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)) {
+               if ((*i)->bundle->offers_port_alone (p)) {
                        return true;
                }
        }
@@ -150,7 +177,7 @@ boost::shared_ptr<Bundle>
 PortGroup::only_bundle ()
 {
        assert (_bundles.size() == 1);
-       return _bundles.front().bundle;
+       return _bundles.front()->bundle;
 }
 
 
@@ -159,7 +186,7 @@ PortGroup::total_channels () const
 {
        uint32_t n = 0;
        for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
-               n += i->bundle->nchannels ();
+               n += (*i)->bundle->nchannels ();
        }
 
        return n;
@@ -169,7 +196,7 @@ 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) {
+       while (i != _bundles.end() && (*i)->bundle != b) {
                ++i;
        }
 
@@ -177,7 +204,56 @@ PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
                return boost::shared_ptr<IO> ();
        }
 
-       return i->io;
+       return (*i)->io;
+}
+
+/** Remove bundles whose channels are already represented by other, larger bundles */
+void
+PortGroup::remove_duplicates ()
+{
+       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;
+       }
 }
 
 
@@ -189,6 +265,11 @@ PortGroupList::PortGroupList ()
 
 }
 
+PortGroupList::~PortGroupList() 
+{
+       /* XXX need to clean up bundles, but ownership shared with PortGroups */
+}
+
 void
 PortGroupList::set_type (DataType t)
 {
@@ -197,7 +278,9 @@ PortGroupList::set_type (DataType t)
 }
 
 void
-PortGroupList::maybe_add_processor_to_bundle (boost::weak_ptr<Processor> wp, boost::shared_ptr<RouteBundle> rb, bool inputs, set<boost::shared_ptr<IO> >& used_io)
+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());
 
@@ -212,7 +295,7 @@ PortGroupList::maybe_add_processor_to_bundle (boost::weak_ptr<Processor> wp, boo
                boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
 
                if (io && used_io.find (io) == used_io.end()) {
-                       rb->add_processor_bundle (io->bundle ());
+                       route_bundles->push_back (io->bundle ());
                        used_io.insert (io);
                }
        }
@@ -221,10 +304,14 @@ PortGroupList::maybe_add_processor_to_bundle (boost::weak_ptr<Processor> wp, boo
 
 /** Gather bundles from around the system and put them in this PortGroupList */
 void
-PortGroupList::gather (ARDOUR::Session& session, bool inputs)
+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")));
@@ -235,22 +322,25 @@ PortGroupList::gather (ARDOUR::Session& session, bool inputs)
           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 ();
+       boost::shared_ptr<RouteList> routes = session->get_routes ();
 
        for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
 
-               /* keep track of IOs that we have taken bundles from, so that maybe_add_processor... below
-                  can avoid taking the same IO from both Route::output() and the main_outs Delivery */
+               list<boost::shared_ptr<Bundle> > route_bundles;
+
+               /* 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 */
 
                set<boost::shared_ptr<IO> > used_io;
                boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
                used_io.insert (io);
 
-               boost::shared_ptr<RouteBundle> rb (new RouteBundle (io->bundle()));
+               route_bundles.push_back (io->bundle ());
 
-               (*i)->foreach_processor (bind (mem_fun (*this, &PortGroupList::maybe_add_processor_to_bundle), rb, inputs, used_io));
+               (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &route_bundles, inputs, used_io));
 
-               /* Work out which group to put this bundle in */
+               /* Work out which group to put these bundles in */
                boost::shared_ptr<PortGroup> g;
                if (_type == DataType::AUDIO) {
 
@@ -272,29 +362,40 @@ PortGroupList::gather (ARDOUR::Session& session, bool inputs)
 
                if (g) {
 
-                       TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (i->get());
-                       if (tv) {
-                               g->add_bundle (rb, io, tv->color ());
-                       } else {
-                               g->add_bundle (rb, io);
+                       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 */
+       /* 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 ();
 
-       boost::shared_ptr<BundleList> b = session.bundles ();
        for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
-               if ((*i)->ports_are_inputs() == inputs && (*i)->type() == _type) {
-                       system->add_bundle (*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);
+               }
+       }
+       
        /* Ardour stuff */
 
        if (!inputs && _type == DataType::AUDIO) {
-               ardour->add_bundle (session.the_auditioner()->output()->bundle());
-               ardour->add_bundle (session.click_io()->bundle());
+               ardour->add_bundle (session->the_auditioner()->output()->bundle());
+               ardour->add_bundle (session->click_io()->bundle());
        }
 
        /* Now find all other ports that we haven't thought of yet */
@@ -302,21 +403,35 @@ PortGroupList::gather (ARDOUR::Session& session, bool inputs)
        std::vector<std::string> extra_system;
        std::vector<std::string> extra_other;
 
-       const char **ports = session.engine().get_ports ("", _type.to_jack_type(), inputs ?
+       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 (!system->has_port(p) && !bus->has_port(p) && !track->has_port(p) && !ardour->has_port(p) && !other->has_port(p)) {
+                       if (!system->has_port(p) &&
+                           !bus->has_port(p) &&
+                           !track->has_port(p) &&
+                           !ardour->has_port(p) &&
+                           !other->has_port(p)) {
+                                
+                                /* special hack: ignore MIDI ports labelled Midi-Through. these
+                                   are basically useless and mess things up for default
+                                   connections.
+                                */
+
+                                if (p.find ("MIDI-Through") != string::npos) {
+                                        ++n;
+                                        continue;
+                                }
 
                                if (port_has_prefix (p, "system:") ||
                                    port_has_prefix (p, "alsa_pcm") ||
@@ -334,18 +449,23 @@ PortGroupList::gather (ARDOUR::Session& session, bool inputs)
        }
 
        if (!extra_system.empty()) {
-               system->add_bundle (make_bundle_from_ports (extra_system, inputs));
+               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));
        }
 
-       add_group (system);
-       add_group (bus);
-       add_group (track);
-       add_group (ardour);
-       add_group (other);
+       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 ();
 }
@@ -423,13 +543,7 @@ void
 PortGroupList::clear ()
 {
        _groups.clear ();
-
-       for (std::vector<sigc::connection>::iterator i = _bundle_changed_connections.begin(); i != _bundle_changed_connections.end(); ++i) {
-               i->disconnect ();
-       }
-
-       _bundle_changed_connections.clear ();
-
+       _bundle_changed_connections.drop_connections ();
        emit_changed ();
 }
 
@@ -447,30 +561,32 @@ PortGroupList::bundles () const
 }
 
 uint32_t
-PortGroupList::total_visible_channels () const
+PortGroupList::total_channels () const
 {
        uint32_t n = 0;
 
        for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
-               if ((*i)->visible()) {
-                       n += (*i)->total_channels ();
-               }
+               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 (sigc::mem_fun (*this, &PortGroupList::emit_changed));
-
-       _bundle_changed_connections.push_back (
-               g->BundleChanged.connect (sigc::mem_fun (*this, &PortGroupList::emit_bundle_changed))
-               );
+       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 ();
 }
@@ -541,44 +657,14 @@ PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
        return boost::shared_ptr<IO> ();
 }
 
-
-RouteBundle::RouteBundle (boost::shared_ptr<Bundle> r)
-       : _route (r)
-{
-       _route->Changed.connect (sigc::hide (sigc::mem_fun (*this, &RouteBundle::reread_component_bundles)));
-       reread_component_bundles ();
-}
-
-void
-RouteBundle::reread_component_bundles ()
+bool
+PortGroupList::empty () const
 {
-       suspend_signals ();
-
-       remove_channels ();
-
-       set_name (_route->name());
-
-       for (uint32_t i = 0; i < _route->nchannels(); ++i) {
-               add_channel (_route->channel_name (i));
-               PortList const & pl = _route->channel_ports (i);
-               for (uint32_t j = 0; j < pl.size(); ++j) {
-                       add_port_to_channel (i, pl[j]);
-               }
-       }
-
-       for (std::vector<boost::shared_ptr<Bundle> >::iterator i = _processor.begin(); i != _processor.end(); ++i) {
-               add_channels_from_bundle (*i);
+       List::const_iterator i = _groups.begin ();
+       while (i != _groups.end() && (*i)->total_channels() == 0) {
+               ++i;
        }
 
-       resume_signals ();
-}
-
-void
-RouteBundle::add_processor_bundle (boost::shared_ptr<Bundle> p)
-{
-       p->Changed.connect (sigc::hide (sigc::mem_fun (*this, &RouteBundle::reread_component_bundles)));
-       _processor.push_back (p);
-
-       reread_component_bundles ();
+       return (i == _groups.end());
 }