Writing an Imagepipeline Plugin - Revision history

Byob: /* C++ Code */

2018-11-20T09:06:29Z

C++ Code

← Older revision		Revision as of 11:06, 20 November 2018
Line 209:		Line 209:

	# Our plugin: detect overexposure after all other imagepipeline operations are done		# Our plugin: detect overexposure after all other imagepipeline operations are done
	~~# Note that after a tonemap operation, all colors are in 0..1 range~~
	film.imagepipeline.2.type = OVEREXPOSURE_DETECTION		film.imagepipeline.2.type = OVEREXPOSURE_DETECTION
	film.imagepipeline.2.threshold = 0.99		film.imagepipeline.2.threshold = 0.99

Byob: /* Modifying CMakeLists.txt */

2018-06-18T14:10:35Z

Modifying CMakeLists.txt

← Older revision		Revision as of 16:10, 18 June 2018
Line 219:		Line 219:

	==== Modifying CMakeLists.txt ====		==== Modifying CMakeLists.txt ====
	Open src/slg/CMakeLists.txt		Open src/slg/CMakeLists.txt<br>
	Search for <code>set(SLG_FILM_SRCS</code> and add your source filepath among the other imagepipeline plugins:		Search for <code>set(SLG_FILM_SRCS</code> and add your source filepath among the other imagepipeline plugins:

Byob at 13:59, 3 December 2017

2017-12-03T13:59:07Z

← Older revision		Revision as of 15:59, 3 December 2017
Line 1:		Line 1:
	This tutorial explains how to add a new plugin to the imagepipeline.<br>		This tutorial explains how to add a new plugin to the imagepipeline.<br>
	A plugin receives the output of the previous plugin as input and operates on these pixels, outputting them to the next plugin.		A plugin receives the output of the previous plugin as input and operates on these pixels in screen space, outputting them to the next plugin.

	Imagepipeline plugins are written in C++ and optionally in OpenCL. For now, this tutorial contains a C++ only example.		Imagepipeline plugins are written in C++ and optionally in OpenCL. For now, this tutorial contains a C++ only example.

Byob at 13:58, 3 December 2017

2017-12-03T13:58:28Z

← Older revision		Revision as of 15:58, 3 December 2017
Line 1:		Line 1:
	This tutorial explains how to add a new plugin to the imagepipeline.		This tutorial explains how to add a new plugin to the imagepipeline.<br>
			A plugin receives the output of the previous plugin as input and operates on these pixels, outputting them to the next plugin.

	Imagepipeline plugins are written in C++ and optionally in OpenCL. For now, this tutorial contains a C++ only example.		Imagepipeline plugins are written in C++ and optionally in OpenCL. For now, this tutorial contains a C++ only example.

Byob: /* Compile and Test */

2017-12-02T18:06:35Z

Compile and Test

← Older revision		Revision as of 20:06, 2 December 2017
Line 243:		Line 243:
	</pre>		</pre>

	And you should see pixels above the threshold marked in red: ~~http~~:~~//pasteall~~.~~org/pic/show.php?id=120778~~		And you should see pixels above the threshold marked in red:

			[[File:Imagepipeline_tutorial_result.png]]

	== OpenCL Code ==		== OpenCL Code ==

Byob at 09:37, 2 December 2017

2017-12-02T09:37:09Z

← Older revision		Revision as of 11:37, 2 December 2017
Line 1:		Line 1:
			This tutorial explains how to add a new plugin to the imagepipeline.

			Imagepipeline plugins are written in C++ and optionally in OpenCL. For now, this tutorial contains a C++ only example.

	== C++ Code ==		== C++ Code ==
	Files that need to be created:		Files that need to be created:

Byob: /* Compile */

2017-12-02T09:34:45Z

Compile

@@ Line 221: / Line 221: @@
 </pre>
-==== Compile ====
+==== Compile and Test ====
 To test your plugin, compile LuxCore: [[Compiling_LuxCore]]
 == OpenCL Code ==

Byob at 09:28, 2 December 2017

2017-12-02T09:28:08Z

← Older revision		Revision as of 11:28, 2 December 2017
Line 214:		Line 214:

	==== Modifying CMakeLists.txt ====		==== Modifying CMakeLists.txt ====
			Open src/slg/CMakeLists.txt
			Search for <code>set(SLG_FILM_SRCS</code> and add your source filepath among the other imagepipeline plugins:

			<pre>
			${LuxRays_SOURCE_DIR}/src/slg/film/imagepipeline/plugins/overexposuredetection.cpp
			</pre>

			==== Compile ====
			To test your plugin, compile LuxCore: [[Compiling_LuxCore]]

	== OpenCL Code ==		== OpenCL Code ==

Byob at 09:22, 2 December 2017

2017-12-02T09:22:07Z

Show changes

Byob at 09:15, 2 December 2017

2017-12-02T09:15:01Z

← Older revision		Revision as of 11:15, 2 December 2017
Line 1:		Line 1:

	== C++ Code ==		== C++ Code ==
	Files that need to be created:		Files that need to be created:
Line 19:		Line 18:
	Open the file src/slg/film/filmparse.cpp and include your header file, right under the last include line and before the "using namespace x" lines.		Open the file src/slg/film/filmparse.cpp and include your header file, right under the last include line and before the "using namespace x" lines.

	<~~code~~>#include "slg/film/imagepipeline/plugins/overexposuredetection.h"</~~code~~>		<pre>#include "slg/film/imagepipeline/plugins/overexposuredetection.h"</pre>

	In the same file, go to the function Film::AllocImagePipeline.		In the same file, go to the function Film::AllocImagePipeline.
	You'll see a long if/else if/... section where the plugins are initialized. Add an else if clause at the end, before the final else:		You'll see a long if/else if/... section where the plugins are initialized. Add an else if clause at the end, before the final else:
	<~~code~~>		<pre>
	// ...		// ...
	} else if (type == "OVEREXPOSURE_DETECTION") {		} else if (type == "OVEREXPOSURE_DETECTION") {
	const float threshold = Clamp(props.Get(Property(prefix + ".threshold")(1000.f)).Get<float>(), 0.f, INFINITY);		const float threshold = Clamp(props.Get(Property(prefix + ".threshold")(1000.f)).Get<float>(), 0.f, INFINITY);
	imagePipeline->AddPlugin(new OverExposureDetection(threshold));		imagePipeline->AddPlugin(new OverExposureDetection(threshold));
	} else		} else
	// ...		// ...
	</code>		</pre>

			The string for the <code>type == "PLUGINNAME"</code> comparison can be chosen freely (it does not occur in any other files).
			By convention it should be all upper case, with underscores for better readability in long names.

			Next, parse the value that the user set for the "threshold" parameter in the .cfg configuration file of a luxcore scene definition.
			Our plugin is configured like this:

			<pre>
			# Film image pipeline plug-ins
			film.imagepipeline.0.type = TONEMAP_LINEAR
			film.imagepipeline.1.type = GAMMA_CORRECTION
			film.imagepipeline.1.value = 2.2

			# Our plugin: detect overexposure after all other imagepipeline operations are done
			film.imagepipeline.2.type = OVEREXPOSURE_DETECTION
			film.imagepipeline.2.threshold = 10
			</pre>

			However, the user can also omit the <code>film.imagepipeline.2.threshold</code> line if we define a default value in the filmparse function.

			It is also a good idea to sanitize the input with a Clamp function. In our case, a threshold below 0 does not make sense.

	== OpenCL Code ==		== OpenCL Code ==