Shared abstract Node interface.

git-svn-id: http://svn.drobilla.net/lad/ingen@835 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 0 insertions, 159 deletions

diff --git a/src/libs/engine/Node.hpp b/src/libs/engine/Node.hpp
deleted file mode 100644
index 083ceea2..00000000
--- a/src/libs/engine/Node.hpp
+++ /dev/null
@@ -1,159 +0,0 @@
-/* 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 NODE_H
-#define NODE_H
-
-#include <string>
-#include <raul/Array.hpp>
-#include "types.hpp"
-#include "GraphObjectImpl.hpp"
-
-namespace Raul { template <typename T> class List; class Maid; }
-
-namespace Ingen {
-
-class Buffer;
-class Plugin;
-class Patch;
-class Port;
-class OutputPort;
-namespace Shared { class ClientInterface; }
-
-
-/** A Node (or "module") in a Patch (which is also a Node).
- * 
- * A Node is a unit with input/output ports, a process() method, and some other
- * things.
- * 
- * This is a pure abstract base class for any Node, it contains no
- * implementation details/data whatsoever.  This is the interface you need to
- * implement to add a new Node type.
- *
- * \ingroup engine
- */
-class Node : public GraphObjectImpl
-{
-public:
-	Node(GraphObjectImpl* parent, const std::string& name, bool poly)
-		: GraphObjectImpl(parent, name, poly)
-	{}
-
-	virtual ~Node() {}
-
-	/** Activate this Node.
-	 *
-	 * This function will be called in a non-realtime thread before it is
-	 * inserted in to a patch.  Any non-realtime actions that need to be
-	 * done before the Node is ready for use should be done here.
-	 */
-	virtual void activate()   = 0;
-	virtual void deactivate() = 0;
-	virtual bool activated()  = 0;
-
-	/** Prepare for a new (external) polyphony value.
-	 *
-	 * Preprocessor thread, poly is actually applied by apply_poly.
-	 * \return true on success.
-	 */
-	virtual bool prepare_poly(uint32_t poly) = 0;
-	
-	/** Apply a new (external) polyphony value.
-	 *
-	 * Audio thread.
-	 *
-	 * \param poly Must be < the most recent value passed to prepare_poly.
-	 * \param maid Any objects no longer needed will be pushed to this
-	 */
-	virtual bool apply_poly(Raul::Maid& maid, uint32_t poly) = 0;
-
-	/** Parallelism: Reset flags for start of a new cycle.
-	 */
-	virtual void reset_input_ready() = 0;
-	
-	/** Parallelism: Claim this node (to wait on its input).
-	 * Only one thread will ever take this lock on a particular Node.
-	 * \return true if lock was aquired, false otherwise
-	 */
-	virtual bool process_lock() = 0;
-	
-	/** Parallelism: Unclaim this node (let someone else wait on its input).
-	 * Only a thread which successfully called process_lock may call this.
-	 */
-	virtual void process_unlock() = 0;
-
-	/** Parallelism: Wait for signal that input is ready.
-	 * Only a thread which successfully called process_lock may call this.
-	 */
-	virtual void wait_for_input(size_t num_providers) = 0;
-	
-	/** Parallelism: Signal that input is ready.  Realtime safe.
-	 * Calling this will wake up the thread which blocked on wait_for_input
-	 * if there is one, and otherwise cause it to return true the next call.
-	 * \return true if lock was aquired and input is ready, false otherwise
-	 */
-	virtual void signal_input_ready() = 0;
-
-	/** Parallelism: Return the number of providers that have signalled.
-	 */
-	virtual unsigned n_inputs_ready() const = 0;
-
-	/** Run the node for @a nframes input/output.
-	 *
-	 * @a start and @a end are transport times: end is not redundant in the case
-	 * of varispeed, where end-start != nframes.
-	 */
-	virtual void process(ProcessContext& context) = 0;
-
-	virtual void set_port_buffer(uint32_t voice, uint32_t port_num, Buffer* buf) = 0;
-
-	// FIXME: Only used by client senders.  Remove?
-	virtual const Raul::Array<Port*>& ports() const = 0;
-	
-	virtual uint32_t num_ports() const = 0;
-	
-	/** Used by the process order finding algorithm (ie during connections) */
-	virtual bool traversed() const  = 0;
-	virtual void traversed(bool b)  = 0;
-	
-	/** Nodes that are connected to this Node's inputs.
-	 * (This Node depends on them)
-	 */
-	virtual Raul::List<Node*>* providers()                     = 0;
-	virtual void               providers(Raul::List<Node*>* l) = 0;
-	
-	/** Nodes are are connected to this Node's outputs.
-	 * (They depend on this Node)
-	 */
-	virtual Raul::List<Node*>* dependants()                     = 0;
-	virtual void               dependants(Raul::List<Node*>* l) = 0;
-	
-	/** The Patch this Node belongs to. */
-	virtual Patch* parent_patch() const = 0;
-
-	/** Information about the Plugin this Node is an instance of.
-	 * Not the best name - not all nodes come from plugins (ie Patch)
-	 */
-	virtual const Plugin* plugin() const = 0;
-
-	virtual void set_buffer_size(size_t size) = 0;
-};
-
-
-} // namespace Ingen
-
-#endif // NODE_H