Skip to content

[OIDN] Switch to using external library. #83314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+193 −115
Draft

[OIDN] Switch to using external library. #83314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 118 additions & 112 deletions modules/lightmapper_rd/lightmapper_rd.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,127 +778,137 @@ LightmapperRD::BakeError LightmapperRD::_dilate(RenderingDevice *rd, Ref<RDShade
return BAKE_OK;
}

Error LightmapperRD::_store_pfm(RenderingDevice *p_rd, RID p_atlas_tex, int p_index, const Size2i &p_atlas_size, const String &p_name) {
Vector<uint8_t> data = p_rd->texture_get_data(p_atlas_tex, p_index);
Ref<Image> img = Image::create_from_data(p_atlas_size.width, p_atlas_size.height, false, Image::FORMAT_RGBAH, data);
img->convert(Image::FORMAT_RGBF);
Vector<uint8_t> data_float = img->get_data();

Error err = OK;
Ref<FileAccess> file = FileAccess::open(p_name, FileAccess::WRITE, &err);
ERR_FAIL_COND_V_MSG(err, err, vformat("Can't save PFN at path: '%s'.", p_name));
file->store_line("PF");
file->store_line(vformat("%d %d", img->get_width(), img->get_height()));
#ifdef BIG_ENDIAN_ENABLED
file->store_line("1.0");
#else
file->store_line("-1.0");
#endif
file->store_buffer(data_float);
file->close();
bool LightmapperRD::_load_oidn(const String &p_library_path) {
if (oidn_lib_path == p_library_path) {
return oidn_lib_handle != nullptr;
}
oidn_lib_path = p_library_path;

return OK;
Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
String lib_name;
if (OS::get_singleton()->get_name() == "macOS") {
lib_name = "libOpenImageDenoise.dylib";
} else if (OS::get_singleton()->get_name() == "Windows") {
lib_name = "OpenImageDenoise.dll";
} else {
lib_name = "libOpenImageDenoise.so";
}
String lib_path = oidn_lib_path.path_join(lib_name);
if (!da->file_exists(lib_path)) {
lib_path = oidn_lib_path.path_join("lib").path_join(lib_name);
}
if (!da->file_exists(lib_path)) {
lib_path = oidn_lib_path.path_join("..").path_join("lib").path_join(lib_name);
}

_unload_oidn();

if (OS::get_singleton()->open_dynamic_library(lib_path, oidn_lib_handle, true) != OK) {
oidn_lib_handle = nullptr;
ERR_PRINT(vformat("Failed to load %s.", lib_path));
return false;
}
bool symbols_ok = true;
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnNewDevice", (void *&)oidnNewDevice) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnCommitDevice", (void *&)oidnCommitDevice) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnNewFilter", (void *&)oidnNewFilter) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnSetSharedFilterImage", (void *&)oidnSetSharedFilterImage) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnSetFilterBool", (void *&)oidnSetFilterBool) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnCommitFilter", (void *&)oidnCommitFilter) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnExecuteFilter", (void *&)oidnExecuteFilter) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnGetDeviceError", (void *&)oidnGetDeviceError) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnReleaseFilter", (void *&)oidnReleaseFilter) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnReleaseDevice", (void *&)oidnReleaseDevice) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnNewBuffer", (void *&)oidnNewBuffer) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnGetBufferData", (void *&)oidnGetBufferData) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnReadBuffer", (void *&)oidnReadBuffer) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnWriteBuffer", (void *&)oidnWriteBuffer) == OK);
symbols_ok = symbols_ok && (OS::get_singleton()->get_dynamic_library_symbol_handle(oidn_lib_handle, "oidnReleaseBuffer", (void *&)oidnReleaseBuffer) == OK);
if (!symbols_ok) {
ERR_PRINT("Failed to load OIDN symbols.");
_unload_oidn();
return false;
}

oidn_device = oidnNewDevice(OIDN_DEVICE_TYPE_DEFAULT);
oidnCommitDevice(oidn_device);
const char *msg = nullptr;
if (oidnGetDeviceError(oidn_device, &msg) != OIDN_ERROR_NONE) {
ERR_PRINT(vformat("Failed to load OIDN device: %s", msg));
_unload_oidn();
return false;
}

return true;
}

Ref<Image> LightmapperRD::_read_pfm(const String &p_name) {
Error err = OK;
Ref<FileAccess> file = FileAccess::open(p_name, FileAccess::READ, &err);
ERR_FAIL_COND_V_MSG(err, Ref<Image>(), vformat("Can't load PFM at path: '%s'.", p_name));
ERR_FAIL_COND_V(file->get_line() != "PF", Ref<Image>());

Vector<String> new_size = file->get_line().split(" ");
ERR_FAIL_COND_V(new_size.size() != 2, Ref<Image>());
int new_width = new_size[0].to_int();
int new_height = new_size[1].to_int();

float endian = file->get_line().to_float();
Vector<uint8_t> new_data = file->get_buffer(file->get_length() - file->get_position());
file->close();

#ifdef BIG_ENDIAN_ENABLED
if (unlikely(endian < 0.0)) {
uint32_t count = new_data.size() / 4;
uint16_t *dst = (uint16_t *)new_data.ptrw();
for (uint32_t j = 0; j < count; j++) {
dst[j * 4] = BSWAP32(dst[j * 4]);
}
}
#else
if (unlikely(endian > 0.0)) {
uint32_t count = new_data.size() / 4;
uint16_t *dst = (uint16_t *)new_data.ptrw();
for (uint32_t j = 0; j < count; j++) {
dst[j * 4] = BSWAP32(dst[j * 4]);
void LightmapperRD::_unload_oidn() {
if (oidn_lib_handle) {
if (oidn_device) {
oidnReleaseDevice(oidn_device);
oidn_device = nullptr;
}

OS::get_singleton()->close_dynamic_library(oidn_lib_handle);
oidn_lib_handle = nullptr;
}
#endif
Ref<Image> img = Image::create_from_data(new_width, new_height, false, Image::FORMAT_RGBF, new_data);
img->convert(Image::FORMAT_RGBAH);
return img;
}

LightmapperRD::BakeError LightmapperRD::_denoise_oidn(RenderingDevice *p_rd, RID p_source_light_tex, RID p_source_normal_tex, RID p_dest_light_tex, const Size2i &p_atlas_size, int p_atlas_slices, bool p_bake_sh, const String &p_exe) {
Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);

LightmapperRD::BakeError LightmapperRD::_denoise_oidn(RenderingDevice *p_rd, RID p_source_light_tex, RID p_source_normal_tex, RID p_dest_light_tex, const Size2i &p_atlas_size, int p_atlas_slices, bool p_bake_sh) {
for (int i = 0; i < p_atlas_slices; i++) {
String fname_norm_in = EditorPaths::get_singleton()->get_cache_dir().path_join(vformat("temp_norm_%d.pfm", i));
_store_pfm(p_rd, p_source_normal_tex, i, p_atlas_size, fname_norm_in);
Vector<uint8_t> sn = p_rd->texture_get_data(p_source_normal_tex, i);

Ref<Image> imgn = Image::create_from_data(p_atlas_size.width, p_atlas_size.height, false, Image::FORMAT_RGBAH, sn);
imgn->convert(Image::FORMAT_RGBF);
Vector<uint8_t> datan = imgn->get_data();
void *bufn = oidnNewBuffer(oidn_device, datan.size());
oidnWriteBuffer(bufn, 0, datan.size(), (void *)datan.ptrw());

for (int j = 0; j < (p_bake_sh ? 4 : 1); j++) {
int index = i * (p_bake_sh ? 4 : 1) + j;
String fname_light_in = EditorPaths::get_singleton()->get_cache_dir().path_join(vformat("temp_light_%d.pfm", index));
String fname_out = EditorPaths::get_singleton()->get_cache_dir().path_join(vformat("temp_denoised_%d.pfm", index));

_store_pfm(p_rd, p_source_light_tex, index, p_atlas_size, fname_light_in);

List<String> args;
args.push_back("--device");
args.push_back("default");

args.push_back("--filter");
args.push_back("RTLightmap");

args.push_back("--hdr");
args.push_back(fname_light_in);
Vector<uint8_t> sl = p_rd->texture_get_data(p_source_light_tex, index);

args.push_back("--nrm");
args.push_back(fname_norm_in);
Ref<Image> imgl = Image::create_from_data(p_atlas_size.width, p_atlas_size.height, false, Image::FORMAT_RGBAH, sl);
imgl->convert(Image::FORMAT_RGBF);
Vector<uint8_t> datal = imgl->get_data();

args.push_back("--output");
args.push_back(fname_out);
void *bufl = oidnNewBuffer(oidn_device, datal.size());
oidnWriteBuffer(bufl, 0, datal.size(), (void *)datal.ptrw());

String str;
int exitcode = 0;
void *filter = oidnNewFilter(oidn_device, "RTLightmap");
oidnSetSharedFilterImage(filter, "color", oidnGetBufferData(bufl), OIDN_FORMAT_FLOAT3, imgl->get_width(), imgl->get_height(), 0, 0, 0);
oidnSetSharedFilterImage(filter, "normal", oidnGetBufferData(bufn), OIDN_FORMAT_FLOAT3, imgn->get_width(), imgn->get_height(), 0, 0, 0);
oidnSetSharedFilterImage(filter, "output", oidnGetBufferData(bufl), OIDN_FORMAT_FLOAT3, imgl->get_width(), imgl->get_height(), 0, 0, 0);
oidnSetFilterBool(filter, "hdr", true);
oidnCommitFilter(filter);
oidnExecuteFilter(filter);

Error err = OS::get_singleton()->execute(p_exe, args, &str, &exitcode, true);

da->remove(fname_light_in);

if (err != OK || exitcode != 0) {
da->remove(fname_out);
print_verbose(str);
ERR_FAIL_V_MSG(BAKE_ERROR_LIGHTMAP_CANT_PRE_BAKE_MESHES, vformat("OIDN denoiser failed, return code: %d", exitcode));
const char *msg = nullptr;
if (oidnGetDeviceError(oidn_device, &msg) != OIDN_ERROR_NONE) {
oidnReleaseFilter(filter);
ERR_FAIL_V_MSG(BAKE_ERROR_LIGHTMAP_CANT_PRE_BAKE_MESHES, String(msg));
}

Ref<Image> img = _read_pfm(fname_out);
da->remove(fname_out);

ERR_FAIL_COND_V(img.is_null(), BAKE_ERROR_LIGHTMAP_CANT_PRE_BAKE_MESHES);

Vector<uint8_t> old_data = p_rd->texture_get_data(p_source_light_tex, index);
Vector<uint8_t> new_data = img->get_data();
img.unref(); // Avoid copy on write.

uint32_t count = old_data.size() / 2;
const uint16_t *src = (const uint16_t *)old_data.ptr();
uint16_t *dst = (uint16_t *)new_data.ptrw();
for (uint32_t k = 0; k < count; k += 4) {
dst[k + 3] = src[k + 3];
oidnReleaseFilter(filter);

oidnReadBuffer(bufl, 0, datal.size(), (void *)datal.ptrw());
oidnReleaseBuffer(bufl);

imgl->set_data(imgl->get_width(), imgl->get_height(), false, imgl->get_format(), datal);
imgl->convert(Image::FORMAT_RGBAH);
Vector<uint8_t> ds = imgl->get_data();
imgl.unref(); // Avoid copy on write.
{ // Restore alpha.
uint32_t count = sl.size() / 2;
const uint16_t *src = (const uint16_t *)sl.ptr();
uint16_t *dst = (uint16_t *)ds.ptrw();
for (uint32_t k = 0; k < count; k += 4) {
dst[k + 3] = src[k + 3];
}
}

p_rd->texture_update(p_dest_light_tex, index, new_data);
p_rd->texture_update(p_dest_light_tex, index, ds);
}
da->remove(fname_norm_in);
oidnReleaseBuffer(bufn);
}
return BAKE_OK;
}
Expand Down Expand Up @@ -980,15 +990,7 @@ LightmapperRD::BakeError LightmapperRD::bake(BakeQuality p_quality, bool p_use_d
if (p_use_denoiser && denoiser == 1) {
// OIDN (external).
Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);

if (da->dir_exists(oidn_path)) {
if (OS::get_singleton()->get_name() == "Windows") {
oidn_path = oidn_path.path_join("oidnDenoise.exe");
} else {
oidn_path = oidn_path.path_join("oidnDenoise");
}
}
ERR_FAIL_COND_V_MSG(oidn_path.is_empty() || !da->file_exists(oidn_path), BAKE_ERROR_LIGHTMAP_CANT_PRE_BAKE_MESHES, "OIDN denoiser is selected in the project settings, but no or invalid OIDN executable path is configured in the editor settings.");
ERR_FAIL_COND_V_MSG(oidn_path.is_empty() || !_load_oidn(oidn_path), BAKE_ERROR_LIGHTMAP_CANT_PRE_BAKE_MESHES, "OIDN denoiser is selected in the project settings, but no or invalid OIDN library path is configured in the editor settings.");
}

if (p_step_function) {
Expand Down Expand Up @@ -1749,7 +1751,7 @@ LightmapperRD::BakeError LightmapperRD::bake(BakeQuality p_quality, bool p_use_d
BakeError error;
if (denoiser == 1) {
// OIDN (external).
error = _denoise_oidn(rd, light_accum_tex, normal_tex, light_accum_tex, atlas_size, atlas_slices, p_bake_sh, oidn_path);
error = _denoise_oidn(rd, light_accum_tex, normal_tex, light_accum_tex, atlas_size, atlas_slices, p_bake_sh);
} else {
// JNLM (built-in).
SWAP(light_accum_tex, light_accum_tex2);
Expand Down Expand Up @@ -2018,3 +2020,7 @@ Vector<Color> LightmapperRD::get_bake_probe_sh(int p_probe) const {

LightmapperRD::LightmapperRD() {
}

LightmapperRD::~LightmapperRD() {
_unload_oidn();
}
78 changes: 75 additions & 3 deletions modules/lightmapper_rd/lightmapper_rd.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,80 @@
#include "scene/resources/mesh.h"
#include "servers/rendering/rendering_device.h"

typedef enum {
OIDN_DEVICE_TYPE_DEFAULT = 0, // select device automatically

OIDN_DEVICE_TYPE_CPU = 1, // CPU device
OIDN_DEVICE_TYPE_SYCL = 2, // SYCL device
OIDN_DEVICE_TYPE_CUDA = 3, // CUDA device
OIDN_DEVICE_TYPE_HIP = 4, // HIP device
} OIDNDeviceType;

typedef enum {
OIDN_FORMAT_UNDEFINED = 0,

// 32-bit single-precision floating-point scalar and vector formats
OIDN_FORMAT_FLOAT = 1,
OIDN_FORMAT_FLOAT2,
OIDN_FORMAT_FLOAT3,
OIDN_FORMAT_FLOAT4,

// 16-bit half-precision floating-point scalar and vector formats
OIDN_FORMAT_HALF = 257,
OIDN_FORMAT_HALF2,
OIDN_FORMAT_HALF3,
OIDN_FORMAT_HALF4,
} OIDNFormat;

typedef enum {
OIDN_ERROR_NONE = 0, // no error occurred
OIDN_ERROR_UNKNOWN = 1, // an unknown error occurred
OIDN_ERROR_INVALID_ARGUMENT = 2, // an invalid argument was specified
OIDN_ERROR_INVALID_OPERATION = 3, // the operation is not allowed
OIDN_ERROR_OUT_OF_MEMORY = 4, // not enough memory to execute the operation
OIDN_ERROR_UNSUPPORTED_HARDWARE = 5, // the hardware (e.g. CPU) is not supported
OIDN_ERROR_CANCELLED = 6, // the operation was cancelled by the user
} OIDNError;

typedef void *(*oidnNewDevicePtr)(OIDNDeviceType type);
typedef void (*oidnCommitDevicePtr)(void *device);
typedef void *(*oidnNewFilterPtr)(void *device, const char *type);
typedef void (*oidnSetSharedFilterImagePtr)(void *filter, const char *name, void *devPtr, OIDNFormat format, size_t width, size_t height, size_t byteOffset, size_t pixelByteStride, size_t rowByteStride);
typedef void (*oidnSetFilterBoolPtr)(void *filter, const char *name, bool value);
typedef void (*oidnCommitFilterPtr)(void *filter);
typedef void (*oidnExecuteFilterPtr)(void *filter);
typedef OIDNError (*oidnGetDeviceErrorPtr)(void *device, const char **outMessage);
typedef void (*oidnReleaseFilterPtr)(void *filter);
typedef void (*oidnReleaseDevicePtr)(void *device);
typedef void *(*oidnNewBufferPtr)(void *device, size_t byteSize);
typedef void *(*oidnGetBufferDataPtr)(void *buffer);
typedef void (*oidnReadBufferPtr)(void *buffer, size_t byteOffset, size_t byteSize, void *dstHostPtr);
typedef void (*oidnWriteBufferPtr)(void *buffer, size_t byteOffset, size_t byteSize, const void *srcHostPtr);
typedef void (*oidnReleaseBufferPtr)(void *buffer);

class RDShaderFile;
class LightmapperRD : public Lightmapper {
GDCLASS(LightmapperRD, Lightmapper)

String oidn_lib_path;
void *oidn_lib_handle = nullptr;
void *oidn_device = nullptr;
oidnNewDevicePtr oidnNewDevice = nullptr;
oidnCommitDevicePtr oidnCommitDevice = nullptr;
oidnNewFilterPtr oidnNewFilter = nullptr;
oidnSetSharedFilterImagePtr oidnSetSharedFilterImage = nullptr;
oidnSetFilterBoolPtr oidnSetFilterBool = nullptr;
oidnCommitFilterPtr oidnCommitFilter = nullptr;
oidnExecuteFilterPtr oidnExecuteFilter = nullptr;
oidnGetDeviceErrorPtr oidnGetDeviceError = nullptr;
oidnReleaseFilterPtr oidnReleaseFilter = nullptr;
oidnReleaseDevicePtr oidnReleaseDevice = nullptr;
oidnNewBufferPtr oidnNewBuffer = nullptr;
oidnGetBufferDataPtr oidnGetBufferData = nullptr;
oidnReadBufferPtr oidnReadBuffer = nullptr;
oidnWriteBufferPtr oidnWriteBuffer = nullptr;
oidnReleaseBufferPtr oidnReleaseBuffer = nullptr;

struct BakeParameters {
float world_size[3] = {};
float bias = 0.0;
Expand Down Expand Up @@ -273,9 +343,10 @@ class LightmapperRD : public Lightmapper {
BakeError _dilate(RenderingDevice *rd, Ref<RDShaderFile> &compute_shader, RID &compute_base_uniform_set, PushConstant &push_constant, RID &source_light_tex, RID &dest_light_tex, const Size2i &atlas_size, int atlas_slices);
BakeError _denoise(RenderingDevice *p_rd, Ref<RDShaderFile> &p_compute_shader, const RID &p_compute_base_uniform_set, PushConstant &p_push_constant, RID p_source_light_tex, RID p_source_normal_tex, RID p_dest_light_tex, float p_denoiser_strength, const Size2i &p_atlas_size, int p_atlas_slices, bool p_bake_sh, BakeStepFunc p_step_function);

Error _store_pfm(RenderingDevice *p_rd, RID p_atlas_tex, int p_index, const Size2i &p_atlas_size, const String &p_name);
Ref<Image> _read_pfm(const String &p_name);
BakeError _denoise_oidn(RenderingDevice *p_rd, RID p_source_light_tex, RID p_source_normal_tex, RID p_dest_light_tex, const Size2i &p_atlas_size, int p_atlas_slices, bool p_bake_sh, const String &p_exe);
bool _load_oidn(const String &p_library_path);
void _unload_oidn();

BakeError _denoise_oidn(RenderingDevice *p_rd, RID p_source_light_tex, RID p_source_normal_tex, RID p_dest_light_tex, const Size2i &p_atlas_size, int p_atlas_slices, bool p_bake_sh);

public:
virtual void add_mesh(const MeshData &p_mesh) override;
Expand All @@ -296,6 +367,7 @@ class LightmapperRD : public Lightmapper {
Vector<Color> get_bake_probe_sh(int p_probe) const override;

LightmapperRD();
~LightmapperRD();
};

#endif // LIGHTMAPPER_RD_H