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 "ardour/parameter_descriptor.h"
29 #include "evoral/Curve.hpp"
30 #include "pbd/stacktrace.h"
31 #include "pbd/enumwriter.h"
36 using namespace ARDOUR;
39 PBD::Signal1<void,AutomationList *> AutomationList::AutomationListCreated;
42 static void dumpit (const AutomationList& al, string prefix = "")
44 cerr << prefix << &al << endl;
45 for (AutomationList::const_iterator i = al.begin(); i != al.end(); ++i) {
46 cerr << prefix << '\t' << (*i)->when << ',' << (*i)->value << endl;
51 AutomationList::AutomationList (const Evoral::Parameter& id, const Evoral::ParameterDescriptor& desc)
52 : ControlList(id, desc)
56 g_atomic_int_set (&_touching, 0);
58 create_curve_if_necessary();
60 assert(_parameter.type() != NullAutomation);
61 AutomationListCreated(this);
64 AutomationList::AutomationList (const Evoral::Parameter& id)
65 : ControlList(id, ARDOUR::ParameterDescriptor(id))
69 g_atomic_int_set (&_touching, 0);
71 create_curve_if_necessary();
73 assert(_parameter.type() != NullAutomation);
74 AutomationListCreated(this);
77 AutomationList::AutomationList (const AutomationList& other)
78 : StatefulDestructible()
81 _style = other._style;
82 _state = other._state;
83 g_atomic_int_set (&_touching, other.touching());
85 create_curve_if_necessary();
87 assert(_parameter.type() != NullAutomation);
88 AutomationListCreated(this);
91 AutomationList::AutomationList (const AutomationList& other, double start, double end)
92 : ControlList(other, start, end)
94 _style = other._style;
95 _state = other._state;
96 g_atomic_int_set (&_touching, other.touching());
98 create_curve_if_necessary();
100 assert(_parameter.type() != NullAutomation);
101 AutomationListCreated(this);
104 /** @param id is used for legacy sessions where the type is not present
105 * in or below the AutomationList node. It is used if @param id is non-null.
107 AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
108 : ControlList(id, ARDOUR::ParameterDescriptor(id))
110 g_atomic_int_set (&_touching, 0);
114 set_state (node, Stateful::loading_state_version);
120 create_curve_if_necessary();
122 assert(_parameter.type() != NullAutomation);
123 AutomationListCreated(this);
126 AutomationList::~AutomationList()
130 boost::shared_ptr<Evoral::ControlList>
131 AutomationList::create(const Evoral::Parameter& id,
132 const Evoral::ParameterDescriptor& desc)
134 return boost::shared_ptr<Evoral::ControlList>(new AutomationList(id, desc));
138 AutomationList::create_curve_if_necessary()
140 switch (_parameter.type()) {
142 case PanAzimuthAutomation:
143 case PanElevationAutomation:
144 case PanWidthAutomation:
145 case FadeInAutomation:
146 case FadeOutAutomation:
147 case EnvelopeAutomation:
156 AutomationList::operator= (const AutomationList& other)
158 if (this != &other) {
161 ControlList::operator= (other);
162 _state = other._state;
163 _style = other._style;
164 _touching = other._touching;
167 maybe_signal_changed ();
174 AutomationList::maybe_signal_changed ()
176 ControlList::maybe_signal_changed ();
178 if (!ControlList::frozen()) {
179 StateChanged (); /* EMIT SIGNAL */
184 AutomationList::set_automation_state (AutoState s)
188 automation_state_changed (s); /* EMIT SIGNAL */
193 AutomationList::set_automation_style (AutoStyle s)
197 automation_style_changed (); /* EMIT SIGNAL */
202 AutomationList::start_touch (double when)
204 if (_state == Touch) {
205 start_write_pass (when);
208 g_atomic_int_set (&_touching, 1);
212 AutomationList::stop_touch (bool mark, double)
214 if (g_atomic_int_get (&_touching) == 0) {
215 /* this touch has already been stopped (probably by Automatable::transport_stopped),
216 so we've nothing to do.
221 g_atomic_int_set (&_touching, 0);
223 if (_state == Touch) {
227 /* XXX need to mark the last added point with the
235 AutomationList::thaw ()
239 if (_changed_when_thawed) {
240 _changed_when_thawed = false;
241 StateChanged(); /* EMIT SIGNAL */
246 AutomationList::get_state ()
252 AutomationList::state (bool full)
254 XMLNode* root = new XMLNode (X_("AutomationList"));
256 LocaleGuard lg (X_("POSIX"));
258 root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
260 root->add_property ("id", id().to_s());
262 snprintf (buf, sizeof (buf), "%.12g", _default_value);
263 root->add_property ("default", buf);
264 snprintf (buf, sizeof (buf), "%.12g", _min_yval);
265 root->add_property ("min-yval", buf);
266 snprintf (buf, sizeof (buf), "%.12g", _max_yval);
267 root->add_property ("max-yval", buf);
269 root->add_property ("interpolation-style", enum_2_string (_interpolation));
272 /* never serialize state with Write enabled - too dangerous
275 if (_state != Write) {
276 root->add_property ("state", auto_state_to_string (_state));
278 root->add_property ("state", auto_state_to_string (Off));
281 /* never save anything but Off for automation state to a template */
282 root->add_property ("state", auto_state_to_string (Off));
285 root->add_property ("style", auto_style_to_string (_style));
287 if (!_events.empty()) {
288 root->add_child_nocopy (serialize_events());
295 AutomationList::serialize_events ()
297 XMLNode* node = new XMLNode (X_("events"));
300 str.precision(15); //10 digits is enough digits for 24 hours at 96kHz
302 for (iterator xx = _events.begin(); xx != _events.end(); ++xx) {
303 str << (double) (*xx)->when;
305 str <<(double) (*xx)->value;
309 /* XML is a bit wierd */
311 XMLNode* content_node = new XMLNode (X_("foo")); /* it gets renamed by libxml when we set content */
312 content_node->set_content (str.str());
314 node->add_child_nocopy (*content_node);
320 AutomationList::deserialize_events (const XMLNode& node)
322 if (node.children().empty()) {
326 XMLNode* content_node = node.children().front();
328 if (content_node->content().empty()) {
332 ControlList::freeze ();
335 stringstream str (content_node->content());
351 fast_simple_add (x, y);
356 error << _("automation list: cannot load coordinates from XML, all points ignored") << endmsg;
359 maybe_signal_changed ();
368 AutomationList::set_state (const XMLNode& node, int version)
370 LocaleGuard lg (X_("POSIX"));
371 XMLNodeList nlist = node.children();
373 XMLNodeIterator niter;
374 const XMLProperty* prop;
376 if (node.name() == X_("events")) {
377 /* partial state setting*/
378 return deserialize_events (node);
381 if (node.name() == X_("Envelope") || node.name() == X_("FadeOut") || node.name() == X_("FadeIn")) {
383 if ((nsos = node.child (X_("AutomationList")))) {
384 /* new school in old school clothing */
385 return set_state (*nsos, version);
390 const XMLNodeList& elist = node.children();
391 XMLNodeConstIterator i;
396 ControlList::freeze ();
399 for (i = elist.begin(); i != elist.end(); ++i) {
401 if ((prop = (*i)->property ("x")) == 0) {
402 error << _("automation list: no x-coordinate stored for control point (point ignored)") << endmsg;
405 x = atoi (prop->value().c_str());
407 if ((prop = (*i)->property ("y")) == 0) {
408 error << _("automation list: no y-coordinate stored for control point (point ignored)") << endmsg;
411 y = atof (prop->value().c_str());
413 fast_simple_add (x, y);
421 if (node.name() != X_("AutomationList") ) {
422 error << string_compose (_("AutomationList: passed XML node called %1, not \"AutomationList\" - ignored"), node.name()) << endmsg;
427 /* update session AL list */
428 AutomationListCreated(this);
431 if ((prop = node.property (X_("automation-id"))) != 0){
432 _parameter = EventTypeMap::instance().from_symbol(prop->value());
434 warning << "Legacy session: automation list has no automation-id property." << endmsg;
437 if ((prop = node.property (X_("interpolation-style"))) != 0) {
438 _interpolation = (InterpolationStyle)string_2_enum(prop->value(), _interpolation);
440 _interpolation = Linear;
443 if ((prop = node.property (X_("default"))) != 0){
444 _default_value = atof (prop->value().c_str());
446 _default_value = 0.0;
449 if ((prop = node.property (X_("style"))) != 0) {
450 _style = string_to_auto_style (prop->value());
455 if ((prop = node.property (X_("state"))) != 0) {
456 _state = string_to_auto_state (prop->value());
457 if (_state == Write) {
460 automation_state_changed(_state);
465 if ((prop = node.property (X_("min-yval"))) != 0) {
466 _min_yval = atof (prop->value ().c_str());
471 if ((prop = node.property (X_("max-yval"))) != 0) {
472 _max_yval = atof (prop->value ().c_str());
477 bool have_events = false;
479 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
480 if ((*niter)->name() == X_("events")) {
481 deserialize_events (*(*niter));
487 /* there was no Events child node; clear any current events */
491 maybe_signal_changed ();
499 AutomationList::operator!= (AutomationList const & other) const
502 static_cast<ControlList const &> (*this) != static_cast<ControlList const &> (other) ||
503 _state != other._state ||
504 _style != other._style ||
505 _touching != other._touching
510 AutomationListProperty::clone () const
512 return new AutomationListProperty (
514 boost::shared_ptr<AutomationList> (new AutomationList (*this->_old.get())),
515 boost::shared_ptr<AutomationList> (new AutomationList (*this->_current.get()))