Remove LocaleGuard from ARDOUR::Pannable class
[ardour.git] / libs / ardour / automation_control.cc
index 7efaa07f233158c345af4bdd718abb9dd86315a8..30eb19fd5a54fa015fffbb72aa7d9c4a07203ccf 100644 (file)
 #include "ardour/control_group.h"
 #include "ardour/event_type_map.h"
 #include "ardour/session.h"
+#include "ardour/selection.h"
+#include "ardour/value_as_string.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #ifdef COMPILER_MSVC
 #include <float.h>
@@ -49,16 +51,26 @@ AutomationControl::AutomationControl(ARDOUR::Session&                          s
                                      const Evoral::Parameter&                  parameter,
                                      const ParameterDescriptor&                desc,
                                      boost::shared_ptr<ARDOUR::AutomationList> list,
-                                     const string&                             name)
-       : Controllable (name.empty() ? EventTypeMap::instance().to_symbol(parameter) : name)
+                                     const string&                             name,
+                                     Controllable::Flag                        flags)
+
+       : Controllable (name.empty() ? EventTypeMap::instance().to_symbol(parameter) : name, flags)
        , Evoral::Control(parameter, desc, list)
        , _session(session)
        , _desc(desc)
 {
+       if (_desc.toggled) {
+               set_flags (Controllable::Toggle);
+       }
+       boost::shared_ptr<AutomationList> al = alist();
+       if (al) {
+               al->StateChanged.connect_same_thread (_state_changed_connection, boost::bind (&Session::set_dirty, &_session));
+       }
 }
 
 AutomationControl::~AutomationControl ()
 {
+       _session.selection().remove_control_by_id (id());
        DropReferences (); /* EMIT SIGNAL */
 }
 
@@ -80,6 +92,23 @@ AutomationControl::get_value() const
        return Control::get_double (from_list, _session.transport_frame());
 }
 
+double
+AutomationControl::get_save_value() const
+{
+       /* save user-value, not incl masters */
+       return Control::get_double ();
+}
+
+void
+AutomationControl::pre_realtime_queue_stuff (double val, PBD::Controllable::GroupControlDisposition gcd)
+{
+       if (_group && _group->use_me (gcd)) {
+               _group->pre_realtime_queue_stuff (val);
+       } else {
+               do_pre_realtime_queue_stuff (val);
+       }
+}
+
 void
 AutomationControl::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 {
@@ -114,14 +143,56 @@ AutomationControl::set_value (double val, PBD::Controllable::GroupControlDisposi
 void
 AutomationControl::actually_set_value (double value, PBD::Controllable::GroupControlDisposition gcd)
 {
-       bool to_list = _list && boost::dynamic_pointer_cast<AutomationList>(_list)->automation_write();
+       boost::shared_ptr<AutomationList> al = boost::dynamic_pointer_cast<AutomationList> (_list);
+       const framepos_t pos = _session.transport_frame();
+       bool to_list;
+       double old_value;
+
+       /* We cannot use ::get_value() here since that is virtual, and intended
+          to return a scalar value that in some way reflects the state of the
+          control (with semantics defined by the control itself, since it's
+          internal state may be more complex than can be fully represented by
+          a single scalar).
+
+          This method's only job is to set the "user_double()" value of the
+          underlying Evoral::Control object, and so we should compare the new
+          value we're being given to the current user_double().
+
+          Unless ... we're doing automation playback, in which case the
+          current effective value of the control (used to determine if
+          anything has changed) is the one derived from the automation event
+          list.
+       */
+
+       if (!al) {
+               to_list = false;
+               old_value = Control::user_double();
+       } else {
+               if (al->automation_write ()) {
+                       to_list = true;
+                       old_value = Control::user_double ();
+               } else if (al->automation_playback()) {
+                       to_list = false;
+                       old_value = al->eval (pos);
+               } else {
+                       to_list = false;
+                       old_value = Control::user_double ();
+               }
+       }
+
+       Control::set_double (value, pos, to_list);
 
-       Control::set_double (value, _session.transport_frame(), to_list);
+       if (old_value != value) {
+               //AutomationType at = (AutomationType) _parameter.type();
+               //std::cerr << "++++ Changed (" << enum_2_string (at) << ", " << enum_2_string (gcd) << ") = " << value
+               //<< " (was " << old_value << ") @ " << this << std::endl;
 
-       AutomationType at = (AutomationType) _parameter.type();
+               Changed (true, gcd);
+               if (!al || !al->automation_playback ()) {
+                       _session.set_dirty ();
+               }
+       }
 
-       std::cerr << "++++ Changed (" << enum_2_string (at) << ", " << enum_2_string (gcd) << ") = " << value << " @ " << this << std::endl;
-       Changed (true, gcd);
 }
 
 void
@@ -134,16 +205,27 @@ AutomationControl::set_list (boost::shared_ptr<Evoral::ControlList> list)
 void
 AutomationControl::set_automation_state (AutoState as)
 {
+       if (flags() & NotAutomatable) {
+               return;
+       }
        if (_list && as != alist()->automation_state()) {
 
+               const double val = get_value ();
+
                alist()->set_automation_state (as);
                if (_desc.toggled) {
+                       Changed (false, Controllable::NoGroup); // notify slaves, update boolean masters
                        return;  // No watch for boolean automation
                }
 
                if (as == Write) {
                        AutomationWatch::instance().add_automation_watch (shared_from_this());
                } else if (as == Touch) {
+                       if (alist()->empty()) {
+                               Control::set_double (val, _session.current_start_frame (), true);
+                               Control::set_double (val, _session.current_end_frame (), true);
+                               Changed (true, Controllable::NoGroup);
+                       }
                        if (!touching()) {
                                AutomationWatch::instance().remove_automation_watch (shared_from_this());
                        } else {
@@ -160,13 +242,6 @@ AutomationControl::set_automation_state (AutoState as)
        }
 }
 
-void
-AutomationControl::set_automation_style (AutoStyle as)
-{
-       if (!_list) return;
-       alist()->set_automation_style (as);
-}
-
 void
 AutomationControl::start_touch(double when)
 {
@@ -175,10 +250,14 @@ AutomationControl::start_touch(double when)
        }
 
        if (!touching()) {
-
                if (alist()->automation_state() == Touch) {
-                       /* subtle. aligns the user value with the playback */
-                       set_value (get_value (), Controllable::NoGroup);
+                       /* subtle. aligns the user value with the playback and
+                        * use take actual value (incl masters).
+                        *
+                        * Touch + hold writes inverse curve of master-automation
+                        * using AutomationWatch::timer ()
+                        */
+                       AutomationControl::actually_set_value (get_value (), Controllable::NoGroup);
                        alist()->start_touch (when);
                        if (!_desc.toggled) {
                                AutomationWatch::instance().add_automation_watch (shared_from_this());
@@ -218,59 +297,41 @@ AutomationControl::commit_transaction (bool did_write)
        }
 }
 
+/* take control-value and return UI range [0..1] */
 double
 AutomationControl::internal_to_interface (double val) const
 {
-       if (_desc.integer_step) {
-               // both upper and lower are inclusive.
-               val =  (val - lower()) / (1 + upper() - lower());
-       } else {
-               val =  (val - lower()) / (upper() - lower());
-       }
-
-       if (_desc.logarithmic) {
-               if (val > 0) {
-                       val = pow (val, 1./2.0);
-               } else {
-                       val = 0;
-               }
-       }
-
-       return val;
+       // XXX maybe optimize. _desc.from_interface() has
+       // a switch-statement depending on AutomationType.
+       return _desc.to_interface (val);
 }
 
+/* map GUI range [0..1] to control-value */
 double
 AutomationControl::interface_to_internal (double val) const
 {
        if (!isfinite_local (val)) {
+               assert (0);
                val = 0;
        }
-       if (_desc.logarithmic) {
-               if (val <= 0) {
-                       val = 0;
-               } else {
-                       val = pow (val, 2.0);
-               }
-       }
-
-       if (_desc.integer_step) {
-               val =  lower() + val * (1 + upper() - lower());
-       } else {
-               val =  lower() + val * (upper() - lower());
-       }
-
-       if (val < lower()) val = lower();
-       if (val > upper()) val = upper();
+       // XXX maybe optimize. see above.
+       return _desc.from_interface (val);
+}
 
-       return val;
+std::string
+AutomationControl::get_user_string () const
+{
+       return ARDOUR::value_as_string (_desc, get_value());
 }
 
 void
 AutomationControl::set_group (boost::shared_ptr<ControlGroup> cg)
 {
-       if (_group) {
-               _group->remove_control (shared_from_this());
-       }
+       /* this method can only be called by a ControlGroup. We do not need
+          to ensure consistency by calling ControlGroup::remove_control(),
+          since we are guaranteed that the ControlGroup will take care of that
+          for us.
+       */
 
        _group = cg;
 }
@@ -278,9 +339,8 @@ AutomationControl::set_group (boost::shared_ptr<ControlGroup> cg)
 bool
 AutomationControl::check_rt (double val, Controllable::GroupControlDisposition gcd)
 {
-       if ((flags() & Controllable::RealTime) && !AudioEngine::instance()->in_process_thread()) {
+       if (!_session.loading() && (flags() & Controllable::RealTime) && !AudioEngine::instance()->in_process_thread()) {
                /* queue change in RT context */
-               std::cerr << "::set_value (" << val << ", " << enum_2_string (gcd) << ") called for " << enum_2_string ((AutomationType) _parameter.type()) << ", queueing in RT context\n";
                _session.set_control (shared_from_this(), val, gcd);
                return true;
        }