src/gdcmPixelConvert.cxx

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