Optimize plugin-processing for non-automated params
[ardour.git] / libs / ardour / automatable.cc
index 906ff4ed3ee2ad7b7a0a316a2293f3aaeab66d89..51a58ce94293f10b4e00e60827c8556d35f7c061 100644 (file)
 
 */
 
-#include <fstream>
 #include <cstdio>
 #include <errno.h>
 
+#include "pbd/gstdio_compat.h"
 #include <glibmm/miscutils.h>
 
 #include "pbd/error.h"
 #include "ardour/amp.h"
 #include "ardour/automatable.h"
 #include "ardour/event_type_map.h"
+#include "ardour/gain_control.h"
+#include "ardour/monitor_control.h"
 #include "ardour/midi_track.h"
 #include "ardour/pan_controllable.h"
 #include "ardour/pannable.h"
 #include "ardour/plugin.h"
 #include "ardour/plugin_insert.h"
+#include "ardour/record_enable_control.h"
 #include "ardour/session.h"
+#ifdef LV2_SUPPORT
 #include "ardour/uri_map.h"
+#endif
 #include "ardour/value_as_string.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+/* used for templates (previously: !full_state) */
+bool Automatable::skip_saving_automation = false;
+
 const string Automatable::xml_node_name = X_("Automation");
 
 Automatable::Automatable(Session& session)
        : _a_session(session)
+       , _automated_controls (new ControlList)
 {
 }
 
 Automatable::Automatable (const Automatable& other)
-        : ControlSet (other)
-        , _a_session (other._a_session)
+       : ControlSet (other)
+       , Slavable ()
+       , _a_session (other._a_session)
+       , _automated_controls (new ControlList)
 {
         Glib::Threads::Mutex::Lock lm (other._control_lock);
 
@@ -65,18 +76,22 @@ Automatable::Automatable (const Automatable& other)
 Automatable::~Automatable ()
 {
        {
-               Glib::Threads::Mutex::Lock lm (_control_lock);
-               
-               for (Controls::const_iterator li = _controls.begin(); li != _controls.end(); ++li) {
-                       boost::dynamic_pointer_cast<AutomationControl>(li->second)->drop_references ();
-               }
+               RCUWriter<ControlList> writer (_automated_controls);
+               boost::shared_ptr<ControlList> cl = writer.get_copy ();
+               cl->clear ();
+       }
+       _automated_controls.flush ();
+
+       Glib::Threads::Mutex::Lock lm (_control_lock);
+       for (Controls::const_iterator li = _controls.begin(); li != _controls.end(); ++li) {
+               boost::dynamic_pointer_cast<AutomationControl>(li->second)->drop_references ();
        }
 }
 
 int
 Automatable::old_set_automation_state (const XMLNode& node)
 {
-       const XMLProperty *prop;
+       XMLProperty const * prop;
 
        if ((prop = node.property ("path")) != 0) {
                load_automation (prop->value());
@@ -98,7 +113,8 @@ Automatable::load_automation (const string& path)
                fullpath = _a_session.automation_dir();
                fullpath += path;
        }
-       ifstream in (fullpath.c_str());
+
+       FILE * in = g_fopen (fullpath.c_str (), "rb");
 
        if (!in) {
                warning << string_compose(_("cannot open %2 to load automation data (%3)")
@@ -110,14 +126,17 @@ Automatable::load_automation (const string& path)
        set<Evoral::Parameter> tosave;
        controls().clear ();
 
-       while (in) {
+       while (!feof(in)) {
                double when;
                double value;
                uint32_t port;
 
-               in >> port;  if (!in) break;
-               in >> when;  if (!in) goto bad;
-               in >> value; if (!in) goto bad;
+               if (3 != fscanf (in, "%d %lf %lf", &port, &when, &value)) {
+                       if (feof(in)) {
+                               break;
+                       }
+                       goto bad;
+               }
 
                Evoral::Parameter param(PluginAutomation, 0, port);
                /* FIXME: this is legacy and only used for plugin inserts?  I think? */
@@ -125,12 +144,14 @@ Automatable::load_automation (const string& path)
                c->list()->add (when, value);
                tosave.insert (param);
        }
+       ::fclose (in);
 
        return 0;
 
   bad:
        error << string_compose(_("cannot load automation data from %2"), fullpath) << endmsg;
        controls().clear ();
+       ::fclose (in);
        return -1;
 }
 
@@ -141,7 +162,9 @@ Automatable::add_control(boost::shared_ptr<Evoral::Control> ac)
 
        boost::shared_ptr<AutomationList> al = boost::dynamic_pointer_cast<AutomationList> (ac->list ());
 
-       if (al) {
+       boost::shared_ptr<AutomationControl> actl (boost::dynamic_pointer_cast<AutomationControl> (ac));
+
+       if ((!actl || !(actl->flags() & Controllable::NotAutomatable)) && al) {
                al->automation_state_changed.connect_same_thread (
                        _list_connections,
                        boost::bind (&Automatable::automation_list_automation_state_changed,
@@ -150,7 +173,7 @@ Automatable::add_control(boost::shared_ptr<Evoral::Control> ac)
 
        ControlSet::add_control (ac);
 
-       if (al) {
+       if ((!actl || !(actl->flags() & Controllable::NotAutomatable)) && al) {
                _can_automate_list.insert (param);
                automation_list_automation_state_changed (param, al->automation_state ()); // sync everything up
        }
@@ -163,6 +186,8 @@ Automatable::describe_parameter (Evoral::Parameter param)
 
        if (param == Evoral::Parameter(GainAutomation)) {
                return _("Fader");
+       } else if (param.type() == TrimAutomation) {
+               return _("Trim");
        } else if (param.type() == MuteAutomation) {
                return _("Mute");
        } else if (param.type() == MidiCCAutomation) {
@@ -173,8 +198,12 @@ Automatable::describe_parameter (Evoral::Parameter param)
                return string_compose("Bender [%1]", int(param.channel()) + 1);
        } else if (param.type() == MidiChannelPressureAutomation) {
                return string_compose("Pressure [%1]", int(param.channel()) + 1);
+       } else if (param.type() == MidiNotePressureAutomation) {
+               return string_compose("PolyPressure [%1]", int(param.channel()) + 1);
+#ifdef LV2_SUPPORT
        } else if (param.type() == PluginPropertyAutomation) {
                return string_compose("Property %1", URIMap::instance().id_to_uri(param.id()));
+#endif
        } else {
                return EventTypeMap::instance().to_symbol(param);
        }
@@ -209,22 +238,35 @@ Automatable::set_automation_xml_state (const XMLNode& node, Evoral::Parameter le
 
                if ((*niter)->name() == "AutomationList") {
 
-                       const XMLProperty* id_prop = (*niter)->property("automation-id");
+                       XMLProperty const * id_prop = (*niter)->property("automation-id");
 
                        Evoral::Parameter param = (id_prop
-                                       ? EventTypeMap::instance().new_parameter(id_prop->value())
+                                       ? EventTypeMap::instance().from_symbol(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: " << EventTypeMap::instance().to_symbol(legacy_param) << endmsg;
                        }
 
+                       if (_can_automate_list.find (param) == _can_automate_list.end ()) {
+                               boost::shared_ptr<AutomationControl> actl = automation_control (param);
+                               if (actl && (*niter)->children().size() > 0 && Config->get_limit_n_automatables () > 0) {
+                                       actl->set_flags (Controllable::Flag ((int)actl->flags() & ~Controllable::NotAutomatable));
+                                       can_automate (param);
+                                       info << "Marked parmater as automatable" << endl;
+                               } else {
+                                       warning << "Ignored automation data for non-automatable parameter" << endl;
+                                       continue;
+                               }
+                       }
+
+
                        boost::shared_ptr<AutomationControl> existing = automation_control (param);
 
                        if (existing) {
@@ -256,7 +298,7 @@ Automatable::get_automation_xml_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 && !l->empty()) {
+               if (l) {
                        node->add_child_nocopy (l->get_state ());
                }
        }
@@ -274,6 +316,7 @@ Automatable::set_parameter_automation_state (Evoral::Parameter param, AutoState
        if (c && (s != c->automation_state())) {
                c->set_automation_state (s);
                _a_session.set_dirty ();
+               AutomationStateChanged(); /* Emit signal */
        }
 }
 
@@ -283,7 +326,7 @@ Automatable::get_parameter_automation_state (Evoral::Parameter param)
        AutoState result = Off;
 
        boost::shared_ptr<AutomationControl> c = automation_control(param);
-       
+
        if (c) {
                result = c->automation_state();
        }
@@ -291,34 +334,6 @@ Automatable::get_parameter_automation_state (Evoral::Parameter param)
        return result;
 }
 
-void
-Automatable::set_parameter_automation_style (Evoral::Parameter param, AutoStyle s)
-{
-       Glib::Threads::Mutex::Lock lm (control_lock());
-
-       boost::shared_ptr<AutomationControl> c = automation_control(param, true);
-
-       if (c && (s != c->automation_style())) {
-               c->set_automation_style (s);
-               _a_session.set_dirty ();
-       }
-}
-
-AutoStyle
-Automatable::get_parameter_automation_style (Evoral::Parameter param)
-{
-       Glib::Threads::Mutex::Lock lm (control_lock());
-
-       boost::shared_ptr<Evoral::Control> c = control(param);
-       boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(c->list());
-
-       if (c) {
-               return l->automation_style();
-       } else {
-               return Absolute; // whatever
-       }
-}
-
 void
 Automatable::protect_automation ()
 {
@@ -334,6 +349,8 @@ Automatable::protect_automation ()
                case Write:
                        l->set_automation_state (Off);
                        break;
+               case Latch:
+                       /* fall through */
                case Touch:
                        l->set_automation_state (Play);
                        break;
@@ -344,25 +361,53 @@ Automatable::protect_automation ()
 }
 
 void
-Automatable::transport_located (framepos_t now)
+Automatable::non_realtime_locate (samplepos_t now)
 {
+       bool rolling = _a_session.transport_rolling ();
+
        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::shared_ptr<AutomationList> l
                                = boost::dynamic_pointer_cast<AutomationList>(c->list());
 
-                       if (l) {
-                               l->start_write_pass (now);
+                       if (!l) {
+                               continue;
+                       }
+
+                       bool am_touching = c->touching ();
+                       if (rolling && am_touching) {
+                       /* when locating while rolling, and writing automation,
+                        * start a new write pass.
+                        * compare to compare to non_realtime_transport_stop()
+                        */
+                               const bool list_did_write = !l->in_new_write_pass ();
+                               c->stop_touch (-1); // time is irrelevant
+                               l->stop_touch (-1);
+                               c->commit_transaction (list_did_write);
+                               l->write_pass_finished (now, Config->get_automation_thinning_factor ());
+
+                               if (l->automation_state () == Write) {
+                                       l->set_automation_state (Touch);
+                               }
+                               if (l->automation_playback ()) {
+                                       c->set_value_unchecked (c->list ()->eval (now));
+                               }
+                       }
+
+                       l->start_write_pass (now);
+
+                       if (rolling && am_touching) {
+                               c->start_touch (now);
                        }
                }
        }
 }
 
 void
-Automatable::transport_stopped (framepos_t now)
+Automatable::non_realtime_transport_stop (samplepos_t now, bool /*flush_processors*/)
 {
        for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
                boost::shared_ptr<AutomationControl> c =
@@ -383,32 +428,88 @@ Automatable::transport_stopped (framepos_t now)
                   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, Config->get_automation_thinning_factor());
+               const bool list_did_write = !l->in_new_write_pass ();
 
-               if (l->automation_playback()) {
-                       c->set_value(c->list()->eval(now));
-               }
+               c->stop_touch (now);
+               l->stop_touch (now);
 
-               if (l->automation_state() == Write) {
+               c->commit_transaction (list_did_write);
+
+               l->write_pass_finished (now, Config->get_automation_thinning_factor ());
+
+               if (l->automation_state () == Write) {
                        l->set_automation_state (Touch);
                }
+
+               if (l->automation_playback ()) {
+                       c->set_value_unchecked (c->list ()->eval (now));
+               }
+       }
+}
+
+void
+Automatable::automation_run (samplepos_t start, pframes_t nframes, bool only_active)
+{
+       if (only_active) {
+               boost::shared_ptr<ControlList> cl = _automated_controls.reader ();
+               for (ControlList::const_iterator ci = cl->begin(); ci != cl->end(); ++ci) {
+                       (*ci)->automation_run (start, nframes);
+               }
+               return;
+       }
+
+       for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
+               boost::shared_ptr<AutomationControl> c =
+                       boost::dynamic_pointer_cast<AutomationControl>(li->second);
+               if (!c) {
+                       continue;
+               }
+               c->automation_run (start, nframes);
+       }
+}
+
+void
+Automatable::automation_list_automation_state_changed (Evoral::Parameter param, AutoState as)
+{
+       {
+               boost::shared_ptr<AutomationControl> c (automation_control(param));
+               assert (c && c->list());
+
+               RCUWriter<ControlList> writer (_automated_controls);
+               boost::shared_ptr<ControlList> cl = writer.get_copy ();
+
+               ControlList::const_iterator fi = std::find (cl->begin(), cl->end(), c);
+               if (fi != cl->end()) {
+                       cl->erase (fi);
+               }
+               switch (as) {
+                       /* all potential  automation_playback() states */
+                       case Play:
+                       case Touch:
+                       case Latch:
+                               cl->push_back (c);
+                               break;
+                       case Off:
+                       case Write:
+                               break;
+               }
        }
+       _automated_controls.flush();
 }
 
 boost::shared_ptr<Evoral::Control>
 Automatable::control_factory(const Evoral::Parameter& param)
 {
-       boost::shared_ptr<AutomationList> list(new AutomationList(param));
-       Evoral::Control* control = NULL;
-       ParameterDescriptor desc(param);
+       Evoral::Control*                  control   = NULL;
+       bool                              make_list = true;
+       ParameterDescriptor               desc(param);
+       boost::shared_ptr<AutomationList> list;
+
        if (param.type() >= MidiCCAutomation && param.type() <= MidiChannelPressureAutomation) {
                MidiTrack* mt = dynamic_cast<MidiTrack*>(this);
                if (mt) {
                        control = new MidiTrack::MidiControl(mt, param);
-                       list.reset();  // No list, this is region "automation"
-               } else {
-                       warning << "MidiCCAutomation for non-MidiTrack" << endl;
+                       make_list = false;  // No list, this is region "automation"
                }
        } else if (param.type() == PluginAutomation) {
                PluginInsert* pi = dynamic_cast<PluginInsert*>(this);
@@ -424,7 +525,9 @@ Automatable::control_factory(const Evoral::Parameter& param)
                        desc = pi->plugin(0)->get_property_descriptor(param.id());
                        if (desc.datatype != Variant::NOTHING) {
                                if (!Variant::type_is_numeric(desc.datatype)) {
-                                       list.reset();  // Can't automate non-numeric data yet
+                                       make_list = false;  // Can't automate non-numeric data yet
+                               } else {
+                                       list = boost::shared_ptr<AutomationList>(new AutomationList(param, desc));
                                }
                                control = new PluginInsert::PluginPropertyControl(pi, param, desc, list);
                        }
@@ -432,12 +535,9 @@ Automatable::control_factory(const Evoral::Parameter& param)
                        warning << "PluginPropertyAutomation 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;
-               }
+               control = new GainControl(_a_session, param);
+       } else if (param.type() == TrimAutomation) {
+               control = new GainControl(_a_session, param);
        } else if (param.type() == PanAzimuthAutomation || param.type() == PanWidthAutomation || param.type() == PanElevationAutomation) {
                Pannable* pannable = dynamic_cast<Pannable*>(this);
                if (pannable) {
@@ -445,16 +545,55 @@ Automatable::control_factory(const Evoral::Parameter& param)
                } else {
                        warning << "PanAutomation for non-Pannable" << endl;
                }
+       } else if (param.type() == RecEnableAutomation) {
+               Recordable* re = dynamic_cast<Recordable*> (this);
+               if (re) {
+                       control = new RecordEnableControl (_a_session, X_("recenable"), *re);
+               }
+       } else if (param.type() == MonitoringAutomation) {
+               Monitorable* m = dynamic_cast<Monitorable*>(this);
+               if (m) {
+                       control = new MonitorControl (_a_session, X_("monitor"), *m);
+               }
+       } else if (param.type() == SoloAutomation) {
+               Soloable* s = dynamic_cast<Soloable*>(this);
+               Muteable* m = dynamic_cast<Muteable*>(this);
+               if (s && m) {
+                       control = new SoloControl (_a_session, X_("solo"), *s, *m);
+               }
+       } else if (param.type() == MuteAutomation) {
+               Muteable* m = dynamic_cast<Muteable*>(this);
+               if (m) {
+                       control = new MuteControl (_a_session, X_("mute"), *m);
+               }
+       }
+
+       if (make_list && !list) {
+               list = boost::shared_ptr<AutomationList>(new AutomationList(param, desc));
        }
 
        if (!control) {
-               control = new AutomationControl(_a_session, param, desc);
+               control = new AutomationControl(_a_session, param, desc, list);
        }
 
-       control->set_list(list);
        return boost::shared_ptr<Evoral::Control>(control);
 }
 
+boost::shared_ptr<AutomationControl>
+Automatable::automation_control (PBD::ID const & id) const
+{
+       Controls::const_iterator li;
+
+       for (li = _controls.begin(); li != _controls.end(); ++li) {
+               boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (li->second);
+               if (ac && (ac->id() == id)) {
+                       return ac;
+               }
+       }
+
+       return boost::shared_ptr<AutomationControl>();
+}
+
 boost::shared_ptr<AutomationControl>
 Automatable::automation_control (const Evoral::Parameter& id, bool create)
 {
@@ -474,8 +613,48 @@ Automatable::clear_controls ()
        ControlSet::clear_controls ();
 }
 
-string
-Automatable::value_as_string (boost::shared_ptr<AutomationControl> ac) const
+bool
+Automatable::find_next_event (double now, double end, Evoral::ControlEvent& next_event, bool only_active) const
 {
-       return ARDOUR::value_as_string(ac->desc(), ac->get_value());
+       Controls::const_iterator li;
+
+       next_event.when = std::numeric_limits<double>::max();
+
+       for (li = _controls.begin(); li != _controls.end(); ++li) {
+               boost::shared_ptr<AutomationControl> c
+                       = boost::dynamic_pointer_cast<AutomationControl>(li->second);
+
+               if (only_active && (!c || !c->automation_playback())) {
+                       continue;
+               }
+
+               boost::shared_ptr<SlavableAutomationControl> sc
+                       = boost::dynamic_pointer_cast<SlavableAutomationControl>(li->second);
+
+               if (sc) {
+                       sc->find_next_event (now, end, next_event);
+               }
+
+               Evoral::ControlList::const_iterator i;
+               boost::shared_ptr<const Evoral::ControlList> alist (li->second->list());
+               Evoral::ControlEvent cp (now, 0.0f);
+               if (!alist) {
+                       continue;
+               }
+
+               for (i = lower_bound (alist->begin(), alist->end(), &cp, Evoral::ControlList::time_comparator);
+                    i != alist->end() && (*i)->when < end; ++i) {
+                       if ((*i)->when > now) {
+                               break;
+                       }
+               }
+
+               if (i != alist->end() && (*i)->when < end) {
+                       if ((*i)->when < next_event.when) {
+                               next_event.when = (*i)->when;
+                       }
+               }
+       }
+
+       return next_event.when != std::numeric_limits<double>::max();
 }