mlImageFormatTools.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_IMAGE_FORMAT_TOOLS_H
#define ML_IMAGE_FORMAT_TOOLS_H

 
// Resolve platform independencies.
#include "MLImageFormatBaseSystem.h"
 
#include "mlModuleIncludes.h"
#include "mlImageFormatTagList.h"
#include <mlTimeCounter.h>
 
// Implement everything in ML namespace.
ML_START_NAMESPACE

  class MLImageFormatInfos;
  class DataCompressor;
  class MLImageFormatIdxTable;
 
  //----------------------------------------------------------------------
  //----------------------------------------------------------------------
  class MLIMAGEFORMATBASE_EXPORT MLImageFormatTools {
 
  public:
    friend class MLImageFormatSaveHandler;

    enum SaveModeBits {
      DefaultSaveMode      = 0,  
      AllowPartialPages    = 1,  
      SaveOnlyDefaultValue = 2   
    };
 
    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------
    typedef void  MLImageFormatNotifyCB(double      progress,
                                        void        *usrData  
                                       );
 
 
    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------
    static const std::string  ML_FILE_VERSION_STRING;
 
    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------
    static const std::string  ML_FILE_VERSION_STRING_EXT;
 
    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------
    static const size_t       ML_MAX_VERSION_AND_FIRST_PAIR_SIZE;
 
    //----------------------------------------------------------------------
    //
    //
    //----------------------------------------------------------------------

    static MLErrorCode         open(MLImageFormatInfos        *&infos,
                                    const std::string          &fileName,
                                    bool                       truncate                  = false,
                                    const std::string          &compressorName           = "",
                                    const MLImageFormatTagList &compressionTagList       = MLImageFormatTagList::getDefaultEmptyTagList(),
                                    const MLImageFormatTagList &userTagList              = MLImageFormatTagList::getDefaultEmptyTagList(),
                                    const MLImageFormatTagList &privateTagList           = MLImageFormatTagList::getDefaultEmptyTagList(),
                                    const std::string          &defaultVoxelValue        = "0",
                                    bool                       rewritable                = true,
                                    bool                       suppressReadCheckSumTests = false);

    static MLErrorCode         open(MLImageFormatInfos        *&infos,
                                    MLImageFormatAbstractFileHandle* fileHandle,
                                    bool                       truncate = false,
                                    const std::string          &compressorName = "",
                                    const MLImageFormatTagList &compressionTagList = MLImageFormatTagList::getDefaultEmptyTagList(),
                                    const MLImageFormatTagList &userTagList = MLImageFormatTagList::getDefaultEmptyTagList(),
                                    const MLImageFormatTagList &privateTagList = MLImageFormatTagList::getDefaultEmptyTagList(),
                                    const std::string          &defaultVoxelValue = "0",
                                    bool                       rewritable = true,
                                    bool                       suppressReadCheckSumTests = false);

    static MLErrorCode         close(MLImageFormatInfos *&infos);

    static MLErrorCode         save(MLImageFormatInfos             &infos,
                                    PagedImage                     &inputPagedImg,
                                    const SubImageBox              &box            = SubImageBox(),
                                    MLImageFormatNotifyCB          *callback       = nullptr,
                                    void                           *userData       = nullptr,
                                    const ScaleShiftData           &scaleShiftData = ScaleShiftData(),
                                    MLuint32                       saveModeBits    = DefaultSaveMode,
                                    MLdouble                       *saveTime       = nullptr ,
                                    MLdouble                       *prepTime       = nullptr);
 

    static MLErrorCode overwriteHeaderAndPageList(const MLImageFormatInfos &infos,
                                                  MLuint32                  saveModeBits);
 

    static MLErrorCode         overwrite(MLImageFormatInfos         &infos         ,
                                         PagedImage                 &inputPagedImg ,
                                         const SubImageBox          &box           ,
                                         MLImageFormatNotifyCB      *callback      ,
                                         void                       *userData      ,
                                         const ScaleShiftData       &scaleShiftData,
                                         MLuint32                   saveModeBits = DefaultSaveMode,
                                         MLdouble                   *saveTime    = nullptr ,
                                         MLdouble                   *prepTime    = nullptr);

    static MLErrorCode         overwrite(MLImageFormatInfos         &infos         ,
                                         const SubImage             &inputSubImg   ,
                                         MLImageFormatNotifyCB      *callback      ,
                                         void                       *userData      ,
                                         const ScaleShiftData       &scaleShiftData,
                                         MLuint32                   saveModeBits = DefaultSaveMode,
                                         MLdouble                   *saveTime    = nullptr ,
                                         MLdouble                   *prepTime    = nullptr);

    static MLErrorCode         getTile(const MLImageFormatInfos &infos,
                                       SubImage                 &subImgToFill,
                                       bool                      useFileDataType,
                                       bool                      useFileRegion,
                                       const ScaleShiftData     &scaleShiftData);
 

    static MLuint32            calcCheckSum(const void *dataPtr, size_t numBytes, size_t voxSize);

    static void                setDICOMTreeSourceFileName(PagedImage &outImg,
                                                          const std::string &fileName);
 
 
  protected:

    static MLErrorCode  _loadFileProperties(MLImageFormatInfos &infos);

    static MLErrorCode  _destroyFileProperties(MLImageFormatInfos *&infos);

    static MLErrorCode  _loadPage(const MLImageFormatInfos &infos,
                                  MLint                    pageId,
                                  SubImage                 &pageBuf);

    static MLErrorCode _decompressPageData(const MLImageFormatInfos  &infos,
                                           const size_t              savedPageSizeInBytes,
                                           const size_t              expectedSizeInBytes,
                                           MLuint8                  *&loadedPage,
                                           bool                      &isLossy);

    static MLErrorCode _saveIndexTableAndPages(MLImageFormatInfos    &infos,
                                               const SubImageBox     &box,
                                               PagedImage            *inputPagedImg,
                                               const SubImage        *inputSubImg,
                                               MLImageFormatNotifyCB *callback,
                                               void                  *userData,
                                               const ScaleShiftData  &scaleShiftData,
                                               bool                  replaceAreaToSave,
                                               MLuint32              saveModeBits,
                                               MLdouble              *saveTime=nullptr,
                                               MLdouble              *prepTime=nullptr);

    static MLErrorCode _savePage(MLImageFormatInfos    &infos,
                                 const MLint           pageId,
                                 const bool            isOutsideAreaToSave,
                                 const MLTypeData      *defaultVoxelPtr,
                                 const SubImage        &subImgToSave,
                                 const bool            replaceOnlyWrittenPageIds,
                                 const MLuint32        saveModeBits,
                                 TimeCounter           &saveTimer,
                                 MLdouble              &saveTime,
                                 TimeCounter           &calcTimer,
                                 MLdouble              &calcTime);

    static MLErrorCode _compressPageData(DataCompressor *compressor,
                                         SubImage       &dataSubImg,
                                         MLint          &dstBufSize);
 
  };
 
ML_END_NAMESPACE
 
#endif // of __mlImageFormatTools_H