OpenVDB: Archive.h Source File

OpenVDB 6.1.0

Archive.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2018 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 <openvdb/version.h>
35 #include "Compression.h" // for COMPRESS_ZIP, etc.
36 #include <openvdb/Grid.h>
37 #include <openvdb/MetaMap.h>
38 #include <openvdb/Platform.h>
39 #include <openvdb/version.h> // for VersionId
40 #include <boost/uuid/uuid.hpp>
41 #include <cstdint>
42 #include <iosfwd>
43 #include <map>
44 #include <memory>
45 #include <string>
46
47
48 class TestFile;
49
50 namespace openvdb {
51 OPENVDB_USE_VERSION_NAMESPACE
52 namespace OPENVDB_VERSION_NAME {
53 namespace io {
54
55 class GridDescriptor;
56
57
59 class OPENVDB_API Archive
60 {
61 public:
62 using Ptr = SharedPtr<Archive>;
63 using ConstPtr = SharedPtr<const Archive>;
64
65 static const uint32_t DEFAULT_COMPRESSION_FLAGS;
66
67 Archive();
68 Archive(const Archive&) = default;
69 Archive& operator=(const Archive&) = default;
70 virtual ~Archive();
71
73 virtual Ptr copy() const;
74
77 std::string getUniqueTag() const;
79 bool isIdentical(const std::string& uuidStr) const;
80
82 uint32_t fileVersion() const { return mFileVersion; }
85 VersionId libraryVersion() const { return mLibraryVersion; }
88 std::string version() const;
89
92 bool isInstancingEnabled() const { return mEnableInstancing; }
96 void setInstancingEnabled(bool b) { mEnableInstancing = b; }
97
99 static bool hasBloscCompression();
100
102 uint32_t compression() const { return mCompression; }
107 void setCompression(uint32_t c) { mCompression = c; }
108
111 bool isGridStatsMetadataEnabled() const { return mEnableGridStats; }
114 void setGridStatsMetadataEnabled(bool b) { mEnableGridStats = b; }
115
117 virtual void write(const GridCPtrVec&, const MetaMap& = MetaMap()) const {}
118
124 static bool isDelayedLoadingEnabled();
125
126 protected:
129 bool inputHasGridOffsets() const { return mInputHasGridOffsets; }
130 void setInputHasGridOffsets(bool b) { mInputHasGridOffsets = b; }
131
136 void setFormatVersion(std::istream&);
137
143 void setLibraryVersion(std::istream&);
144
147 void setDataCompression(std::istream&);
148
151 void setGridCompression(std::ostream&, const GridBase&) const;
154 static void readGridCompression(std::istream&);
155
157 static int32_t readGridCount(std::istream&);
158
160 static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&);
161 #if OPENVDB_ABI_VERSION_NUMBER >= 3
162 static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&, const BBoxd&);
167 static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&, const CoordBBox&);
168 #endif
169
170 using NamedGridMap = std::map<Name /*uniqueName*/, GridBase::Ptr>;
171
174 void connectInstance(const GridDescriptor&, const NamedGridMap&) const;
175
179 void writeGrid(GridDescriptor&, GridBase::ConstPtr, std::ostream&, bool seekable) const;
184 void writeGridInstance(GridDescriptor&, GridBase::ConstPtr,
185 std::ostream&, bool seekable) const;
186
189 bool readHeader(std::istream&);
193 void writeHeader(std::ostream&, bool seekable) const;
194
196 void write(std::ostream&, const GridPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
198 void write(std::ostream&, const GridCPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
200
201 private:
202 friend class ::TestFile;
203
205 uint32_t mFileVersion;
207 VersionId mLibraryVersion;
209 mutable boost::uuids::uuid mUuid;// needs to be mutable since writeHeader is const!
212 bool mInputHasGridOffsets;
215 bool mEnableInstancing;
217 uint32_t mCompression;
219 bool mEnableGridStats;
220 }; // class Archive
221
222 } // namespace io
223 } // namespace OPENVDB_VERSION_NAME
224 } // namespace openvdb
225
226 #endif // OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
227
228 // Copyright (c) 2012-2018 DreamWorks Animation LLC
229 // All rights reserved. This software is distributed under the
230 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
openvdb::v6_1::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:288
openvdb::v6_1::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:129
Compression.h
MetaMap.h
openvdb::v6_1::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,...
openvdb::v6_1::VersionId
Definition: version.h:233
openvdb::v6_1::io::Archive::Ptr
SharedPtr< Archive > Ptr
Definition: Archive.h:62
openvdb::v6_1::io::Archive::DEFAULT_COMPRESSION_FLAGS
static const uint32_t DEFAULT_COMPRESSION_FLAGS
Definition: Archive.h:65
openvdb::v6_1::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:85
openvdb::v6_1::io::GridDescriptor
Definition: GridDescriptor.h:46
openvdb::v6_1::GridBase
Abstract base class for typed grids.
Definition: Grid.h:104
openvdb::v6_1::math::BBox< Vec3d >
openvdb::v6_1::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:111
openvdb::v6_1::SharedPtr
std::shared_ptr< T > SharedPtr
Definition: Types.h:139
openvdb::v6_1::Name
std::string Name
Definition: Name.h:44
openvdb::v6_1::GridPtrVec
std::vector< GridBase::Ptr > GridPtrVec
Definition: Grid.h:527
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:125
openvdb::v6_1::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:92
openvdb::v6_1::io::Archive::compression
uint32_t compression() const
Return a bit mask specifying compression options for the data stream.
Definition: Archive.h:102
openvdb::v6_1::io::Archive::write
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:117
openvdb::v6_1::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:114
openvdb
Definition: Exceptions.h:40
openvdb::v6_1::GridBase::Ptr
SharedPtr< GridBase > Ptr
Definition: Grid.h:107
openvdb::v6_1::io::Archive::fileVersion
uint32_t fileVersion() const
Return the file format version number of the input stream.
Definition: Archive.h:82
openvdb::v6_1::math::CoordBBox
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:271
openvdb::v6_1::GridCPtrVec
std::vector< GridBase::ConstPtr > GridCPtrVec
Definition: Grid.h:532
openvdb::v6_1::io::Archive::setInputHasGridOffsets
void setInputHasGridOffsets(bool b)
Definition: Archive.h:130
version.h
Library and file format version numbers.
openvdb::v6_1::io::Archive
Grid serializer/unserializer.
Definition: Archive.h:59
Grid.h
openvdb::v6_1::io::Archive::setCompression
void setCompression(uint32_t c)
Specify whether and how the data stream should be compressed.
Definition: Archive.h:107
openvdb::v6_1::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:96
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:177
openvdb::v6_1::io::Archive::NamedGridMap
std::map< Name, GridBase::Ptr > NamedGridMap
Definition: Archive.h:170
openvdb::v6_1::MetaMap
Container that maps names (strings) to values of arbitrary types.
Definition: MetaMap.h:46
openvdb::v6_1::io::Archive::ConstPtr
SharedPtr< const Archive > ConstPtr
Definition: Archive.h:63
Platform.h