1 /* This file is part of Evoral.
2 * Copyright (C) 2008 Dave 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
23 #include <boost/pool/pool.hpp>
24 #include <boost/pool/pool_alloc.hpp>
25 #include <glibmm/thread.h>
26 #include "evoral/types.hpp"
27 #include "evoral/Parameter.hpp"
28 #include "evoral/Curve.hpp"
33 /** A single event (time-stamped value) for a control
36 ControlEvent (double w, double v)
37 : when (w), value (v), coeff (0)
40 ControlEvent (const ControlEvent& other)
41 : when (other.when), value (other.value), coeff (0)
45 for (size_t i = 0; i < 4; ++i)
46 coeff[i] = other.coeff[i];
50 ~ControlEvent() { if (coeff) delete[] coeff; }
52 void create_coeffs() {
54 coeff = new double[4];
56 coeff[0] = coeff[1] = coeff[2] = coeff[3] = 0.0;
61 double* coeff; ///< double[4] allocated by Curve as needed
65 /** Pool allocator for control lists that does not use a lock
66 * and allocates 8k blocks of new pointers at a time
68 typedef boost::fast_pool_allocator<
70 boost::default_user_allocator_new_delete,
71 boost::details::pool::null_mutex,
73 ControlEventAllocator;
76 /** A list (sequence) of time-stamped values for a control
81 typedef std::list<ControlEvent*,ControlEventAllocator> EventList;
82 typedef EventList::iterator iterator;
83 typedef EventList::reverse_iterator reverse_iterator;
84 typedef EventList::const_iterator const_iterator;
86 ControlList (const Parameter& id);
87 ControlList (const ControlList&);
88 ControlList (const ControlList&, double start, double end);
89 virtual ~ControlList();
91 virtual boost::shared_ptr<ControlList> create(Parameter id);
93 ControlList& operator= (const ControlList&);
94 bool operator== (const ControlList&);
99 const Parameter& parameter() const { return _parameter; }
100 void set_parameter(const Parameter& p) { _parameter = p; }
102 EventList::size_type size() const { return _events.size(); }
103 bool empty() const { return _events.empty(); }
105 void reset_default (double val) {
106 _default_value = val;
110 void x_scale (double factor);
111 bool extend_to (double);
112 void slide (iterator before, double distance);
114 void reposition_for_rt_add (double when);
115 void rt_add (double when, double value);
116 void add (double when, double value);
117 void fast_simple_add (double when, double value);
119 void reset_range (double start, double end);
120 void erase_range (double start, double end);
121 void erase (iterator);
122 void erase (iterator, iterator);
123 void move_ranges (RangeMoveList const &);
124 void modify (iterator, double, double);
126 boost::shared_ptr<ControlList> cut (double, double);
127 boost::shared_ptr<ControlList> copy (double, double);
128 void clear (double, double);
130 boost::shared_ptr<ControlList> cut (iterator, iterator);
131 boost::shared_ptr<ControlList> copy (iterator, iterator);
132 void clear (iterator, iterator);
134 bool paste (ControlList&, double position, float times);
136 void set_yrange (double min, double max) {
141 double get_max_y() const { return _max_yval; }
142 double get_min_y() const { return _min_yval; }
144 void truncate_end (double length);
145 void truncate_start (double length);
147 iterator begin() { return _events.begin(); }
148 const_iterator begin() const { return _events.begin(); }
149 iterator end() { return _events.end(); }
150 const_iterator end() const { return _events.end(); }
151 ControlEvent* back() { return _events.back(); }
152 const ControlEvent* back() const { return _events.back(); }
153 ControlEvent* front() { return _events.front(); }
154 const ControlEvent* front() const { return _events.front(); }
156 std::pair<ControlList::iterator,ControlList::iterator> control_points_adjacent (double when);
158 template<class T> void apply_to_points (T& obj, void (T::*method)(const ControlList&)) {
159 Glib::Mutex::Lock lm (_lock);
160 (obj.*method)(*this);
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 static inline bool time_comparator (const ControlEvent* a, const ControlEvent* b) {
183 return a->when < b->when;
186 /** Lookup cache for eval functions, range contains equivalent values */
188 LookupCache() : left(-1) {}
189 double left; /* leftmost x coordinate used when finding "range" */
190 std::pair<ControlList::const_iterator,ControlList::const_iterator> range;
193 /** Lookup cache for point finding, range contains points between left and right */
195 SearchCache() : left(-1), right(-1) {}
196 double left; /* leftmost x coordinate used when finding "range" */
197 double right; /* rightmost x coordinate used when finding "range" */
198 std::pair<ControlList::const_iterator,ControlList::const_iterator> range;
201 const EventList& events() const { return _events; }
202 double default_value() const { return _parameter.normal(); }
204 // FIXME: const violations for Curve
205 Glib::Mutex& lock() const { return _lock; }
206 LookupCache& lookup_cache() const { return _lookup_cache; }
207 SearchCache& search_cache() const { return _search_cache; }
209 /** Called by locked entry point and various private
210 * locations where we already hold the lock.
212 * FIXME: Should this be private? Curve needs it..
214 double unlocked_eval (double x) const;
216 bool rt_safe_earliest_event (double start, double end, double& x, double& y, bool start_inclusive=false) const;
217 bool rt_safe_earliest_event_unlocked (double start, double end, double& x, double& y, bool start_inclusive=false) const;
219 Curve& curve() { return *_curve; }
220 const Curve& curve() const { return *_curve; }
222 virtual void mark_dirty () const;
224 enum InterpolationStyle {
230 InterpolationStyle interpolation() const { return _interpolation; }
231 void set_interpolation(InterpolationStyle style) { _interpolation = style; }
235 /** Called by unlocked_eval() to handle cases of 3 or more control points. */
236 double multipoint_eval (double x) const;
238 void build_search_cache_if_necessary(double start, double end) const;
240 bool rt_safe_earliest_event_discrete_unlocked (double start, double end, double& x, double& y, bool inclusive) const;
241 bool rt_safe_earliest_event_linear_unlocked (double start, double end, double& x, double& y, bool inclusive) const;
243 boost::shared_ptr<ControlList> cut_copy_clear (double, double, int op);
244 bool erase_range_internal (double start, double end, EventList &);
246 virtual void maybe_signal_changed ();
248 void _x_scale (double factor);
250 mutable LookupCache _lookup_cache;
251 mutable SearchCache _search_cache;
253 Parameter _parameter;
254 InterpolationStyle _interpolation;
256 mutable Glib::Mutex _lock;
258 bool _changed_when_thawed;
263 double _default_value;
265 iterator _rt_insertion_point;
271 } // namespace Evoral
273 #endif // EVORAL_CONTROL_LIST_HPP