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