1 /* This file is part of Evoral.
2 * Copyright (C) 2008 David Robillard <http://drobilla.net>
3 * Copyright (C) 2000-2008 Paul Davis
5 * Evoral is free software; you can redistribute it and/or modify it under the
6 * terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 2 of the License, or (at your option) any later
10 * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
11 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef EVORAL_CONTROL_LIST_HPP
20 #define EVORAL_CONTROL_LIST_HPP
24 #include <boost/pool/pool.hpp>
25 #include <boost/pool/pool_alloc.hpp>
26 #include <glibmm/threads.h>
27 #include "pbd/signals.h"
28 #include "evoral/types.hpp"
29 #include "evoral/Range.hpp"
30 #include "evoral/Parameter.hpp"
36 /** A single event (time-stamped value) for a control
40 ControlEvent (double w, double v)
41 : when (w), value (v), coeff (0)
44 ControlEvent (const ControlEvent& other)
45 : when (other.when), value (other.value), coeff (0)
49 for (size_t i = 0; i < 4; ++i)
50 coeff[i] = other.coeff[i];
54 ~ControlEvent() { if (coeff) delete[] coeff; }
56 void create_coeffs() {
58 coeff = new double[4];
60 coeff[0] = coeff[1] = coeff[2] = coeff[3] = 0.0;
65 double* coeff; ///< double[4] allocated by Curve as needed
69 /** Pool allocator for control lists that does not use a lock
70 * and allocates 8k blocks of new pointers at a time
72 typedef boost::fast_pool_allocator<
74 boost::default_user_allocator_new_delete,
75 boost::details::pool::null_mutex,
77 ControlEventAllocator;
80 /** A list (sequence) of time-stamped values for a control
85 typedef std::list<ControlEvent*,ControlEventAllocator> EventList;
86 typedef EventList::iterator iterator;
87 typedef EventList::reverse_iterator reverse_iterator;
88 typedef EventList::const_iterator const_iterator;
90 ControlList (const Parameter& id);
91 ControlList (const ControlList&);
92 ControlList (const ControlList&, double start, double end);
93 virtual ~ControlList();
95 virtual boost::shared_ptr<ControlList> create(Parameter id);
97 ControlList& operator= (const ControlList&);
98 bool operator== (const ControlList&);
99 void copy_events (const ControlList&);
101 virtual void freeze();
102 virtual void thaw ();
103 bool frozen() const { return _frozen; }
105 const Parameter& parameter() const { return _parameter; }
106 void set_parameter(const Parameter& p) { _parameter = p; }
108 EventList::size_type size() const { return _events.size(); }
109 double length() const {
110 Glib::Threads::Mutex::Lock lm (_lock);
111 return _events.empty() ? 0.0 : _events.back()->when;
113 bool empty() const { return _events.empty(); }
115 void reset_default (double val) {
116 _default_value = val;
120 void x_scale (double factor);
121 bool extend_to (double);
122 void slide (iterator before, double distance);
123 void shift (double before, double distance);
125 virtual bool clamp_value (double& /*when*/, double& /*value*/) const { return true; }
127 virtual void add (double when, double value);
128 void fast_simple_add (double when, double value);
130 void erase_range (double start, double end);
131 void erase (iterator);
132 void erase (iterator, iterator);
133 void erase (double, double);
134 bool move_ranges (std::list< RangeMove<double> > const &);
135 void modify (iterator, double, double);
139 boost::shared_ptr<ControlList> cut (double, double);
140 boost::shared_ptr<ControlList> copy (double, double);
141 void clear (double, double);
143 bool paste (ControlList&, double position, float times);
145 void set_yrange (double min, double max) {
150 double get_max_y() const { return _max_yval; }
151 double get_min_y() const { return _min_yval; }
153 void truncate_end (double length);
154 void truncate_start (double length);
156 iterator begin() { return _events.begin(); }
157 const_iterator begin() const { return _events.begin(); }
158 iterator end() { return _events.end(); }
159 const_iterator end() const { return _events.end(); }
160 ControlEvent* back() { return _events.back(); }
161 const ControlEvent* back() const { return _events.back(); }
162 ControlEvent* front() { return _events.front(); }
163 const ControlEvent* front() const { return _events.front(); }
165 std::pair<ControlList::iterator,ControlList::iterator> control_points_adjacent (double when);
167 template<class T> void apply_to_points (T& obj, void (T::*method)(const ControlList&)) {
168 Glib::Threads::Mutex::Lock lm (_lock);
169 (obj.*method)(*this);
172 double eval (double where) {
173 Glib::Threads::Mutex::Lock lm (_lock);
174 return unlocked_eval (where);
177 double rt_safe_eval (double where, bool& ok) {
179 Glib::Threads::Mutex::Lock lm (_lock, Glib::Threads::TRY_LOCK);
181 if ((ok = lm.locked())) {
182 return unlocked_eval (where);
188 static inline bool time_comparator (const ControlEvent* a, const ControlEvent* b) {
189 return a->when < b->when;
192 /** Lookup cache for eval functions, range contains equivalent values */
194 LookupCache() : left(-1) {}
195 double left; /* leftmost x coordinate used when finding "range" */
196 std::pair<ControlList::const_iterator,ControlList::const_iterator> range;
199 /** Lookup cache for point finding, range contains points after left */
201 SearchCache () : left(-1) {}
202 double left; /* leftmost x coordinate used when finding "first" */
203 ControlList::const_iterator first;
206 const EventList& events() const { return _events; }
207 double default_value() const { return _parameter.normal(); }
209 // FIXME: const violations for Curve
210 Glib::Threads::Mutex& lock() const { return _lock; }
211 LookupCache& lookup_cache() const { return _lookup_cache; }
212 SearchCache& search_cache() const { return _search_cache; }
214 /** Called by locked entry point and various private
215 * locations where we already hold the lock.
217 * FIXME: Should this be private? Curve needs it..
219 double unlocked_eval (double x) const;
221 bool rt_safe_earliest_event (double start, double& x, double& y, bool start_inclusive=false) const;
222 bool rt_safe_earliest_event_unlocked (double start, double& x, double& y, bool start_inclusive=false) const;
223 bool rt_safe_earliest_event_linear_unlocked (double start, double& x, double& y, bool inclusive) const;
224 bool rt_safe_earliest_event_discrete_unlocked (double start, double& x, double& y, bool inclusive) const;
227 void destroy_curve();
229 Curve& curve() { assert(_curve); return *_curve; }
230 const Curve& curve() const { assert(_curve); return *_curve; }
232 void mark_dirty () const;
234 enum InterpolationStyle {
240 InterpolationStyle interpolation() const { return _interpolation; }
241 void set_interpolation (InterpolationStyle);
243 virtual bool touching() const { return false; }
244 virtual bool writing() const { return false; }
245 virtual bool touch_enabled() const { return false; }
246 void start_write_pass (double time);
247 void write_pass_finished (double when);
248 void set_in_write_pass (bool);
249 bool in_write_pass () const;
251 /** Emitted when mark_dirty() is called on this object */
252 mutable PBD::Signal0<void> Dirty;
253 /** Emitted when our interpolation style changes */
254 PBD::Signal1<void, InterpolationStyle> InterpolationChanged;
256 static void set_thinning_factor (double d);
257 static double thinning_factor() { return _thinning_factor; }
259 bool operator!= (ControlList const &) const;
261 void invalidate_insert_iterator ();
265 /** Called by unlocked_eval() to handle cases of 3 or more control points. */
266 double multipoint_eval (double x) const;
268 void build_search_cache_if_necessary (double start) const;
270 boost::shared_ptr<ControlList> cut_copy_clear (double, double, int op);
271 bool erase_range_internal (double start, double end, EventList &);
273 virtual void maybe_signal_changed ();
275 void _x_scale (double factor);
277 mutable LookupCache _lookup_cache;
278 mutable SearchCache _search_cache;
280 Parameter _parameter;
281 InterpolationStyle _interpolation;
283 mutable Glib::Threads::Mutex _lock;
285 bool _changed_when_thawed;
288 double _default_value;
293 static double _thinning_factor;
296 iterator most_recent_insert_iterator;
297 double insert_position;
299 bool did_write_during_pass;
301 void unlocked_invalidate_insert_iterator ();
304 } // namespace Evoral
306 #endif // EVORAL_CONTROL_LIST_HPP