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)
184 if (_state == Write) {
185 Glib::Mutex::Lock lm (ControlList::_lock);
186 nascent.push_back (new NascentInfo ());
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 Glib::Mutex::Lock lm (ControlList::_lock);
206 nascent.push_back (new NascentInfo (when));
209 g_atomic_int_set (&_touching, 1);
213 AutomationList::stop_touch (bool mark, double when)
215 if (g_atomic_int_get (&_touching) == 0) {
216 /* this touch has already been stopped (probably by Automatable::transport_stopped),
217 so we've nothing to do.
222 g_atomic_int_set (&_touching, 0);
224 if (_state == Touch) {
226 assert (!nascent.empty ());
228 Glib::Mutex::Lock lm (ControlList::_lock);
232 nascent.back()->end_time = when;
236 /* nascent info created in start touch but never used. just get rid of it.
239 NascentInfo* ninfo = nascent.back ();
240 nascent.erase (nascent.begin());
247 AutomationList::thaw ()
251 if (_changed_when_thawed) {
252 _changed_when_thawed = false;
253 StateChanged(); /* EMIT SIGNAL */
258 AutomationList::get_state ()
264 AutomationList::state (bool full)
266 XMLNode* root = new XMLNode (X_("AutomationList"));
268 LocaleGuard lg (X_("POSIX"));
270 root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
272 root->add_property ("id", id().to_s());
274 snprintf (buf, sizeof (buf), "%.12g", _default_value);
275 root->add_property ("default", buf);
276 snprintf (buf, sizeof (buf), "%.12g", _min_yval);
277 root->add_property ("min-yval", buf);
278 snprintf (buf, sizeof (buf), "%.12g", _max_yval);
279 root->add_property ("max-yval", buf);
281 root->add_property ("interpolation-style", enum_2_string (_interpolation));
284 /* never serialize state with Write enabled - too dangerous
287 if (_state != Write) {
288 root->add_property ("state", auto_state_to_string (_state));
290 root->add_property ("state", auto_state_to_string (Off));
293 /* never save anything but Off for automation state to a template */
294 root->add_property ("state", auto_state_to_string (Off));
297 root->add_property ("style", auto_style_to_string (_style));
299 if (!_events.empty()) {
300 root->add_child_nocopy (serialize_events());
307 AutomationList::serialize_events ()
309 XMLNode* node = new XMLNode (X_("events"));
312 str.precision(15); //10 digits is enough digits for 24 hours at 96kHz
314 for (iterator xx = _events.begin(); xx != _events.end(); ++xx) {
315 str << (double) (*xx)->when;
317 str <<(double) (*xx)->value;
321 /* XML is a bit wierd */
323 XMLNode* content_node = new XMLNode (X_("foo")); /* it gets renamed by libxml when we set content */
324 content_node->set_content (str.str());
326 node->add_child_nocopy (*content_node);
332 AutomationList::deserialize_events (const XMLNode& node)
334 if (node.children().empty()) {
338 XMLNode* content_node = node.children().front();
340 if (content_node->content().empty()) {
344 ControlList::freeze ();
347 stringstream str (content_node->content());
363 fast_simple_add (x, y);
370 error << _("automation list: cannot load coordinates from XML, all points ignored") << endmsg;
373 maybe_signal_changed ();
382 AutomationList::set_state (const XMLNode& node, int version)
384 XMLNodeList nlist = node.children();
386 XMLNodeIterator niter;
387 const XMLProperty* prop;
389 if (node.name() == X_("events")) {
390 /* partial state setting*/
391 return deserialize_events (node);
394 if (node.name() == X_("Envelope") || node.name() == X_("FadeOut") || node.name() == X_("FadeIn")) {
396 if ((nsos = node.child (X_("AutomationList")))) {
397 /* new school in old school clothing */
398 return set_state (*nsos, version);
403 const XMLNodeList& elist = node.children();
404 XMLNodeConstIterator i;
409 ControlList::freeze ();
412 for (i = elist.begin(); i != elist.end(); ++i) {
414 if ((prop = (*i)->property ("x")) == 0) {
415 error << _("automation list: no x-coordinate stored for control point (point ignored)") << endmsg;
418 x = atoi (prop->value().c_str());
420 if ((prop = (*i)->property ("y")) == 0) {
421 error << _("automation list: no y-coordinate stored for control point (point ignored)") << endmsg;
424 y = atof (prop->value().c_str());
426 fast_simple_add (x, y);
436 if (node.name() != X_("AutomationList") ) {
437 error << string_compose (_("AutomationList: passed XML node called %1, not \"AutomationList\" - ignored"), node.name()) << endmsg;
442 /* update session AL list */
443 AutomationListCreated(this);
446 if ((prop = node.property (X_("automation-id"))) != 0){
447 _parameter = EventTypeMap::instance().new_parameter(prop->value());
449 warning << "Legacy session: automation list has no automation-id property.";
452 if ((prop = node.property (X_("interpolation-style"))) != 0) {
453 _interpolation = (InterpolationStyle)string_2_enum(prop->value(), _interpolation);
455 _interpolation = Linear;
458 if ((prop = node.property (X_("default"))) != 0){
459 _default_value = atof (prop->value().c_str());
461 _default_value = 0.0;
464 if ((prop = node.property (X_("style"))) != 0) {
465 _style = string_to_auto_style (prop->value());
470 if ((prop = node.property (X_("state"))) != 0) {
471 _state = string_to_auto_state (prop->value());
472 if (_state == Write) {
479 if ((prop = node.property (X_("min-yval"))) != 0) {
480 _min_yval = atof (prop->value ().c_str());
485 if ((prop = node.property (X_("max-yval"))) != 0) {
486 _max_yval = atof (prop->value ().c_str());
491 bool have_events = false;
493 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
494 if ((*niter)->name() == X_("events")) {
495 deserialize_events (*(*niter));
501 /* there was no Events child node; clear any current events */
505 maybe_signal_changed ();