/*
- 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_event.h>
-#include <ardour/automation_control.h>
-#include <ardour/param_id.h>
+
+#include "pbd/rcu.h"
+#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;
-class Automatable : public SessionObject
+/* The inherited ControlSet is virtual because AutomatableSequence inherits
+ * from this AND EvoralSequence, which is also a ControlSet
+ */
+class LIBARDOUR_API Automatable : virtual public Evoral::ControlSet, public Slavable
{
public:
- Automatable(Session&, const std::string& name);
+ Automatable(Session&);
+ Automatable (const Automatable& other);
+
+ virtual ~Automatable();
+
+ static bool skip_saving_automation; // to be used only by session-state
+
+ boost::shared_ptr<Evoral::Control> control_factory(const Evoral::Parameter& id);
- virtual ~Automatable() {}
+ 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.
- // shorthand for gain, pan, etc
- inline boost::shared_ptr<AutomationControl>
- control(AutomationType type, bool create_if_missing=false) {
- return control(ParamID(type), create_if_missing);
+ 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) {
+ 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 boost::shared_ptr<AutomationControl> control(ParamID id, bool create_if_missing=false);
- virtual boost::shared_ptr<const AutomationControl> control(ParamID id) const;
-
- typedef std::map<ParamID,boost::shared_ptr<AutomationControl> > Controls;
- Controls controls() { return _controls; }
+ virtual void add_control(boost::shared_ptr<Evoral::Control>);
+ virtual bool find_next_event (double start, double end, Evoral::ControlEvent& ev, bool only_active = true) const;
+ void clear_controls ();
- virtual void add_control(boost::shared_ptr<AutomationControl>);
+ virtual void non_realtime_locate (samplepos_t now);
+ virtual void non_realtime_transport_stop (samplepos_t now, bool flush);
- virtual void automation_snapshot(nframes_t now);
- virtual void transport_stopped(nframes_t now);
+ virtual void automation_run (samplepos_t, pframes_t, bool only_active = false);
- virtual bool find_next_event(nframes_t start, nframes_t end, ControlEvent& ev) const;
-
- virtual string describe_parameter(ParamID param);
- virtual float default_parameter_value(ParamID param) { return 1.0f; }
-
- virtual void clear_automation();
+ virtual std::string describe_parameter(Evoral::Parameter param);
- AutoState get_parameter_automation_state (ParamID param, bool lock = true);
- virtual void set_parameter_automation_state (ParamID param, AutoState);
-
- AutoStyle get_parameter_automation_style (ParamID param);
- void set_parameter_automation_style (ParamID param, AutoStyle);
+ AutoState get_parameter_automation_state (Evoral::Parameter param);
+ virtual void set_parameter_automation_state (Evoral::Parameter param, AutoState);
void protect_automation ();
- void what_has_automation(std::set<ParamID>&) const;
- void what_has_visible_automation(std::set<ParamID>&) const;
- const std::set<ParamID>& what_can_be_automated() const { return _can_automate_list; }
+ const std::set<Evoral::Parameter>& what_can_be_automated() const { return _can_automate_list; }
+ void what_has_existing_automation (std::set<Evoral::Parameter>&) const;
+
+ static const std::string xml_node_name;
+
+ int set_automation_xml_state (const XMLNode&, Evoral::Parameter default_param);
+ XMLNode& get_automation_xml_state();
- void mark_automation_visible(ParamID, bool);
+ PBD::Signal0<void> AutomationStateChanged;
protected:
+ Session& _a_session;
- void can_automate(ParamID);
+ void can_automate(Evoral::Parameter);
- virtual void auto_state_changed (ParamID which) {}
+ virtual void automation_list_automation_state_changed (Evoral::Parameter, AutoState);
+ SerializedRCUManager<ControlList> _automated_controls;
- int set_automation_state(const XMLNode&, ParamID default_param);
- XMLNode& get_automation_state();
-
int load_automation (const std::string& path);
int old_set_automation_state(const XMLNode&);
- mutable Glib::Mutex _automation_lock;
-
- Controls _controls;
- std::set<ParamID> _visible_controls;
- std::set<ParamID> _can_automate_list;
-
- nframes_t _last_automation_snapshot;
+ std::set<Evoral::Parameter> _can_automate_list;
+
+ samplepos_t _last_automation_snapshot;
+
+ SlavableControlList slavables () const { return SlavableControlList(); }
+
+private:
+ inline void find_next_ac_event (boost::shared_ptr<AutomationControl>, double start, double end, Evoral::ControlEvent& ev) const;
+
+ PBD::ScopedConnectionList _control_connections; ///< connections to our controls' signals
};
+
} // namespace ARDOUR
#endif /* __ardour_automatable_h__ */
projects / ardour.git / blobdiff