fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / automation_list.cc
index 92a3d167da76e9ba9d3cd124020f560021a461e4..4b23378cacd1275e0d170fb660682ac177bca556 100644 (file)
 #include <algorithm>
 #include "ardour/automation_list.h"
 #include "ardour/event_type_map.h"
+#include "ardour/parameter_descriptor.h"
 #include "evoral/Curve.hpp"
+#include "pbd/memento_command.h"
 #include "pbd/stacktrace.h"
 #include "pbd/enumwriter.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -41,19 +43,33 @@ PBD::Signal1<void,AutomationList *> AutomationList::AutomationListCreated;
 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;
+       _style = Absolute;
+       g_atomic_int_set (&_touching, 0);
+
+       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);
 
        create_curve_if_necessary();
 
@@ -64,10 +80,11 @@ AutomationList::AutomationList (Evoral::Parameter id)
 AutomationList::AutomationList (const AutomationList& other)
        : StatefulDestructible()
        , ControlList(other)
+       , _before (0)
 {
        _style = other._style;
        _state = other._state;
-       _touching = other._touching;
+       g_atomic_int_set (&_touching, other.touching());
 
        create_curve_if_necessary();
 
@@ -77,10 +94,11 @@ 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();
 
@@ -88,13 +106,14 @@ 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);
        _state = Off;
        _style = Absolute;
 
@@ -112,12 +131,14 @@ AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
 
 AutomationList::~AutomationList()
 {
+       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
@@ -125,7 +146,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:
@@ -136,27 +160,16 @@ 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;
+               ControlList::operator= (other);
+               _state = other._state;
+               _style = other._style;
+               _touching = other._touching;
 
                mark_dirty ();
                maybe_signal_changed ();
@@ -180,7 +193,13 @@ 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 */
        }
 }
 
@@ -194,17 +213,66 @@ AutomationList::set_automation_style (AutoStyle s)
 }
 
 void
-AutomationList::start_touch ()
+AutomationList::start_write_pass (double when)
+{
+       delete _before;
+       if (in_new_write_pass ()) {
+               _before = &get_state ();
+       } else {
+               _before = 0;
+       }
+       ControlList::start_write_pass (when);
+}
+
+void
+AutomationList::write_pass_finished (double when, double thinning_factor)
+{
+       ControlList::write_pass_finished (when, thinning_factor);
+}
+
+void
+AutomationList::start_touch (double when)
+{
+        if (_state == Touch) {
+               start_write_pass (when);
+        }
+
+       g_atomic_int_set (&_touching, 1);
+}
+
+void
+AutomationList::stop_touch (bool mark, double)
 {
-       _touching = true;
-       _new_value = true;
+       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::stop_touch ()
+AutomationList::clear_history ()
 {
-       _touching = false;
-       _new_value = false;
+       delete _before;
+       _before = 0;
 }
 
 void
@@ -218,11 +286,10 @@ AutomationList::thaw ()
        }
 }
 
-void
-AutomationList::mark_dirty () const
+Command*
+AutomationList::memento_command (XMLNode* before, XMLNode* after)
 {
-       ControlList::mark_dirty ();
-       Dirty (); /* EMIT SIGNAL */
+       return new MementoCommand<AutomationList> (*this, before, after);
 }
 
 XMLNode&
@@ -236,11 +303,11 @@ AutomationList::state (bool full)
 {
        XMLNode* root = new XMLNode (X_("AutomationList"));
        char buf[64];
-       LocaleGuard lg (X_("POSIX"));
+       LocaleGuard lg;
 
        root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
 
-       root->add_property ("id", _id.to_s());
+       root->add_property ("id", id().to_s());
 
        snprintf (buf, sizeof (buf), "%.12g", _default_value);
        root->add_property ("default", buf);
@@ -248,13 +315,22 @@ AutomationList::state (bool full)
        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->add_property ("interpolation-style", enum_2_string (_interpolation));
 
        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->add_property ("state", auto_state_to_string (_state));
+                } else {
+                       if (_events.empty ()) {
+                               root->add_property ("state", auto_state_to_string (Off));
+                       } else {
+                               root->add_property ("state", auto_state_to_string (Touch));
+                       }
+                }
        } else {
                /* never save anything but Off for automation state to a template */
                root->add_property ("state", auto_state_to_string (Off));
@@ -334,22 +410,22 @@ 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 ();
        }
 
-        ControlList::thaw ();
-        
+        thaw ();
+
        return 0;
 }
 
 int
 AutomationList::set_state (const XMLNode& node, int version)
 {
+       LocaleGuard lg;
        XMLNodeList nlist = node.children();
        XMLNode* nsos;
        XMLNodeIterator niter;
-       const XMLProperty* prop;
+       XMLProperty const * prop;
 
        if (node.name() == X_("events")) {
                /* partial state setting*/
@@ -367,8 +443,8 @@ AutomationList::set_state (const XMLNode& node, int version)
 
                const XMLNodeList& elist = node.children();
                XMLNodeConstIterator i;
-               XMLProperty* prop;
-               nframes_t x;
+               XMLProperty const * prop;
+               pframes_t x;
                double y;
 
                 ControlList::freeze ();
@@ -391,7 +467,7 @@ AutomationList::set_state (const XMLNode& node, int version)
                        fast_simple_add (x, y);
                }
 
-                ControlList::thaw ();
+               thaw ();
 
                return 0;
        }
@@ -401,16 +477,15 @@ AutomationList::set_state (const XMLNode& node, int version)
                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());
+               _parameter = EventTypeMap::instance().from_symbol(prop->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) {
@@ -433,34 +508,65 @@ AutomationList::set_state (const XMLNode& node, int version)
 
        if ((prop = node.property (X_("state"))) != 0) {
                _state = string_to_auto_state (prop->value());
+                if (_state == Write) {
+                        _state = Off;
+                }
+               automation_state_changed(_state);
        } else {
                _state = Off;
        }
 
-       if ((prop = node.property (X_("min_yval"))) != 0) {
+       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) {
+       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 ||
+               _style != other._style ||
+               _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()))
+               );
+}
+