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                 RangeStop,
  50                 RangeLocate,
  51                 Overwrite,
  52                 SetSyncSource,
  53                 Audition,
  54                 SetPlayAudioRange,
  55                 CancelPlayAudioRange,
  56                 RealTimeOperation,
  57                 AdjustPlaybackBuffering,
  58                 AdjustCaptureBuffering,
  59                 SetTimecodeTransmission,
  60                 Skip,
  61
  62                 /* only one of each of these events can be queued at any one time */
  63
  64                 StopOnce,
  65                 AutoLoop,
  66                 AutoLoopDeclick,
  67         };
  68
  69         enum Action {
  70                 Add,
  71                 Remove,
  72                 Replace,
  73                 Clear
  74         };
  75
  76         Type       type;
  77         Action     action;
  78         samplepos_t action_sample;
  79         samplepos_t target_sample;
  80         double     speed;
  81
  82         union {
  83                 void*        ptr;
  84                 bool         yes_or_no;
  85                 samplepos_t   target2_sample;
  86                 Slave*       slave;
  87                 Route*       route;
  88         };
  89
  90         union {
  91                 bool second_yes_or_no;
  92                 double control_value;
  93         };
  94
  95         union {
  96                 bool third_yes_or_no;
  97         };
  98
  99         /* 5 members to handle a multi-group event handled in RT context */
 100
 101         typedef boost::function<void (SessionEvent*)> RTeventCallback;
 102
 103         boost::shared_ptr<ControlList> controls; /* apply to */
 104         boost::shared_ptr<RouteList> routes;     /* apply to */
 105         boost::function<void (void)> rt_slot;    /* what to call in RT context */
 106         RTeventCallback              rt_return;  /* called after rt_slot, with this event as an argument */
 107         PBD::EventLoop*              event_loop;
 108
 109         std::list<AudioRange> audio_range;
 110         std::list<MusicRange> music_range;
 111
 112         boost::shared_ptr<Region> region;
 113
 114         SessionEvent (Type t, Action a, samplepos_t when, samplepos_t where, double spd, bool yn = false, bool yn2 = false, bool yn3 = false);
 115
 116         void set_ptr (void* p) {
 117                 ptr = p;
 118         }
 119
 120         bool before (const SessionEvent& other) const {
 121                 return action_sample < other.action_sample;
 122         }
 123
 124         bool after (const SessionEvent& other) const {
 125                 return action_sample > other.action_sample;
 126         }
 127
 128         static bool compare (const SessionEvent *e1, const SessionEvent *e2) {
 129                 return e1->before (*e2);
 130         }
 131
 132         void* operator new (size_t);
 133         void  operator delete (void *ptr, size_t /*size*/);
 134
 135         static const samplepos_t Immediate = -1;
 136
 137         static bool has_per_thread_pool ();
 138         static void create_per_thread_pool (const std::string& n, uint32_t nitems);
 139         static void init_event_pool ();
 140
 141         CrossThreadPool* event_pool() const { return own_pool; }
 142
 143 private:
 144         static PerThreadPool* pool;
 145         CrossThreadPool* own_pool;
 146
 147         friend class Butler;
 148 };
 149
 150 class SessionEventManager {
 151 public:
 152         SessionEventManager () : pending_events (2048),
 153                                  auto_loop_event(0), punch_out_event(0), punch_in_event(0) {}
 154         virtual ~SessionEventManager() {}
 155
 156         virtual void queue_event (SessionEvent *ev) = 0;
 157         void clear_events (SessionEvent::Type type);
 158         void clear_events (SessionEvent::Type type, boost::function<void (void)> after);
 159
 160 protected:
 161         PBD::RingBuffer<SessionEvent*> pending_events;
 162         typedef std::list<SessionEvent *> Events;
 163         Events           events;
 164         Events           immediate_events;
 165         Events::iterator next_event;
 166
 167         Glib::Threads::Mutex rb_write_lock;
 168
 169         /* there can only ever be one of each of these */
 170
 171         SessionEvent *auto_loop_event;
 172         SessionEvent *punch_out_event;
 173         SessionEvent *punch_in_event;
 174
 175         void dump_events () const;
 176         void merge_event (SessionEvent*);
 177         void replace_event (SessionEvent::Type, samplepos_t action_sample, samplepos_t target = 0);
 178         bool _replace_event (SessionEvent*);
 179         bool _remove_event (SessionEvent *);
 180         void _clear_event_type (SessionEvent::Type);
 181
 182         void add_event (samplepos_t action_sample, SessionEvent::Type type, samplepos_t target_sample = 0);
 183         void remove_event (samplepos_t sample, SessionEvent::Type type);
 184
 185         virtual void process_event(SessionEvent*) = 0;
 186         virtual void set_next_event () = 0;
 187 };
 188
 189 } /* namespace */
 190
 191 #endif /* __ardour_session_event_h__ */