libs/ardour/ardour/session_event.h

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