/*
  This file is part of Ingen.
  Copyright 2007-2012 David Robillard <http://drobilla.net/>

  Ingen is free software: you can redistribute it and/or modify it under the
  terms of the GNU Affero General Public License as published by the Free
  Software Foundation, either version 3 of the License, or 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 Affero General Public License for details.

  You should have received a copy of the GNU Affero General Public License
  along with Ingen.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef INGEN_ENGINE_ENGINE_HPP
#define INGEN_ENGINE_ENGINE_HPP

#include <boost/utility.hpp>

#include "ingen/EngineBase.hpp"
#include "ingen/Interface.hpp"
#include "raul/SharedPtr.hpp"

#include "ProcessContext.hpp"
#include "MessageContext.hpp"

namespace Raul { class Maid; }

namespace Ingen {

namespace Shared { class World; }

namespace Server {

class BufferFactory;
class ClientBroadcaster;
class ControlBindings;
class Driver;
class EngineStore;
class Event;
class EventWriter;
class MessageContext;
class NodeFactory;
class PostProcessor;
class PreProcessor;
class ProcessContext;
class PatchImpl;

/**
   The engine which executes the process graph.

   This is a simple class that provides pointers to the various components
   that make up the engine implementation.  In processes with a local engine,
   it can be accessed via the Ingen::Shared::World.

   @ingroup engine
*/
class Engine : public boost::noncopyable, public EngineBase
{
public:
	explicit Engine(Ingen::Shared::World* world);

	virtual ~Engine();

	// EngineBase methods
	virtual bool activate();
	virtual void deactivate();
	virtual unsigned run(uint32_t sample_count);
	virtual void quit();
	virtual bool main_iteration();
	virtual void register_client(const Raul::URI& uri,
	                             SharedPtr<Interface> client);
	virtual bool unregister_client(const Raul::URI& uri);

	void set_driver(SharedPtr<Driver> driver);

	/** Return true iff any events are pending. */
	bool pending_events();

	/** Enqueue an event to be processed (non-realtime threads only). */
	void enqueue_event(Event* ev);

	/** Process events (process thread only). */
	unsigned process_events();

	bool is_process_context(const Context& context) const {
		return &context == &_process_context;
	}

	Ingen::Shared::World* world() const { return _world; }

	EventWriter*          interface()        const { return _event_writer; }
	ClientBroadcaster*    broadcaster()      const { return _broadcaster; }
	BufferFactory*        buffer_factory()   const { return _buffer_factory; }
	ControlBindings*      control_bindings() const { return _control_bindings; }
	Driver*               driver()           const { return _driver.get(); }
	Raul::Maid*           maid()             const { return _maid; }
	NodeFactory*          node_factory()     const { return _node_factory; }
	PostProcessor*        post_processor()   const { return _post_processor; }
	PatchImpl*            root_patch()       const { return _root_patch; }

	MessageContext& message_context() { return _message_context; }
	ProcessContext& process_context() { return _process_context; }

	SharedPtr<EngineStore> engine_store() const;

	size_t event_queue_size() const;

private:
	Ingen::Shared::World* _world;

	ClientBroadcaster* _broadcaster;
	BufferFactory*     _buffer_factory;
	ControlBindings*   _control_bindings;
	SharedPtr<Driver>  _driver;
	Raul::Maid*        _maid;
	NodeFactory*       _node_factory;
	PreProcessor*      _pre_processor;
	PostProcessor*     _post_processor;
	EventWriter*       _event_writer;

	PatchImpl* _root_patch;

	MessageContext _message_context;
	ProcessContext _process_context;

	bool _quit_flag;
};

} // namespace Server
} // namespace Ingen

#endif // INGEN_ENGINE_ENGINE_HPP