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

#include <cstdlib>
#include <string>

#include "PortImpl.hpp"

namespace Ingen {
namespace Server {

/** An output port.
 *
 * Output ports always have a locally allocated buffer, and buffer() will
 * always return that buffer.  (This is very different from InputPort)
 *
 * This class actually adds no functionality to Port whatsoever right now,
 * it will in the future when more advanced port types exist, and it makes
 * things clearer throughout the engine.
 *
 * \ingroup engine
 */
class OutputPort : virtual public PortImpl
{
public:
	OutputPort(BufferFactory&      bufs,
	           NodeImpl*           parent,
	           const Raul::Symbol& symbol,
	           uint32_t            index,
	           uint32_t            poly,
	           PortType            type,
	           LV2_URID            buffer_type,
	           const Raul::Atom&   value,
	           size_t              buffer_size=0);

	virtual ~OutputPort() {}

	bool get_buffers(BufferFactory&          bufs,
	                 Raul::Array<BufferRef>* buffers,
	                 uint32_t                poly,
	                 bool                    real_time) const;

	void pre_process(Context& context);
	void post_process(Context& context);

	bool is_input()  const { return false; }
	bool is_output() const { return true; }
};

} // namespace Server
} // namespace Ingen

#endif // INGEN_ENGINE_OUTPUTPORT_HPP