Blender V5.3
image_vdb.cpp
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011-2022 Blender Foundation
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#include "scene/image_vdb.h"
6
8#include "util/log.h"
9#include "util/nanovdb.h"
10#include "util/openvdb.h"
11#include "util/types_image.h"
12
13#ifdef WITH_OPENVDB
14# include <openvdb/tools/Dense.h>
15#endif
16
18
19#ifdef WITH_OPENVDB
20VDBImageLoader::VDBImageLoader(openvdb::GridBase::ConstPtr grid_,
21 const string &grid_name,
22 const float clipping)
23 : grid_name(grid_name), clipping(clipping), grid(grid_)
24{
25}
26#endif
27
32
34
36 const ImageLoaderParams & /*params*/,
37 Progress & /*progress*/)
38{
39#ifdef WITH_NANOVDB
40 load_grid();
41
42 if (!grid) {
43 return false;
44 }
45
46 /* Convert to the few float types that we know. */
47 grid = openvdb_convert_to_known_type(grid);
48 if (!grid) {
49 return false;
50 }
51
52 /* Get number of channels from type. */
53 metadata.channels = openvdb_num_channels(grid);
54
55 /* Convert OpenVDB to NanoVDB grid. */
56 nanogrid = openvdb_to_nanovdb(grid, precision, clipping);
57 if (!nanogrid) {
58 grid.reset();
59 return false;
60 }
61
62 /* Set dimensions. */
63 bbox = grid->evalActiveVoxelBoundingBox();
64 if (bbox.empty()) {
66 metadata.nanovdb_byte_size = 1;
67 grid.reset();
68 return true;
69 }
70
71 if (metadata.channels == 1) {
72 if (precision == 0) {
74 }
75 else if (precision == 16) {
77 }
78 else {
80 }
81 }
82 else if (metadata.channels == 3) {
84 }
85 else if (metadata.channels == 4) {
87 }
88 else {
89 grid.reset();
90 return false;
91 }
92
93# if NANOVDB_MAJOR_VERSION_NUMBER > 32 || \
94 (NANOVDB_MAJOR_VERSION_NUMBER == 32 && NANOVDB_MINOR_VERSION_NUMBER >= 9)
95 /* size() was deprecated in this version. */
96 metadata.nanovdb_byte_size = nanogrid.bufferSize();
97# else
98 metadata.nanovdb_byte_size = nanogrid.size();
99# endif
100
101 /* Set transform from object space to voxel index. */
102 openvdb::math::Mat4f grid_matrix = grid->transform().baseMap()->getAffineMap()->getMat4();
103 Transform index_to_object;
104 for (int col = 0; col < 4; col++) {
105 for (int row = 0; row < 3; row++) {
106 index_to_object[row][col] = (float)grid_matrix[col][row];
107 }
108 }
109
110 metadata.transform_3d = transform_inverse(index_to_object);
111 metadata.use_transform_3d = true;
112
113 /* Only NanoGrid needed now, free OpenVDB grid. */
114 grid.reset();
115
116 return true;
117#else
118 (void)metadata;
119 return false;
120#endif
121}
122
123bool VDBImageLoader::load_pixels(const ImageMetaData &metadata, void *pixels)
124{
125#ifdef WITH_NANOVDB
126 if (metadata.type == IMAGE_DATA_TYPE_NANOVDB_EMPTY) {
127 memset(pixels, 0, metadata.nanovdb_byte_size);
128 return true;
129 }
130 if (nanogrid) {
131 memcpy(pixels, nanogrid.data(), metadata.nanovdb_byte_size);
132 return true;
133 }
134#else
135 (void)metadata;
136 (void)pixels;
137#endif
138
139 return false;
140}
141
143{
144 return grid_name;
145}
146
147bool VDBImageLoader::equals(const ImageLoader &other) const
148{
149#ifdef WITH_OPENVDB
150 const VDBImageLoader &other_loader = (const VDBImageLoader &)other;
151 return grid && grid == other_loader.grid;
152#else
153 (void)other;
154 return true;
155#endif
156}
157
159{
160#ifdef WITH_OPENVDB
161 /* Free OpenVDB grid memory as soon as we can. */
162 grid.reset();
163#endif
164#ifdef WITH_NANOVDB
165 nanogrid.reset();
166#endif
167}
168
170{
171 return true;
172}
173
174#ifdef WITH_OPENVDB
175openvdb::GridBase::ConstPtr VDBImageLoader::get_grid()
176{
177 return grid;
178}
179
180template<typename GridType>
181openvdb::GridBase::ConstPtr create_grid(const float *voxels,
182 const size_t width,
183 const size_t height,
184 const size_t depth,
185 Transform transform_3d,
186 const float clipping)
187{
188 using ValueType = typename GridType::ValueType;
189 openvdb::GridBase::ConstPtr grid;
190
191 const openvdb::CoordBBox dense_bbox(0, 0, 0, width - 1, height - 1, depth - 1);
192
193 typename GridType::Ptr sparse = GridType::create(ValueType(0.0f));
194 if (dense_bbox.empty()) {
195 return sparse;
196 }
197
198 const openvdb::tools::Dense<const ValueType, openvdb::tools::MemoryLayout::LayoutXYZ> dense(
199 dense_bbox, reinterpret_cast<const ValueType *>(voxels));
200
201 openvdb::tools::copyFromDense(dense, *sparse, ValueType(clipping));
202
203 /* Compute index to world matrix. */
204 const float3 voxel_size = make_float3(1.0f / width, 1.0f / height, 1.0f / depth);
205
206 transform_3d = transform_inverse(transform_3d);
207
208 const openvdb::Mat4R index_to_world_mat((double)(voxel_size.x * transform_3d[0][0]),
209 0.0,
210 0.0,
211 0.0,
212 0.0,
213 (double)(voxel_size.y * transform_3d[1][1]),
214 0.0,
215 0.0,
216 0.0,
217 0.0,
218 (double)(voxel_size.z * transform_3d[2][2]),
219 0.0,
220 (double)transform_3d[0][3],
221 (double)transform_3d[1][3],
222 (double)transform_3d[2][3],
223 1.0);
224
225 const openvdb::math::Transform::Ptr index_to_world_tfm =
226 openvdb::math::Transform::createLinearTransform(index_to_world_mat);
227
228 sparse->setTransform(index_to_world_tfm);
229
230 return sparse;
231}
232#endif
233
235 const size_t height,
236 const size_t depth,
237 const int channels,
238 const float *voxels,
239 Transform transform_3d)
240{
241#ifdef WITH_OPENVDB
242 /* TODO: Create NanoVDB grid directly? */
243 if (channels == 1) {
244 grid = create_grid<openvdb::FloatGrid>(voxels, width, height, depth, transform_3d, clipping);
245 }
246 else if (channels == 3) {
247 grid = create_grid<openvdb::Vec3fGrid>(voxels, width, height, depth, transform_3d, clipping);
248 }
249 else if (channels == 4) {
250 grid = create_grid<openvdb::Vec4fGrid>(voxels, width, height, depth, transform_3d, clipping);
251 }
252
253 /* Clipping already applied, no need to do it again. */
254 clipping = 0.0f;
255#else
256 (void)width;
257 (void)height;
258 (void)depth;
259 (void)channels;
260 (void)voxels;
261 (void)transform_3d;
262#endif
263}
264
ImageDataType type
Transform transform_3d
int64_t nanovdb_byte_size
bool load_pixels(const ImageMetaData &metadata, void *pixels) override
bool equals(const ImageLoader &other) const override
string grid_name
Definition image_vdb.h:64
~VDBImageLoader() override
void cleanup() override
void grid_from_dense_voxels(const size_t width, const size_t height, const size_t depth, const int channels, const float *voxels, Transform transform_3d)
bool is_vdb_loader() const override
VDBImageLoader(const string &grid_name, const float clipping=0.001f)
Definition image_vdb.cpp:28
bool load_metadata(ImageMetaData &metadata, const ImageLoaderParams &params, Progress &progress) override
Definition image_vdb.cpp:35
virtual void load_grid()
Definition image_vdb.h:55
string name() const override
#define CCL_NAMESPACE_END
ccl_device_forceinline float3 make_float3(const float x, const float y, const float z)
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
float z
Definition sky_math.h:136
float y
Definition sky_math.h:136
float x
Definition sky_math.h:136
ccl_device_inline Transform transform_inverse(const Transform tfm)
Definition transform.h:563
@ IMAGE_DATA_TYPE_NANOVDB_FP16
Definition types_image.h:48
@ IMAGE_DATA_TYPE_NANOVDB_EMPTY
Definition types_image.h:49
@ IMAGE_DATA_TYPE_NANOVDB_FLOAT
Definition types_image.h:44
@ IMAGE_DATA_TYPE_NANOVDB_FLOAT3
Definition types_image.h:45
@ IMAGE_DATA_TYPE_NANOVDB_FLOAT4
Definition types_image.h:46
@ IMAGE_DATA_TYPE_NANOVDB_FPN
Definition types_image.h:47