src/gdcmDocument.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocument.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/07/07 16:37:41 $
   7   Version:   $Revision: 1.114 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDOCUMENT_H
  20 #define GDCMDOCUMENT_H
  21
  22 #include "gdcmVR.h"
  23 #include "gdcmDict.h"
  24 #include "gdcmElementSet.h"
  25 #include "gdcmException.h"
  26
  27 #include <map>
  28 #include <list>
  29 #include <fstream>
  30
  31 #define NO_SEQ        0x00000001  // Don't load odd groups
  32 #define NO_SHADOW     0x00000002  // Don't load Sequences
  33 #define NO_SHADOWSEQ  0x00000004  // Don't load Sequences if they belong to odd group
  34                                   // (*exclusive* from NO_SEQ and NO_SHADOW)
  35 namespace gdcm
  36 {
  37 class ValEntry;
  38 class BinEntry;
  39 class SeqEntry;
  40 class Dict;
  41
  42 //-----------------------------------------------------------------------------
  43 /**
  44  * \brief Derived by both gdcm::File and gdcm::DicomDir
  45  */
  46 class GDCM_EXPORT Document : public ElementSet
  47 {
  48 public:
  49
  50 typedef std::list<Element> ListElements;
  51
  52 // Loading
  53    virtual bool Load( std::string const &filename );
  54    virtual bool Load( );
  55
  56 // Dictionaries
  57    Dict *GetPubDict();
  58    Dict *GetShaDict();
  59    bool SetShaDict(Dict *dict);
  60    bool SetShaDict(DictKey const &dictName);
  61
  62 // Informations contained in the gdcm::Document
  63    virtual bool IsReadable();
  64    bool IsDicomV3();
  65    bool IsPapyrus();
  66    FileType GetFileType();
  67    std::string GetTransferSyntax();
  68    /// Return the Transfer Syntax as a string
  69    std::string GetTransferSyntaxName();
  70
  71 // Swap code
  72    /// 'Swap code' accessor (see \ref SwapCode )
  73    int GetSwapCode() { return SwapCode; }
  74    // System access (meaning endian related !?)
  75    uint16_t SwapShort(uint16_t);
  76    uint32_t SwapLong(uint32_t);
  77    /// \brief  Unswaps back the bytes of 2-bytes long integer
  78    ///         so they agree with the processor order.
  79    uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
  80    /// \brief  Unswaps back the bytes of 4-byte long integer
  81    ///         so they agree with the processor order.
  82    uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
  83
  84 // File I/O
  85    /// Accessor to \ref Filename
  86    const std::string &GetFileName() const { return Filename; }
  87    /// Accessor to \ref Filename
  88    void SetFileName(std::string const &fileName) { if (Filename != fileName)
  89                                  Filename = fileName, IsDocumentModified = true; }
  90
  91    std::ifstream *OpenFile();
  92    bool CloseFile();
  93    void WriteContent( std::ofstream *fp, FileType type );
  94
  95 // Content entries
  96    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
  97    virtual void LoadEntryBinArea(BinEntry *entry);
  98
  99    void LoadDocEntrySafe(DocEntry *entry);
 100
 101 // Ordering of Documents
 102    bool operator<(Document &document);
 103
 104 /**
 105  * \brief Sets the LoadMode as a boolean string.
 106  *        NO_SEQ, NO_SHADOW, NO_SHADOWSEQ
 107  ... (nothing more, right now)
 108  *        WARNING : before using NO_SHADOW, be sure *all* your files
 109  *        contain accurate values in the 0x0000 element (if any)
 110  *        of *each* Shadow Group. The parser will fail if the size is wrong !
 111  * @param   mode Load mode to be used
 112  */
 113    void SetLoadMode (int mode) { if (LoadMode != mode)
 114                                    LoadMode = mode, IsDocumentModified = true; }
 115
 116 protected:
 117 // Methods
 118    // Constructor and destructor are protected to forbid end user
 119    // to instanciate from this class Document (only gdcm::File and
 120    // gdcm::DicomDir are meaningfull).
 121    Document();
 122    Document( std::string const &filename );
 123    virtual ~Document();
 124
 125    uint16_t ReadInt16() throw ( FormatError );
 126    uint32_t ReadInt32() throw ( FormatError );
 127    void     SkipBytes(uint32_t);
 128    int ComputeGroup0002Length( FileType filetype );
 129
 130 // Variables
 131    /// Refering underlying filename.
 132    std::string Filename;
 133
 134    /// \brief Swap code gives an information on the byte order of a
 135    ///  supposed to be an int32, as it's read on disc
 136    /// (depending on the image Transfer Syntax *and* on the processor endianess)
 137    /// as opposed as it should in memory to be dealt as an int32.
 138    /// For instance :
 139    /// - a 'Little Endian' image, read with a little endian processor
 140    /// will have a SwapCode= 1234 (the order is OK; nothing to do)
 141    /// - a 'Little Endian' image, read with a big endian procesor
 142    /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
 143    /// swapped)
 144    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
 145    /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
 146    int SwapCode;
 147
 148    ///\brief whether we already parsed group 0002 (Meta Elements)
 149    bool Group0002Parsed;
 150
 151    ///\brief whether file has a DCM Preamble
 152    bool HasDCMPreamble;
 153
 154    /// File Pointer, opened during Document parsing.
 155    std::ifstream *Fp;
 156
 157    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
 158    FileType Filetype;
 159
 160    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
 161    static const unsigned int HEADER_LENGTH_TO_READ;
 162    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
 163    /// are NOT loaded.
 164    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
 165
 166    /// List of elements to Anonymize
 167    ListElements AnonymizeList;
 168
 169    /// \brief Bit string integer (each one considered as a boolean)
 170    ///        Bit 0 : Skip Sequences,    if possible
 171    ///        Bit 1 : Skip Shadow Groups if possible
 172    ///        Probabely, some more to add
 173    int LoadMode;
 174
 175    /// Whether the gdcm::Document is already parsed/loaded
 176    /// - False from the creation of the gdcm::Document untill
 177    ///   gdcm::Document:Load()
 178    bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now
 179
 180    bool IsDocumentModified;
 181
 182 private:
 183 // Methods
 184    void Initialize();
 185    bool DoTheLoadingDocumentJob();
 186    // Read
 187    void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
 188    void ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);
 189
 190    void LoadDocEntry         (DocEntry *e);
 191    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
 192    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
 193    std::string FindDocEntryVR();
 194    bool CheckDocEntryVR      (VRKey k);
 195
 196    std::string GetDocEntryValue  (DocEntry *entry);
 197    std::string GetDocEntryUnvalue(DocEntry *entry);
 198
 199    void SkipDocEntry          (DocEntry *entry);
 200    void SkipToNextDocEntry    (DocEntry *entry);
 201
 202    void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
 203    bool IsDocEntryAnInteger   (DocEntry *entry);
 204
 205    bool CheckSwap();
 206    void SwitchByteSwapCode();
 207    void SetMaxSizeLoadEntry(long);
 208
 209    // DocEntry related utilities
 210    DocEntry *ReadNextDocEntry();
 211
 212    void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
 213    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 214
 215 // Variables
 216    /// Public dictionary used to parse this header
 217    Dict *RefPubDict;
 218    /// \brief Optional "shadow dictionary" (private elements) used to parse
 219    /// this header
 220    Dict *RefShaDict;
 221
 222    /// \brief Size threshold above which an element value will NOT be loaded
 223    /// in memory (to avoid loading the image/volume itself). By default,
 224    /// this upper bound is fixed to 1024 bytes (which might look reasonable
 225    /// when one considers the definition of the various VR contents).
 226    uint32_t MaxSizeLoadEntry;
 227
 228 //  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 229 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 230 //                                  DocEntrySet *set );
 231
 232 };
 233
 234 } // end namespace gdcm
 235
 236 //-----------------------------------------------------------------------------
 237 #endif