Merge remote-tracking branch 'upstream/feature/io' into io_scalar_codecs

Author: danrbailey

openvdb/openvdb/io/Archive.cc

@@ -448,9 +448,9 @@ getFormatVersion(std::ios_base& is)
 void
 checkFormatVersion(std::ios_base& is)
 {
-    if (getFormatVersion(is) < OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION ) {
+    if (getFormatVersion(is) < OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX ) {
         OPENVDB_THROW(IoError,
-            "VDB file version < 222 (NODE_MASK_COMPRESSION) is no longer supported. "
+            "VDB file version < 221 (FLOAT_FRUSTUM_BBOX) is no longer supported. "
             "To read older VDB files, please use VDB 12.x or older and then write "
             "them out again to produce files that are compatible with 13.0 and above.");
     }
@@ -750,9 +750,9 @@ Archive::readHeader(std::istream& is)
     if (mFileVersion > OPENVDB_FILE_VERSION) {
         OPENVDB_LOG_WARN("unsupported VDB file format (expected version "
             << OPENVDB_FILE_VERSION << " or earlier, got version " << mFileVersion << ")");
-    } else if (mFileVersion < OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION) {
+    } else if (mFileVersion < OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX) {
         OPENVDB_THROW(IoError,
-            "VDB file version < 222 (NODE_MASK_COMPRESSION) is no longer supported.");
+            "VDB file version < 221 (FLOAT_FRUSTUM_BBOX) is no longer supported.");
     }
 
     // 3) Read the library version numbers (not stored prior to file format version 211).

openvdb/openvdb/io/Codec.h

@@ -465,12 +465,14 @@ readCompressedValues(std::istream& is, ValueT* destBuf, Index destCount,
 
     int8_t metadata = NO_MASK_AND_ALL_VALS;
 
-    // Read the flag that specifies what, if any, additional metadata
-    // (selection mask and/or inactive value(s)) is saved.
-    if (seek && !maskCompressed) {
-        is.seekg(/*bytes=*/1, std::ios_base::cur);
-    } else {
-        is.read(reinterpret_cast<char*>(&metadata), /*bytes=*/1);
+    if (getFormatVersion(is) >= OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION) {
+        // Read the flag that specifies what, if any, additional metadata
+        // (selection mask and/or inactive value(s)) is saved.
+        if (seek && !maskCompressed) {
+            is.seekg(/*bytes=*/1, std::ios_base::cur);
+        } else {
+            is.read(reinterpret_cast<char*>(&metadata), /*bytes=*/1);
+        }
     }
 
     ValueT background = zeroVal<ValueT>();

openvdb/openvdb/io/Compression.h

@@ -365,9 +365,9 @@ File::readAllGridMetadata()
         OPENVDB_THROW(IoError, mFilename << " is not open for reading");
     }
 
-    if (fileVersion() < OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION) {
+    if (fileVersion() < OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX) {
         OPENVDB_THROW(IoError,
-            "VDB file version < 222 (NODE_MASK_COMPRESSION) is no longer supported.");
+            "VDB file version < 221 (FLOAT_FRUSTUM_BBOX) is no longer supported.");
     }
 
     GridPtrVecPtr ret(new GridPtrVec);
@@ -406,9 +406,9 @@ File::readGridMetadata(const Name& name)
         OPENVDB_THROW(IoError, mFilename << " is not open for reading.");
     }
 
-    if (fileVersion() < OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION) {
+    if (fileVersion() < OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX) {
         OPENVDB_THROW(IoError,
-            "VDB file version < 222 (NODE_MASK_COMPRESSION) is no longer supported.");
+            "VDB file version < 221 (FLOAT_FRUSTUM_BBOX) is no longer supported.");
     }
 
     GridBase::ConstPtr ret;

openvdb/openvdb/io/File.cc

@@ -14,14 +14,16 @@
 #endif
 
 
-/// @note tbb/blocked_range.h is the ONLY include that persists from TBB 2020
-///   to TBB 2021 that itself includes the TBB specific version header files.
-///   In TBB 2020, the version header was called tbb/stddef.h. In 2021, it's
-///   called tbb/version.h. We include tbb/blocked_range.h here to indirectly
-///   access the version defines in a consistent way so that downstream
-///   software doesn't need to provide compile time defines.
 #include <tbb/blocked_range.h>
 #include <tbb/task.h>
+/// @note tbb/task_arena.h is the ONLY include that persists from TBB 2020
+///   to TBB 2021 to TBB 2023 that itself includes the TBB specific version
+///   header files.
+///   In TBB 2020, the version header was called tbb/stddef.h. In 2021+, it's
+///   called tbb/version.h. We include tbb/task_arena.h here to indirectly
+///   access the version defines in a consistent way so that downstream
+///   software doesn't need to provide compile time defines.
+#include <tbb/task_arena.h>
 #include <tbb/task_group.h>
 
 namespace openvdb {

openvdb/openvdb/thread/Threading.h

@@ -2426,7 +2426,9 @@ InternalNode<ChildT, Log2Dim>::readTopology(std::istream& is, bool fromHalf)
     mChildMask.load(is);
     mValueMask.load(is);
 
-    const Index numValues = NUM_VALUES;
+    const bool oldVersion =
+        (io::getFormatVersion(is) < OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION);
+    const Index numValues = (oldVersion ? mChildMask.countOff() : NUM_VALUES);
     {
         // Read in (and uncompress, if necessary) all of this node's values
         // into a contiguous array.
@@ -2435,8 +2437,16 @@ InternalNode<ChildT, Log2Dim>::readTopology(std::istream& is, bool fromHalf)
         io::readCompressedValues(is, values, numValues, mValueMask, fromHalf);
 
         // Copy values from the array into this node's table.
-        for (ValueAllIter iter = this->beginValueAll(); iter; ++iter) {
-            mNodes[iter.pos()].setValue(values[iter.pos()]);
+        if (oldVersion) {
+            Index n = 0;
+            for (ValueAllIter iter = this->beginValueAll(); iter; ++iter) {
+                mNodes[iter.pos()].setValue(values[n++]);
+            }
+            OPENVDB_ASSERT(n == numValues);
+        } else {
+            for (ValueAllIter iter = this->beginValueAll(); iter; ++iter) {
+                mNodes[iter.pos()].setValue(values[iter.pos()]);
+            }
         }
     }
 

openvdb/openvdb/tree/InternalNode.h

@@ -1381,6 +1381,13 @@ LeafNode<T,Log2Dim>::readBuffers(std::istream& is, const CoordBBox& clipBBox, bo
     }
 
     int8_t numBuffers = 1;
+    if (io::getFormatVersion(is) < OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION) {
+        // Read in the origin.
+        is.read(reinterpret_cast<char*>(&mOrigin), sizeof(Coord::ValueType) * 3);
+
+        // Read in the number of buffers, which should now always be one.
+        is.read(reinterpret_cast<char*>(&numBuffers), sizeof(int8_t));
+    }
 
     CoordBBox nodeBBox = this->getNodeBoundingBox();
     if (!clipBBox.hasOverlap(nodeBBox)) {

openvdb/openvdb/tree/LeafNode.h

@@ -151,11 +151,11 @@ class OPENVDB_API TreeBase
     /// @brief Read the tree topology from a stream.
     ///
     /// This will read the tree structure and tile values, but not voxel data.
-    virtual void readTopology(std::istream&, bool saveFloatAsHalf = false);
+    virtual void readTopology(std::istream&, bool saveFloatAsHalf = false) = 0;
     /// @brief Write the tree topology to a stream.
     ///
     /// This will write the tree structure and tile values, but not voxel data.
-    virtual void writeTopology(std::ostream&, bool saveFloatAsHalf = false) const;
+    virtual void writeTopology(std::ostream&, bool saveFloatAsHalf = false) const = 0;
 
     /// Read all data buffers for this tree.
     virtual void readBuffers(std::istream&, bool saveFloatAsHalf = false) = 0;
@@ -1130,23 +1130,6 @@ struct Tree5 {
 ////////////////////////////////////////
 
 
-inline void
-TreeBase::readTopology(std::istream& is, bool /*saveFloatAsHalf*/)
-{
-    int32_t bufferCount;
-    is.read(reinterpret_cast<char*>(&bufferCount), sizeof(int32_t));
-    if (bufferCount != 1) OPENVDB_LOG_WARN("multi-buffer trees are no longer supported");
-}
-
-
-inline void
-TreeBase::writeTopology(std::ostream& os, bool /*saveFloatAsHalf*/) const
-{
-    int32_t bufferCount = 1;
-    os.write(reinterpret_cast<char*>(&bufferCount), sizeof(int32_t));
-}
-
-
 inline void
 TreeBase::print(std::ostream& os, int /*verboseLevel*/) const
 {
@@ -1273,7 +1256,9 @@ void
 Tree<RootNodeType>::readTopology(std::istream& is, bool saveFloatAsHalf)
 {
     this->clearAllAccessors();
-    TreeBase::readTopology(is, saveFloatAsHalf);
+    int32_t bufferCount;
+    is.read(reinterpret_cast<char*>(&bufferCount), sizeof(int32_t));
+    if (bufferCount != 1) OPENVDB_LOG_WARN("multi-buffer trees are no longer supported");
     mRoot.readTopology(is, saveFloatAsHalf);
 }
 
@@ -1282,7 +1267,8 @@ template<typename RootNodeType>
 void
 Tree<RootNodeType>::writeTopology(std::ostream& os, bool saveFloatAsHalf) const
 {
-    TreeBase::writeTopology(os, saveFloatAsHalf);
+    int32_t bufferCount = 1;
+    os.write(reinterpret_cast<char*>(&bufferCount), sizeof(int32_t));
     mRoot.writeTopology(os, saveFloatAsHalf);
 }
 

openvdb/openvdb/tree/Tree.h

@@ -0,0 +1,6 @@
+OpenVDB:
+  API changes:
+  - Added optional trailing WriteOptions parameter to io::File::write() and io::Stream::write().
+    No changes in behavior.
+  - Added optional trailing ReadOptions parameter to io::File::getGrids() and io::File::readGrid().
+    No changes in behavior.

pendingchanges/iooptions.txt

@@ -0,0 +1,8 @@
+OpenVDB:
+  API changes:
+  - GridDescriptor::read() has been deprecated, use GridDescriptor::readHeader()
+    followed by GridDescriptor::readStreamPos() instead.
+
+  Improvements:
+  - Large refactor of I/O classes, many private and protected member functions have
+    been modified. No change in behavior for io::File and io::Stream.