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 <boost/pool/pool.hpp>
  25 #include <boost/pool/pool_alloc.hpp>
  26 #include <glibmm/thread.h>
  27 #include "pbd/signals.h"
  28 #include "evoral/types.hpp"
  29 #include "evoral/Range.hpp"
  30 #include "evoral/Parameter.hpp"
  31
  32 namespace Evoral {
  33
  34 class Curve;
  35
  36 /** A single event (time-stamped value) for a control
  37  */
  38 class ControlEvent {
  39 public:
  40         ControlEvent (double w, double v)
  41                 : when (w), value (v), coeff (0)
  42         {}
  43
  44         ControlEvent (const ControlEvent& other)
  45                 : when (other.when), value (other.value), coeff (0)
  46         {
  47                 if (other.coeff) {
  48                         create_coeffs();
  49                         for (size_t i = 0; i < 4; ++i)
  50                                 coeff[i] = other.coeff[i];
  51                 }
  52         }
  53
  54         ~ControlEvent() { if (coeff) delete[] coeff; }
  55
  56         void create_coeffs() {
  57                 if (!coeff)
  58                         coeff = new double[4];
  59
  60                 coeff[0] = coeff[1] = coeff[2] = coeff[3] = 0.0;
  61         }
  62
  63         double  when;
  64         double  value;
  65         double* coeff; ///< double[4] allocated by Curve as needed
  66 };
  67
  68
  69 /** Pool allocator for control lists that does not use a lock
  70  * and allocates 8k blocks of new pointers at a time
  71  */
  72 typedef boost::fast_pool_allocator<
  73         ControlEvent*,
  74         boost::default_user_allocator_new_delete,
  75         boost::details::pool::null_mutex,
  76         8192>
  77 ControlEventAllocator;
  78
  79
  80 /** A list (sequence) of time-stamped values for a control
  81  */
  82 class ControlList
  83 {
  84 public:
  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;
  89
  90         ControlList (const Parameter& id);
  91         ControlList (const ControlList&);
  92         ControlList (const ControlList&, double start, double end);
  93         virtual ~ControlList();
  94
  95         virtual boost::shared_ptr<ControlList> create(Parameter id);
  96
  97         ControlList& operator= (const ControlList&);
  98         bool operator== (const ControlList&);
  99         void copy_events (const ControlList&);
 100
 101         virtual void freeze();
 102         virtual void thaw ();
 103         bool frozen() const { return _frozen; }
 104
 105         const Parameter& parameter() const                 { return _parameter; }
 106         void             set_parameter(const Parameter& p) { _parameter = p; }
 107
 108         EventList::size_type size() const { return _events.size(); }
 109         double length() const {
 110                 Glib::Mutex::Lock lm (_lock);
 111                 return _events.empty() ? 0.0 : _events.back()->when;
 112         }
 113         bool empty() const { return _events.empty(); }
 114
 115         void reset_default (double val) {
 116                 _default_value = val;
 117         }
 118
 119         void clear ();
 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);
 124
 125         virtual bool clamp_value (double& /*when*/, double& /*value*/) const { return true; }
 126
 127         virtual void add (double when, double value);
 128         void fast_simple_add (double when, double value);
 129
 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);
 136
 137         void thin ();
 138
 139         boost::shared_ptr<ControlList> cut (double, double);
 140         boost::shared_ptr<ControlList> copy (double, double);
 141         void clear (double, double);
 142
 143         bool paste (ControlList&, double position, float times);
 144
 145         void set_yrange (double min, double max) {
 146                 _min_yval = min;
 147                 _max_yval = max;
 148         }
 149
 150         double get_max_y() const { return _max_yval; }
 151         double get_min_y() const { return _min_yval; }
 152
 153         void truncate_end (double length);
 154         void truncate_start (double length);
 155
 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(); }
 164
 165         std::pair<ControlList::iterator,ControlList::iterator> control_points_adjacent (double when);
 166
 167         template<class T> void apply_to_points (T& obj, void (T::*method)(const ControlList&)) {
 168                 Glib::Mutex::Lock lm (_lock);
 169                 (obj.*method)(*this);
 170         }
 171
 172         double eval (double where) {
 173                 Glib::Mutex::Lock lm (_lock);
 174                 return unlocked_eval (where);
 175         }
 176
 177         double rt_safe_eval (double where, bool& ok) {
 178
 179                 Glib::Mutex::Lock lm (_lock, Glib::TRY_LOCK);
 180
 181                 if ((ok = lm.locked())) {
 182                         return unlocked_eval (where);
 183                 } else {
 184                         return 0.0;
 185                 }
 186         }
 187
 188         static inline bool time_comparator (const ControlEvent* a, const ControlEvent* b) {
 189                 return a->when < b->when;
 190         }
 191
 192         /** Lookup cache for eval functions, range contains equivalent values */
 193         struct LookupCache {
 194                 LookupCache() : left(-1) {}
 195                 double left;  /* leftmost x coordinate used when finding "range" */
 196                 std::pair<ControlList::const_iterator,ControlList::const_iterator> range;
 197         };
 198
 199         /** Lookup cache for point finding, range contains points after left */
 200         struct SearchCache {
 201                 SearchCache () : left(-1) {}
 202                 double left;  /* leftmost x coordinate used when finding "first" */
 203                 ControlList::const_iterator first;
 204         };
 205
 206         const EventList& events() const { return _events; }
 207         double default_value() const { return _parameter.normal(); }
 208
 209         // FIXME: const violations for Curve
 210         Glib::Mutex& lock()         const { return _lock; }
 211         LookupCache& lookup_cache() const { return _lookup_cache; }
 212         SearchCache& search_cache() const { return _search_cache; }
 213
 214         /** Called by locked entry point and various private
 215          * locations where we already hold the lock.
 216          *
 217          * FIXME: Should this be private?  Curve needs it..
 218          */
 219         double unlocked_eval (double x) const;
 220
 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;
 225
 226         void create_curve();
 227         void destroy_curve();
 228
 229         Curve&       curve()       { assert(_curve); return *_curve; }
 230         const Curve& curve() const { assert(_curve); return *_curve; }
 231
 232         void mark_dirty () const;
 233
 234         enum InterpolationStyle {
 235                 Discrete,
 236                 Linear,
 237                 Curved
 238         };
 239
 240         InterpolationStyle interpolation() const { return _interpolation; }
 241         void set_interpolation (InterpolationStyle);
 242
 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;
 250
 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;
 255
 256         static void set_thinning_factor (double d);
 257         static double thinning_factor() { return _thinning_factor; }
 258
 259         bool operator!= (ControlList const &) const;
 260
 261         void invalidate_insert_iterator ();
 262
 263 protected:
 264
 265         /** Called by unlocked_eval() to handle cases of 3 or more control points. */
 266         double multipoint_eval (double x) const;
 267
 268         void build_search_cache_if_necessary (double start) const;
 269
 270         boost::shared_ptr<ControlList> cut_copy_clear (double, double, int op);
 271         bool erase_range_internal (double start, double end, EventList &);
 272
 273         virtual void maybe_signal_changed ();
 274
 275         void _x_scale (double factor);
 276
 277         mutable LookupCache   _lookup_cache;
 278         mutable SearchCache   _search_cache;
 279
 280         Parameter             _parameter;
 281         InterpolationStyle    _interpolation;
 282         EventList             _events;
 283         mutable Glib::Mutex   _lock;
 284         int8_t                _frozen;
 285         bool                  _changed_when_thawed;
 286         double                _min_yval;
 287         double                _max_yval;
 288         double                _default_value;
 289         bool                  _sort_pending;
 290
 291         Curve* _curve;
 292
 293         static double _thinning_factor;
 294
 295   private:
 296     iterator   most_recent_insert_iterator;
 297     double     insert_position;
 298     bool       new_write_pass;
 299     bool       did_write_during_pass;
 300     bool       _in_write_pass;
 301     void unlocked_invalidate_insert_iterator ();
 302 };
 303
 304 } // namespace Evoral
 305
 306 #endif // EVORAL_CONTROL_LIST_HPP
 307