/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmFile.h,v $
  Language:  C++
  Date:      $Date: 2005/01/06 20:03:27 $
  Version:   $Revision: 1.91 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
                                                                                
=========================================================================*/

#ifndef GDCMFILE_H
#define GDCMFILE_H

#include <iostream>
#include "gdcmBase.h"

namespace gdcm 
{
class Header;
class ValEntry;
class BinEntry;
class PixelReadConvert;
class PixelWriteConvert;
class DocEntryArchive;
//-----------------------------------------------------------------------------
/*
 * In addition to Dicom header exploration, this class is designed
 * for accessing the image/volume content. One can also use it to
 * write Dicom/ACR-NEMA/RAW files.
 */
class GDCM_EXPORT File : public Base
{
public:
   enum FileMode
   {
      WMODE_RAW,
      WMODE_RGB
   };
     
public:
   File( );
   File( Header *header );
   File( std::string const &filename );
 
   virtual ~File();

   void Print(std::ostream &os = std::cout); 

   /// Accessor to \ref Header
   Header *GetHeader() { return HeaderInternal; }

   size_t GetImageDataSize();
   size_t GetImageDataRawSize();

   uint8_t *GetImageData();
   uint8_t *GetImageDataRaw();
   size_t GetImageDataIntoVector(void *destination, size_t maxSize);

   void SetImageData(uint8_t *data, size_t expectedSize);

   // User datas
   void SetUserData(uint8_t *data, size_t expectedSize);
   uint8_t* GetUserData();
   size_t GetUserDataSize();
   // RBG datas (from file
   uint8_t* GetRGBData();
   size_t GetRGBDataSize();
   // RAW datas (from file
   uint8_t* GetRawData();
   size_t GetRawDataSize();

   // Write pixels of ONE image on hard drive
   // No test is made on processor "endianity"
   // The user must call his reader correctly
   bool WriteRawData  (std::string const &fileName);
   bool WriteDcmImplVR(std::string const &fileName);
   bool WriteDcmExplVR(std::string const &fileName);
   bool WriteAcr      (std::string const &fileName);
   bool Write         (std::string const &fileName);

   bool SetEntryByNumber(std::string const &content,
                         uint16_t group, uint16_t element);
   bool SetEntryByNumber(uint8_t *content, int lgth,
                         uint16_t group, uint16_t element);
   bool ReplaceOrCreateByNumber(std::string const &content,
                                uint16_t group, uint16_t element);
   bool ReplaceOrCreateByNumber(uint8_t *binArea, int lgth,
                                uint16_t group, uint16_t element);

   uint8_t* GetLutRGBA();

   // Write mode
   void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
   void SetWriteModeToRGB()          { SetWriteMode(WMODE_RGB); };
   void SetWriteMode(FileMode mode)  { WriteMode = mode; };
   FileMode GetWriteMode()           { return WriteMode; };

   // Write format
   void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
   void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
   void SetWriteTypeToAcr()           { SetWriteType(ACR); };
   void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
   void SetWriteType(FileType format) { WriteType = format; };
   FileType GetWriteType()            { return WriteType; };

protected:
   bool CheckWriteIntegrity();

   void SetWriteToRaw();
   void SetWriteToRGB();
   void RestoreWrite();

   void SetWriteFileTypeToACR();
   void SetWriteFileTypeToExplicitVR();
   void SetWriteFileTypeToImplicitVR();
   void RestoreWriteFileType();

   void SetWriteToLibido();
   void SetWriteToNoLibido();
   void RestoreWriteOfLibido();

   ValEntry *CopyValEntry(uint16_t group,uint16_t element);
   BinEntry *CopyBinEntry(uint16_t group,uint16_t element);

private:
   void Initialise();

   uint8_t *GetRaw();

// members variables:
   /// Header to use to load the file
   Header *HeaderInternal;

   /// \brief Whether the underlying \ref Header was loaded by
   ///  the constructor or passed to the constructor. When false
   ///  the destructor is in charge of deletion.
   bool SelfHeader;
   
   /// Wether already parsed or not
   bool Parsed;

   /// Utility pixel converter
   PixelReadConvert *PixelReadConverter;
   PixelWriteConvert *PixelWriteConverter;

   // Utility header archive
   DocEntryArchive *Archive;

   // Write variables
   FileMode WriteMode;
   FileType WriteType;
};
} // end namespace gdcm

//-----------------------------------------------------------------------------
#endif