a-EQ: Tweak knob layout to be less confusing
[ardour.git] / libs / ardour / automation_control.cc
index d7b645d8ae06a806d17d6ebc9db649fb44d242fa..4e81de8aaffb067d917d07fb2b434aeb6d9c4f1b 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/memento_command.h"
-#include "pbd/stacktrace.h"
-
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #ifdef COMPILER_MSVC
 #include <float.h>
@@ -46,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 */
 }
 
@@ -69,42 +84,48 @@ AutomationControl::writable() const
        return true;
 }
 
+/** Get the current effective `user' value based on automation state */
 double
-AutomationControl::get_masters_value_locked () const
+AutomationControl::get_value() const
 {
-       gain_t v = 1.0;
+       bool from_list = _list && boost::dynamic_pointer_cast<AutomationList>(_list)->automation_playback();
+       return Control::get_double (from_list, _session.transport_frame());
+}
 
-       for (Masters::const_iterator mr = _masters.begin(); mr != _masters.end(); ++mr) {
-               /* get current master value, scale by our current ratio with that master */
-               v *= mr->second.master()->get_value () * mr->second.ratio();
+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);
        }
-
-       return min (_desc.upper, v);
 }
 
-double
-AutomationControl::get_value_locked() const
+void
+AutomationControl::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 {
-       /* read or write masters lock must be held */
-
-       if (_masters.empty()) {
-               return Control::get_double (false, _session.transport_frame());
+       if (!writable()) {
+               return;
        }
 
-       return get_masters_value_locked ();
-}
+       /* enforce strict double/boolean value mapping */
 
-/** Get the current effective `user' value based on automation state */
-double
-AutomationControl::get_value() const
-{
-       bool from_list = _list && ((AutomationList*)_list.get())->automation_playback();
+       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 (!from_list) {
-               Glib::Threads::RWLock::ReaderLock lm (master_lock);
-               return get_value_locked ();
+       if (_group && _group->use_me (gcd)) {
+               _group->set_group_value (shared_from_this(), val);
        } else {
-               return Control::get_double (from_list, _session.transport_frame());
+               actually_set_value (val, gcd);
        }
 }
 
@@ -113,35 +134,91 @@ AutomationControl::get_value() const
  *  @param value `user' value
  */
 void
-AutomationControl::set_value (double value, PBD::Controllable::GroupControlDisposition /* group_override */)
+AutomationControl::actually_set_value (double value, PBD::Controllable::GroupControlDisposition gcd)
 {
-       bool to_list = _list && ((AutomationList*)_list.get())->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);
+
+       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;
 
-       Control::set_double (value, _session.transport_frame(), to_list);
+               Changed (true, gcd);
+               if (!al || !al->automation_playback ()) {
+                       _session.set_dirty ();
+               }
+       }
 
-       Changed(); /* EMIT SIGNAL */
 }
 
 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 (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 {
@@ -263,102 +340,32 @@ AutomationControl::interface_to_internal (double val) const
        return val;
 }
 
-
-void
-AutomationControl::add_master (boost::shared_ptr<AutomationControl> m)
-{
-       double current_value;
-       std::pair<Masters::iterator,bool> res;
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-               current_value = get_value_locked ();
-
-               /* ratio will be recomputed below */
-
-               res = _masters.insert (make_pair<PBD::ID,MasterRecord> (m->id(), MasterRecord (m, 1.0)));
-
-               if (res.second) {
-
-                       recompute_masters_ratios (current_value);
-
-                       /* note that we bind @param m as a weak_ptr<AutomationControl>, thus
-                          avoiding holding a reference to the control in the binding
-                          itself.
-                       */
-
-                       m->DropReferences.connect_same_thread (masters_connections, boost::bind (&AutomationControl::master_going_away, this, m));
-
-                       /* Store the connection inside the MasterRecord, so that when we destroy it, the connection is destroyed
-                          and we no longer hear about changes to the AutomationControl.
-                       */
-
-                       m->Changed.connect_same_thread (res.first->second.connection, boost::bind (&PBD::Signal0<void>::operator(), &Changed));
-               }
-       }
-
-       if (res.second) {
-               MasterStatusChange (); /* EMIT SIGNAL */
-       }
-}
-
-void
-AutomationControl::master_going_away (boost::weak_ptr<AutomationControl> wm)
-{
-       boost::shared_ptr<AutomationControl> m = wm.lock();
-       if (m) {
-               remove_master (m);
-       }
-}
-
-void
-AutomationControl::remove_master (boost::shared_ptr<AutomationControl> m)
+std::string
+AutomationControl::get_user_string () const
 {
-       double current_value;
-       Masters::size_type erased = 0;
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-               current_value = get_value_locked ();
-               erased = _masters.erase (m->id());
-               if (erased) {
-                       recompute_masters_ratios (current_value);
-               }
-       }
-
-       if (erased) {
-               MasterStatusChange (); /* EMIT SIGNAL */
-       }
+       return ARDOUR::value_as_string (_desc, get_value());
 }
 
 void
-AutomationControl::clear_masters ()
+AutomationControl::set_group (boost::shared_ptr<ControlGroup> cg)
 {
-       bool had_masters = false;
-
-       {
-               Glib::Threads::RWLock::WriterLock lm (master_lock);
-               if (!_masters.empty()) {
-                       had_masters = true;
-               }
-               _masters.clear ();
-       }
+       /* 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.
+       */
 
-       if (had_masters) {
-               MasterStatusChange (); /* EMIT SIGNAL */
-       }
+       _group = cg;
 }
 
 bool
-AutomationControl::slaved_to (boost::shared_ptr<AutomationControl> m) const
+AutomationControl::check_rt (double val, Controllable::GroupControlDisposition gcd)
 {
-       Glib::Threads::RWLock::ReaderLock lm (master_lock);
-       return _masters.find (m->id()) != _masters.end();
-}
+       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;
+       }
 
-bool
-AutomationControl::slaved () const
-{
-       Glib::Threads::RWLock::ReaderLock lm (master_lock);
-       return !_masters.empty();
+       return false;
 }