X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.cxx;h=d3e99c2062ff83f549af69c9ff94646fdd29910b;hb=8afb2999a90aefbce7662c43fe19dad237d49331;hp=d10063e116670656fc3e2c9a36c1d2d5fef8ce4c;hpb=48a606a19c1e2ef88c450156f04114bb43f261c0;p=gdcm.git diff --git a/src/gdcmHeader.cxx b/src/gdcmHeader.cxx index d10063e1..d3e99c20 100644 --- a/src/gdcmHeader.cxx +++ b/src/gdcmHeader.cxx @@ -38,6 +38,7 @@ void gdcmHeader::Initialise(void) { } gdcmHeader::gdcmHeader (const char* InFilename) { + SetMaxSizeLoadElementValue(1024); filename = InFilename; Initialise(); fp=fopen(InFilename,"rw"); @@ -56,32 +57,32 @@ void gdcmHeader::InitVRDict (void) { return; } VRHT *vr = new VRHT; - (*vr)["AE"] = "Application Entity"; // 16 car max - (*vr)["AS"] = "Age String"; // 4 car fixe - (*vr)["AT"] = "Attribute Tag"; // 2 unsigned short int - (*vr)["CS"] = "Code String"; // 16 car max - (*vr)["DA"] = "Date"; // 8 car fixe - (*vr)["DS"] = "Decimal String"; // Decimal codé Binaire 16 max - (*vr)["DT"] = "Date Time"; // 26 car max - (*vr)["FL"] = "Floating Point Single"; // 4 octets IEEE 754:1985 - (*vr)["FD"] = "Floating Point Double"; // 8 octets IEEE 754:1985 - (*vr)["IS"] = "Integer String"; // en format externe 12 max - (*vr)["LO"] = "Long String"; // 64 octets max - (*vr)["LT"] = "Long Text"; // 10240 max - (*vr)["OB"] = "Other Byte String"; - (*vr)["OW"] = "Other Word String"; - (*vr)["PN"] = "Person Name"; - (*vr)["SH"] = "Short String"; // 16 car max - (*vr)["SL"] = "Signed Long"; + (*vr)["AE"] = "Application Entity"; // At most 16 bytes + (*vr)["AS"] = "Age String"; // Exactly 4 bytes + (*vr)["AT"] = "Attribute Tag"; // 2 16-bit unsigned short integers + (*vr)["CS"] = "Code String"; // At most 16 bytes + (*vr)["DA"] = "Date"; // Exactly 8 bytes + (*vr)["DS"] = "Decimal String"; // At most 16 bytes + (*vr)["DT"] = "Date Time"; // At most 26 bytes + (*vr)["FL"] = "Floating Point Single"; // 32-bit IEEE 754:1985 float + (*vr)["FD"] = "Floating Point Double"; // 64-bit IEEE 754:1985 double + (*vr)["IS"] = "Integer String"; // At most 12 bytes + (*vr)["LO"] = "Long String"; // At most 64 chars + (*vr)["LT"] = "Long Text"; // At most 10240 chars + (*vr)["OB"] = "Other Byte String"; // String of bytes (vr independant) + (*vr)["OW"] = "Other Word String"; // String of 16-bit words (vr dep) + (*vr)["PN"] = "Person Name"; // At most 64 chars + (*vr)["SH"] = "Short String"; // At most 16 chars + (*vr)["SL"] = "Signed Long"; // Exactly 4 bytes (*vr)["SQ"] = "Sequence of Items"; // Not Applicable - (*vr)["SS"] = "Signed Short"; // 2 octets - (*vr)["ST"] = "Short Text"; // 1024 car max - (*vr)["TM"] = "Time"; // 16 car max - (*vr)["UI"] = "Unique Identifier"; // 64 car max - (*vr)["UN"] = "Unknown"; - (*vr)["UT"] = "Unlimited Text"; // 2 puissance 32 -1 car max - (*vr)["UL"] = "Unsigned Long "; // 4 octets fixe - (*vr)["US"] = "Unsigned Short "; // 2 octets fixe + (*vr)["SS"] = "Signed Short"; // Exactly 2 bytes + (*vr)["ST"] = "Short Text"; // At most 1024 chars + (*vr)["TM"] = "Time"; // At most 16 bytes + (*vr)["UI"] = "Unique Identifier"; // At most 64 bytes + (*vr)["UL"] = "Unsigned Long "; // Exactly 4 bytes + (*vr)["UN"] = "Unknown"; // Any length of bytes + (*vr)["US"] = "Unsigned Short "; // Exactly 2 bytes + (*vr)["UT"] = "Unlimited Text"; // At most 2^32 -1 chars dicom_vr = vr; } @@ -191,19 +192,19 @@ void gdcmHeader::CheckSwap() switch (s) { case 0x00040000 : - sw=3412; + sw = 3412; filetype = ACR; return; case 0x04000000 : - sw=4321; + sw = 4321; filetype = ACR; return; case 0x00000400 : - sw=2143; + sw = 2143; filetype = ACR; return; case 0x00000004 : - sw=0; + sw = 0; filetype = ACR; return; default : @@ -213,7 +214,7 @@ void gdcmHeader::CheckSwap() // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file. // It is time for despaired wild guesses. So, let's assume this file - // happens to be 'dirty' ACR/NEMA, i.e. the length of the group it + // happens to be 'dirty' ACR/NEMA, i.e. the length of the group is // not present. Then the only info we have is the net2host one. //FIXME Si c'est du RAW, ca degagera + tard @@ -224,6 +225,25 @@ void gdcmHeader::CheckSwap() return; } +void gdcmHeader::SwitchSwapToBigEndian(void) { + dbg.Verbose(1, "gdcmHeader::SwitchSwapToBigEndian", + "Switching to BigEndian mode."); + if ( sw == 0 ) { + sw = 4321; + return; + } + if ( sw == 4321 ) { + sw = 0; + return; + } + if ( sw == 3412 ) { + sw = 2143; + return; + } + if ( sw == 2143 ) + sw = 3412; +} + /** * \ingroup gdcmHeader * \brief recupere la longueur d'un champ DICOM. @@ -264,6 +284,9 @@ void gdcmHeader::CheckSwap() */ void gdcmHeader::FindVR( ElValue *ElVal) { + if (filetype != ExplicitVR) + return; + char VR[3]; string vr; int lgrLue; @@ -277,9 +300,6 @@ void gdcmHeader::FindVR( ElValue *ElVal) { // the case. bool RealExplicit = true; - if (filetype != ExplicitVR) - return; - lgrLue=fread (&VR, (size_t)2,(size_t)1, fp); VR[2]=0; vr = string(VR); @@ -302,8 +322,26 @@ void gdcmHeader::FindVR( ElValue *ElVal) { RealExplicit = false; if ( RealExplicit ) { - if ( ElVal->IsVrUnknown() ) + if ( ElVal->IsVrUnknown() ) { + // When not a dictionary entry, we can safely overwrite the vr. ElVal->SetVR(vr); + return; + } + if ( ElVal->GetVR() == vr ) { + // The vr we just read and the dictionary agree. Nothing to do. + return; + } + // The vr present in the file and the dictionary disagree. We assume + // the file writer knew best and use the vr of the file. Since it would + // be unwise to overwrite the vr of a dictionary (since it would + // compromise it's next user), we need to clone the actual DictEntry + // and change the vr for the read one. + gdcmDictEntry* NewTag = new gdcmDictEntry(ElVal->GetGroup(), + ElVal->GetElement(), + vr, + "FIXME", + ElVal->GetName()); + ElVal->SetDictEntry(NewTag); return; } @@ -321,48 +359,160 @@ void gdcmHeader::FindVR( ElValue *ElVal) { ElVal->SetImplicitVr(); } -void gdcmHeader::FindLength( ElValue * ElVal) { - guint32 length32; +/** + * \ingroup gdcmHeader + * \brief Determines if the Transfer Syntax was allready encountered + * and if it corresponds to a Big Endian one. + * + * @return True when big endian found. False in all other cases. + */ +bool gdcmHeader::IsBigEndianTransferSyntax(void) { + ElValue* Element = PubElVals.GetElement(0x0002, 0x0010); + if ( !Element ) + return false; + LoadElementValueSafe(Element); + string Transfer = Element->GetValue(); + if ( Transfer == "1.2.840.10008.1.2.2" ) + return true; + return false; +} + +void gdcmHeader::FixFoundLength(ElValue * ElVal, guint32 FoudLength) { + // Heuristic: a final fix. + if ( FoudLength == 0xffffffff) + FoudLength = 0; + ElVal->SetLength(FoudLength); +} + +guint32 gdcmHeader::FindLengthOB(void) { + // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data. + guint16 g; + guint16 n; + long PositionOnEntry = ftell(fp); + bool FoundSequenceDelimiter = false; + guint32 TotalLength = 0; + guint32 ItemLength; + + while ( ! FoundSequenceDelimiter) { + g = ReadInt16(); + n = ReadInt16(); + TotalLength += 4; // We even have to decount the group and element + if ( g != 0xfffe ) { + dbg.Verbose(1, "gdcmHeader::FindLengthOB: ", + "wrong group for an item sequence."); + throw Error::FileReadError(fp, "gdcmHeader::FindLengthOB"); + } + if ( n == 0xe0dd ) + FoundSequenceDelimiter = true; + else if ( n != 0xe000) { + dbg.Verbose(1, "gdcmHeader::FindLengthOB: ", + "wrong element for an item sequence."); + throw Error::FileReadError(fp, "gdcmHeader::FindLengthOB"); + } + ItemLength = ReadInt32(); + TotalLength += ItemLength + 4; // We add 4 bytes since we just read + // the ItemLength with ReadInt32 + SkipBytes(ItemLength); + } + fseek(fp, PositionOnEntry, SEEK_SET); + return TotalLength; +} + +void gdcmHeader::FindLength(ElValue * ElVal) { + guint16 element = ElVal->GetElement(); + string vr = ElVal->GetVR(); guint16 length16; - string vr = ElVal->GetVR(); if ( (filetype == ExplicitVR) && ! ElVal->IsImplicitVr() ) { + if ( (vr=="OB") || (vr=="OW") || (vr=="SQ") || (vr=="UN") ) { - - // The following two bytes are reserved, so we skip them, - // and we proceed on reading the length on 4 bytes. - fseek(fp, 2L,SEEK_CUR); - length32 = ReadInt32(); - - } else { - // Length is encoded on 2 bytes. - length16 = ReadInt16(); - - if ( length16 == 0xffff) { - length32 = 0; - } else { - length32 = length16; + // The following reserved two bytes (see PS 3.5-2001, section + // 7.1.2 Data element structure with explicit vr p27) must be + // skipped before proceeding on reading the length on 4 bytes. + fseek(fp, 2L, SEEK_CUR); + guint32 length32 = ReadInt32(); + if ( (vr == "OB") && (length32 == 0xffffffff) ) { + ElVal->SetLength(FindLengthOB()); + return; } + FixFoundLength(ElVal, length32); + return; } - } else { - // Either implicit VR or an explicit VR that (at least for this - // element) lied a little bit. Length is on 4 bytes. - length32 = ReadInt32(); + + // Length is encoded on 2 bytes. + length16 = ReadInt16(); + + // We can tell the current file is encoded in big endian (like + // Data/US-RGB-8-epicard) when we find the "Transfer Syntax" tag + // and it's value is the one of the encoding of a big endian file. + // In order to deal with such big endian encoded files, we have + // (at least) two strategies: + // * when we load the "Transfer Syntax" tag with value of big endian + // encoding, we raise the proper flags. Then we wait for the end + // of the META group (0x0002) among which is "Transfer Syntax", + // before switching the swap code to big endian. We have to postpone + // the switching of the swap code since the META group is fully encoded + // in little endian, and big endian coding only starts at the next + // group. The corresponding code can be hard to analyse and adds + // many additional unnecessary tests for regular tags. + // * the second strategy consist in waiting for trouble, that shall appear + // when we find the first group with big endian encoding. This is + // easy to detect since the length of a "Group Length" tag (the + // ones with zero as element number) has to be of 4 (0x0004). When we + // encouter 1024 (0x0400) chances are the encoding changed and we + // found a group with big endian encoding. + // We shall use this second strategy. In order make sure that we + // can interpret the presence of an apparently big endian encoded + // length of a "Group Length" without committing a big mistake, we + // add an additional check: we look in the allready parsed elements + // for the presence of a "Transfer Syntax" whose value has to be "big + // endian encoding". When this is the case, chances are we got our + // hands on a big endian encoded file: we switch the swap code to + // big endian and proceed... + if ( (element == 0) && (length16 == 1024) ) { + if ( ! IsBigEndianTransferSyntax() ) + throw Error::FileReadError(fp, "gdcmHeader::FindLength"); + length16 = 4; + SwitchSwapToBigEndian(); + // Restore the unproperly loaded values i.e. the group, the element + // and the dictionary entry depending on them. + guint16 CorrectGroup = SwapShort(ElVal->GetGroup()); + guint16 CorrectElem = SwapShort(ElVal->GetElement()); + gdcmDictEntry * NewTag = IsInDicts(CorrectGroup, CorrectElem); + if (!NewTag) { + // This correct tag is not in the dictionary. Create a new one. + NewTag = new gdcmDictEntry(CorrectGroup, CorrectElem); + } + // FIXME this can create a memory leaks on the old entry that be + // left unreferenced. + ElVal->SetDictEntry(NewTag); + } + + // Heuristic: well some files are really ill-formed. + if ( length16 == 0xffff) { + length16 = 0; + dbg.Verbose(0, "gdcmHeader::FindLength", + "Erroneous element length fixed."); + } + FixFoundLength(ElVal, (guint32)length16); + return; } - - // Traitement des curiosites sur la longueur - if ( length32 == 0xffffffff) - length32=0; - - ElVal->SetLength(length32); -} + // Either implicit VR or a non DICOM conformal (see not below) explicit + // VR that ommited the VR of (at least) this element. Farts happen. + // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25 + // on Data elements "Implicit and Explicit VR Data Elements shall + // not coexist in a Data Set and Data Sets nested within it".] + // Length is on 4 bytes. + FixFoundLength(ElVal, ReadInt32()); +} /** * \ingroup gdcmHeader - * \brief remet les octets dans un ordre compatible avec celui du processeur - - * @return longueur retenue pour le champ + * \brief Swaps back the bytes of 4-byte long integer accordingly to + * processor order. + * + * @return The suggested integer. */ guint32 gdcmHeader::SwapLong(guint32 a) { // FIXME: il pourrait y avoir un pb pour les entiers negatifs ... @@ -391,19 +541,31 @@ guint32 gdcmHeader::SwapLong(guint32 a) { /** * \ingroup gdcmHeader * \brief Swaps the bytes so they agree with the processor order - - * @return longueur retenue pour le champ + * @return The properly swaped 16 bits integer. */ guint16 gdcmHeader::SwapShort(guint16 a) { - //FIXME how could sw be equal to 2143 since we never set it this way ? if ( (sw==4321) || (sw==2143) ) a =(((a<<8) & 0x0ff00) | ((a>>8)&0x00ff)); return (a); } -void gdcmHeader::SkipElementValue(ElValue * ElVal) { +void gdcmHeader::SkipBytes(guint32 NBytes) { //FIXME don't dump the returned value - (void)fseek(fp, (long)ElVal->GetLength(), SEEK_CUR); + (void)fseek(fp, (long)NBytes, SEEK_CUR); +} + +void gdcmHeader::SkipElementValue(ElValue * ElVal) { + SkipBytes(ElVal->GetLength()); +} + +void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) { + if (NewSize < 0) + return; + if ((guint32)NewSize >= (guint32)0xffffffff) { + MaxSizeLoadElementValue = 0xffffffff; + return; + } + MaxSizeLoadElementValue = NewSize; } /** @@ -421,25 +583,53 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { guint16 elem = ElVal->GetElement(); string vr = ElVal->GetVR(); guint32 length = ElVal->GetLength(); + bool SkipLoad = false; fseek(fp, (long)ElVal->GetOffset(), SEEK_SET); // Sequences not treated yet ! - if( vr == "SQ" ) { + if( vr == "SQ" ) + SkipLoad = true; + + // Heuristic : a sequence "contains" a set of tags (called items). It looks + // like the last tag of a sequence (the one that terminates the sequence) + // has a group of 0xfffe (with a dummy length). + if( group == 0xfffe ) + SkipLoad = true; + + // The group length doesn't represent data to be loaded in memory, since + // each element of the group shall be loaded individualy. + if( elem == 0 ) + SkipLoad = true; + + if ( SkipLoad ) { + // FIXME the following skip is not necessary SkipElementValue(ElVal); ElVal->SetLength(0); + ElVal->SetValue("gdcm::Skipped"); return; } - // A sequence "contains" a set of tags (called items). It looks like - // the last tag of a sequence (the one that terminates the sequence) - // has a group of 0xfffe (with a dummy length). - if( group == 0xfffe) { - SkipElementValue(ElVal); - ElVal->SetLength(0); + + // When the length is zero things are easy: + if ( length == 0 ) { + ElVal->SetValue(""); + return; + } + + // Values bigger than specified are not loaded. + if (length > MaxSizeLoadElementValue) { + ostringstream s; + s << "gdcm::NotLoaded."; + s << " Address:" << (long)ElVal->GetOffset(); + s << " Length:" << ElVal->GetLength(); + //mesg += " Length:" + ElVal->GetLength(); + ElVal->SetValue(s.str()); return; } - if ( IsAnInteger(group, elem, vr, length) ) { + // When an integer is expected, read and convert the following two or + // four bytes properly i.e. as an integer as opposed to a string. + if ( IsAnInteger(ElVal) ) { guint32 NewInt; if( length == 2 ) { NewInt = ReadInt16(); @@ -463,8 +653,6 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { } NewValue[length]= 0; - // FIXME les elements trop long (seuil a fixer a la main) ne devraient - // pas etre charge's !!!! Voir TODO. item_read = fread(NewValue, (size_t)length, (size_t)1, fp); if ( item_read != 1 ) { g_free(NewValue); @@ -475,6 +663,20 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { ElVal->SetValue(NewValue); } +/** + * \ingroup gdcmHeader + * \brief Loads the element while preserving the current + * underlying file position indicator as opposed to + * to LoadElementValue that modifies it. + * @param ElVal Element whose value shall be loaded. + * @return + */ +void gdcmHeader::LoadElementValueSafe(ElValue * ElVal) { + long PositionOnEntry = ftell(fp); + LoadElementValue(ElVal); + fseek(fp, PositionOnEntry, SEEK_SET); +} + guint16 gdcmHeader::ReadInt16(void) { guint16 g; @@ -529,20 +731,29 @@ ElValue * gdcmHeader::ReadNextElement(void) { } FindVR(NewElVal); - FindLength(NewElVal); + try { FindLength(NewElVal); } + catch ( Error::FileReadError ) { // Call it quits + return (ElValue *)0; + } NewElVal->SetOffset(ftell(fp)); return NewElVal; } -bool gdcmHeader::IsAnInteger(guint16 group, guint16 element, - string vr, guint32 length ) { +bool gdcmHeader::IsAnInteger(ElValue * ElVal) { + guint16 group = ElVal->GetGroup(); + guint16 element = ElVal->GetElement(); + string vr = ElVal->GetVR(); + guint32 length = ElVal->GetLength(); + // When we have some semantics on the element we just read, and if we // a priori know we are dealing with an integer, then we shall be // able to swap it's element value properly. if ( element == 0 ) { // This is the group length of the group - if (length != 4) - dbg.Error("gdcmHeader::ShouldBeSwaped", "should be four"); - return true; + if (length == 4) + return true; + else + dbg.Error("gdcmHeader::IsAnInteger", + "Erroneous Group Length element length."); } if ( group % 2 != 0 )