libs/ardour/ardour/automation_event.h

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_automation_event_h__
  21 #define __ardour_automation_event_h__
  22
  23 #include <stdint.h>
  24 #include <list>
  25 #include <cmath>
  26
  27 #include <sigc++/signal.h>
  28 #include <glibmm/thread.h>
  29
  30 #include <pbd/undo.h>
  31 #include <pbd/xml++.h>
  32 #include <pbd/statefuldestructible.h>
  33
  34 #include <ardour/ardour.h>
  35
  36 namespace ARDOUR {
  37
  38 struct ControlEvent {
  39     double when;
  40     double value;
  41
  42     ControlEvent (double w, double v)
  43             : when (w), value (v) { }
  44     ControlEvent (const ControlEvent& other)
  45             : when (other.when), value (other.value) {}
  46
  47     virtual ~ControlEvent() {}
  48
  49 //    bool operator==(const ControlEvent& other) {
  50 //          return value == other.value && when == other.when;
  51 //    }
  52
  53 };
  54
  55 class AutomationList : public PBD::StatefulDestructible
  56 {
  57   public:
  58         typedef std::list<ControlEvent*> AutomationEventList;
  59         typedef AutomationEventList::iterator iterator;
  60         typedef AutomationEventList::const_iterator const_iterator;
  61
  62         AutomationList (double default_value);
  63         AutomationList (const XMLNode&);
  64         ~AutomationList();
  65
  66         AutomationList (const AutomationList&);
  67         AutomationList (const AutomationList&, double start, double end);
  68         AutomationList& operator= (const AutomationList&);
  69         bool operator== (const AutomationList&);
  70
  71         void freeze();
  72         void thaw ();
  73
  74         AutomationEventList::size_type size() const { return events.size(); }
  75         bool empty() const { return events.empty(); }
  76
  77         void reset_default (double val) {
  78                 default_value = val;
  79         }
  80
  81         void clear ();
  82         void x_scale (double factor);
  83         bool extend_to (double);
  84         void slide (iterator before, double distance);
  85
  86         void reposition_for_rt_add (double when);
  87         void rt_add (double when, double value);
  88         void add (double when, double value);
  89         /* this should be private but old-school automation loading needs it in IO/Redirect */
  90         void fast_simple_add (double when, double value);
  91
  92         void reset_range (double start, double end);
  93         void erase_range (double start, double end);
  94         void erase (iterator);
  95         void erase (iterator, iterator);
  96         void move_range (iterator start, iterator end, double, double);
  97         void modify (iterator, double, double);
  98
  99         AutomationList* cut (double, double);
 100         AutomationList* copy (double, double);
 101         void clear (double, double);
 102
 103         AutomationList* cut (iterator, iterator);
 104         AutomationList* copy (iterator, iterator);
 105         void clear (iterator, iterator);
 106
 107         bool paste (AutomationList&, double position, float times);
 108
 109         void set_automation_state (AutoState);
 110         AutoState automation_state() const { return _state; }
 111         sigc::signal<void> automation_style_changed;
 112
 113         void set_automation_style (AutoStyle m);
 114         AutoStyle automation_style() const { return _style; }
 115         sigc::signal<void> automation_state_changed;
 116
 117         bool automation_playback() {
 118                 return (_state & Play) || ((_state & Touch) && !_touching);
 119         }
 120         bool automation_write () {
 121                 return (_state & Write) || ((_state & Touch) && _touching);
 122         }
 123
 124         void start_touch ();
 125         void stop_touch ();
 126         bool touching() const { return _touching; }
 127
 128         void set_yrange (double min, double max) {
 129                 min_yval = min;
 130                 max_yval = max;
 131         }
 132
 133         double get_max_y() const { return max_yval; }
 134         double get_min_y() const { return min_yval; }
 135
 136         void truncate_end (double length);
 137         void truncate_start (double length);
 138
 139         iterator begin() { return events.begin(); }
 140         iterator end() { return events.end(); }
 141
 142         ControlEvent* back() { return events.back(); }
 143         ControlEvent* front() { return events.front(); }
 144
 145         const_iterator const_begin() const { return events.begin(); }
 146         const_iterator const_end() const { return events.end(); }
 147
 148         std::pair<AutomationList::iterator,AutomationList::iterator> control_points_adjacent (double when);
 149
 150         template<class T> void apply_to_points (T& obj, void (T::*method)(const AutomationList&)) {
 151                 Glib::Mutex::Lock lm (lock);
 152                 (obj.*method)(*this);
 153         }
 154
 155         sigc::signal<void> StateChanged;
 156
 157         XMLNode& get_state(void);
 158         int set_state (const XMLNode &s);
 159         XMLNode& state (bool full);
 160         XMLNode& serialize_events ();
 161
 162         void set_max_xval (double);
 163         double get_max_xval() const { return max_xval; }
 164
 165         double eval (double where) {
 166                 Glib::Mutex::Lock lm (lock);
 167                 return unlocked_eval (where);
 168         }
 169
 170         double rt_safe_eval (double where, bool& ok) {
 171
 172                 Glib::Mutex::Lock lm (lock, Glib::TRY_LOCK);
 173
 174                 if ((ok = lm.locked())) {
 175                         return unlocked_eval (where);
 176                 } else {
 177                         return 0.0;
 178                 }
 179         }
 180
 181         struct TimeComparator {
 182                 bool operator() (const ControlEvent* a, const ControlEvent* b) {
 183                         return a->when < b->when;
 184                 }
 185         };
 186
 187         static sigc::signal<void, AutomationList*> AutomationListCreated;
 188
 189   protected:
 190
 191         AutomationEventList events;
 192         mutable Glib::Mutex lock;
 193         int8_t  _frozen;
 194         bool    changed_when_thawed;
 195         bool   _dirty;
 196
 197         struct LookupCache {
 198             double left;  /* leftmost x coordinate used when finding "range" */
 199             std::pair<AutomationList::iterator,AutomationList::iterator> range;
 200         };
 201
 202         LookupCache lookup_cache;
 203
 204         AutoState  _state;
 205         AutoStyle  _style;
 206         bool  _touching;
 207         bool  _new_touch;
 208         double max_xval;
 209         double min_yval;
 210         double max_yval;
 211         double default_value;
 212         bool   sort_pending;
 213
 214         iterator rt_insertion_point;
 215         double   rt_pos;
 216
 217         void maybe_signal_changed ();
 218         void mark_dirty ();
 219         void _x_scale (double factor);
 220
 221         /* called by type-specific unlocked_eval() to handle
 222            common case of 0, 1 or 2 control points.
 223         */
 224
 225         double shared_eval (double x);
 226
 227         /* called by shared_eval() to handle any case of
 228            3 or more control points.
 229         */
 230
 231         virtual double multipoint_eval (double x);
 232
 233         /* called by locked entry point and various private
 234            locations where we already hold the lock.
 235         */
 236
 237         virtual double unlocked_eval (double where);
 238
 239         virtual ControlEvent* point_factory (double,double) const;
 240         virtual ControlEvent* point_factory (const ControlEvent&) const;
 241
 242         AutomationList* cut_copy_clear (double, double, int op);
 243
 244         int deserialize_events (const XMLNode&);
 245 };
 246
 247 } // namespace
 248
 249 #endif /* __ardour_automation_event_h__ */