Optimize plugin-processing for non-automated params
[ardour.git] / libs / ardour / ardour / automation_list.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 <cstdlib>
25 #include <list>
26 #include <cmath>
27
28 #include <glibmm/threads.h>
29
30 #include "evoral/ControlList.hpp"
31 #include "evoral/Parameter.hpp"
32
33 #include "pbd/undo.h"
34 #include "pbd/xml++.h"
35 #include "pbd/statefuldestructible.h"
36 #include "pbd/properties.h"
37
38 #include "ardour/ardour.h"
39
40 namespace ARDOUR {
41
42 class AutomationList;
43 class DoubleBeatsSamplesConverter;
44
45 /** A SharedStatefulProperty for AutomationLists */
46 class LIBARDOUR_API AutomationListProperty : public PBD::SharedStatefulProperty<AutomationList>
47 {
48 public:
49         AutomationListProperty (PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > d, Ptr p)
50                 : PBD::SharedStatefulProperty<AutomationList> (d.property_id, p)
51         {}
52
53         AutomationListProperty (PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > d, Ptr o, Ptr c)
54                 : PBD::SharedStatefulProperty<AutomationList> (d.property_id, o, c)
55         {}
56
57         PBD::PropertyBase* clone () const;
58
59 private:
60         /* No copy-construction nor assignment */
61         AutomationListProperty (AutomationListProperty const &);
62         AutomationListProperty& operator= (AutomationListProperty const &);
63 };
64
65 /** AutomationList is a stateful wrapper around Evoral::ControlList.
66  * It includes session-specifics (such as automation state), control logic (e.g. touch, signals)
67  * and acts as proxy to the underlying ControlList which holds the actual data.
68  */
69 class LIBARDOUR_API AutomationList : public Evoral::ControlList, public PBD::StatefulDestructible
70 {
71 public:
72         AutomationList (const Evoral::Parameter& id, const Evoral::ParameterDescriptor& desc);
73         AutomationList (const Evoral::Parameter& id);
74         AutomationList (const XMLNode&, Evoral::Parameter id);
75         AutomationList (const AutomationList&);
76         AutomationList (const AutomationList&, double start, double end);
77         ~AutomationList();
78
79         virtual boost::shared_ptr<ControlList> create(const Evoral::Parameter&           id,
80                                                       const Evoral::ParameterDescriptor& desc);
81
82         AutomationList& operator= (const AutomationList&);
83
84         void thaw ();
85         bool paste (const ControlList&, double, DoubleBeatsSamplesConverter const&);
86
87         void set_automation_state (AutoState);
88         AutoState automation_state() const;
89         PBD::Signal1<void, AutoState> automation_state_changed;
90
91         bool automation_playback() const {
92                 return (_state & Play) || ((_state & (Touch | Latch)) && !touching());
93         }
94         bool automation_write () const {
95                 return ((_state & Write) || ((_state & (Touch | Latch)) && touching()));
96         }
97
98         PBD::Signal0<void> StateChanged;
99
100         static PBD::Signal1<void,AutomationList*> AutomationListCreated;
101
102         void start_write_pass (double when);
103         void write_pass_finished (double when, double thinning_factor=0.0);
104
105         void start_touch (double when);
106         void stop_touch (double when);
107         bool touching() const { return g_atomic_int_get (const_cast<gint*>(&_touching)); }
108         bool writing() const { return _state == Write; }
109         bool touch_enabled() const { return _state & (Touch | Latch); }
110
111         XMLNode& get_state ();
112         int set_state (const XMLNode &, int version);
113
114         Command* memento_command (XMLNode* before, XMLNode* after);
115
116         bool operator!= (const AutomationList &) const;
117
118         XMLNode* before () { XMLNode* rv = _before; _before = 0; return rv; }
119         void clear_history ();
120         void snapshot_history (bool need_lock);
121
122         ControlList::InterpolationStyle default_interpolation () const;
123
124 private:
125         void create_curve_if_necessary ();
126         int deserialize_events (const XMLNode&);
127
128         XMLNode& state (bool save_auto_state, bool need_lock);
129         XMLNode& serialize_events (bool need_lock);
130
131         void maybe_signal_changed ();
132
133         AutoState    _state;
134         gint         _touching;
135
136         PBD::ScopedConnection _writepass_connection;
137
138         bool operator== (const AutomationList&) const { /* not called */ abort(); return false; }
139         XMLNode* _before; //used for undo of touch start/stop pairs.
140
141 };
142
143 } // namespace
144
145 #endif /* __ardour_automation_event_h__ */