/*
- Copyright (C) 2001,2007 Paul Davis
+ Copyright (C) 2001,2007 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
-#include <ardour/ardour.h>
#include <fstream>
-#include <inttypes.h>
#include <cstdio>
#include <errno.h>
-#include <pbd/error.h>
-#include <pbd/enumwriter.h>
-#include <ardour/session.h>
-#include <ardour/automatable.h>
+
+#include <glibmm/miscutils.h>
+
+#include "pbd/error.h"
+
+#include "midi++/names.h"
+
+#include "ardour/amp.h"
+#include "ardour/automatable.h"
+#include "ardour/event_type_map.h"
+#include "ardour/midi_track.h"
+#include "ardour/pan_controllable.h"
+#include "ardour/pannable.h"
+#include "ardour/plugin_insert.h"
+#include "ardour/session.h"
#include "i18n.h"
using namespace ARDOUR;
using namespace PBD;
+framecnt_t Automatable::_automation_interval = 0;
+const string Automatable::xml_node_name = X_("Automation");
-Automatable::Automatable(Session& _session, const string& name)
- : SessionObject(_session, name)
+Automatable::Automatable(Session& session)
+ : _a_session(session)
, _last_automation_snapshot(0)
-{}
+{
+}
+
+Automatable::Automatable (const Automatable& other)
+ : ControlSet (other)
+ , _a_session (other._a_session)
+ , _last_automation_snapshot (0)
+{
+ Glib::Mutex::Lock lm (other._control_lock);
+ for (Controls::const_iterator i = other._controls.begin(); i != other._controls.end(); ++i) {
+ boost::shared_ptr<Evoral::Control> ac (control_factory (i->first));
+ add_control (ac);
+ }
+}
int
Automatable::old_set_automation_state (const XMLNode& node)
{
const XMLProperty *prop;
-
+
if ((prop = node.property ("path")) != 0) {
load_automation (prop->value());
} else {
- warning << string_compose(_("%1: Automation node has no path property"), _name) << endmsg;
+ warning << _("Automation node has no path property") << endmsg;
}
-
- if ((prop = node.property ("visible")) != 0) {
- uint32_t what;
- stringstream sstr;
-
- _visible_controls.clear ();
-
- sstr << prop->value();
- while (1) {
- sstr >> what;
- if (sstr.fail()) {
- break;
- }
- mark_automation_visible (ParamID(PluginAutomation, what), true);
- }
- }
-
+
_last_automation_snapshot = 0;
return 0;
{
string fullpath;
- if (path[0] == '/') { // legacy
+ if (Glib::path_is_absolute (path)) { // legacy
fullpath = path;
} else {
- fullpath = _session.automation_dir();
+ fullpath = _a_session.automation_dir();
fullpath += path;
}
ifstream in (fullpath.c_str());
if (!in) {
- warning << string_compose(_("%1: cannot open %2 to load automation data (%3)"), _name, fullpath, strerror (errno)) << endmsg;
+ warning << string_compose(_("cannot open %2 to load automation data (%3)")
+ , fullpath, strerror (errno)) << endmsg;
return 1;
}
- Glib::Mutex::Lock lm (_automation_lock);
- set<ParamID> tosave;
- _controls.clear ();
-
+ Glib::Mutex::Lock lm (control_lock());
+ set<Evoral::Parameter> tosave;
+ controls().clear ();
+
_last_automation_snapshot = 0;
while (in) {
in >> port; if (!in) break;
in >> when; if (!in) goto bad;
in >> value; if (!in) goto bad;
-
+
+ Evoral::Parameter param(PluginAutomation, 0, port);
/* FIXME: this is legacy and only used for plugin inserts? I think? */
- boost::shared_ptr<AutomationControl> c = control (ParamID(PluginAutomation, port), true);
+ boost::shared_ptr<Evoral::Control> c = control (param, true);
c->list()->add (when, value);
- tosave.insert (ParamID(PluginAutomation, port));
+ tosave.insert (param);
}
-
+
return 0;
bad:
- error << string_compose(_("%1: cannot load automation data from %2"), _name, fullpath) << endmsg;
- _controls.clear ();
+ error << string_compose(_("cannot load automation data from %2"), fullpath) << endmsg;
+ controls().clear ();
return -1;
}
void
-Automatable::add_control(boost::shared_ptr<AutomationControl> ac)
+Automatable::add_control(boost::shared_ptr<Evoral::Control> ac)
{
- ParamID param = ac->list()->param_id();
+ Evoral::Parameter param = ac->parameter();
- _controls[param] = ac;
-
- cerr << _name << ": added parameter " << param.to_string() << endl;
+ boost::shared_ptr<AutomationList> al = boost::dynamic_pointer_cast<AutomationList> (ac->list ());
+ assert (al);
- _can_automate_list.insert(param);
+ al->automation_state_changed.connect_same_thread (
+ _list_connections, boost::bind (&Automatable::automation_list_automation_state_changed, this, ac->parameter(), _1)
+ );
- // Sync everything (derived classes) up to initial values
- auto_state_changed(param);
-}
-
-void
-Automatable::what_has_automation (set<ParamID>& s) const
-{
- Glib::Mutex::Lock lm (_automation_lock);
- Controls::const_iterator li;
-
- // FIXME: correct semantics?
- for (li = _controls.begin(); li != _controls.end(); ++li) {
- s.insert ((*li).first);
- }
-}
+ ControlSet::add_control (ac);
+ _can_automate_list.insert (param);
-void
-Automatable::what_has_visible_automation (set<ParamID>& s) const
-{
- Glib::Mutex::Lock lm (_automation_lock);
- set<ParamID>::const_iterator li;
-
- for (li = _visible_controls.begin(); li != _visible_controls.end(); ++li) {
- s.insert (*li);
- }
+ automation_list_automation_state_changed (param, al->automation_state ()); // sync everything up
}
-/** Returns NULL if we don't have an AutomationList for \a parameter.
- */
-boost::shared_ptr<AutomationControl>
-Automatable::control (ParamID parameter, bool create_if_missing)
-{
- Controls::iterator i = _controls.find(parameter);
-
- if (i != _controls.end()) {
- return i->second;
-
- } else if (create_if_missing) {
- boost::shared_ptr<AutomationList> al (new AutomationList (
- parameter, FLT_MIN, FLT_MAX, default_parameter_value (parameter)));
- boost::shared_ptr<AutomationControl> ac (new AutomationControl(_session, al));
- add_control(ac);
- cerr << "WARNING: Default AutomationControl created for " << parameter.to_string() << endl;
- return ac;
-
- } else {
- //warning << "AutomationList " << parameter.to_string() << " not found for " << _name << endmsg;
- return boost::shared_ptr<AutomationControl>();
- }
-}
-
-boost::shared_ptr<const AutomationControl>
-Automatable::control (ParamID parameter) const
-{
- Controls::const_iterator i = _controls.find(parameter);
-
- if (i != _controls.end()) {
- return i->second;
- } else {
- //warning << "AutomationList " << parameter.to_string() << " not found for " << _name << endmsg;
- return boost::shared_ptr<AutomationControl>();
- }
-}
-
-
string
-Automatable::describe_parameter (ParamID param)
+Automatable::describe_parameter (Evoral::Parameter param)
{
/* derived classes like PluginInsert should override this */
- if (param == ParamID(GainAutomation))
+ if (param == Evoral::Parameter(GainAutomation)) {
return _("Fader");
- else if (param.type() == PanAutomation)
- return (string_compose(_("Pan %1"), param.id()));
- else if (param.type() == MidiCCAutomation)
- return string_compose("CC %1", param.id());
- else
- return param.to_string();
-}
-
-void
-Automatable::can_automate (ParamID what)
-{
- _can_automate_list.insert (what);
-}
-
-void
-Automatable::mark_automation_visible (ParamID what, bool yn)
-{
- if (yn) {
- _visible_controls.insert (what);
+ } else if (param.type() == MidiCCAutomation) {
+ return string_compose("%1: %2 [%3]",
+ param.id(), midi_name(param.id()), int(param.channel()) + 1);
+ } else if (param.type() == MidiPgmChangeAutomation) {
+ return string_compose("Program [%1]", int(param.channel()) + 1);
+ } else if (param.type() == MidiPitchBenderAutomation) {
+ return string_compose("Bender [%1]", int(param.channel()) + 1);
+ } else if (param.type() == MidiChannelPressureAutomation) {
+ return string_compose("Pressure [%1]", int(param.channel()) + 1);
} else {
- set<ParamID>::iterator i;
-
- if ((i = _visible_controls.find (what)) != _visible_controls.end()) {
- _visible_controls.erase (i);
- }
+ return EventTypeMap::instance().to_symbol(param);
}
}
-bool
-Automatable::find_next_event (nframes_t now, nframes_t end, ControlEvent& next_event) const
+void
+Automatable::can_automate (Evoral::Parameter what)
{
- Controls::const_iterator li;
- AutomationList::TimeComparator cmp;
-
- next_event.when = max_frames;
-
- for (li = _controls.begin(); li != _controls.end(); ++li) {
-
- AutomationList::const_iterator i;
- boost::shared_ptr<const AutomationList> alist (li->second->list());
- ControlEvent cp (now, 0.0f);
-
- for (i = lower_bound (alist->const_begin(), alist->const_end(), &cp, cmp); i != alist->const_end() && (*i)->when < end; ++i) {
- if ((*i)->when > now) {
- break;
- }
- }
-
- if (i != alist->const_end() && (*i)->when < end) {
-
- if ((*i)->when < next_event.when) {
- next_event.when = (*i)->when;
- }
- }
- }
-
- return next_event.when != max_frames;
+ _can_automate_list.insert (what);
}
/** \a legacy_param is used for loading legacy sessions where an object (IO, Panner)
* pass that type and it will be used for the untyped AutomationList found.
*/
int
-Automatable::set_automation_state (const XMLNode& node, ParamID legacy_param)
-{
- Glib::Mutex::Lock lm (_automation_lock);
+Automatable::set_automation_xml_state (const XMLNode& node, Evoral::Parameter legacy_param)
+{
+ Glib::Mutex::Lock lm (control_lock());
/* Don't clear controls, since some may be special derived Controllable classes */
- _visible_controls.clear ();
-
XMLNodeList nlist = node.children();
XMLNodeIterator niter;
-
+
for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
/*if (sscanf ((*niter)->name().c_str(), "parameter-%" PRIu32, ¶m) != 1) {
const XMLProperty* id_prop = (*niter)->property("automation-id");
- ParamID param = (id_prop ? ParamID(id_prop->value()) : legacy_param);
-
- boost::shared_ptr<AutomationList> al (new AutomationList(**niter, param));
-
+ Evoral::Parameter param = (id_prop
+ ? EventTypeMap::instance().new_parameter(id_prop->value())
+ : legacy_param);
+
+ if (param.type() == NullAutomation) {
+ warning << "Automation has null type" << endl;
+ continue;
+ }
+
if (!id_prop) {
warning << "AutomationList node without automation-id property, "
- << "using default: " << legacy_param.to_string() << endmsg;
- al->set_param_id(legacy_param);
+ << "using default: " << EventTypeMap::instance().to_symbol(legacy_param) << endmsg;
}
- boost::shared_ptr<AutomationControl> existing = control(param);
- if (existing)
- existing->set_list(al);
- else
- add_control(boost::shared_ptr<AutomationControl>(new AutomationControl(_session, al)));
+ boost::shared_ptr<AutomationControl> existing = automation_control (param);
+
+ if (existing) {
+ existing->alist()->set_state (**niter, 3000);
+ } else {
+ boost::shared_ptr<Evoral::Control> newcontrol = control_factory(param);
+ add_control (newcontrol);
+ boost::shared_ptr<AutomationList> al (new AutomationList(**niter, param));
+ newcontrol->set_list(al);
+ }
} else {
- error << "Expected AutomationList node, got '" << (*niter)->name() << endmsg;
+ error << "Expected AutomationList node, got '" << (*niter)->name() << "'" << endmsg;
}
}
}
XMLNode&
-Automatable::get_automation_state ()
+Automatable::get_automation_xml_state ()
{
- Glib::Mutex::Lock lm (_automation_lock);
- XMLNode* node = new XMLNode (X_("Automation"));
-
- if (_controls.empty()) {
+ Glib::Mutex::Lock lm (control_lock());
+ XMLNode* node = new XMLNode (Automatable::xml_node_name);
+
+ if (controls().empty()) {
return *node;
}
- for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li) {
- node->add_child_nocopy (li->second->list()->get_state ());
+ for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
+ boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(li->second->list());
+ if (!l->empty()) {
+ node->add_child_nocopy (l->get_state ());
+ }
}
return *node;
}
void
-Automatable::clear_automation ()
+Automatable::set_parameter_automation_state (Evoral::Parameter param, AutoState s)
{
- Glib::Mutex::Lock lm (_automation_lock);
+ Glib::Mutex::Lock lm (control_lock());
- for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
- li->second->list()->clear();
-}
-
-void
-Automatable::set_parameter_automation_state (ParamID param, AutoState s)
-{
- Glib::Mutex::Lock lm (_automation_lock);
-
- boost::shared_ptr<AutomationControl> c = control (param, true);
+ boost::shared_ptr<Evoral::Control> c = control (param, true);
+ boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
- if (s != c->list()->automation_state()) {
- c->list()->set_automation_state (s);
- _session.set_dirty ();
+ if (s != l->automation_state()) {
+ l->set_automation_state (s);
+ _a_session.set_dirty ();
}
}
AutoState
-Automatable::get_parameter_automation_state (ParamID param, bool lock)
+Automatable::get_parameter_automation_state (Evoral::Parameter param)
{
AutoState result = Off;
- if (lock)
- _automation_lock.lock();
+ boost::shared_ptr<Evoral::Control> c = control(param);
+ boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
- boost::shared_ptr<AutomationControl> c = control(param);
-
- if (c)
- result = c->list()->automation_state();
-
- if (lock)
- _automation_lock.unlock();
+ if (c) {
+ result = l->automation_state();
+ }
return result;
}
void
-Automatable::set_parameter_automation_style (ParamID param, AutoStyle s)
+Automatable::set_parameter_automation_style (Evoral::Parameter param, AutoStyle s)
{
- Glib::Mutex::Lock lm (_automation_lock);
-
- boost::shared_ptr<AutomationControl> c = control(param, true);
+ Glib::Mutex::Lock lm (control_lock());
+
+ boost::shared_ptr<Evoral::Control> c = control(param, true);
+ boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
- if (s != c->list()->automation_style()) {
- c->list()->set_automation_style (s);
- _session.set_dirty ();
+ if (s != l->automation_style()) {
+ l->set_automation_style (s);
+ _a_session.set_dirty ();
}
}
AutoStyle
-Automatable::get_parameter_automation_style (ParamID param)
+Automatable::get_parameter_automation_style (Evoral::Parameter param)
{
- Glib::Mutex::Lock lm (_automation_lock);
+ Glib::Mutex::Lock lm (control_lock());
- boost::shared_ptr<AutomationControl> c = control(param);
+ boost::shared_ptr<Evoral::Control> c = control(param);
+ boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
if (c) {
- return c->list()->automation_style();
+ return l->automation_style();
} else {
return Absolute; // whatever
}
void
Automatable::protect_automation ()
{
- set<ParamID> automated_params;
+ typedef set<Evoral::Parameter> ParameterSet;
+ const ParameterSet& automated_params = what_can_be_automated ();
- what_has_automation (automated_params);
+ for (ParameterSet::const_iterator i = automated_params.begin(); i != automated_params.end(); ++i) {
- for (set<ParamID>::iterator i = automated_params.begin(); i != automated_params.end(); ++i) {
+ boost::shared_ptr<Evoral::Control> c = control(*i);
+ boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
- boost::shared_ptr<AutomationControl> c = control(*i);
-
- switch (c->list()->automation_state()) {
+ switch (l->automation_state()) {
case Write:
- c->list()->set_automation_state (Off);
+ l->set_automation_state (Off);
break;
case Touch:
- c->list()->set_automation_state (Play);
+ l->set_automation_state (Play);
break;
default:
break;
}
void
-Automatable::automation_snapshot (nframes_t now)
+Automatable::automation_snapshot (framepos_t now, bool force)
{
- if (_last_automation_snapshot > now || (now - _last_automation_snapshot) > _session.automation_interval()) {
+ if (force || _last_automation_snapshot > now || (now - _last_automation_snapshot) > _automation_interval) {
- for (Controls::iterator i = _controls.begin(); i != _controls.end(); ++i) {
- if (i->second->list()->automation_write()) {
- i->second->list()->rt_add (now, i->second->user_value());
+ for (Controls::iterator i = controls().begin(); i != controls().end(); ++i) {
+ boost::shared_ptr<AutomationControl> c
+ = boost::dynamic_pointer_cast<AutomationControl>(i->second);
+ if (_a_session.transport_rolling() && c->automation_write()) {
+ c->list()->rt_add (now, i->second->user_double());
}
}
-
+
_last_automation_snapshot = now;
}
}
void
-Automatable::transport_stopped (nframes_t now)
+Automatable::transport_stopped (framepos_t now)
{
- for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li) {
-
- boost::shared_ptr<AutomationControl> c = li->second;
-
- c->list()->reposition_for_rt_add (now);
-
- if (c->list()->automation_state() != Off) {
- c->set_value(c->list()->eval(now));
+ for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
+
+ boost::shared_ptr<AutomationControl> c
+ = boost::dynamic_pointer_cast<AutomationControl>(li->second);
+ if (c) {
+ boost::shared_ptr<AutomationList> l
+ = boost::dynamic_pointer_cast<AutomationList>(c->list());
+
+ if (l) {
+ /* Stop any active touch gesture just before we mark the write pass
+ as finished. If we don't do this, the transport can end up stopped with
+ an AutomationList thinking that a touch is still in progress and,
+ when the transport is re-started, a touch will magically
+ be happening without it ever have being started in the usual way.
+ */
+ l->stop_touch (true, now);
+ l->write_pass_finished (now);
+
+ if (l->automation_playback()) {
+ c->set_value(c->list()->eval(now));
+ }
+
+ if (l->automation_state() == Write) {
+ l->set_automation_state (Touch);
+ }
+ }
+ }
+ }
+}
+
+boost::shared_ptr<Evoral::Control>
+Automatable::control_factory(const Evoral::Parameter& param)
+{
+ boost::shared_ptr<AutomationList> list(new AutomationList(param));
+ Evoral::Control* control = NULL;
+ if (param.type() >= MidiCCAutomation && param.type() <= MidiChannelPressureAutomation) {
+ MidiTrack* mt = dynamic_cast<MidiTrack*>(this);
+ if (mt) {
+ control = new MidiTrack::MidiControl(mt, param);
+ } else {
+ warning << "MidiCCAutomation for non-MidiTrack" << endl;
+ }
+ } else if (param.type() == PluginAutomation) {
+ PluginInsert* pi = dynamic_cast<PluginInsert*>(this);
+ if (pi) {
+ control = new PluginInsert::PluginControl(pi, param);
+ } else {
+ warning << "PluginAutomation for non-Plugin" << endl;
+ }
+ } else if (param.type() == GainAutomation) {
+ Amp* amp = dynamic_cast<Amp*>(this);
+ if (amp) {
+ control = new Amp::GainControl(X_("gaincontrol"), _a_session, amp, param);
+ } else {
+ warning << "GainAutomation for non-Amp" << endl;
+ }
+ } else if (param.type() == PanAzimuthAutomation || param.type() == PanWidthAutomation || param.type() == PanElevationAutomation) {
+ Pannable* pannable = dynamic_cast<Pannable*>(this);
+ if (pannable) {
+ control = new PanControllable (_a_session, pannable->describe_parameter (param), pannable, param);
+ } else {
+ warning << "PanAutomation for non-Pannable" << endl;
}
}
+
+ if (!control) {
+ control = new AutomationControl(_a_session, param);
+ }
+
+ control->set_list(list);
+ return boost::shared_ptr<Evoral::Control>(control);
}
+boost::shared_ptr<AutomationControl>
+Automatable::automation_control (const Evoral::Parameter& id, bool create)
+{
+ return boost::dynamic_pointer_cast<AutomationControl>(Evoral::ControlSet::control(id, create));
+}
+
+boost::shared_ptr<const AutomationControl>
+Automatable::automation_control (const Evoral::Parameter& id) const
+{
+ return boost::dynamic_pointer_cast<const AutomationControl>(Evoral::ControlSet::control(id));
+}
+
+void
+Automatable::clear_controls ()
+{
+ _control_connections.drop_connections ();
+ ControlSet::clear_controls ();
+}
+
+string
+Automatable::value_as_string (boost::shared_ptr<AutomationControl> ac) const
+{
+ std::stringstream s;
+
+ /* this is a the default fallback for this virtual method. Derived Automatables
+ are free to override this to display the values of their parameters/controls
+ in different ways.
+ */
+
+ // Hack to display CC as integer value, rather than double
+ if (ac->parameter().type() == MidiCCAutomation) {
+ s << lrint (ac->get_value());
+ } else {
+ s << std::fixed << std::setprecision(3) << ac->get_value();
+ }
+
+ return s.str ();
+}