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); }
51 template<typename T = BufferT, typename util::enable_if<BufferTraits<T>::hasDeviceDual,
int>::type = 0>
57 template<typename T = BufferT, typename util::disable_if<BufferTraits<T>::hasDeviceDual,
int>::type = 0>
68 mBuffer = std::move(other.mBuffer);
69 mMetaData = std::move(other.mMetaData);
83 mBuffer = std::move(other.mBuffer);
84 mMetaData = std::move(other.mMetaData);
92 template <
typename OtherBufferT = HostBuffer>
96 BufferT&
buffer() {
return mBuffer; }
99 const BufferT&
buffer()
const {
return mBuffer; }
103 void*
data() {
return mBuffer.data(); }
107 const void*
data()
const {
return mBuffer.data(); }
109 template<
typename U = BufferT>
112 template<
typename U = BufferT>
117 uint64_t
size()
const {
return mBuffer.size(); }
126 operator bool()
const {
return !this->
empty(); }
133 template<
typename ValueT>
141 template<
typename ValueT>
149 template<
typename ValueT,
typename U = BufferT>
159 template<
typename ValueT,
typename U = BufferT>
165 template<
typename U = BufferT>
167 deviceUpload(
void* stream =
nullptr,
bool sync =
true) { mBuffer.deviceUpload(stream, sync); }
171 template<
typename U = BufferT>
173 deviceDownload(
void* stream =
nullptr,
bool sync =
true) { mBuffer.deviceDownload(stream, sync); }
177 bool isPadded()
const {
return mMetaData.empty() ? false : mMetaData.back().offset + mMetaData.back().size != mBuffer.size();}
180 uint32_t
gridCount()
const {
return static_cast<uint32_t
>(mMetaData.size());}
185 uint64_t
gridSize(uint32_t n = 0)
const {
return mMetaData[n].size; }
205 void write(std::ostream& os, uint32_t n)
const {
207 os.write((
const char*)
data,
data->mGridSize);
209 throw std::runtime_error(
"GridHandle does not contain a #" + std::to_string(n) +
" grid");
215 void write(std::ostream& os)
const {
221 void write(
const std::string &fileName)
const {
222 std::ofstream os(fileName, std::ios::out | std::ios::binary | std::ios::trunc);
223 if (!os.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for output");
230 void write(
const std::string &fileName, uint32_t n)
const {
231 std::ofstream os(fileName, std::ios::out | std::ios::binary | std::ios::trunc);
232 if (!os.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for output");
240 void read(std::istream& is,
const BufferT& pool = BufferT());
247 void read(std::istream& is, uint32_t n,
const BufferT& pool = BufferT());
254 void read(std::istream& is,
const std::string &gridName,
const BufferT& pool = BufferT());
259 void read(
const std::string &fileName,
const BufferT& pool = BufferT()) {
260 std::ifstream is(fileName, std::ios::in | std::ios::binary);
261 if (!is.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for input");
262 this->
read(is, pool);
271 void read(
const std::string &fileName, uint32_t n,
const BufferT& pool = BufferT()) {
272 std::ifstream is(fileName, std::ios::in | std::ios::binary);
273 if (!is.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for input");
274 this->
read(is, n, pool);
283 void read(
const std::string &fileName,
const std::string &gridName,
const BufferT& pool = BufferT()) {
284 std::ifstream is(fileName, std::ios::in | std::ios::binary);
285 if (!is.is_open())
throw std::ios_base::failure(
"Unable to open file named \"" + fileName +
"\" for input");
286 this->
read(is, gridName, pool);
292template<
typename BufferT>
295 const void *
data = this->data();
296 if (
data ==
nullptr || n >= mMetaData.size())
return nullptr;
300template<
typename BufferT>
304 if (
data ==
nullptr || n >= mMetaData.size())
return nullptr;
311 for (
auto *p=meta, *q=p+data->
mGridCount; p!=q; ++p) {
318template<
typename BufferT>
319template<typename T, typename util::disable_if<BufferTraits<T>::hasDeviceDual,
int>::type>
323 mBuffer = std::move(
buffer);
324 if (
auto *
data =
reinterpret_cast<const GridData*
>(mBuffer.data())) {
325 if (!
data->isValid())
throw std::runtime_error(
"GridHandle was constructed with an invalid host buffer");
326 mMetaData.resize(
data->mGridCount);
331template<
typename BufferT>
332template <
typename OtherBufferT>
336 auto buffer = OtherBufferT::create(mBuffer.size(), &other);
337 std::memcpy(
buffer.data(), mBuffer.data(), mBuffer.size());
341template<
typename BufferT>
342template<
typename ValueT>
345 const void *
data = mBuffer.data();
346 if (
data ==
nullptr || n >= mMetaData.size() || mMetaData[n].gridType !=
toGridType<ValueT>())
return nullptr;
350template<
typename BufferT>
351template<
typename ValueT,
typename U>
355 const void *
data = mBuffer.deviceData();
356 if (
data ==
nullptr || n >= mMetaData.size() || mMetaData[n].gridType !=
toGridType<ValueT>())
return nullptr;
360template<
typename BufferT>
365 if (
data.isValid()) {
366 uint64_t
size =
data.mGridSize, sum = 0u;
367 while(
data.mGridIndex + 1u <
data.mGridCount) {
368 is.seekg(
data.mGridSize -
sizeof(
GridData), std::ios::cur);
370 sum +=
data.mGridSize;
372 auto buffer = BufferT::create(
size + sum, &pool);
373 is.seekg(-int64_t(sum +
sizeof(
GridData)), std::ios::cur);
377 is.seekg(-
sizeof(
GridData), std::ios::cur);
378 throw std::logic_error(
"This stream does not contain a valid raw grid buffer");
382template<
typename BufferT>
387 if (
data.isValid()) {
388 if (n>=
data.mGridCount)
throw std::runtime_error(
"stream does not contain a #" + std::to_string(n) +
" grid");
389 while(
data.mGridIndex != n) {
390 is.seekg(
data.mGridSize -
sizeof(
GridData), std::ios::cur);
393 auto buffer = BufferT::create(
data.mGridSize, &pool);
394 is.seekg(-
sizeof(
GridData), std::ios::cur);
395 is.read((
char*)(
buffer.data()),
data.mGridSize);
399 is.seekg(-
sizeof(
GridData), std::ios::cur);
400 throw std::logic_error(
"This file does not contain a valid raw buffer");
404template<
typename BufferT>
407 static const std::streamsize byteSize =
sizeof(
GridData);
409 is.read((
char*)&
data, byteSize);
410 is.seekg(-byteSize, std::ios::cur);
411 if (
data.isValid()) {
413 while(
data.mGridName != gridName && n++ <
data.mGridCount) {
414 is.seekg(
data.mGridSize, std::ios::cur);
415 is.read((
char*)&
data, byteSize);
416 is.seekg(-byteSize, std::ios::cur);
418 if (n>
data.mGridCount)
throw std::runtime_error(
"No raw grid named \""+gridName+
"\"");
419 auto buffer = BufferT::create(
data.mGridSize, &pool);
420 is.read((
char*)(
buffer.data()),
data.mGridSize);
424 throw std::logic_error(
"This file does not contain a valid raw buffer");
435template<
typename BufferT,
template <
class,
class...>
class VectorT = std::vector>
436inline VectorT<GridHandle<BufferT>>
440 const void *ptr = handle.
data();
441 if (ptr ==
nullptr)
return VectorT<HandleT>();
442 VectorT<HandleT> handles(handle.
gridCount());
443 for (
auto &h : handles) {
446 auto buffer = BufferT::create(src->
mGridSize, other);
449 tools::updateGridCount(dst, 0u, 1u);
450 h = HandleT(std::move(buffer));
453 return std::move(handles);
461template<
typename BufferT,
template <
class,
class...>
class VectorT>
462inline GridHandle<BufferT>
466 uint32_t counter = 0u, gridCount = 0u;
467 for (
auto &h : handles) {
468 gridCount += h.gridCount();
469 for (uint32_t n=0; n<h.gridCount(); ++n) size += h.gridSize(n);
471 auto buffer = BufferT::create(size, pool);
472 void *dst = buffer.data();
473 for (
auto &h : handles) {
474 const void *src = h.data();
475 for (uint32_t n=0; n<h.gridCount(); ++n) {
476 std::memcpy(dst, src, h.gridSize(n));
479 tools::updateGridCount(data, counter++, gridCount);
489#if defined(__CUDACC__)
490#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:103
GridHandle & operator=(const GridHandle &)=delete
Disallow copy assignment operation.
NanoGrid< ValueT > * grid(uint32_t n=0)
Returns a host pointer to the n'th NanoVDB grid encoded in this GridHandle.
Definition GridHandle.h:142
BufferT & buffer()
Return a reference to the buffer.
Definition GridHandle.h:96
const GridData * gridData(uint32_t n=0) const
Access to the GridData of the n'th grid in the current handle.
Definition GridHandle.h:293
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceUpload(void *stream=nullptr, bool sync=true)
Upload the grid to the device, e.g. from CPU to GPU.
Definition GridHandle.h:167
const void * data() const
Returns a const pointer to the data.
Definition GridHandle.h:107
void write(std::ostream &os) const
Write the entire grid buffer to an output stream.
Definition GridHandle.h:215
GridHandle(const GridHandle &)=delete
Disallow copy-construction.
GridHandle & operator=(GridHandle &&other) noexcept
Move copy assignment operation.
Definition GridHandle.h:82
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceDownload(void *stream=nullptr, bool sync=true)
Download the grid to from the device, e.g. from GPU to CPU.
Definition GridHandle.h:173
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:343
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:283
bool empty() const
Return true if this handle is empty, i.e. has no allocated memory.
Definition GridHandle.h:121
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:353
uint64_t size() const
Returns the size in bytes of the raw memory buffer managed by this GridHandle.
Definition GridHandle.h:117
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:161
const BufferT & buffer() const
Return a const reference to the buffer.
Definition GridHandle.h:99
GridHandle(GridHandle &&other) noexcept
Move copy-constructor.
Definition GridHandle.h:67
util::enable_if< BufferTraits< U >::hasDeviceDual, constvoid * >::type deviceData() const
Definition GridHandle.h:111
const GridMetaData * gridMetaData(uint32_t n=0) const
Returns a const point to the n'th grid meta data.
Definition GridHandle.h:301
uint64_t gridSize(uint32_t n=0) const
Return the grid size of the n'th grid in this GridHandle.
Definition GridHandle.h:185
GridType gridType(uint32_t n=0) const
Return the GridType of the n'th grid in this GridHandle.
Definition GridHandle.h:190
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:271
void write(const std::string &fileName) const
Write this entire grid buffer to a file.
Definition GridHandle.h:221
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:177
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:333
uint32_t gridCount() const
Return the total number of grids contained in this buffer.
Definition GridHandle.h:180
bool isEmpty() const
Definition GridHandle.h:122
void reset()
clear this GridHandle to an empty handle
Definition GridHandle.h:73
GridHandle(T &&buffer)
Move constructor from a host buffer.
Definition GridHandle.h:320
util::enable_if< BufferTraits< U >::hasDeviceDual, void * >::type deviceData()
Definition GridHandle.h:114
void read(const std::string &fileName, const BufferT &pool=BufferT())
Read a raw grid buffer from a file.
Definition GridHandle.h:259
void write(const std::string &fileName, uint32_t n) const
Write a specific grid to file.
Definition GridHandle.h:230
void read(std::istream &is, const BufferT &pool=BufferT())
Read an entire raw grid buffer from an input stream.
Definition GridHandle.h:361
void write(std::ostream &os, uint32_t n) const
Write a specific grid in this buffer to an output stream.
Definition GridHandle.h:205
GridHandle()=default
Constructs an empty GridHandle.
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:478
Definition GridHandle.h:27
void cpyGridHandleMeta(const GridData *data, GridHandleMetaData *meta)
Definition GridHandle.h:308
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:463
Grid< NanoTree< BuildT > > NanoGrid
Definition NanoVDB.h:4750
__hostdev__ GridType toGridType()
Maps from a templated build type to a GridType enum.
Definition NanoVDB.h:812
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:437
GridType
List of types that are currently supported by NanoVDB.
Definition NanoVDB.h:219
#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:1811
GridType mGridType
Definition NanoVDB.h:1825
uint64_t mGridSize
Definition NanoVDB.h:1819
__hostdev__ bool isValid() const
return true if the magic number and the version are both valid
Definition NanoVDB.h:1864
uint32_t mGridCount
Definition NanoVDB.h:1818
C++11 implementation of std::enable_if.
Definition Util.h:335
static constexpr bool value
Definition Util.h:316