/* This file is part of Ingen.
 * Copyright (C) 2007-2009 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 INGEN_EVENTS_SETPORTVALUE_HPP
#define INGEN_EVENTS_SETPORTVALUE_HPP

#include "raul/Atom.hpp"
#include "QueuedEvent.hpp"
#include "types.hpp"

namespace Ingen {

class PortImpl;

namespace Events {


/** An event to change the value of a port.
 *
 * This event can either be queued or immediate, depending on the queued
 * parameter passed to the constructor.  It must be passed to the appropriate
 * place (ie queued event passed to the event queue and non-queued event
 * processed in the audio thread) or nasty things will happen.
 *
 * \ingroup engine
 */
class SetPortValue : public QueuedEvent
{
public:
	SetPortValue(Engine&              engine,
	             SharedPtr<Request>   request,
	             bool                 queued,
	             SampleCount          timestamp,
	             const Raul::Path&    port_path,
	             const Raul::Atom&    value);

	SetPortValue(Engine&              engine,
	             SharedPtr<Request>   request,
	             SampleCount          timestamp,
	             PortImpl*            port,
	             const Raul::Atom&    value);

	~SetPortValue();

	void pre_process();
	void execute(ProcessContext& context);
	void post_process();

private:
	enum ErrorType {
		NO_ERROR,
		PORT_NOT_FOUND,
		NO_SPACE,
		TYPE_MISMATCH
	};

	void apply(Context& context);

	bool             _queued;
	const Raul::Path _port_path;
	const Raul::Atom _value;
	PortImpl*        _port;
};


} // namespace Ingen
} // namespace Events

#endif // INGEN_EVENTS_SETPORTVALUE_HPP