Consistent Automation evaluation:
[ardour.git] / libs / ardour / automation_list.cc
index 2f06f267c1647abad2c9920bdf298bd7fd06a167..27bc64462e336debfbff88ed283e38c201a62d3d 100644 (file)
 #include <cmath>
 #include <sstream>
 #include <algorithm>
-#include <sigc++/bind.h>
 #include "ardour/automation_list.h"
+#include "ardour/beats_frames_converter.h"
 #include "ardour/event_type_map.h"
+#include "ardour/parameter_descriptor.h"
+#include "ardour/parameter_types.h"
+#include "ardour/evoral_types_convert.h"
+#include "ardour/types_convert.h"
 #include "evoral/Curve.hpp"
+#include "pbd/memento_command.h"
 #include "pbd/stacktrace.h"
 #include "pbd/enumwriter.h"
+#include "pbd/types_convert.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
-using namespace sigc;
 using namespace PBD;
 
-sigc::signal<void,AutomationList *> AutomationList::AutomationListCreated;
+PBD::Signal1<void,AutomationList *> AutomationList::AutomationListCreated;
 
 #if 0
 static void dumpit (const AutomationList& al, string prefix = "")
 {
        cerr << prefix << &al << endl;
-       for (AutomationList::const_iterator i = al.const_begin(); i != al.const_end(); ++i) {
+       for (AutomationList::const_iterator i = al.begin(); i != al.end(); ++i) {
                cerr << prefix << '\t' << (*i)->when << ',' << (*i)->value << endl;
        }
        cerr << "\n";
 }
 #endif
+AutomationList::AutomationList (const Evoral::Parameter& id, const Evoral::ParameterDescriptor& desc)
+       : ControlList(id, desc)
+       , _before (0)
+{
+       _state = Off;
+       g_atomic_int_set (&_touching, 0);
+       _interpolation = default_interpolation ();
+
+       create_curve_if_necessary();
+
+       assert(_parameter.type() != NullAutomation);
+       AutomationListCreated(this);
+}
 
-AutomationList::AutomationList (Evoral::Parameter id)
-       : ControlList(id)
+AutomationList::AutomationList (const Evoral::Parameter& id)
+       : ControlList(id, ARDOUR::ParameterDescriptor(id))
+       , _before (0)
 {
        _state = Off;
-       _style = Absolute;
-       _touching = false;
+       g_atomic_int_set (&_touching, 0);
+       _interpolation = default_interpolation ();
 
        create_curve_if_necessary();
 
@@ -64,12 +83,12 @@ AutomationList::AutomationList (Evoral::Parameter id)
 }
 
 AutomationList::AutomationList (const AutomationList& other)
-       : StatefulDestructible()
-       , ControlList(other)
+       : ControlList(other)
+       , StatefulDestructible()
+       , _before (0)
 {
-       _style = other._style;
        _state = other._state;
-       _touching = other._touching;
+       g_atomic_int_set (&_touching, other.touching());
 
        create_curve_if_necessary();
 
@@ -79,10 +98,10 @@ AutomationList::AutomationList (const AutomationList& other)
 
 AutomationList::AutomationList (const AutomationList& other, double start, double end)
        : ControlList(other, start, end)
+       , _before (0)
 {
-       _style = other._style;
        _state = other._state;
-       _touching = other._touching;
+       g_atomic_int_set (&_touching, other.touching());
 
        create_curve_if_necessary();
 
@@ -90,17 +109,18 @@ AutomationList::AutomationList (const AutomationList& other, double start, doubl
        AutomationListCreated(this);
 }
 
-/** \a id is used for legacy sessions where the type is not present
- * in or below the <AutomationList> node.  It is used if \a id is non-null.
+/** @param id is used for legacy sessions where the type is not present
+ * in or below the AutomationList node.  It is used if @param id is non-null.
  */
 AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
-       : ControlList(id)
+       : ControlList(id, ARDOUR::ParameterDescriptor(id))
+       , _before (0)
 {
-       _touching = false;
+       g_atomic_int_set (&_touching, 0);
+       _interpolation = default_interpolation ();
        _state = Off;
-       _style = Absolute;
 
-       set_state (node);
+       set_state (node, Stateful::loading_state_version);
 
        if (id) {
                _parameter = id;
@@ -114,13 +134,14 @@ AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
 
 AutomationList::~AutomationList()
 {
-       GoingAway ();
+       delete _before;
 }
 
 boost::shared_ptr<Evoral::ControlList>
-AutomationList::create(Evoral::Parameter id)
+AutomationList::create(const Evoral::Parameter&           id,
+                       const Evoral::ParameterDescriptor& desc)
 {
-       return boost::shared_ptr<Evoral::ControlList>(new AutomationList(id));
+       return boost::shared_ptr<Evoral::ControlList>(new AutomationList(id, desc));
 }
 
 void
@@ -128,7 +149,10 @@ AutomationList::create_curve_if_necessary()
 {
        switch (_parameter.type()) {
        case GainAutomation:
-       case PanAutomation:
+       case TrimAutomation:
+       case PanAzimuthAutomation:
+       case PanElevationAutomation:
+       case PanWidthAutomation:
        case FadeInAutomation:
        case FadeOutAutomation:
        case EnvelopeAutomation:
@@ -139,30 +163,18 @@ AutomationList::create_curve_if_necessary()
        }
 }
 
-bool
-AutomationList::operator== (const AutomationList& other)
-{
-       return _events == other._events;
-}
-
 AutomationList&
 AutomationList::operator= (const AutomationList& other)
 {
        if (this != &other) {
-
-               _events.clear ();
-
-               for (const_iterator i = other._events.begin(); i != other._events.end(); ++i) {
-                       _events.push_back (new Evoral::ControlEvent (**i));
-               }
-
-               _min_yval = other._min_yval;
-               _max_yval = other._max_yval;
-               _max_xval = other._max_xval;
-               _default_value = other._default_value;
-
-               mark_dirty ();
-               maybe_signal_changed ();
+               ControlList::freeze ();
+               /* ControlList::operator= calls copy_events() which calls
+                * mark_dirty() and maybe_signal_changed()
+                */
+               ControlList::operator= (other);
+               _state = other._state;
+               _touching = other._touching;
+               ControlList::thaw ();
        }
 
        return *this;
@@ -173,7 +185,7 @@ AutomationList::maybe_signal_changed ()
 {
        ControlList::maybe_signal_changed ();
 
-       if (!_frozen) {
+       if (!ControlList::frozen()) {
                StateChanged (); /* EMIT SIGNAL */
        }
 }
@@ -183,37 +195,100 @@ AutomationList::set_automation_state (AutoState s)
 {
        if (s != _state) {
                _state = s;
-               automation_state_changed (); /* EMIT SIGNAL */
+               delete _before;
+               if (s == Write && _desc.toggled) {
+                       _before = &get_state ();
+               } else {
+                       _before = 0;
+               }
+               automation_state_changed (s); /* EMIT SIGNAL */
+       }
+}
+
+Evoral::ControlList::InterpolationStyle
+AutomationList::default_interpolation () const
+{
+       switch (_parameter.type()) {
+               case GainAutomation:
+               case BusSendLevel:
+               case EnvelopeAutomation:
+#ifndef XXX_NEW_INTERPOLATON__BREAK_SESSION_FORMAT_XXX
+                       /* use old, wrong linear gain interpolation */
+                       return ControlList::Linear;
+#endif
+                       return ControlList::Exponential;
+                       break;
+               case TrimAutomation:
+                       return ControlList::Logarithmic;
+                       break;
+               default:
+                       break;
        }
+       /* based on Evoral::ParameterDescriptor log,toggle,.. */
+       return ControlList::default_interpolation ();
 }
 
 void
-AutomationList::set_automation_style (AutoStyle s)
+AutomationList::start_write_pass (double when)
 {
-       if (s != _style) {
-               _style = s;
-               automation_style_changed (); /* EMIT SIGNAL */
+       delete _before;
+       if (in_new_write_pass ()) {
+               _before = &get_state ();
+       } else {
+               _before = 0;
        }
+       ControlList::start_write_pass (when);
 }
 
 void
-AutomationList::start_touch ()
+AutomationList::write_pass_finished (double when, double thinning_factor)
 {
-       _touching = true;
-       _new_value = true;
+       ControlList::write_pass_finished (when, thinning_factor);
 }
 
 void
-AutomationList::stop_touch ()
+AutomationList::start_touch (double when)
 {
-       _touching = false;
-       _new_value = false;
+        if (_state == Touch) {
+               start_write_pass (when);
+        }
+
+       g_atomic_int_set (&_touching, 1);
 }
 
 void
-AutomationList::freeze ()
+AutomationList::stop_touch (bool mark, double)
 {
-       _frozen++;
+       if (g_atomic_int_get (&_touching) == 0) {
+               /* this touch has already been stopped (probably by Automatable::transport_stopped),
+                  so we've nothing to do.
+               */
+               return;
+       }
+
+       g_atomic_int_set (&_touching, 0);
+
+        if (_state == Touch) {
+
+                if (mark) {
+
+                       /* XXX need to mark the last added point with the
+                        * current time
+                        */
+                }
+        }
+}
+
+/* _before may be owned by the undo stack,
+ * so we have to be careful about doing this.
+ *
+ * ::before () transfers ownership, setting _before to 0
+ */
+void
+AutomationList::clear_history ()
+{
+       delete _before;
+       _before = 0;
 }
 
 void
@@ -222,15 +297,40 @@ AutomationList::thaw ()
        ControlList::thaw();
 
        if (_changed_when_thawed) {
+               _changed_when_thawed = false;
                StateChanged(); /* EMIT SIGNAL */
        }
 }
 
-void
-AutomationList::mark_dirty () const
+bool
+AutomationList::paste (const ControlList& alist, double pos, DoubleBeatsFramesConverter const& bfc)
 {
-       ControlList::mark_dirty ();
-       Dirty (); /* EMIT SIGNAL */
+       AutomationType src_type = (AutomationType)alist.parameter().type();
+       AutomationType dst_type = (AutomationType)_parameter.type();
+
+       if (parameter_is_midi (src_type) == parameter_is_midi (dst_type)) {
+               return ControlList::paste (alist, pos);
+       }
+       bool to_frame = parameter_is_midi (src_type);
+
+       ControlList cl (alist);
+       cl.clear ();
+       for (const_iterator i = alist.begin ();i != alist.end (); ++i) {
+               double when = (*i)->when;
+               if (to_frame) {
+                       when = bfc.to ((*i)->when);
+               } else {
+                       when = bfc.from ((*i)->when);
+               }
+               cl.fast_simple_add (when, (*i)->value);
+       }
+       return ControlList::paste (cl, pos);
+}
+
+Command*
+AutomationList::memento_command (XMLNode* before, XMLNode* after)
+{
+       return new MementoCommand<AutomationList> (*this, before, after);
 }
 
 XMLNode&
@@ -243,33 +343,44 @@ XMLNode&
 AutomationList::state (bool full)
 {
        XMLNode* root = new XMLNode (X_("AutomationList"));
-       char buf[64];
-       LocaleGuard lg (X_("POSIX"));
-
-       root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
-
-       root->add_property ("id", _id.to_s());
 
-       snprintf (buf, sizeof (buf), "%.12g", _default_value);
-       root->add_property ("default", buf);
-       snprintf (buf, sizeof (buf), "%.12g", _min_yval);
-       root->add_property ("min-yval", buf);
-       snprintf (buf, sizeof (buf), "%.12g", _max_yval);
-       root->add_property ("max-yval", buf);
-       snprintf (buf, sizeof (buf), "%.12g", _max_xval);
-       root->add_property ("max-xval", buf);
+       root->set_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
+       root->set_property ("id", id());
 
-       root->add_property ("interpolation-style", enum_2_string (_interpolation));
+#ifndef XXX_NEW_INTERPOLATON__BREAK_SESSION_FORMAT_XXX
+       /* force new enums to existing ones in session-file */
+       Evoral::ControlList::InterpolationStyle is = _interpolation;
+       switch (is) {
+               case ControlList::Exponential:
+               case ControlList::Logarithmic:
+                       is = ControlList::Linear;
+                       break;
+               default:
+                       break;
+       }
+       root->set_property ("interpolation-style", is);
+#else
+       root->set_property ("interpolation-style", _interpolation);
+#endif
 
        if (full) {
-               root->add_property ("state", auto_state_to_string (_state));
+               /* never serialize state with Write enabled - too dangerous
+                  for the user's data
+               */
+               if (_state != Write) {
+                       root->set_property ("state", _state);
+               } else {
+                       if (_events.empty ()) {
+                               root->set_property ("state", Off);
+                       } else {
+                               root->set_property ("state", Touch);
+                       }
+               }
        } else {
                /* never save anything but Off for automation state to a template */
-               root->add_property ("state", auto_state_to_string (Off));
+               root->set_property ("state", Off);
        }
 
-       root->add_property ("style", auto_style_to_string (_style));
-
        if (!_events.empty()) {
                root->add_child_nocopy (serialize_events());
        }
@@ -283,12 +394,10 @@ AutomationList::serialize_events ()
        XMLNode* node = new XMLNode (X_("events"));
        stringstream str;
 
-       str.precision(15);  //10 digits is enough digits for 24 hours at 96kHz
-
        for (iterator xx = _events.begin(); xx != _events.end(); ++xx) {
-               str << (double) (*xx)->when;
+               str << PBD::to_string ((*xx)->when);
                str << ' ';
-               str <<(double) (*xx)->value;
+               str << PBD::to_string ((*xx)->value);
                str << '\n';
        }
 
@@ -315,25 +424,28 @@ AutomationList::deserialize_events (const XMLNode& node)
                return -1;
        }
 
-       freeze ();
+        ControlList::freeze ();
        clear ();
 
        stringstream str (content_node->content());
 
+       std::string x_str;
+       std::string y_str;
        double x;
        double y;
        bool ok = true;
 
        while (str) {
-               str >> x;
-               if (!str) {
+               str >> x_str;
+               if (!str || !PBD::string_to<double> (x_str, x)) {
                        break;
                }
-               str >> y;
-               if (!str) {
+               str >> y_str;
+               if (!str || !PBD::string_to<double> (y_str, y)) {
                        ok = false;
                        break;
                }
+               y = std::min ((double)_desc.upper, std::max ((double)_desc.lower, y));
                fast_simple_add (x, y);
        }
 
@@ -342,22 +454,20 @@ AutomationList::deserialize_events (const XMLNode& node)
                error << _("automation list: cannot load coordinates from XML, all points ignored") << endmsg;
        } else {
                mark_dirty ();
-               reposition_for_rt_add (0);
                maybe_signal_changed ();
        }
 
-       thaw ();
+        thaw ();
 
        return 0;
 }
 
 int
-AutomationList::set_state (const XMLNode& node)
+AutomationList::set_state (const XMLNode& node, int version)
 {
        XMLNodeList nlist = node.children();
        XMLNode* nsos;
        XMLNodeIterator niter;
-       const XMLProperty* prop;
 
        if (node.name() == X_("events")) {
                /* partial state setting*/
@@ -368,34 +478,32 @@ AutomationList::set_state (const XMLNode& node)
 
                if ((nsos = node.child (X_("AutomationList")))) {
                        /* new school in old school clothing */
-                       return set_state (*nsos);
+                       return set_state (*nsos, version);
                }
 
                /* old school */
 
                const XMLNodeList& elist = node.children();
                XMLNodeConstIterator i;
-               XMLProperty* prop;
-               nframes_t x;
-               double y;
 
-               freeze ();
+               ControlList::freeze ();
                clear ();
 
                for (i = elist.begin(); i != elist.end(); ++i) {
 
-                       if ((prop = (*i)->property ("x")) == 0) {
+                       pframes_t x;
+                       if (!(*i)->get_property ("x", x)) {
                                error << _("automation list: no x-coordinate stored for control point (point ignored)") << endmsg;
                                continue;
                        }
-                       x = atoi (prop->value().c_str());
 
-                       if ((prop = (*i)->property ("y")) == 0) {
+                       double y;
+                       if (!(*i)->get_property ("y", y)) {
                                error << _("automation list: no y-coordinate stored for control point (point ignored)") << endmsg;
                                continue;
                        }
-                       y = atof (prop->value().c_str());
 
+                       y = std::min ((double)_desc.upper, std::max ((double)_desc.lower, y));
                        fast_simple_add (x, y);
                }
 
@@ -409,66 +517,75 @@ AutomationList::set_state (const XMLNode& node)
                return -1;
        }
 
-       if ((prop = node.property ("id")) != 0) {
-               _id = prop->value ();
+       if (set_id (node)) {
                /* update session AL list */
                AutomationListCreated(this);
        }
 
-       if ((prop = node.property (X_("automation-id"))) != 0){
-               _parameter = EventTypeMap::instance().new_parameter(prop->value());
+       std::string value;
+       if (node.get_property (X_("automation-id"), value)) {
+               _parameter = EventTypeMap::instance().from_symbol(value);
        } else {
-               warning << "Legacy session: automation list has no automation-id property.";
+               warning << "Legacy session: automation list has no automation-id property." << endmsg;
        }
 
-       if ((prop = node.property (X_("interpolation-style"))) != 0) {
-               _interpolation = (InterpolationStyle)string_2_enum(prop->value(), _interpolation);
-       } else {
-               _interpolation = Linear;
+       if (!node.get_property (X_("interpolation-style"), _interpolation)) {
+               _interpolation = default_interpolation ();
        }
-
-       if ((prop = node.property (X_("default"))) != 0){
-               _default_value = atof (prop->value().c_str());
-       } else {
-               _default_value = 0.0;
-       }
-
-       if ((prop = node.property (X_("style"))) != 0) {
-               _style = string_to_auto_style (prop->value());
-       } else {
-               _style = Absolute;
+#ifndef XXX_NEW_INTERPOLATON__BREAK_SESSION_FORMAT_XXX
+       /* internally force logarithmic and Trim params to use Log-scale */
+       if (_desc.logarithmic || _parameter.type() == TrimAutomation) {
+               _interpolation = ControlList::Logarithmic;
        }
+#endif
 
-       if ((prop = node.property (X_("state"))) != 0) {
-               _state = string_to_auto_state (prop->value());
+       if (node.get_property (X_("state"), _state)) {
+               if (_state == Write) {
+                       _state = Off;
+               }
+               automation_state_changed (_state);
        } else {
                _state = Off;
        }
 
-       if ((prop = node.property (X_("min_yval"))) != 0) {
-               _min_yval = atof (prop->value ().c_str());
-       } else {
-               _min_yval = FLT_MIN;
-       }
-
-       if ((prop = node.property (X_("max_yval"))) != 0) {
-               _max_yval = atof (prop->value ().c_str());
-       } else {
-               _max_yval = FLT_MAX;
-       }
-
-       if ((prop = node.property (X_("max_xval"))) != 0) {
-               _max_xval = atof (prop->value ().c_str());
-       } else {
-               _max_xval = 0; // means "no limit ;
-       }
+       bool have_events = false;
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
                if ((*niter)->name() == X_("events")) {
                        deserialize_events (*(*niter));
+                       have_events = true;
                }
        }
 
+       if (!have_events) {
+               /* there was no Events child node; clear any current events */
+               freeze ();
+               clear ();
+               mark_dirty ();
+               maybe_signal_changed ();
+               thaw ();
+       }
+
        return 0;
 }
 
+bool
+AutomationList::operator!= (AutomationList const & other) const
+{
+       return (
+               static_cast<ControlList const &> (*this) != static_cast<ControlList const &> (other) ||
+               _state != other._state ||
+               _touching != other._touching
+               );
+}
+
+PBD::PropertyBase *
+AutomationListProperty::clone () const
+{
+       return new AutomationListProperty (
+               this->property_id(),
+               boost::shared_ptr<AutomationList> (new AutomationList (*this->_old.get())),
+               boost::shared_ptr<AutomationList> (new AutomationList (*this->_current.get()))
+               );
+}
+