Add option to limit automatable control parmaters
[ardour.git] / libs / ardour / gain_control.cc
index 124ce97d45a68239e4359c563d23afe7314e00cc..1813586e0935a49cf8e2aa177f9311f3a7a853df 100644 (file)
 #include "pbd/convert.h"
 #include "pbd/strsplit.h"
 
+#include "evoral/Curve.hpp"
+
 #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"
+#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")) {
-
-       alist()->reset_default (1.0);
-
-       lower_db = accurate_coefficient_to_dB (_desc.lower);
-       range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
-}
-
-double
-GainControl::get_value () const
+       : SlavableAutomationControl (session, param, ParameterDescriptor(param),
+                                    al ? al : boost::shared_ptr<AutomationList> (new AutomationList (param)),
+                                    param.type() == GainAutomation ? X_("gaincontrol") : X_("trimcontrol"),
+                                    Controllable::GainLike)
 {
-       Glib::Threads::RWLock::ReaderLock lm (master_lock);
-
-       if (_masters.empty()) {
-               return AutomationControl::get_value();
-       }
-
-       gain_t g = 1.0;
-
-       for (Masters::const_iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
-               /* get current master value, scale by our current ratio with that master */
-               g *= mr->master()->get_value () * mr->ratio();
-       }
-
-       return g;
-}
-
-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)
+GainControl::inc_gain (gain_t factor)
 {
-       /* used only automation playback */
-       _set_value (val, Controllable::NoGroup);
-}
-
-void
-GainControl::_set_value (double val, Controllable::GroupControlDisposition group_override)
-{
-       val = std::max (std::min (val, (double)_desc.upper), (double)_desc.lower);
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-
-               if (!_masters.empty()) {
-                       recompute_masters_ratios (val);
-               }
-       }
-
-       AutomationControl::set_value (val, group_override);
-
-       _session.set_dirty ();
-}
+       /* To be used ONLY when doing group-relative gain adjustment, from
+        * ControlGroup::set_group_values().
+        */
 
-double
-GainControl::internal_to_interface (double v) const
-{
-       if (_desc.type == GainAutomation) {
-               return gain_to_slider_position (v);
-       } else {
-               return (accurate_coefficient_to_dB (v) - lower_db) / range_db;
-       }
-}
+       const float desired_gain = get_value ();
 
-double
-GainControl::interface_to_internal (double v) const
-{
-       if (_desc.type == GainAutomation) {
-               return slider_position_to_gain (v);
+       if (fabsf (desired_gain) < GAIN_COEFF_SMALL) {
+               // really?! what's the idea here?
+               actually_set_value (0.000001f + (0.000001f * factor), Controllable::ForGroup);
        } else {
-               return dB_to_coefficient (lower_db + v * range_db);
-       }
-}
-
-double
-GainControl::internal_to_user (double v) const
-{
-       return accurate_coefficient_to_dB (v);
-}
-
-double
-GainControl::user_to_internal (double u) const
-{
-       return dB_to_coefficient (u);
-}
-
-std::string
-GainControl::get_user_string () const
-{
-       char theBuf[32]; sprintf( theBuf, _("%3.1f dB"), accurate_coefficient_to_dB (get_value()));
-       return std::string(theBuf);
-}
-
-gain_t
-GainControl::get_master_gain () const
-{
-       Glib::Threads::RWLock::ReaderLock sm (master_lock, Glib::Threads::TRY_LOCK);
-
-       if (sm.locked()) {
-               return get_master_gain_locked ();
-       }
-
-       return 1.0;
-}
-
-gain_t
-GainControl::get_master_gain_locked () const
-{
-       /* Master lock MUST be held (read or write lock is acceptable) */
-
-       gain_t g = 1.0;
-
-       for (Masters::const_iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
-               /* get current master value, scale by our current ratio with that master */
-               g *= mr->master()->get_value () * mr->ratio();
-       }
-
-       return g;
-}
-
-void
-GainControl::add_master (boost::shared_ptr<VCA> vca)
-{
-       gain_t old_master_val;
-       std::pair<Masters::iterator,bool> res;
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-               old_master_val = get_master_gain_locked ();
-
-               /* ratio will be recomputed below */
-
-               MasterRecord mr (vca->control(), vca->number(), 0.0);
-
-               res = _masters.insert (mr);
-               recompute_masters_ratios (old_master_val);
-
-               /* note that we bind @param m as a weak_ptr<GainControl>, thus
-                  avoiding holding a reference to the control in the binding
-                  itself.
-               */
-
-               vca->DropReferences.connect_same_thread (masters_connections, boost::bind (&GainControl::master_going_away, this, vca));
-               vca->control()->Changed.connect_same_thread (masters_connections, boost::bind (&PBD::Signal0<void>::operator(), &Changed));
-       }
-
-       if (res.second) {
-               VCAStatusChange (); /* EMIT SIGNAL */
+               actually_set_value (desired_gain + (desired_gain * factor), Controllable::ForGroup);
        }
 }
 
 void
-GainControl::master_going_away (boost::weak_ptr<VCA> wv)
+GainControl::post_add_master (boost::shared_ptr<AutomationControl> m)
 {
-       boost::shared_ptr<VCA> v = wv.lock();
-       if (v) {
-               remove_master (v);
+       if (m->get_value() == 0) {
+               /* master is at -inf, which forces this ctrl to -inf on assignment */
+               Changed (false, Controllable::NoGroup); /* EMIT SIGNAL */
        }
 }
 
-void
-GainControl::remove_master (boost::shared_ptr<VCA> vca)
-{
-       gain_t old_master_val;
-       Masters::size_type erased = 0;
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-               old_master_val = get_master_gain_locked ();
-               MasterRecord mr (vca->control(), vca->number(), 0.0);
-               erased = _masters.erase (mr);
-               if (erased) {
-                       recompute_masters_ratios (old_master_val);
-               }
-       }
-
-       if (erased) {
-               VCAStatusChange (); /* EMIT SIGNAL */
-       }
-}
-
-void
-GainControl::clear_masters ()
-{
-       bool had_masters = false;
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-               if (!_masters.empty()) {
-                       had_masters = true;
-               }
-               _masters.clear ();
-       }
-
-       if (had_masters) {
-               VCAStatusChange (); /* EMIT SIGNAL */
-       }
-}
-
-void
-GainControl::recompute_masters_ratios (double val)
-{
-       /* Master WRITE lock must be held */
-
-       /* V' is the new gain value for this
-
-          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->master()->get_value();
-       }
-
-       const double new_universal_ratio = pow ((val / masters_total_gain_coefficient), (1.0/nmasters));
-
-       for (Masters::iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
-               const_cast<MasterRecord*>(&(*mr))->reset_ratio (new_universal_ratio);
-       }
-}
-
-bool
-GainControl::slaved_to (boost::shared_ptr<VCA> vca) const
-{
-       Glib::Threads::RWLock::ReaderLock lm (master_lock);
-       return find (_masters.begin(), _masters.end(), MasterRecord (vca->control(), vca->number(), 0.0)) != _masters.end();
-}
-
 bool
-GainControl::slaved () const
-{
-       Glib::Threads::RWLock::ReaderLock lm (master_lock);
-       return !_masters.empty();
-}
-
-XMLNode&
-GainControl::get_state ()
+GainControl::get_masters_curve_locked (samplepos_t start, samplepos_t end, float* vec, samplecnt_t veclen) const
 {
-       XMLNode& node (AutomationControl::get_state());
-
-       /* 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->number(), std::dec);
-               }
-       }
-
-       if (!str.empty()) {
-               node.add_property (X_("masters"), str);
+       if (_masters.empty()) {
+               return list()->curve().rt_safe_get_vector (start, end, vec, veclen);
        }
-
-       return node;
-}
-
-int
-GainControl::set_state (XMLNode const& node, int version)
-{
-       AutomationControl::set_state (node, version);
-
-       XMLProperty const* prop = node.property (X_("masters"));
-
-       /* XXX Problem 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);
-                       }
-               }
+       for (samplecnt_t i = 0; i < veclen; ++i) {
+               vec[i] = 1.f;
        }
-
-       return 0;
+       return SlavableAutomationControl::masters_curve_multiply (start, end, vec, veclen);
 }