Archive.h

Go to the documentation of this file.

//
// Copyright (c) 2012-2013 DreamWorks Animation LLC
//
// All rights reserved. This software is distributed under the
// Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
//
// Redistributions of source code must retain the above copyright
// and license notice and the following restrictions and disclaimer.
//
// *     Neither the name of DreamWorks Animation nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// IN NO EVENT SHALL THE COPYRIGHT HOLDERS' AND CONTRIBUTORS' AGGREGATE
// LIABILITY FOR ALL CLAIMS REGARDLESS OF THEIR BASIS EXCEED US$250.00.
//

#ifndef OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED
#define OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED

#include <openvdb/Platform.h>
#include <iosfwd>
#include <map>
#include <string>
#include <boost/uuid/uuid.hpp>
#include <boost/cstdint.hpp>
#include <openvdb/Grid.h>
#include <openvdb/metadata/MetaMap.h>
#include <openvdb/version.h> // for VersionId
#include "Compression.h" // for COMPRESS_ZIP, etc.


class TestFile;

namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace io {

class GridDescriptor;


OPENVDB_API uint32_t getFormatVersion(std::istream&);

OPENVDB_API VersionId getLibraryVersion(std::istream&);

OPENVDB_API std::string getVersion(std::istream&);

OPENVDB_API void setCurrentVersion(std::istream&);

OPENVDB_API bool getWriteGridStatsMetadata(std::ostream&);

OPENVDB_API uint32_t getDataCompression(std::ios_base&);

OPENVDB_API uint32_t getGridClass(std::ios_base&);

OPENVDB_API const void* getGridBackgroundValuePtr(std::ios_base&);

OPENVDB_API void setGridBackgroundValuePtr(std::ios_base&, const void* background);


class OPENVDB_API Archive
{
public:
    // Indices into a stream's internal extensible array of values of use to readers and writers
    // (VC9 requires these declarations to be on separate lines.)
    static const int sFormatVersionIndex;
    static const int sLibraryMajorVersionIndex;
    static const int sLibraryMinorVersionIndex;
    static const int sDataCompressionIndex;
    static const int sWriteGridStatsMetadataIndex;
    static const int sGridBackgroundIndex;
    static const int sGridClassIndex;

    static const uint32_t DEFAULT_COMPRESSION_FLAGS;

    Archive();
    virtual ~Archive();

    std::string getUniqueTag() const;
    bool isIdentical(const std::string& uuidStr) const;

    uint32_t fileVersion() const { return mFileVersion; }
    VersionId libraryVersion() const { return mLibraryVersion; }
    std::string version() const;

    bool isInstancingEnabled() const { return mEnableInstancing; }
    void setInstancingEnabled(bool b) { mEnableInstancing = b; }

    bool isCompressionEnabled() const;
    void setCompressionEnabled(bool);

    uint32_t compressionFlags() const { return mCompression; }
    void setCompressionFlags(uint32_t c) { mCompression = c; }

    bool isGridStatsMetadataEnabled() const { return mEnableGridStats; }
    void setGridStatsMetadataEnabled(bool b) { mEnableGridStats = b; }

protected:
    bool inputHasGridOffsets() const { return mInputHasGridOffsets; }
    void setInputHasGridOffsets(bool b) { mInputHasGridOffsets = b; }

    void setFormatVersion(std::istream&);

    void setLibraryVersion(std::istream&);

    void setDataCompression(std::istream&);

    void setGridCompression(std::ostream&, const GridBase&) const;
    static void readGridCompression(std::istream&);

    void setWriteGridStatsMetadata(std::ostream&);

    static int readGridCount(std::istream&);

    static void readGrid(GridBase::Ptr, const GridDescriptor&, std::istream&);

    typedef std::map<Name /*uniqueName*/, GridBase::Ptr> NamedGridMap;

    void connectInstance(const GridDescriptor&, const NamedGridMap&) const;

    void writeGrid(GridDescriptor&, GridBase::ConstPtr, std::ostream&, bool seekable) const;
    void writeGridInstance(GridDescriptor&, GridBase::ConstPtr,
        std::ostream&, bool seekable) const;

    bool readHeader(std::istream&);
    void writeHeader(std::ostream&, bool seekable) const;


    void write(std::ostream&, const GridPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;
    void write(std::ostream&, const GridCPtrVec&, bool seekable, const MetaMap& = MetaMap()) const;

private:
    friend class ::TestFile;

    uint32_t mFileVersion;
    VersionId mLibraryVersion;
    mutable boost::uuids::uuid mUuid;// needs to mutable since writeHeader is const!
    bool mInputHasGridOffsets;
    bool mEnableInstancing;
    uint32_t mCompression;
    bool mEnableGridStats;
}; // class Archive

} // namespace io
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb

#endif // OPENVDB_IO_ARCHIVE_HAS_BEEN_INCLUDED

// Copyright (c) 2012-2013 DreamWorks Animation LLC
// All rights reserved. This software is distributed under the
// Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )