Blender V5.3
denoised_auxiliary_pass.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2025 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#ifdef WITH_OPENIMAGEDENOISE
6
7# include <cstdint>
8# include <memory>
9
10# include "BLI_assert.hh"
11# include "BLI_hash.hh"
12
13# include "COM_context.hh"
15# include "COM_result.hh"
16# include "COM_utilities.hh"
17# include "COM_utilities_oidn.hh"
18
19# include <OpenImageDenoise/oidn.hpp>
20
21namespace blender::compositor {
22
23/* ------------------------------------------------------------------------------------------------
24 * Denoised Auxiliary Pass Key.
25 */
26
27DenoisedAuxiliaryPassKey::DenoisedAuxiliaryPassKey(const DenoisedAuxiliaryPassType type,
28 const oidn::Quality quality)
29 : type(type), quality(quality)
30{
31}
32
33uint64_t DenoisedAuxiliaryPassKey::hash() const
34{
35 return get_default_hash(this->type, this->quality);
36}
37
38bool operator==(const DenoisedAuxiliaryPassKey &a, const DenoisedAuxiliaryPassKey &b)
39{
40 return a.type == b.type && a.quality == b.quality;
41}
42
43/* --------------------------------------------------------------------
44 * Denoised Auxiliary Pass.
45 */
46
47/* A callback to cancel the filter operations by evaluating the context's is_canceled method. The
48 * API specifies that true indicates the filter should continue, while false indicates it should
49 * stop, so invert the condition. This callback can also be used to track progress using the given
50 * n argument, but we currently don't make use of it. See OIDNProgressMonitorFunction in the API
51 * for more information. */
52static bool oidn_progress_monitor_function(void *user_ptr, double /*n*/)
53{
54 const Context *context = static_cast<const Context *>(user_ptr);
55 return !context->is_canceled();
56}
57
58static const char *get_pass_name(const DenoisedAuxiliaryPassType type)
59{
60 switch (type) {
61 case DenoisedAuxiliaryPassType::Albedo:
62 return "albedo";
63 case DenoisedAuxiliaryPassType::Normal:
64 return "normal";
65 }
66
68 return "";
69}
70
71DenoisedAuxiliaryPass::DenoisedAuxiliaryPass(Context &context,
72 const Result &pass,
73 const DenoisedAuxiliaryPassType type,
74 const oidn::Quality quality)
75 : result(context.create_result(pass.type()))
76{
77 Result denoise_input = context.create_result(pass.type());
78 Result *denoise_output = nullptr;
79 bool is_denoising_in_place = false;
80 if (context.use_gpu()) {
81 Result input_pass_cpu = pass.download_to_cpu();
82 denoise_input.share_data(input_pass_cpu);
83 input_pass_cpu.release();
84
85 denoise_output = &denoise_input;
86 is_denoising_in_place = true;
87 }
88 else {
89 denoise_input.share_data(pass);
90
91 this->result.allocate_texture(pass.domain());
92 denoise_output = &this->result;
93 }
94
95 oidn::DeviceRef device = create_oidn_device(context);
96 device.commit();
97
98 oidn::BufferRef input_buffer = create_oidn_buffer(device, denoise_input);
99 oidn::BufferRef output_buffer = create_oidn_buffer(device, *denoise_output);
100
101 oidn::FilterRef filter = device.newFilter("RT");
102 const char *pass_name = get_pass_name(type);
103 const int2 size = pass.domain().data_size;
104 const int pixel_stride = sizeof(float) * denoise_input.channels_count();
105 filter.setImage(pass_name, input_buffer, oidn::Format::Float3, size.x, size.y, 0, pixel_stride);
106 filter.setImage("output", output_buffer, oidn::Format::Float3, size.x, size.y, 0, pixel_stride);
107 filter.set("quality", quality);
108 filter.setProgressMonitorFunction(oidn_progress_monitor_function, &context);
109 filter.commit();
110 filter.execute();
111
112 if (output_buffer.getStorage() != oidn::Storage::Host) {
113 output_buffer.read(
114 0, denoise_output->size_in_bytes(), denoise_output->cpu_data_for_write().data());
115 }
116
117 if (is_denoising_in_place) {
118 this->result.share_data(denoise_input);
119 }
120 denoise_input.release();
121}
122
123DenoisedAuxiliaryPass::~DenoisedAuxiliaryPass()
124{
125 this->result.release();
126}
127
128/* --------------------------------------------------------------------
129 * Denoised Auxiliary Pass Container.
130 */
131
132DenoisedAuxiliaryPass &DenoisedAuxiliaryPassContainer::get(Context &context,
133 const Result &pass,
134 const DenoisedAuxiliaryPassType type,
135 const oidn::Quality quality)
136{
137 const DenoisedAuxiliaryPassKey key(type, quality);
138
139 return *map_.lookup_or_add_cb(key, [&]() {
140 return std::make_unique<DenoisedAuxiliaryPass>(context, pass, type, quality);
141 });
142}
143
144} // namespace blender::compositor
145
146#endif
#define BLI_assert_unreachable()
unsigned long long int uint64_t
static DBVT_INLINE btScalar size(const btDbvtVolume &a)
Definition btDbvt.cpp:52
if(state< num_states)
ccl_device_inline bool operator==(const float2 a, const float2 b)
int context(const bContext *C, const char *member, bContextDataResult *result)
DO_INLINE void filter(lfVector *V, fmatrix3x3 *S)
constexpr uint64_t get_default_hash(const T &v, const Args &...args)
Definition BLI_hash.hh:252
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float