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