2 Copyright (C) 2007 Paul Davis
3 Author: David Robillard
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #ifndef __ardour_automation_control_h__
22 #define __ardour_automation_control_h__
26 #include <glibmm/threads.h>
28 #include <boost/shared_ptr.hpp>
29 #include <boost/enable_shared_from_this.hpp>
31 #include "pbd/controllable.h"
33 #include "evoral/types.hpp"
34 #include "evoral/Control.hpp"
36 #include "ardour/automation_list.h"
37 #include "ardour/control_group_member.h"
38 #include "ardour/parameter_descriptor.h"
39 #include "ardour/session_handle.h"
41 #include "ardour/libardour_visibility.h"
49 /** A PBD::Controllable with associated automation data (AutomationList)
51 class LIBARDOUR_API AutomationControl
52 : public PBD::Controllable
53 , public Evoral::Control
54 , public boost::enable_shared_from_this<AutomationControl>
55 , public ControlGroupMember
56 , public SessionHandleRef
59 AutomationControl(ARDOUR::Session&,
60 const Evoral::Parameter& parameter,
61 const ParameterDescriptor& desc,
62 boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
63 const std::string& name="",
64 PBD::Controllable::Flag flags=PBD::Controllable::Flag (0)
67 virtual ~AutomationControl ();
69 boost::shared_ptr<AutomationList> alist() const {
70 return boost::dynamic_pointer_cast<AutomationList>(_list);
73 void set_list (boost::shared_ptr<Evoral::ControlList>);
75 inline bool automation_playback() const {
76 return alist() ? alist()->automation_playback() : false;
79 inline bool automation_write() const {
80 return alist() ? alist()->automation_write() : false;
83 inline AutoState automation_state() const {
84 return alist() ? alist()->automation_state() : Off;
87 void set_automation_state(AutoState as);
88 void start_touch(double when);
89 void stop_touch(double when);
91 /* inherited from PBD::Controllable. */
92 virtual double get_value () const;
93 virtual double get_save_value () const;
95 /* inherited from PBD::Controllable.
96 * Derived classes MUST call ::writable() to verify
97 * that writing to the parameter is legal at that time.
99 void set_value (double value, PBD::Controllable::GroupControlDisposition group_override);
100 /* automation related value setting */
101 virtual bool writable () const;
102 /* Call to ::set_value() with no test for writable() because
103 * this is only used by automation playback.
105 void set_value_unchecked (double val) {
106 actually_set_value (val, PBD::Controllable::NoGroup);
109 virtual void automation_run (samplepos_t start, pframes_t nframes);
111 double lower() const { return _desc.lower; }
112 double upper() const { return _desc.upper; }
113 double normal() const { return _desc.normal; }
114 bool toggled() const { return _desc.toggled; }
116 double internal_to_interface (double i) const;
117 double interface_to_internal (double i) const;
119 virtual std::string get_user_string() const;
121 const ParameterDescriptor& desc() const { return _desc; }
123 const ARDOUR::Session& session() const { return _session; }
124 void commit_transaction (bool did_write);
126 ControlList grouped_controls () const;
129 boost::shared_ptr<ControlGroup> _group;
131 const ParameterDescriptor _desc;
133 bool check_rt (double val, Controllable::GroupControlDisposition gcd);
135 /* derived classes may reimplement this, but should either
136 call this explicitly inside their version OR make sure that the
137 Controllable::Changed signal is emitted when necessary.
140 virtual void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
142 /* Session needs to call this method before it queues up the real
143 change for execution in a realtime context. C++ access control sucks.
145 friend class Session;
146 /* this is what the session invokes */
147 void pre_realtime_queue_stuff (double new_value, PBD::Controllable::GroupControlDisposition);
148 /* this will be invoked in turn on behalf of the group or the control by itself */
149 virtual void do_pre_realtime_queue_stuff (double new_value) {}
151 void session_going_away ();
154 /* I am unclear on why we have to make ControlGroup a friend in order
155 to get access to the ::set_group() method when it is already
156 declared to be a friend in ControlGroupMember. Oh well.
158 friend class ControlGroup;
159 void set_group (boost::shared_ptr<ControlGroup>);
160 PBD::ScopedConnection _state_changed_connection;
165 } // namespace ARDOUR
167 #endif /* __ardour_automation_control_h__ */