15#ifndef NANOVDB_GRID_HANDLE_H_HAS_BEEN_INCLUDED
16#define NANOVDB_GRID_HANDLE_H_HAS_BEEN_INCLUDED
21#include <initializer_list>
25#include <nanovdb/tools/GridChecksum.h>
36template<
typename BufferT = HostBuffer>
39 std::vector<GridHandleMetaData> mMetaData;
43 static T* no_const(
const T* ptr) {
return const_cast<T*
>(ptr); }
52 template<typename T = BufferT, typename util::enable_if<BufferTraits<T>::hasDeviceDual,
int>::type = 0>
58 template<typename T = BufferT, typename util::disable_if<BufferTraits<T>::hasDeviceDual,
int>::type = 0>
69 mBuffer = std::move(other.mBuffer);
70 mMetaData = std::move(other.mMetaData);
84 mBuffer = std::move(other.mBuffer);
85 mMetaData = std::move(other.mMetaData);
93 template <
typename OtherBufferT = HostBuffer>
97 BufferT&
buffer() {
return mBuffer; }
100 const BufferT&
buffer()
const {
return mBuffer; }
104 void*
data() {
return mBuffer.data(); }
108 const void*
data()
const {
return mBuffer.data(); }
110 template<
typename U = BufferT>
113 template<
typename U = BufferT>
115 deviceData(
int device)
const {
return mBuffer.deviceData(device); }
116 template<
typename U = BufferT>
119 template<
typename U = BufferT>
121 deviceData(
int device) {
return mBuffer.deviceData(device); }
125 [[deprecated(
"Use GridHandle::bufferSize instead.")]] uint64_t
size()
const {
return mBuffer.size(); }
131 bool empty()
const {
return mBuffer.size() == 0; }
132 bool isEmpty()
const {
return mBuffer.size() == 0; }
136 operator bool()
const {
return !this->
empty(); }
143 template<
typename ValueT>
151 template<
typename ValueT>
159 template<
typename ValueT,
typename U = BufferT>
169 template<
typename ValueT,
typename U = BufferT>
175 template<
typename U = BufferT>
177 deviceUpload(
void* stream,
bool sync =
true) { mBuffer.deviceUpload(stream, sync); }
183 template<
typename U = BufferT>
185 deviceUpload(
int device = 0,
void* stream =
nullptr,
bool sync =
true) { mBuffer.deviceUpload(device, stream, sync); }
189 template<
typename U = BufferT>
191 deviceDownload(
void* stream,
bool sync =
true) { mBuffer.deviceDownload(stream, sync); }
193 template<
typename U = BufferT>
195 deviceDownload(
int device = 0,
void* stream =
nullptr,
bool sync =
true) { mBuffer.deviceDownload(device, stream, sync); }
199 bool isPadded()
const {
return mMetaData.empty() ? false : mMetaData.back().offset + mMetaData.back().size != mBuffer.size();}
202 uint32_t
gridCount()
const {
return static_cast<uint32_t
>(mMetaData.size());}
207 uint64_t
gridSize(uint32_t n = 0)
const {
return mMetaData[n].size; }
213 for (
auto &m : mMetaData) sum += m.size;
244 void write(std::ostream& os, uint32_t n)
const {
246 os.write((
const char*)
data,
data->mGridSize);
248 throw std::runtime_error(
"GridHandle does not contain a #" + std::to_string(n) +
" grid");
254 void write(std::ostream& os)
const {
260 void write(
const std::string &fileName)
const {
261 std::ofstream os(fileName, std::ios::out | std::ios::binary | std::ios::trunc);
262 if (!os.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for output");
269 void write(
const std::string &fileName, uint32_t n)
const {
270 std::ofstream os(fileName, std::ios::out | std::ios::binary | std::ios::trunc);
271 if (!os.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for output");
279 void read(std::istream& is,
const BufferT& pool = BufferT());
286 void read(std::istream& is, uint32_t n,
const BufferT& pool = BufferT());
293 void read(std::istream& is,
const std::string &gridName,
const BufferT& pool = BufferT());
298 void read(
const std::string &fileName,
const BufferT& pool = BufferT()) {
299 std::ifstream is(fileName, std::ios::in | std::ios::binary);
300 if (!is.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for input");
301 this->
read(is, pool);
310 void read(
const std::string &fileName, uint32_t n,
const BufferT& pool = BufferT()) {
311 std::ifstream is(fileName, std::ios::in | std::ios::binary);
312 if (!is.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for input");
313 this->
read(is, n, pool);
322 void read(
const std::string &fileName,
const std::string &gridName,
const BufferT& pool = BufferT()) {
323 std::ifstream is(fileName, std::ios::in | std::ios::binary);
324 if (!is.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for input");
325 this->
read(is, gridName, pool);
331template<
typename BufferT>
334 const void *
data = this->data();
335 if (
data ==
nullptr || n >= mMetaData.size())
return nullptr;
339template<
typename BufferT>
343 if (
data ==
nullptr || n >= mMetaData.size())
return nullptr;
350 for (
auto *p=meta, *q=p+data->
mGridCount; p!=q; ++p) {
358template<
typename BufferT>
359template<typename T, typename util::disable_if<BufferTraits<T>::hasDeviceDual,
int>::type>
363 mBuffer = std::move(
buffer);
364 if (
auto *
data =
reinterpret_cast<const GridData*
>(mBuffer.data())) {
365 if (!
data->isValid())
throw std::runtime_error(
"GridHandle was constructed with an invalid host buffer");
366 mMetaData.resize(
data->mGridCount);
371template<
typename BufferT>
372template <
typename OtherBufferT>
376 auto buffer = OtherBufferT::create(mBuffer.size(), &other);
377 std::memcpy(
buffer.data(), mBuffer.data(), mBuffer.size());
381template<
typename BufferT>
382template<
typename ValueT>
385 const void *
data = mBuffer.data();
386 if (
data ==
nullptr || n >= mMetaData.size() || mMetaData[n].gridType !=
toGridType<ValueT>())
return nullptr;
390template<
typename BufferT>
391template<
typename ValueT,
typename U>
395 const void *
data = mBuffer.deviceData();
396 if (
data ==
nullptr || n >= mMetaData.size() || mMetaData[n].gridType !=
toGridType<ValueT>())
return nullptr;
400template<
typename BufferT>
405 if (
data.isValid()) {
406 uint64_t
size =
data.mGridSize, sum = 0u;
407 while(
data.mGridIndex + 1u <
data.mGridCount) {
408 is.seekg(
data.mGridSize -
sizeof(
GridData), std::ios::cur);
410 sum +=
data.mGridSize;
412 auto buffer = BufferT::create(
size + sum, &pool);
413 is.seekg(-int64_t(sum +
sizeof(
GridData)), std::ios::cur);
417 is.seekg(-
sizeof(
GridData), std::ios::cur);
418 throw std::logic_error(
"This stream does not contain a valid raw grid buffer");
422template<
typename BufferT>
427 if (
data.isValid()) {
428 if (n>=
data.mGridCount)
throw std::runtime_error(
"stream does not contain a #" + std::to_string(n) +
" grid");
429 while(
data.mGridIndex != n) {
430 is.seekg(
data.mGridSize -
sizeof(
GridData), std::ios::cur);
433 auto buffer = BufferT::create(
data.mGridSize, &pool);
434 is.seekg(-
sizeof(
GridData), std::ios::cur);
435 is.read((
char*)(
buffer.data()),
data.mGridSize);
439 is.seekg(-
sizeof(
GridData), std::ios::cur);
440 throw std::logic_error(
"This file does not contain a valid raw buffer");
444template<
typename BufferT>
447 static const std::streamsize byteSize =
sizeof(
GridData);
449 is.read((
char*)&
data, byteSize);
450 is.seekg(-byteSize, std::ios::cur);
451 if (
data.isValid()) {
453 while(
data.mGridName != gridName && n++ <
data.mGridCount) {
454 is.seekg(
data.mGridSize, std::ios::cur);
455 is.read((
char*)&
data, byteSize);
456 is.seekg(-byteSize, std::ios::cur);
458 if (n>
data.mGridCount)
throw std::runtime_error(
"No raw grid named \""+gridName+
"\"");
459 auto buffer = BufferT::create(
data.mGridSize, &pool);
460 is.read((
char*)(
buffer.data()),
data.mGridSize);
464 throw std::logic_error(
"This file does not contain a valid raw buffer");
475template<
typename BufferT,
template <
class,
class...>
class VectorT = std::vector>
476inline VectorT<GridHandle<BufferT>>
480 const void *ptr = handle.
data();
481 if (ptr ==
nullptr)
return VectorT<HandleT>();
482 VectorT<HandleT> handles(handle.
gridCount());
483 for (
auto &h : handles) {
486 auto buffer = BufferT::create(src->
mGridSize, other);
489 tools::updateGridCount(dst, 0u, 1u);
490 h = HandleT(std::move(buffer));
501template<
typename BufferT,
template <
class,
class...>
class VectorT>
502inline GridHandle<BufferT>
506 uint32_t counter = 0u, gridCount = 0u;
507 for (
auto &h : handles) {
508 gridCount += h.gridCount();
509 for (uint32_t n=0; n<h.gridCount(); ++n) size += h.gridSize(n);
511 auto buffer = BufferT::create(size, pool);
512 void *dst = buffer.data();
513 for (
auto &h : handles) {
514 const void *src = h.data();
515 for (uint32_t n=0; n<h.gridCount(); ++n) {
516 std::memcpy(dst, src, h.gridSize(n));
519 tools::updateGridCount(data, counter++, gridCount);
529#if defined(__CUDACC__)
530#include <nanovdb/cuda/GridHandle.cuh>
HostBuffer - a buffer that contains a shared or private bump pool to either externally or internally ...
Implements a light-weight self-contained VDB data-structure in a single file! In other words,...
This class serves to manage a buffer containing one or more NanoVDB Grids.
Definition GridHandle.h:38
void * data()
Returns a non-const pointer to the data.
Definition GridHandle.h:104
uint64_t freeSize() const
compute the size of unused storage in this buffer
Definition GridHandle.h:220
GridHandle & operator=(const GridHandle &)=delete
Disallow copy assignment operation.
uint64_t totalGridSize() const
compute the total sum of memory footprints of all the grids in this buffer
Definition GridHandle.h:211
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceDownload(int device=0, void *stream=nullptr, bool sync=true)
Definition GridHandle.h:195
util::enable_if< BufferTraits< U >::hasDeviceDual, constvoid * >::type deviceData(int device) const
Definition GridHandle.h:115
NanoGrid< ValueT > * grid(uint32_t n=0)
Returns a host pointer to the n'th NanoVDB grid encoded in this GridHandle.
Definition GridHandle.h:152
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceUpload(void *stream, bool sync=true)
Upload the grid to the device, e.g. from CPU to GPU.
Definition GridHandle.h:177
BufferT & buffer()
Return a reference to the buffer.
Definition GridHandle.h:97
const GridData * gridData(uint32_t n=0) const
Access to the GridData of the n'th grid in the current handle.
Definition GridHandle.h:332
const void * data() const
Returns a const pointer to the data.
Definition GridHandle.h:108
void write(std::ostream &os) const
Write the entire grid buffer to an output stream.
Definition GridHandle.h:254
GridHandle(const GridHandle &)=delete
Disallow copy-construction.
GridHandle & operator=(GridHandle &&other) noexcept
Move copy assignment operation.
Definition GridHandle.h:83
const NanoGrid< ValueT > * grid(uint32_t n=0) const
Returns a const host pointer to the n'th NanoVDB grid encoded in this GridHandle.
Definition GridHandle.h:383
uint64_t bufferSize() const
Definition GridHandle.h:126
void read(const std::string &fileName, const std::string &gridName, const BufferT &pool=BufferT())
Read a specific grid from a file containing a raw grid buffer.
Definition GridHandle.h:322
bool empty() const
Return true if this handle is empty, i.e. has no allocated memory.
Definition GridHandle.h:131
util::enable_if< BufferTraits< U >::hasDeviceDual, constNanoGrid< ValueT > * >::type deviceGrid(uint32_t n=0) const
Return a const pointer to the n'th grid encoded in this GridHandle on the device, e....
Definition GridHandle.h:393
uint64_t size() const
Returns the size in bytes of the raw memory buffer managed by this GridHandle.
Definition GridHandle.h:125
util::enable_if< BufferTraits< U >::hasDeviceDual, NanoGrid< ValueT > * >::type deviceGrid(uint32_t n=0)
Return a const pointer to the n'th grid encoded in this GridHandle on the device, e....
Definition GridHandle.h:171
const BufferT & buffer() const
Return a const reference to the buffer.
Definition GridHandle.h:100
GridHandle(GridHandle &&other) noexcept
Move copy-constructor.
Definition GridHandle.h:68
util::enable_if< BufferTraits< U >::hasDeviceDual, constvoid * >::type deviceData() const
Definition GridHandle.h:112
const GridMetaData * gridMetaData(uint32_t n=0) const
Returns a const point to the n'th grid meta data.
Definition GridHandle.h:340
uint64_t gridSize(uint32_t n=0) const
Return the grid size of the n'th grid in this GridHandle.
Definition GridHandle.h:207
GridType gridType(uint32_t n=0) const
Return the GridType of the n'th grid in this GridHandle.
Definition GridHandle.h:229
util::enable_if< BufferTraits< U >::hasDeviceDual, void * >::type deviceData(int device)
Definition GridHandle.h:121
void read(const std::string &fileName, uint32_t n, const BufferT &pool=BufferT())
Read a specific grid from a file containing a raw grid buffer.
Definition GridHandle.h:310
void write(const std::string &fileName) const
Write this entire grid buffer to a file.
Definition GridHandle.h:260
bool isPadded() const
Check if the buffer is this handle has any padding, i.e. if the buffer is larger than the combined si...
Definition GridHandle.h:199
BufferT BufferType
Definition GridHandle.h:46
GridHandle< OtherBufferT > copy(const OtherBufferT &buffer=OtherBufferT()) const
Performs a deep copy of the GridHandle, possibly templated on a different buffer type.
Definition GridHandle.h:373
uint32_t gridCount() const
Return the total number of grids contained in this buffer.
Definition GridHandle.h:202
bool isEmpty() const
Definition GridHandle.h:132
void reset()
clear this GridHandle to an empty handle
Definition GridHandle.h:74
bool isFull() const
Test if this buffer has any unused storage left, i.e. memory not occupied by grids.
Definition GridHandle.h:224
GridHandle(T &&buffer)
Move constructor from a dual host-device buffer.
Definition GridHandle.h:360
util::enable_if< BufferTraits< U >::hasDeviceDual, void * >::type deviceData()
Definition GridHandle.h:118
void read(const std::string &fileName, const BufferT &pool=BufferT())
Read a raw grid buffer from a file.
Definition GridHandle.h:298
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceUpload(int device=0, void *stream=nullptr, bool sync=true)
Upload the host buffer to a specific device buffer. It device buffer doesn't exist it's created first...
Definition GridHandle.h:185
void write(const std::string &fileName, uint32_t n) const
Write a specific grid to file.
Definition GridHandle.h:269
void read(std::istream &is, const BufferT &pool=BufferT())
Read an entire raw grid buffer from an input stream.
Definition GridHandle.h:401
void write(std::ostream &os, uint32_t n) const
Write a specific grid in this buffer to an output stream.
Definition GridHandle.h:244
GridHandle()=default
Constructs an empty GridHandle.
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceDownload(void *stream, bool sync=true)
Download the grid to from the device, e.g. from GPU to CPU.
Definition GridHandle.h:191
static DstT * PtrAdd(void *p, int64_t offset)
Adds a byte offset to a non-const pointer to produce another non-const pointer.
Definition Util.h:512
Definition GridHandle.h:27
void cpyGridHandleMeta(const GridData *data, GridHandleMetaData *meta)
Definition GridHandle.h:347
GridHandle< BufferT > mergeGrids(const VectorT< GridHandle< BufferT > > &handles, const BufferT *pool=nullptr)
Combines (or merges) multiple GridHandles into a single GridHandle containing all grids.
Definition GridHandle.h:503
Grid< NanoTree< BuildT > > NanoGrid
Definition NanoVDB.h:4621
__hostdev__ GridType toGridType()
Maps from a templated build type to a GridType enum.
Definition NanoVDB.h:830
VectorT< GridHandle< BufferT > > splitGrids(const GridHandle< BufferT > &handle, const BufferT *other=nullptr)
Split all grids in a single GridHandle into a vector of multiple GridHandles each with a single grid.
Definition GridHandle.h:477
GridType
List of types that are currently supported by NanoVDB.
Definition NanoVDB.h:214
#define __hostdev__
Definition Util.h:73
#define NANOVDB_ASSERT(x)
Definition Util.h:50
Struct with all the member data of the Grid (useful during serialization of an openvdb grid)
Definition NanoVDB.h:1922
GridType mGridType
Definition NanoVDB.h:1936
uint64_t mGridSize
Definition NanoVDB.h:1930
__hostdev__ bool isValid() const
return true if the magic number and the version are both valid
Definition NanoVDB.h:1979
uint32_t mGridCount
Definition NanoVDB.h:1929
C++11 implementation of std::enable_if.
Definition Util.h:341
static constexpr bool value
Definition Util.h:316