]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.cxx
Port Mathieu's commit from gdcm1.2
[gdcm.git] / src / gdcmDocument.cxx
index c2754559da0d9946c7ea82506abc8bcb0f8401ff..bd497da659500399d7fe77450548d686606f53b2 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2007/05/23 14:18:09 $
-  Version:   $Revision: 1.358 $
+  Date:      $Date: 2007/12/05 16:36:21 $
+  Version:   $Revision: 1.376 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -50,7 +50,7 @@ const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
 
 /**
  * \brief This default constructor neither loads nor parses the file. 
- *        You should then invoke \ref Document::Load.
+ *        You should then invoke Document::Load.
  *         
  */
 Document::Document() 
@@ -70,6 +70,8 @@ Document::Document()
    LoadMode = LD_ALL; // default : load everything, later
    
    SetFileName("");
+   changeFromUN=false;
+   UnexpectedEOF=false;
 }
 
 /**
@@ -279,9 +281,10 @@ bool Document::DoTheLoadingDocumentJob(  )
    //
    std::string RecCode;
    RecCode = GetEntryString(0x0008, 0x0010); // recognition code (RET)
-   if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
-       RecCode == "CANRME_AILIBOD1_1." )  // for brain-damaged softwares
-                                          // with "little-endian strings"
+   
+   if(RecCode.find("ACRNEMA_LIBIDO") == 0 || // any version
+      RecCode.find("CANRME_AILIBOD") == 0)   // for brain-damaged softwares
+                                             // with "little-endian strings"
    {
          Filetype = ACR_LIBIDO; 
          std::string rows    = GetEntryString(0x0028, 0x0010);
@@ -580,7 +583,7 @@ double Document::SwapDouble(double a)
 //
 // -----------------File I/O ---------------
 /**
- * \brief  Tries to open the file \ref Document::Filename and
+ * \brief  Tries to open the file Document::Filename and
  *         checks the preamble when existing,
  *         or if the file starts with an ACR-NEMA look-like element.
  * @return The FILE pointer on success, 0 on failure. 
@@ -691,7 +694,7 @@ bool Document::CloseFile()
  * @param filetype Type of the File to be written 
  *          (ACR-NEMA, ExplicitVR, ImplicitVR)
  */
-void Document::WriteContent(std::ofstream *fp, FileType filetype)
+void Document::WriteContent(std::ofstream *fp, FileType filetype, bool, bool)
 {
    // Skip if user wants to write an ACR-NEMA file
 
@@ -719,8 +722,10 @@ void Document::WriteContent(std::ofstream *fp, FileType filetype)
     * --> was too much tricky / we were [in a hurry / too lazy]
     * --> We don't write the element 0x0000 (group length)
     */
-
-   ElementSet::WriteContent(fp, filetype); // This one is recursive
+ // This one is recursive
+ // false : outside MetaElements
+ // false : outside Sequence
+   ElementSet::WriteContent(fp, filetype, false, false);
 }
 
 // -----------------------------------------
@@ -849,7 +854,7 @@ void Document::LoadEntryBinArea(DataEntry *entry)
 //}
 
 /**
- * \brief   Compares two documents, according to \ref DicomDir rules
+ * \brief   Compares two documents, according to DicomDir rules
  * \warning Does NOT work with ACR-NEMA files
  * \todo    Find a trick to solve the pb (use RET fields ?)
  * @param   document to compare with current one
@@ -918,7 +923,7 @@ bool Document::operator<(Document &document)
 
 /**
  * \brief Reads a given length of bytes
- *       (in order to avoid to many CPU time consuming fread-s)
+ *       (in order to avoid to many CPU time-consuming fread-s)
  * @param l length to read 
  */
 void Document::ReadBegBuffer(size_t l)
@@ -1031,10 +1036,10 @@ int Document::ComputeGroup0002Length( )
             vr = entry->GetVR();
 
             //if ( (vr == "OB")||(vr == "OW")||(vr == "UT")||(vr == "SQ"))
-            // (no SQ, OW, UT in group 0x0002;)
+            // (no SQ, OW, OL, UT in group 0x0002;)
                if ( vr == "OB" ) 
                {
-                  // explicit VR AND (OB, OW, SQ, UT) : 4 more bytes
+                  // explicit VR AND (OB, OW, OL, SQ, UT, UN) : 4 more bytes
                   groupLength +=  4;
                }
             groupLength += 2 + 2 + 4 + entry->GetLength();   
@@ -1282,11 +1287,11 @@ void Document::ParseDES(DocEntrySet *set, long offset,
                                << " at offset 0x(" << std::hex
                                << newDocEntry->GetOffset() << ")");
 
-            ParseSQ( newSeqEntry, 
-                     newDocEntry->GetOffset(),
-                     l, delim_mode_intern);
+            bool res = ParseSQ( newSeqEntry, 
+                         newDocEntry->GetOffset(),
+                         l, delim_mode_intern);
 
-            gdcmDebugMacro( "Exit from ParseSQ, delim " << delim_mode_intern);
+            gdcmDebugMacro( "Exit from ParseSQ, delim " << delim_mode_intern << " -->return : " << res);
          }
          if ( !set->AddEntry( newSeqEntry ) )
          {
@@ -1318,15 +1323,18 @@ void Document::ParseDES(DocEntrySet *set, long offset,
          newDocEntry->Delete();
       }
       first = false;
+      
+      if (UnexpectedEOF) // some terminator was missing
+         break;
    }                               // end While
    gdcmDebugMacro( "Exit from ParseDES, delim-mode " << delim_mode );
 }
 
 /**
  * \brief   Parses a Sequence ( SeqEntry after SeqEntry)
- * @return  parsed length for this level
+ * @return  false if expected fff0,e000 not found
  */ 
-void Document::ParseSQ( SeqEntry *seqEntry,
+bool Document::ParseSQ( SeqEntry *seqEntry,
                         long offset, long l_max, bool delim_mode)
 {
    int SQItemNumber = 0;
@@ -1339,9 +1347,11 @@ void Document::ParseSQ( SeqEntry *seqEntry,
       DocEntry *newDocEntry = ReadNextDocEntry();
 
       if ( !newDocEntry )
-      {
+      { 
+         // The most frequent is when a SQ terminator is missing (?!?)
          gdcmWarningMacro("in ParseSQ : should never get here!");
-         break;
+         UnexpectedEOF = true;
+         return false;
       }
       if ( delim_mode )
       {
@@ -1389,6 +1399,7 @@ void Document::ParseSQ( SeqEntry *seqEntry,
          break;
       }
    }
+   return true;
 }
 
 /**
@@ -1502,20 +1513,30 @@ void Document::FindDocEntryLength( DocEntry *entry )
 {
    const VRKey &vr  = entry->GetVR();
    uint16_t length16;       
-   
    if ( Filetype == ExplicitVR && !entry->IsImplicitVR() ) 
    {
-      if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UT" 
-                                                           || vr == "UN" )
+   
+   // WARNING :
+   //
+   // For some images, length of UN elements is coded on 2 bytes (instead of 4)
+   // There are *not* readable !
+   // You can make a quick and dirty patch, commenting out 
+   //| vr == "UN"
+   // in the following line.
+   // (the 'straight' images will no longer be readable ...)
+   
+      if ( vr == "OB" || vr == "OW" || vr == "OL" || vr == "SQ" || vr == "UT" 
+                                                          || vr == "UN" || changeFromUN == true)
       {
+         changeFromUN = false;
          // The following reserved two bytes (see PS 3.5-2003, section
          // "7.1.2 Data element structure with explicit vr", p 27) must be
          // skipped before proceeding on reading the length on 4 bytes.
 
-         //Fp->seekg( 2L, std::ios::cur); // Once per OW,OB,SQ DocEntry
-         uint32_t length32 = ReadInt32(); // Once per OW,OB,SQ DocEntry
+         //Fp->seekg( 2L, std::ios::cur); // Once per OB,OW,OL,UT,UN,SQ DocEntry
+         uint32_t length32 = ReadInt32(); // Once per OB,OW,OL,UT,UN,SQ DocEntry
          CurrentOffsetPosition+=4;
-         if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff ) 
+         if ( (vr == "OB" || vr == "OW" || vr == "OL") && length32 == 0xffffffff ) 
          {
             uint32_t lengthOB;
             try 
@@ -1549,11 +1570,9 @@ void Document::FindDocEntryLength( DocEntry *entry )
          FixDocEntryFoundLength(entry, length32); 
          return;
       }
-
       // Length is encoded on 2 bytes.
       //length16 = ReadInt16();
       length16 = GetInt16();
-
       // 0xffff means that we deal with 'No Length' Sequence 
       //        or 'No Length' SQItem
       if ( length16 == 0xffff) 
@@ -1603,7 +1622,8 @@ uint32_t Document::FindDocEntryLengthOBOrOW()
       uint16_t elem;
 
       try
-      {
+      {  ///\todo make sure there is never OL encoded pixel data!
+      
          //group = ReadInt16(); // Once per fragment (if any) of OB,OW DataElements
          //elem  = ReadInt16(); // Once per fragment (if any) of OB,OW DataElements 
          ReadBegBuffer(4); // Once per fragment (if any) of OB,OW DataElements
@@ -1737,7 +1757,7 @@ void Document::SkipDocEntry(DocEntry *entry)
 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry) 
 {
    long l = currentDocEntry->GetReadLength();
-   if ( l == -1 ) // length = 0xffff shouldn't appear here ...
+   if ( (uint32_t) l == (uint32_t)-1 ) // length = 0xffff shouldn't appear here ...
                   // ... but PMS imagers happen !
       return;
    Fp->seekg((size_t)(currentDocEntry->GetOffset()), std::ios::beg); //FIXME :each DocEntry
@@ -2062,8 +2082,7 @@ bool Document::CheckSwap()
          s16 = *((uint16_t *)(deb));
  
          gdcmDebugMacro("not a DicomV3 nor a 'clean' ACR/NEMA;"
-                     << " (->despaired wild guesses !)"); 
-      
+                     << " (->despaired wild guesses !)");       
          switch ( s16 )
          {
             case 0x0001 :
@@ -2091,9 +2110,48 @@ bool Document::CheckSwap()
                Filetype = ACR;
                return true;
             default :
-               gdcmWarningMacro("ACR/NEMA unfound swap info (Hopeless !)");
-               Filetype = Unknown;
-               return false;
+    
+               s16 = *((uint16_t *)(deb));
+               if (s16 != 0x0000)
+                   return false;
+               s16 = *((uint16_t *)(deb+2));
+
+               Fp->seekg ( 0L, std::ios::beg); // Once per Document
+               CurrentOffsetPosition = 0;
+               switch(s16)  // try an other trick!
+                            // -> to be able to decode 0029|1010 DataElement
+                            // -> and be not less cleaver than dcmdump ;-)
+               {
+                  case 0x0004 :
+                     SwapCode = 1234; 
+                     break;
+                  case 0x0400 :
+                     SwapCode = 3412;
+                     break;      
+                  default:
+                     gdcmWarningMacro("ACR/NEMA unfound swap info (Hopeless !)");
+                     Filetype = Unknown;
+                     return false;
+               }
+               // Check if next 2 bytes are a VR
+               // Probabely something more time-consuming exists with std::string
+               const char VRvalues[] = "AEASATCSDADTFLFDISLOLTPNSHSLSSSTTMUIULUSUTOBOWOLOFATUNSQRT";
+               int nbVal = 29;
+               const char *pt = VRvalues;
+               for (int i=0;i<nbVal;i++)
+               {
+                  if(*(deb+4) == *pt++) {
+                    if(*(deb+5) == *pt++) {
+                       Filetype = ExplicitVR;
+                       return true;
+                    }
+                    else {
+                       pt++;
+                    }
+                 }
+              }
+              Filetype = ImplicitVR;
+              return true;       
          }
    }
 }
@@ -2164,9 +2222,10 @@ DocEntry *Document::ReadNextDocEntry()
       return 0;
    }
    
+   changeFromUN = false;
    CurrentGroup = GetInt16();
    CurrentElem  = GetInt16();
-   
+      
    // In 'true DICOM' files Group 0002 is always little endian
    if ( HasDCMPreamble )
    {
@@ -2191,18 +2250,39 @@ DocEntry *Document::ReadNextDocEntry()
          realVR = "UL";
       }
 
-      // Commented out in order not to generate 'Shadow Groups' where some 
+      // Was commented out in order not to generate 'Shadow Groups' where some 
       // Data Elements are Explicit VR and some other ones Implicit VR
-      // (Stupid MatLab DICOM Reader couldn't read gdcm-written images)
-      /*
-      else if (CurrentGroup%2 == 1 &&  
-                               (CurrentElem >= 0x0010 && CurrentElem <=0x00ff ))
-      {  
-      // DICOM PS 3-5 7.8.1 a) states that those 
-      // (gggg-0010->00FF where gggg is odd) attributes have to be LO
-         realVR = "LO";
+      // -> Better we fix the problem at Write time
+     
+      else if (CurrentGroup%2 == 1 )
+      { 
+         if (CurrentElem >= 0x0010 && CurrentElem <=0x00ff )
+         {
+            // DICOM PS 3-5 7.8.1 a) states that :
+            // Private Creator Data Elements numbered (gggg,0010-00FF) (gggg is odd)
+            // attributes have to be LO (Long String) and the VM shall be equal to 1
+            realVR = "LO";
+    
+            // Seems not to be true
+            // Still in gdcmtk, David Clunnie disagrees, Marco Eichelberg says it's OK ...
+            // We let it for a while? 
+            //(We should check length==4, for more security, but we don't have it yet !)
+         }
+         else if ( CurrentElem == 0x0001)
+         {
+            realVR = "UL"; // Private Group Length To Eng
+         }
+         else  // check the private dictionary for shadow elements when Implicit VR!
+         {
+            DictEntry *dictEntry = GetDictEntry(CurrentGroup,CurrentElem);
+            if ( dictEntry )
+            {
+               realVR = dictEntry->GetVR(); 
+               dictEntry->Unregister(); // GetDictEntry registered it
+            }   
+         }               
       }
-      */
+      
       else
       {
          DictEntry *dictEntry = GetDictEntry(CurrentGroup,CurrentElem);//only when ImplicitVR
@@ -2214,6 +2294,28 @@ DocEntry *Document::ReadNextDocEntry()
       }
    }
 
+   // if UN found, let's check the dictionary, and trust it!
+   // (maybe a private dictionary exists?)    
+   else if (vr == "UN")
+   {
+      DictEntry *dictEntry = GetDictEntry(CurrentGroup,CurrentElem);
+      if ( dictEntry )
+      {
+         realVR = dictEntry->GetVR();                   
+         dictEntry->Unregister(); // GetDictEntry registered it
+
+         // for VR = "UN", length is always stored on 4 bytes.
+         // remember this info, in order not to crash later
+         changeFromUN=true;
+         /// \todo : fixme If inside a vr = "UN" DataElement (but SQ according to a private dictionnary)
+         ///         there is some more vr = "UN" DataElements, it will probabely fail.
+         ///         --> find a -non time consuming- trick to store changeFromUN info at DataElement level,
+         ///         not at the Document level.
+         /// --> ?!? JPR
+  
+      }   
+   }
+
    DocEntry *newEntry;
    //if ( Global::GetVR()->IsVROfSequence(realVR) )
    if (realVR == "SQ")