summaryrefslogtreecommitdiffstats
path: root/src/engine/Driver.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/Driver.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/Driver.hpp')
-rw-r--r--src/engine/Driver.hpp98
1 files changed, 98 insertions, 0 deletions
diff --git a/src/engine/Driver.hpp b/src/engine/Driver.hpp
new file mode 100644
index 00000000..590b66b5
--- /dev/null
+++ b/src/engine/Driver.hpp
@@ -0,0 +1,98 @@
+/* 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 DRIVER_H
+#define DRIVER_H
+
+#include <string>
+#include <boost/utility.hpp>
+#include <raul/Path.hpp>
+#include "interface/DataType.hpp"
+#include "DuplexPort.hpp"
+
+namespace Ingen {
+
+class DuplexPort;
+
+
+/** Representation of a "system" (eg outside Ingen) port.
+ *
+ * This is the class through which the rest of the engine manages everything
+ * related to driver ports. Derived classes are expected to have a pointer to
+ * their driver (to be able to perform the operation necessary).
+ *
+ * \ingroup engine
+ */
+class DriverPort : boost::noncopyable {
+public:
+ virtual ~DriverPort() {}
+
+ /** Set the name of the system port */
+ virtual void set_name(const std::string& name) = 0;
+
+ bool is_input() const { return _patch_port->is_input(); }
+ DuplexPort* patch_port() const { return _patch_port; }
+
+protected:
+ /** is_input from the perspective outside of ingen */
+ DriverPort(DuplexPort* port) : _patch_port(port) {}
+
+ DuplexPort* _patch_port;
+};
+
+
+/** Driver abstract base class.
+ *
+ * A Driver is, from the perspective of GraphObjects (nodes, patches, ports) an
+ * interface for managing system ports. An implementation of Driver basically
+ * needs to manage DriverPorts, and handle writing/reading data to/from them.
+ *
+ * \ingroup engine
+ */
+class Driver : boost::noncopyable
+{
+public:
+ Driver(DataType type)
+ : _type(type)
+ {}
+
+ virtual ~Driver() {}
+
+ virtual void activate() = 0;
+ virtual void deactivate() = 0;
+
+ virtual bool is_activated() const = 0;
+
+ /** Create a port ready to be inserted with add_input (non realtime).
+ *
+ * May return NULL if the Driver can not drive the port for some reason.
+ */
+ virtual DriverPort* create_port(DuplexPort* patch_port) = 0;
+
+ virtual DriverPort* driver_port(const Raul::Path& path) = 0;
+
+ virtual void add_port(DriverPort* port) = 0;
+ virtual DriverPort* remove_port(const Raul::Path& path) = 0;
+
+protected:
+ DataType _type;
+};
+
+
+} // namespace Ingen
+
+#endif // DRIVER_H