src/gdcmPixelReadConvert.cxx

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