/* 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 PATCH_H
#define PATCH_H

#include <cstdlib>
#include <string>
#include <raul/List.hpp>
#include "NodeBase.hpp"
#include "Plugin.hpp"
#include "DataType.hpp"
#include "CompiledPatch.hpp"

using std::string;

template <typename T> class Array;

namespace Ingen {

class Connection;
class Engine;
class CompiledPatch;


/** A group of nodes in a graph, possibly polyphonic.
 *
 * Note that this is also a Node, just one which contains Nodes.
 * Therefore infinite subpatching is possible, of polyphonic
 * patches of polyphonic nodes etc. etc.
 *
 * \ingroup engine
 */
class Patch : public NodeBase
{
public:
	Patch(Engine& engine, const string& name, uint32_t poly, Patch* parent, SampleRate srate, size_t buffer_size, uint32_t local_poly);
	virtual ~Patch();

	void activate();
	void deactivate();

	void process(ProcessContext& context);
	
	void set_buffer_size(size_t size);
	
	/** Prepare for a new (internal) polyphony value.
	 *
	 * Preprocessor thread, poly is actually applied by apply_internal_poly.
	 * \return true on success.
	 */
	bool prepare_internal_poly(uint32_t poly);
	
	/** Apply a new (internal) polyphony value.
	 *
	 * Audio thread.
	 *
	 * \param poly Must be < the most recent value passed to prepare_internal_poly.
	 * \param maid Any objects no longer needed will be pushed to this
	 */
	bool apply_internal_poly(Raul::Maid& maid, uint32_t poly);
	
	// Patch specific stuff not inherited from Node
	
	void                   add_node(Raul::ListNode<Node*>* tn);
	Raul::ListNode<Node*>* remove_node(const string& name);

	Raul::List<Node*>&       nodes()       { return _nodes; }
	Raul::List<Connection*>& connections() { return _connections; }
	
	const Raul::List<Node*>&       nodes()       const { return _nodes; }
	const Raul::List<Connection*>& connections() const { return _connections; }
	
	uint32_t num_ports() const;
	
	Port* create_port(const string& name, DataType type, size_t buffer_size, bool is_output);
	void add_input(Raul::ListNode<Port*>* port)  { _input_ports.push_back(port); } ///< Preprocesser thread
	void add_output(Raul::ListNode<Port*>* port) { _output_ports.push_back(port); } ///< Preprocessor thread
	Raul::ListNode<Port*>* remove_port(const string& name);
	
	void add_connection(Raul::ListNode<Connection*>* c) { _connections.push_back(c); }
	Raul::ListNode<Connection*>* remove_connection(const Port* src_port, const Port* dst_port);
	
	CompiledPatch* compiled_patch()                  { return _compiled_patch; }
	void           compiled_patch(CompiledPatch* cp) { _compiled_patch = cp; }
	
	Raul::Array<Port*>* external_ports()                       { return _ports; }
	void                external_ports(Raul::Array<Port*>* pa) { _ports = pa; }

	CompiledPatch*      compile() const;
	Raul::Array<Port*>* build_ports_array() const;
	
	/** Whether to run this patch's DSP bits in the audio thread */
	bool enabled() const { return _process; }
	void enable() { _process = true; }
	void disable();

	uint32_t internal_poly() const { return _internal_poly; }

private:
	inline void compile_recursive(Node* n, CompiledPatch* output) const;
	void process_parallel(ProcessContext& context);
	void process_single(ProcessContext& context);

	Engine&                 _engine;
	uint32_t                _internal_poly;
	CompiledPatch*          _compiled_patch; ///< Accessed in audio thread only
	Raul::List<Connection*> _connections;    ///< Accessed in audio thread only
	Raul::List<Port*>       _input_ports;    ///< Accessed in preprocessing thread only
	Raul::List<Port*>       _output_ports;   ///< Accessed in preprocessing thread only
	Raul::List<Node*>       _nodes;          ///< Accessed in preprocessing thread only
	bool                    _process;
};



/** Private helper for compile */
inline void
Patch::compile_recursive(Node* n, CompiledPatch* output) const
{
	if (n == NULL || n->traversed())
		return;

	n->traversed(true);
	assert(output != NULL);
	
	for (Raul::List<Node*>::iterator i = n->providers()->begin(); i != n->providers()->end(); ++i)
		if ( ! (*i)->traversed() )
			compile_recursive((*i), output);

	output->push_back(CompiledNode(n, n->providers()->size(), n->dependants()));
}


} // namespace Ingen

#endif // PATCH_H