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