summaryrefslogtreecommitdiffstats
path: root/src/engine/QueuedEvent.hpp
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2008-09-30 16:50:21 +0000
committerDavid Robillard <d@drobilla.net>2008-09-30 16:50:21 +0000
commit93850c202de8b073a1ce1dd8bd246d407bce4e2f (patch)
tree6910b135bf4eff12de1af116cef73f6e9c107cd0 /src/engine/QueuedEvent.hpp
parenta8bf5272d096de73507d2eab47f282c345f4ca8a (diff)
downloadingen-93850c202de8b073a1ce1dd8bd246d407bce4e2f.tar.gz
ingen-93850c202de8b073a1ce1dd8bd246d407bce4e2f.tar.bz2
ingen-93850c202de8b073a1ce1dd8bd246d407bce4e2f.zip
Flatten ingen source directory heirarchy a bit.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@1551 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'src/engine/QueuedEvent.hpp')
-rw-r--r--src/engine/QueuedEvent.hpp83
1 files changed, 83 insertions, 0 deletions
diff --git a/src/engine/QueuedEvent.hpp b/src/engine/QueuedEvent.hpp
new file mode 100644
index 00000000..e616d269
--- /dev/null
+++ b/src/engine/QueuedEvent.hpp
@@ -0,0 +1,83 @@
+/* This file is part of Ingen.
+ * Copyright (C) 2007 Dave Robillard <http://drobilla.net>
+ *
+ * Ingen is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ *
+ * Ingen is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef QUEUEDEVENT_H
+#define QUEUEDEVENT_H
+
+#include "Event.hpp"
+
+namespace Ingen {
+
+class QueuedEventSource;
+
+
+/** An Event with a not-time-critical preprocessing stage.
+ *
+ * These events are events that aren't able to be executed immediately by the
+ * Jack thread (because they allocate memory or whatever). They are pushed
+ * on to the QueuedEventQueue where they are preprocessed then pushed on
+ * to the realtime Event Queue when they are ready.
+ *
+ * Lookups for these events should go in the pre_process() method, since they are
+ * not time critical and shouldn't waste time in the audio thread doing
+ * lookups they can do beforehand. (This applies for any expensive operation that
+ * could be done before the execute() method).
+ *
+ * \ingroup engine
+ */
+class QueuedEvent : public Event
+{
+public:
+ /** Process this event into a realtime-suitable event.
+ */
+ virtual void pre_process();
+
+ virtual void execute(ProcessContext& context);
+
+ /** If this event blocks the prepare phase of other slow events */
+ bool is_blocking() { return _blocking; }
+
+ bool is_prepared() { return _pre_processed; }
+
+protected:
+ QueuedEvent(Engine& engine,
+ SharedPtr<Responder> responder,
+ FrameTime time,
+ bool blocking = false,
+ QueuedEventSource* source = NULL)
+ : Event(engine, responder, time)
+ , _pre_processed(false), _blocking(blocking), _source(source)
+ {
+ if (blocking)
+ assert(_source);
+ }
+
+ // NULL event base (for internal events only!)
+ QueuedEvent(Engine& engine)
+ : Event(engine, SharedPtr<Responder>(), 0)
+ , _pre_processed(false), _blocking(false), _source(NULL)
+ {}
+
+ bool _pre_processed;
+ bool _blocking;
+ QueuedEventSource* _source;
+};
+
+
+} // namespace Ingen
+
+#endif // QUEUEDEVENT_H