move ever close to working master/slave logic, this time with audio testing
[ardour.git] / libs / ardour / gain_control.cc
index 5af0e2d397cf13d0d86d81dd17f82bbb23e7a7cb..3ffeb057da8fc1d0cc26a128375b15998470a3f7 100644 (file)
     675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
+#include <cmath>
+
+#include "pbd/convert.h"
+#include "pbd/strsplit.h"
+
 #include "ardour/dB.h"
 #include "ardour/gain_control.h"
 #include "ardour/session.h"
+#include "ardour/vca.h"
+#include "ardour/vca_manager.h"
 
 #include "i18n.h"
 
@@ -26,9 +33,9 @@ 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);
 
@@ -36,37 +43,6 @@ GainControl::GainControl (Session& session, const Evoral::Parameter &param, boos
        range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
 }
 
-double
-GainControl::get_value() const
-{
-       if (!_master) {
-               return AutomationControl::get_value();
-       }
-       return AutomationControl::get_value() * _master->get_value();
-}
-
-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
 {
@@ -107,28 +83,143 @@ GainControl::get_user_string () const
 }
 
 void
-GainControl::set_master (boost::shared_ptr<GainControl> m)
+GainControl::inc_gain (gain_t factor)
 {
-       double old_master_val;
+       /* To be used ONLY when doing group-relative gain adjustment, from
+        * ControlGroup::set_group_values().
+        */
 
-       if (_master) {
-               old_master_val = _master->get_value();
+       const float desired_gain = user_double();
+
+       if (fabsf (desired_gain) < GAIN_COEFF_SMALL) {
+               // really?! what's the idea here?
+               actually_set_value (0.000001f + (0.000001f * factor), Controllable::ForGroup);
        } else {
-               old_master_val = 1.0;
+               actually_set_value (desired_gain + (desired_gain * factor), Controllable::ForGroup);
        }
+}
 
-       _master = m;
+void
+GainControl::recompute_masters_ratios (double val)
+{
+       /* Master WRITE lock must be held */
 
-       double new_master_val;
+       /* V' is the new gain value for this
 
-       if (_master) {
-               new_master_val = _master->get_value();
-       } else {
-               new_master_val = 1.0;
+          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
+
+          the slave should return V' on the next call to ::get_value().
+
+          but the value is determined by the masters, so we know:
+
+          V' = (Mv(1) * Mr(1)) * (Mv(2) * Mr(2)) * ... * (Mv(n) * Mr(n))
+
+          hence:
+
+          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:
+
+          pow (Mr(n), n) = V' / (Mv(1) * Mv(2) * ... * Mv(n))
+
+          which gives
+
+          Mr(n) = pow ((V' / (Mv(1) * Mv(2) * ... * Mv(n))), 1/n)
+
+          Mr(n) is the new ratio number for the slaves
+       */
+
+
+       const double nmasters = _masters.size();
+       double masters_total_gain_coefficient = 1.0;
+
+       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));
+
+       for (Masters::iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
+               mr->second.reset_ratio (new_universal_ratio);
        }
 }
 
+XMLNode&
+GainControl::get_state ()
+{
+       XMLNode& node (AutomationControl::get_state());
+
+#if 0
+       /* store VCA master IDs */
+
+       string str;
+
+       {
+               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 (mr->first, std::dec);
+               }
+       }
+
+       if (!str.empty()) {
+               node.add_property (X_("masters"), str);
+       }
+#endif
+
+       return node;
+}
+
+int
+GainControl::set_state (XMLNode const& node, int version)
+{
+       AutomationControl::set_state (node, version);
+
+#if 0
+       XMLProperty const* prop = node.property (X_("masters"));
+
+       /* Problem here if we allow VCA's to be slaved to other VCA's .. we
+        * have to load all VCAs first, then set up slave/master relationships
+        * once we have them all.
+        */
+
+       if (prop) {
+               masters_string = prop->value ();
+
+               if (_session.vca_manager().vcas_loaded()) {
+                       vcas_loaded ();
+               } else {
+                       _session.vca_manager().VCAsLoaded.connect_same_thread (vca_loaded_connection, boost::bind (&GainControl::vcas_loaded, this));
+               }
+       }
+#endif
+
+       return 0;
+}
+
+void
+GainControl::vcas_loaded ()
+{
+       if (masters_string.empty()) {
+               return;
+       }
+
+       vector<string> masters;
+       split (masters_string, 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->gain_control());
+               }
+       }
+
+       vca_loaded_connection.disconnect ();
+       masters_string.clear ();
+}
+