Move RouteGroup color into libardour.
[ardour.git] / libs / ardour / route_group.cc
index 137e2c4734edd324a96f505dd9708765ab7f4d3f..c41a890a02d68eef7528cb0174342213cb48d29b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2009 Paul Davis
+    Copyright (C) 2000-2016 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 "pbd/error.h"
 #include "pbd/enumwriter.h"
 #include "pbd/strsplit.h"
+#include "pbd/types_convert.h"
 #include "pbd/debug.h"
 
 #include "ardour/amp.h"
 #include "ardour/audio_track.h"
+#include "ardour/debug.h"
 #include "ardour/monitor_control.h"
 #include "ardour/route.h"
 #include "ardour/route_group.h"
 #include "ardour/session.h"
+#include "ardour/vca.h"
+#include "ardour/vca_manager.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
@@ -41,57 +45,60 @@ using namespace std;
 
 namespace ARDOUR {
        namespace Properties {
-               PropertyDescriptor<bool> relative;
                PropertyDescriptor<bool> active;
-               PropertyDescriptor<bool> gain;
-               PropertyDescriptor<bool> mute;
-               PropertyDescriptor<bool> solo;
-               PropertyDescriptor<bool> recenable;
-               PropertyDescriptor<bool> select;
-               PropertyDescriptor<bool> route_active;
-               PropertyDescriptor<bool> color;
-               PropertyDescriptor<bool> monitoring;
+               PropertyDescriptor<bool> group_relative;
+               PropertyDescriptor<bool> group_gain;
+               PropertyDescriptor<bool> group_mute;
+               PropertyDescriptor<bool> group_solo;
+               PropertyDescriptor<bool> group_recenable;
+               PropertyDescriptor<bool> group_select;
+               PropertyDescriptor<bool> group_route_active;
+               PropertyDescriptor<bool> group_color;
+               PropertyDescriptor<bool> group_monitoring;
+               PropertyDescriptor<int32_t> group_master_number;
        }
 }
 
 void
 RouteGroup::make_property_quarks ()
 {
-       Properties::relative.property_id = g_quark_from_static_string (X_("relative"));
-        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for relative = %1\n",   Properties::relative.property_id));
        Properties::active.property_id = g_quark_from_static_string (X_("active"));
         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for active = %1\n",     Properties::active.property_id));
-       Properties::hidden.property_id = g_quark_from_static_string (X_("hidden"));
-        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for hidden = %1\n",     Properties::hidden.property_id));
-       Properties::gain.property_id = g_quark_from_static_string (X_("gain"));
-        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for gain = %1\n",       Properties::gain.property_id));
-       Properties::mute.property_id = g_quark_from_static_string (X_("mute"));
-        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for mute = %1\n",       Properties::mute.property_id));
-       Properties::solo.property_id = g_quark_from_static_string (X_("solo"));
-        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for solo = %1\n",       Properties::solo.property_id));
-       Properties::recenable.property_id = g_quark_from_static_string (X_("recenable"));
-        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::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, true) \
+
+        Properties::group_relative.property_id = g_quark_from_static_string (X_("relative"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for relative = %1\n",   Properties::group_relative.property_id));
+       Properties::group_gain.property_id = g_quark_from_static_string (X_("gain"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for gain = %1\n",       Properties::group_gain.property_id));
+       Properties::group_mute.property_id = g_quark_from_static_string (X_("mute"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for mute = %1\n",       Properties::group_mute.property_id));
+       Properties::group_solo.property_id = g_quark_from_static_string (X_("solo"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for solo = %1\n",       Properties::group_solo.property_id));
+       Properties::group_recenable.property_id = g_quark_from_static_string (X_("recenable"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for recenable = %1\n",  Properties::group_recenable.property_id));
+       Properties::group_select.property_id = g_quark_from_static_string (X_("select"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for select = %1\n",     Properties::group_select.property_id));
+       Properties::group_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::group_route_active.property_id));
+       Properties::group_color.property_id = g_quark_from_static_string (X_("color"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for color = %1\n", Properties::group_color.property_id));
+       Properties::group_monitoring.property_id = g_quark_from_static_string (X_("monitoring"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for monitoring = %1\n", Properties::group_monitoring.property_id));
+       Properties::group_master_number.property_id = g_quark_from_static_string (X_("group-master-number"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for group-master-number = %1\n", Properties::group_master_number.property_id));
+}
+
+#define ROUTE_GROUP_DEFAULT_PROPERTIES  _relative (Properties::group_relative, true) \
        , _active (Properties::active, true) \
        , _hidden (Properties::hidden, 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)
+       , _gain (Properties::group_gain, true) \
+       , _mute (Properties::group_mute, true) \
+       , _solo (Properties::group_solo, true) \
+       , _recenable (Properties::group_recenable, true) \
+       , _select (Properties::group_select, true) \
+       , _route_active (Properties::group_route_active, true) \
+       , _color (Properties::group_color, true) \
+       , _monitoring (Properties::group_monitoring, true) \
+       , _group_master_number (Properties::group_master_number, -1)
 
 RouteGroup::RouteGroup (Session& s, const string &n)
        : SessionObject (s, n)
@@ -100,8 +107,9 @@ RouteGroup::RouteGroup (Session& s, const string &n)
        , _solo_group (new ControlGroup (SoloAutomation))
        , _mute_group (new ControlGroup (MuteAutomation))
        , _rec_enable_group (new ControlGroup (RecEnableAutomation))
-       , _gain_group (new ControlGroup (GainAutomation))
+       , _gain_group (new GainControlGroup ())
        , _monitoring_group (new ControlGroup (MonitoringAutomation))
+       , _rgba (0)
 {
        _xml_node_name = X_("RouteGroup");
 
@@ -116,6 +124,7 @@ RouteGroup::RouteGroup (Session& s, const string &n)
        add_property (_route_active);
        add_property (_color);
        add_property (_monitoring);
+       add_property (_group_master_number);
 }
 
 RouteGroup::~RouteGroup ()
@@ -126,12 +135,18 @@ RouteGroup::~RouteGroup ()
        _rec_enable_group->clear ();
        _monitoring_group->clear ();
 
+       boost::shared_ptr<VCA> vca (group_master.lock());
+
        for (RouteList::iterator i = routes->begin(); i != routes->end();) {
                RouteList::iterator tmp = i;
                ++tmp;
 
                (*i)->set_route_group (0);
 
+               if (vca) {
+                       (*i)->unassign (vca);
+               }
+
                i = tmp;
        }
 }
@@ -142,6 +157,10 @@ RouteGroup::~RouteGroup ()
 int
 RouteGroup::add (boost::shared_ptr<Route> r)
 {
+       if (r->is_master()) {
+               return 0;
+       }
+
        if (find (routes->begin(), routes->end(), r) != routes->end()) {
                return 0;
        }
@@ -164,6 +183,12 @@ RouteGroup::add (boost::shared_ptr<Route> r)
        r->set_route_group (this);
        r->DropReferences.connect_same_thread (*this, boost::bind (&RouteGroup::remove_when_going_away, this, boost::weak_ptr<Route> (r)));
 
+       boost::shared_ptr<VCA> vca (group_master.lock());
+
+       if (vca) {
+               r->assign  (vca, false);
+       }
+
        _session.set_dirty ();
        RouteAdded (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
        return 0;
@@ -186,6 +211,13 @@ RouteGroup::remove (boost::shared_ptr<Route> r)
 
        if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
                r->set_route_group (0);
+
+               boost::shared_ptr<VCA> vca = group_master.lock();
+
+               if (vca) {
+                       r->unassign (vca);
+               }
+
                _solo_group->remove_control (r->solo_control());
                _mute_group->remove_control (r->mute_control());
                _gain_group->remove_control (r->gain_control());
@@ -203,15 +235,30 @@ RouteGroup::remove (boost::shared_ptr<Route> r)
        return -1;
 }
 
+void
+RouteGroup::set_rgba (uint32_t color) {
+       _rgba = color;
+
+       PBD::PropertyChange change;
+       change.add (Properties::color);
+       PropertyChanged (change);
+
+       if (!is_color ()) {
+               return;
+       }
+
+       for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
+               (*i)->presentation_info().PropertyChanged (Properties::color);
+       }
+}
 
 XMLNode&
 RouteGroup::get_state ()
 {
        XMLNode *node = new XMLNode ("RouteGroup");
 
-       char buf[64];
-       id().print (buf, sizeof (buf));
-       node->add_property ("id", buf);
+       node->set_property ("id", id());
+       node->set_property ("rgba", _rgba);
 
        add_properties (*node);
 
@@ -222,7 +269,7 @@ RouteGroup::get_state ()
                        str << (*i)->id () << ' ';
                }
 
-               node->add_property ("routes", str.str());
+               node->set_property ("routes", str.str());
        }
 
        return *node;
@@ -235,13 +282,13 @@ RouteGroup::set_state (const XMLNode& node, int version)
                return set_state_2X (node, version);
        }
 
-       XMLProperty const * prop;
-
        set_id (node);
        set_values (node);
+       node.get_property ("rgba", _rgba);
 
-       if ((prop = node.property ("routes")) != 0) {
-               stringstream str (prop->value());
+       std::string routes;
+       if (node.get_property ("routes", routes)) {
+               stringstream str (routes);
                vector<string> ids;
                split (str.str(), ids, ' ');
 
@@ -255,6 +302,17 @@ RouteGroup::set_state (const XMLNode& node, int version)
                }
        }
 
+       if (_group_master_number.val() > 0) {
+               boost::shared_ptr<VCA> vca = _session.vca_manager().vca_by_number (_group_master_number.val());
+               if (vca) {
+                       /* no need to do the assignment because slaves will
+                          handle that themselves. But we can set group_master
+                          to use with future assignments of newly added routes.
+                       */
+                       group_master = vca;
+               }
+       }
+
        push_to_groups ();
 
        return 0;
@@ -292,10 +350,14 @@ RouteGroup::set_gain (bool yn)
        if (is_gain() == yn) {
                return;
        }
+       if (has_control_master()) {
+               return;
+       }
+
        _gain = yn;
        _gain_group->set_active (yn);
 
-       send_change (PropertyChange (Properties::gain));
+       send_change (PropertyChange (Properties::group_gain));
 }
 
 void
@@ -306,7 +368,8 @@ RouteGroup::set_mute (bool yn)
        }
        _mute = yn;
        _mute_group->set_active (yn);
-       send_change (PropertyChange (Properties::mute));
+
+       send_change (PropertyChange (Properties::group_mute));
 }
 
 void
@@ -317,7 +380,8 @@ RouteGroup::set_solo (bool yn)
        }
        _solo = yn;
        _solo_group->set_active (yn);
-       send_change (PropertyChange (Properties::solo));
+
+       send_change (PropertyChange (Properties::group_solo));
 }
 
 void
@@ -328,7 +392,7 @@ RouteGroup::set_recenable (bool yn)
        }
        _recenable = yn;
        _rec_enable_group->set_active (yn);
-       send_change (PropertyChange (Properties::recenable));
+       send_change (PropertyChange (Properties::group_recenable));
 }
 
 void
@@ -338,7 +402,7 @@ RouteGroup::set_select (bool yn)
                return;
        }
        _select = yn;
-       send_change (PropertyChange (Properties::select));
+       send_change (PropertyChange (Properties::group_select));
 }
 
 void
@@ -348,7 +412,7 @@ RouteGroup::set_route_active (bool yn)
                return;
        }
        _route_active = yn;
-       send_change (PropertyChange (Properties::route_active));
+       send_change (PropertyChange (Properties::group_route_active));
 }
 
 void
@@ -359,7 +423,7 @@ RouteGroup::set_color (bool yn)
        }
        _color = yn;
 
-       send_change (PropertyChange (Properties::color));
+       send_change (PropertyChange (Properties::group_color));
 
        /* This is a bit of a hack, but this might change
           our route's effective color, so emit gui_changed
@@ -381,7 +445,7 @@ RouteGroup::set_monitoring (bool yn)
        _monitoring = yn;
        _monitoring_group->set_active (yn);
 
-       send_change (PropertyChange (Properties::monitoring));
+       send_change (PropertyChange (Properties::group_monitoring));
 
        _session.set_dirty ();
 }
@@ -394,6 +458,9 @@ RouteGroup::set_active (bool yn, void* /*src*/)
        }
 
        _active = yn;
+
+       push_to_groups ();
+
        send_change (PropertyChange (Properties::active));
        _session.set_dirty ();
 }
@@ -404,8 +471,12 @@ RouteGroup::set_relative (bool yn, void* /*src*/)
        if (is_relative() == yn) {
                return;
        }
+
        _relative = yn;
-       send_change (PropertyChange (Properties::relative));
+
+       push_to_groups ();
+
+       send_change (PropertyChange (Properties::group_relative));
        _session.set_dirty ();
 }
 
@@ -473,7 +544,7 @@ RouteGroup::make_subgroup (bool aux, Placement placement)
                 * (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);
+               rl = _session.new_audio_route (nin, 2, 0, 1, string(), PresentationInfo::AudioBus, PresentationInfo::max_order);
        } catch (...) {
                return;
        }
@@ -538,9 +609,105 @@ RouteGroup::post_set (PBD::PropertyChange const &)
 void
 RouteGroup::push_to_groups ()
 {
-       _gain_group->set_active (_gain);
-       _solo_group->set_active (_solo);
-       _mute_group->set_active (_mute);
-       _rec_enable_group->set_active (_recenable);
-       _monitoring_group->set_active (_monitoring);
+       if (is_relative()) {
+               _gain_group->set_mode (ControlGroup::Mode (_gain_group->mode()|ControlGroup::Relative));
+       } else {
+               _gain_group->set_mode (ControlGroup::Mode (_gain_group->mode()&~ControlGroup::Relative));
+       }
+
+       if (_active) {
+               _gain_group->set_active (is_gain());
+               _solo_group->set_active (is_solo());
+               _mute_group->set_active (is_mute());
+               _rec_enable_group->set_active (is_recenable());
+               _monitoring_group->set_active (is_monitoring());
+       } else {
+               _gain_group->set_active (false);
+               _solo_group->set_active (false);
+               _mute_group->set_active (false);
+
+               _rec_enable_group->set_active (false);
+               _monitoring_group->set_active (false);
+       }
+}
+
+void
+RouteGroup::assign_master (boost::shared_ptr<VCA> master)
+{
+       if (!routes || routes->empty()) {
+               return;
+       }
+
+       boost::shared_ptr<Route> front = routes->front ();
+
+       if (front->slaved_to (master)) {
+               return;
+       }
+
+       for (RouteList::iterator r = routes->begin(); r != routes->end(); ++r) {
+               (*r)->assign (master, false);
+       }
+
+       bool used_to_share_gain = false;
+
+       if (is_gain()) {
+               used_to_share_gain = true;
+       }
+
+       group_master = master;
+       _group_master_number = master->number();
+       _gain_group->set_active (false);
+
+       if (used_to_share_gain) {
+               send_change (PropertyChange (Properties::group_gain));
+       }
+}
+
+void
+RouteGroup::unassign_master (boost::shared_ptr<VCA> master)
+{
+       if (!routes || routes->empty()) {
+               return;
+       }
+
+       boost::shared_ptr<Route> front = routes->front ();
+
+       if (!front->slaved_to (master)) {
+               return;
+       }
+
+       for (RouteList::iterator r = routes->begin(); r != routes->end(); ++r) {
+               (*r)->unassign (master);
+       }
+
+       group_master.reset ();
+       _group_master_number = -1;
+
+       /* this is slightly tricky: is_gain() will return whether or not
+          the group is supposed to be sharing gain adjustment, and now that
+          we've reset _group_master_number to -1, it will reflect the user's
+          intentions correctly. Since there was a master before, and now there
+          is not, we are going to reactivate gain sharing ... and then tell
+          the world about it.
+       */
+       if (is_gain()) {
+               _gain_group->set_active (true);
+               send_change (PropertyChange (Properties::group_gain));
+       }
+}
+
+bool
+RouteGroup::slaved () const
+{
+       if (!routes || routes->empty()) {
+               return false;
+       }
+
+       return routes->front()->slaved ();
+}
+
+bool
+RouteGroup::has_control_master() const
+{
+       return group_master.lock() != 0;
 }