libs/ardour/automatable.cc

   1 /*
   2     Copyright (C) 2001,2007 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 <ardour/ardour.h>
  21 #include <fstream>
  22 #include <inttypes.h>
  23 #include <cstdio>
  24 #include <errno.h>
  25 #include <pbd/error.h>
  26 #include <pbd/enumwriter.h>
  27 #include <midi++/names.h>
  28 #include <ardour/session.h>
  29 #include <ardour/automatable.h>
  30 #include <ardour/midi_track.h>
  31
  32 #include "i18n.h"
  33
  34 using namespace std;
  35 using namespace ARDOUR;
  36 using namespace PBD;
  37
  38 nframes_t Automatable::_automation_interval = 0;
  39
  40 Automatable::Automatable(Session& _session, const string& name)
  41         : SessionObject(_session, name)
  42         , _last_automation_snapshot(0)
  43 {}
  44
  45 int
  46 Automatable::old_set_automation_state (const XMLNode& node)
  47 {
  48         const XMLProperty *prop;
  49
  50         if ((prop = node.property ("path")) != 0) {
  51                 load_automation (prop->value());
  52         } else {
  53                 warning << string_compose(_("%1: Automation node has no path property"), _name) << endmsg;
  54         }
  55
  56         if ((prop = node.property ("visible")) != 0) {
  57                 uint32_t what;
  58                 stringstream sstr;
  59
  60                 _visible_controls.clear ();
  61
  62                 sstr << prop->value();
  63                 while (1) {
  64                         sstr >> what;
  65                         if (sstr.fail()) {
  66                                 break;
  67                         }
  68                         mark_automation_visible (Parameter(PluginAutomation, what), true);
  69                 }
  70         }
  71
  72         _last_automation_snapshot = 0;
  73
  74         return 0;
  75 }
  76
  77 int
  78 Automatable::load_automation (const string& path)
  79 {
  80         string fullpath;
  81
  82         if (path[0] == '/') { // legacy
  83                 fullpath = path;
  84         } else {
  85                 fullpath = _session.automation_dir();
  86                 fullpath += path;
  87         }
  88         ifstream in (fullpath.c_str());
  89
  90         if (!in) {
  91                 warning << string_compose(_("%1: cannot open %2 to load automation data (%3)"), _name, fullpath, strerror (errno)) << endmsg;
  92                 return 1;
  93         }
  94
  95         Glib::Mutex::Lock lm (_automation_lock);
  96         set<Parameter> tosave;
  97         _controls.clear ();
  98
  99         _last_automation_snapshot = 0;
 100
 101         while (in) {
 102                 double when;
 103                 double value;
 104                 uint32_t port;
 105
 106                 in >> port;  if (!in) break;
 107                 in >> when;  if (!in) goto bad;
 108                 in >> value; if (!in) goto bad;
 109
 110                 /* FIXME: this is legacy and only used for plugin inserts?  I think? */
 111                 boost::shared_ptr<AutomationControl> c = control (Parameter(PluginAutomation, port), true);
 112                 c->list()->add (when, value);
 113                 tosave.insert (Parameter(PluginAutomation, port));
 114         }
 115
 116         return 0;
 117
 118   bad:
 119         error << string_compose(_("%1: cannot load automation data from %2"), _name, fullpath) << endmsg;
 120         _controls.clear ();
 121         return -1;
 122 }
 123
 124 void
 125 Automatable::add_control(boost::shared_ptr<AutomationControl> ac)
 126 {
 127         Parameter param = ac->parameter();
 128
 129         _controls[param] = ac;
 130
 131         _can_automate_list.insert(param);
 132
 133         // Sync everything (derived classes) up to initial values
 134         auto_state_changed(param);
 135 }
 136
 137 void
 138 Automatable::what_has_automation (set<Parameter>& s) const
 139 {
 140         Glib::Mutex::Lock lm (_automation_lock);
 141         Controls::const_iterator li;
 142
 143         // FIXME: correct semantics?
 144         for (li = _controls.begin(); li != _controls.end(); ++li) {
 145                 s.insert  ((*li).first);
 146         }
 147 }
 148
 149 void
 150 Automatable::what_has_visible_automation (set<Parameter>& s) const
 151 {
 152         Glib::Mutex::Lock lm (_automation_lock);
 153         set<Parameter>::const_iterator li;
 154
 155         for (li = _visible_controls.begin(); li != _visible_controls.end(); ++li) {
 156                 s.insert  (*li);
 157         }
 158 }
 159
 160 /** Returns NULL if we don't have an AutomationList for \a parameter.
 161  */
 162 boost::shared_ptr<AutomationControl>
 163 Automatable::control (Parameter parameter, bool create_if_missing)
 164 {
 165         Controls::iterator i = _controls.find(parameter);
 166
 167         if (i != _controls.end()) {
 168                 return i->second;
 169
 170         } else if (create_if_missing) {
 171                 boost::shared_ptr<AutomationList> al (new AutomationList (
 172                                         parameter, FLT_MIN, FLT_MAX, default_parameter_value (parameter)));
 173                 boost::shared_ptr<AutomationControl> ac(control_factory(al));
 174                 add_control(ac);
 175                 return ac;
 176
 177         } else {
 178                 //warning << "AutomationList " << parameter.to_string() << " not found for " << _name << endmsg;
 179                 return boost::shared_ptr<AutomationControl>();
 180         }
 181 }
 182
 183 boost::shared_ptr<const AutomationControl>
 184 Automatable::control (Parameter parameter) const
 185 {
 186         Controls::const_iterator i = _controls.find(parameter);
 187
 188         if (i != _controls.end()) {
 189                 return i->second;
 190         } else {
 191                 //warning << "AutomationList " << parameter.to_string() << " not found for " << _name << endmsg;
 192                 return boost::shared_ptr<AutomationControl>();
 193         }
 194 }
 195
 196 string
 197 Automatable::describe_parameter (Parameter param)
 198 {
 199         /* derived classes like PluginInsert should override this */
 200
 201         if (param == Parameter(GainAutomation)) {
 202                 return _("Fader");
 203         } else if (param.type() == PanAutomation) {
 204                 return (string_compose(_("Pan %1"), param.id()));
 205         } else if (param.type() == MidiCCAutomation) {
 206                 return string_compose("CC %1 (%2) [%3]",
 207                                 param.id(), midi_name(param.id()), int(param.channel()) + 1);
 208         } else if (param.type() == MidiPgmChangeAutomation) {
 209                 return string_compose("Program [%1]", int(param.channel()) + 1);
 210         } else if (param.type() == MidiPitchBenderAutomation) {
 211                 return string_compose("Bender [%1]", int(param.channel()) + 1);
 212         } else if (param.type() == MidiChannelAftertouchAutomation) {
 213                 return string_compose("Aftertouch [%1]", int(param.channel()) + 1);
 214         } else {
 215                 return param.to_string();
 216         }
 217 }
 218
 219 void
 220 Automatable::can_automate (Parameter what)
 221 {
 222         _can_automate_list.insert (what);
 223 }
 224
 225 void
 226 Automatable::mark_automation_visible (Parameter what, bool yn)
 227 {
 228         if (yn) {
 229                 _visible_controls.insert (what);
 230         } else {
 231                 set<Parameter>::iterator i;
 232
 233                 if ((i = _visible_controls.find (what)) != _visible_controls.end()) {
 234                         _visible_controls.erase (i);
 235                 }
 236         }
 237 }
 238
 239 bool
 240 Automatable::find_next_event (nframes_t now, nframes_t end, ControlEvent& next_event) const
 241 {
 242         Controls::const_iterator li;
 243
 244         next_event.when = max_frames;
 245
 246         for (li = _controls.begin(); li != _controls.end(); ++li) {
 247
 248                 AutomationList::const_iterator i;
 249                 boost::shared_ptr<const AutomationList> alist (li->second->list());
 250                 ControlEvent cp (now, 0.0f);
 251
 252                 for (i = lower_bound (alist->const_begin(), alist->const_end(), &cp, AutomationList::time_comparator);
 253                                 i != alist->const_end() && (*i)->when < end; ++i) {
 254                         if ((*i)->when > now) {
 255                                 break;
 256                         }
 257                 }
 258
 259                 if (i != alist->const_end() && (*i)->when < end) {
 260
 261                         if ((*i)->when < next_event.when) {
 262                                 next_event.when = (*i)->when;
 263                         }
 264                 }
 265         }
 266
 267         return next_event.when != max_frames;
 268 }
 269
 270 /** \a legacy_param is used for loading legacy sessions where an object (IO, Panner)
 271  * had a single automation parameter, with it's type implicit.  Derived objects should
 272  * pass that type and it will be used for the untyped AutomationList found.
 273  */
 274 int
 275 Automatable::set_automation_state (const XMLNode& node, Parameter legacy_param)
 276 {
 277         Glib::Mutex::Lock lm (_automation_lock);
 278
 279         /* Don't clear controls, since some may be special derived Controllable classes */
 280
 281         _visible_controls.clear ();
 282
 283         XMLNodeList nlist = node.children();
 284         XMLNodeIterator niter;
 285
 286         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 287
 288                 /*if (sscanf ((*niter)->name().c_str(), "parameter-%" PRIu32, &param) != 1) {
 289                   error << string_compose (_("%2: badly formatted node name in XML automation state, ignored"), _name) << endmsg;
 290                   continue;
 291                   }*/
 292
 293                 if ((*niter)->name() == "AutomationList") {
 294
 295                         const XMLProperty* id_prop = (*niter)->property("automation-id");
 296
 297                         Parameter param = (id_prop ? Parameter(id_prop->value()) : legacy_param);
 298
 299                         boost::shared_ptr<AutomationList> al (new AutomationList(**niter, param));
 300
 301                         if (!id_prop) {
 302                                 warning << "AutomationList node without automation-id property, "
 303                                         << "using default: " << legacy_param.to_string() << endmsg;
 304                                 al->set_parameter(legacy_param);
 305                         }
 306
 307                         boost::shared_ptr<AutomationControl> existing = control(param);
 308                         if (existing)
 309                                 existing->set_list(al);
 310                         else
 311                                 add_control(control_factory(al));
 312
 313                 } else {
 314                         error << "Expected AutomationList node, got '" << (*niter)->name() << endmsg;
 315                 }
 316         }
 317
 318         _last_automation_snapshot = 0;
 319
 320         return 0;
 321 }
 322
 323 XMLNode&
 324 Automatable::get_automation_state ()
 325 {
 326         Glib::Mutex::Lock lm (_automation_lock);
 327         XMLNode* node = new XMLNode (X_("Automation"));
 328
 329         if (_controls.empty()) {
 330                 return *node;
 331         }
 332
 333         for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li) {
 334                 node->add_child_nocopy (li->second->list()->get_state ());
 335         }
 336
 337         return *node;
 338 }
 339
 340 void
 341 Automatable::clear_automation ()
 342 {
 343         Glib::Mutex::Lock lm (_automation_lock);
 344
 345         for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
 346                 li->second->list()->clear();
 347 }
 348
 349 void
 350 Automatable::set_parameter_automation_state (Parameter param, AutoState s)
 351 {
 352         Glib::Mutex::Lock lm (_automation_lock);
 353
 354         boost::shared_ptr<AutomationControl> c = control (param, true);
 355
 356         if (s != c->list()->automation_state()) {
 357                 c->list()->set_automation_state (s);
 358                 _session.set_dirty ();
 359         }
 360 }
 361
 362 AutoState
 363 Automatable::get_parameter_automation_state (Parameter param, bool lock)
 364 {
 365         AutoState result = Off;
 366
 367         if (lock)
 368                 _automation_lock.lock();
 369
 370         boost::shared_ptr<AutomationControl> c = control(param);
 371
 372         if (c)
 373                 result = c->list()->automation_state();
 374
 375         if (lock)
 376                 _automation_lock.unlock();
 377
 378         return result;
 379 }
 380
 381 void
 382 Automatable::set_parameter_automation_style (Parameter param, AutoStyle s)
 383 {
 384         Glib::Mutex::Lock lm (_automation_lock);
 385
 386         boost::shared_ptr<AutomationControl> c = control(param, true);
 387
 388         if (s != c->list()->automation_style()) {
 389                 c->list()->set_automation_style (s);
 390                 _session.set_dirty ();
 391         }
 392 }
 393
 394 AutoStyle
 395 Automatable::get_parameter_automation_style (Parameter param)
 396 {
 397         Glib::Mutex::Lock lm (_automation_lock);
 398
 399         boost::shared_ptr<AutomationControl> c = control(param);
 400
 401         if (c) {
 402                 return c->list()->automation_style();
 403         } else {
 404                 return Absolute; // whatever
 405         }
 406 }
 407
 408 void
 409 Automatable::protect_automation ()
 410 {
 411         set<Parameter> automated_params;
 412
 413         what_has_automation (automated_params);
 414
 415         for (set<Parameter>::iterator i = automated_params.begin(); i != automated_params.end(); ++i) {
 416
 417                 boost::shared_ptr<AutomationControl> c = control(*i);
 418
 419                 switch (c->list()->automation_state()) {
 420                 case Write:
 421                         c->list()->set_automation_state (Off);
 422                         break;
 423                 case Touch:
 424                         c->list()->set_automation_state (Play);
 425                         break;
 426                 default:
 427                         break;
 428                 }
 429         }
 430 }
 431
 432 void
 433 Automatable::automation_snapshot (nframes_t now, bool force)
 434 {
 435         if (force || _last_automation_snapshot > now || (now - _last_automation_snapshot) > _automation_interval) {
 436
 437                 for (Controls::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 438                         if (i->second->list()->automation_write()) {
 439                                 i->second->list()->rt_add (now, i->second->user_value());
 440                         }
 441                 }
 442
 443                 _last_automation_snapshot = now;
 444         }
 445 }
 446
 447 void
 448 Automatable::transport_stopped (nframes_t now)
 449 {
 450         for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li) {
 451
 452                 boost::shared_ptr<AutomationControl> c = li->second;
 453
 454                 c->list()->reposition_for_rt_add (now);
 455
 456                 if (c->list()->automation_state() != Off) {
 457                         c->set_value(c->list()->eval(now));
 458                 }
 459         }
 460 }
 461
 462 /* FIXME: this probably doesn't belong here */
 463 boost::shared_ptr<AutomationControl>
 464 Automatable::control_factory(boost::shared_ptr<AutomationList> list)
 465 {
 466         if (
 467                         list->parameter().type() == MidiCCAutomation ||
 468                         list->parameter().type() == MidiPgmChangeAutomation ||
 469                         list->parameter().type() == MidiChannelAftertouchAutomation
 470            ) {
 471                 // FIXME: this will die horribly if this is not a MidiTrack
 472                 return boost::shared_ptr<AutomationControl>(new MidiTrack::MidiControl((MidiTrack*)this, list));
 473         } else {
 474                 return boost::shared_ptr<AutomationControl>(new AutomationControl(_session, list));
 475         }
 476 }
 477