Merge pull request godotengine#101255 from metamuffin/load-exr-image

Add `Image.load_exr_from_buffer`

Author: Repiteo

core/io/image.cpp

@@ -3925,6 +3925,7 @@ void Image::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("load_bmp_from_buffer", "buffer"), &Image::load_bmp_from_buffer);
 	ClassDB::bind_method(D_METHOD("load_ktx_from_buffer", "buffer"), &Image::load_ktx_from_buffer);
 	ClassDB::bind_method(D_METHOD("load_dds_from_buffer", "buffer"), &Image::load_dds_from_buffer);
+	ClassDB::bind_method(D_METHOD("load_exr_from_buffer", "buffer"), &Image::load_exr_from_buffer);
 
 	ClassDB::bind_method(D_METHOD("load_svg_from_buffer", "buffer", "scale"), &Image::load_svg_from_buffer, DEFVAL(1.0));
 	ClassDB::bind_method(D_METHOD("load_svg_from_string", "svg_str", "scale"), &Image::load_svg_from_string, DEFVAL(1.0));
@@ -4424,6 +4425,14 @@ Error Image::load_jpg_from_buffer(const Vector<uint8_t> &p_array) {
 	return _load_from_buffer(p_array, _jpg_mem_loader_func);
 }
 
+Error Image::load_exr_from_buffer(const Vector<uint8_t> &p_array) {
+	ERR_FAIL_NULL_V_MSG(
+			_exr_mem_loader_func,
+			ERR_UNAVAILABLE,
+			"The TinyEXR module isn't enabled. Recompile the Godot editor or export template binary with the `tinyexr_export_templates=yes` SCons option.");
+	return _load_from_buffer(p_array, _exr_mem_loader_func);
+}
+
 Error Image::load_webp_from_buffer(const Vector<uint8_t> &p_array) {
 	return _load_from_buffer(p_array, _webp_mem_loader_func);
 }

core/io/image.h

@@ -219,6 +219,7 @@ class Image : public Resource {
 	static inline ScalableImageMemLoadFunc _svg_scalable_mem_loader_func = nullptr;
 	static inline ImageMemLoadFunc _ktx_mem_loader_func = nullptr;
 	static inline ImageMemLoadFunc _dds_mem_loader_func = nullptr;
+	static inline ImageMemLoadFunc _exr_mem_loader_func = nullptr;
 
 	// External VRAM compression function pointers.
 
@@ -429,6 +430,7 @@ class Image : public Resource {
 	Error load_bmp_from_buffer(const Vector<uint8_t> &p_array);
 	Error load_ktx_from_buffer(const Vector<uint8_t> &p_array);
 	Error load_dds_from_buffer(const Vector<uint8_t> &p_array);
+	Error load_exr_from_buffer(const Vector<uint8_t> &p_array);
 
 	Error load_svg_from_buffer(const Vector<uint8_t> &p_array, float scale = 1.0);
 	Error load_svg_from_string(const String &p_svg_str, float scale = 1.0);

doc/classes/Image.xml

@@ -356,6 +356,13 @@
 				[b]Note:[/b] This method is only available in engine builds with the DDS module enabled. By default, the DDS module is enabled, but it can be disabled at build-time using the [code]module_dds_enabled=no[/code] SCons option.
 			</description>
 		</method>
+		<method name="load_exr_from_buffer">
+			<return type="int" enum="Error" />
+			<param index="0" name="buffer" type="PackedByteArray" />
+			<description>
+				Loads an image from the binary contents of an OpenEXR file.
+			</description>
+		</method>
 		<method name="load_from_file" qualifiers="static">
 			<return type="Image" />
 			<param index="0" name="path" type="String" />
@@ -489,15 +496,13 @@
 			<param index="1" name="grayscale" type="bool" default="false" />
 			<description>
 				Saves the image as an EXR file to [param path]. If [param grayscale] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module.
-				[b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project.
 			</description>
 		</method>
 		<method name="save_exr_to_buffer" qualifiers="const">
 			<return type="PackedByteArray" />
 			<param index="0" name="grayscale" type="bool" default="false" />
 			<description>
 				Saves the image as an EXR file to a byte array. If [param grayscale] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module.
-				[b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr_to_buffer] will return an empty byte array when it is called from an exported project.
 			</description>
 		</method>
 		<method name="save_jpg" qualifiers="const">

modules/tinyexr/config.py

@@ -1,5 +1,5 @@
 def can_build(env, platform):
-    return env.editor_build
+    return True
 
 
 def configure(env):

modules/tinyexr/image_loader_tinyexr.cpp

@@ -34,6 +34,8 @@
 
 #include "thirdparty/tinyexr/tinyexr.h"
 
+#include "core/io/file_access_memory.h"
+
 Error ImageLoaderTinyEXR::load_image(Ref<Image> p_image, Ref<FileAccess> f, BitField<ImageFormatLoader::LoaderFlags> p_flags, float p_scale) {
 	Vector<uint8_t> src_image;
 	uint64_t src_image_len = f->get_length();
@@ -291,5 +293,19 @@ void ImageLoaderTinyEXR::get_recognized_extensions(List<String> *p_extensions) c
 	p_extensions->push_back("exr");
 }
 
+static Ref<Image> _tinyexr_mem_loader_func(const uint8_t *p_exr, int p_size) {
+	Ref<FileAccessMemory> memfile;
+	memfile.instantiate();
+	Error open_memfile_error = memfile->open_custom(p_exr, p_size);
+	ERR_FAIL_COND_V_MSG(open_memfile_error, Ref<Image>(), "Could not create memfile for EXR image buffer.");
+
+	Ref<Image> img;
+	img.instantiate();
+	Error load_error = ImageLoaderTinyEXR().load_image(img, memfile, false, 1.0f);
+	ERR_FAIL_COND_V_MSG(load_error, Ref<Image>(), "Failed to load EXR image.");
+	return img;
+}
+
 ImageLoaderTinyEXR::ImageLoaderTinyEXR() {
+	Image::_exr_mem_loader_func = _tinyexr_mem_loader_func;
 }

platform/linuxbsd/wayland/display_server_wayland.cpp

@@ -546,6 +546,8 @@ Ref<Image> DisplayServerWayland::clipboard_get_image() const {
 		err = image->load_tga_from_buffer(wayland_thread.selection_get_mime("image/x-targa"));
 	} else if (wayland_thread.selection_has_mime("image/ktx")) {
 		err = image->load_ktx_from_buffer(wayland_thread.selection_get_mime("image/ktx"));
+	} else if (wayland_thread.selection_has_mime("image/x-exr")) {
+		err = image->load_exr_from_buffer(wayland_thread.selection_get_mime("image/x-exr"));
 	}
 
 	ERR_FAIL_COND_V(err != OK, Ref<Image>());

tests/core/io/test_image.h

@@ -122,6 +122,20 @@ TEST_CASE("[Image] Saving and loading") {
 			"The BMP image should load successfully.");
 #endif // MODULE_BMP_ENABLED
 
+#ifdef MODULE_EXR_ENABLED
+	// Load EXR
+	Ref<Image> image_exr;
+	image_exr.instantiate();
+	Ref<FileAccess> f_exr = FileAccess::open(TestUtils::get_data_path("images/icon.exr"), FileAccess::READ, &err);
+	REQUIRE(f_exr.is_valid());
+	PackedByteArray data_exr;
+	data_exr.resize(f_exr->get_length() + 1);
+	f_exr->get_buffer(data_exr.ptrw(), f_exr->get_length());
+	CHECK_MESSAGE(
+			image_exr->load_exr_from_buffer(data_exr) == OK,
+			"The EXR image should load successfully.");
+#endif // MODULE_EXR_ENABLED
+
 #ifdef MODULE_JPG_ENABLED
 	// Load JPG
 	Ref<Image> image_jpg = memnew(Image());