initial pass at session-renaming functionality
[ardour.git] / libs / ardour / automatable.cc
index 03e5ad97c31e7d511222931fb86e24a3085652d5..6d8114939de2c3d8130aa5ae112575cdf4b9bd8c 100644 (file)
@@ -35,7 +35,9 @@
 #include "ardour/amp.h"
 #include "ardour/event_type_map.h"
 #include "ardour/midi_track.h"
+#include "ardour/pannable.h"
 #include "ardour/panner.h"
+#include "ardour/pan_controllable.h"
 #include "ardour/plugin_insert.h"
 #include "ardour/session.h"
 
@@ -46,6 +48,7 @@ using namespace ARDOUR;
 using namespace PBD;
 
 framecnt_t Automatable::_automation_interval = 0;
+const string Automatable::xml_node_name = X_("Automation");
 
 Automatable::Automatable(Session& session)
        : _a_session(session)
@@ -76,22 +79,6 @@ Automatable::old_set_automation_state (const XMLNode& node)
                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 (Evoral::Parameter(PluginAutomation, 0, what), true);
-               }
-       }
-
        _last_automation_snapshot = 0;
 
        return 0;
@@ -153,7 +140,7 @@ Automatable::add_control(boost::shared_ptr<Evoral::Control> ac)
 
        boost::shared_ptr<AutomationList> al = boost::dynamic_pointer_cast<AutomationList> (ac->list ());
        assert (al);
-       
+
        al->automation_state_changed.connect_same_thread (
                _list_connections, boost::bind (&Automatable::automation_list_automation_state_changed, this, ac->parameter(), _1)
                );
@@ -164,17 +151,6 @@ Automatable::add_control(boost::shared_ptr<Evoral::Control> ac)
        automation_list_automation_state_changed (param, al->automation_state ()); // sync everything up
 }
 
-void
-Automatable::what_has_visible_data(set<Evoral::Parameter>& s) const
-{
-       Glib::Mutex::Lock lm (control_lock());
-       set<Evoral::Parameter>::const_iterator li;
-
-       for (li = _visible_controls.begin(); li != _visible_controls.end(); ++li) {
-               s.insert  (*li);
-       }
-}
-
 string
 Automatable::describe_parameter (Evoral::Parameter param)
 {
@@ -182,12 +158,9 @@ Automatable::describe_parameter (Evoral::Parameter param)
 
        if (param == Evoral::Parameter(GainAutomation)) {
                return _("Fader");
-       } else if (param.type() == PanAutomation) {
-               /* ID's are zero-based, present them as 1-based */
-               return (string_compose(_("Pan %1"), param.id() + 1));
        } else if (param.type() == MidiCCAutomation) {
                return string_compose("%1: %2 [%3]",
-                               param.id() + 1, midi_name(param.id()), int(param.channel()) + 1);
+                               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) {
@@ -205,20 +178,6 @@ Automatable::can_automate (Evoral::Parameter what)
        _can_automate_list.insert (what);
 }
 
-void
-Automatable::mark_automation_visible (Evoral::Parameter what, bool yn)
-{
-       if (yn) {
-               _visible_controls.insert (what);
-       } else {
-               set<Evoral::Parameter>::iterator i;
-
-               if ((i = _visible_controls.find (what)) != _visible_controls.end()) {
-                       _visible_controls.erase (i);
-               }
-       }
-}
-
 /** \a legacy_param is used for loading legacy sessions where an object (IO, Panner)
  * had a single automation parameter, with it's type implicit.  Derived objects should
  * pass that type and it will be used for the untyped AutomationList found.
@@ -230,8 +189,6 @@ Automatable::set_automation_xml_state (const XMLNode& node, Evoral::Parameter le
 
        /* Don't clear controls, since some may be special derived Controllable classes */
 
-       _visible_controls.clear ();
-
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
 
@@ -255,19 +212,19 @@ Automatable::set_automation_xml_state (const XMLNode& node, Evoral::Parameter le
                                continue;
                         }
 
-                       boost::shared_ptr<AutomationList> al (new AutomationList(**niter, param));
-
                        if (!id_prop) {
                                warning << "AutomationList node without automation-id property, "
                                        << "using default: " << EventTypeMap::instance().to_symbol(legacy_param) << endmsg;
                        }
 
-                       boost::shared_ptr<Evoral::Control> existing = control(param);
+                       boost::shared_ptr<AutomationControl> existing = automation_control (param);
+
                        if (existing) {
-                               existing->set_list(al);
+                                existing->alist()->set_state (**niter, 3000);
                        } else {
-                           boost::shared_ptr<Evoral::Control> newcontrol = control_factory(param);
-                               add_control(newcontrol);
+                                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);
                        }
 
@@ -285,15 +242,14 @@ XMLNode&
 Automatable::get_automation_xml_state ()
 {
        Glib::Mutex::Lock lm (control_lock());
-       XMLNode* node = new XMLNode (X_("Automation"));
+       XMLNode* node = new XMLNode (Automatable::xml_node_name);
 
        if (controls().empty()) {
                return *node;
        }
 
        for (Controls::iterator li = controls().begin(); li != controls().end(); ++li) {
-               boost::shared_ptr<AutomationList> l
-                               = boost::dynamic_pointer_cast<AutomationList>(li->second->list());
+               boost::shared_ptr<AutomationList> l = boost::dynamic_pointer_cast<AutomationList>(li->second->list());
                if (!l->empty()) {
                        node->add_child_nocopy (l->get_state ());
                }
@@ -364,11 +320,9 @@ void
 Automatable::protect_automation ()
 {
        typedef set<Evoral::Parameter> ParameterSet;
-       ParameterSet automated_params;
-
-       what_has_data(automated_params);
+       const ParameterSet& automated_params = what_can_be_automated ();
 
-       for (ParameterSet::iterator i = automated_params.begin(); i != automated_params.end(); ++i) {
+       for (ParameterSet::const_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());
@@ -413,14 +367,21 @@ Automatable::transport_stopped (framepos_t now)
                 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);
                                 }
@@ -455,13 +416,12 @@ Automatable::control_factory(const Evoral::Parameter& param)
                } else {
                        warning << "GainAutomation for non-Amp" << endl;
                }
-       } else if (param.type() == PanAutomation) {
-               Panner* panner = dynamic_cast<Panner*>(this);
-               if (panner) {
-                        StreamPanner& sp (panner->streampanner (param.channel()));
-                       control = new StreamPanner::PanControllable (_a_session, X_("direction"), &sp, param);
+       } 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-Panner" << endl;
+                       warning << "PanAutomation for non-Pannable" << endl;
                }
        }
 
@@ -491,3 +451,23 @@ 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 ();
+}