summaryrefslogtreecommitdiffstats
path: root/src/libs/engine/QueuedEngineInterface.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2006-06-10 01:52:02 +0000
committerDavid Robillard <d@drobilla.net>2006-06-10 01:52:02 +0000
commit98fe0e7056e6697396249531785d3899f94d79be (patch)
tree233319008d4bfb6c8bdc546bdf4a81b87ecf7f3a /src/libs/engine/QueuedEngineInterface.h
parent6c8eaee73b0ea66216744f49b452e22e26fe83e1 (diff)
downloadingen-98fe0e7056e6697396249531785d3899f94d79be.tar.gz
ingen-98fe0e7056e6697396249531785d3899f94d79be.tar.bz2
ingen-98fe0e7056e6697396249531785d3899f94d79be.zip
More juggling
git-svn-id: http://svn.drobilla.net/lad/grauph@15 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'src/libs/engine/QueuedEngineInterface.h')
-rw-r--r--src/libs/engine/QueuedEngineInterface.h145
1 files changed, 145 insertions, 0 deletions
diff --git a/src/libs/engine/QueuedEngineInterface.h b/src/libs/engine/QueuedEngineInterface.h
new file mode 100644
index 00000000..cc9c575f
--- /dev/null
+++ b/src/libs/engine/QueuedEngineInterface.h
@@ -0,0 +1,145 @@
+/* This file is part of Om. Copyright (C) 2006 Dave Robillard.
+ *
+ * Om 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.
+ *
+ * Om 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.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef QUEUEDENGINEINTERFACE_H
+#define QUEUEDENGINEINTERFACE_H
+
+#include <inttypes.h>
+#include <string>
+#include <memory>
+#include "util/CountedPtr.h"
+#include "interface/ClientInterface.h"
+#include "interface/ClientKey.h"
+#include "QueuedEventSource.h"
+#include "Responder.h"
+using std::string;
+
+namespace Om {
+
+using Shared::ClientKey;
+using Shared::ClientInterface;
+
+
+/** A queued (preprocessed) event source / interface.
+ *
+ * This is the bridge between the EngineInterface presented to the client, and
+ * the EventSource that needs to be presented to the AudioDriver.
+ *
+ * This is sort of a state machine, \ref set_responder sets the Responder that
+ * will be used to send the response from all future function calls. Stateless
+ * protocols like UDP/OSC can use this to set a different response address for
+ * each event (eg incoming UDP port), but engine/client interfaces that don't
+ * need to change an 'address' constantly can just set it once on initialisation.
+ * Blocking control interfaces can be made by setting a Responder which signals
+ * the caller when the 'response' is 'sent'.
+ *
+ * If you do not register a responder, you have no way of knowing if your calls
+ * are successful.
+ *
+ * FIXME: this isn't really "queued" entirely, since some events aren't queued
+ * events and get pushed directly into the realtime event queue. Should that
+ * be separated into a different interface/client?
+ */
+class QueuedEngineInterface : public Om::QueuedEventSource
+{
+public:
+ QueuedEngineInterface(size_t queue_size);
+ virtual ~QueuedEngineInterface() {}
+
+ virtual void set_responder(CountedPtr<Responder> responder);
+ virtual void disable_responses();
+
+ // Client registration
+ virtual void register_client(ClientKey key, CountedPtr<ClientInterface> client);
+ virtual void unregister_client(ClientKey key);
+
+
+ // Engine commands
+ virtual void load_plugins();
+ virtual void activate();
+ virtual void deactivate();
+ virtual void quit();
+
+ // Object commands
+
+ virtual void create_patch(const string& path,
+ uint32_t poly);
+
+ virtual void create_node(const string& path,
+ const string& plugin_type,
+ const string& plugin_uri,
+ bool polyphonic);
+
+ virtual void rename(const string& old_path,
+ const string& new_name);
+
+ virtual void destroy(const string& path);
+
+ virtual void clear_patch(const string& patch_path);
+
+ virtual void enable_patch(const string& patch_path);
+
+ virtual void disable_patch(const string& patch_path);
+
+ virtual void connect(const string& src_port_path,
+ const string& dst_port_path);
+
+ virtual void disconnect(const string& src_port_path,
+ const string& dst_port_path);
+
+ virtual void disconnect_all(const string& node_path);
+
+ virtual void set_port_value(const string& port_path,
+ float val);
+
+ virtual void set_port_value(const string& port_path,
+ uint32_t voice,
+ float val);
+
+ virtual void set_port_value_queued(const string& port_path,
+ float val);
+
+ virtual void set_program(const string& node_path,
+ uint32_t bank,
+ uint32_t program);
+
+ virtual void midi_learn(const string& node_path);
+
+ virtual void set_metadata(const string& path,
+ const string& predicate,
+ const string& value);
+
+ // Requests //
+
+ virtual void ping();
+
+ virtual void request_port_value(const string& port_path);
+
+ virtual void request_plugins();
+
+ virtual void request_all_objects();
+
+protected:
+
+ /** Where responses to current messages will go. */
+ CountedPtr<Responder> _responder;
+};
+
+
+} // namespace Om
+
+#endif // QUEUEDENGINEINTERFACE_H
+