libs/ardour/ardour/session_event.h

   1 /*
   2     Copyright (C) 2012 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_session_event_h__
  21 #define __ardour_session_event_h__
  22
  23 #include <list>
  24 #include <boost/function.hpp>
  25 #include <boost/shared_ptr.hpp>
  26
  27 #include "pbd/pool.h"
  28 #include "pbd/ringbuffer.h"
  29 #include "pbd/event_loop.h"
  30
  31 #include "ardour/libardour_visibility.h"
  32 #include "ardour/types.h"
  33
  34 namespace ARDOUR {
  35
  36 class Slave;
  37 class Region;
  38
  39 class LIBARDOUR_API SessionEvent {
  40 public:
  41         enum Type {
  42                 SetTransportSpeed,
  43                 Locate,
  44                 LocateRoll,
  45                 LocateRollLocate,
  46                 SetLoop,
  47                 PunchIn,
  48                 PunchOut,
  49                 RecordStart,
  50                 RangeStop,
  51                 RangeLocate,
  52                 Overwrite,
  53                 SetSyncSource,
  54                 Audition,
  55                 SetPlayAudioRange,
  56                 CancelPlayAudioRange,
  57                 RealTimeOperation,
  58                 AdjustPlaybackBuffering,
  59                 AdjustCaptureBuffering,
  60                 SetTimecodeTransmission,
  61                 Skip,
  62
  63                 /* only one of each of these events can be queued at any one time */
  64
  65                 StopOnce,
  66                 AutoLoop,
  67                 AutoLoopDeclick,
  68         };
  69
  70         enum Action {
  71                 Add,
  72                 Remove,
  73                 Replace,
  74                 Clear
  75         };
  76
  77         Type       type;
  78         Action     action;
  79         framepos_t action_frame;
  80         framepos_t target_frame;
  81         double     speed;
  82
  83         union {
  84                 void*        ptr;
  85                 bool         yes_or_no;
  86                 framepos_t   target2_frame;
  87                 Slave*       slave;
  88                 Route*       route;
  89         };
  90
  91         union {
  92                 bool second_yes_or_no;
  93                 double control_value;
  94         };
  95
  96         union {
  97                 bool third_yes_or_no;
  98         };
  99
 100         /* 5 members to handle a multi-group event handled in RT context */
 101
 102         typedef boost::function<void (SessionEvent*)> RTeventCallback;
 103
 104         boost::shared_ptr<ControlList> controls; /* apply to */
 105         boost::shared_ptr<RouteList> routes;     /* apply to */
 106         boost::function<void (void)> rt_slot;    /* what to call in RT context */
 107         RTeventCallback              rt_return;  /* called after rt_slot, with this event as an argument */
 108         PBD::EventLoop*              event_loop;
 109
 110         std::list<AudioRange> audio_range;
 111         std::list<MusicRange> music_range;
 112
 113         boost::shared_ptr<Region> region;
 114
 115         SessionEvent (Type t, Action a, framepos_t when, framepos_t where, double spd, bool yn = false, bool yn2 = false, bool yn3 = false);
 116
 117         void set_ptr (void* p) {
 118                 ptr = p;
 119         }
 120
 121         bool before (const SessionEvent& other) const {
 122                 return action_frame < other.action_frame;
 123         }
 124
 125         bool after (const SessionEvent& other) const {
 126                 return action_frame > other.action_frame;
 127         }
 128
 129         static bool compare (const SessionEvent *e1, const SessionEvent *e2) {
 130                 return e1->before (*e2);
 131         }
 132
 133         void* operator new (size_t);
 134         void  operator delete (void *ptr, size_t /*size*/);
 135
 136         static const framepos_t Immediate = -1;
 137
 138         static bool has_per_thread_pool ();
 139         static void create_per_thread_pool (const std::string& n, uint32_t nitems);
 140         static void init_event_pool ();
 141
 142         CrossThreadPool* event_pool() const { return own_pool; }
 143
 144 private:
 145         static PerThreadPool* pool;
 146         CrossThreadPool* own_pool;
 147
 148         friend class Butler;
 149 };
 150
 151 class SessionEventManager {
 152 public:
 153         SessionEventManager () : pending_events (2048),
 154                                  auto_loop_event(0), punch_out_event(0), punch_in_event(0) {}
 155         virtual ~SessionEventManager() {}
 156
 157         virtual void queue_event (SessionEvent *ev) = 0;
 158         void clear_events (SessionEvent::Type type);
 159         void clear_events (SessionEvent::Type type, boost::function<void (void)> after);
 160
 161 protected:
 162         PBD::RingBuffer<SessionEvent*> pending_events;
 163         typedef std::list<SessionEvent *> Events;
 164         Events           events;
 165         Events           immediate_events;
 166         Events::iterator next_event;
 167
 168         Glib::Threads::Mutex rb_write_lock;
 169
 170         /* there can only ever be one of each of these */
 171
 172         SessionEvent *auto_loop_event;
 173         SessionEvent *punch_out_event;
 174         SessionEvent *punch_in_event;
 175
 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);
 182
 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);
 185
 186         virtual void process_event(SessionEvent*) = 0;
 187         virtual void set_next_event () = 0;
 188 };
 189
 190 } /* namespace */
 191
 192 #endif /* __ardour_session_event_h__ */