]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.h
* src/gdcmFile.h : bug fix. Variable type and variable name had same name
[gdcm.git] / src / gdcmFile.h
index 7fd947fb16ea947a2aecfd31b778f4a25d43e91a..f72484188d77d0a8363eaa7d4f457398996aed20 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/20 14:30:40 $
-  Version:   $Revision: 1.64 $
+  Date:      $Date: 2004/12/04 09:41:02 $
+  Version:   $Revision: 1.84 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #define GDCMFILE_H
 
 #include "gdcmCommon.h"
-#include "gdcmHeader.h"
-#include "gdcmPixelConvert.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
@@ -34,6 +37,13 @@ namespace gdcm
  */
 class GDCM_EXPORT File
 {
+public:
+   enum FileMode
+   {
+      WMODE_DECOMPRESSED,
+      WMODE_RGB
+   };
+     
 public:
    File( Header* header );
    File( std::string const& filename );
@@ -43,28 +53,15 @@ public:
    /// Accessor to \ref Header
    Header* GetHeader() { return HeaderInternal; }
 
-   int ComputeDecompressedPixelDataSizeFromHeader();
-
-   /// Accessor to \ref ImageDataSize
-   size_t GetImageDataSize(){ return ImageDataSize; };
-
-   /// Accessor to \ref ImageDataSizeRaw
-   size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
-
-   /// Accessor to \ref PixelConverter
-   PixelConvert* GetPixelConverter(){ return PixelConverter; };
+   size_t GetImageDataSize();
+   size_t GetImageDataRawSize();
 
    uint8_t* GetImageData();
-   size_t GetImageDataIntoVector(void* destination, size_t maxSize);
    uint8_t* GetImageDataRaw();
-   void GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
+   size_t GetImageDataIntoVector(void* destination, size_t maxSize);
 
-   // see also Header::SetImageDataSize ?!?         
    bool SetImageData (uint8_t* data, size_t expectedSize);
 
-   /// \todo When the caller is aware we simply point to the data:
-   /// int SetImageDataNoCopy (void* Data, size_t ExpectedSize);
-
    // Write pixels of ONE image on hard drive
    // No test is made on processor "endianity"
    // The user must call his reader correctly
@@ -72,34 +69,51 @@ public:
    bool WriteDcmImplVR(std::string const& fileName);
    bool WriteDcmExplVR(std::string const& fileName);
    bool WriteAcr      (std::string const& fileName);
+   bool Write(std::string const& fileName);
 
-   virtual bool SetEntryByNumber(std::string const& content,
-                                 uint16_t group, uint16_t element)
-   { 
-      HeaderInternal->SetEntryByNumber(content,group,element);
-      return true;
-   }
+   bool SetEntryByNumber(std::string const& content,
+                                uint16_t group, uint16_t element);
    uint8_t* GetLutRGBA();
-     
+
+   // Write mode
+   void SetWriteModeToDecompressed() { SetWriteMode(WMODE_DECOMPRESSED); };
+   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 WriteBase(std::string const& fileName, FileType type);
+   bool WriteBase(std::string const& fileName);
+   bool CheckWriteIntegrity();
 
-private:
-   void Initialise();
+   void SetWriteToDecompressed();
+   void SetWriteToRGB();
+   void RestoreWrite();
 
-   // For JPEG 8 Bits, body in file gdcmJpeg.cxx
-   bool gdcm_write_JPEG_file    (FILE* fp, void* image_buffer, 
-                                 int image_width, int image_heigh,
-                                 int quality);
+   void SetWriteFileTypeToACR();
+   void SetWriteFileTypeToExplicitVR();
+   void SetWriteFileTypeToImplicitVR();
+   void RestoreWriteFileType();
 
-   // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
-   bool gdcm_write_JPEG_file12  (FILE* fp, void* image_buffer, 
-                                 int image_width, int image_height,
-                                 int quality);
+   void SetWriteToLibido();
+   void SetWriteToNoLibido();
+   void RestoreWriteOfLibido();
 
-   void SaveInitialValues();    // will belong to the future PixelData class
-   void RestoreInitialValues(); // will belong to the future PixelData class
-   void DeleteInitialValues();  // will belong to the future PixelData class 
+   ValEntry* CopyValEntry(uint16_t group,uint16_t element);
+   BinEntry* CopyBinEntry(uint16_t group,uint16_t element);
+
+private:
+   void Initialise();
+
+   uint8_t* GetDecompressed();
+   int ComputeDecompressedPixelDataSizeFromHeader();
 
 private:
 // members variables:
@@ -114,78 +128,17 @@ private:
    
    /// Wether already parsed or not
    bool Parsed;
-      
-   /// Utility pixel converter
-   PixelConvert* PixelConverter;
 
-/// FIXME
-// --------------- Will be moved to a PixelData class
-//
+   /// Utility pixel converter
+   PixelReadConvert* PixelReadConverter;
+   PixelWriteConvert* PixelWriteConverter;
 
-   /// \brief to hold the Pixels (when read)
-   uint8_t* Pixel_Data;  // (was PixelData)
-   
-   /// \brief Size (in bytes) of required memory to hold the Gray Level pixels
-   ///        represented in this file. This is used when the user DOESN'T want
-   ///        the RGB pixels image when it's stored as a PALETTE COLOR image
-   size_t ImageDataSizeRaw;
-   
-   /// \brief Size (in bytes) of requited memory to hold the the pixels
-   ///        of this image in it's RGB convertion either from:
-   ///        - Plane R, Plane G, Plane B 
-   ///        - Grey Plane + Palette Color
-   ///        - YBR Pixels (or from RGB Pixels, as well) 
-   size_t ImageDataSize;
-       
-  /// \brief ==1  if GetImageDataRaw was used
-  ///        ==0  if GetImageData    was used
-  ///        ==-1 if ImageData never read                       
-   int PixelRead;
-
-  /// \brief length of the last allocated area devoided to receive Pixels
-  ///        ( to allow us not to (free + new) if un necessary )     
-   size_t LastAllocatedPixelDataLength; 
-
-  // Initial values of some fields that can be modified during reading process
-  // if user asked to transform gray level + LUT image into RGB image
-     
-  /// \brief Samples Per Pixel           (0x0028,0x0002), as found on disk
-   std::string InitialSpp;
-  /// \brief Photometric Interpretation  (0x0028,0x0004), as found on disk
-   std::string InitialPhotInt;
-  /// \brief Planar Configuration        (0x0028,0x0006), as found on disk   
-   std::string InitialPlanConfig;
-    
-  // Initial values of some fields that can be modified during reading process
-  // if the image was a 'strange' ACR-NEMA 
-  // (Bits Allocated=12, High Bit not equal to Bits stored +1) 
-  /// \brief Bits Allocated              (0x0028,0x0100), as found on disk
-   std::string InitialBitsAllocated;
-  /// \brief High Bit                    (0x0028,0x0102), as found on disk
-   std::string InitialHighBit;
-  
-  // some DocEntry that can be moved out of the H table during reading process
-  // if user asked to transform gray level + LUT image into RGB image
-  // We keep a pointer on them for a future use.
-     
-  /// \brief Red Palette Color Lookup Table Descriptor   0028 1101 as read
-  DocEntry* InitialRedLUTDescr;  
-  /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
-  DocEntry* InitialGreenLUTDescr;
-  /// \brief Blue Palette Color Lookup Table Descriptor  0028 1103 as read
-  DocEntry* InitialBlueLUTDescr;
-  
-  /// \brief Red Palette Color Lookup Table Data         0028 1201 as read
-  DocEntry* InitialRedLUTData;  
-  /// \brief Green Palette Color Lookup Table Data       0028 1202 as read
-  DocEntry* InitialGreenLUTData;
-  /// \brief Blue Palette Color Lookup Table Data        0028 1203 as read
-  DocEntry* InitialBlueLUTData;
-  
-//
-// --------------- end of future PixelData class
-//  
+   // Utility header archive
+   DocEntryArchive *Archive;
 
+   // Write variables
+   FileMode WriteMode;
+   FileType WriteType;
 };
 } // end namespace gdcm