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 {
56 InputConfigurationChange,
60 AdjustPlaybackBuffering,
61 AdjustCaptureBuffering,
62 SetTimecodeTransmission,
65 /* only one of each of these events can be queued at any one time */
81 framepos_t action_frame;
82 framepos_t target_frame;
88 framepos_t target2_frame;
94 bool second_yes_or_no;
102 /* 5 members to handle a multi-group event handled in RT context */
104 typedef boost::function<void (SessionEvent*)> RTeventCallback;
106 boost::shared_ptr<ControlList> controls; /* apply to */
107 boost::shared_ptr<RouteList> routes; /* apply to */
108 boost::function<void (void)> rt_slot; /* what to call in RT context */
109 RTeventCallback rt_return; /* called after rt_slot, with this event as an argument */
110 PBD::EventLoop* event_loop;
112 std::list<AudioRange> audio_range;
113 std::list<MusicRange> music_range;
115 boost::shared_ptr<Region> region;
117 SessionEvent (Type t, Action a, framepos_t when, framepos_t where, double spd, bool yn = false, bool yn2 = false, bool yn3 = false);
119 void set_ptr (void* p) {
123 bool before (const SessionEvent& other) const {
124 return action_frame < other.action_frame;
127 bool after (const SessionEvent& other) const {
128 return action_frame > other.action_frame;
131 static bool compare (const SessionEvent *e1, const SessionEvent *e2) {
132 return e1->before (*e2);
135 void* operator new (size_t);
136 void operator delete (void *ptr, size_t /*size*/);
138 static const framepos_t Immediate = -1;
140 static bool has_per_thread_pool ();
141 static void create_per_thread_pool (const std::string& n, uint32_t nitems);
142 static void init_event_pool ();
144 CrossThreadPool* event_pool() const { return own_pool; }
147 static PerThreadPool* pool;
148 CrossThreadPool* own_pool;
153 class SessionEventManager {
155 SessionEventManager () : pending_events (2048),
156 auto_loop_event(0), punch_out_event(0), punch_in_event(0) {}
157 virtual ~SessionEventManager() {}
159 virtual void queue_event (SessionEvent *ev) = 0;
160 void clear_events (SessionEvent::Type type);
161 void clear_events (SessionEvent::Type type, boost::function<void (void)> after);
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__ */