libs/ardour/session_events.cc

   1 /*
   2     Copyright (C) 1999-2004 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 #include <cmath>
  21 #include <unistd.h>
  22
  23 #include "pbd/error.h"
  24 #include "pbd/enumwriter.h"
  25 #include "pbd/stacktrace.h"
  26
  27 #include "ardour/debug.h"
  28 #include "ardour/session_event.h"
  29
  30 #include "i18n.h"
  31
  32 using namespace std;
  33 using namespace ARDOUR;
  34 using namespace PBD;
  35
  36 PerThreadPool* SessionEvent::pool;
  37
  38 void
  39 SessionEvent::init_event_pool ()
  40 {
  41         pool = new PerThreadPool;
  42 }
  43
  44 void
  45 SessionEvent::create_per_thread_pool (const std::string& name, uint32_t nitems)
  46 {
  47         /* this is a per-thread call that simply creates a thread-private ptr to
  48            a CrossThreadPool for use by this thread whenever events are allocated/released
  49            from SessionEvent::pool()
  50         */
  51         pool->create_per_thread_pool (name, sizeof (SessionEvent), nitems);
  52 }
  53
  54 void *
  55 SessionEvent::operator new (size_t)
  56 {
  57         CrossThreadPool* p = pool->per_thread_pool ();
  58         SessionEvent* ev = static_cast<SessionEvent*> (p->alloc ());
  59         DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("%1 Allocating SessionEvent from %2 ev @ %3\n", pthread_self(), p->name(), ev));
  60 #ifndef NDEBUG
  61         if (DEBUG::SessionEvents & PBD::debug_bits) {
  62                 stacktrace (cerr, 40);
  63         }
  64 #endif
  65         ev->own_pool = p;
  66         return ev;
  67 }
  68
  69 void
  70 SessionEvent::operator delete (void *ptr, size_t /*size*/)
  71 {
  72         Pool* p = pool->per_thread_pool ();
  73         SessionEvent* ev = static_cast<SessionEvent*> (ptr);
  74
  75         DEBUG_TRACE (DEBUG::SessionEvents, string_compose (
  76                              "%1 Deleting SessionEvent @ %2 ev thread pool = %3 ev pool = %4\n",
  77                              pthread_self(), ev, p->name(), ev->own_pool->name()
  78                              ));
  79
  80 #ifndef NDEBUG
  81         if (DEBUG::SessionEvents & PBD::debug_bits) {
  82                 stacktrace (cerr, 40);
  83         }
  84 #endif
  85
  86         if (p == ev->own_pool) {
  87                 p->release (ptr);
  88         } else {
  89                 ev->own_pool->push (ev);
  90         }
  91 }
  92
  93 void
  94 SessionEventManager::add_event (framepos_t frame, SessionEvent::Type type, framepos_t target_frame)
  95 {
  96         SessionEvent* ev = new SessionEvent (type, SessionEvent::Add, frame, target_frame, 0);
  97         queue_event (ev);
  98 }
  99
 100 void
 101 SessionEventManager::remove_event (framepos_t frame, SessionEvent::Type type)
 102 {
 103         SessionEvent* ev = new SessionEvent (type, SessionEvent::Remove, frame, 0, 0);
 104         queue_event (ev);
 105 }
 106
 107 void
 108 SessionEventManager::replace_event (SessionEvent::Type type, framepos_t frame, framepos_t target)
 109 {
 110         SessionEvent* ev = new SessionEvent (type, SessionEvent::Replace, frame, target, 0);
 111         queue_event (ev);
 112 }
 113
 114 void
 115 SessionEventManager::clear_events (SessionEvent::Type type)
 116 {
 117         SessionEvent* ev = new SessionEvent (type, SessionEvent::Clear, 0, 0, 0);
 118         queue_event (ev);
 119 }
 120
 121
 122 void
 123 SessionEventManager::dump_events () const
 124 {
 125         cerr << "EVENT DUMP" << endl;
 126         for (Events::const_iterator i = events.begin(); i != events.end(); ++i) {
 127                 cerr << "\tat " << (*i)->action_frame << ' ' << (*i)->type << " target = " << (*i)->target_frame << endl;
 128         }
 129         cerr << "Next event: ";
 130
 131         if ((Events::const_iterator) next_event == events.end()) {
 132                 cerr << "none" << endl;
 133         } else {
 134                 cerr << "at " << (*next_event)->action_frame << ' '
 135                      << (*next_event)->type << " target = "
 136                      << (*next_event)->target_frame << endl;
 137         }
 138         cerr << "Immediate events pending:\n";
 139         for (Events::const_iterator i = immediate_events.begin(); i != immediate_events.end(); ++i) {
 140                 cerr << "\tat " << (*i)->action_frame << ' ' << (*i)->type << " target = " << (*i)->target_frame << endl;
 141         }
 142         cerr << "END EVENT_DUMP" << endl;
 143 }
 144
 145 void
 146 SessionEventManager::merge_event (SessionEvent* ev)
 147 {
 148         switch (ev->action) {
 149         case SessionEvent::Remove:
 150                 _remove_event (ev);
 151                 delete ev;
 152                 return;
 153
 154         case SessionEvent::Replace:
 155                 _replace_event (ev);
 156                 return;
 157
 158         case SessionEvent::Clear:
 159                 _clear_event_type (ev->type);
 160                 delete ev;
 161                 return;
 162
 163         case SessionEvent::Add:
 164                 break;
 165         }
 166
 167         /* try to handle immediate events right here */
 168
 169         if (ev->action_frame == 0) {
 170                 process_event (ev);
 171                 return;
 172         }
 173
 174         switch (ev->type) {
 175         case SessionEvent::AutoLoop:
 176         case SessionEvent::AutoLoopDeclick:
 177         case SessionEvent::StopOnce:
 178                 _clear_event_type (ev->type);
 179                 break;
 180
 181         default:
 182                 for (Events::iterator i = events.begin(); i != events.end(); ++i) {
 183                         if ((*i)->type == ev->type && (*i)->action_frame == ev->action_frame) {
 184                           error << string_compose(_("Session: cannot have two events of type %1 at the same frame (%2)."),
 185                                                   enum_2_string (ev->type), ev->action_frame) << endmsg;
 186                                 return;
 187                         }
 188                 }
 189         }
 190
 191         events.insert (events.begin(), ev);
 192         events.sort (SessionEvent::compare);
 193         next_event = events.begin();
 194         set_next_event ();
 195 }
 196
 197 /** @return true when @a ev is deleted. */
 198 bool
 199 SessionEventManager::_replace_event (SessionEvent* ev)
 200 {
 201         bool ret = false;
 202         Events::iterator i;
 203
 204         /* private, used only for events that can only exist once in the queue */
 205
 206         for (i = events.begin(); i != events.end(); ++i) {
 207                 if ((*i)->type == ev->type) {
 208                         (*i)->action_frame = ev->action_frame;
 209                         (*i)->target_frame = ev->target_frame;
 210                         if ((*i) == ev) {
 211                                 ret = true;
 212                         }
 213                         delete ev;
 214                         break;
 215                 }
 216         }
 217
 218         if (i == events.end()) {
 219                 events.insert (events.begin(), ev);
 220         }
 221
 222         events.sort (SessionEvent::compare);
 223         next_event = events.end();
 224         set_next_event ();
 225
 226         return ret;
 227 }
 228
 229 /** @return true when @a ev is deleted. */
 230 bool
 231 SessionEventManager::_remove_event (SessionEvent* ev)
 232 {
 233         bool ret = false;
 234         Events::iterator i;
 235
 236         for (i = events.begin(); i != events.end(); ++i) {
 237                 if ((*i)->type == ev->type && (*i)->action_frame == ev->action_frame) {
 238                         if ((*i) == ev) {
 239                                 ret = true;
 240                         }
 241
 242                         delete *i;
 243                         if (i == next_event) {
 244                                 ++next_event;
 245                         }
 246                         events.erase (i);
 247                         break;
 248                 }
 249         }
 250
 251         if (i != events.end()) {
 252                 set_next_event ();
 253         }
 254
 255         return ret;
 256 }
 257
 258 void
 259 SessionEventManager::_clear_event_type (SessionEvent::Type type)
 260 {
 261         Events::iterator i, tmp;
 262
 263         for (i = events.begin(); i != events.end(); ) {
 264
 265                 tmp = i;
 266                 ++tmp;
 267
 268                 if ((*i)->type == type) {
 269                         delete *i;
 270                         if (i == next_event) {
 271                                 ++next_event;
 272                         }
 273                         events.erase (i);
 274                 }
 275
 276                 i = tmp;
 277         }
 278
 279         for (i = immediate_events.begin(); i != immediate_events.end(); ) {
 280
 281                 tmp = i;
 282                 ++tmp;
 283
 284                 if ((*i)->type == type) {
 285                         delete *i;
 286                         immediate_events.erase (i);
 287                 }
 288
 289                 i = tmp;
 290         }
 291
 292         set_next_event ();
 293 }
 294