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.
24 #include "pbd/memento_command.h"
25 #include "pbd/stacktrace.h"
27 #include "ardour/audioengine.h"
28 #include "ardour/automation_control.h"
29 #include "ardour/automation_watch.h"
30 #include "ardour/control_group.h"
31 #include "ardour/event_type_map.h"
32 #include "ardour/session.h"
38 // C99 'isfinite()' is not available in MSVC.
39 #define isfinite_local(val) (bool)_finite((double)val)
41 #define isfinite_local isfinite
45 using namespace ARDOUR;
48 AutomationControl::AutomationControl(ARDOUR::Session& session,
49 const Evoral::Parameter& parameter,
50 const ParameterDescriptor& desc,
51 boost::shared_ptr<ARDOUR::AutomationList> list,
53 : Controllable (name.empty() ? EventTypeMap::instance().to_symbol(parameter) : name)
54 , Evoral::Control(parameter, desc, list)
60 AutomationControl::~AutomationControl ()
62 DropReferences (); /* EMIT SIGNAL */
66 AutomationControl::writable() const
68 boost::shared_ptr<AutomationList> al = alist();
70 return al->automation_state() != Play;
75 /** Get the current effective `user' value based on automation state */
77 AutomationControl::get_value() const
79 bool from_list = _list && boost::dynamic_pointer_cast<AutomationList>(_list)->automation_playback();
80 return Control::get_double (from_list, _session.transport_frame());
84 AutomationControl::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
90 /* enforce strict double/boolean value mapping */
98 if (check_rt (val, gcd)) {
99 /* change has been queued to take place in an RT context */
103 if (_group && _group->use_me (gcd)) {
104 _group->set_group_value (shared_from_this(), val);
106 actually_set_value (val, gcd);
110 /** Set the value and do the right thing based on automation state
111 * (e.g. record if necessary, etc.)
112 * @param value `user' value
115 AutomationControl::actually_set_value (double value, PBD::Controllable::GroupControlDisposition gcd)
117 bool to_list = _list && boost::dynamic_pointer_cast<AutomationList>(_list)->automation_write();
119 Control::set_double (value, _session.transport_frame(), to_list);
121 AutomationType at = (AutomationType) _parameter.type();
123 std::cerr << "++++ Changed (" << enum_2_string (at) << ", " << enum_2_string (gcd) << ") = " << value << " @ " << this << std::endl;
128 AutomationControl::set_list (boost::shared_ptr<Evoral::ControlList> list)
130 Control::set_list (list);
131 Changed (true, Controllable::NoGroup);
135 AutomationControl::set_automation_state (AutoState as)
137 if (_list && as != alist()->automation_state()) {
139 alist()->set_automation_state (as);
141 return; // No watch for boolean automation
145 AutomationWatch::instance().add_automation_watch (shared_from_this());
146 } else if (as == Touch) {
148 AutomationWatch::instance().remove_automation_watch (shared_from_this());
150 /* this seems unlikely, but the combination of
151 * a control surface and the mouse could make
152 * it possible to put the control into Touch
153 * mode *while* touching it.
155 AutomationWatch::instance().add_automation_watch (shared_from_this());
158 AutomationWatch::instance().remove_automation_watch (shared_from_this());
164 AutomationControl::set_automation_style (AutoStyle as)
167 alist()->set_automation_style (as);
171 AutomationControl::start_touch(double when)
179 if (alist()->automation_state() == Touch) {
180 /* subtle. aligns the user value with the playback */
181 set_value (get_value (), Controllable::NoGroup);
182 alist()->start_touch (when);
183 if (!_desc.toggled) {
184 AutomationWatch::instance().add_automation_watch (shared_from_this());
192 AutomationControl::stop_touch(bool mark, double when)
196 set_touching (false);
198 if (alist()->automation_state() == Touch) {
199 alist()->stop_touch (mark, when);
200 if (!_desc.toggled) {
201 AutomationWatch::instance().remove_automation_watch (shared_from_this());
209 AutomationControl::commit_transaction (bool did_write)
212 if (alist ()->before ()) {
213 _session.begin_reversible_command (string_compose (_("record %1 automation"), name ()));
214 _session.commit_reversible_command (new MementoCommand<AutomationList> (*alist ().get (), alist ()->before (), &alist ()->get_state ()));
217 alist ()->clear_history ();
222 AutomationControl::internal_to_interface (double val) const
224 if (_desc.integer_step) {
225 // both upper and lower are inclusive.
226 val = (val - lower()) / (1 + upper() - lower());
228 val = (val - lower()) / (upper() - lower());
231 if (_desc.logarithmic) {
233 val = pow (val, 1./2.0);
243 AutomationControl::interface_to_internal (double val) const
245 if (!isfinite_local (val)) {
248 if (_desc.logarithmic) {
252 val = pow (val, 2.0);
256 if (_desc.integer_step) {
257 val = lower() + val * (1 + upper() - lower());
259 val = lower() + val * (upper() - lower());
262 if (val < lower()) val = lower();
263 if (val > upper()) val = upper();
269 AutomationControl::set_group (boost::shared_ptr<ControlGroup> cg)
272 _group->remove_control (shared_from_this());
279 AutomationControl::check_rt (double val, Controllable::GroupControlDisposition gcd)
281 if ((flags() & Controllable::RealTime) && !AudioEngine::instance()->in_process_thread()) {
282 /* queue change in RT context */
283 std::cerr << "::set_value (" << val << ", " << enum_2_string (gcd) << ") called for " << enum_2_string ((AutomationType) _parameter.type()) << ", queueing in RT context\n";
284 _session.set_control (shared_from_this(), val, gcd);