2 Copyright (C) 2001,2007 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.
20 #include "ardour/ardour.h"
25 #include "pbd/error.h"
26 #include "pbd/enumwriter.h"
28 #include "midi++/names.h"
30 #include "ardour/automatable.h"
31 #include "ardour/amp.h"
32 #include "ardour/event_type_map.h"
33 #include "ardour/midi_track.h"
34 #include "ardour/panner.h"
35 #include "ardour/plugin_insert.h"
36 #include "ardour/session.h"
41 using namespace ARDOUR;
44 nframes_t Automatable::_automation_interval = 0;
46 Automatable::Automatable(Session& session)
48 , _last_automation_snapshot(0)
52 Automatable::Automatable (const Automatable& other)
54 , _a_session (other._a_session)
55 , _last_automation_snapshot (0)
57 Glib::Mutex::Lock lm (other._control_lock);
59 for (Controls::const_iterator i = other._controls.begin(); i != other._controls.end(); ++i) {
60 boost::shared_ptr<Evoral::Control> ac (control_factory (i->first));
65 Automatable::old_set_automation_state (const XMLNode& node)
67 const XMLProperty *prop;
69 if ((prop = node.property ("path")) != 0) {
70 load_automation (prop->value());
72 warning << _("Automation node has no path property") << endmsg;
75 if ((prop = node.property ("visible")) != 0) {
79 _visible_controls.clear ();
81 sstr << prop->value();
87 mark_automation_visible (Evoral::Parameter(PluginAutomation, 0, what), true);
91 _last_automation_snapshot = 0;
97 Automatable::load_automation (const string& path)
101 if (path[0] == '/') { // legacy
104 fullpath = _a_session.automation_dir();
107 ifstream in (fullpath.c_str());
110 warning << string_compose(_("cannot open %2 to load automation data (%3)")
111 , fullpath, strerror (errno)) << endmsg;
115 Glib::Mutex::Lock lm (control_lock());
116 set<Evoral::Parameter> tosave;
119 _last_automation_snapshot = 0;
126 in >> port; if (!in) break;
127 in >> when; if (!in) goto bad;
128 in >> value; if (!in) goto bad;
130 Evoral::Parameter param(PluginAutomation, 0, port);
131 /* FIXME: this is legacy and only used for plugin inserts? I think? */
132 boost::shared_ptr<Evoral::Control> c = control (param, true);
133 c->list()->add (when, value);
134 tosave.insert (param);
140 error << string_compose(_("cannot load automation data from %2"), fullpath) << endmsg;
146 Automatable::add_control(boost::shared_ptr<Evoral::Control> ac)
148 Evoral::Parameter param = ac->parameter();
150 ControlSet::add_control(ac);
151 _can_automate_list.insert(param);
152 auto_state_changed(param); // sync everything up
154 /* connect to automation_state_changed so that we can emit a signal when one of our controls'
155 automation state changes
157 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl> (ac);
159 c->alist()->automation_state_changed.connect_same_thread (
160 _control_connections, boost::bind (&Automatable::automation_state_changed, this, c->parameter())
166 Automatable::what_has_visible_data(set<Evoral::Parameter>& s) const
168 Glib::Mutex::Lock lm (control_lock());
169 set<Evoral::Parameter>::const_iterator li;
171 for (li = _visible_controls.begin(); li != _visible_controls.end(); ++li) {
177 Automatable::describe_parameter (Evoral::Parameter param)
179 /* derived classes like PluginInsert should override this */
181 if (param == Evoral::Parameter(GainAutomation)) {
183 } else if (param.type() == PanAutomation) {
184 /* ID's are zero-based, present them as 1-based */
185 return (string_compose(_("Pan %1"), param.id() + 1));
186 } else if (param.type() == MidiCCAutomation) {
187 return string_compose("%1: %2 [%3]",
188 param.id() + 1, midi_name(param.id()), int(param.channel()) + 1);
189 } else if (param.type() == MidiPgmChangeAutomation) {
190 return string_compose("Program [%1]", int(param.channel()) + 1);
191 } else if (param.type() == MidiPitchBenderAutomation) {
192 return string_compose("Bender [%1]", int(param.channel()) + 1);
193 } else if (param.type() == MidiChannelPressureAutomation) {
194 return string_compose("Pressure [%1]", int(param.channel()) + 1);
196 return EventTypeMap::instance().to_symbol(param);
201 Automatable::can_automate (Evoral::Parameter what)
203 _can_automate_list.insert (what);
207 Automatable::mark_automation_visible (Evoral::Parameter what, bool yn)
210 _visible_controls.insert (what);
212 set<Evoral::Parameter>::iterator i;
214 if ((i = _visible_controls.find (what)) != _visible_controls.end()) {
215 _visible_controls.erase (i);
220 /** \a legacy_param is used for loading legacy sessions where an object (IO, Panner)
221 * had a single automation parameter, with it's type implicit. Derived objects should
222 * pass that type and it will be used for the untyped AutomationList found.
225 Automatable::set_automation_state (const XMLNode& node, Evoral::Parameter legacy_param)
227 Glib::Mutex::Lock lm (control_lock());
229 /* Don't clear controls, since some may be special derived Controllable classes */
231 _visible_controls.clear ();
233 XMLNodeList nlist = node.children();
234 XMLNodeIterator niter;
236 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
238 /*if (sscanf ((*niter)->name().c_str(), "parameter-%" PRIu32, ¶m) != 1) {
239 error << string_compose (_("%2: badly formatted node name in XML automation state, ignored"), _name) << endmsg;
243 if ((*niter)->name() == "AutomationList") {
245 const XMLProperty* id_prop = (*niter)->property("automation-id");
247 Evoral::Parameter param = (id_prop
248 ? EventTypeMap::instance().new_parameter(id_prop->value())
251 if (param.type() == NullAutomation) {
252 warning << "Automation has null type" << endl;
256 boost::shared_ptr<AutomationList> al (new AutomationList(**niter, param));
259 warning << "AutomationList node without automation-id property, "
260 << "using default: " << EventTypeMap::instance().to_symbol(legacy_param) << endmsg;
263 boost::shared_ptr<Evoral::Control> existing = control(param);
265 existing->set_list(al);
267 boost::shared_ptr<Evoral::Control> newcontrol = control_factory(param);
268 add_control(newcontrol);
269 newcontrol->set_list(al);
273 error << "Expected AutomationList node, got '" << (*niter)->name() << endmsg;
277 _last_automation_snapshot = 0;
283 Automatable::get_automation_state ()
285 Glib::Mutex::Lock lm (control_lock());
286 XMLNode* node = new XMLNode (X_("Automation"));
288 if (controls().empty()) {
292 for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
293 boost::shared_ptr<AutomationList> l
294 = boost::dynamic_pointer_cast<AutomationList>(li->second->list());
296 node->add_child_nocopy (l->get_state ());
304 Automatable::set_parameter_automation_state (Evoral::Parameter param, AutoState s)
306 Glib::Mutex::Lock lm (control_lock());
308 boost::shared_ptr<Evoral::Control> c = control (param, true);
309 boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
311 if (s != l->automation_state()) {
312 l->set_automation_state (s);
313 _a_session.set_dirty ();
318 Automatable::get_parameter_automation_state (Evoral::Parameter param, bool lock)
320 AutoState result = Off;
323 control_lock().lock();
325 boost::shared_ptr<Evoral::Control> c = control(param);
326 boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
329 result = l->automation_state();
332 control_lock().unlock();
338 Automatable::set_parameter_automation_style (Evoral::Parameter param, AutoStyle s)
340 Glib::Mutex::Lock lm (control_lock());
342 boost::shared_ptr<Evoral::Control> c = control(param, true);
343 boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
345 if (s != l->automation_style()) {
346 l->set_automation_style (s);
347 _a_session.set_dirty ();
352 Automatable::get_parameter_automation_style (Evoral::Parameter param)
354 Glib::Mutex::Lock lm (control_lock());
356 boost::shared_ptr<Evoral::Control> c = control(param);
357 boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
360 return l->automation_style();
362 return Absolute; // whatever
367 Automatable::protect_automation ()
369 typedef set<Evoral::Parameter> ParameterSet;
370 ParameterSet automated_params;
372 what_has_data(automated_params);
374 for (ParameterSet::iterator i = automated_params.begin(); i != automated_params.end(); ++i) {
376 boost::shared_ptr<Evoral::Control> c = control(*i);
377 boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
379 switch (l->automation_state()) {
381 l->set_automation_state (Off);
384 l->set_automation_state (Play);
393 Automatable::automation_snapshot (nframes_t now, bool force)
395 if (force || _last_automation_snapshot > now || (now - _last_automation_snapshot) > _automation_interval) {
397 for (Controls::iterator i = controls().begin(); i != controls().end(); ++i) {
398 boost::shared_ptr<AutomationControl> c
399 = boost::dynamic_pointer_cast<AutomationControl>(i->second);
400 if (c->automation_write()) {
401 c->list()->rt_add (now, i->second->user_float());
405 _last_automation_snapshot = now;
410 Automatable::transport_stopped (sframes_t now)
412 for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
414 boost::shared_ptr<AutomationControl> c
415 = boost::dynamic_pointer_cast<AutomationControl>(li->second);
416 boost::shared_ptr<AutomationList> l
417 = boost::dynamic_pointer_cast<AutomationList>(c->list());
419 c->list()->reposition_for_rt_add (now);
421 if (c->automation_state() != Off) {
422 c->set_value(c->list()->eval(now));
427 boost::shared_ptr<Evoral::Control>
428 Automatable::control_factory(const Evoral::Parameter& param)
430 boost::shared_ptr<AutomationList> list(new AutomationList(param));
431 Evoral::Control* control = NULL;
432 if (param.type() >= MidiCCAutomation && param.type() <= MidiChannelPressureAutomation) {
433 MidiTrack* mt = dynamic_cast<MidiTrack*>(this);
435 control = new MidiTrack::MidiControl(mt, param);
437 warning << "MidiCCAutomation for non-MidiTrack" << endl;
439 } else if (param.type() == PluginAutomation) {
440 PluginInsert* pi = dynamic_cast<PluginInsert*>(this);
442 control = new PluginInsert::PluginControl(pi, param);
444 warning << "PluginAutomation for non-Plugin" << endl;
446 } else if (param.type() == GainAutomation) {
447 Amp* amp = dynamic_cast<Amp*>(this);
449 control = new Amp::GainControl(X_("gaincontrol"), _a_session, amp, param);
451 warning << "GainAutomation for non-Amp" << endl;
453 } else if (param.type() == PanAutomation) {
454 Panner* me = dynamic_cast<Panner*>(this);
456 control = new Panner::PanControllable(me->session(), X_("panner"), *me, param);
458 warning << "PanAutomation for non-Panner" << endl;
463 control = new AutomationControl(_a_session, param);
466 control->set_list(list);
467 return boost::shared_ptr<Evoral::Control>(control);
470 boost::shared_ptr<AutomationControl>
471 Automatable::automation_control (const Evoral::Parameter& id, bool create)
473 return boost::dynamic_pointer_cast<AutomationControl>(Evoral::ControlSet::control(id, create));
476 boost::shared_ptr<const AutomationControl>
477 Automatable::automation_control (const Evoral::Parameter& id) const
479 return boost::dynamic_pointer_cast<const AutomationControl>(Evoral::ControlSet::control(id));
483 Automatable::automation_state_changed (Evoral::Parameter const & p)
485 AutomationStateChanged (p); /* EMIT SIGNAL */
489 Automatable::clear_controls ()
491 _control_connections.drop_connections ();
492 ControlSet::clear_controls ();