RawImageFile.h

// RawImageFile.h:
// ---------------
//

#ifndef __IPSDKIMAGEFILE_RAWIMAGEFILE_H__
#define __IPSDKIMAGEFILE_RAWIMAGEFILE_H__

// suppression warnings
// warning C4251: 'ipsdk::image::file::RawImageFile::_stream' : class 'std::basic_fstream<_Elem,_Traits>' needs to have dll-interface to be used by clients of class 'ipsdk::image::file::RawImageFile'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImageFile/IPSDKImageFileExports.h>
#include <IPSDKImage/Accessor/BaseDiskImageAccessor.h>
#include <boost/tuple/tuple.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/thread.hpp>
#include <fstream>
#include <map>
#include <vector>

namespace ipsdk {
namespace image {
namespace file {


class IPSDKIMAGEFILE_API RawImageFile : public BaseDiskImageAccessor
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKImageFile, RawImageFile);

public:
    RawImageFile();
    ~RawImageFile();

// methods
public:
    bool                    hasBinary8BitsStorage() const;

    BoolResult              createFile(const boost::filesystem::path& filePath,
                                       const BaseImageGeometry& geometry,
                                       const std::string& headerData = std::string());

    BoolResult              openFile(const boost::filesystem::path& filePath,
                                     const eImageAccessMode& accessMode,
                                     const ipUInt64 dataStartOffset,
                                     const BaseImageGeometry& geometry);

    BoolResult              openSharedRemoteFile(const boost::filesystem::path& filePath,
                                                 const eImageAccessMode& accessMode,
                                                 const ipUInt64 dataStartOffset,
                                                 const BaseImageGeometry& geometry);

protected:
    BoolResult              openFileInternal(const boost::filesystem::path& filePath,
                                             const eImageAccessMode& accessMode,
                                             const ipUInt64 dataStartOffset,
                                             const BaseImageGeometry& geometry,
                                             const bool bSharedRemoteAccess);

    ipUInt64                processOffsets(const ipUInt64 dataStartOffset,
                                           const BaseImageGeometry& geometry);

    BoolResult              resizeData(const BaseImageGeometry& geometry);

    BoolResult              readRawData(const ipUInt64 zPlanIdx,
                                        const ipUInt64 cPlanIdx,
                                        const ipUInt64 tPlanIdx,
                                        const ipUInt64 pixelStartOffset,
                                        const ipUInt64 nbPixels,
                                        void* pData) const;

    BoolResult              writeRawData(const ipUInt64 zPlanIdx,
                                         const ipUInt64 cPlanIdx,
                                         const ipUInt64 tPlanIdx,
                                         const ipUInt64 pixelStartOffset,
                                         const ipUInt64 nbPixels,
                                         const void* pData);

    void                    clearDerived();

    typedef boost::shared_ptr<std::fstream> FStreamPtr;

    BoolResult              findThreadFStream(FStreamPtr& pFStream) const;

// attributes
protected:
    typedef boost::tuple<ipUInt64, ipUInt64, ipUInt64> PlanIdentifier;

    typedef std::map<PlanIdentifier, ipUInt64> OffsetColl;

    OffsetColl              _offsetColl;

    typedef std::map<boost::thread::id, FStreamPtr> FStreamColl;

    mutable FStreamColl     _fStreamColl;

    void*                   _handle;

    mutable boost::mutex    _mutex;
};


} // end of namespace file
} // end of namespace image
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGEFILE_RAWIMAGEFILE_H__