fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / route_group.cc
index 5b5a8f25b184e4220c986811fb205116f2cb42a6..1a7b98050cfe8fb961bb747ecee01a3d641a5599 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/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;
@@ -39,62 +44,70 @@ 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) \
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for active = %1\n",     Properties::active.property_id));
+
+        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)
        , routes (new RouteList)
        , ROUTE_GROUP_DEFAULT_PROPERTIES
+       , _solo_group (new ControlGroup (SoloAutomation))
+       , _mute_group (new ControlGroup (MuteAutomation))
+       , _rec_enable_group (new ControlGroup (RecEnableAutomation))
+       , _gain_group (new GainControlGroup ())
+       , _monitoring_group (new ControlGroup (MonitoringAutomation))
 {
        _xml_node_name = X_("RouteGroup");
 
@@ -109,16 +122,29 @@ RouteGroup::RouteGroup (Session& s, const string &n)
        add_property (_route_active);
        add_property (_color);
        add_property (_monitoring);
+       add_property (_group_master_number);
 }
 
 RouteGroup::~RouteGroup ()
 {
+       _solo_group->clear ();
+       _mute_group->clear ();
+       _gain_group->clear ();
+       _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;
        }
 }
@@ -139,9 +165,24 @@ RouteGroup::add (boost::shared_ptr<Route> r)
 
        routes->push_back (r);
 
+       _solo_group->add_control (r->solo_control());
+       _mute_group->add_control (r->mute_control());
+       _gain_group->add_control (r->gain_control());
+       boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (r);
+       if (trk) {
+               _rec_enable_group->add_control (trk->rec_enable_control());
+               _monitoring_group->add_control (trk->monitoring_control());
+       }
+
        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);
+       }
+
        _session.set_dirty ();
        RouteAdded (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
        return 0;
@@ -164,58 +205,30 @@ RouteGroup::remove (boost::shared_ptr<Route> r)
 
        if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
                r->set_route_group (0);
-               routes->erase (i);
-               _session.set_dirty ();
-               RouteRemoved (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
-               return 0;
-       }
-
-       return -1;
-}
 
+               boost::shared_ptr<VCA> vca = group_master.lock();
 
-gain_t
-RouteGroup::get_min_factor (gain_t factor)
-{
-       for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-               gain_t const g = (*i)->gain_control()->get_value();
-
-               if ((g + g * factor) >= 0.0f) {
-                       continue;
+               if (vca) {
+                       r->unassign (vca);
                }
 
-               if (g <= 0.0000003f) {
-                       return 0.0f;
+               _solo_group->remove_control (r->solo_control());
+               _mute_group->remove_control (r->mute_control());
+               _gain_group->remove_control (r->gain_control());
+               boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (r);
+               if (trk) {
+                       _rec_enable_group->remove_control (trk->rec_enable_control());
+                       _monitoring_group->remove_control (trk->monitoring_control());
                }
-
-               factor = 0.0000003f / g - 1.0f;
+               routes->erase (i);
+               _session.set_dirty ();
+               RouteRemoved (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
+               return 0;
        }
 
-       return factor;
+       return -1;
 }
 
-gain_t
-RouteGroup::get_max_factor (gain_t factor)
-{
-       for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
-               gain_t const g = (*i)->gain_control()->get_value();
-
-               // if the current factor woulnd't raise this route above maximum
-               if ((g + g * factor) <= 1.99526231f) {
-                       continue;
-               }
-
-               // if route gain is already at peak, return 0.0f factor
-               if (g >= 1.99526231f) {
-                       return 0.0f;
-               }
-
-               // factor is calculated so that it would raise current route to max
-               factor = 1.99526231f / g - 1.0f;
-       }
-
-       return factor;
-}
 
 XMLNode&
 RouteGroup::get_state ()
@@ -248,7 +261,7 @@ RouteGroup::set_state (const XMLNode& node, int version)
                return set_state_2X (node, version);
        }
 
-       const XMLProperty *prop;
+       XMLProperty const * prop;
 
        set_id (node);
        set_values (node);
@@ -268,6 +281,19 @@ 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,6 +318,8 @@ RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
                _color = false;
        }
 
+       push_to_groups ();
+
        return 0;
 }
 
@@ -301,8 +329,14 @@ RouteGroup::set_gain (bool yn)
        if (is_gain() == yn) {
                return;
        }
+       if (has_control_master()) {
+               return;
+       }
+
        _gain = yn;
-       send_change (PropertyChange (Properties::gain));
+       _gain_group->set_active (yn);
+
+       send_change (PropertyChange (Properties::group_gain));
 }
 
 void
@@ -312,7 +346,9 @@ RouteGroup::set_mute (bool yn)
                return;
        }
        _mute = yn;
-       send_change (PropertyChange (Properties::mute));
+       _mute_group->set_active (yn);
+
+       send_change (PropertyChange (Properties::group_mute));
 }
 
 void
@@ -322,7 +358,9 @@ RouteGroup::set_solo (bool yn)
                return;
        }
        _solo = yn;
-       send_change (PropertyChange (Properties::solo));
+       _solo_group->set_active (yn);
+
+       send_change (PropertyChange (Properties::group_solo));
 }
 
 void
@@ -332,7 +370,8 @@ RouteGroup::set_recenable (bool yn)
                return;
        }
        _recenable = yn;
-       send_change (PropertyChange (Properties::recenable));
+       _rec_enable_group->set_active (yn);
+       send_change (PropertyChange (Properties::group_recenable));
 }
 
 void
@@ -342,7 +381,7 @@ RouteGroup::set_select (bool yn)
                return;
        }
        _select = yn;
-       send_change (PropertyChange (Properties::select));
+       send_change (PropertyChange (Properties::group_select));
 }
 
 void
@@ -352,7 +391,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
@@ -363,7 +402,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
@@ -383,7 +422,9 @@ RouteGroup::set_monitoring (bool yn)
        }
 
        _monitoring = yn;
-       send_change (PropertyChange (Properties::monitoring));
+       _monitoring_group->set_active (yn);
+
+       send_change (PropertyChange (Properties::group_monitoring));
 
        _session.set_dirty ();
 }
@@ -396,6 +437,9 @@ RouteGroup::set_active (bool yn, void* /*src*/)
        }
 
        _active = yn;
+
+       push_to_groups ();
+
        send_change (PropertyChange (Properties::active));
        _session.set_dirty ();
 }
@@ -406,8 +450,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 ();
 }
 
@@ -475,7 +523,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;
        }
@@ -530,3 +578,91 @@ RouteGroup::enabled_property (PBD::PropertyID prop)
 
        return dynamic_cast<const PropertyTemplate<bool>* > (i->second)->val ();
 }
+
+void
+RouteGroup::post_set (PBD::PropertyChange const &)
+{
+       push_to_groups ();
+}
+
+void
+RouteGroup::push_to_groups ()
+{
+       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);
+       }
+
+       group_master = master;
+       _group_master_number = master->number();
+}
+
+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;
+}
+
+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;
+}