src/gdcmPixelReadConvert.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmPixelReadConvert.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/02 10:02:18 $
   7   Version:   $Revision: 1.44 $
   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 //-----------------------------------------------------------------------------
  34 #define str2num(str, typeNum) *((typeNum *)(str))
  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 PixelReadConvert::~PixelReadConvert()
  51 {
  52    Squeeze();
  53 }
  54
  55 //-----------------------------------------------------------------------------
  56 // Public
  57 void PixelReadConvert::Squeeze()
  58 {
  59    if ( RGB )
  60       delete [] RGB;
  61    RGB = 0;
  62
  63    if ( Raw )
  64       delete [] Raw;
  65    Raw = 0;
  66
  67    if ( LutRGBA )
  68       delete [] LutRGBA;
  69    LutRGBA = 0;
  70 }
  71
  72 void PixelReadConvert::AllocateRGB()
  73 {
  74   if ( RGB )
  75      delete [] RGB;
  76   RGB = new uint8_t[RGBSize];
  77 }
  78
  79 void PixelReadConvert::AllocateRaw()
  80 {
  81   if ( Raw )
  82      delete [] Raw;
  83   Raw = new uint8_t[RawSize];
  84 }
  85
  86 /**
  87  * \brief Read from file a 12 bits per pixel image and decompress it
  88  *        into a 16 bits per pixel image.
  89  */
  90 void PixelReadConvert::ReadAndDecompress12BitsTo16Bits( std::ifstream *fp )
  91                throw ( FormatError )
  92 {
  93    int nbPixels = XSize * YSize;
  94    uint16_t *localDecompres = (uint16_t*)Raw;
  95
  96    for( int p = 0; p < nbPixels; p += 2 )
  97    {
  98       uint8_t b0, b1, b2;
  99
 100       fp->read( (char*)&b0, 1);
 101       if ( fp->fail() || fp->eof() )
 102       {
 103          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 104                                 "Unfound first block" );
 105       }
 106
 107       fp->read( (char*)&b1, 1 );
 108       if ( fp->fail() || fp->eof())
 109       {
 110          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 111                                 "Unfound second block" );
 112       }
 113
 114       fp->read( (char*)&b2, 1 );
 115       if ( fp->fail() || fp->eof())
 116       {
 117          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 118                                 "Unfound second block" );
 119       }
 120
 121       // Two steps are necessary to please VC++
 122       //
 123       // 2 pixels 12bit =     [0xABCDEF]
 124       // 2 pixels 16bit = [0x0ABD] + [0x0FCE]
 125       //                        A                     B                 D
 126       *localDecompres++ =  ((b0 >> 4) << 8) + ((b0 & 0x0f) << 4) + (b1 & 0x0f);
 127       //                        F                     C                 E
 128       *localDecompres++ =  ((b2 & 0x0f) << 8) + ((b1 >> 4) << 4) + (b2 >> 4);
 129
 130       /// \todo JPR Troubles expected on Big-Endian processors ?
 131    }
 132 }
 133
 134
 135 /**
 136  * \brief Swap the bytes, according to \ref SwapCode.
 137  */
 138 void PixelReadConvert::ConvertSwapZone()
 139 {
 140    unsigned int i;
 141
 142    if( BitsAllocated == 16 )
 143    {
 144       uint16_t *im16 = (uint16_t*)Raw;
 145       switch( SwapCode )
 146       {
 147          case 1234:
 148             break;
 149          case 3412:
 150          case 2143:
 151          case 4321:
 152             for( i = 0; i < RawSize / 2; i++ )
 153             {
 154                im16[i]= (im16[i] >> 8) | (im16[i] << 8 );
 155             }
 156             break;
 157          default:
 158             gdcmVerboseMacro("SwapCode value (16 bits) not allowed.");
 159       }
 160    }
 161    else if( BitsAllocated == 32 )
 162    {
 163       uint32_t s32;
 164       uint16_t high;
 165       uint16_t low;
 166       uint32_t *im32 = (uint32_t*)Raw;
 167       switch ( SwapCode )
 168       {
 169          case 1234:
 170             break;
 171          case 4321:
 172             for( i = 0; i < RawSize / 4; i++ )
 173             {
 174                low     = im32[i] & 0x0000ffff;  // 4321
 175                high    = im32[i] >> 16;
 176                high    = ( high >> 8 ) | ( high << 8 );
 177                low     = ( low  >> 8 ) | ( low  << 8 );
 178                s32     = low;
 179                im32[i] = ( s32 << 16 ) | high;
 180             }
 181             break;
 182          case 2143:
 183             for( i = 0; i < RawSize / 4; i++ )
 184             {
 185                low     = im32[i] & 0x0000ffff;   // 2143
 186                high    = im32[i] >> 16;
 187                high    = ( high >> 8 ) | ( high << 8 );
 188                low     = ( low  >> 8 ) | ( low  << 8 );
 189                s32     = high;
 190                im32[i] = ( s32 << 16 ) | low;
 191             }
 192             break;
 193          case 3412:
 194             for( i = 0; i < RawSize / 4; i++ )
 195             {
 196                low     = im32[i] & 0x0000ffff; // 3412
 197                high    = im32[i] >> 16;
 198                s32     = low;
 199                im32[i] = ( s32 << 16 ) | high;
 200             }
 201             break;
 202          default:
 203             gdcmVerboseMacro("SwapCode value (32 bits) not allowed." );
 204       }
 205    }
 206 }
 207
 208 /**
 209  * \brief Deal with endianness i.e. re-arange bytes inside the integer
 210  */
 211 void PixelReadConvert::ConvertReorderEndianity()
 212 {
 213    if ( BitsAllocated != 8 )
 214    {
 215       ConvertSwapZone();
 216    }
 217
 218    // Special kludge in order to deal with xmedcon broken images:
 219    if ( BitsAllocated == 16
 220      && BitsStored < BitsAllocated
 221      && !PixelSign )
 222    {
 223       int l = (int)( RawSize / ( BitsAllocated / 8 ) );
 224       uint16_t *deb = (uint16_t *)Raw;
 225       for(int i = 0; i<l; i++)
 226       {
 227          if( *deb == 0xffff )
 228          {
 229            *deb = 0;
 230          }
 231          deb++;
 232       }
 233    }
 234 }
 235
 236 /**
 237  * \brief     Reads from disk the Pixel Data of JPEG Dicom encapsulated
 238  *            file and decompress it.
 239  * @param     fp File Pointer
 240  * @return    Boolean
 241  */
 242 bool PixelReadConvert::ReadAndDecompressJPEGFile( std::ifstream *fp )
 243 {
 244    if ( IsJPEG2000 )
 245    {
 246       gdcmVerboseMacro( "Sorry, JPEG2000 not yet taken into account" );
 247       fp->seekg( JPEGInfo->GetFirstFragment()->GetOffset(), std::ios::beg);
 248 //    if ( ! gdcm_read_JPEG2000_file( fp,Raw ) )
 249           return false;
 250    }
 251
 252    if ( IsJPEGLS )
 253    {
 254       gdcmVerboseMacro( "Sorry, JPEG-LS not yet taken into account" );
 255       fp->seekg( JPEGInfo->GetFirstFragment()->GetOffset(), std::ios::beg);
 256 //    if ( ! gdcm_read_JPEGLS_file( fp,Raw ) )
 257          return false;
 258    }
 259
 260    // else ??
 261    // Precompute the offset localRaw will be shifted with
 262    int length = XSize * YSize * SamplesPerPixel;
 263    int numberBytes = BitsAllocated / 8;
 264
 265    JPEGInfo->DecompressFromFile(fp, Raw, BitsStored, numberBytes, length );
 266    return true;
 267 }
 268
 269 /**
 270  * \brief  Re-arrange the bits within the bytes.
 271  * @return Boolean
 272  */
 273 bool PixelReadConvert::ConvertReArrangeBits() throw ( FormatError )
 274 {
 275    if ( BitsStored != BitsAllocated )
 276    {
 277       int l = (int)( RawSize / ( BitsAllocated / 8 ) );
 278       if ( BitsAllocated == 16 )
 279       {
 280          uint16_t mask = 0xffff;
 281          mask = mask >> ( BitsAllocated - BitsStored );
 282          uint16_t *deb = (uint16_t*)Raw;
 283          for(int i = 0; i<l; i++)
 284          {
 285             *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & mask;
 286             deb++;
 287          }
 288       }
 289       else if ( BitsAllocated == 32 )
 290       {
 291          uint32_t mask = 0xffffffff;
 292          mask = mask >> ( BitsAllocated - BitsStored );
 293          uint32_t *deb = (uint32_t*)Raw;
 294          for(int i = 0; i<l; i++)
 295          {
 296             *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & mask;
 297             deb++;
 298          }
 299       }
 300       else
 301       {
 302          gdcmVerboseMacro("Weird image");
 303          throw FormatError( "Weird image !?" );
 304       }
 305    }
 306    return true;
 307 }
 308
 309 /**
 310  * \brief   Convert (cY plane, cB plane, cR plane) to RGB pixels
 311  * \warning Works on all the frames at a time
 312  */
 313 void PixelReadConvert::ConvertYcBcRPlanesToRGBPixels()
 314 {
 315    uint8_t *localRaw = Raw;
 316    uint8_t *copyRaw = new uint8_t[ RawSize ];
 317    memmove( copyRaw, localRaw, RawSize );
 318
 319    // to see the tricks about YBR_FULL, YBR_FULL_422,
 320    // YBR_PARTIAL_422, YBR_ICT, YBR_RCT have a look at :
 321    // ftp://medical.nema.org/medical/dicom/final/sup61_ft.pdf
 322    // and be *very* affraid
 323    //
 324    int l        = XSize * YSize;
 325    int nbFrames = ZSize;
 326
 327    uint8_t *a = copyRaw;
 328    uint8_t *b = copyRaw + l;
 329    uint8_t *c = copyRaw + l + l;
 330    double R, G, B;
 331
 332    /// \todo : Replace by the 'well known' integer computation
 333    ///         counterpart. Refer to
 334    ///            http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
 335    ///         for code optimisation.
 336
 337    for ( int i = 0; i < nbFrames; i++ )
 338    {
 339       for ( int j = 0; j < l; j++ )
 340       {
 341          R = 1.164 *(*a-16) + 1.596 *(*c -128) + 0.5;
 342          G = 1.164 *(*a-16) - 0.813 *(*c -128) - 0.392 *(*b -128) + 0.5;
 343          B = 1.164 *(*a-16) + 2.017 *(*b -128) + 0.5;
 344
 345          if (R < 0.0)   R = 0.0;
 346          if (G < 0.0)   G = 0.0;
 347          if (B < 0.0)   B = 0.0;
 348          if (R > 255.0) R = 255.0;
 349          if (G > 255.0) G = 255.0;
 350          if (B > 255.0) B = 255.0;
 351
 352          *(localRaw++) = (uint8_t)R;
 353          *(localRaw++) = (uint8_t)G;
 354          *(localRaw++) = (uint8_t)B;
 355          a++;
 356          b++;
 357          c++;
 358       }
 359    }
 360    delete[] copyRaw;
 361 }
 362
 363 /**
 364  * \brief   Convert (Red plane, Green plane, Blue plane) to RGB pixels
 365  * \warning Works on all the frames at a time
 366  */
 367 void PixelReadConvert::ConvertRGBPlanesToRGBPixels()
 368 {
 369    uint8_t *localRaw = Raw;
 370    uint8_t *copyRaw = new uint8_t[ RawSize ];
 371    memmove( copyRaw, localRaw, RawSize );
 372
 373    int l = XSize * YSize * ZSize;
 374
 375    uint8_t *a = copyRaw;
 376    uint8_t *b = copyRaw + l;
 377    uint8_t *c = copyRaw + l + l;
 378
 379    for (int j = 0; j < l; j++)
 380    {
 381       *(localRaw++) = *(a++);
 382       *(localRaw++) = *(b++);
 383       *(localRaw++) = *(c++);
 384    }
 385    delete[] copyRaw;
 386 }
 387
 388 bool PixelReadConvert::ReadAndDecompressPixelData( std::ifstream *fp )
 389 {
 390    // ComputeRawAndRGBSizes is already made by
 391    // ::GrabInformationsFromfile. So, the structure sizes are
 392    // correct
 393    Squeeze();
 394
 395    //////////////////////////////////////////////////
 396    //// First stage: get our hands on the Pixel Data.
 397    if ( !fp )
 398    {
 399       gdcmVerboseMacro( "Unavailable file pointer." );
 400       return false;
 401    }
 402
 403    fp->seekg( PixelOffset, std::ios::beg );
 404    if( fp->fail() || fp->eof())
 405    {
 406       gdcmVerboseMacro( "Unable to find PixelOffset in file." );
 407       return false;
 408    }
 409
 410    AllocateRaw();
 411
 412    //////////////////////////////////////////////////
 413    //// Second stage: read from disk dans decompress.
 414    if ( BitsAllocated == 12 )
 415    {
 416       ReadAndDecompress12BitsTo16Bits( fp);
 417    }
 418    else if ( IsRaw )
 419    {
 420       // This problem can be found when some obvious informations are found
 421       // after the field containing the image data. In this case, these
 422       // bad data are added to the size of the image (in the PixelDataLength
 423       // variable). But RawSize is the right size of the image !
 424       if( PixelDataLength != RawSize)
 425       {
 426          gdcmVerboseMacro( "Mismatch between PixelReadConvert and RawSize." );
 427       }
 428       if( PixelDataLength > RawSize)
 429       {
 430          fp->read( (char*)Raw, RawSize);
 431       }
 432       else
 433       {
 434          fp->read( (char*)Raw, PixelDataLength);
 435       }
 436
 437       if ( fp->fail() || fp->eof())
 438       {
 439          gdcmVerboseMacro( "Reading of Raw pixel data failed." );
 440          return false;
 441       }
 442    }
 443    else if ( IsRLELossless )
 444    {
 445       if ( ! RLEInfo->DecompressRLEFile( fp, Raw, XSize, YSize, ZSize, BitsAllocated ) )
 446       {
 447          gdcmVerboseMacro( "RLE decompressor failed." );
 448          return false;
 449       }
 450    }
 451    else
 452    {
 453       // Default case concerns JPEG family
 454       if ( ! ReadAndDecompressJPEGFile( fp ) )
 455       {
 456          gdcmVerboseMacro( "JPEG decompressor failed." );
 457          return false;
 458       }
 459    }
 460
 461    ////////////////////////////////////////////
 462    //// Third stage: twigle the bytes and bits.
 463    ConvertReorderEndianity();
 464    ConvertReArrangeBits();
 465    ConvertHandleColor();
 466
 467    return true;
 468 }
 469
 470 void PixelReadConvert::ConvertHandleColor()
 471 {
 472    //////////////////////////////////
 473    // Deal with the color decoding i.e. handle:
 474    //   - R, G, B planes (as opposed to RGB pixels)
 475    //   - YBR (various) encodings.
 476    //   - LUT[s] (or "PALETTE COLOR").
 477    //
 478    // The classification in the color decoding schema is based on the blending
 479    // of two Dicom tags values:
 480    // * "Photometric Interpretation" for which we have the cases:
 481    //  - [Photo A] MONOCHROME[1|2] pictures,
 482    //  - [Photo B] RGB or YBR_FULL_422 (which acts as RGB),
 483    //  - [Photo C] YBR_* (with the above exception of YBR_FULL_422)
 484    //  - [Photo D] "PALETTE COLOR" which indicates the presence of LUT[s].
 485    // * "Planar Configuration" for which we have the cases:
 486    //  - [Planar 0] 0 then Pixels are already RGB
 487    //  - [Planar 1] 1 then we have 3 planes : R, G, B,
 488    //  - [Planar 2] 2 then we have 1 gray Plane and 3 LUTs
 489    //
 490    // Now in theory, one could expect some coherence when blending the above
 491    // cases. For example we should not encounter files belonging at the
 492    // time to case [Planar 0] and case [Photo D].
 493    // Alas, this was only theory ! Because in practice some odd (read ill
 494    // formated Dicom) files (e.g. gdcmData/US-PAL-8-10x-echo.dcm) we encounter:
 495    //     - "Planar Configuration" = 0,
 496    //     - "Photometric Interpretation" = "PALETTE COLOR".
 497    // Hence gdcm will use the folowing "heuristic" in order to be tolerant
 498    // towards Dicom-non-conformance files:
 499    //   << whatever the "Planar Configuration" value might be, a
 500    //      "Photometric Interpretation" set to "PALETTE COLOR" forces
 501    //      a LUT intervention >>
 502    //
 503    // Now we are left with the following handling of the cases:
 504    // - [Planar 0] OR  [Photo A] no color decoding (since respectively
 505    //       Pixels are already RGB and monochrome pictures have no color :),
 506    // - [Planar 1] AND [Photo B] handled with ConvertRGBPlanesToRGBPixels()
 507    // - [Planar 1] AND [Photo C] handled with ConvertYcBcRPlanesToRGBPixels()
 508    // - [Planar 2] OR  [Photo D] requires LUT intervention.
 509
 510    if ( ! IsRawRGB() )
 511    {
 512       // [Planar 2] OR  [Photo D]: LUT intervention done outside
 513       return;
 514    }
 515
 516    if ( PlanarConfiguration == 1 )
 517    {
 518       if ( IsYBRFull )
 519       {
 520          // [Planar 1] AND [Photo C] (remember YBR_FULL_422 acts as RGB)
 521          ConvertYcBcRPlanesToRGBPixels();
 522       }
 523       else
 524       {
 525          // [Planar 1] AND [Photo C]
 526          ConvertRGBPlanesToRGBPixels();
 527       }
 528       return;
 529    }
 530
 531    // When planarConf is 0, and RLELossless (forbidden by Dicom norm)
 532    // pixels need to be RGB-fied anyway
 533    if (IsRLELossless)
 534    {
 535      ConvertRGBPlanesToRGBPixels();
 536    }
 537    // In *normal *case, when planarConf is 0, pixels are already in RGB
 538 }
 539
 540 /**
 541  * \brief Predicate to know wether the image[s] (once Raw) is RGB.
 542  * \note See comments of \ref ConvertHandleColor
 543  */
 544 bool PixelReadConvert::IsRawRGB()
 545 {
 546    if (   IsMonochrome
 547        || PlanarConfiguration == 2
 548        || IsPaletteColor )
 549    {
 550       return false;
 551    }
 552    return true;
 553 }
 554
 555 void PixelReadConvert::ComputeRawAndRGBSizes()
 556 {
 557    int bitsAllocated = BitsAllocated;
 558    // Number of "Bits Allocated" is fixed to 16 when it's 12, since
 559    // in this case we will expand the image to 16 bits (see
 560    //    \ref ReadAndDecompress12BitsTo16Bits() )
 561    if (  BitsAllocated == 12 )
 562    {
 563       bitsAllocated = 16;
 564    }
 565
 566    RawSize =  XSize * YSize * ZSize
 567                      * ( bitsAllocated / 8 )
 568                      * SamplesPerPixel;
 569    if ( HasLUT )
 570    {
 571       RGBSize = 3 * RawSize;
 572    }
 573    else
 574    {
 575       RGBSize = RawSize;
 576    }
 577 }
 578
 579 void PixelReadConvert::GrabInformationsFromFile( File *file )
 580 {
 581    // Number of Bits Allocated for storing a Pixel is defaulted to 16
 582    // when absent from the file.
 583    BitsAllocated = file->GetBitsAllocated();
 584    if ( BitsAllocated == 0 )
 585    {
 586       BitsAllocated = 16;
 587    }
 588
 589    // Number of "Bits Stored", defaulted to number of "Bits Allocated"
 590    // when absent from the file.
 591    BitsStored = file->GetBitsStored();
 592    if ( BitsStored == 0 )
 593    {
 594       BitsStored = BitsAllocated;
 595    }
 596
 597    // High Bit Position, defaulted to "Bits Allocated" - 1
 598    HighBitPosition = file->GetHighBitPosition();
 599    if ( HighBitPosition == 0 )
 600    {
 601       HighBitPosition = BitsAllocated - 1;
 602    }
 603
 604    XSize = file->GetXSize();
 605    YSize = file->GetYSize();
 606    ZSize = file->GetZSize();
 607    SamplesPerPixel = file->GetSamplesPerPixel();
 608    PixelSize = file->GetPixelSize();
 609    PixelSign = file->IsSignedPixelData();
 610    SwapCode  = file->GetSwapCode();
 611    std::string ts = file->GetTransferSyntax();
 612    IsRaw =
 613         ( ! file->IsDicomV3() )
 614      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian
 615      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndianDLXGE
 616      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRLittleEndian
 617      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian
 618      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::DeflatedExplicitVRLittleEndian;
 619
 620    IsJPEG2000      = Global::GetTS()->IsJPEG2000(ts);
 621    IsJPEGLS        = Global::GetTS()->IsJPEGLS(ts);
 622    IsJPEGLossy     = Global::GetTS()->IsJPEGLossy(ts);
 623    IsJPEGLossless  = Global::GetTS()->IsJPEGLossless(ts);
 624    IsRLELossless   = Global::GetTS()->IsRLELossless(ts);
 625
 626    PixelOffset     = file->GetPixelOffset();
 627    PixelDataLength = file->GetPixelAreaLength();
 628    RLEInfo  = file->GetRLEInfo();
 629    JPEGInfo = file->GetJPEGInfo();
 630
 631    PlanarConfiguration = file->GetPlanarConfiguration();
 632    IsMonochrome = file->IsMonochrome();
 633    IsPaletteColor = file->IsPaletteColor();
 634    IsYBRFull = file->IsYBRFull();
 635
 636    /////////////////////////////////////////////////////////////////
 637    // LUT section:
 638    HasLUT = file->HasLUT();
 639    if ( HasLUT )
 640    {
 641       // Just in case some access to a File element requires disk access.
 642       LutRedDescriptor   = file->GetEntryValue( 0x0028, 0x1101 );
 643       LutGreenDescriptor = file->GetEntryValue( 0x0028, 0x1102 );
 644       LutBlueDescriptor  = file->GetEntryValue( 0x0028, 0x1103 );
 645
 646       // Depending on the value of Document::MAX_SIZE_LOAD_ELEMENT_VALUE
 647       // [ refer to invocation of Document::SetMaxSizeLoadEntry() in
 648       // Document::Document() ], the loading of the value (content) of a
 649       // [Bin|Val]Entry occurence migth have been hindered (read simply NOT
 650       // loaded). Hence, we first try to obtain the LUTs data from the file
 651       // and when this fails we read the LUTs data directly from disk.
 652       /// \TODO Reading a [Bin|Val]Entry directly from disk is a kludge.
 653       ///       We should NOT bypass the [Bin|Val]Entry class. Instead
 654       ///       an access to an UNLOADED content of a [Bin|Val]Entry occurence
 655       ///       (e.g. BinEntry::GetBinArea()) should force disk access from
 656       ///       within the [Bin|Val]Entry class itself. The only problem
 657       ///       is that the [Bin|Val]Entry is unaware of the FILE* is was
 658       ///       parsed from. Fix that. FIXME.
 659
 660       ////// Red round
 661       file->LoadEntryBinArea(0x0028, 0x1201);
 662       LutRedData = (uint8_t*)file->GetEntryBinArea( 0x0028, 0x1201 );
 663       if ( ! LutRedData )
 664       {
 665          gdcmVerboseMacro( "Unable to read Red LUT data" );
 666       }
 667
 668       ////// Green round:
 669       file->LoadEntryBinArea(0x0028, 0x1202);
 670       LutGreenData = (uint8_t*)file->GetEntryBinArea(0x0028, 0x1202 );
 671       if ( ! LutGreenData)
 672       {
 673          gdcmVerboseMacro( "Unable to read Green LUT data" );
 674       }
 675
 676       ////// Blue round:
 677       file->LoadEntryBinArea(0x0028, 0x1203);
 678       LutBlueData = (uint8_t*)file->GetEntryBinArea( 0x0028, 0x1203 );
 679       if ( ! LutBlueData )
 680       {
 681          gdcmVerboseMacro( "Unable to read Blue LUT data" );
 682       }
 683    }
 684
 685    ComputeRawAndRGBSizes();
 686 }
 687
 688 /**
 689  * \brief Build Red/Green/Blue/Alpha LUT from File
 690  *         when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
 691  *          and (0028,1101),(0028,1102),(0028,1102)
 692  *            - xxx Palette Color Lookup Table Descriptor - are found
 693  *          and (0028,1201),(0028,1202),(0028,1202)
 694  *            - xxx Palette Color Lookup Table Data - are found
 695  * \warning does NOT deal with :
 696  *   0028 1100 Gray Lookup Table Descriptor (Retired)
 697  *   0028 1221 Segmented Red Palette Color Lookup Table Data
 698  *   0028 1222 Segmented Green Palette Color Lookup Table Data
 699  *   0028 1223 Segmented Blue Palette Color Lookup Table Data
 700  *   no known Dicom reader deals with them :-(
 701  * @return a RGBA Lookup Table
 702  */
 703 void PixelReadConvert::BuildLUTRGBA()
 704 {
 705    if ( LutRGBA )
 706    {
 707       return;
 708    }
 709    // Not so easy : see
 710    // http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables
 711
 712    if ( ! IsPaletteColor )
 713    {
 714       return;
 715    }
 716
 717    if (   LutRedDescriptor   == GDCM_UNFOUND
 718        || LutGreenDescriptor == GDCM_UNFOUND
 719        || LutBlueDescriptor  == GDCM_UNFOUND )
 720    {
 721       return;
 722    }
 723
 724    ////////////////////////////////////////////
 725    // Extract the info from the LUT descriptors
 726    int lengthR;   // Red LUT length in Bytes
 727    int debR;      // Subscript of the first Lut Value
 728    int nbitsR;    // Lut item size (in Bits)
 729    int nbRead = sscanf( LutRedDescriptor.c_str(),
 730                         "%d\\%d\\%d",
 731                         &lengthR, &debR, &nbitsR );
 732    if( nbRead != 3 )
 733    {
 734       gdcmVerboseMacro( "Wrong Red LUT descriptor" );
 735    }
 736
 737    int lengthG;  // Green LUT length in Bytes
 738    int debG;     // Subscript of the first Lut Value
 739    int nbitsG;   // Lut item size (in Bits)
 740    nbRead = sscanf( LutGreenDescriptor.c_str(),
 741                     "%d\\%d\\%d",
 742                     &lengthG, &debG, &nbitsG );
 743    if( nbRead != 3 )
 744    {
 745       gdcmVerboseMacro( "Wrong Green LUT descriptor" );
 746    }
 747
 748    int lengthB;  // Blue LUT length in Bytes
 749    int debB;     // Subscript of the first Lut Value
 750    int nbitsB;   // Lut item size (in Bits)
 751    nbRead = sscanf( LutRedDescriptor.c_str(),
 752                     "%d\\%d\\%d",
 753                     &lengthB, &debB, &nbitsB );
 754    if( nbRead != 3 )
 755    {
 756       gdcmVerboseMacro( "Wrong Blue LUT descriptor" );
 757    }
 758
 759    ////////////////////////////////////////////////////////
 760    if ( ( ! LutRedData ) || ( ! LutGreenData ) || ( ! LutBlueData ) )
 761    {
 762       return;
 763    }
 764
 765    ////////////////////////////////////////////////
 766    // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT
 767    LutRGBA = new uint8_t[ 1024 ]; // 256 * 4 (R, G, B, Alpha)
 768    if ( !LutRGBA )
 769       return;
 770
 771    memset( LutRGBA, 0, 1024 );
 772
 773    int mult;
 774    if ( ( nbitsR == 16 ) && ( BitsAllocated == 8 ) )
 775    {
 776       // when LUT item size is different than pixel size
 777       mult = 2; // high byte must be = low byte
 778    }
 779    else
 780    {
 781       // See PS 3.3-2003 C.11.1.1.2 p 619
 782       mult = 1;
 783    }
 784
 785    // if we get a black image, let's just remove the '+1'
 786    // from 'i*mult+1' and check again
 787    // if it works, we shall have to check the 3 Palettes
 788    // to see which byte is ==0 (first one, or second one)
 789    // and fix the code
 790    // We give up the checking to avoid some (useless ?) overhead
 791    // (optimistic asumption)
 792    int i;
 793    uint8_t *a = LutRGBA + 0;
 794    for( i=0; i < lengthR; ++i )
 795    {
 796       *a = LutRedData[i*mult+1];
 797       a += 4;
 798    }
 799
 800    a = LutRGBA + 1;
 801    for( i=0; i < lengthG; ++i)
 802    {
 803       *a = LutGreenData[i*mult+1];
 804       a += 4;
 805    }
 806
 807    a = LutRGBA + 2;
 808    for(i=0; i < lengthB; ++i)
 809    {
 810       *a = LutBlueData[i*mult+1];
 811       a += 4;
 812    }
 813
 814    a = LutRGBA + 3;
 815    for(i=0; i < 256; ++i)
 816    {
 817       *a = 1; // Alpha component
 818       a += 4;
 819    }
 820 }
 821
 822 /**
 823  * \brief Build the RGB image from the Raw imagage and the LUTs.
 824  */
 825 bool PixelReadConvert::BuildRGBImage()
 826 {
 827    if ( RGB )
 828    {
 829       // The job is already done.
 830       return true;
 831    }
 832
 833    if ( ! Raw )
 834    {
 835       // The job can't be done
 836       return false;
 837    }
 838
 839    BuildLUTRGBA();
 840    if ( ! LutRGBA )
 841    {
 842       // The job can't be done
 843       return false;
 844    }
 845
 846    // Build RGB Pixels
 847    AllocateRGB();
 848    uint8_t *localRGB = RGB;
 849    for (size_t i = 0; i < RawSize; ++i )
 850    {
 851       int j  = Raw[i] * 4;
 852       *localRGB++ = LutRGBA[j];
 853       *localRGB++ = LutRGBA[j+1];
 854       *localRGB++ = LutRGBA[j+2];
 855    }
 856    return true;
 857 }
 858
 859 //-----------------------------------------------------------------------------
 860 // Protected
 861
 862 //-----------------------------------------------------------------------------
 863 // Private
 864
 865 //-----------------------------------------------------------------------------
 866 // Print
 867 /**
 868  * \brief        Print self.
 869  * @param indent Indentation string to be prepended during printing.
 870  * @param os     Stream to print to.
 871  */
 872 void PixelReadConvert::Print( std::ostream &os, std::string const &indent )
 873 {
 874    os << indent
 875       << "--- Pixel information -------------------------"
 876       << std::endl;
 877    os << indent
 878       << "Pixel Data: offset " << PixelOffset
 879       << " x(" << std::hex << PixelOffset << std::dec
 880       << ")   length " << PixelDataLength
 881       << " x(" << std::hex << PixelDataLength << std::dec
 882       << ")" << std::endl;
 883
 884    if ( IsRLELossless )
 885    {
 886       if ( RLEInfo )
 887       {
 888          RLEInfo->Print( os, indent );
 889       }
 890       else
 891       {
 892          gdcmVerboseMacro("Set as RLE file but NO RLEinfo present.");
 893       }
 894    }
 895
 896    if ( IsJPEG2000 || IsJPEGLossless || IsJPEGLossy || IsJPEGLS )
 897    {
 898       if ( JPEGInfo )
 899       {
 900          JPEGInfo->Print( os, indent );
 901       }
 902       else
 903       {
 904          gdcmVerboseMacro("Set as JPEG file but NO JPEGinfo present.");
 905       }
 906    }
 907 }
 908
 909 //-----------------------------------------------------------------------------
 910 } // end namespace gdcm
 911
 912 // NOTES on File internal calls
 913 // User
 914 // ---> GetImageData
 915 //     ---> GetImageDataIntoVector
 916 //        |---> GetImageDataIntoVectorRaw
 917 //        | lut intervention
 918 // User
 919 // ---> GetImageDataRaw
 920 //     ---> GetImageDataIntoVectorRaw
 921