Add bloom intensity commandline parameter!

Also get rid of unused push constants and overrides

Author: devshgraphicsprogramming

examples_tests/39.DenoiserTonemapper/CommandLineHandler.cpp

@@ -176,8 +176,12 @@ CommandLineHandler::CommandLineHandler(core::vector<std::string> argv, IAssetMan
 					assignToMap(DTEA_DENOISER_EXPOSURE_BIAS);
 				else if (variable == DENOISER_BLEND_FACTOR)
 					assignToMap(DTEA_DENOISER_BLEND_FACTOR);
-				else if (variable == BLOOM_SCALE)
-					assignToMap(DTEA_BLOOM_SCALE);
+				else if (variable == BLOOM_PSF_FILE)
+					assignToMap(DTEA_BLOOM_PSF_FILE);
+				else if (variable == BLOOM_RELATIVE_SCALE)
+					assignToMap(DTEA_BLOOM_RELATIVE_SCALE);
+				else if (variable == BLOOM_INTENSITY)
+					assignToMap(DTEA_BLOOM_INTENSITY);
 				else if (variable == REINHARD)
 					assignToMap(DTEA_TONEMAPPER_REINHARD, 2);
 				else if (variable == ACES)
@@ -196,8 +200,6 @@ CommandLineHandler::CommandLineHandler(core::vector<std::string> argv, IAssetMan
 					assignToMap(DTEA_ALBEDO_CHANNEL_NAME);
 				else if (variable == NORMAL_CHANNEL_NAME)
 					assignToMap(DTEA_NORMAL_CHANNEL_NAME);
-				else if (variable == BLOOM_PSF_FILE)
-					assignToMap(DTEA_BLOOM_PSF_FILE);
 				else
 				{
 					os::Printer::log("ERROR (" + std::to_string(__LINE__) + " line): Unexcepted argument! Id of input stride: " + std::to_string(inputBatchStride), ELL_ERROR);
@@ -225,7 +227,7 @@ CommandLineHandler::CommandLineHandler(core::vector<std::string> argv, IAssetMan
 
 bool CommandLineHandler::validateMandatoryParameters(const variablesType& rawVariablesPerFile, const size_t idOfInput)
 {
-	static const nbl::core::vector<DENOISER_TONEMAPPER_EXAMPLE_ARGUMENTS> mandatoryArgumentsOrdinary = { DTEA_COLOR_FILE, DTEA_CAMERA_TRANSFORM, DTEA_DENOISER_EXPOSURE_BIAS, DTEA_DENOISER_BLEND_FACTOR, DTEA_BLOOM_SCALE, DTEA_OUTPUT };
+	static const nbl::core::vector<DENOISER_TONEMAPPER_EXAMPLE_ARGUMENTS> mandatoryArgumentsOrdinary = { DTEA_COLOR_FILE, DTEA_CAMERA_TRANSFORM, DTEA_DENOISER_EXPOSURE_BIAS, DTEA_DENOISER_BLEND_FACTOR, DTEA_BLOOM_PSF_FILE, DTEA_BLOOM_RELATIVE_SCALE, DTEA_BLOOM_INTENSITY, DTEA_OUTPUT };
 
 	auto log = [&](bool status, const std::string message)
 	{

examples_tests/39.DenoiserTonemapper/CommandLineHandler.hpp

@@ -12,9 +12,9 @@
 #include "nbl/core/core.h"
 #include "nbl/ext/MitsubaLoader/CMitsubaLoader.h"
 
-#define PROPER_CMD_ARGUMENTS_AMOUNT 14
-#define MANDATORY_CMD_ARGUMENTS_AMOUNT 8
-#define OPTIONAL_CMD_ARGUMENTS_AMOUNT 6
+#define PROPER_CMD_ARGUMENTS_AMOUNT 17
+#define MANDATORY_CMD_ARGUMENTS_AMOUNT 12
+#define OPTIONAL_CMD_ARGUMENTS_AMOUNT 5
 #define PROPER_BATCH_FILE_ARGUMENTS_AMOUNT 3
 
 enum COMMAND_LINE_MODE
@@ -36,7 +36,9 @@ Mandatory parameters:
 -CAMERA_TRANSFORM=mitsubaFilePath or val1,val2,val3,...,val9
 -DENOISER_EXPOSURE_BIAS=value
 -DENOISER_BLEND_FACTOR=value
--BLOOM_SCALE=theta
+-BLOOM_PSF_FILE=psfFilePath
+-BLOOM_RELATIVE_SCALE=value
+-BLOOM_INTENSITY=value
 -TONEMAPPER=tonemapper=keyValue,extraParameter
 -OUTPUT=file.choosenextension
 Optional Parameters:
@@ -45,7 +47,6 @@ Optional Parameters:
 -COLOR_CHANNEL_NAME=colorChannelName
 -ALBEDO_CHANNEL_NAME=albedoChannelName
 -NORMAL_CHANNEL_NAME=normalChannelName
--BLOOM_PSF_FILE=psfFilePath
 
 Note there mustn't be any space characters!
 All files' (except the bloom kernel) resolutions must match!
@@ -73,9 +74,14 @@ you should use the Tonemapping Operator's Key Value.
 
 DENOISER_BLEND_FACTOR: denoiser blend factor, 0.0 is full denoise, 1.0 is no denoise.
 
-BLOOM_SCALE: Must not be negative or greater than 1. The scale relative to the kernel being placed at the center of the denoised image and isotropically stretched until it touches one of the sides of the denoised image.
-You'll usually want to keep this value below 1/32
-If you don't want bloom then either provide a PSF image which is a single white pixel, or set bloom scale to a very small non negative value.
+BLOOM_PSF_FILE: A EXR file with a HDR sprite corresponding to the Point Spread Function you want to convolve the image with.
+
+BLOOM_RELATIVE_SCALE: Must not be negative or greater than 1. The scale relative to the kernel being placed at the center of the denoised image and isotropically stretched until it touches one of the sides of the denoised image.
+You'll usually want to keep this value quite small (below 1/32) to make sure the kernel has a higher pixel density relative to the image, otherwise you'll end up blurring the image (the executable will print a warning).
+Do not use it for actually controlling the size of the flare, this is because even though the kernel is scaled, it is normalized to conserve energy, which eventually degenerates into an ugly box blur as scale tends to 0.
+
+BLOOM_INTENSITY: Must be in the [0,1] range, it actually controls the size of the flare much better than the relative scale (assuming a good HDR kernel with very long tails).
+If you don't want bloom then set bloom intensity to 0.
 
 TONEMAPPER: tonemapper - choose between "REINHARD", "ACES" and "NONE". After specifying it you have to pass arguments to revelant tonemapper,
 the first argument is always the Key Value, a good default is 0.18 like the Reinhard paper's default.
@@ -100,7 +106,6 @@ while "NONE looks like:
 -TONEMAPPER=NONE=AutoexposureOff
 
 OUTPUT: output file with specified extension 
-BLOOM_PSF_FILE: A EXR file with a HDR sprite corresponding to the Point Spread Function you want to convolve the image with.
 The kernel must be centered and in RGB or RGBA floating point format. Resolution should be less than the denoised image.
 If this file is not provided then we use a built-in PSF as the kernel for the convolution.
 )";
@@ -109,7 +114,9 @@ constexpr std::string_view COLOR_FILE = "COLOR_FILE";
 constexpr std::string_view CAMERA_TRANSFORM = "CAMERA_TRANSFORM";
 constexpr std::string_view DENOISER_EXPOSURE_BIAS = "DENOISER_EXPOSURE_BIAS";
 constexpr std::string_view DENOISER_BLEND_FACTOR = "DENOISER_BLEND_FACTOR";
-constexpr std::string_view BLOOM_SCALE = "BLOOM_SCALE";
+constexpr std::string_view BLOOM_PSF_FILE = "BLOOM_PSF_FILE";
+constexpr std::string_view BLOOM_RELATIVE_SCALE = "BLOOM_RELATIVE_SCALE";
+constexpr std::string_view BLOOM_INTENSITY = "BLOOM_INTENSITY";
 constexpr std::string_view TONEMAPPER = "TONEMAPPER";
 constexpr std::string_view REINHARD = "REINHARD";
 constexpr std::string_view ACES = "ACES";
@@ -121,15 +128,16 @@ constexpr std::string_view NORMAL_FILE = "NORMAL_FILE";
 constexpr std::string_view COLOR_CHANNEL_NAME = "COLOR_CHANNEL_NAME";
 constexpr std::string_view ALBEDO_CHANNEL_NAME = "ALBEDO_CHANNEL_NAME";
 constexpr std::string_view NORMAL_CHANNEL_NAME = "NORMAL_CHANNEL_NAME";
-constexpr std::string_view BLOOM_PSF_FILE = "BLOOM_PSF_FILE";
 
 constexpr std::array<std::string_view, MANDATORY_CMD_ARGUMENTS_AMOUNT> REQUIRED_PARAMETERS =
 {
 	COLOR_FILE,
 	CAMERA_TRANSFORM,
 	DENOISER_EXPOSURE_BIAS,
 	DENOISER_BLEND_FACTOR,
-	BLOOM_SCALE,
+	BLOOM_PSF_FILE,
+	BLOOM_RELATIVE_SCALE,
+	BLOOM_INTENSITY,
 	TONEMAPPER,
 	OUTPUT
 };
@@ -144,7 +152,9 @@ enum DENOISER_TONEMAPPER_EXAMPLE_ARGUMENTS
 	DTEA_CAMERA_TRANSFORM,
 	DTEA_DENOISER_EXPOSURE_BIAS,
 	DTEA_DENOISER_BLEND_FACTOR,
-	DTEA_BLOOM_SCALE,
+	DTEA_BLOOM_PSF_FILE,
+	DTEA_BLOOM_RELATIVE_SCALE,
+	DTEA_BLOOM_INTENSITY,
 	DTEA_TONEMAPPER,
 	DTEA_TONEMAPPER_REINHARD,
 	DTEA_TONEMAPPER_ACES,
@@ -160,7 +170,6 @@ enum DENOISER_TONEMAPPER_EXAMPLE_ARGUMENTS
 	DTEA_COLOR_CHANNEL_NAME,
 	DTEA_ALBEDO_CHANNEL_NAME,
 	DTEA_NORMAL_CHANNEL_NAME,
-	DTEA_BLOOM_PSF_FILE,
 
 	DTEA_COUNT
 };
@@ -234,9 +243,14 @@ class CommandLineHandler
 			return denoiserBlendFactorBundle;
 		}
 
-		auto& getBloomScaleBundle() const
+		auto& getBloomRelativeScaleBundle() const
 		{
-			return bloomScaleBundle;
+			return bloomRelativeScaleBundle;
+		}
+
+		auto& getBloomIntensityBundle() const
+		{
+			return bloomIntensityBundle;
 		}
 
 		auto& getTonemapperBundle() const
@@ -266,7 +280,9 @@ class CommandLineHandler
 			rawVariablesPerFile[DTEA_CAMERA_TRANSFORM];
 			rawVariablesPerFile[DTEA_DENOISER_EXPOSURE_BIAS];
 			rawVariablesPerFile[DTEA_DENOISER_BLEND_FACTOR];
-			rawVariablesPerFile[DTEA_BLOOM_SCALE];
+			rawVariablesPerFile[DTEA_BLOOM_PSF_FILE];
+			rawVariablesPerFile[DTEA_BLOOM_RELATIVE_SCALE];
+			rawVariablesPerFile[DTEA_BLOOM_INTENSITY];
 			rawVariablesPerFile[DTEA_TONEMAPPER_REINHARD];
 			rawVariablesPerFile[DTEA_TONEMAPPER_ACES];
 			rawVariablesPerFile[DTEA_TONEMAPPER_NONE];
@@ -277,7 +293,6 @@ class CommandLineHandler
 			rawVariablesPerFile[DTEA_COLOR_CHANNEL_NAME];
 			rawVariablesPerFile[DTEA_ALBEDO_CHANNEL_NAME];
 			rawVariablesPerFile[DTEA_NORMAL_CHANNEL_NAME];
-			rawVariablesPerFile[DTEA_BLOOM_PSF_FILE];
 		}
 
 		DENOISER_TONEMAPPER_EXAMPLE_ARGUMENTS getMatchedVariableMapID(const std::string& variableName)
@@ -290,8 +305,12 @@ class CommandLineHandler
 				return DTEA_DENOISER_EXPOSURE_BIAS;
 			else if (variableName == DENOISER_BLEND_FACTOR)
 				return DTEA_DENOISER_BLEND_FACTOR;
-			else if (variableName == BLOOM_SCALE)
-				return DTEA_BLOOM_SCALE;
+			else if (variableName == BLOOM_PSF_FILE)
+				return DTEA_BLOOM_PSF_FILE;
+			else if (variableName == BLOOM_RELATIVE_SCALE)
+				return DTEA_BLOOM_RELATIVE_SCALE;
+			else if (variableName == BLOOM_INTENSITY)
+				return DTEA_BLOOM_INTENSITY;
 			else if (variableName == TONEMAPPER)
 				return DTEA_TONEMAPPER;
 			else if (variableName == REINHARD)
@@ -312,8 +331,6 @@ class CommandLineHandler
 				return DTEA_ALBEDO_CHANNEL_NAME;
 			else if (variableName == NORMAL_CHANNEL_NAME)
 				return DTEA_NORMAL_CHANNEL_NAME;
-			else if (variableName == BLOOM_PSF_FILE)
-				return DTEA_BLOOM_PSF_FILE;
 			else
 				return DTEA_COUNT;
 		}
@@ -342,9 +359,14 @@ class CommandLineHandler
 			return std::stof(rawVariables[id][DTEA_DENOISER_BLEND_FACTOR].value()[0]);
 		}
 
-		auto getBloomScale(uint64_t id = 0)
+		auto getBloomRelativeScale(uint64_t id = 0)
+		{
+			return std::stof(rawVariables[id][DTEA_BLOOM_RELATIVE_SCALE].value()[0]);
+		}
+
+		auto getBloomIntensity(uint64_t id = 0)
 		{
-			return std::stof(rawVariables[id][DTEA_BLOOM_SCALE].value()[0]);
+			return std::stof(rawVariables[id][DTEA_BLOOM_INTENSITY].value()[0]);
 		}
 
 		auto getTonemapper(uint64_t id = 0)
@@ -438,10 +460,11 @@ class CommandLineHandler
 			cameraTransformBundle.reserve(inputFilesAmount);
 			denoiserExposureBiasBundle.reserve(inputFilesAmount);
 			denoiserBlendFactorBundle.reserve(inputFilesAmount);
-			bloomScaleBundle.reserve(inputFilesAmount);
+			bloomPsfFileNameBundle.reserve(inputFilesAmount);
+			bloomRelativeScaleBundle.reserve(inputFilesAmount);
+			bloomIntensityBundle.reserve(inputFilesAmount);
 			tonemapperBundle.reserve(inputFilesAmount);
 			outputFileNameBundle.reserve(inputFilesAmount);
-			bloomPsfFileNameBundle.reserve(inputFilesAmount);
 
 			for (auto i = 0ul; i < inputFilesAmount; ++i)
 			{
@@ -454,10 +477,11 @@ class CommandLineHandler
 				cameraTransformBundle.push_back(getCameraTransform(i));
 				denoiserExposureBiasBundle.push_back(getDenoiserExposureBias(i));
 				denoiserBlendFactorBundle.push_back(getDenoiserBlendFactor(i));
-				bloomScaleBundle.push_back(getBloomScale(i));
+				bloomPsfFileNameBundle.push_back(getBloomPsfFile(i));
+				bloomRelativeScaleBundle.push_back(getBloomRelativeScale(i));
+				bloomIntensityBundle.push_back(getBloomIntensity(i));
 				tonemapperBundle.push_back(getTonemapper(i));
 				outputFileNameBundle.push_back(getOutputFile(i));
-				bloomPsfFileNameBundle.push_back(getBloomPsfFile(i));
 			}
 		}
 
@@ -478,10 +502,11 @@ class CommandLineHandler
 		nbl::core::vector<std::optional<nbl::core::matrix3x4SIMD>> cameraTransformBundle;
 		nbl::core::vector<std::optional<float>> denoiserExposureBiasBundle;
 		nbl::core::vector<std::optional<float>> denoiserBlendFactorBundle;
-		nbl::core::vector<std::optional<float>> bloomScaleBundle;
+		nbl::core::vector<std::optional<std::string>> bloomPsfFileNameBundle;
+		nbl::core::vector<std::optional<float>> bloomRelativeScaleBundle;
+		nbl::core::vector<std::optional<float>> bloomIntensityBundle;
 		nbl::core::vector<std::pair<DENOISER_TONEMAPPER_EXAMPLE_ARGUMENTS,nbl::core::vector<float>>> tonemapperBundle;
 		nbl::core::vector<std::optional<std::string>> outputFileNameBundle;
-		nbl::core::vector<std::optional<std::string>> bloomPsfFileNameBundle;
 
 		std::chrono::nanoseconds elapsedTimeXmls = {};
 		std::chrono::nanoseconds elapsedTimeEntireLoading = {};

examples_tests/39.DenoiserTonemapper/exampleInputArguments.txt

@@ -1,2 +1,6 @@
--COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=1.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_SCALE=0.0625 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=spp_benchmark_4k_512_reference.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal
--COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=0.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_SCALE=0.0625 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=spp_benchmark_4k_512_denoised.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal
+-COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=0.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_RELATIVE_SCALE=0.235 -BLOOM_INTENSITY=0.99 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=bloom_intens_0_99.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal
+-COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=0.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_RELATIVE_SCALE=0.235 -BLOOM_INTENSITY=0.75 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=bloom_intens_0_75.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal
+-COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=0.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_RELATIVE_SCALE=0.235 -BLOOM_INTENSITY=0.5 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=bloom_intens_0_5.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal
+-COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=0.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_RELATIVE_SCALE=0.235 -BLOOM_INTENSITY=0.25 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=bloom_intens_0_25.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal
+
+-COLOR_FILE=../../media/noises/spp_benchmark_4k_512.exr -ALBEDO_FILE=../../media/noises/spp_benchmark_4k_512.exr -NORMAL_FILE=../../media/noises/spp_benchmark_4k_512.exr -CAMERA_TRANSFORM=../../media/noises/render.xml -DENOISER_EXPOSURE_BIAS=0.0 -DENOISER_BLEND_FACTOR=1.0 -BLOOM_PSF_FILE=../../media/kernels/physical_flare_512.exr -BLOOM_RELATIVE_SCALE=0.01 -BLOOM_INTENSITY=0.0 -TONEMAPPER=ACES=0.4,0.8 -OUTPUT=reference.exr -COLOR_CHANNEL_NAME=color -ALBEDO_CHANNEL_NAME=albedo -NORMAL_CHANNEL_NAME=normal