ArchiveWriter.h

//-*****************************************************************************
//
// Copyright (c) 2009-2012,
//  Sony Pictures Imageworks Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// *       Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// *       Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// *       Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic, nor the names of their 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 DIRECT, 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.
//
//-*****************************************************************************
 
#ifndef Alembic_AbcCoreAbstract_ArchiveWriter_h
#define Alembic_AbcCoreAbstract_ArchiveWriter_h
 
#include <Alembic/Util/Export.h>
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/MetaData.h>
#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
 
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
 
//-*****************************************************************************
namespace IllustrationOnly {
struct ALEMBIC_EXPORT ArchiveWriterConstructor
{
    // Create an archive writer with the given file name and meta data.
    ArchiveWriterPtr operator()( const std::string &iFileName,
                                 const MetaData &iMetaData );
};
} // End namespace IllustrationOnly
 
//-*****************************************************************************
class ALEMBIC_EXPORT ArchiveWriter
    : private Alembic::Util::noncopyable
{
protected:
    ArchiveWriter()
      : m_compressionHint( -1 ) {}
 
public:
    virtual ~ArchiveWriter();
 
    //-*************************************************************************
    // NEW FUNCTIONS
    //-*************************************************************************

    virtual const std::string &getName() const = 0;

    virtual const MetaData &getMetaData() const = 0;

    virtual ObjectWriterPtr getTop() = 0;

    int8_t getCompressionHint() const { return m_compressionHint; }

    void setCompressionHint( int8_t iCh )
    {
        m_compressionHint = iCh < -1 ? -1 :
            ( iCh > 9 ? 9 : iCh );
    }

    virtual ArchiveWriterPtr asArchivePtr() = 0;

    virtual uint32_t addTimeSampling( const TimeSampling & iTs ) = 0;

    virtual TimeSamplingPtr getTimeSampling( uint32_t iIndex ) = 0;

    virtual uint32_t getNumTimeSamplings() = 0;

    virtual index_t getMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex ) = 0;

    virtual void setMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex,
                                                       index_t iMaxIndex ) = 0;
 
private:
    int8_t m_compressionHint;
};
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace AbcCoreAbstract
} // End namespace Alembic
 
#endif