src/gdcmPixelReadConvert.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmPixelReadConvert.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/17 01:14:33 $
   7   Version:   $Revision: 1.29 $
   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 //////////////////   TEMPORARY NOTE
  20 // look for "fixMem" and convert that to a member of this class
  21 // Removing the prefix fixMem and dealing with allocations should do the trick
  22 //
  23 // grep PixelReadConvert everywhere and clean up !
  24
  25 #include "gdcmDebug.h"
  26 #include "gdcmHeader.h"
  27 #include "gdcmGlobal.h"
  28 #include "gdcmTS.h"
  29 #include "gdcmPixelReadConvert.h"
  30 #include "gdcmDocEntry.h"
  31 #include "gdcmRLEFramesInfo.h"
  32 #include "gdcmJPEGFragmentsInfo.h"
  33
  34 #include <fstream>
  35 #include <stdio.h> //for sscanf
  36
  37 namespace gdcm
  38 {
  39 #define str2num(str, typeNum) *((typeNum *)(str))
  40
  41
  42 //-----------------------------------------------------------------------------
  43 // Constructor / Destructor
  44 PixelReadConvert::PixelReadConvert()
  45 {
  46    RGB = 0;
  47    RGBSize = 0;
  48    Raw = 0;
  49    RawSize = 0;
  50    LutRGBA = 0;
  51    LutRedData = 0;
  52    LutGreenData = 0;
  53    LutBlueData =0;
  54 }
  55
  56 void PixelReadConvert::Squeeze()
  57 {
  58    if ( RGB )
  59    {
  60       delete [] RGB;
  61    }
  62    RGB = 0;
  63
  64    if ( Raw )
  65    {
  66       delete [] Raw;
  67    }
  68    Raw = 0;
  69
  70    if ( LutRGBA )
  71    {
  72       delete [] LutRGBA;
  73    }
  74    LutRGBA = 0;
  75 }
  76
  77 PixelReadConvert::~PixelReadConvert()
  78 {
  79    Squeeze();
  80 }
  81
  82 void PixelReadConvert::AllocateRGB()
  83 {
  84   if ( RGB ) {
  85      delete [] RGB;
  86   }
  87   RGB = new uint8_t[ RGBSize ];
  88 }
  89
  90 void PixelReadConvert::AllocateRaw()
  91 {
  92   if ( Raw ) {
  93      delete [] Raw;
  94   }
  95   Raw = new uint8_t[ RawSize ];
  96 }
  97
  98 /**
  99  * \brief Read from file a 12 bits per pixel image and decompress it
 100  *        into a 16 bits per pixel image.
 101  */
 102 void PixelReadConvert::ReadAndDecompress12BitsTo16Bits( std::ifstream *fp )
 103                throw ( FormatError )
 104 {
 105    int nbPixels = XSize * YSize;
 106    uint16_t* localDecompres = (uint16_t*)Raw;
 107
 108    for( int p = 0; p < nbPixels; p += 2 )
 109    {
 110       uint8_t b0, b1, b2;
 111
 112       fp->read( (char*)&b0, 1);
 113       if ( fp->fail() || fp->eof() )//Fp->gcount() == 1
 114       {
 115          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 116                                 "Unfound first block" );
 117       }
 118
 119       fp->read( (char*)&b1, 1 );
 120       if ( fp->fail() || fp->eof())//Fp->gcount() == 1
 121       {
 122          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 123                                 "Unfound second block" );
 124       }
 125
 126       fp->read( (char*)&b2, 1 );
 127       if ( fp->fail() || fp->eof())//Fp->gcount() == 1
 128       {
 129          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 130                                 "Unfound second block" );
 131       }
 132
 133       // Two steps are necessary to please VC++
 134       //
 135       // 2 pixels 12bit =     [0xABCDEF]
 136       // 2 pixels 16bit = [0x0ABD] + [0x0FCE]
 137       //                        A                     B                 D
 138       *localDecompres++ =  ((b0 >> 4) << 8) + ((b0 & 0x0f) << 4) + (b1 & 0x0f);
 139       //                        F                     C                 E
 140       *localDecompres++ =  ((b2 & 0x0f) << 8) + ((b1 >> 4) << 4) + (b2 >> 4);
 141
 142       /// \todo JPR Troubles expected on Big-Endian processors ?
 143    }
 144 }
 145
 146 /**
 147  * \brief     Try to deal with RLE 16 Bits.
 148  *            We assume the RLE has already been parsed and loaded in
 149  *            Raw (through \ref ReadAndDecompressJPEGFile ).
 150  *            We here need to make 16 Bits Pixels from Low Byte and
 151  *            High Byte 'Planes'...(for what it may mean)
 152  * @return    Boolean
 153  */
 154 bool PixelReadConvert::DecompressRLE16BitsFromRLE8Bits( int NumberOfFrames )
 155 {
 156    size_t pixelNumber = XSize * YSize;
 157    size_t rawSize = XSize * YSize * NumberOfFrames;
 158
 159    // We assumed Raw contains the decoded RLE pixels but as
 160    // 8 bits per pixel. In order to convert those pixels to 16 bits
 161    // per pixel we cannot work in place within Raw and hence
 162    // we copy it in a safe place, say copyRaw.
 163
 164    uint8_t* copyRaw = new uint8_t[ rawSize * 2 ];
 165    memmove( copyRaw, Raw, rawSize * 2 );
 166
 167    uint8_t* x = Raw;
 168    uint8_t* a = copyRaw;
 169    uint8_t* b = a + pixelNumber;
 170
 171    for ( int i = 0; i < NumberOfFrames; i++ )
 172    {
 173       for ( unsigned int j = 0; j < pixelNumber; j++ )
 174       {
 175          *(x++) = *(b++);
 176          *(x++) = *(a++);
 177       }
 178    }
 179
 180    delete[] copyRaw;
 181
 182    /// \todo check that operator new []didn't fail, and sometimes return false
 183    return true;
 184 }
 185
 186 /**
 187  * \brief Implementation of the RLE decoding algorithm for decompressing
 188  *        a RLE fragment. [refer to PS 3.5-2003, section G.3.2 p 86]
 189  * @param subRaw Sub region of \ref Raw where the de
 190  *        decoded fragment should be placed.
 191  * @param fragmentSize The length of the binary fragment as found on the disk.
 192  * @param RawSegmentSize The expected length of the fragment ONCE
 193  *        Raw.
 194  * @param fp File Pointer: on entry the position should be the one of
 195  *        the fragment to be decoded.
 196  */
 197 bool PixelReadConvert::ReadAndDecompressRLEFragment( uint8_t *subRaw,
 198                                                  long fragmentSize,
 199                                                  long RawSegmentSize,
 200                                                  std::ifstream *fp )
 201 {
 202    int8_t count;
 203    long numberOfOutputBytes = 0;
 204    long numberOfReadBytes = 0;
 205
 206    while( numberOfOutputBytes < RawSegmentSize )
 207    {
 208       fp->read( (char*)&count, 1 );
 209       numberOfReadBytes += 1;
 210       if ( count >= 0 )
 211       // Note: count <= 127 comparison is always true due to limited range
 212       //       of data type int8_t [since the maximum of an exact width
 213       //       signed integer of width N is 2^(N-1) - 1, which for int8_t
 214       //       is 127].
 215       {
 216          fp->read( (char*)subRaw, count + 1);
 217          numberOfReadBytes   += count + 1;
 218          subRaw     += count + 1;
 219          numberOfOutputBytes += count + 1;
 220       }
 221       else
 222       {
 223          if ( ( count <= -1 ) && ( count >= -127 ) )
 224          {
 225             int8_t newByte;
 226             fp->read( (char*)&newByte, 1);
 227             numberOfReadBytes += 1;
 228             for( int i = 0; i < -count + 1; i++ )
 229             {
 230                subRaw[i] = newByte;
 231             }
 232             subRaw     += -count + 1;
 233             numberOfOutputBytes += -count + 1;
 234          }
 235       }
 236       // if count = 128 output nothing
 237
 238       if ( numberOfReadBytes > fragmentSize )
 239       {
 240          gdcmVerboseMacro( "Read more bytes than the segment size.");
 241          return false;
 242       }
 243    }
 244    return true;
 245 }
 246
 247 /**
 248  * \brief     Reads from disk the Pixel Data of 'Run Length Encoded'
 249  *            Dicom encapsulated file and decompress it.
 250  * @param     fp already open File Pointer
 251  *            at which the pixel data should be copied
 252  * @return    Boolean
 253  */
 254 bool PixelReadConvert::ReadAndDecompressRLEFile( std::ifstream *fp )
 255 {
 256    uint8_t *subRaw = Raw;
 257    long RawSegmentSize = XSize * YSize;
 258
 259    // Loop on the frame[s]
 260    for( RLEFramesInfo::RLEFrameList::iterator
 261         it  = RLEInfo->Frames.begin();
 262         it != RLEInfo->Frames.end();
 263       ++it )
 264    {
 265       // Loop on the fragments
 266       for( unsigned int k = 1; k <= (*it)->NumberFragments; k++ )
 267       {
 268          fp->seekg(  (*it)->Offset[k] , std::ios::beg );
 269          (void)ReadAndDecompressRLEFragment( subRaw,
 270                                              (*it)->Length[k],
 271                                              RawSegmentSize,
 272                                              fp );
 273          subRaw += RawSegmentSize;
 274       }
 275    }
 276
 277    if ( BitsAllocated == 16 )
 278    {
 279       // Try to deal with RLE 16 Bits
 280       (void)DecompressRLE16BitsFromRLE8Bits( ZSize );
 281    }
 282
 283    return true;
 284 }
 285
 286 /**
 287  * \brief Swap the bytes, according to \ref SwapCode.
 288  */
 289 void PixelReadConvert::ConvertSwapZone()
 290 {
 291    unsigned int i;
 292
 293    if( BitsAllocated == 16 )
 294    {
 295       uint16_t *im16 = (uint16_t*)Raw;
 296       switch( SwapCode )
 297       {
 298          case 1234:
 299             break;
 300          case 3412:
 301          case 2143:
 302          case 4321:
 303             for( i = 0; i < RawSize / 2; i++ )
 304             {
 305                im16[i]= (im16[i] >> 8) | (im16[i] << 8 );
 306             }
 307             break;
 308          default:
 309             gdcmVerboseMacro("SwapCode value (16 bits) not allowed.");
 310       }
 311    }
 312    else if( BitsAllocated == 32 )
 313    {
 314       uint32_t s32;
 315       uint16_t high;
 316       uint16_t low;
 317       uint32_t* im32 = (uint32_t*)Raw;
 318       switch ( SwapCode )
 319       {
 320          case 1234:
 321             break;
 322          case 4321:
 323             for( i = 0; i < RawSize / 4; i++ )
 324             {
 325                low     = im32[i] & 0x0000ffff;  // 4321
 326                high    = im32[i] >> 16;
 327                high    = ( high >> 8 ) | ( high << 8 );
 328                low     = ( low  >> 8 ) | ( low  << 8 );
 329                s32     = low;
 330                im32[i] = ( s32 << 16 ) | high;
 331             }
 332             break;
 333          case 2143:
 334             for( i = 0; i < RawSize / 4; i++ )
 335             {
 336                low     = im32[i] & 0x0000ffff;   // 2143
 337                high    = im32[i] >> 16;
 338                high    = ( high >> 8 ) | ( high << 8 );
 339                low     = ( low  >> 8 ) | ( low  << 8 );
 340                s32     = high;
 341                im32[i] = ( s32 << 16 ) | low;
 342             }
 343             break;
 344          case 3412:
 345             for( i = 0; i < RawSize / 4; i++ )
 346             {
 347                low     = im32[i] & 0x0000ffff; // 3412
 348                high    = im32[i] >> 16;
 349                s32     = low;
 350                im32[i] = ( s32 << 16 ) | high;
 351             }
 352             break;
 353          default:
 354             gdcmVerboseMacro("SwapCode value (32 bits) not allowed." );
 355       }
 356    }
 357 }
 358
 359 /**
 360  * \brief Deal with endianity i.e. re-arange bytes inside the integer
 361  */
 362 void PixelReadConvert::ConvertReorderEndianity()
 363 {
 364    if ( BitsAllocated != 8 )
 365    {
 366       ConvertSwapZone();
 367    }
 368
 369    // Special kludge in order to deal with xmedcon broken images:
 370    if (  ( BitsAllocated == 16 )
 371        && ( BitsStored < BitsAllocated )
 372        && ( ! PixelSign ) )
 373    {
 374       int l = (int)( RawSize / ( BitsAllocated / 8 ) );
 375       uint16_t *deb = (uint16_t *)Raw;
 376       for(int i = 0; i<l; i++)
 377       {
 378          if( *deb == 0xffff )
 379          {
 380            *deb = 0;
 381          }
 382          deb++;
 383       }
 384    }
 385 }
 386
 387
 388 /**
 389  * \brief     Reads from disk the Pixel Data of JPEG Dicom encapsulated
 390  *            file and decompress it. This function assumes that each
 391  *            jpeg fragment contains a whole frame (jpeg file).
 392  * @param     fp File Pointer
 393  * @return    Boolean
 394  */
 395 bool PixelReadConvert::ReadAndDecompressJPEGFramesFromFile( std::ifstream *fp )
 396 {
 397    uint8_t *localRaw = Raw;
 398    // Loop on the fragment[s]
 399    for( JPEGFragmentsInfo::JPEGFragmentsList::iterator
 400         it  = JPEGInfo->Fragments.begin();
 401         it != JPEGInfo->Fragments.end();
 402       ++it )
 403    {
 404       fp->seekg( (*it)->Offset, std::ios::beg);
 405
 406       (*it)->DecompressJPEGFramesFromFile(fp, localRaw, BitsStored );
 407
 408       // Advance to next free location in Raw
 409       // for next fragment decompression (if any)
 410       int length = XSize * YSize * SamplesPerPixel;
 411       int numberBytes = BitsAllocated / 8;
 412
 413       localRaw += length * numberBytes;
 414    }
 415    return true;
 416 }
 417
 418 /**
 419  * \brief     Reads from disk the Pixel Data of JPEG Dicom encapsulated
 420  *            file and decompress it. This function assumes that the dicom
 421  *            image is a single frame split into several JPEG fragments.
 422  *            Those fragments will be glued together into a memory buffer
 423  *            before being read.
 424  * @param     fp File Pointer
 425  * @return    Boolean
 426  */
 427 bool PixelReadConvert::
 428 ReadAndDecompressJPEGSingleFrameFragmentsFromFile( std::ifstream *fp )
 429 {
 430    // Loop on the fragment[s] to get total length
 431    size_t totalLength = 0;
 432    JPEGFragmentsInfo::JPEGFragmentsList::iterator it;
 433    for( it  = JPEGInfo->Fragments.begin();
 434         it != JPEGInfo->Fragments.end();
 435         ++it )
 436    {
 437       totalLength += (*it)->Length;
 438    }
 439
 440    // Concatenate the jpeg fragments into a local buffer
 441    JOCTET *buffer = new JOCTET [totalLength];
 442    JOCTET *p = buffer;
 443
 444    // Loop on the fragment[s]
 445    for( it  = JPEGInfo->Fragments.begin();
 446         it != JPEGInfo->Fragments.end();
 447         ++it )
 448    {
 449       fp->seekg( (*it)->Offset, std::ios::beg);
 450       size_t len = (*it)->Length;
 451       fp->read((char *)p,len);
 452       p += len;
 453    }
 454
 455    (*it)->DecompressJPEGSingleFrameFragmentsFromFile(buffer, totalLength, Raw, BitsStored);
 456
 457    // free local buffer
 458    delete [] buffer;
 459
 460    return true;
 461 }
 462
 463 /**
 464  * \brief     Reads from disk the Pixel Data of JPEG Dicom encapsulated
 465  *            file and decompress it. This function handles the generic
 466  *            and complex case where the DICOM contains several frames,
 467  *            and some of the frames are possibly split into several JPEG
 468  *            fragments.
 469  * @param     fp File Pointer
 470  * @return    Boolean
 471  */
 472 bool PixelReadConvert::
 473 ReadAndDecompressJPEGFragmentedFramesFromFile( std::ifstream *fp )
 474 {
 475    // Loop on the fragment[s] to get total length
 476    size_t totalLength = 0;
 477    JPEGFragmentsInfo::JPEGFragmentsList::iterator it;
 478    for( it  = JPEGInfo->Fragments.begin();
 479         it != JPEGInfo->Fragments.end();
 480         ++it )
 481    {
 482       totalLength += (*it)->Length;
 483    }
 484
 485    // Concatenate the jpeg fragments into a local buffer
 486    JOCTET *buffer = new JOCTET [totalLength];
 487    JOCTET *p = buffer;
 488
 489    // Loop on the fragment[s]
 490    for( it  = JPEGInfo->Fragments.begin();
 491         it != JPEGInfo->Fragments.end();
 492         ++it )
 493    {
 494       fp->seekg( (*it)->Offset, std::ios::beg);
 495       size_t len = (*it)->Length;
 496       fp->read((char *)p,len);
 497       p+=len;
 498    }
 499
 500    size_t howManyRead = 0;
 501    size_t howManyWritten = 0;
 502    size_t fragmentLength = 0;
 503
 504    for( it  = JPEGInfo->Fragments.begin() ;
 505         (it != JPEGInfo->Fragments.end()) && (howManyRead < totalLength);
 506         ++it )
 507    {
 508       fragmentLength += (*it)->Length;
 509
 510       if (howManyRead > fragmentLength) continue;
 511
 512       (*it)->DecompressJPEGFragmentedFramesFromFile(buffer, Raw, BitsStored, howManyRead, howManyWritten, totalLength);
 513
 514       if (howManyRead < fragmentLength)
 515          howManyRead = fragmentLength;
 516    }
 517
 518    // free local buffer
 519    delete [] buffer;
 520
 521    return true;
 522 }
 523
 524 /**
 525  * \brief     Reads from disk the Pixel Data of JPEG Dicom encapsulated
 526  *            file and decompress it.
 527  * @param     fp File Pointer
 528  * @return    Boolean
 529  */
 530 bool PixelReadConvert::ReadAndDecompressJPEGFile( std::ifstream *fp )
 531 {
 532    if ( IsJPEG2000 )
 533    {
 534       fp->seekg( (*JPEGInfo->Fragments.begin())->Offset, std::ios::beg);
 535 //      if ( ! gdcm_read_JPEG2000_file( fp,Raw ) )
 536 //         return false;
 537    }
 538
 539    if ( ( ZSize == 1 ) && ( JPEGInfo->Fragments.size() > 1 ) )
 540    {
 541       // we have one frame split into several fragments
 542       // we will pack those fragments into a single buffer and
 543       // read from it
 544       return ReadAndDecompressJPEGSingleFrameFragmentsFromFile( fp );
 545    }
 546    else if (JPEGInfo->Fragments.size() == (size_t)ZSize)
 547    {
 548       // suppose each fragment is a frame
 549       return ReadAndDecompressJPEGFramesFromFile( fp );
 550    }
 551    else
 552    {
 553       // The dicom image contains frames containing fragments of images
 554       // a more complex algorithm :-)
 555       return ReadAndDecompressJPEGFragmentedFramesFromFile( fp );
 556    }
 557 }
 558
 559 /**
 560  * \brief  Re-arrange the bits within the bytes.
 561  * @return Boolean
 562  */
 563 bool PixelReadConvert::ConvertReArrangeBits() throw ( FormatError )
 564 {
 565    if ( BitsStored != BitsAllocated )
 566    {
 567       int l = (int)( RawSize / ( BitsAllocated / 8 ) );
 568       if ( BitsAllocated == 16 )
 569       {
 570          uint16_t mask = 0xffff;
 571          mask = mask >> ( BitsAllocated - BitsStored );
 572          uint16_t* deb = (uint16_t*)Raw;
 573          for(int i = 0; i<l; i++)
 574          {
 575             *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & mask;
 576             deb++;
 577          }
 578       }
 579       else if ( BitsAllocated == 32 )
 580       {
 581          uint32_t mask = 0xffffffff;
 582          mask = mask >> ( BitsAllocated - BitsStored );
 583          uint32_t* deb = (uint32_t*)Raw;
 584          for(int i = 0; i<l; i++)
 585          {
 586             *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & mask;
 587             deb++;
 588          }
 589       }
 590       else
 591       {
 592          gdcmVerboseMacro("Weird image");
 593          throw FormatError( "Weird image !?" );
 594       }
 595    }
 596    return true;
 597 }
 598
 599 /**
 600  * \brief   Convert (Y plane, cB plane, cR plane) to RGB pixels
 601  * \warning Works on all the frames at a time
 602  */
 603 void PixelReadConvert::ConvertYcBcRPlanesToRGBPixels()
 604 {
 605    uint8_t *localRaw = Raw;
 606    uint8_t *copyRaw = new uint8_t[ RawSize ];
 607    memmove( copyRaw, localRaw, RawSize );
 608
 609    // to see the tricks about YBR_FULL, YBR_FULL_422,
 610    // YBR_PARTIAL_422, YBR_ICT, YBR_RCT have a look at :
 611    // ftp://medical.nema.org/medical/dicom/final/sup61_ft.pdf
 612    // and be *very* affraid
 613    //
 614    int l        = XSize * YSize;
 615    int nbFrames = ZSize;
 616
 617    uint8_t *a = copyRaw;
 618    uint8_t *b = copyRaw + l;
 619    uint8_t *c = copyRaw + l + l;
 620    double R, G, B;
 621
 622    /// \todo : Replace by the 'well known' integer computation
 623    ///         counterpart. Refer to
 624    ///            http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
 625    ///         for code optimisation.
 626
 627    for ( int i = 0; i < nbFrames; i++ )
 628    {
 629       for ( int j = 0; j < l; j++ )
 630       {
 631          R = 1.164 *(*a-16) + 1.596 *(*c -128) + 0.5;
 632          G = 1.164 *(*a-16) - 0.813 *(*c -128) - 0.392 *(*b -128) + 0.5;
 633          B = 1.164 *(*a-16) + 2.017 *(*b -128) + 0.5;
 634
 635          if (R < 0.0)   R = 0.0;
 636          if (G < 0.0)   G = 0.0;
 637          if (B < 0.0)   B = 0.0;
 638          if (R > 255.0) R = 255.0;
 639          if (G > 255.0) G = 255.0;
 640          if (B > 255.0) B = 255.0;
 641
 642          *(localRaw++) = (uint8_t)R;
 643          *(localRaw++) = (uint8_t)G;
 644          *(localRaw++) = (uint8_t)B;
 645          a++;
 646          b++;
 647          c++;
 648       }
 649    }
 650    delete[] copyRaw;
 651 }
 652
 653 /**
 654  * \brief   Convert (Red plane, Green plane, Blue plane) to RGB pixels
 655  * \warning Works on all the frames at a time
 656  */
 657 void PixelReadConvert::ConvertRGBPlanesToRGBPixels()
 658 {
 659    uint8_t *localRaw = Raw;
 660    uint8_t *copyRaw = new uint8_t[ RawSize ];
 661    memmove( copyRaw, localRaw, RawSize );
 662
 663    int l = XSize * YSize * ZSize;
 664
 665    uint8_t* a = copyRaw;
 666    uint8_t* b = copyRaw + l;
 667    uint8_t* c = copyRaw + l + l;
 668
 669    for (int j = 0; j < l; j++)
 670    {
 671       *(localRaw++) = *(a++);
 672       *(localRaw++) = *(b++);
 673       *(localRaw++) = *(c++);
 674    }
 675    delete[] copyRaw;
 676 }
 677
 678 bool PixelReadConvert::ReadAndDecompressPixelData( std::ifstream *fp )
 679 {
 680    // ComputeRawAndRGBSizes is already made by
 681    // ::GrabInformationsFromHeader. So, the structure sizes are
 682    // correct
 683    Squeeze();
 684
 685    //////////////////////////////////////////////////
 686    //// First stage: get our hands on the Pixel Data.
 687    if ( !fp )
 688    {
 689       gdcmVerboseMacro( "Unavailable file pointer." );
 690       return false;
 691    }
 692
 693    fp->seekg( PixelOffset, std::ios::beg );
 694    if( fp->fail() || fp->eof())
 695    {
 696       gdcmVerboseMacro( "Unable to find PixelOffset in file." );
 697       return false;
 698    }
 699
 700    AllocateRaw();
 701
 702    //////////////////////////////////////////////////
 703    //// Second stage: read from disk dans decompress.
 704    if ( BitsAllocated == 12 )
 705    {
 706       ReadAndDecompress12BitsTo16Bits( fp);
 707    }
 708    else if ( IsRaw )
 709    {
 710       // This problem can be found when some obvious informations are found
 711       // after the field containing the image datas. In this case, these
 712       // bad datas are added to the size of the image (in the PixelDataLength
 713       // variable). But RawSize is the right size of the image !
 714       if( PixelDataLength != RawSize)
 715       {
 716          gdcmVerboseMacro( "Mismatch between PixelReadConvert and RawSize." );
 717       }
 718       if( PixelDataLength > RawSize)
 719       {
 720          fp->read( (char*)Raw, RawSize);
 721       }
 722       else
 723       {
 724          fp->read( (char*)Raw, PixelDataLength);
 725       }
 726
 727       if ( fp->fail() || fp->eof())
 728       {
 729          gdcmVerboseMacro( "Reading of Raw pixel data failed." );
 730          return false;
 731       }
 732    }
 733    else if ( IsRLELossless )
 734    {
 735       if ( ! ReadAndDecompressRLEFile( fp ) )
 736       {
 737          gdcmVerboseMacro( "RLE decompressor failed." );
 738          return false;
 739       }
 740    }
 741    else
 742    {
 743       // Default case concerns JPEG family
 744       if ( ! ReadAndDecompressJPEGFile( fp ) )
 745       {
 746          gdcmVerboseMacro( "JPEG decompressor failed." );
 747          return false;
 748       }
 749    }
 750
 751    ////////////////////////////////////////////
 752    //// Third stage: twigle the bytes and bits.
 753    ConvertReorderEndianity();
 754    ConvertReArrangeBits();
 755    ConvertHandleColor();
 756
 757    return true;
 758 }
 759
 760 void PixelReadConvert::ConvertHandleColor()
 761 {
 762    //////////////////////////////////
 763    // Deal with the color decoding i.e. handle:
 764    //   - R, G, B planes (as opposed to RGB pixels)
 765    //   - YBR (various) encodings.
 766    //   - LUT[s] (or "PALETTE COLOR").
 767    //
 768    // The classification in the color decoding schema is based on the blending
 769    // of two Dicom tags values:
 770    // * "Photometric Interpretation" for which we have the cases:
 771    //  - [Photo A] MONOCHROME[1|2] pictures,
 772    //  - [Photo B] RGB or YBR_FULL_422 (which acts as RGB),
 773    //  - [Photo C] YBR_* (with the above exception of YBR_FULL_422)
 774    //  - [Photo D] "PALETTE COLOR" which indicates the presence of LUT[s].
 775    // * "Planar Configuration" for which we have the cases:
 776    //  - [Planar 0] 0 then Pixels are already RGB
 777    //  - [Planar 1] 1 then we have 3 planes : R, G, B,
 778    //  - [Planar 2] 2 then we have 1 gray Plane and 3 LUTs
 779    //
 780    // Now in theory, one could expect some coherence when blending the above
 781    // cases. For example we should not encounter files belonging at the
 782    // time to case [Planar 0] and case [Photo D].
 783    // Alas, this was only theory ! Because in practice some odd (read ill
 784    // formated Dicom) files (e.g. gdcmData/US-PAL-8-10x-echo.dcm) we encounter:
 785    //     - "Planar Configuration" = 0,
 786    //     - "Photometric Interpretation" = "PALETTE COLOR".
 787    // Hence gdcm will use the folowing "heuristic" in order to be tolerant
 788    // towards Dicom-non-conformance files:
 789    //   << whatever the "Planar Configuration" value might be, a
 790    //      "Photometric Interpretation" set to "PALETTE COLOR" forces
 791    //      a LUT intervention >>
 792    //
 793    // Now we are left with the following handling of the cases:
 794    // - [Planar 0] OR  [Photo A] no color decoding (since respectively
 795    //       Pixels are already RGB and monochrome pictures have no color :),
 796    // - [Planar 1] AND [Photo B] handled with ConvertRGBPlanesToRGBPixels()
 797    // - [Planar 1] AND [Photo C] handled with ConvertYcBcRPlanesToRGBPixels()
 798    // - [Planar 2] OR  [Photo D] requires LUT intervention.
 799
 800    if ( ! IsRawRGB() )
 801    {
 802       // [Planar 2] OR  [Photo D]: LUT intervention done outside
 803       return;
 804    }
 805
 806    if ( PlanarConfiguration == 1 )
 807    {
 808       if ( IsYBRFull )
 809       {
 810          // [Planar 1] AND [Photo C] (remember YBR_FULL_422 acts as RGB)
 811          ConvertYcBcRPlanesToRGBPixels();
 812       }
 813       else
 814       {
 815          // [Planar 1] AND [Photo C]
 816          ConvertRGBPlanesToRGBPixels();
 817       }
 818       return;
 819    }
 820
 821    // When planarConf is 0, and RLELossless (forbidden by Dicom norm)
 822    // pixels need to be RGB-fied anyway
 823    if (IsRLELossless)
 824    {
 825      ConvertRGBPlanesToRGBPixels();
 826    }
 827    // In *normal *case, when planarConf is 0, pixels are already in RGB
 828 }
 829
 830 /**
 831  * \brief Predicate to know wether the image[s] (once Raw) is RGB.
 832  * \note See comments of \ref ConvertHandleColor
 833  */
 834 bool PixelReadConvert::IsRawRGB()
 835 {
 836    if (   IsMonochrome
 837        || PlanarConfiguration == 2
 838        || IsPaletteColor )
 839    {
 840       return false;
 841    }
 842    return true;
 843 }
 844
 845 void PixelReadConvert::ComputeRawAndRGBSizes()
 846 {
 847    int bitsAllocated = BitsAllocated;
 848    // Number of "Bits Allocated" is fixed to 16 when it's 12, since
 849    // in this case we will expand the image to 16 bits (see
 850    //    \ref ReadAndDecompress12BitsTo16Bits() )
 851    if (  BitsAllocated == 12 )
 852    {
 853       bitsAllocated = 16;
 854    }
 855
 856    RawSize =  XSize * YSize * ZSize
 857                      * ( bitsAllocated / 8 )
 858                      * SamplesPerPixel;
 859    if ( HasLUT )
 860    {
 861       RGBSize = 3 * RawSize;
 862    }
 863    else
 864    {
 865       RGBSize = RawSize;
 866    }
 867 }
 868
 869 void PixelReadConvert::GrabInformationsFromHeader( Header *header )
 870 {
 871    // Number of Bits Allocated for storing a Pixel is defaulted to 16
 872    // when absent from the header.
 873    BitsAllocated = header->GetBitsAllocated();
 874    if ( BitsAllocated == 0 )
 875    {
 876       BitsAllocated = 16;
 877    }
 878
 879    // Number of "Bits Stored" defaulted to number of "Bits Allocated"
 880    // when absent from the header.
 881    BitsStored = header->GetBitsStored();
 882    if ( BitsStored == 0 )
 883    {
 884       BitsStored = BitsAllocated;
 885    }
 886
 887    // High Bit Position
 888    HighBitPosition = header->GetHighBitPosition();
 889    if ( HighBitPosition == 0 )
 890    {
 891       HighBitPosition = BitsAllocated - 1;
 892    }
 893
 894    XSize = header->GetXSize();
 895    YSize = header->GetYSize();
 896    ZSize = header->GetZSize();
 897    SamplesPerPixel = header->GetSamplesPerPixel();
 898    PixelSize = header->GetPixelSize();
 899    PixelSign = header->IsSignedPixelData();
 900    SwapCode  = header->GetSwapCode();
 901    std::string ts = header->GetTransferSyntax();
 902    IsRaw =
 903         ( ! header->IsDicomV3() )
 904      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian
 905      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndianDLXGE
 906      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRLittleEndian
 907      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian
 908      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::DeflatedExplicitVRLittleEndian;
 909    IsJPEG2000     = Global::GetTS()->IsJPEG2000(ts);
 910    IsJPEGLossless = Global::GetTS()->IsJPEGLossless(ts);
 911    IsRLELossless  =  Global::GetTS()->IsRLELossless(ts);
 912    PixelOffset     = header->GetPixelOffset();
 913    PixelDataLength = header->GetPixelAreaLength();
 914    RLEInfo  = header->GetRLEInfo();
 915    JPEGInfo = header->GetJPEGInfo();
 916
 917    PlanarConfiguration = header->GetPlanarConfiguration();
 918    IsMonochrome = header->IsMonochrome();
 919    IsPaletteColor = header->IsPaletteColor();
 920    IsYBRFull = header->IsYBRFull();
 921
 922    /////////////////////////////////////////////////////////////////
 923    // LUT section:
 924    HasLUT = header->HasLUT();
 925    if ( HasLUT )
 926    {
 927       // Just in case some access to a Header element requires disk access.
 928       LutRedDescriptor   = header->GetEntry( 0x0028, 0x1101 );
 929       LutGreenDescriptor = header->GetEntry( 0x0028, 0x1102 );
 930       LutBlueDescriptor  = header->GetEntry( 0x0028, 0x1103 );
 931
 932       // Depending on the value of Document::MAX_SIZE_LOAD_ELEMENT_VALUE
 933       // [ refer to invocation of Document::SetMaxSizeLoadEntry() in
 934       // Document::Document() ], the loading of the value (content) of a
 935       // [Bin|Val]Entry occurence migth have been hindered (read simply NOT
 936       // loaded). Hence, we first try to obtain the LUTs data from the header
 937       // and when this fails we read the LUTs data directely from disk.
 938       /// \TODO Reading a [Bin|Val]Entry directly from disk is a kludge.
 939       ///       We should NOT bypass the [Bin|Val]Entry class. Instead
 940       ///       an access to an UNLOADED content of a [Bin|Val]Entry occurence
 941       ///       (e.g. BinEntry::GetBinArea()) should force disk access from
 942       ///       within the [Bin|Val]Entry class itself. The only problem
 943       ///       is that the [Bin|Val]Entry is unaware of the FILE* is was
 944       ///       parsed from. Fix that. FIXME.
 945
 946       ////// Red round
 947       header->LoadEntryBinArea(0x0028, 0x1201);
 948       LutRedData = (uint8_t*)header->GetEntryBinArea( 0x0028, 0x1201 );
 949       if ( ! LutRedData )
 950       {
 951          gdcmVerboseMacro( "Unable to read Red LUT data" );
 952       }
 953
 954       ////// Green round:
 955       header->LoadEntryBinArea(0x0028, 0x1202);
 956       LutGreenData = (uint8_t*)header->GetEntryBinArea(0x0028, 0x1202 );
 957       if ( ! LutGreenData)
 958       {
 959          gdcmVerboseMacro( "Unable to read Green LUT data" );
 960       }
 961
 962       ////// Blue round:
 963       header->LoadEntryBinArea(0x0028, 0x1203);
 964       LutBlueData = (uint8_t*)header->GetEntryBinArea( 0x0028, 0x1203 );
 965       if ( ! LutBlueData )
 966       {
 967          gdcmVerboseMacro( "Unable to read Blue LUT data" );
 968       }
 969    }
 970
 971    ComputeRawAndRGBSizes();
 972 }
 973
 974 /**
 975  * \brief Build Red/Green/Blue/Alpha LUT from Header
 976  *         when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
 977  *          and (0028,1101),(0028,1102),(0028,1102)
 978  *            - xxx Palette Color Lookup Table Descriptor - are found
 979  *          and (0028,1201),(0028,1202),(0028,1202)
 980  *            - xxx Palette Color Lookup Table Data - are found
 981  * \warning does NOT deal with :
 982  *   0028 1100 Gray Lookup Table Descriptor (Retired)
 983  *   0028 1221 Segmented Red Palette Color Lookup Table Data
 984  *   0028 1222 Segmented Green Palette Color Lookup Table Data
 985  *   0028 1223 Segmented Blue Palette Color Lookup Table Data
 986  *   no known Dicom reader deals with them :-(
 987  * @return a RGBA Lookup Table
 988  */
 989 void PixelReadConvert::BuildLUTRGBA()
 990 {
 991    if ( LutRGBA )
 992    {
 993       return;
 994    }
 995    // Not so easy : see
 996    // http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables
 997
 998    if ( ! IsPaletteColor )
 999    {
1000       return;
1001    }
1002
1003    if (   LutRedDescriptor   == GDCM_UNFOUND
1004        || LutGreenDescriptor == GDCM_UNFOUND
1005        || LutBlueDescriptor  == GDCM_UNFOUND )
1006    {
1007       return;
1008    }
1009
1010    ////////////////////////////////////////////
1011    // Extract the info from the LUT descriptors
1012    int lengthR;   // Red LUT length in Bytes
1013    int debR;      // Subscript of the first Lut Value
1014    int nbitsR;    // Lut item size (in Bits)
1015    int nbRead = sscanf( LutRedDescriptor.c_str(),
1016                         "%d\\%d\\%d",
1017                         &lengthR, &debR, &nbitsR );
1018    if( nbRead != 3 )
1019    {
1020       gdcmVerboseMacro( "Wrong Red LUT descriptor" );
1021    }
1022
1023    int lengthG;  // Green LUT length in Bytes
1024    int debG;     // Subscript of the first Lut Value
1025    int nbitsG;   // Lut item size (in Bits)
1026    nbRead = sscanf( LutGreenDescriptor.c_str(),
1027                     "%d\\%d\\%d",
1028                     &lengthG, &debG, &nbitsG );
1029    if( nbRead != 3 )
1030    {
1031       gdcmVerboseMacro( "Wrong Green LUT descriptor" );
1032    }
1033
1034    int lengthB;  // Blue LUT length in Bytes
1035    int debB;     // Subscript of the first Lut Value
1036    int nbitsB;   // Lut item size (in Bits)
1037    nbRead = sscanf( LutRedDescriptor.c_str(),
1038                     "%d\\%d\\%d",
1039                     &lengthB, &debB, &nbitsB );
1040    if( nbRead != 3 )
1041    {
1042       gdcmVerboseMacro( "Wrong Blue LUT descriptor" );
1043    }
1044
1045    ////////////////////////////////////////////////////////
1046    if ( ( ! LutRedData ) || ( ! LutGreenData ) || ( ! LutBlueData ) )
1047    {
1048       return;
1049    }
1050
1051    ////////////////////////////////////////////////
1052    // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT
1053    LutRGBA = new uint8_t[ 1024 ]; // 256 * 4 (R, G, B, Alpha)
1054    if ( !LutRGBA )
1055    {
1056       return;
1057    }
1058    memset( LutRGBA, 0, 1024 );
1059
1060    int mult;
1061    if ( ( nbitsR == 16 ) && ( BitsAllocated == 8 ) )
1062    {
1063       // when LUT item size is different than pixel size
1064       mult = 2; // high byte must be = low byte
1065    }
1066    else
1067    {
1068       // See PS 3.3-2003 C.11.1.1.2 p 619
1069       mult = 1;
1070    }
1071
1072    // if we get a black image, let's just remove the '+1'
1073    // from 'i*mult+1' and check again
1074    // if it works, we shall have to check the 3 Palettes
1075    // to see which byte is ==0 (first one, or second one)
1076    // and fix the code
1077    // We give up the checking to avoid some (useless ?) overhead
1078    // (optimistic asumption)
1079    int i;
1080    uint8_t* a = LutRGBA + 0;
1081    for( i=0; i < lengthR; ++i )
1082    {
1083       *a = LutRedData[i*mult+1];
1084       a += 4;
1085    }
1086
1087    a = LutRGBA + 1;
1088    for( i=0; i < lengthG; ++i)
1089    {
1090       *a = LutGreenData[i*mult+1];
1091       a += 4;
1092    }
1093
1094    a = LutRGBA + 2;
1095    for(i=0; i < lengthB; ++i)
1096    {
1097       *a = LutBlueData[i*mult+1];
1098       a += 4;
1099    }
1100
1101    a = LutRGBA + 3;
1102    for(i=0; i < 256; ++i)
1103    {
1104       *a = 1; // Alpha component
1105       a += 4;
1106    }
1107 }
1108
1109 /**
1110  * \brief Build the RGB image from the Raw imagage and the LUTs.
1111  */
1112 bool PixelReadConvert::BuildRGBImage()
1113 {
1114    if ( RGB )
1115    {
1116       // The job is already done.
1117       return true;
1118    }
1119
1120    if ( ! Raw )
1121    {
1122       // The job can't be done
1123       return false;
1124    }
1125
1126    BuildLUTRGBA();
1127    if ( ! LutRGBA )
1128    {
1129       // The job can't be done
1130       return false;
1131    }
1132
1133    // Build RGB Pixels
1134    AllocateRGB();
1135    uint8_t* localRGB = RGB;
1136    for (size_t i = 0; i < RawSize; ++i )
1137    {
1138       int j  = Raw[i] * 4;
1139       *localRGB++ = LutRGBA[j];
1140       *localRGB++ = LutRGBA[j+1];
1141       *localRGB++ = LutRGBA[j+2];
1142    }
1143    return true;
1144 }
1145
1146 /**
1147  * \brief        Print self.
1148  * @param indent Indentation string to be prepended during printing.
1149  * @param os     Stream to print to.
1150  */
1151 void PixelReadConvert::Print( std::ostream &os, std::string const & indent )
1152 {
1153    os << indent
1154       << "--- Pixel information -------------------------"
1155       << std::endl;
1156    os << indent
1157       << "Pixel Data: offset " << PixelOffset
1158       << " x(" << std::hex << PixelOffset << std::dec
1159       << ")   length " << PixelDataLength
1160       << " x(" << std::hex << PixelDataLength << std::dec
1161       << ")" << std::endl;
1162
1163    if ( IsRLELossless )
1164    {
1165       if ( RLEInfo )
1166       {
1167          RLEInfo->Print( os, indent );
1168       }
1169       else
1170       {
1171          gdcmVerboseMacro("Set as RLE file but NO RLEinfo present.");
1172       }
1173    }
1174
1175    if ( IsJPEG2000 || IsJPEGLossless )
1176    {
1177       if ( JPEGInfo )
1178       {
1179          JPEGInfo->Print( os, indent );
1180       }
1181       else
1182       {
1183          gdcmVerboseMacro("Set as JPEG file but NO JPEGinfo present.");
1184       }
1185    }
1186 }
1187
1188 } // end namespace gdcm
1189
1190 // NOTES on File internal calls
1191 // User
1192 // ---> GetImageData
1193 //     ---> GetImageDataIntoVector
1194 //        |---> GetImageDataIntoVectorRaw
1195 //        | lut intervention
1196 // User
1197 // ---> GetImageDataRaw
1198 //     ---> GetImageDataIntoVectorRaw
1199