auto-backup: gtk2_ardour part. (from mixbus)
[ardour.git] / libs / ardour / automation_control.cc
index 773fd3f40c8a2e2fcd8abb44d889adf5c99c2b2c..5755e04aacc7e04210acebd7c52eb8ad6ee93b4f 100644 (file)
 
 */
 
+#include <math.h>
 #include <iostream>
 
+#include "pbd/memento_command.h"
+#include "pbd/stacktrace.h"
+
+#include "ardour/audioengine.h"
 #include "ardour/automation_control.h"
 #include "ardour/automation_watch.h"
+#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 "pbd/i18n.h"
+
+#ifdef COMPILER_MSVC
+#include <float.h>
+// C99 'isfinite()' is not available in MSVC.
+#define isfinite_local(val) (bool)_finite((double)val)
+#else
+#define isfinite_local isfinite
+#endif
 
 using namespace std;
 using namespace ARDOUR;
@@ -33,24 +51,131 @@ 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)
+       , SessionHandleRef (session)
        , _desc(desc)
+       , _no_session(false)
 {
+       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 ()
 {
+       if (!_no_session && !_session.deletion_in_progress ()) {
+               _session.selection().remove_control_by_id (id());
+               DropReferences (); /* EMIT SIGNAL */
+       }
+}
+
+void
+AutomationControl::session_going_away ()
+{
+       SessionHandleRef::session_going_away ();
+       DropReferences (); /* EMIT SIGNAL */
+       _no_session = true;
+}
+
+bool
+AutomationControl::writable() const
+{
+       boost::shared_ptr<AutomationList> al = alist();
+       if (al) {
+               return al->automation_state() != Play;
+       }
+       return true;
 }
 
 /** Get the current effective `user' value based on automation state */
 double
 AutomationControl::get_value() const
 {
-       bool from_list = _list && ((AutomationList*)_list.get())->automation_playback();
-       return Control::get_double (from_list, _session.transport_frame());
+       bool from_list = alist() && alist()->automation_playback();
+       return Control::get_double (from_list, _session.transport_sample());
+}
+
+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)
+{
+       if (!writable()) {
+               return;
+       }
+
+       /* enforce strict double/boolean value mapping */
+
+       if (_desc.toggled) {
+               if (val != 0.0) {
+                       val = 1.0;
+               }
+       }
+
+       if (check_rt (val, gcd)) {
+               /* change has been queued to take place in an RT context */
+               return;
+       }
+
+       if (_group && _group->use_me (gcd)) {
+               _group->set_group_value (shared_from_this(), val);
+       } else {
+               actually_set_value (val, gcd);
+       }
+}
+
+ControlList
+AutomationControl::grouped_controls () const
+{
+       if (_group && _group->use_me (PBD::Controllable::UseGroup)) {
+               return _group->controls ();
+       } else {
+               return ControlList ();
+       }
+}
+
+void
+AutomationControl::automation_run (samplepos_t start, pframes_t nframes)
+{
+       if (!automation_playback ()) {
+               return;
+       }
+
+       assert (_list);
+       bool valid = false;
+       double val = _list->rt_safe_eval (start, valid);
+       if (!valid) {
+               return;
+       }
+       if (toggled ()) {
+               const double thresh = .5 * (_desc.upper - _desc.lower);
+               set_value_unchecked (val >= thresh ? _desc.upper : _desc.lower);
+       } else {
+               set_value_unchecked (val);
+       }
 }
 
 /** Set the value and do the right thing based on automation state
@@ -58,32 +183,82 @@ AutomationControl::get_value() const
  *  @param value `user' value
  */
 void
-AutomationControl::set_value (double value)
+AutomationControl::actually_set_value (double value, PBD::Controllable::GroupControlDisposition gcd)
 {
-       bool to_list = _list && ((AutomationList*)_list.get())->automation_write();
+       boost::shared_ptr<AutomationList> al = alist ();
+       const samplepos_t pos = _session.transport_sample();
+       bool to_list;
 
-       Control::set_double (value, _session.transport_frame(), to_list);
+       /* 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).
 
-       Changed(); /* EMIT SIGNAL */
+          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.
+       */
+       float old_value = Control::user_double();
+
+       if (al && al->automation_write ()) {
+               to_list = true;
+       } else {
+               to_list = false;
+       }
+
+       Control::set_double (value, pos, to_list);
+
+       if (old_value != (float)value) {
+#if 0
+               AutomationType at = (AutomationType) _parameter.type();
+               std::cerr << "++++ Changed (" << enum_2_string (at) << ", " << enum_2_string (gcd) << ") = " << value
+               << " (was " << old_value << ") @ " << this << std::endl;
+#endif
+
+               Changed (true, gcd);
+               if (!al || !al->automation_playback ()) {
+                       _session.set_dirty ();
+               }
+       }
 }
 
 void
 AutomationControl::set_list (boost::shared_ptr<Evoral::ControlList> list)
 {
        Control::set_list (list);
-       Changed();  /* EMIT SIGNAL */
+       Changed (true, Controllable::NoGroup);
 }
 
 void
 AutomationControl::set_automation_state (AutoState as)
 {
-       if (_list && as != alist()->automation_state()) {
+       if (flags() & NotAutomatable) {
+               return;
+       }
+       if (alist() && 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) {
+               } else if (as & (Touch | Latch)) {
+                       if (alist()->empty()) {
+                               Control::set_double (val, _session.current_start_sample (), true);
+                               Control::set_double (val, _session.current_end_sample (), true);
+                               Changed (true, Controllable::NoGroup);
+                       }
                        if (!touching()) {
                                AutomationWatch::instance().remove_automation_watch (shared_from_this());
                        } else {
@@ -96,23 +271,28 @@ AutomationControl::set_automation_state (AutoState as)
                        }
                } else {
                        AutomationWatch::instance().remove_automation_watch (shared_from_this());
+                       Changed (false, Controllable::NoGroup);
                }
        }
 }
 
 void
-AutomationControl::set_automation_style (AutoStyle as)
+AutomationControl::start_touch (double when)
 {
-       alist()->set_automation_style (as);
-}
+       if (!_list || touching ()) {
+               return;
+       }
 
-void
-AutomationControl::start_touch(double when)
-{
-       if (!_list) return;
-       if (!touching()) {
-               if (alist()->automation_state() == Touch) {
-                       alist()->start_touch (when);
+       if (alist()->automation_state() & (Touch | Latch)) {
+               /* 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());
                }
                set_touching (true);
@@ -120,14 +300,87 @@ AutomationControl::start_touch(double when)
 }
 
 void
-AutomationControl::stop_touch(bool mark, double when)
+AutomationControl::stop_touch (double when)
 {
-       if (!_list) return;
-       if (touching()) {
-               set_touching (false);
-               if (alist()->automation_state() == Touch) {
-                       alist()->stop_touch (mark, when);
+       if (!_list || !touching ()) {
+               return;
+       }
+
+       if (alist()->automation_state() == Latch && _session.transport_rolling ()) {
+               return;
+       }
+
+       set_touching (false);
+
+       if (alist()->automation_state() & (Touch | Latch)) {
+               alist()->stop_touch (when);
+               if (!_desc.toggled) {
                        AutomationWatch::instance().remove_automation_watch (shared_from_this());
                }
        }
 }
+
+void
+AutomationControl::commit_transaction (bool did_write)
+{
+       if (did_write) {
+               XMLNode* before = alist ()->before ();
+               if (before) {
+                       _session.begin_reversible_command (string_compose (_("record %1 automation"), name ()));
+                       _session.commit_reversible_command (alist ()->memento_command (before, &alist ()->get_state ()));
+               }
+       } else {
+               alist ()->clear_history ();
+       }
+}
+
+/* take control-value and return UI range [0..1] */
+double
+AutomationControl::internal_to_interface (double val) const
+{
+       // 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;
+       }
+       // XXX maybe optimize. see above.
+       return _desc.from_interface (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)
+{
+       /* 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;
+}
+
+bool
+AutomationControl::check_rt (double val, Controllable::GroupControlDisposition gcd)
+{
+       if (!_session.loading() && (flags() & Controllable::RealTime) && !AudioEngine::instance()->in_process_thread()) {
+               /* queue change in RT context */
+               _session.set_control (shared_from_this(), val, gcd);
+               return true;
+       }
+
+       return false;
+}