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/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                 SetTrackSpeed,
  44                 Locate,
  45                 LocateRoll,
  46                 LocateRollLocate,
  47                 SetLoop,
  48                 PunchIn,
  49                 PunchOut,
  50                 RangeStop,
  51                 RangeLocate,
  52                 Overwrite,
  53                 SetSyncSource,
  54                 Audition,
  55                 InputConfigurationChange,
  56                 SetPlayAudioRange,
  57                 RealTimeOperation,
  58                 AdjustPlaybackBuffering,
  59                 AdjustCaptureBuffering,
  60                 SetTimecodeTransmission,
  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         framepos_t action_frame;
  79         framepos_t target_frame;
  80         double     speed;
  81
  82         union {
  83                 void*        ptr;
  84                 bool         yes_or_no;
  85                 framepos_t  target2_frame;
  86                 Slave*       slave;
  87                 Route*       route;
  88         };
  89
  90         union {
  91                 bool second_yes_or_no;
  92         };
  93
  94         union {
  95                 bool third_yes_or_no;
  96         };
  97
  98         /* 4 members to handle a multi-group event handled in RT context */
  99
 100         typedef boost::function<void (SessionEvent*)> RTeventCallback;
 101
 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;
 106
 107         std::list<AudioRange> audio_range;
 108         std::list<MusicRange> music_range;
 109
 110         boost::shared_ptr<Region> region;
 111
 112     SessionEvent (Type t, Action a, framepos_t when, framepos_t where, double spd, bool yn = false, bool yn2 = false, bool yn3 = false)
 113                 : type (t)
 114                 , action (a)
 115                 , action_frame (when)
 116                 , target_frame (where)
 117                 , speed (spd)
 118                 , yes_or_no (yn)
 119                 , second_yes_or_no (yn2)
 120                 , third_yes_or_no (yn3)
 121                 , event_loop (0) {}
 122
 123         void set_ptr (void* p) {
 124                 ptr = p;
 125         }
 126
 127         bool before (const SessionEvent& other) const {
 128                 return action_frame < other.action_frame;
 129         }
 130
 131         bool after (const SessionEvent& other) const {
 132                 return action_frame > other.action_frame;
 133         }
 134
 135         static bool compare (const SessionEvent *e1, const SessionEvent *e2) {
 136                 return e1->before (*e2);
 137         }
 138
 139         void* operator new (size_t);
 140         void  operator delete (void *ptr, size_t /*size*/);
 141
 142         static const framepos_t Immediate = 0;
 143
 144         static void create_per_thread_pool (const std::string& n, uint32_t nitems);
 145         static void init_event_pool ();
 146
 147 private:
 148         static PerThreadPool* pool;
 149         CrossThreadPool* own_pool;
 150
 151         friend class Butler;
 152 };
 153
 154 class LIBARDOUR_API SessionEventManager {
 155 public:
 156         SessionEventManager () : pending_events (2048),
 157                                  auto_loop_event(0), punch_out_event(0), punch_in_event(0) {}
 158         virtual ~SessionEventManager() {}
 159
 160         virtual void queue_event (SessionEvent *ev) = 0;
 161         void clear_events (SessionEvent::Type type);
 162
 163 protected:
 164         RingBuffer<SessionEvent*> pending_events;
 165         typedef std::list<SessionEvent *> Events;
 166         Events           events;
 167         Events           immediate_events;
 168         Events::iterator next_event;
 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__ */