Make control point selection more consistent.
[ardour.git] / libs / evoral / evoral / ControlList.hpp
1 /* This file is part of Evoral.
2  * Copyright (C) 2008 David Robillard <http://drobilla.net>
3  * Copyright (C) 2000-2008 Paul Davis
4  *
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
8  * version.
9  *
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.
13  *
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
17  */
18
19 #ifndef EVORAL_CONTROL_LIST_HPP
20 #define EVORAL_CONTROL_LIST_HPP
21
22 #include <cassert>
23 #include <list>
24 #include <stdint.h>
25
26 #include <boost/pool/pool.hpp>
27 #include <boost/pool/pool_alloc.hpp>
28
29 #include <glibmm/threads.h>
30
31 #include "pbd/signals.h"
32
33 #include "evoral/visibility.h"
34 #include "evoral/types.hpp"
35 #include "evoral/Range.hpp"
36 #include "evoral/Parameter.hpp"
37 #include "evoral/ParameterDescriptor.hpp"
38
39 namespace Evoral {
40
41 class Curve;
42 class TypeMap;
43
44 /** A single event (time-stamped value) for a control
45  */
46 class LIBEVORAL_API ControlEvent {
47 public:
48         ControlEvent (double w, double v)
49                 : when (w), value (v), coeff (0)
50         {}
51
52         ControlEvent (const ControlEvent& other)
53                 : when (other.when), value (other.value), coeff (0)
54         {
55                 if (other.coeff) {
56                         create_coeffs();
57                         for (size_t i = 0; i < 4; ++i)
58                                 coeff[i] = other.coeff[i];
59                 }
60         }
61
62         ~ControlEvent() { if (coeff) delete[] coeff; }
63
64         void create_coeffs() {
65                 if (!coeff)
66                         coeff = new double[4];
67
68                 coeff[0] = coeff[1] = coeff[2] = coeff[3] = 0.0;
69         }
70
71         double  when;
72         double  value;
73         double* coeff; ///< double[4] allocated by Curve as needed
74 };
75
76 /** A list (sequence) of time-stamped values for a control
77  */
78 class LIBEVORAL_API ControlList
79 {
80 public:
81         typedef std::list<ControlEvent*> EventList;
82         typedef EventList::iterator iterator;
83         typedef EventList::reverse_iterator reverse_iterator;
84         typedef EventList::const_iterator const_iterator;
85         typedef EventList::const_reverse_iterator const_reverse_iterator;
86
87         ControlList (const Parameter& id, const ParameterDescriptor& desc);
88         ControlList (const ControlList&);
89         ControlList (const ControlList&, double start, double end);
90         virtual ~ControlList();
91
92         virtual boost::shared_ptr<ControlList> create(const Parameter& id, const ParameterDescriptor& desc);
93
94         void dump (std::ostream&);
95
96         ControlList& operator= (const ControlList&);
97         bool operator== (const ControlList&);
98         void copy_events (const ControlList&);
99
100         virtual void freeze();
101         virtual void thaw ();
102         bool frozen() const { return _frozen; }
103
104         const Parameter& parameter() const                 { return _parameter; }
105         void             set_parameter(const Parameter& p) { _parameter = p; }
106
107         const ParameterDescriptor& descriptor() const                           { return _desc; }
108         void                       set_descriptor(const ParameterDescriptor& d) { _desc = d; }
109
110         EventList::size_type size() const { return _events.size(); }
111         double length() const {
112                 Glib::Threads::RWLock::ReaderLock lm (_lock);
113                 return _events.empty() ? 0.0 : _events.back()->when;
114         }
115         bool empty() const { return _events.empty(); }
116
117         void reset_default (double val) {
118                 _default_value = val;
119         }
120
121         void clear ();
122         void x_scale (double factor);
123         bool extend_to (double);
124         void slide (iterator before, double distance);
125         void shift (double before, double distance);
126
127         virtual void add (double when, double value, bool with_guards=true, bool with_initial=true);
128
129         virtual bool editor_add (double when, double value, bool with_guard);
130
131         void fast_simple_add (double when, double value);
132
133         void erase_range (double start, double end);
134         void erase (iterator);
135         void erase (iterator, iterator);
136         void erase (double, double);
137         bool move_ranges (std::list< RangeMove<double> > const &);
138         void modify (iterator, double, double);
139
140         /** Thin the number of events in this list.
141          *
142          * The thinning factor has no units but corresponds to the area of a
143          * triangle computed between three points in the list.  If the area is
144          * large, it indicates significant non-linearity between the points.
145          *
146          * During automation recording we thin the recorded points using this
147          * value.  If a point is sufficiently co-linear with its neighbours (as
148          * defined by the area of the triangle formed by three of them), we will
149          * not include it in the list.  The larger the value, the more points are
150          * excluded, so this effectively measures the amount of thinning to be
151          * done.
152          */
153         void thin (double thinning_factor);
154
155         boost::shared_ptr<ControlList> cut (double, double);
156         boost::shared_ptr<ControlList> copy (double, double);
157         void clear (double, double);
158
159         bool paste (const ControlList&, double position, float times);
160
161         void set_yrange (double min, double max) {
162                 _min_yval = min;
163                 _max_yval = max;
164         }
165
166         double get_max_y() const { return _max_yval; }
167         double get_min_y() const { return _min_yval; }
168
169         void truncate_end (double length);
170         void truncate_start (double length);
171
172         iterator            begin()       { return _events.begin(); }
173         const_iterator      begin() const { return _events.begin(); }
174         iterator            end()         { return _events.end(); }
175         const_iterator      end()   const { return _events.end(); }
176         reverse_iterator            rbegin()       { return _events.rbegin(); }
177         const_reverse_iterator      rbegin() const { return _events.rbegin(); }
178         reverse_iterator            rend()         { return _events.rend(); }
179         const_reverse_iterator      rend()   const { return _events.rend(); }
180         ControlEvent*       back()        { return _events.back(); }
181         const ControlEvent* back()  const { return _events.back(); }
182         ControlEvent*       front()       { return _events.front(); }
183         const ControlEvent* front() const { return _events.front(); }
184
185         std::pair<ControlList::iterator,ControlList::iterator> control_points_adjacent (double when);
186
187         template<class T> void apply_to_points (T& obj, void (T::*method)(const ControlList&)) {
188                 Glib::Threads::RWLock::WriterLock lm (_lock);
189                 (obj.*method)(*this);
190         }
191
192         double eval (double where) {
193                 Glib::Threads::RWLock::ReaderLock lm (_lock);
194                 return unlocked_eval (where);
195         }
196
197         double rt_safe_eval (double where, bool& ok) {
198
199                 Glib::Threads::RWLock::ReaderLock lm (_lock, Glib::Threads::TRY_LOCK);
200
201                 if ((ok = lm.locked())) {
202                         return unlocked_eval (where);
203                 } else {
204                         return 0.0;
205                 }
206         }
207
208         static inline bool time_comparator (const ControlEvent* a, const ControlEvent* b) {
209                 return a->when < b->when;
210         }
211
212         /** Lookup cache for eval functions, range contains equivalent values */
213         struct LookupCache {
214                 LookupCache() : left(-1) {}
215                 double left;  /* leftmost x coordinate used when finding "range" */
216                 std::pair<ControlList::const_iterator,ControlList::const_iterator> range;
217         };
218
219         /** Lookup cache for point finding, range contains points after left */
220         struct SearchCache {
221                 SearchCache () : left(-1) {}
222                 double left;  /* leftmost x coordinate used when finding "first" */
223                 ControlList::const_iterator first;
224         };
225
226         const EventList& events() const { return _events; }
227         double default_value() const { return _default_value; }
228
229         // FIXME: const violations for Curve
230         Glib::Threads::RWLock& lock()       const { return _lock; }
231         LookupCache& lookup_cache() const { return _lookup_cache; }
232         SearchCache& search_cache() const { return _search_cache; }
233
234         /** Called by locked entry point and various private
235          * locations where we already hold the lock.
236          *
237          * FIXME: Should this be private?  Curve needs it..
238          */
239         double unlocked_eval (double x) const;
240
241         bool rt_safe_earliest_event (double start, double& x, double& y, bool start_inclusive=false) const;
242         bool rt_safe_earliest_event_unlocked (double start, double& x, double& y, bool start_inclusive=false) const;
243         bool rt_safe_earliest_event_linear_unlocked (double start, double& x, double& y, bool inclusive) const;
244         bool rt_safe_earliest_event_discrete_unlocked (double start, double& x, double& y, bool inclusive) const;
245
246         void create_curve();
247         void destroy_curve();
248
249         Curve&       curve()       { assert(_curve); return *_curve; }
250         const Curve& curve() const { assert(_curve); return *_curve; }
251
252         void mark_dirty () const;
253
254         enum InterpolationStyle {
255                 Discrete,
256                 Linear,
257                 Curved
258         };
259
260         InterpolationStyle interpolation() const { return _interpolation; }
261         void set_interpolation (InterpolationStyle);
262
263         virtual bool touching() const { return false; }
264         virtual bool writing() const { return false; }
265         virtual bool touch_enabled() const { return false; }
266         void start_write_pass (double time);
267         void write_pass_finished (double when, double thinning_factor=0.0);
268         void set_in_write_pass (bool, bool add_point = false, double when = 0.0);
269         bool in_write_pass () const;
270
271         /** Emitted when mark_dirty() is called on this object */
272         mutable PBD::Signal0<void> Dirty;
273         /** Emitted when our interpolation style changes */
274         PBD::Signal1<void, InterpolationStyle> InterpolationChanged;
275
276         bool operator!= (ControlList const &) const;
277
278         void invalidate_insert_iterator ();
279
280 protected:
281
282         /** Called by unlocked_eval() to handle cases of 3 or more control points. */
283         double multipoint_eval (double x) const;
284
285         void build_search_cache_if_necessary (double start) const;
286
287         boost::shared_ptr<ControlList> cut_copy_clear (double, double, int op);
288         bool erase_range_internal (double start, double end, EventList &);
289
290         void     maybe_add_insert_guard (double when);
291         iterator erase_from_iterator_to (iterator iter, double when);
292         bool     maybe_insert_straight_line (double when, double value);
293
294         virtual void maybe_signal_changed ();
295
296         void _x_scale (double factor);
297
298         mutable LookupCache   _lookup_cache;
299         mutable SearchCache   _search_cache;
300
301         mutable Glib::Threads::RWLock _lock;
302
303         Parameter             _parameter;
304         ParameterDescriptor   _desc;
305         InterpolationStyle    _interpolation;
306         EventList             _events;
307         int8_t                _frozen;
308         bool                  _changed_when_thawed;
309         double                _min_yval;
310         double                _max_yval;
311         double                _default_value;
312         bool                  _sort_pending;
313
314         Curve* _curve;
315
316   private:
317     iterator   most_recent_insert_iterator;
318     double     insert_position;
319     bool       new_write_pass;
320     bool       did_write_during_pass;
321     bool       _in_write_pass;
322     void unlocked_invalidate_insert_iterator ();
323     void add_guard_point (double when);
324 };
325
326 } // namespace Evoral
327
328 #endif // EVORAL_CONTROL_LIST_HPP
329