OpenVDB: Archive.h Source File

OpenVDB 4.0.2

Archive.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2017 DreamWorks Animation LLC
4 //
5 // All rights reserved. This software is distributed under the
6 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
7 //
8 // Redistributions of source code must retain the above copyright
9 // and license notice and the following restrictions and disclaimer.
10 //
11 // * Neither the name of DreamWorks Animation nor the names of
12 // its contributors may be used to endorse or promote products derived
13 // from this software without specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
20 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 // IN NO EVENT SHALL THE COPYRIGHT HOLDERS' AND CONTRIBUTORS' AGGREGATE
27 // LIABILITY FOR ALL CLAIMS REGARDLESS OF THEIR BASIS EXCEED US$250.00.
28 //
30
31 #ifndef OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
32 #define OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
33
34 #include "Compression.h" // for COMPRESS_ZIP, etc.
35 #include <openvdb/Grid.h>
36 #include <openvdb/MetaMap.h>
37 #include <openvdb/Platform.h>
38 #include <openvdb/version.h> // for VersionId
39 #include <boost/uuid/uuid.hpp>
40 #include <cstdint>
41 #include <iosfwd>
42 #include <map>
43 #include <memory>
44 #include <string>
45
46
47 class TestFile;
48
49 namespace openvdb {
50 OPENVDB_USE_VERSION_NAMESPACE
51 namespace OPENVDB_VERSION_NAME {
52 namespace io {
53
54 class GridDescriptor;
55
56
58 class OPENVDB_API Archive
59 {
60 public:
61 using Ptr = SharedPtr<Archive>;
62 using ConstPtr = SharedPtr<const Archive>;
63
64 static const uint32_t DEFAULT_COMPRESSION_FLAGS;
65
66 Archive();
67 Archive(const Archive&) = default;
68 Archive& operator=(const Archive&) = default;
69 virtual ~Archive();
70
72 virtual Ptr copy() const;
73
76 std::string getUniqueTag() const;
78 bool isIdentical(const std::string& uuidStr) const;
79
81 uint32_t fileVersion() const { return mFileVersion; }
84 VersionId libraryVersion() const { return mLibraryVersion; }
87 std::string version() const;
88
91 bool isInstancingEnabled() const { return mEnableInstancing; }
95 void setInstancingEnabled(bool b) { mEnableInstancing = b; }
96
98 static bool hasBloscCompression();
99
101 uint32_t compression() const { return mCompression; }
106 void setCompression(uint32_t c) { mCompression = c; }
107
110 bool isGridStatsMetadataEnabled() const { return mEnableGridStats; }
113 void setGridStatsMetadataEnabled(bool b) { mEnableGridStats = b; }
114
116 virtual void write(const GridCPtrVec&, const MetaMap& = MetaMap()) const {}
117
123 static bool isDelayedLoadingEnabled();
124
125 protected:
128 bool inputHasGridOffsets() const { return mInputHasGridOffsets; }
129 void setInputHasGridOffsets(bool b) { mInputHasGridOffsets = b; }
130
135 void setFormatVersion(std::istream&);
136
142 void setLibraryVersion(std::istream&);
143
146 void setDataCompression(std::istream&);
147
150 void setGridCompression(std::ostream&, const GridBase&) const;
153 static void readGridCompression(std::istream&);
154
156 static int32_t readGridCount(std::istream&);
157
159 static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&);
160 #ifndef OPENVDB_2_ABI_COMPATIBLE
161 static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&, const BBoxd&);
166 static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&, const CoordBBox&);
167 #endif
168
169 typedef std::map<Name /*uniqueName*/, GridBase::Ptr> NamedGridMap;
170
173 void connectInstance(const GridDescriptor&, const NamedGridMap&) const;
174
178 void writeGrid(GridDescriptor&, GridBase::ConstPtr, std::ostream&, bool seekable) const;
183 void writeGridInstance(GridDescriptor&, GridBase::ConstPtr,
184 std::ostream&, bool seekable) const;
185
188 bool readHeader(std::istream&);
192 void writeHeader(std::ostream&, bool seekable) const;
193
195 void write(std::ostream&, const GridPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
197 void write(std::ostream&, const GridCPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
199
200 private:
201 friend class ::TestFile;
202
204 uint32_t mFileVersion;
206 VersionId mLibraryVersion;
208 mutable boost::uuids::uuid mUuid;// needs to be mutable since writeHeader is const!
211 bool mInputHasGridOffsets;
214 bool mEnableInstancing;
216 uint32_t mCompression;
218 bool mEnableGridStats;
219 }; // class Archive
220
221 } // namespace io
222 } // namespace OPENVDB_VERSION_NAME
223 } // namespace openvdb
224
225 #endif // OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
226
227 // Copyright (c) 2012-2017 DreamWorks Animation LLC
228 // All rights reserved. This software is distributed under the
229 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
openvdb::v4_0_2::io::Archive::setGridStatsMetadataEnabled
void setGridStatsMetadataEnabled(bool b)
Specify whether grid statistics (active voxel count and bounding box, etc.) should be computed and wr...
Definition: Archive.h:113
openvdb::v4_0_2::GridBase::ConstPtr
SharedPtr< const GridBase > ConstPtr
Definition: Grid.h:108
OPENVDB_API
#define OPENVDB_API
Helper macros for defining library symbol visibility.
Definition: Platform.h:194
openvdb::v4_0_2::io::Archive::Ptr
SharedPtr< Archive > Ptr
Definition: Archive.h:61
Compression.h
openvdb::v4_0_2::io::Archive::write
virtual void write(const GridCPtrVec &, const MetaMap &=MetaMap()) const
Write the grids in the given container to this archive&#39;s output stream.
Definition: Archive.h:116
openvdb::v4_0_2::SharedPtr
std::shared_ptr< T > SharedPtr
Definition: Types.h:130
openvdb::v4_0_2::GridBase::Ptr
SharedPtr< GridBase > Ptr
Definition: Grid.h:107
MetaMap.h
openvdb::v4_0_2::io::Archive::compression
uint32_t compression() const
Return a bit mask specifying compression options for the data stream.
Definition: Archive.h:101
openvdb::v4_0_2::io::Archive::fileVersion
uint32_t fileVersion() const
Return the file format version number of the input stream.
Definition: Archive.h:81
openvdb::v4_0_2::GridPtrVec
std::vector< GridBase::Ptr > GridPtrVec
Definition: Grid.h:437
openvdb::v4_0_2::math::CoordBBox
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:261
openvdb::v4_0_2::io::Archive
Grid serializer/unserializer.
Definition: Archive.h:58
openvdb::v4_0_2::Name
std::string Name
Definition: Name.h:44
openvdb::v4_0_2::io::Archive::NamedGridMap
std::map< Name, GridBase::Ptr > NamedGridMap
Definition: Archive.h:169
openvdb::v4_0_2::io::Archive::isInstancingEnabled
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:91
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
Definition: version.h:43
openvdb::v4_0_2::VersionId
Definition: version.h:121
openvdb::v4_0_2::io::setDataCompression
OPENVDB_API void setDataCompression(std::ios_base &, uint32_t compressionFlags)
Associate with the given stream a bitwise OR of compression option flags (COMPRESS_ZIP, COMPRESS_ACTIVE_MASK, etc.) specifying whether and how input data is compressed or output data should be compressed.
openvdb::v4_0_2::io::GridDescriptor
Definition: GridDescriptor.h:46
openvdb
Definition: Exceptions.h:39
openvdb::v4_0_2::GridCPtrVec
std::vector< GridBase::ConstPtr > GridCPtrVec
Definition: Grid.h:442
version.h
openvdb::v4_0_2::io::Archive::setInstancingEnabled
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:95
openvdb::v4_0_2::io::Archive::setInputHasGridOffsets
void setInputHasGridOffsets(bool b)
Definition: Archive.h:129
openvdb::v4_0_2::io::Archive::setCompression
void setCompression(uint32_t c)
Specify whether and how the data stream should be compressed.
Definition: Archive.h:106
openvdb::v4_0_2::GridBase
Abstract base class for typed grids.
Definition: Grid.h:104
Grid.h
openvdb::v4_0_2::MetaMap
Container that maps names (strings) to values of arbitrary types.
Definition: MetaMap.h:46
openvdb::v4_0_2::io::Archive::DEFAULT_COMPRESSION_FLAGS
static const uint32_t DEFAULT_COMPRESSION_FLAGS
Definition: Archive.h:64
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:71
openvdb::v4_0_2::io::Archive::isGridStatsMetadataEnabled
bool isGridStatsMetadataEnabled() const
Return true if grid statistics (active voxel count and bounding box, etc.) are computed and written a...
Definition: Archive.h:110
openvdb::v4_0_2::io::Archive::libraryVersion
VersionId libraryVersion() const
Return the (major, minor) version number of the library that was used to write the input stream...
Definition: Archive.h:84
openvdb::v4_0_2::io::Archive::inputHasGridOffsets
bool inputHasGridOffsets() const
Return true if the input stream contains grid offsets that allow for random access or partial reading...
Definition: Archive.h:128
openvdb::v4_0_2::io::Archive::ConstPtr
SharedPtr< const Archive > ConstPtr
Definition: Archive.h:62
openvdb::v4_0_2::math::BBox< Vec3d >
Platform.h