fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / gain_control.cc
index c5f1f25bb7cd9b5986d327bdf34f651035d1f07c..8910c9a98c6b4fafac48905d420e24f4febeec35 100644 (file)
@@ -16,6 +16,8 @@
     675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
+#include <cmath>
+
 #include "pbd/convert.h"
 #include "pbd/strsplit.h"
 
 #include "ardour/vca.h"
 #include "ardour/vca_manager.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace std;
 
 GainControl::GainControl (Session& session, const Evoral::Parameter &param, boost::shared_ptr<AutomationList> al)
-       : AutomationControl (session, param, ParameterDescriptor(param),
-                            al ? al : boost::shared_ptr<AutomationList> (new AutomationList (param)),
-                            param.type() == GainAutomation ? X_("gaincontrol") : X_("trimcontrol")) {
+       : SlavableAutomationControl (session, param, ParameterDescriptor(param),
+                                    al ? al : boost::shared_ptr<AutomationList> (new AutomationList (param)),
+                                    param.type() == GainAutomation ? X_("gaincontrol") : X_("trimcontrol")) {
 
        alist()->reset_default (1.0);
 
@@ -41,28 +43,6 @@ GainControl::GainControl (Session& session, const Evoral::Parameter &param, boos
        range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
 }
 
-void
-GainControl::set_value (double val, PBD::Controllable::GroupControlDisposition group_override)
-{
-       if (writable()) {
-               _set_value (val, group_override);
-       }
-}
-
-void
-GainControl::set_value_unchecked (double val)
-{
-       /* used only automation playback */
-       _set_value (val, Controllable::NoGroup);
-}
-
-void
-GainControl::_set_value (double val, Controllable::GroupControlDisposition group_override)
-{
-       AutomationControl::set_value (std::max (std::min (val, (double)_desc.upper), (double)_desc.lower), group_override);
-       _session.set_dirty ();
-}
-
 double
 GainControl::internal_to_interface (double v) const
 {
@@ -102,111 +82,69 @@ GainControl::get_user_string () const
        return std::string(theBuf);
 }
 
-gain_t
-GainControl::get_master_gain () const
+void
+GainControl::inc_gain (gain_t factor)
 {
-       Glib::Threads::Mutex::Lock sm (master_lock, Glib::Threads::TRY_LOCK);
+       /* To be used ONLY when doing group-relative gain adjustment, from
+        * ControlGroup::set_group_values().
+        */
 
-       if (sm.locked()) {
-               return get_master_gain_locked ();
-       }
+       const float desired_gain = user_double();
 
-       return 1.0;
+       if (fabsf (desired_gain) < GAIN_COEFF_SMALL) {
+               // really?! what's the idea here?
+               actually_set_value (0.000001f + (0.000001f * factor), Controllable::ForGroup);
+       } else {
+               actually_set_value (desired_gain + (desired_gain * factor), Controllable::ForGroup);
+       }
 }
 
-gain_t
-GainControl::get_master_gain_locked () const
+void
+GainControl::recompute_masters_ratios (double val)
 {
-       /* Master lock MUST be held */
+       /* Master WRITE lock must be held */
 
-       gain_t g = 1.0;
+       /* V' is the new gain value for this
 
-       for (Masters::const_iterator m = _masters.begin(); m != _masters.end(); ++m) {
-               g *= (*m)->get_value ();
-       }
+          Mv(n) is the return value of ::get_value() for the n-th master
+          Mr(n) is the return value of ::ratio() for the n-th master record
 
-       return g;
-}
+          the slave should return V' on the next call to ::get_value().
 
-void
-GainControl::add_master (boost::shared_ptr<VCA> vca)
-{
-       gain_t old_master_val;
-       gain_t new_master_val;
+          but the value is determined by the masters, so we know:
 
-       {
-               Glib::Threads::Mutex::Lock lm (master_lock);
-               old_master_val = get_master_gain_locked ();
-               _masters.insert (vca->control());
-               _masters_numbers.insert (vca->number());
-               new_master_val = get_master_gain_locked ();
+          V' = (Mv(1) * Mr(1)) * (Mv(2) * Mr(2)) * ... * (Mv(n) * Mr(n))
 
-               /* note that we bind @param m as a weak_ptr<GainControl>, thus
-                  avoiding holding a reference to the control in the binding
-                  itself.
-               */
+          hence:
 
-               vca->DropReferences.connect_same_thread (masters_connections, boost::bind (&GainControl::master_going_away, this, vca));
+          Mr(1) * Mr(2) * ... * (Mr(n) = V' / (Mv(1) * Mv(2) * ... * Mv(n))
 
-       }
+          if we make all ratios equal (i.e. each master contributes the same
+          fraction of its own gain level to make the final slave gain), then we
+          have:
 
-       if (old_master_val != new_master_val) {
-               Changed(); /* EMIT SIGNAL */
-       }
-}
+          pow (Mr(n), n) = V' / (Mv(1) * Mv(2) * ... * Mv(n))
 
-void
-GainControl::master_going_away (boost::weak_ptr<VCA> wv)
-{
-       boost::shared_ptr<VCA> v = wv.lock();
-       if (v) {
-               remove_master (v);
-       }
-}
+          which gives
 
-void
-GainControl::remove_master (boost::shared_ptr<VCA> vca)
-{
-       gain_t old_master_val;
-       gain_t new_master_val;
+          Mr(n) = pow ((V' / (Mv(1) * Mv(2) * ... * Mv(n))), 1/n)
 
-       {
-               Glib::Threads::Mutex::Lock lm (master_lock);
-               old_master_val = get_master_gain_locked ();
-               _masters.erase (vca->control());
-               _masters_numbers.erase (vca->number());
-               new_master_val = get_master_gain_locked ();
-       }
+          Mr(n) is the new ratio number for the slaves
+       */
 
-       if (old_master_val != new_master_val) {
-               Changed(); /* EMIT SIGNAL */
-       }
-}
 
-void
-GainControl::clear_masters ()
-{
-       gain_t old_master_val;
-       gain_t new_master_val;
+       const double nmasters = _masters.size();
+       double masters_total_gain_coefficient = 1.0;
 
-       {
-               Glib::Threads::Mutex::Lock lm (master_lock);
-               old_master_val = get_master_gain_locked ();
-               _masters.clear ();
-               _masters_numbers.clear ();
-               new_master_val = get_master_gain_locked ();
+       for (Masters::iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
+               masters_total_gain_coefficient *= mr->second.master()->get_value();
        }
 
-       if (old_master_val != new_master_val) {
-               Changed(); /* EMIT SIGNAL */
-       }
-}
+       const double new_universal_ratio = pow ((val / masters_total_gain_coefficient), (1.0/nmasters));
 
-bool
-GainControl::slaved_to (boost::shared_ptr<VCA> vca) const
-{
-       Glib::Threads::Mutex::Lock lm (master_lock);
-       return find (_masters.begin(), _masters.end(), vca->control()) != _masters.end();
+       for (Masters::iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
+               mr->second.reset_ratio (new_universal_ratio);
+       }
 }
 
 XMLNode&
@@ -214,23 +152,25 @@ GainControl::get_state ()
 {
        XMLNode& node (AutomationControl::get_state());
 
+#if 0
        /* store VCA master IDs */
 
        string str;
 
        {
-               Glib::Threads::Mutex::Lock lm (master_lock);
-               for (set<uint32_t>::const_iterator m = _masters_numbers.begin(); m != _masters_numbers.end(); ++m) {
+               Glib::Threads::RWLock::ReaderLock lm (master_lock);
+               for (Masters::const_iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
                        if (!str.empty()) {
                                str += ',';
                        }
-                       str += PBD::to_string (*m, std::dec);
+                       str += PBD::to_string (mr->first, std::dec);
                }
        }
 
        if (!str.empty()) {
                node.add_property (X_("masters"), str);
        }
+#endif
 
        return node;
 }
@@ -238,26 +178,6 @@ GainControl::get_state ()
 int
 GainControl::set_state (XMLNode const& node, int version)
 {
-       AutomationControl::set_state (node, version);
-
-       XMLProperty const* prop = node.property (X_("masters"));
-
-       /* XXXProblem here if we allow VCA's to be slaved to other VCA's .. we
-        * have to load all VCAs first, then call ::set_state() so that
-        * vca_by_number() will succeed.
-        */
-
-       if (prop) {
-               vector<string> masters;
-               split (prop->value(), masters, ',');
-
-               for (vector<string>::const_iterator m = masters.begin(); m != masters.end(); ++m) {
-                       boost::shared_ptr<VCA> vca = _session.vca_manager().vca_by_number (PBD::atoi (*m));
-                       if (vca) {
-                               add_master (vca);
-                       }
-               }
-       }
-
-       return 0;
+       return AutomationControl::set_state (node, version);
 }
+