remove incorrect/out of date comment
[ardour.git] / libs / ardour / route_group.cc
index 4e9baa082e16a0322afc08d87e251a7336a1e3ed..036aede02eb07196ffba7e9818441321994b6db7 100644 (file)
 
 #include <algorithm>
 
-
 #include "pbd/error.h"
 #include "pbd/enumwriter.h"
 #include "pbd/strsplit.h"
 
 #include "ardour/amp.h"
-#include "ardour/debug.h"
-#include "ardour/route_group.h"
 #include "ardour/audio_track.h"
-#include "ardour/audio_diskstream.h"
-#include "ardour/configuration.h"
+#include "ardour/route.h"
+#include "ardour/route_group.h"
 #include "ardour/session.h"
 
 #include "i18n.h"
@@ -49,8 +46,9 @@ namespace ARDOUR {
                PropertyDescriptor<bool> solo;
                PropertyDescriptor<bool> recenable;
                PropertyDescriptor<bool> select;
-               PropertyDescriptor<bool> edit;
                PropertyDescriptor<bool> route_active;
+               PropertyDescriptor<bool> color;
+               PropertyDescriptor<bool> monitoring;
        }
 }
 
@@ -73,22 +71,25 @@ RouteGroup::make_property_quarks ()
         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for recenable = %1\n",  Properties::recenable.property_id));
        Properties::select.property_id = g_quark_from_static_string (X_("select"));
         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for select = %1\n",     Properties::select.property_id));
-       Properties::edit.property_id = g_quark_from_static_string (X_("edit"));
-        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for edit = %1\n",       Properties::edit.property_id));
        Properties::route_active.property_id = g_quark_from_static_string (X_("route-active"));
         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for route-active = %1\n", Properties::route_active.property_id));
+       Properties::color.property_id = g_quark_from_static_string (X_("color"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for color = %1\n",       Properties::color.property_id));
+       Properties::monitoring.property_id = g_quark_from_static_string (X_("monitoring"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for monitoring = %1\n",       Properties::monitoring.property_id));
 }
 
-#define ROUTE_GROUP_DEFAULT_PROPERTIES  _relative (Properties::relative, false) \
-       , _active (Properties::active, false) \
+#define ROUTE_GROUP_DEFAULT_PROPERTIES  _relative (Properties::relative, true) \
+       , _active (Properties::active, true) \
        , _hidden (Properties::hidden, false) \
-       , _gain (Properties::gain, false) \
-       , _mute (Properties::mute, false) \
-       , _solo (Properties::solo, false) \
-       , _recenable (Properties::recenable, false) \
-       , _select (Properties::select, false) \
-       , _edit (Properties::edit, false) \
-       , _route_active (Properties::route_active, false)
+       , _gain (Properties::gain, true) \
+       , _mute (Properties::mute, true) \
+       , _solo (Properties::solo, true) \
+       , _recenable (Properties::recenable, true) \
+       , _select (Properties::select, true) \
+       , _route_active (Properties::route_active, true) \
+       , _color (Properties::color, true) \
+       , _monitoring (Properties::monitoring, true)
 
 RouteGroup::RouteGroup (Session& s, const string &n)
        : SessionObject (s, n)
@@ -105,8 +106,9 @@ RouteGroup::RouteGroup (Session& s, const string &n)
        add_property (_solo);
        add_property (_recenable);
        add_property (_select);
-       add_property (_edit);
        add_property (_route_active);
+       add_property (_color);
+       add_property (_monitoring);
 }
 
 RouteGroup::~RouteGroup ()
@@ -115,7 +117,7 @@ RouteGroup::~RouteGroup ()
                RouteList::iterator tmp = i;
                ++tmp;
 
-               (*i)->leave_route_group ();
+               (*i)->set_route_group (0);
 
                i = tmp;
        }
@@ -131,15 +133,17 @@ RouteGroup::add (boost::shared_ptr<Route> r)
                return 0;
        }
 
-       r->leave_route_group ();
+       if (r->route_group()) {
+               r->route_group()->remove (r);
+       }
 
        routes->push_back (r);
 
-       r->join_route_group (this);
+       r->set_route_group (this);
        r->DropReferences.connect_same_thread (*this, boost::bind (&RouteGroup::remove_when_going_away, this, boost::weak_ptr<Route> (r)));
 
        _session.set_dirty ();
-       MembershipChanged (); /* EMIT SIGNAL */
+       RouteAdded (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
        return 0;
 }
 
@@ -159,10 +163,10 @@ RouteGroup::remove (boost::shared_ptr<Route> r)
        RouteList::iterator i;
 
        if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
-               r->leave_route_group ();
+               r->set_route_group (0);
                routes->erase (i);
                _session.set_dirty ();
-               MembershipChanged (); /* EMIT SIGNAL */
+               RouteRemoved (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
                return 0;
        }
 
@@ -171,31 +175,30 @@ RouteGroup::remove (boost::shared_ptr<Route> r)
 
 
 gain_t
-RouteGroup::get_min_factor(gain_t factor)
+RouteGroup::get_min_factor (gain_t factor)
 {
-       gain_t g;
-
        for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-               g = (*i)->amp()->gain();
+               gain_t const g = (*i)->amp()->gain();
 
-               if ( (g+g*factor) >= 0.0f)
+               if ((g + g * factor) >= 0.0f) {
                        continue;
+               }
 
-               if ( g <= 0.0000003f )
+               if (g <= 0.0000003f) {
                        return 0.0f;
+               }
 
-               factor = 0.0000003f/g - 1.0f;
+               factor = 0.0000003f / g - 1.0f;
        }
+
        return factor;
 }
 
 gain_t
-RouteGroup::get_max_factor(gain_t factor)
+RouteGroup::get_max_factor (gain_t factor)
 {
-       gain_t g;
-
        for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
-               g = (*i)->amp()->gain();
+               gain_t const g = (*i)->amp()->gain();
 
                // if the current factor woulnd't raise this route above maximum
                if ((g + g * factor) <= 1.99526231f) {
@@ -247,10 +250,7 @@ RouteGroup::set_state (const XMLNode& node, int version)
 
        const XMLProperty *prop;
 
-       if ((prop = node.property ("id")) != 0) {
-               _id = prop->value();
-       }
-
+       set_id (node);
        set_values (node);
 
        if ((prop = node.property ("routes")) != 0) {
@@ -281,15 +281,15 @@ RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
                _mute = true;
                _solo = true;
                _recenable = true;
-               _edit = false;
                _route_active = true;
+               _color = false;
        } else if (node.name() == "EditGroup") {
                _gain = false;
                _mute = false;
                _solo = false;
                _recenable = false;
-               _edit = true;
                _route_active = false;
+               _color = false;
        }
 
        return 0;
@@ -302,6 +302,7 @@ RouteGroup::set_gain (bool yn)
                return;
        }
        _gain = yn;
+       send_change (PropertyChange (Properties::gain));
 }
 
 void
@@ -311,6 +312,7 @@ RouteGroup::set_mute (bool yn)
                return;
        }
        _mute = yn;
+       send_change (PropertyChange (Properties::mute));
 }
 
 void
@@ -320,6 +322,7 @@ RouteGroup::set_solo (bool yn)
                return;
        }
        _solo = yn;
+       send_change (PropertyChange (Properties::solo));
 }
 
 void
@@ -329,6 +332,7 @@ RouteGroup::set_recenable (bool yn)
                return;
        }
        _recenable = yn;
+       send_change (PropertyChange (Properties::recenable));
 }
 
 void
@@ -338,24 +342,50 @@ RouteGroup::set_select (bool yn)
                return;
        }
        _select = yn;
+       send_change (PropertyChange (Properties::select));
 }
 
 void
-RouteGroup::set_edit (bool yn)
+RouteGroup::set_route_active (bool yn)
 {
-       if (is_edit() == yn) {
+       if (is_route_active() == yn) {
                return;
        }
-       _edit = yn;
+       _route_active = yn;
+       send_change (PropertyChange (Properties::route_active));
 }
 
 void
-RouteGroup::set_route_active (bool yn)
+RouteGroup::set_color (bool yn)
 {
-       if (is_route_active() == yn) {
+       if (is_color() == yn) {
                return;
        }
-       _route_active = yn;
+       _color = yn;
+
+       send_change (PropertyChange (Properties::color));
+
+       /* This is a bit of a hack, but this might change
+          our route's effective color, so emit gui_changed
+          for our routes.
+       */
+
+       for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+               (*i)->gui_changed (X_("color"), this);
+       }
+}
+
+void
+RouteGroup::set_monitoring (bool yn)
+{
+       if (is_monitoring() == yn) {
+               return;
+       }
+
+       _monitoring = yn;
+       send_change (PropertyChange (Properties::monitoring));
+
+       _session.set_dirty ();
 }
 
 void
@@ -367,7 +397,6 @@ RouteGroup::set_active (bool yn, void* /*src*/)
 
        _active = yn;
        send_change (PropertyChange (Properties::active));
-
        _session.set_dirty ();
 }
 
@@ -378,6 +407,7 @@ RouteGroup::set_relative (bool yn, void* /*src*/)
                return;
        }
        _relative = yn;
+       send_change (PropertyChange (Properties::relative));
        _session.set_dirty ();
 }
 
@@ -400,7 +430,7 @@ RouteGroup::set_hidden (bool yn, void* /*src*/)
                }
        }
 
-       PropertyChanged (Properties::hidden); /* EMIT SIGNAL */
+       send_change (Properties::hidden);
 
        _session.set_dirty ();
 }
@@ -426,18 +456,26 @@ RouteGroup::make_subgroup (bool aux, Placement placement)
 
        for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
                if ((*i)->output()->n_ports().n_midi() != 0) {
-                       PBD::info << _("You cannot subgroup MIDI tracks at this time") << endmsg;
+                       PBD::warning << _("You cannot subgroup MIDI tracks at this time") << endmsg;
                        return;
                }
        }
 
        for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+               if (!aux && nin != 0 && nin != (*i)->output()->n_ports().n_audio()) {
+                       PBD::warning << _("You cannot subgroup tracks with different number of outputs at this time.") << endmsg;
+                       return;
+               }
                nin = max (nin, (*i)->output()->n_ports().n_audio());
        }
 
        try {
-               /* use master bus etc. to determine default nouts */
-               rl = _session.new_audio_route (nin, 2, 0, 1);
+               /* use master bus etc. to determine default nouts.
+                *
+                * (since tracks can't have fewer outs than ins,
+                * "nin" currently defines the number of outpus if nin > 2)
+                */
+               rl = _session.new_audio_route (nin, 2 /*XXX*/, 0, 1);
        } catch (...) {
                return;
        }
@@ -455,7 +493,7 @@ RouteGroup::make_subgroup (bool aux, Placement placement)
 
                for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
                        (*i)->output()->disconnect (this);
-                       (*i)->output()->connect_ports_to_bundle (bundle, this);
+                       (*i)->output()->connect_ports_to_bundle (bundle, false, this);
                }
        }
 }
@@ -476,6 +514,12 @@ RouteGroup::destroy_subgroup ()
        subgroup_bus.reset ();
 }
 
+bool
+RouteGroup::has_subgroup() const
+{
+       return subgroup_bus != 0;
+}
+
 bool
 RouteGroup::enabled_property (PBD::PropertyID prop)
 {