Skip to content

chunky-dev/chunky-denoiser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Denoising Plugin

Note: This README is for an development version of the plugin that is not yet released. Click here for the README for the current version of the plugin, which is 0.4.0.

This is a plugin for Chunky that creates Portable Float Map files (.pfm) for use with denoisers, e.g. Intel Open Image Denoise.

Please use version 0.3.2 for Chunky 1.x and the latest version for Chunky 2.4.0 or later.

Installation

Download the latest plugin release for your Chunky version from the releases page. In the Chunky Launcher, click on Manage plugins and then on Add and select the .jar file you just downloaded. Click on Save to store the updated configuration, then start Chunky as usual.

Download the Intel Open Image Denoiser here. After unpacking the archive in a safe location, you can configure the denoiser executable (denoiser.exe on Windows, denoiser on Linux) in the Denoiser tab inside Chunky.

Usage

Select the DenoisedPathTracer in the Advanced tab:

image

Then render the scene as usual. It will automatically render all passes and denoise the final image.

Denoising an Existing Render

Existing renders can be denoised by clicking on the Denoise Current Render button in the Denoiser tab:

image

WARNING: this will overwrite your existing render.

It will automatically render all passes and denoise the final image.

Denoising Outside Chunky

By checking Save albedo map and Save normal map, the denoised renderers will automatically save the albedo and normal maps as .pfm files inside the scene directory.

image

These files can be used by Intel Open Image Denoise like this:

./denoise -ldr scene-name.pfm -alb scene-name.albedo.pfm -nrm scene-name.normal.pfm -o output.pfm

Development

It is recommended to use IntelliJ. Install the Java17 JDK (Temurin is the recommended distribution). Then, clone the Chunky repository and let IntelliJ index the project. Navigate to src/main/java/de/lemaik/chunky/denoiser/DenoiserPlugin and click the green play button next to public class DenoiserPlugin implements Plugin { to build and run the denoiser plugin.

To build the plugin externally, run the gradlew script in the project root directory. Gradle is setup with a few main tasks:

  • gradlew pluginJar - Build the denoiser plugin Jar
  • gradlew clean - Cleans the project. Removes old builds.

License

Copyright 2019-2021 Maik Marschner (leMaik)

Permission to modify and redistribute is granted under the terms of the GNU General Public License, Version 3. See the LICENSE file for the full license.