// K-3D
// Copyright (c) 1995-2009, Timothy M. Shead
//
// Contact: tshead@k-3d.com
//
// This program 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.
//
// This program 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 more 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

/** \file
	\author Tim Shead <tshead@k-3d.com>
*/

#include "light.h"
#include "material.h"

#include <k3d-i18n-config.h>
#include <k3d-version-config.h>
#include <k3dsdk/algebra.h>
#include <k3dsdk/classes.h>
#include <k3dsdk/color.h>
#include <k3dsdk/document_plugin_factory.h>
#include <k3dsdk/file_range.h>
#include <k3dsdk/fstream.h>
#include <k3dsdk/gl.h>
#include <k3dsdk/icamera.h>
#include <k3dsdk/iomanip.h>
#include <k3dsdk/imaterial.h>
#include <k3dsdk/imesh_sink.h>
#include <k3dsdk/imesh_source.h>
#include <k3dsdk/inetwork_render_farm.h>
#include <k3dsdk/inetwork_render_frame.h>
#include <k3dsdk/inetwork_render_job.h>
#include <k3dsdk/inode_collection_sink.h>
#include <k3dsdk/iprojection.h>
#include <k3dsdk/irender_camera_animation.h>
#include <k3dsdk/irender_camera_frame.h>
#include <k3dsdk/irender_camera_preview.h>
#include <k3dsdk/imatrix_source.h>
#include <k3dsdk/material.h>
#include <k3dsdk/measurement.h>
#include <k3dsdk/network_render_farm.h>
#include <k3dsdk/node.h>
#include <k3dsdk/nodes.h>
#include <k3dsdk/polyhedron.h>
#include <k3dsdk/property.h>
#include <k3dsdk/resolutions.h>
#include <k3dsdk/time_source.h>
#include <k3dsdk/transform.h>
#include <k3dsdk/triangulator.h>
#include <k3dsdk/utility_gl.h>

#include <boost/scoped_ptr.hpp>

#include <iomanip>
#include <iterator>
#include <map>
#include <set>

namespace module
{

namespace indigo
{

/////////////////////////////////////////////////////////////////////////////
// render_engine

class render_engine :
	public k3d::node,
	public k3d::inode_collection_sink,
	public k3d::irender_camera_preview,
	public k3d::irender_camera_frame,
	public k3d::irender_camera_animation
{
	typedef k3d::node base;
// initialise properties
public:
	render_engine(k3d::iplugin_factory& Factory, k3d::idocument& Document) :
		base(Factory, Document),
		m_visible_nodes(init_owner(*this) + init_name("visible_nodes") + init_label(_("Visible Nodes")) + init_description(_("A list of nodes that will be visible in the rendered output.")) + init_value(std::vector<k3d::inode*>())),
		m_enabled_lights(init_owner(*this) + init_name("enabled_lights") + init_label(_("Enabled Lights")) + init_description(_("A list of light sources that will contribute to the rendered output.")) + init_value(std::vector<k3d::inode*>())),
		m_resolution(init_owner(*this) + init_name("resolution") + init_label(_("Resolution")) + init_description(_("Choose a predefined image resolution")) + init_enumeration(k3d::resolution_values()) + init_value(k3d::string_t(""))),
		m_pixel_width(init_owner(*this) + init_name("pixel_width") + init_label(_("pixel_width")) + init_description(_("The horizontal size in pixels of the rendered output image.")) + init_value(320) + init_step_increment(1) + init_units(typeid(k3d::measurement::scalar)) + init_constraint(constraint::minimum<k3d::int32_t>(1))),
		m_pixel_height(init_owner(*this) + init_name("pixel_height") + init_label(_("pixel_height")) + init_description(_("The vertical size in pixels of the rendered output image.")) + init_value(240) + init_step_increment(1) + init_units(typeid(k3d::measurement::scalar)) + init_constraint(constraint::minimum<k3d::int32_t>(1))),
		m_halt_time(init_owner(*this) + init_name("halt_time") + init_label(_("Halt Time")) + init_description(_("Maximum rendering time in seconds.")) + init_value(30) + init_step_increment(1) + init_units(typeid(k3d::measurement::time))),
		m_halt_samples(init_owner(*this) + init_name("halt_samples") + init_label(_("Halt Samples")) + init_description(_("Maximum number of samples-per-pixel.")) + init_value(100) + init_step_increment(1) + init_units(typeid(k3d::measurement::scalar)))
	{
		m_resolution.changed_signal().connect(sigc::mem_fun(*this, &render_engine::on_resolution_changed));
	}

	const k3d::inode_collection_sink::properties_t node_collection_properties()
	{
		k3d::inode_collection_sink::properties_t results;
		results.push_back(&m_visible_nodes);
		results.push_back(&m_enabled_lights);

		return results;
	}

	void on_resolution_changed(k3d::iunknown*)
	{
		const k3d::string_t new_resolution = m_resolution.pipeline_value();

		const k3d::resolutions_t& resolutions = k3d::resolutions();
		for(k3d::resolutions_t::const_iterator resolution = resolutions.begin(); resolution != resolutions.end(); ++resolution)
		{
			if(resolution->name != new_resolution)
				continue;

			m_pixel_width.set_value(resolution->width);
			m_pixel_height.set_value(resolution->height);
			return;
		}

		assert_not_reached();
	}

	k3d::bool_t render_camera_preview(k3d::icamera& Camera)
	{
		// Start a new render job ...
		k3d::inetwork_render_job& job = k3d::get_network_render_farm().create_job("k3d-indigo-preview");

		// Add a single render frame to the job ...
		k3d::inetwork_render_frame& frame = job.create_frame("frame");

		// Create an output image path ...
		const k3d::filesystem::path output_image = frame.add_file("output.png");

		// Render it ...
		return_val_if_fail(render(Camera, frame, output_image, true), false);

		// View the output when it's done ...
		frame.add_view_command(output_image);

		// Start the job running ...
		k3d::get_network_render_farm().start_job(job);

		return true;
	}

	k3d::bool_t render_camera_frame(k3d::icamera& Camera, const k3d::filesystem::path& OutputImage, const k3d::bool_t ViewImage)
	{
		// Sanity checks ...
		return_val_if_fail(!OutputImage.empty(), false);

		// Start a new render job ...
		k3d::inetwork_render_job& job = k3d::get_network_render_farm().create_job("k3d-indigo-render-frame");

		// Add a single render frame to the job ...
		k3d::inetwork_render_frame& frame = job.create_frame("frame");

		// Create an output image path ...
		const k3d::filesystem::path output_image = frame.add_file("output.png");

		// Render it ...
		return_val_if_fail(render(Camera, frame, output_image, false), false);

		// Copy the output image to its requested destination ...
		frame.add_copy_command(output_image, OutputImage);

		// View the output image when it's done ...
		if(ViewImage)
			frame.add_view_command(OutputImage);

		// Start the job running ...
		k3d::get_network_render_farm().start_job(job);

		return true;
	}

	k3d::bool_t render_camera_animation(k3d::icamera& Camera, k3d::iproperty& Time, const k3d::frames& Frames, const k3d::bool_t ViewCompletedImages)
	{
		// Start a new render job ...
		k3d::inetwork_render_job& job = k3d::get_network_render_farm().create_job("k3d-indigo-render-animation");

		// For each frame to be rendered ...
		k3d::uint_t frame_index = 0;
		for(k3d::frames::const_iterator frame = Frames.begin(); frame != Frames.end(); ++frame, ++frame_index)
		{
			// Set the frame time ...
			k3d::property::set_internal_value(Time, frame->begin_time);

			// Redraw everything ...
			k3d::gl::redraw_all(document(), k3d::gl::irender_viewport::SYNCHRONOUS);

			// Add a render frame to the job ...
			std::stringstream buffer;
			buffer << "frame-" << frame_index;
			k3d::inetwork_render_frame& render_frame = job.create_frame(buffer.str());

			// Create an output image path ...
			const k3d::filesystem::path output_image = render_frame.add_file("output.png");

			// Render it (hidden rendering) ...
			return_val_if_fail(render(Camera, render_frame, output_image, false), false);

			// Copy the output image to its requested destination ...
			render_frame.add_copy_command(output_image, frame->destination);

			// View the output image when it's done ...
			if(ViewCompletedImages)
				render_frame.add_view_command(frame->destination);
		}

		// Start the job running ...
		k3d::get_network_render_farm().start_job(job);

		return true;
	}

	static k3d::iplugin_factory& get_factory()
	{
		static k3d::document_plugin_factory<render_engine,
			k3d::interface_list<k3d::irender_camera_animation,
			k3d::interface_list<k3d::irender_camera_frame,
			k3d::interface_list<k3d::irender_camera_preview> > > > factory(
				k3d::uuid(0xd3415ff0, 0x084b272d, 0x76eba2ad, 0x813d5f1d),
				"IndigoEngine",
				_("Indigo Render Engine"),
				"Indigo RenderEngine",
				k3d::iplugin_factory::EXPERIMENTAL);

		return factory;
	}

private:
	/// Helper class used to triangulate faces
	class create_triangles :
		public k3d::triangulator
	{
		typedef k3d::triangulator base;

	public:
		create_triangles(
			const k3d::mesh::materials_t& FaceMaterials,
			k3d::mesh::points_t& Points,
			k3d::mesh::indices_t& APoints,
			k3d::mesh::indices_t& BPoints,
			k3d::mesh::indices_t& CPoints,
			std::vector<indigo::material*>& TriangleMaterials,
			std::set<indigo::material*>& MaterialList) :
			m_points(Points),
			m_a_points(APoints),
			m_b_points(BPoints),
			m_c_points(CPoints),
			m_triangle_materials(TriangleMaterials),
			m_material_list(MaterialList)
		{
			m_face_materials.resize(FaceMaterials.size());
			for(k3d::uint_t i = 0; i != FaceMaterials.size(); ++i)
				m_face_materials[i] = k3d::material::lookup<indigo::material>(FaceMaterials[i]);
		}

	private:
		void start_face(const k3d::uint_t Face)
		{
			m_current_face = Face;
		}

		void add_vertex(const k3d::point3& Coordinates, k3d::uint_t Vertices[4], k3d::uint_t Edges[4], double Weights[4], k3d::uint_t& NewVertex)
		{
			NewVertex = m_points.size();
			m_points.push_back(Coordinates);
		}

		void add_triangle(k3d::uint_t Vertices[3], k3d::uint_t Edges[3])
		{
			m_a_points.push_back(Vertices[0]);
			m_b_points.push_back(Vertices[1]);
			m_c_points.push_back(Vertices[2]);
			m_triangle_materials.push_back(m_face_materials[m_current_face]);
			m_material_list.insert(m_face_materials[m_current_face]);
		}

		std::vector<indigo::material*> m_face_materials;
		k3d::mesh::points_t& m_points;
		k3d::mesh::indices_t& m_a_points;
		k3d::mesh::indices_t& m_b_points;
		k3d::mesh::indices_t& m_c_points;
		std::vector<indigo::material*>& m_triangle_materials;
		std::set<indigo::material*>& m_material_list;

		k3d::uint_t m_current_face;
	};

	void render_mesh(std::map<indigo::material*, k3d::string_t>& MaterialNames, const k3d::string_t& Name, k3d::inode& MeshInstance, const k3d::mesh& Mesh, std::ostream& Stream)
	{
		Stream << k3d::standard_indent << "<mesh>\n" << k3d::push_indent;
		Stream << k3d::standard_indent << "<name>" << Name << "</name>\n";
		Stream << k3d::standard_indent << "<normal_smoothing>false</normal_smoothing>\n";
		Stream << k3d::standard_indent << "<embedded>\n" << k3d::push_indent;

		std::set<indigo::material*> material_list;

		k3d::mesh::points_t points(*Mesh.points);
		k3d::mesh::indices_t a_points;
		k3d::mesh::indices_t b_points;
		k3d::mesh::indices_t c_points;
		std::vector<indigo::material*> triangle_materials;

		for(k3d::mesh::primitives_t::const_iterator primitive = Mesh.primitives.begin(); primitive != Mesh.primitives.end(); ++primitive)
		{
			boost::scoped_ptr<k3d::polyhedron::const_primitive> polyhedron(k3d::polyhedron::validate(Mesh, **primitive));
			if(!polyhedron)
				continue;

			// Triangulate the mesh faces ...
			create_triangles(polyhedron->face_materials, points, a_points, b_points, c_points, triangle_materials, material_list).process(Mesh, *polyhedron);
		}

		const k3d::matrix4 matrix = k3d::node_to_world_matrix(MeshInstance);
		for(k3d::mesh::points_t::const_iterator point = points.begin(); point != points.end(); ++point)
		{
			const k3d::point3 pos = matrix * (*point);
			Stream << k3d::standard_indent << "<vertex pos=\"" << -pos[0] << " " << pos[1] << " " << pos[2] << "\"/>\n";
		}

		for(std::set<indigo::material*>::const_iterator material = material_list.begin(); material != material_list.end(); ++material)
		{
			if(0 == *material)
			{
				k3d::log() << warning << "Geometry without an Indigo material will not be rendered." << std::endl;
				continue;
			}
	
			Stream << k3d::standard_indent << "<triangle_set>\n" << k3d::push_indent;
			Stream << k3d::standard_indent << "<material_name>" << MaterialNames[*material] << "</material_name>\n";
			const k3d::uint_t begin = 0;
			const k3d::uint_t end = begin + triangle_materials.size();
			for(k3d::uint_t i = begin; i != end; ++i)
			{
				if(triangle_materials[i] != *material)
					continue;

				Stream << k3d::standard_indent << "<tri>" << a_points[i] << " " << b_points[i] << " " << c_points[i] << "</tri>\n";
			}
			Stream << k3d::pop_indent << k3d::standard_indent << "</triangle_set>\n";
		}

		Stream << k3d::pop_indent << k3d::standard_indent << "</embedded>\n";
		Stream << k3d::pop_indent << k3d::standard_indent << "</mesh>\n";

		Stream << k3d::standard_indent << "<model>\n" << k3d::push_indent;
		Stream << k3d::standard_indent << "<pos>" << "0 0 0" << "</pos>\n";
		Stream << k3d::standard_indent << "<scale>" << "1" << "</scale>\n";
		Stream << k3d::standard_indent << "<mesh_name>" << Name << "</mesh_name>\n";
		Stream << k3d::pop_indent << k3d::standard_indent << "</model>\n";
	}

	k3d::bool_t render(k3d::icamera& Camera, k3d::inetwork_render_frame& Frame, const k3d::filesystem::path& OutputImagePath, const k3d::bool_t VisibleRender)
	{
		try
		{
			k3d::iperspective* const projection = dynamic_cast<k3d::iperspective*>(&Camera.projection());
			if(!projection)
				throw std::runtime_error("A perspective projection is required.");

			// Start our indigo XML file ...
			const k3d::filesystem::path scene_path = Frame.add_file("world.igs");
			k3d::filesystem::ofstream stream(scene_path);
			return_val_if_fail(stream.good(), false);

			k3d::inetwork_render_frame::environment environment;

			k3d::inetwork_render_frame::arguments arguments;
			//     arguments.push_back(k3d::inetwork_render_frame::argument("-n m"));
			arguments.push_back(k3d::inetwork_render_frame::argument(scene_path.native_filesystem_string()));
			arguments.push_back(k3d::inetwork_render_frame::argument("-o"));
			arguments.push_back(k3d::inetwork_render_frame::argument(OutputImagePath.native_filesystem_string()));

			Frame.add_exec_command("indigo_console", environment, arguments);

			// Setup the scene description ...
			stream << k3d::xml::declaration();
			stream << k3d::standard_indent << "<!-- Indigo scene generated by K-3D Version " K3D_VERSION ", http://www.k-3d.org -->\n";
			stream << k3d::standard_indent << "<scene>\n" << k3d::push_indent;

			// Set renderer options ...
			const k3d::int32_t pixel_width = m_pixel_width.pipeline_value();
			const k3d::int32_t pixel_height = m_pixel_height.pipeline_value();
			stream << k3d::standard_indent << "<renderer_settings>\n" << k3d::push_indent;
			stream << k3d::standard_indent << "<width>" << pixel_width << "</width>\n";
			stream << k3d::standard_indent << "<height>" << pixel_height << "</height>\n";
			stream << k3d::standard_indent << "<halt_time>" << m_halt_time.pipeline_value() << "</halt_time>\n";
			stream << k3d::standard_indent << "<halt_samples_per_pixel>" << m_halt_samples.pipeline_value() << "</halt_samples_per_pixel>\n";
			stream << k3d::pop_indent << k3d::standard_indent << "</renderer_settings>\n";

			// Setup the camera ...
			const k3d::matrix4 camera_matrix = k3d::property::pipeline_value<k3d::matrix4>(Camera.transformation().matrix_source_output());
			const k3d::point3 camera_pos = k3d::position(camera_matrix);
			const k3d::vector3 camera_up = camera_matrix * k3d::vector3(0, 1, 0);
			const k3d::vector3 camera_forwards = camera_matrix * k3d::vector3(0, 0, 1);

			const k3d::double_t camera_near = k3d::property::pipeline_value<k3d::double_t>(projection->near());
			const k3d::double_t camera_width = std::abs(k3d::property::pipeline_value<k3d::double_t>(projection->left()) - k3d::property::pipeline_value<k3d::double_t>(projection->right()));

			stream << k3d::standard_indent << "<camera>\n" << k3d::push_indent;
			stream << k3d::standard_indent << "<pos>" << -camera_pos[0] << " " << camera_pos[1] << " " << camera_pos[2] << "</pos>\n";
			stream << k3d::standard_indent << "<up>" << -camera_up[0] << " " << camera_up[1] << " " << camera_up[2] << "</up>\n";
			stream << k3d::standard_indent << "<forwards>" << -camera_forwards[0] << " " << camera_forwards[1] << " " << camera_forwards[2] << "</forwards>\n";
			stream << k3d::standard_indent << "<aperture_radius>" << "0.001" << "</aperture_radius>\n";
			stream << k3d::standard_indent << "<focus_distance>" << "3.0" << "</focus_distance>\n";
			stream << k3d::standard_indent << "<aspect_ratio>" << static_cast<k3d::double_t>(pixel_width) / static_cast<k3d::double_t>(pixel_height) << "</aspect_ratio>\n";
			stream << k3d::standard_indent << "<sensor_width>" << camera_width << "</sensor_width>\n";
			stream << k3d::standard_indent << "<lens_sensor_dist>" << camera_near << "</lens_sensor_dist>\n";
			stream << k3d::standard_indent << "<white_balance>" << "D65" << "</white_balance>\n";
			stream << k3d::standard_indent << "<autofocus/>\n";
			stream << k3d::pop_indent << k3d::standard_indent << "</camera>\n";

			// Setup tonemapping ...
			stream << k3d::standard_indent << "<tonemapping>\n" << k3d::push_indent;
			//      stream << "<linear>\n";
			//     stream << "<scale>" << "1.0" << "</scale>\n";
			//      stream << "</linear>\n";
			stream << k3d::standard_indent << "<reinhard>\n" << k3d::push_indent;
			stream << k3d::standard_indent << "<pre_scale>" << "6.0" << "</pre_scale>\n";
			stream << k3d::standard_indent << "<post_scale>" << "1.0" << "</post_scale>\n";
			stream << k3d::standard_indent << "<burn>" << "6.0" << "</burn>\n";
			stream << k3d::pop_indent << k3d::standard_indent << "</reinhard>\n";
			stream << k3d::pop_indent << k3d::standard_indent << "</tonemapping>\n";

			// Setup lights ...
			const k3d::inode_collection_property::nodes_t enabled_lights = m_enabled_lights.pipeline_value();
			for(k3d::inode_collection_property::nodes_t::const_iterator node = enabled_lights.begin(); node != enabled_lights.end(); ++node)
			{
				if(indigo::light* const light = dynamic_cast<indigo::light*>(*node))
				{
					light->setup(stream);
				}
			}

			// Setup materials, assigning unique names as-we-go ...
			std::map<indigo::material*, k3d::string_t> material_names;
			const std::vector<indigo::material*> materials = k3d::node::lookup<indigo::material>(document());
			for(k3d::uint_t i = 0; i != materials.size(); ++i)
			{
				const k3d::string_t material_name = "material_" + k3d::string_cast(material_names.size());
				material_names.insert(std::make_pair(materials[i], material_name));
				materials[i]->setup(material_name, stream);
			}

			// Render geometry ...
			k3d::uint_t mesh_index = 0;
			const k3d::inode_collection_property::nodes_t visible_nodes = m_visible_nodes.pipeline_value();
			for(k3d::inode_collection_property::nodes_t::const_iterator node = visible_nodes.begin(); node != visible_nodes.end(); ++node)
			{
				if((*node)->factory().factory_id() != k3d::classes::MeshInstance())
					continue;

				const k3d::mesh* const mesh = k3d::property::pipeline_value<k3d::mesh*>(**node, "output_mesh");
				if(!mesh)
					continue;

				const k3d::string_t mesh_name = "mesh_" + k3d::string_cast(mesh_index++);

				render_mesh(material_names, mesh_name, **node, *mesh, stream);
			}

			// Finish the scene ...
			stream << k3d::pop_indent << k3d::standard_indent << "</scene>\n";
		}
		catch(std::exception& e)
		{
			k3d::log() << error << "exception: " << e.what() << std::endl;
			return false;
		}
		catch(...)
		{
			k3d::log() << error << "unknown exception" << std::endl;
			return false;
		}

		return true;
	}

	/// Helper class that limits the list of visible nodes to those that we can render
	template<typename value_t, class name_policy_t>
	class indigo_visible_nodes_property :
		public k3d::data::writable_property<value_t, name_policy_t>,
		public k3d::inode_collection_property
	{
		typedef k3d::data::writable_property<value_t, name_policy_t> base;

	public:
		k3d::bool_t property_allow(k3d::inode& Node)
		{
			return Node.factory().factory_id() == k3d::classes::MeshInstance();
		}

	protected:
		template<typename init_t>
		indigo_visible_nodes_property(const init_t& Init) :
			base(Init)
		{
		}
	};

	/// Helper class that limits the list of enabled lights
	template<typename value_t, class name_policy_t>
	class indigo_enabled_lights_property :
		public k3d::data::writable_property<value_t, name_policy_t>,
		public k3d::inode_collection_property
	{
		typedef k3d::data::writable_property<value_t, name_policy_t> base;

	public:
		k3d::bool_t property_allow(k3d::inode& Node)
		{
			return dynamic_cast<indigo::light*>(&Node) ? true : false;
		}

	protected:
		template<typename init_t>
		indigo_enabled_lights_property(const init_t& Init) :
			base(Init)
		{
		}
	};

// define properties
	k3d_data(k3d::inode_collection_property::nodes_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, indigo_visible_nodes_property, node_collection_serialization) m_visible_nodes;
	k3d_data(k3d::inode_collection_property::nodes_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, indigo_enabled_lights_property, node_collection_serialization) m_enabled_lights;
	k3d_data(k3d::string_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, enumeration_property, with_serialization) m_resolution;
	k3d_data(k3d::int32_t, immutable_name, change_signal, with_undo, local_storage, with_constraint, measurement_property, with_serialization) m_pixel_width;
	k3d_data(k3d::int32_t, immutable_name, change_signal, with_undo, local_storage, with_constraint, measurement_property, with_serialization) m_pixel_height;
	k3d_data(k3d::double_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, measurement_property, with_serialization) m_halt_time;
	k3d_data(k3d::double_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, measurement_property, with_serialization) m_halt_samples;
};

k3d::iplugin_factory& render_engine_factory()
{
	return render_engine::get_factory();
}

} // namespace indigo

} // namespace module