src/gdcmPixelReadConvert.cxx

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