/*
Copyright (C) 2007 Paul Davis
- Author: Dave Robillard
+ Author: David Robillard
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_automation_control_h__
#define __ardour_automation_control_h__
+#include <map>
+
+#include <glibmm/threads.h>
+
#include <boost/shared_ptr.hpp>
-#include <pbd/controllable.h>
-#include <ardour/parameter.h>
+#include <boost/enable_shared_from_this.hpp>
+
+#include "pbd/controllable.h"
+
+#include "evoral/types.hpp"
+#include "evoral/Control.hpp"
+
+#include "ardour/automation_list.h"
+#include "ardour/control_group_member.h"
+#include "ardour/parameter_descriptor.h"
+#include "ardour/session_handle.h"
+
+#include "ardour/libardour_visibility.h"
namespace ARDOUR {
-class AutomationList;
class Session;
+class Automatable;
+class ControlGroup;
-
-/** A PBD:Controllable with associated automation data (AutomationList)
+/** A PBD::Controllable with associated automation data (AutomationList)
*/
-class AutomationControl : public PBD::Controllable
+class LIBARDOUR_API AutomationControl
+ : public PBD::Controllable
+ , public Evoral::Control
+ , public boost::enable_shared_from_this<AutomationControl>
+ , public ControlGroupMember
+ , public SessionHandleRef
{
public:
- AutomationControl(ARDOUR::Session&, boost::shared_ptr<ARDOUR::AutomationList>,
- std::string name="unnamed controllable");
+ AutomationControl(ARDOUR::Session&,
+ const Evoral::Parameter& parameter,
+ const ParameterDescriptor& desc,
+ boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
+ const std::string& name="",
+ PBD::Controllable::Flag flags=PBD::Controllable::Flag (0)
+ );
+
+ virtual ~AutomationControl ();
+
+ boost::shared_ptr<AutomationList> alist() const {
+ return boost::dynamic_pointer_cast<AutomationList>(_list);
+ }
+
+ void set_list (boost::shared_ptr<Evoral::ControlList>);
+
+ inline bool automation_playback() const {
+ return alist() ? alist()->automation_playback() : false;
+ }
+
+ inline bool automation_write() const {
+ return alist() ? alist()->automation_write() : false;
+ }
+
+ inline AutoState automation_state() const {
+ return alist() ? alist()->automation_state() : Off;
+ }
+
+ void set_automation_state(AutoState as);
+ void start_touch(double when);
+ void stop_touch(double when);
+
+ /* inherited from PBD::Controllable. */
+ virtual double get_value () const;
+ virtual double get_save_value () const;
+
+ /* inherited from PBD::Controllable.
+ * Derived classes MUST call ::writable() to verify
+ * that writing to the parameter is legal at that time.
+ */
+ void set_value (double value, PBD::Controllable::GroupControlDisposition group_override);
+ /* automation related value setting */
+ virtual bool writable () const;
+ /* Call to ::set_value() with no test for writable() because
+ * this is only used by automation playback.
+ */
+ void set_value_unchecked (double val) {
+ actually_set_value (val, PBD::Controllable::NoGroup);
+ }
+
+ virtual void automation_run (samplepos_t start, pframes_t nframes);
+
+ double lower() const { return _desc.lower; }
+ double upper() const { return _desc.upper; }
+ double normal() const { return _desc.normal; }
+ bool toggled() const { return _desc.toggled; }
+
+ double internal_to_interface (double i) const;
+ double interface_to_internal (double i) const;
- void set_value(float val);
- float get_value() const;
- float user_value() const;
+ virtual std::string get_user_string() const;
- void set_list(boost::shared_ptr<ARDOUR::AutomationList>);
+ const ParameterDescriptor& desc() const { return _desc; }
- boost::shared_ptr<ARDOUR::AutomationList> list() { return _list; }
- boost::shared_ptr<const ARDOUR::AutomationList> list() const { return _list; }
+ const ARDOUR::Session& session() const { return _session; }
+ void commit_transaction (bool did_write);
- Parameter parameter() const;
+ ControlList grouped_controls () const;
protected:
- ARDOUR::Session& _session;
- boost::shared_ptr<ARDOUR::AutomationList> _list;
- float _user_value;
+ boost::shared_ptr<ControlGroup> _group;
+
+ const ParameterDescriptor _desc;
+
+ bool check_rt (double val, Controllable::GroupControlDisposition gcd);
+
+ /* derived classes may reimplement this, but should either
+ call this explicitly inside their version OR make sure that the
+ Controllable::Changed signal is emitted when necessary.
+ */
+
+ virtual void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
+
+ /* Session needs to call this method before it queues up the real
+ change for execution in a realtime context. C++ access control sucks.
+ */
+ friend class Session;
+ /* this is what the session invokes */
+ void pre_realtime_queue_stuff (double new_value, PBD::Controllable::GroupControlDisposition);
+ /* this will be invoked in turn on behalf of the group or the control by itself */
+ virtual void do_pre_realtime_queue_stuff (double new_value) {}
+
+ void session_going_away ();
+
+private:
+ /* I am unclear on why we have to make ControlGroup a friend in order
+ to get access to the ::set_group() method when it is already
+ declared to be a friend in ControlGroupMember. Oh well.
+ */
+ friend class ControlGroup;
+ void set_group (boost::shared_ptr<ControlGroup>);
+ PBD::ScopedConnection _state_changed_connection;
+ bool _no_session;
};