OpenVDB 5.1.0

io.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_IO_HAS_BEEN_INCLUDED
32 #define OPENVDB_IO_IO_HAS_BEEN_INCLUDED
33
34 #include <openvdb/Platform.h>
35 #include <openvdb/Types.h> // for SharedPtr
36 #include <openvdb/version.h>
37 #include <boost/any.hpp>
38 #include <functional>
39 #include <iosfwd> // for std::ios_base
40 #include <map>
41 #include <memory>
42 #include <string>
43
44
45 namespace openvdb {
46 OPENVDB_USE_VERSION_NAMESPACE
47 namespace OPENVDB_VERSION_NAME {
48
49 class MetaMap;
50
51 namespace io {
52
56 class OPENVDB_API StreamMetadata
57 {
58 public:
59 using Ptr = SharedPtr<StreamMetadata>;
60 using ConstPtr = SharedPtr<const StreamMetadata>;
61
62 StreamMetadata();
63 StreamMetadata(const StreamMetadata&);
64 explicit StreamMetadata(std::ios_base&);
65 ~StreamMetadata();
66
67 StreamMetadata& operator=(const StreamMetadata&);
68
71 void transferTo(std::ios_base&) const;
72
73 uint32_t fileVersion() const;
74 void setFileVersion(uint32_t);
75
76 VersionId libraryVersion() const;
77 void setLibraryVersion(VersionId);
78
79 uint32_t compression() const;
80 void setCompression(uint32_t);
81
82 uint32_t gridClass() const;
83 void setGridClass(uint32_t);
84
85 const void* backgroundPtr() const;
86 void setBackgroundPtr(const void*);
87
88 bool halfFloat() const;
89 void setHalfFloat(bool);
90
91 bool writeGridStats() const;
92 void setWriteGridStats(bool);
93
94 bool seekable() const;
95 void setSeekable(bool);
96
97 bool countingPasses() const;
98 void setCountingPasses(bool);
99
100 uint32_t pass() const;
101 void setPass(uint32_t);
102
104 MetaMap& gridMetadata();
110 const MetaMap& gridMetadata() const;
112
113 using AuxDataMap = std::map<std::string, boost::any>;
115 AuxDataMap& auxData();
117 const AuxDataMap& auxData() const;
119
121 std::string str() const;
122
123 private:
124 struct Impl;
125 std::unique_ptr<Impl> mImpl;
126 }; // class StreamMetadata
127
128
130 std::ostream& operator<<(std::ostream&, const StreamMetadata&);
131
132 std::ostream& operator<<(std::ostream&, const StreamMetadata::AuxDataMap&);
133
134
136
137
140 struct MultiPass {};
141
142
144
145
146 class File;
147
149 class OPENVDB_API MappedFile
150 {
151 public:
152 using Ptr = SharedPtr<MappedFile>;
153
154 ~MappedFile();
155 MappedFile(const MappedFile&) = delete; // not copyable
156 MappedFile& operator=(const MappedFile&) = delete;
157
159 std::string filename() const;
160
170 SharedPtr<std::streambuf> createBuffer() const;
171
172 using Notifier = std::function<void(std::string /*filename*/)>;
175 void setNotifier(const Notifier&);
177 void clearNotifier();
178
179 private:
180 friend class File;
181
182 explicit MappedFile(const std::string& filename, bool autoDelete = false);
183
184 class Impl;
185 std::unique_ptr<Impl> mImpl;
186 }; // class MappedFile
187
188
190
191
193 std::string getErrorString(int errorNum);
194
195
197 std::string getErrorString();
198
199
201
202
205 OPENVDB_API uint32_t getFormatVersion(std::ios_base&);
206
209 OPENVDB_API VersionId getLibraryVersion(std::ios_base&);
210
213 OPENVDB_API std::string getVersion(std::ios_base&);
214
216 OPENVDB_API void setCurrentVersion(std::istream&);
217
221 OPENVDB_API void setVersion(std::ios_base&, const VersionId& libraryVersion, uint32_t fileVersion);
222
226 OPENVDB_API uint32_t getDataCompression(std::ios_base&);
230 OPENVDB_API void setDataCompression(std::ios_base&, uint32_t compressionFlags);
231
234 OPENVDB_API uint32_t getGridClass(std::ios_base&);
237 OPENVDB_API void setGridClass(std::ios_base&, uint32_t);
238
241 OPENVDB_API bool getHalfFloat(std::ios_base&);
244 OPENVDB_API void setHalfFloat(std::ios_base&, bool);
245
248 OPENVDB_API const void* getGridBackgroundValuePtr(std::ios_base&);
252 OPENVDB_API void setGridBackgroundValuePtr(std::ios_base&, const void* background);
253
256 OPENVDB_API bool getWriteGridStatsMetadata(std::ios_base&);
259 OPENVDB_API void setWriteGridStatsMetadata(std::ios_base&, bool writeGridStats);
260
263 OPENVDB_API SharedPtr<MappedFile> getMappedFilePtr(std::ios_base&);
267 OPENVDB_API void setMappedFilePtr(std::ios_base&, SharedPtr<MappedFile>&);
268
271 OPENVDB_API SharedPtr<StreamMetadata> getStreamMetadataPtr(std::ios_base&);
279 OPENVDB_API void setStreamMetadataPtr(std::ios_base&,
280 SharedPtr<StreamMetadata>&, bool transfer = true);
283 OPENVDB_API SharedPtr<StreamMetadata> clearStreamMetadataPtr(std::ios_base&);
284
285 } // namespace io
286 } // namespace OPENVDB_VERSION_NAME
287 } // namespace openvdb
288
289 #endif // OPENVDB_IO_IO_HAS_BEEN_INCLUDED
290
291 // Copyright (c) 2012-2018 DreamWorks Animation LLC
292 // All rights reserved. This software is distributed under the
293 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
openvdb::v5_1::io::getErrorString
std::string getErrorString()
Return a string (possibly empty) describing the most recent system error.
openvdb::v5_1::io::operator<<
std::ostream & operator<<(std::ostream &, const StreamMetadata::AuxDataMap &)
openvdb::v5_1::io::getLibraryVersion
OPENVDB_API VersionId getLibraryVersion(std::ios_base &)
Return the (major, minor) library version number associated with the given input stream.
OPENVDB_API
#define OPENVDB_API
Helper macros for defining library symbol visibility.
Definition: Platform.h:194
openvdb::v5_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, COMPRESS_ACTIVE_MASK, etc.) specifying whether and how input data is compressed or output data should be compressed.
openvdb::v5_1::io::StreamMetadata
Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (w...
Definition: io.h:56
openvdb::v5_1::io::getVersion
OPENVDB_API std::string getVersion(std::ios_base &)
Return a string of the form "<major>.<minor>/<format>", giving the library and file format version nu...
Types.h
openvdb::v5_1::io::File
Grid archive associated with a file on disk.
Definition: File.h:57
openvdb::v5_1::io::MappedFile::Ptr
SharedPtr< MappedFile > Ptr
Definition: io.h:152
openvdb::v5_1::VersionId
Definition: version.h:244
openvdb::v5_1::io::StreamMetadata::AuxDataMap
std::map< std::string, boost::any > AuxDataMap
Definition: io.h:113
openvdb::v5_1::io::setMappedFilePtr
OPENVDB_API void setMappedFilePtr(std::ios_base &, SharedPtr< MappedFile > &)
Associate the given stream with (a shared pointer to) a memory-mapped file.
openvdb::v5_1::io::getGridClass
OPENVDB_API uint32_t getGridClass(std::ios_base &)
Return the class (GRID_LEVEL_SET, GRID_UNKNOWN, etc.) of the grid currently being read from or writte...
openvdb::v5_1::io::StreamMetadata::ConstPtr
SharedPtr< const StreamMetadata > ConstPtr
Definition: io.h:60
openvdb::v5_1::io::setGridBackgroundValuePtr
OPENVDB_API void setGridBackgroundValuePtr(std::ios_base &, const void *background)
Specify (a pointer to) the background value of the grid currently being read from or written to the g...
openvdb::v5_1::io::StreamMetadata::Ptr
SharedPtr< StreamMetadata > Ptr
Definition: io.h:59
openvdb::v5_1::io::getDataCompression
OPENVDB_API uint32_t getDataCompression(std::ios_base &)
Return 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::v5_1::io::getWriteGridStatsMetadata
OPENVDB_API bool getWriteGridStatsMetadata(std::ios_base &)
Return true if grid statistics (active voxel count and bounding box, etc.) should be computed and sto...
openvdb::v5_1::SharedPtr
std::shared_ptr< T > SharedPtr
Definition: Types.h:139
openvdb::v5_1::io::clearStreamMetadataPtr
OPENVDB_API SharedPtr< StreamMetadata > clearStreamMetadataPtr(std::ios_base &)
Dissociate the given stream from its metadata object (if it has one) and return a shared pointer to t...
openvdb::v5_1::io::getGridBackgroundValuePtr
OPENVDB_API const void * getGridBackgroundValuePtr(std::ios_base &)
Return a pointer to the background value of the grid currently being read from or written to the give...
openvdb::v5_1::io::getMappedFilePtr
OPENVDB_API SharedPtr< MappedFile > getMappedFilePtr(std::ios_base &)
Return a shared pointer to the memory-mapped file with which the given stream is associated, or a null pointer if the stream is not associated with a memory-mapped file.
openvdb::v5_1::io::setHalfFloat
OPENVDB_API void setHalfFloat(std::ios_base &, bool)
Specify whether floating-point values should be quantized to 16 bits when writing to the given stream...
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:136
openvdb::v5_1::io::setStreamMetadataPtr
OPENVDB_API void setStreamMetadataPtr(std::ios_base &, SharedPtr< StreamMetadata > &, bool transfer=true)
Associate the given stream with (a shared pointer to) an object that stores metadata (file format...
openvdb::v5_1::io::MappedFile
Handle to control the lifetime of a memory-mapped .vdb file.
Definition: io.h:149
openvdb
Definition: Exceptions.h:40
openvdb::v5_1::io::setCurrentVersion
OPENVDB_API void setCurrentVersion(std::istream &)
Associate the current file format and library version numbers with the given input stream...
openvdb::v5_1::io::getHalfFloat
OPENVDB_API bool getHalfFloat(std::ios_base &)
Return true if floating-point values should be quantized to 16 bits when writing to the given stream ...
version.h
Library and file format version numbers.
openvdb::v5_1::io::getStreamMetadataPtr
OPENVDB_API SharedPtr< StreamMetadata > getStreamMetadataPtr(std::ios_base &)
Return a shared pointer to an object that stores metadata (file format, compression scheme...
openvdb::v5_1::io::MappedFile::Notifier
std::function< void(std::string)> Notifier
Definition: io.h:172
openvdb::v5_1::io::MultiPass
Leaf nodes that require multi-pass I/O must inherit from this struct.
Definition: io.h:140
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:188
openvdb::v5_1::io::getFormatVersion
OPENVDB_API uint32_t getFormatVersion(std::ios_base &)
Return the file format version number associated with the given input stream.
openvdb::v5_1::MetaMap
Container that maps names (strings) to values of arbitrary types.
Definition: MetaMap.h:46
openvdb::v5_1::io::setGridClass
OPENVDB_API void setGridClass(std::ios_base &, uint32_t)
Associate with the given stream the class (GRID_LEVEL_SET, GRID_UNKNOWN, etc.) of the grid currently ...
openvdb::v5_1::io::setWriteGridStatsMetadata
OPENVDB_API void setWriteGridStatsMetadata(std::ios_base &, bool writeGridStats)
Specify whether to compute grid statistics (active voxel count and bounding box, etc.) and store them as grid metadata when writing to the given stream.
openvdb::v5_1::io::setVersion
OPENVDB_API void setVersion(std::ios_base &, const VersionId &libraryVersion, uint32_t fileVersion)
Associate specific file format and library version numbers with the given stream. ...
Platform.h