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.const_begin(); i != al.const_end(); ++i) {
45 cerr << prefix << '\t' << (*i)->when << ',' << (*i)->value << endl;
51 AutomationList::AutomationList (Evoral::Parameter id)
56 g_atomic_int_set (&_touching, 0);
58 create_curve_if_necessary();
60 assert(_parameter.type() != NullAutomation);
61 AutomationListCreated(this);
64 AutomationList::AutomationList (const AutomationList& other)
65 : StatefulDestructible()
68 _style = other._style;
69 _state = other._state;
70 g_atomic_int_set (&_touching, other.touching());
72 create_curve_if_necessary();
74 assert(_parameter.type() != NullAutomation);
75 AutomationListCreated(this);
78 AutomationList::AutomationList (const AutomationList& other, double start, double end)
79 : ControlList(other, start, end)
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 /** @param id is used for legacy sessions where the type is not present
92 * in or below the AutomationList node. It is used if @param id is non-null.
94 AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
97 g_atomic_int_set (&_touching, 0);
101 set_state (node, Stateful::loading_state_version);
107 create_curve_if_necessary();
109 assert(_parameter.type() != NullAutomation);
110 AutomationListCreated(this);
113 AutomationList::~AutomationList()
117 boost::shared_ptr<Evoral::ControlList>
118 AutomationList::create(Evoral::Parameter id)
120 return boost::shared_ptr<Evoral::ControlList>(new AutomationList(id));
124 AutomationList::create_curve_if_necessary()
126 switch (_parameter.type()) {
129 case FadeInAutomation:
130 case FadeOutAutomation:
131 case EnvelopeAutomation:
140 AutomationList::operator== (const AutomationList& other)
142 return _events == other._events;
146 AutomationList::operator= (const AutomationList& other)
148 if (this != &other) {
152 for (const_iterator i = other._events.begin(); i != other._events.end(); ++i) {
153 _events.push_back (new Evoral::ControlEvent (**i));
156 _min_yval = other._min_yval;
157 _max_yval = other._max_yval;
158 _max_xval = other._max_xval;
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 (false));
189 automation_state_changed (s); /* EMIT SIGNAL */
194 AutomationList::set_automation_style (AutoStyle s)
198 automation_style_changed (); /* EMIT SIGNAL */
203 AutomationList::start_touch (double when)
205 if (_state == Touch) {
206 Glib::Mutex::Lock lm (ControlList::_lock);
207 nascent.push_back (new NascentInfo (true, when));
210 g_atomic_int_set (&_touching, 1);
214 AutomationList::stop_touch (bool mark, double when)
216 g_atomic_int_set (&_touching, 0);
218 if (_state == Touch) {
219 Glib::Mutex::Lock lm (ControlList::_lock);
222 nascent.back()->end_time = when;
226 /* nascent info created in start touch but never used. just get rid of it.
229 NascentInfo* ninfo = nascent.back ();
230 nascent.erase (nascent.begin());
237 AutomationList::thaw ()
241 if (_changed_when_thawed) {
242 _changed_when_thawed = false;
243 StateChanged(); /* EMIT SIGNAL */
248 AutomationList::get_state ()
254 AutomationList::state (bool full)
256 XMLNode* root = new XMLNode (X_("AutomationList"));
258 LocaleGuard lg (X_("POSIX"));
260 root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
262 root->add_property ("id", _id.to_s());
264 snprintf (buf, sizeof (buf), "%.12g", _default_value);
265 root->add_property ("default", buf);
266 snprintf (buf, sizeof (buf), "%.12g", _min_yval);
267 root->add_property ("min-yval", buf);
268 snprintf (buf, sizeof (buf), "%.12g", _max_yval);
269 root->add_property ("max-yval", buf);
270 snprintf (buf, sizeof (buf), "%.12g", _max_xval);
271 root->add_property ("max-xval", buf);
273 root->add_property ("interpolation-style", enum_2_string (_interpolation));
276 /* never serialize state with Write enabled - too dangerous
279 if (_state != Write) {
280 root->add_property ("state", auto_state_to_string (_state));
282 root->add_property ("state", auto_state_to_string (Off));
285 /* never save anything but Off for automation state to a template */
286 root->add_property ("state", auto_state_to_string (Off));
289 root->add_property ("style", auto_style_to_string (_style));
291 if (!_events.empty()) {
292 root->add_child_nocopy (serialize_events());
299 AutomationList::serialize_events ()
301 XMLNode* node = new XMLNode (X_("events"));
304 str.precision(15); //10 digits is enough digits for 24 hours at 96kHz
306 for (iterator xx = _events.begin(); xx != _events.end(); ++xx) {
307 str << (double) (*xx)->when;
309 str <<(double) (*xx)->value;
313 /* XML is a bit wierd */
315 XMLNode* content_node = new XMLNode (X_("foo")); /* it gets renamed by libxml when we set content */
316 content_node->set_content (str.str());
318 node->add_child_nocopy (*content_node);
324 AutomationList::deserialize_events (const XMLNode& node)
326 if (node.children().empty()) {
330 XMLNode* content_node = node.children().front();
332 if (content_node->content().empty()) {
336 ControlList::freeze ();
339 stringstream str (content_node->content());
355 fast_simple_add (x, y);
360 error << _("automation list: cannot load coordinates from XML, all points ignored") << endmsg;
363 maybe_signal_changed ();
372 AutomationList::set_state (const XMLNode& node, int version)
374 XMLNodeList nlist = node.children();
376 XMLNodeIterator niter;
377 const XMLProperty* prop;
379 if (node.name() == X_("events")) {
380 /* partial state setting*/
381 return deserialize_events (node);
384 if (node.name() == X_("Envelope") || node.name() == X_("FadeOut") || node.name() == X_("FadeIn")) {
386 if ((nsos = node.child (X_("AutomationList")))) {
387 /* new school in old school clothing */
388 return set_state (*nsos, version);
393 const XMLNodeList& elist = node.children();
394 XMLNodeConstIterator i;
399 ControlList::freeze ();
402 for (i = elist.begin(); i != elist.end(); ++i) {
404 if ((prop = (*i)->property ("x")) == 0) {
405 error << _("automation list: no x-coordinate stored for control point (point ignored)") << endmsg;
408 x = atoi (prop->value().c_str());
410 if ((prop = (*i)->property ("y")) == 0) {
411 error << _("automation list: no y-coordinate stored for control point (point ignored)") << endmsg;
414 y = atof (prop->value().c_str());
416 fast_simple_add (x, y);
424 if (node.name() != X_("AutomationList") ) {
425 error << string_compose (_("AutomationList: passed XML node called %1, not \"AutomationList\" - ignored"), node.name()) << endmsg;
429 if ((prop = node.property ("id")) != 0) {
430 _id = prop->value ();
431 /* update session AL list */
432 AutomationListCreated(this);
435 if ((prop = node.property (X_("automation-id"))) != 0){
436 _parameter = EventTypeMap::instance().new_parameter(prop->value());
438 warning << "Legacy session: automation list has no automation-id property.";
441 if ((prop = node.property (X_("interpolation-style"))) != 0) {
442 _interpolation = (InterpolationStyle)string_2_enum(prop->value(), _interpolation);
444 _interpolation = Linear;
447 if ((prop = node.property (X_("default"))) != 0){
448 _default_value = atof (prop->value().c_str());
450 _default_value = 0.0;
453 if ((prop = node.property (X_("style"))) != 0) {
454 _style = string_to_auto_style (prop->value());
459 if ((prop = node.property (X_("state"))) != 0) {
460 _state = string_to_auto_state (prop->value());
461 if (_state == Write) {
468 if ((prop = node.property (X_("min_yval"))) != 0) {
469 _min_yval = atof (prop->value ().c_str());
474 if ((prop = node.property (X_("max_yval"))) != 0) {
475 _max_yval = atof (prop->value ().c_str());
480 if ((prop = node.property (X_("max_xval"))) != 0) {
481 _max_xval = atof (prop->value ().c_str());
483 _max_xval = 0; // means "no limit ;
486 bool have_events = false;
488 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
489 if ((*niter)->name() == X_("events")) {
490 deserialize_events (*(*niter));
496 /* there was no Events child node; clear any current events */
500 maybe_signal_changed ();