/*
- Copyright (C) 2000-2007 Paul Davis
+ Copyright (C) 2000-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
#ifndef __ardour_automatable_h__
#define __ardour_automatable_h__
-#include <set>
#include <map>
+#include <set>
+#include <string>
+
#include <boost/shared_ptr.hpp>
-#include <ardour/session_object.h>
-#include <ardour/automation_list.h>
-#include <ardour/automation_control.h>
-#include <ardour/event_type_map.h>
-#include <evoral/ControlSet.hpp>
-#include <evoral/Sequence.hpp>
+
+#include "pbd/signals.h"
+
+#include "evoral/ControlSet.hpp"
+
+#include "ardour/libardour_visibility.h"
+#include "ardour/slavable.h"
+#include "ardour/types.h"
+
+class XMLNode;
namespace ARDOUR {
class Session;
class AutomationControl;
-
-/** Note this class is abstract, actual objects must either be
- * an AutomatableControls or an AutomatableSequence
+/* The inherited ControlSet is virtual because AutomatableSequence inherits
+ * from this AND EvoralSequence, which is also a ControlSet
*/
-class Automatable : virtual public Evoral::ControlSet
+class LIBARDOUR_API Automatable : virtual public Evoral::ControlSet, public Slavable
{
public:
Automatable(Session&);
- Automatable();
+ Automatable (const Automatable& other);
+
+ virtual ~Automatable();
- virtual ~Automatable() {}
+ boost::shared_ptr<Evoral::Control> control_factory(const Evoral::Parameter& id);
- boost::shared_ptr<Evoral::Control>
- control_factory(const Evoral::Parameter& id);
+ boost::shared_ptr<AutomationControl> automation_control (PBD::ID const & id) const;
+ /* derived classes need to provide some way to search their own child
+ automatable's for a control. normally, we'd just make the method
+ above virtual, and let them override it. But that wouldn't
+ differentiate the "check children" and "just your own" cases.
+
+ We could theoretically just overload the above method with an extra
+ "bool recurse = default", but the rules of name hiding for C++ mean
+ that making a method virtual will hide other overloaded versions of
+ the same name. This means that virtual automation_control (PBD::ID
+ const &) would hide automation_control (Evoral::Parameter const &
+ id).
+
+ So, skip around all that with a different name.
+ */
+ virtual boost::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const {
+ return automation_control (id);
+ }
- boost::shared_ptr<AutomationControl>
- automation_control (const Evoral::Parameter& id, bool create_if_missing=false);
-
- boost::shared_ptr<const AutomationControl>
- automation_control (const Evoral::Parameter& id) const;
+ boost::shared_ptr<AutomationControl> automation_control (const Evoral::Parameter& id) {
+ return automation_control (id, false);
+ }
+ boost::shared_ptr<AutomationControl> automation_control (const Evoral::Parameter& id, bool create_if_missing);
+ boost::shared_ptr<const AutomationControl> automation_control (const Evoral::Parameter& id) const;
virtual void add_control(boost::shared_ptr<Evoral::Control>);
-
- virtual void automation_snapshot(nframes_t now, bool force);
- virtual void transport_stopped(nframes_t now);
+ virtual bool find_next_event (double start, double end, Evoral::ControlEvent& ev, bool only_active = true) const;
+ void clear_controls ();
+
+ virtual void non_realtime_locate (samplepos_t now);
+ virtual void non_realtime_transport_stop (samplepos_t now, bool flush);
+
+ virtual void automation_run (samplepos_t, pframes_t);
- virtual string describe_parameter(Evoral::Parameter param);
-
- AutoState get_parameter_automation_state (Evoral::Parameter param, bool lock = true);
+ virtual std::string describe_parameter(Evoral::Parameter param);
+
+ AutoState get_parameter_automation_state (Evoral::Parameter param);
virtual void set_parameter_automation_state (Evoral::Parameter param, AutoState);
-
- AutoStyle get_parameter_automation_style (Evoral::Parameter param);
- void set_parameter_automation_style (Evoral::Parameter param, AutoStyle);
void protect_automation ();
- void what_has_visible_data(std::set<Evoral::Parameter>&) const;
const std::set<Evoral::Parameter>& what_can_be_automated() const { return _can_automate_list; }
+ void what_has_existing_automation (std::set<Evoral::Parameter>&) const;
- void mark_automation_visible(Evoral::Parameter, bool);
-
- inline bool should_snapshot (nframes_t now) {
- return (_last_automation_snapshot > now
- || (now - _last_automation_snapshot) > _automation_interval);
- }
-
- static void set_automation_interval (jack_nframes_t frames) {
- _automation_interval = frames;
- }
+ static const std::string xml_node_name;
- static jack_nframes_t automation_interval() {
- return _automation_interval;
- }
-
- typedef Evoral::ControlSet::Controls Controls;
-
- Evoral::ControlSet& data() { return *this; }
- const Evoral::ControlSet& data() const { return *this; }
+ int set_automation_xml_state (const XMLNode&, Evoral::Parameter default_param);
+ XMLNode& get_automation_xml_state();
- int set_automation_state (const XMLNode&, Evoral::Parameter default_param);
- XMLNode& get_automation_state();
+ PBD::Signal0<void> AutomationStateChanged;
- protected:
+protected:
Session& _a_session;
void can_automate(Evoral::Parameter);
- virtual void auto_state_changed (Evoral::Parameter which) {}
+ virtual void automation_list_automation_state_changed (Evoral::Parameter, AutoState) {}
-
int load_automation (const std::string& path);
int old_set_automation_state(const XMLNode&);
- std::set<Evoral::Parameter> _visible_controls;
std::set<Evoral::Parameter> _can_automate_list;
-
- nframes_t _last_automation_snapshot;
- static nframes_t _automation_interval;
-};
-
-/** Contains notes and controllers */
-class AutomatableSequence : public Automatable, public Evoral::Sequence {
-public:
- AutomatableSequence(Session& s, size_t size)
- : Evoral::ControlSet()
- , Automatable(s)
- , Evoral::Sequence(EventTypeMap::instance())
- {}
-};
+ samplepos_t _last_automation_snapshot;
+ SlavableControlList slavables () const { return SlavableControlList(); }
-/** Contains only controllers */
-class AutomatableControls : public Automatable {
-public:
- AutomatableControls(Session& s) : Evoral::ControlSet(), Automatable(s) {}
+private:
+ PBD::ScopedConnectionList _control_connections; ///< connections to our controls' signals
};