OpenVDB  8.1.0
Archive.h
Go to the documentation of this file.
1 // Copyright Contributors to the OpenVDB Project
2 // SPDX-License-Identifier: MPL-2.0
3 
4 #ifndef OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
5 #define OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
6 
7 #include <openvdb/version.h>
8 #include "Compression.h" // for COMPRESS_ZIP, etc.
9 #include <openvdb/Grid.h>
10 #include <openvdb/MetaMap.h>
11 #include <openvdb/Platform.h>
12 #include <openvdb/version.h> // for VersionId
13 #include <boost/uuid/uuid.hpp>
14 #include <cstdint>
15 #include <iosfwd>
16 #include <map>
17 #include <memory>
18 #include <string>
19 
20 
21 class TestFile;
22 
23 namespace openvdb {
25 namespace OPENVDB_VERSION_NAME {
26 namespace io {
27 
28 class GridDescriptor;
29 
30 
33 {
34 public:
37 
38  static const uint32_t DEFAULT_COMPRESSION_FLAGS;
39 
41  Archive(const Archive&) = default;
42  Archive& operator=(const Archive&) = default;
43  virtual ~Archive();
44 
46  virtual Ptr copy() const;
47 
50  std::string getUniqueTag() const;
52  bool isIdentical(const std::string& uuidStr) const;
53 
55  uint32_t fileVersion() const { return mFileVersion; }
58  VersionId libraryVersion() const { return mLibraryVersion; }
61  std::string version() const;
62 
65  bool isInstancingEnabled() const { return mEnableInstancing; }
69  void setInstancingEnabled(bool b) { mEnableInstancing = b; }
70 
72  static bool hasBloscCompression();
73 
75  static bool hasZLibCompression();
76 
78  uint32_t compression() const { return mCompression; }
83  void setCompression(uint32_t c) { mCompression = c; }
84 
87  bool isGridStatsMetadataEnabled() const { return mEnableGridStats; }
90  void setGridStatsMetadataEnabled(bool b) { mEnableGridStats = b; }
91 
93  virtual void write(const GridCPtrVec&, const MetaMap& = MetaMap()) const {}
94 
100  static bool isDelayedLoadingEnabled();
101 
102 protected:
105  bool inputHasGridOffsets() const { return mInputHasGridOffsets; }
106  void setInputHasGridOffsets(bool b) { mInputHasGridOffsets = b; }
107 
112  void setFormatVersion(std::istream&);
113 
119  void setLibraryVersion(std::istream&);
120 
123  void setDataCompression(std::istream&);
124 
127  void setGridCompression(std::ostream&, const GridBase&) const;
130  static void readGridCompression(std::istream&);
131 
133  static int32_t readGridCount(std::istream&);
134 
136  static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&);
139  static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&, const BBoxd&);
142  static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&, const CoordBBox&);
143 
144  using NamedGridMap = std::map<Name /*uniqueName*/, GridBase::Ptr>;
145 
148  void connectInstance(const GridDescriptor&, const NamedGridMap&) const;
149 
153  void writeGrid(GridDescriptor&, GridBase::ConstPtr, std::ostream&, bool seekable) const;
159  std::ostream&, bool seekable) const;
160 
163  bool readHeader(std::istream&);
167  void writeHeader(std::ostream&, bool seekable) const;
168 
170  void write(std::ostream&, const GridPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
172  void write(std::ostream&, const GridCPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
174 
175 private:
176  friend class ::TestFile;
177 
179  uint32_t mFileVersion;
181  VersionId mLibraryVersion;
183  mutable boost::uuids::uuid mUuid;// needs to be mutable since writeHeader is const!
186  bool mInputHasGridOffsets;
189  bool mEnableInstancing;
191  uint32_t mCompression;
193  bool mEnableGridStats;
194 }; // class Archive
195 
196 } // namespace io
197 } // namespace OPENVDB_VERSION_NAME
198 } // namespace openvdb
199 
200 #endif // OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
#define OPENVDB_API
Helper macros for defining library symbol visibility.
Definition: Platform.h:240
Abstract base class for typed grids.
Definition: Grid.h:78
SharedPtr< const GridBase > ConstPtr
Definition: Grid.h:81
SharedPtr< GridBase > Ptr
Definition: Grid.h:80
Container that maps names (strings) to values of arbitrary types.
Definition: MetaMap.h:20
Grid serializer/unserializer.
Definition: Archive.h:33
void connectInstance(const GridDescriptor &, const NamedGridMap &) const
If the grid represented by the given grid descriptor is an instance, connect it with its instance par...
void setFormatVersion(std::istream &)
Tag the given input stream with the input file format version number.
bool isGridStatsMetadataEnabled() const
Return true if grid statistics (active voxel count and bounding box, etc.) are computed and written a...
Definition: Archive.h:87
void setLibraryVersion(std::istream &)
Tag the given input stream with the version number of the library with which the input stream was cre...
static void readGrid(GridBase::Ptr, const GridDescriptor &, std::istream &)
Populate the given grid from the input stream.
bool inputHasGridOffsets() const
Return true if the input stream contains grid offsets that allow for random access or partial reading...
Definition: Archive.h:105
static bool hasBloscCompression()
Return true if the OpenVDB library includes support for the Blosc compressor.
static const uint32_t DEFAULT_COMPRESSION_FLAGS
Definition: Archive.h:38
void setDataCompression(std::istream &)
Tag the given input stream with flags indicating whether the input stream contains compressed data an...
uint32_t fileVersion() const
Return the file format version number of the input stream.
Definition: Archive.h:55
Archive & operator=(const Archive &)=default
virtual void write(const GridCPtrVec &, const MetaMap &=MetaMap()) const
Write the grids in the given container to this archive's output stream.
Definition: Archive.h:93
static void readGrid(GridBase::Ptr, const GridDescriptor &, std::istream &, const BBoxd &)
Populate the given grid from the input stream, but only where it intersects the given world-space bou...
std::string getUniqueTag() const
Return the UUID that was most recently written (or read, if no UUID has been written yet).
static bool isDelayedLoadingEnabled()
Return true if delayed loading is enabled.
void setGridCompression(std::ostream &, const GridBase &) const
Tag an output stream with flags specifying only those compression options that are applicable to the ...
void writeHeader(std::ostream &, bool seekable) const
Write the magic number, version numbers, UUID, etc. to the given output stream.
static int32_t readGridCount(std::istream &)
Read in and return the number of grids on the input stream.
void write(std::ostream &, const GridCPtrVec &, bool seekable, const MetaMap &=MetaMap()) const
SharedPtr< const Archive > ConstPtr
Definition: Archive.h:36
bool isInstancingEnabled() const
Return true if trees shared by multiple grids are written out only once, false if they are written ou...
Definition: Archive.h:65
static void readGrid(GridBase::Ptr, const GridDescriptor &, std::istream &, const CoordBBox &)
Populate the given grid from the input stream, but only where it intersects the given index-space bou...
void setInstancingEnabled(bool b)
Specify whether trees shared by multiple grids should be written out only once (true) or once per gri...
Definition: Archive.h:69
static void readGridCompression(std::istream &)
Read in the compression flags for a grid and tag the given input stream with those flags.
virtual Ptr copy() const
Return a copy of this archive.
static bool hasZLibCompression()
Return true if the OpenVDB library includes support for the ZLib compressor.
void setCompression(uint32_t c)
Specify whether and how the data stream should be compressed.
Definition: Archive.h:83
uint32_t compression() const
Return a bit mask specifying compression options for the data stream.
Definition: Archive.h:78
std::map< Name, GridBase::Ptr > NamedGridMap
Definition: Archive.h:144
bool isIdentical(const std::string &uuidStr) const
Return true if the given UUID matches this archive's UUID.
void writeGridInstance(GridDescriptor &, GridBase::ConstPtr, std::ostream &, bool seekable) const
void writeGrid(GridDescriptor &, GridBase::ConstPtr, std::ostream &, bool seekable) const
bool readHeader(std::istream &)
Read the magic number, version numbers, UUID, etc. from the given input stream.
SharedPtr< Archive > Ptr
Definition: Archive.h:35
Archive(const Archive &)=default
void setGridStatsMetadataEnabled(bool b)
Specify whether grid statistics (active voxel count and bounding box, etc.) should be computed and wr...
Definition: Archive.h:90
VersionId libraryVersion() const
Return the (major, minor) version number of the library that was used to write the input stream.
Definition: Archive.h:58
std::string version() const
Return a string of the form "<major>.<minor>/<format>", giving the library and file format version nu...
void setInputHasGridOffsets(bool b)
Definition: Archive.h:106
Definition: GridDescriptor.h:20
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:249
std::string Name
Definition: Name.h:17
std::vector< GridBase::Ptr > GridPtrVec
Definition: Grid.h:514
std::shared_ptr< T > SharedPtr
Definition: openvdb/Types.h:110
std::vector< GridBase::ConstPtr > GridCPtrVec
Definition: Grid.h:519
Definition: openvdb/Exceptions.h:13
Definition: version.h.in:237
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:116
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:178