2 Copyright (C) 2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #ifndef __ardour_automation_event_h__
22 #define __ardour_automation_event_h__
28 #include <sigc++/signal.h>
29 #include <glibmm/thread.h>
32 #include <pbd/xml++.h>
33 #include <pbd/statefuldestructible.h>
35 #include <ardour/ardour.h>
43 ControlEvent (double w, double v)
44 : when (w), value (v) { }
45 ControlEvent (const ControlEvent& other)
46 : when (other.when), value (other.value) {}
48 virtual ~ControlEvent() {}
50 // bool operator==(const ControlEvent& other) {
51 // return value == other.value && when == other.when;
56 class AutomationList : public PBD::StatefulDestructible
59 typedef std::list<ControlEvent*> AutomationEventList;
60 typedef AutomationEventList::iterator iterator;
61 typedef AutomationEventList::const_iterator const_iterator;
63 AutomationList (double default_value);
64 AutomationList (const XMLNode&);
67 AutomationList (const AutomationList&);
68 AutomationList (const AutomationList&, double start, double end);
69 AutomationList& operator= (const AutomationList&);
70 bool operator== (const AutomationList&);
75 AutomationEventList::size_type size() const { return events.size(); }
76 bool empty() const { return events.empty(); }
78 void reset_default (double val) {
83 void x_scale (double factor);
84 bool extend_to (double);
85 void slide (iterator before, double distance);
87 void reposition_for_rt_add (double when);
88 void rt_add (double when, double value);
89 void add (double when, double value);
90 /* this should be private but old-school automation loading needs it in IO/Redirect */
91 void fast_simple_add (double when, double value);
93 void reset_range (double start, double end);
94 void erase_range (double start, double end);
95 void erase (iterator);
96 void erase (iterator, iterator);
97 void move_range (iterator start, iterator end, double, double);
98 void modify (iterator, double, double);
100 AutomationList* cut (double, double);
101 AutomationList* copy (double, double);
102 void clear (double, double);
104 AutomationList* cut (iterator, iterator);
105 AutomationList* copy (iterator, iterator);
106 void clear (iterator, iterator);
108 bool paste (AutomationList&, double position, float times);
110 void set_automation_state (AutoState);
111 AutoState automation_state() const { return _state; }
112 sigc::signal<void> automation_style_changed;
114 void set_automation_style (AutoStyle m);
115 AutoStyle automation_style() const { return _style; }
116 sigc::signal<void> automation_state_changed;
118 bool automation_playback() {
119 return (_state & Play) || ((_state & Touch) && !_touching);
121 bool automation_write () {
122 return (_state & Write) || ((_state & Touch) && _touching);
127 bool touching() const { return _touching; }
129 void set_yrange (double min, double max) {
134 double get_max_y() const { return max_yval; }
135 double get_min_y() const { return min_yval; }
137 void truncate_end (double length);
138 void truncate_start (double length);
140 iterator begin() { return events.begin(); }
141 iterator end() { return events.end(); }
143 ControlEvent* back() { return events.back(); }
144 ControlEvent* front() { return events.front(); }
146 const_iterator const_begin() const { return events.begin(); }
147 const_iterator const_end() const { return events.end(); }
149 std::pair<AutomationList::iterator,AutomationList::iterator> control_points_adjacent (double when);
151 template<class T> void apply_to_points (T& obj, void (T::*method)(const AutomationList&)) {
152 Glib::Mutex::Lock lm (lock);
153 (obj.*method)(*this);
156 sigc::signal<void> StateChanged;
158 XMLNode& get_state(void);
159 int set_state (const XMLNode &s);
160 XMLNode& state (bool full);
161 XMLNode& serialize_events ();
163 void set_max_xval (double);
164 double get_max_xval() const { return max_xval; }
166 double eval (double where) {
167 Glib::Mutex::Lock lm (lock);
168 return unlocked_eval (where);
171 double rt_safe_eval (double where, bool& ok) {
173 Glib::Mutex::Lock lm (lock, Glib::TRY_LOCK);
175 if ((ok = lm.locked())) {
176 return unlocked_eval (where);
182 struct TimeComparator {
183 bool operator() (const ControlEvent* a, const ControlEvent* b) {
184 return a->when < b->when;
188 static sigc::signal<void, AutomationList*> AutomationListCreated;
192 AutomationEventList events;
193 mutable Glib::Mutex lock;
195 bool changed_when_thawed;
199 double left; /* leftmost x coordinate used when finding "range" */
200 std::pair<AutomationList::iterator,AutomationList::iterator> range;
203 LookupCache lookup_cache;
212 double default_value;
215 iterator rt_insertion_point;
218 void maybe_signal_changed ();
220 void _x_scale (double factor);
222 /* called by type-specific unlocked_eval() to handle
223 common case of 0, 1 or 2 control points.
226 double shared_eval (double x);
228 /* called by shared_eval() to handle any case of
229 3 or more control points.
232 virtual double multipoint_eval (double x);
234 /* called by locked entry point and various private
235 locations where we already hold the lock.
238 virtual double unlocked_eval (double where);
240 virtual ControlEvent* point_factory (double,double) const;
241 virtual ControlEvent* point_factory (const ControlEvent&) const;
243 AutomationList* cut_copy_clear (double, double, int op);
245 int deserialize_events (const XMLNode&);
250 #endif /* __ardour_automation_event_h__ */