add new OpenEXR integration into Nabla with core & full mode switch depending on _NBL_COMPILE_WITH_OPEN_EXR_, make it's libs being linked into Nabla's DLL (when in DLL mode), perform tests. Leave some TODO comments to Nahim

Author: AnastaZIuk

3rdparty/CMakeLists.txt

@@ -160,24 +160,34 @@ add_subdirectory(libpng libpng EXCLUDE_FROM_ALL)
 add_dependencies(png_static zlibstatic)
 
 
-#openexr
+# OpenEXR
 option(_NBL_COMPILE_WITH_OPEN_EXR_ "Build with OpenEXR library" ON)
-if (_NBL_COMPILE_WITH_OPEN_EXR_)
-	set(_OLD_BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS})
-	set(_OLD_BUILD_STATIC_LIBS ${BUILD_STATIC_LIBS})
-	set(_OLD_BUILD_TESTING ${BUILD_TESTING})
-	set(BUILD_SHARED_LIBS OFF)
-	set(BUILD_STATIC_LIBS OFF)
-	set(BUILD_TESTING OFF)
-	set(PYILMBASE_ENABLE OFF CACHE STRING "" FORCE)
-	set(OPENEXR_BUILD_UTILS OFF CACHE STRING "" FORCE)
-	set(OPENEXR_VIEWERS_ENABLE OFF CACHE STRING "" FORCE)
-	add_subdirectory(openexr openexr EXCLUDE_FROM_ALL)
-	set(BUILD_SHARED_LIBS ${_OLD_BUILD_SHARED_LIBS})
-	set(BUILD_STATIC_LIBS ${_OLD_BUILD_STATIC_LIBS})
-	set(BUILD_TESTING ${_OLD_BUILD_TESTING})
-endif()
 
+# Note we are adding it anyway regardless _NBL_COMPILE_WITH_OPEN_EXR_, its because we need Half dependecy 
+# it generates on fly in its build directory which doesnt have to be linked (class with inline methods), 
+# here is where _NBL_COMPILE_WITH_OPEN_EXR_ plays a role - when disabled OpenEXR won't be built and linked
+# but it's core 
+
+set(_OLD_BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS})
+set(_OLD_BUILD_STATIC_LIBS ${BUILD_STATIC_LIBS})
+set(_OLD_BUILD_TESTING ${BUILD_TESTING})
+set(BUILD_SHARED_LIBS OFF)
+set(BUILD_STATIC_LIBS OFF)
+set(BUILD_TESTING OFF)
+set(PYILMBASE_ENABLE OFF CACHE STRING "" FORCE)
+set(OPENEXR_BUILD_UTILS OFF CACHE STRING "" FORCE)
+set(OPENEXR_FORCE_INTERNAL_IMATH ON CACHE STRING "" FORCE) # TODO: make it a submodule and force using it maybe instead of letting OpenEXR download it from it's github repository
+set(OPENEXR_BUILD_TOOLS OFF CACHE STRING "" FORCE) 
+set(OPENEXR_INSTALL OFF CACHE STRING "" FORCE)
+set(OPENEXR_INSTALL_DOCS OFF CACHE STRING "" FORCE)
+set(OPENEXR_INSTALL_EXAMPLES OFF CACHE STRING "" FORCE)
+set(OPENEXR_INSTALL_PKG_CONFIG OFF CACHE STRING "" FORCE)
+set(OPENEXR_INSTALL_TOOLS OFF CACHE STRING "" FORCE)
+
+add_subdirectory(openexr openexr EXCLUDE_FROM_ALL)
+set(BUILD_SHARED_LIBS ${_OLD_BUILD_SHARED_LIBS})
+set(BUILD_STATIC_LIBS ${_OLD_BUILD_STATIC_LIBS})
+set(BUILD_TESTING ${_OLD_BUILD_TESTING})
 
 #gli
 option(_NBL_COMPILE_WITH_GLI_ "Build with GLI library" ON)
@@ -340,7 +350,6 @@ if (NBL_COMPILE_WITH_CUDA)
 	endif()
 endif()
 
-
 # Final gather
 set(NBL_3RDPARTY_TARGETS
 				lzma
@@ -361,18 +370,15 @@ set(NBL_3RDPARTY_TARGETS
 				GenericCodeGen
 				SPIRV 
 				SPIRV-Tools-static # SPIRV-Tools-shared in case of SHARED lib
-				SPIRV-Tools-opt 
+				SPIRV-Tools-opt
+				Imath
+				OpenEXRCore
 )
 if (_NBL_COMPILE_WITH_OPEN_EXR_)
 	list(APPEND NBL_3RDPARTY_TARGETS
-	    IlmBaseConfig
-		IlmImfConfig
-		Imath
-		IlmThread
-		IlmImf
-		Half
+		OpenEXR
 		Iex
-		IexMath
+		IlmThread
 	)
 endif()
 if(ANDROID AND NOT ${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Windows")

src/nbl/CMakeLists.txt

@@ -242,15 +242,15 @@ set(NBL_ASSET_SOURCES
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageLoaderJPG.cpp
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageLoaderPNG.cpp
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageLoaderTGA.cpp
-	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageLoaderOpenEXR.cpp
+	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageLoaderOpenEXR.cpp # TODO: Nahim
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CGLILoader.cpp
 
 # Image writers
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/IImageWriter.cpp
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageWriterJPG.cpp
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageWriterPNG.cpp
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageWriterTGA.cpp
-	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageWriterOpenEXR.cpp
+	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CImageWriterOpenEXR.cpp # TODO: Nahim
 	${NBL_ROOT_PATH}/src/nbl/asset/interchange/CGLIWriter.cpp
 
 # Material compiler
@@ -338,8 +338,6 @@ set(COMMON_INCLUDE_DIRS
 	${THIRD_PARTY_SOURCE_DIR}/glm
         ${THIRD_PARTY_SOURCE_DIR}/renderdoc # for renderdoc api header
 	${CMAKE_BINARY_DIR}/3rdparty/zlib #for dynamically generated zconf.h
-	${CMAKE_BINARY_DIR}/3rdparty/openexr/IlmBase/config #for dynamically generated IlmBaseConfig.h
-	${CMAKE_BINARY_DIR}/3rdparty/openexr/OpenEXR/config #for dynamically generated OpenEXRConfig.h
 	$<TARGET_PROPERTY:png_static,BINARY_DIR> #for dynamically generated pnglibconf.h
 	$<TARGET_PROPERTY:jpeg-static,BINARY_DIR> #for dynamically generated jconfig.h
 )
@@ -497,24 +495,30 @@ endif()
 target_include_directories(Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/libpng)
 # OpenEXR
 if (_NBL_COMPILE_WITH_OPEN_EXR_)
-	add_dependencies(Nabla OpenEXR::IlmImf)
+	add_dependencies(Nabla OpenEXR)
 	if(NBL_STATIC_BUILD)
-		target_link_libraries(Nabla INTERFACE OpenEXR::IlmImf)
+		target_link_libraries(Nabla INTERFACE OpenEXR)
 	else()
-		target_link_libraries(Nabla PRIVATE OpenEXR::IlmImf)
+		target_link_libraries(Nabla PRIVATE OpenEXR)
 	endif()
 
-	target_link_libraries(Nabla INTERFACE Half) # a workaround which causes Half static library to be linked directly to each Nabla example no matter if Nabla is DLL or not, I think we should really not expose OpenEXR interface to our public Nabla include files
+	target_include_directories(
+		Nabla PUBLIC $<TARGET_PROPERTY:OpenEXR,INCLUDE_DIRECTORIES>				   
+	)
+else()
+	add_dependencies(Nabla OpenEXRCore)
+	if(NBL_STATIC_BUILD)
+		target_link_libraries(Nabla INTERFACE OpenEXRCore)
+	else()
+		target_link_libraries(Nabla PRIVATE OpenEXRCore)
+	endif()
 
 	target_include_directories(
-		Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/openexr/OpenEXR/IlmImf
-		Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/openexr/IlmBase/Half
-		Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/openexr/IlmBase/Iex
-		Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/openexr/IlmBase/IexMath
-		Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/openexr/IlmBase/Imath
-		Nabla PUBLIC ${THIRD_PARTY_SOURCE_DIR}/openexr/IlmBase/IlmThread						   
+		Nabla PUBLIC $<TARGET_PROPERTY:OpenEXRCore,INCLUDE_DIRECTORIES> # for OpenEXR's Half-only dependency					   
 	)
 endif()
+
+# GLI
 if(_NBL_COMPILE_WITH_GLI_)
 	add_dependencies(Nabla gli)
 	if(NBL_STATIC_BUILD)
@@ -702,20 +706,9 @@ if(NBL_STATIC_BUILD)
 	nbl_install_lib(HLSL)
 	nbl_install_lib(jpeg-static)
 	if (_NBL_COMPILE_WITH_OPEN_EXR_)
-		# OpenEXR guys, please correct installation targets to avoid warnings!
-		set_target_properties(Half PROPERTIES PUBLIC_HEADER "")
-		set_target_properties(Iex PROPERTIES PUBLIC_HEADER "")
-		set_target_properties(IexMath PROPERTIES PUBLIC_HEADER "")
-		set_target_properties(IlmImf PROPERTIES PUBLIC_HEADER "")
-		set_target_properties(IlmThread PROPERTIES PUBLIC_HEADER "")
-		set_target_properties(Imath PROPERTIES PUBLIC_HEADER "")
-	
-		nbl_install_lib(Half)
-		nbl_install_lib(Iex)
-		nbl_install_lib(IexMath)
-		nbl_install_lib(IlmImf)
-		nbl_install_lib(IlmThread)
-		nbl_install_lib(Imath)
+		nbl_install_lib(OpenEXR)
+	else()
+		nbl_install_lib(OpenEXRCore)
 	endif()
 	nbl_install_lib(png_static)
 

src/nbl/asset/interchange/CImageLoaderOpenEXR.cpp

@@ -17,6 +17,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
+#if 0 // oldie
+
 #include <algorithm>
 #include <iostream>
 #include <string>
@@ -608,3 +610,4 @@ bool readHeader(IMF::IStream* nblIStream, SContext& ctx)
 
 
 #endif // _NBL_COMPILE_WITH_OPENEXR_LOADER_
+#endif

src/nbl/asset/interchange/CImageLoaderOpenEXR.h

@@ -25,7 +25,10 @@ class CImageLoaderOpenEXR final : public IImageLoader
 	public:
 		CImageLoaderOpenEXR(IAssetManager* _manager) : m_manager(_manager) {}
 
-		bool isALoadableFileFormat(system::IFile* _file, const system::logger_opt_ptr logger) const override;
+		bool isALoadableFileFormat(system::IFile* _file, const system::logger_opt_ptr logger) const override
+		{
+			return false; // TODO: Nahim, implement in cpp file please
+		}
 
 		const char** getAssociatedFileExtensions() const override
 		{
@@ -35,7 +38,10 @@ class CImageLoaderOpenEXR final : public IImageLoader
 
 		uint64_t getSupportedAssetTypesBitfield() const override { return asset::IAsset::ET_IMAGE; }
 
-		asset::SAssetBundle loadAsset(system::IFile* _file, const asset::IAssetLoader::SAssetLoadParams& _params, asset::IAssetLoader::IAssetLoaderOverride* _override = nullptr, uint32_t _hierarchyLevel = 0u) override;
+		asset::SAssetBundle loadAsset(system::IFile* _file, const asset::IAssetLoader::SAssetLoadParams& _params, asset::IAssetLoader::IAssetLoaderOverride* _override = nullptr, uint32_t _hierarchyLevel = 0u) override
+		{
+			return {}; // TODO: Nahim, implement in cpp file please
+		}
 
 	private:
 

src/nbl/asset/interchange/CImageWriterOpenEXR.cpp

@@ -17,6 +17,9 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
+
+#if 0 // oldie
+
 #include <algorithm>
 #include <iostream>
 #include <string>
@@ -236,3 +239,5 @@ bool CImageWriterOpenEXR::writeImageBinary(system::IFile* file, const asset::ICP
 	return true;
 }
 #endif // _NBL_COMPILE_WITH_OPENEXR_WRITER_
+
+#endif

src/nbl/asset/interchange/CImageWriterOpenEXR.h

@@ -37,11 +37,17 @@ class CImageWriterOpenEXR final : public IImageWriter
 
 		uint32_t getForcedFlags() { return asset::EWF_BINARY; }
 
-		bool writeAsset(system::IFile* _file, const SAssetWriteParams& _params, IAssetWriterOverride* _override = nullptr) override;
+		bool writeAsset(system::IFile* _file, const SAssetWriteParams& _params, IAssetWriterOverride* _override = nullptr) override
+		{
+			return false; // TODO: Nahim implement in cpp file please
+		}
 
 	private:
 
-		bool writeImageBinary(system::IFile* file, const asset::ICPUImage* image);
+		bool writeImageBinary(system::IFile* file, const asset::ICPUImage* image)
+		{
+			return false; // TODO: Nahim implement in cpp file please
+		}
 };
 
 }