2 Copyright (C) 2012 Paul Davis
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.
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.
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.
20 #ifndef __ardour_session_event_h__
21 #define __ardour_session_event_h__
24 #include <boost/function.hpp>
25 #include <boost/shared_ptr.hpp>
28 #include "pbd/ringbuffer.h"
29 #include "pbd/event_loop.h"
31 #include "ardour/libardour_visibility.h"
32 #include "ardour/types.h"
39 class LIBARDOUR_API SessionEvent {
55 InputConfigurationChange,
58 AdjustPlaybackBuffering,
59 AdjustCaptureBuffering,
60 SetTimecodeTransmission,
62 /* only one of each of these events can be queued at any one time */
78 framepos_t action_frame;
79 framepos_t target_frame;
85 framepos_t target2_frame;
91 bool second_yes_or_no;
98 /* 4 members to handle a multi-group event handled in RT context */
100 typedef boost::function<void (SessionEvent*)> RTeventCallback;
102 boost::shared_ptr<RouteList> routes; /* apply to */
103 boost::function<void (void)> rt_slot; /* what to call in RT context */
104 RTeventCallback rt_return; /* called after rt_slot, with this event as an argument */
105 PBD::EventLoop* event_loop;
107 std::list<AudioRange> audio_range;
108 std::list<MusicRange> music_range;
110 boost::shared_ptr<Region> region;
112 SessionEvent (Type t, Action a, framepos_t when, framepos_t where, double spd, bool yn = false, bool yn2 = false, bool yn3 = false)
115 , action_frame (when)
116 , target_frame (where)
119 , second_yes_or_no (yn2)
120 , third_yes_or_no (yn3)
123 void set_ptr (void* p) {
127 bool before (const SessionEvent& other) const {
128 return action_frame < other.action_frame;
131 bool after (const SessionEvent& other) const {
132 return action_frame > other.action_frame;
135 static bool compare (const SessionEvent *e1, const SessionEvent *e2) {
136 return e1->before (*e2);
139 void* operator new (size_t);
140 void operator delete (void *ptr, size_t /*size*/);
142 static const framepos_t Immediate = 0;
144 static void create_per_thread_pool (const std::string& n, uint32_t nitems);
145 static void init_event_pool ();
148 static PerThreadPool* pool;
149 CrossThreadPool* own_pool;
154 class LIBARDOUR_API SessionEventManager {
156 SessionEventManager () : pending_events (2048),
157 auto_loop_event(0), punch_out_event(0), punch_in_event(0) {}
158 virtual ~SessionEventManager() {}
160 virtual void queue_event (SessionEvent *ev) = 0;
161 void clear_events (SessionEvent::Type type);
164 RingBuffer<SessionEvent*> pending_events;
165 typedef std::list<SessionEvent *> Events;
167 Events immediate_events;
168 Events::iterator next_event;
170 /* there can only ever be one of each of these */
172 SessionEvent *auto_loop_event;
173 SessionEvent *punch_out_event;
174 SessionEvent *punch_in_event;
176 void dump_events () const;
177 void merge_event (SessionEvent*);
178 void replace_event (SessionEvent::Type, framepos_t action_frame, framepos_t target = 0);
179 bool _replace_event (SessionEvent*);
180 bool _remove_event (SessionEvent *);
181 void _clear_event_type (SessionEvent::Type);
183 void add_event (framepos_t action_frame, SessionEvent::Type type, framepos_t target_frame = 0);
184 void remove_event (framepos_t frame, SessionEvent::Type type);
186 virtual void process_event(SessionEvent*) = 0;
187 virtual void set_next_event () = 0;
192 #endif /* __ardour_session_event_h__ */