2 Copyright (C) 2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "ardour/automation_list.h"
27 #include "ardour/event_type_map.h"
28 #include "evoral/Curve.hpp"
29 #include "pbd/stacktrace.h"
30 #include "pbd/enumwriter.h"
35 using namespace ARDOUR;
38 PBD::Signal1<void,AutomationList *> AutomationList::AutomationListCreated;
41 static void dumpit (const AutomationList& al, string prefix = "")
43 cerr << prefix << &al << endl;
44 for (AutomationList::const_iterator i = al.begin(); i != al.end(); ++i) {
45 cerr << prefix << '\t' << (*i)->when << ',' << (*i)->value << endl;
50 AutomationList::AutomationList (Evoral::Parameter id)
55 g_atomic_int_set (&_touching, 0);
57 create_curve_if_necessary();
59 assert(_parameter.type() != NullAutomation);
60 AutomationListCreated(this);
63 AutomationList::AutomationList (const AutomationList& other)
64 : StatefulDestructible()
67 _style = other._style;
68 _state = other._state;
69 g_atomic_int_set (&_touching, other.touching());
71 create_curve_if_necessary();
73 assert(_parameter.type() != NullAutomation);
74 AutomationListCreated(this);
77 AutomationList::AutomationList (const AutomationList& other, double start, double end)
78 : ControlList(other, start, end)
80 _style = other._style;
81 _state = other._state;
82 g_atomic_int_set (&_touching, other.touching());
84 create_curve_if_necessary();
86 assert(_parameter.type() != NullAutomation);
87 AutomationListCreated(this);
90 /** @param id is used for legacy sessions where the type is not present
91 * in or below the AutomationList node. It is used if @param id is non-null.
93 AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
96 g_atomic_int_set (&_touching, 0);
100 set_state (node, Stateful::loading_state_version);
106 create_curve_if_necessary();
108 assert(_parameter.type() != NullAutomation);
109 AutomationListCreated(this);
112 AutomationList::~AutomationList()
116 boost::shared_ptr<Evoral::ControlList>
117 AutomationList::create(Evoral::Parameter id)
119 return boost::shared_ptr<Evoral::ControlList>(new AutomationList(id));
123 AutomationList::create_curve_if_necessary()
125 switch (_parameter.type()) {
127 case PanAzimuthAutomation:
128 case PanElevationAutomation:
129 case PanWidthAutomation:
130 case FadeInAutomation:
131 case FadeOutAutomation:
132 case EnvelopeAutomation:
141 AutomationList::operator== (const AutomationList& other)
143 return _events == other._events;
147 AutomationList::operator= (const AutomationList& other)
149 if (this != &other) {
153 for (const_iterator i = other._events.begin(); i != other._events.end(); ++i) {
154 _events.push_back (new Evoral::ControlEvent (**i));
157 _min_yval = other._min_yval;
158 _max_yval = other._max_yval;
159 _default_value = other._default_value;
162 maybe_signal_changed ();
169 AutomationList::maybe_signal_changed ()
171 ControlList::maybe_signal_changed ();
173 if (!ControlList::frozen()) {
174 StateChanged (); /* EMIT SIGNAL */
179 AutomationList::set_automation_state (AutoState s)
183 automation_state_changed (s); /* EMIT SIGNAL */
188 AutomationList::set_automation_style (AutoStyle s)
192 automation_style_changed (); /* EMIT SIGNAL */
197 AutomationList::start_touch (double when)
199 if (_state == Touch) {
200 start_write_pass (when);
203 g_atomic_int_set (&_touching, 1);
207 AutomationList::stop_touch (bool mark, double)
209 if (g_atomic_int_get (&_touching) == 0) {
210 /* this touch has already been stopped (probably by Automatable::transport_stopped),
211 so we've nothing to do.
216 g_atomic_int_set (&_touching, 0);
218 if (_state == Touch) {
222 /* XXX need to mark the last added point with the
230 AutomationList::thaw ()
234 if (_changed_when_thawed) {
235 _changed_when_thawed = false;
236 StateChanged(); /* EMIT SIGNAL */
241 AutomationList::get_state ()
247 AutomationList::state (bool full)
249 XMLNode* root = new XMLNode (X_("AutomationList"));
251 LocaleGuard lg (X_("POSIX"));
253 root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
255 root->add_property ("id", id().to_s());
257 snprintf (buf, sizeof (buf), "%.12g", _default_value);
258 root->add_property ("default", buf);
259 snprintf (buf, sizeof (buf), "%.12g", _min_yval);
260 root->add_property ("min-yval", buf);
261 snprintf (buf, sizeof (buf), "%.12g", _max_yval);
262 root->add_property ("max-yval", buf);
264 root->add_property ("interpolation-style", enum_2_string (_interpolation));
267 /* never serialize state with Write enabled - too dangerous
270 if (_state != Write) {
271 root->add_property ("state", auto_state_to_string (_state));
273 root->add_property ("state", auto_state_to_string (Off));
276 /* never save anything but Off for automation state to a template */
277 root->add_property ("state", auto_state_to_string (Off));
280 root->add_property ("style", auto_style_to_string (_style));
282 if (!_events.empty()) {
283 root->add_child_nocopy (serialize_events());
290 AutomationList::serialize_events ()
292 XMLNode* node = new XMLNode (X_("events"));
295 str.precision(15); //10 digits is enough digits for 24 hours at 96kHz
297 for (iterator xx = _events.begin(); xx != _events.end(); ++xx) {
298 str << (double) (*xx)->when;
300 str <<(double) (*xx)->value;
304 /* XML is a bit wierd */
306 XMLNode* content_node = new XMLNode (X_("foo")); /* it gets renamed by libxml when we set content */
307 content_node->set_content (str.str());
309 node->add_child_nocopy (*content_node);
315 AutomationList::deserialize_events (const XMLNode& node)
317 if (node.children().empty()) {
321 XMLNode* content_node = node.children().front();
323 if (content_node->content().empty()) {
327 ControlList::freeze ();
330 stringstream str (content_node->content());
346 fast_simple_add (x, y);
353 error << _("automation list: cannot load coordinates from XML, all points ignored") << endmsg;
356 maybe_signal_changed ();
365 AutomationList::set_state (const XMLNode& node, int version)
367 LocaleGuard lg (X_("POSIX"));
368 XMLNodeList nlist = node.children();
370 XMLNodeIterator niter;
371 const XMLProperty* prop;
373 if (node.name() == X_("events")) {
374 /* partial state setting*/
375 return deserialize_events (node);
378 if (node.name() == X_("Envelope") || node.name() == X_("FadeOut") || node.name() == X_("FadeIn")) {
380 if ((nsos = node.child (X_("AutomationList")))) {
381 /* new school in old school clothing */
382 return set_state (*nsos, version);
387 const XMLNodeList& elist = node.children();
388 XMLNodeConstIterator i;
393 ControlList::freeze ();
396 for (i = elist.begin(); i != elist.end(); ++i) {
398 if ((prop = (*i)->property ("x")) == 0) {
399 error << _("automation list: no x-coordinate stored for control point (point ignored)") << endmsg;
402 x = atoi (prop->value().c_str());
404 if ((prop = (*i)->property ("y")) == 0) {
405 error << _("automation list: no y-coordinate stored for control point (point ignored)") << endmsg;
408 y = atof (prop->value().c_str());
410 fast_simple_add (x, y);
420 if (node.name() != X_("AutomationList") ) {
421 error << string_compose (_("AutomationList: passed XML node called %1, not \"AutomationList\" - ignored"), node.name()) << endmsg;
426 /* update session AL list */
427 AutomationListCreated(this);
430 if ((prop = node.property (X_("automation-id"))) != 0){
431 _parameter = EventTypeMap::instance().new_parameter(prop->value());
433 warning << "Legacy session: automation list has no automation-id property." << endmsg;
436 if ((prop = node.property (X_("interpolation-style"))) != 0) {
437 _interpolation = (InterpolationStyle)string_2_enum(prop->value(), _interpolation);
439 _interpolation = Linear;
442 if ((prop = node.property (X_("default"))) != 0){
443 _default_value = atof (prop->value().c_str());
445 _default_value = 0.0;
448 if ((prop = node.property (X_("style"))) != 0) {
449 _style = string_to_auto_style (prop->value());
454 if ((prop = node.property (X_("state"))) != 0) {
455 _state = string_to_auto_state (prop->value());
456 if (_state == Write) {
459 automation_state_changed(_state);
464 if ((prop = node.property (X_("min-yval"))) != 0) {
465 _min_yval = atof (prop->value ().c_str());
470 if ((prop = node.property (X_("max-yval"))) != 0) {
471 _max_yval = atof (prop->value ().c_str());
476 bool have_events = false;
478 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
479 if ((*niter)->name() == X_("events")) {
480 deserialize_events (*(*niter));
486 /* there was no Events child node; clear any current events */
490 maybe_signal_changed ();
498 AutomationList::operator!= (AutomationList const & other) const
501 static_cast<ControlList const &> (*this) != static_cast<ControlList const &> (other) ||
502 _state != other._state ||
503 _style != other._style ||
504 _touching != other._touching
509 AutomationListProperty::clone () const
511 return new AutomationListProperty (
513 boost::shared_ptr<AutomationList> (new AutomationList (*this->_old.get())),
514 boost::shared_ptr<AutomationList> (new AutomationList (*this->_current.get()))