libs/ardour/automation_list.cc

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include <set>
  21 #include <climits>
  22 #include <float.h>
  23 #include <cmath>
  24 #include <sstream>
  25 #include <algorithm>
  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"
  31
  32 #include "i18n.h"
  33
  34 using namespace std;
  35 using namespace ARDOUR;
  36 using namespace PBD;
  37
  38 PBD::Signal1<void,AutomationList *> AutomationList::AutomationListCreated;
  39
  40 #if 0
  41 static void dumpit (const AutomationList& al, string prefix = "")
  42 {
  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;
  46         }
  47         cerr << "\n";
  48 }
  49 #endif
  50 AutomationList::AutomationList (Evoral::Parameter id)
  51         : ControlList(id)
  52 {
  53         _state = Off;
  54         _style = Absolute;
  55         g_atomic_int_set (&_touching, 0);
  56
  57         create_curve_if_necessary();
  58
  59         assert(_parameter.type() != NullAutomation);
  60         AutomationListCreated(this);
  61 }
  62
  63 AutomationList::AutomationList (const AutomationList& other)
  64         : StatefulDestructible()
  65         , ControlList(other)
  66 {
  67         _style = other._style;
  68         _state = other._state;
  69         g_atomic_int_set (&_touching, other.touching());
  70
  71         create_curve_if_necessary();
  72
  73         assert(_parameter.type() != NullAutomation);
  74         AutomationListCreated(this);
  75 }
  76
  77 AutomationList::AutomationList (const AutomationList& other, double start, double end)
  78         : ControlList(other, start, end)
  79 {
  80         _style = other._style;
  81         _state = other._state;
  82         g_atomic_int_set (&_touching, other.touching());
  83
  84         create_curve_if_necessary();
  85
  86         assert(_parameter.type() != NullAutomation);
  87         AutomationListCreated(this);
  88 }
  89
  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.
  92  */
  93 AutomationList::AutomationList (const XMLNode& node, Evoral::Parameter id)
  94         : ControlList(id)
  95 {
  96         g_atomic_int_set (&_touching, 0);
  97         _state = Off;
  98         _style = Absolute;
  99
 100         set_state (node, Stateful::loading_state_version);
 101
 102         if (id) {
 103                 _parameter = id;
 104         }
 105
 106         create_curve_if_necessary();
 107
 108         assert(_parameter.type() != NullAutomation);
 109         AutomationListCreated(this);
 110 }
 111
 112 AutomationList::~AutomationList()
 113 {
 114 }
 115
 116 boost::shared_ptr<Evoral::ControlList>
 117 AutomationList::create(Evoral::Parameter id)
 118 {
 119         return boost::shared_ptr<Evoral::ControlList>(new AutomationList(id));
 120 }
 121
 122 void
 123 AutomationList::create_curve_if_necessary()
 124 {
 125         switch (_parameter.type()) {
 126         case GainAutomation:
 127         case PanAzimuthAutomation:
 128         case PanElevationAutomation:
 129         case PanWidthAutomation:
 130         case FadeInAutomation:
 131         case FadeOutAutomation:
 132         case EnvelopeAutomation:
 133                 create_curve();
 134                 break;
 135         default:
 136                 break;
 137         }
 138 }
 139
 140 bool
 141 AutomationList::operator== (const AutomationList& other)
 142 {
 143         return _events == other._events;
 144 }
 145
 146 AutomationList&
 147 AutomationList::operator= (const AutomationList& other)
 148 {
 149         if (this != &other) {
 150
 151                 _events.clear ();
 152
 153                 for (const_iterator i = other._events.begin(); i != other._events.end(); ++i) {
 154                         _events.push_back (new Evoral::ControlEvent (**i));
 155                 }
 156
 157                 _min_yval = other._min_yval;
 158                 _max_yval = other._max_yval;
 159                 _default_value = other._default_value;
 160
 161                 mark_dirty ();
 162                 maybe_signal_changed ();
 163         }
 164
 165         return *this;
 166 }
 167
 168 void
 169 AutomationList::maybe_signal_changed ()
 170 {
 171         ControlList::maybe_signal_changed ();
 172
 173         if (!ControlList::frozen()) {
 174                 StateChanged (); /* EMIT SIGNAL */
 175         }
 176 }
 177
 178 void
 179 AutomationList::set_automation_state (AutoState s)
 180 {
 181         if (s != _state) {
 182                 _state = s;
 183
 184                 if (_state == Write) {
 185                         Glib::Mutex::Lock lm (ControlList::_lock);
 186                         nascent.push_back (new NascentInfo ());
 187                 }
 188                 automation_state_changed (s); /* EMIT SIGNAL */
 189         }
 190 }
 191
 192 void
 193 AutomationList::set_automation_style (AutoStyle s)
 194 {
 195         if (s != _style) {
 196                 _style = s;
 197                 automation_style_changed (); /* EMIT SIGNAL */
 198         }
 199 }
 200
 201 void
 202 AutomationList::start_touch (double when)
 203 {
 204         if (_state == Touch) {
 205                 Glib::Mutex::Lock lm (ControlList::_lock);
 206                 nascent.push_back (new NascentInfo (when));
 207         }
 208
 209         g_atomic_int_set (&_touching, 1);
 210 }
 211
 212 void
 213 AutomationList::stop_touch (bool mark, double when)
 214 {
 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.
 218                 */
 219                 return;
 220         }
 221
 222         g_atomic_int_set (&_touching, 0);
 223
 224         if (_state == Touch) {
 225
 226                 assert (!nascent.empty ());
 227
 228                 Glib::Mutex::Lock lm (ControlList::_lock);
 229
 230                 if (mark) {
 231
 232                         nascent.back()->end_time = when;
 233
 234                 } else {
 235
 236                         /* nascent info created in start touch but never used. just get rid of it.
 237                          */
 238
 239                         NascentInfo* ninfo = nascent.back ();
 240                         nascent.erase (nascent.begin());
 241                         delete ninfo;
 242                 }
 243         }
 244 }
 245
 246 void
 247 AutomationList::thaw ()
 248 {
 249         ControlList::thaw();
 250
 251         if (_changed_when_thawed) {
 252                 _changed_when_thawed = false;
 253                 StateChanged(); /* EMIT SIGNAL */
 254         }
 255 }
 256
 257 XMLNode&
 258 AutomationList::get_state ()
 259 {
 260         return state (true);
 261 }
 262
 263 XMLNode&
 264 AutomationList::state (bool full)
 265 {
 266         XMLNode* root = new XMLNode (X_("AutomationList"));
 267         char buf[64];
 268         LocaleGuard lg (X_("POSIX"));
 269
 270         root->add_property ("automation-id", EventTypeMap::instance().to_symbol(_parameter));
 271
 272         root->add_property ("id", id().to_s());
 273
 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);
 280
 281         root->add_property ("interpolation-style", enum_2_string (_interpolation));
 282
 283         if (full) {
 284                 /* never serialize state with Write enabled - too dangerous
 285                    for the user's data
 286                 */
 287                 if (_state != Write) {
 288                         root->add_property ("state", auto_state_to_string (_state));
 289                 } else {
 290                         root->add_property ("state", auto_state_to_string (Off));
 291                 }
 292         } else {
 293                 /* never save anything but Off for automation state to a template */
 294                 root->add_property ("state", auto_state_to_string (Off));
 295         }
 296
 297         root->add_property ("style", auto_style_to_string (_style));
 298
 299         if (!_events.empty()) {
 300                 root->add_child_nocopy (serialize_events());
 301         }
 302
 303         return *root;
 304 }
 305
 306 XMLNode&
 307 AutomationList::serialize_events ()
 308 {
 309         XMLNode* node = new XMLNode (X_("events"));
 310         stringstream str;
 311
 312         str.precision(15);  //10 digits is enough digits for 24 hours at 96kHz
 313
 314         for (iterator xx = _events.begin(); xx != _events.end(); ++xx) {
 315                 str << (double) (*xx)->when;
 316                 str << ' ';
 317                 str <<(double) (*xx)->value;
 318                 str << '\n';
 319         }
 320
 321         /* XML is a bit wierd */
 322
 323         XMLNode* content_node = new XMLNode (X_("foo")); /* it gets renamed by libxml when we set content */
 324         content_node->set_content (str.str());
 325
 326         node->add_child_nocopy (*content_node);
 327
 328         return *node;
 329 }
 330
 331 int
 332 AutomationList::deserialize_events (const XMLNode& node)
 333 {
 334         if (node.children().empty()) {
 335                 return -1;
 336         }
 337
 338         XMLNode* content_node = node.children().front();
 339
 340         if (content_node->content().empty()) {
 341                 return -1;
 342         }
 343
 344         ControlList::freeze ();
 345         clear ();
 346
 347         stringstream str (content_node->content());
 348
 349         double x;
 350         double y;
 351         bool ok = true;
 352
 353         while (str) {
 354                 str >> x;
 355                 if (!str) {
 356                         break;
 357                 }
 358                 str >> y;
 359                 if (!str) {
 360                         ok = false;
 361                         break;
 362                 }
 363                 fast_simple_add (x, y);
 364         }
 365
 366         thin ();
 367
 368         if (!ok) {
 369                 clear ();
 370                 error << _("automation list: cannot load coordinates from XML, all points ignored") << endmsg;
 371         } else {
 372                 mark_dirty ();
 373                 maybe_signal_changed ();
 374         }
 375
 376         thaw ();
 377
 378         return 0;
 379 }
 380
 381 int
 382 AutomationList::set_state (const XMLNode& node, int version)
 383 {
 384         LocaleGuard lg (X_("POSIX"));
 385         XMLNodeList nlist = node.children();
 386         XMLNode* nsos;
 387         XMLNodeIterator niter;
 388         const XMLProperty* prop;
 389
 390         if (node.name() == X_("events")) {
 391                 /* partial state setting*/
 392                 return deserialize_events (node);
 393         }
 394
 395         if (node.name() == X_("Envelope") || node.name() == X_("FadeOut") || node.name() == X_("FadeIn")) {
 396
 397                 if ((nsos = node.child (X_("AutomationList")))) {
 398                         /* new school in old school clothing */
 399                         return set_state (*nsos, version);
 400                 }
 401
 402                 /* old school */
 403
 404                 const XMLNodeList& elist = node.children();
 405                 XMLNodeConstIterator i;
 406                 XMLProperty* prop;
 407                 pframes_t x;
 408                 double y;
 409
 410                 ControlList::freeze ();
 411                 clear ();
 412
 413                 for (i = elist.begin(); i != elist.end(); ++i) {
 414
 415                         if ((prop = (*i)->property ("x")) == 0) {
 416                                 error << _("automation list: no x-coordinate stored for control point (point ignored)") << endmsg;
 417                                 continue;
 418                         }
 419                         x = atoi (prop->value().c_str());
 420
 421                         if ((prop = (*i)->property ("y")) == 0) {
 422                                 error << _("automation list: no y-coordinate stored for control point (point ignored)") << endmsg;
 423                                 continue;
 424                         }
 425                         y = atof (prop->value().c_str());
 426
 427                         fast_simple_add (x, y);
 428                 }
 429
 430                 thin ();
 431
 432                 thaw ();
 433
 434                 return 0;
 435         }
 436
 437         if (node.name() != X_("AutomationList") ) {
 438                 error << string_compose (_("AutomationList: passed XML node called %1, not \"AutomationList\" - ignored"), node.name()) << endmsg;
 439                 return -1;
 440         }
 441
 442         if (set_id (node)) {
 443                 /* update session AL list */
 444                 AutomationListCreated(this);
 445         }
 446
 447         if ((prop = node.property (X_("automation-id"))) != 0){
 448                 _parameter = EventTypeMap::instance().new_parameter(prop->value());
 449         } else {
 450                 warning << "Legacy session: automation list has no automation-id property.";
 451         }
 452
 453         if ((prop = node.property (X_("interpolation-style"))) != 0) {
 454                 _interpolation = (InterpolationStyle)string_2_enum(prop->value(), _interpolation);
 455         } else {
 456                 _interpolation = Linear;
 457         }
 458
 459         if ((prop = node.property (X_("default"))) != 0){
 460                 _default_value = atof (prop->value().c_str());
 461         } else {
 462                 _default_value = 0.0;
 463         }
 464
 465         if ((prop = node.property (X_("style"))) != 0) {
 466                 _style = string_to_auto_style (prop->value());
 467         } else {
 468                 _style = Absolute;
 469         }
 470
 471         if ((prop = node.property (X_("state"))) != 0) {
 472                 _state = string_to_auto_state (prop->value());
 473                 if (_state == Write) {
 474                         _state = Off;
 475                 }
 476         } else {
 477                 _state = Off;
 478         }
 479
 480         if ((prop = node.property (X_("min-yval"))) != 0) {
 481                 _min_yval = atof (prop->value ().c_str());
 482         } else {
 483                 _min_yval = FLT_MIN;
 484         }
 485
 486         if ((prop = node.property (X_("max-yval"))) != 0) {
 487                 _max_yval = atof (prop->value ().c_str());
 488         } else {
 489                 _max_yval = FLT_MAX;
 490         }
 491
 492         bool have_events = false;
 493
 494         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 495                 if ((*niter)->name() == X_("events")) {
 496                         deserialize_events (*(*niter));
 497                         have_events = true;
 498                 }
 499         }
 500
 501         if (!have_events) {
 502                 /* there was no Events child node; clear any current events */
 503                 freeze ();
 504                 clear ();
 505                 mark_dirty ();
 506                 maybe_signal_changed ();
 507                 thaw ();
 508         }
 509
 510         return 0;
 511 }
 512