]> Creatis software - gdcm.git/blob - src/gdcmPixelReadConvert.h
Typo normalization
[gdcm.git] / src / gdcmPixelReadConvert.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmPixelReadConvert.h,v $
5   Language:  C++
6   Date:      $Date: 2005/02/03 10:03:07 $
7   Version:   $Revision: 1.18 $
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
20 #ifndef GDCMPIXELREADCONVERT_H
21 #define GDCMPIXELREADCONVERT_H
22
23 #include "gdcmCommon.h"
24 #include "gdcmBase.h"
25 #include "gdcmException.h"
26
27 namespace gdcm
28 {
29 class File;
30 class RLEFramesInfo;
31 class JPEGFragmentsInfo;
32
33 /**
34  * \brief Utility container for gathering the various forms the pixel data
35  *        migth take during the user demanded processes.
36  */
37 class GDCM_EXPORT PixelReadConvert : public Base
38 {
39 public:
40    PixelReadConvert();
41    virtual ~PixelReadConvert();
42
43    void Print( std::ostream &os = std::cout, std::string const &indent = "" );
44
45    // Getter accessors:
46    uint8_t *GetRGB()     { return RGB;     }
47    size_t   GetRGBSize() { return RGBSize; }
48    uint8_t *GetRaw()     { return Raw;     }
49    size_t   GetRawSize() { return RawSize; }
50    uint8_t *GetLutRGBA() { return LutRGBA; }
51
52    // Predicates:
53    bool IsRawRGB();
54
55 // In progress
56    void GrabInformationsFromFile( File *file );
57    bool ReadAndDecompressPixelData( std::ifstream *fp );
58    void Squeeze();
59    bool BuildRGBImage();
60
61 private:
62    // Use the fp:
63    void ReadAndDecompress12BitsTo16Bits( std::ifstream *fp ) 
64                                  throw ( FormatError );
65    bool ReadAndDecompressJPEGFile( std::ifstream *fp );
66
67    // In place (within Decompressed and with no fp access) decompression
68    // or convertion:
69    void BuildLUTRGBA();
70    void ConvertSwapZone();
71    void ConvertReorderEndianity();
72    bool ConvertReArrangeBits() throw ( FormatError );
73    void ConvertRGBPlanesToRGBPixels();
74    void ConvertYcBcRPlanesToRGBPixels();
75    void ConvertHandleColor();
76
77    void ComputeRawAndRGBSizes();
78    void AllocateRGB();
79    void AllocateRaw();
80
81 // Variables
82    /// Pixel data represented as RGB after LUT color interpretation.
83    uint8_t *RGB;
84    /// Size of RGB image.
85    size_t   RGBSize;
86    /// Pixel data after decompression and bit/byte rearrangement.
87    uint8_t *Raw;
88    /// Size of Decompressed image.
89    size_t   RawSize;
90    /// \brief Red/Green/Blue/Alpha LookUpTable build out of the
91    ///        Red/Green/Blue LUT descriptors (see \ref BuildLUTRGBA ).
92    uint8_t *LutRGBA;
93
94    size_t PixelOffset;
95    size_t PixelDataLength;
96    int XSize;
97    int YSize;
98    int ZSize;
99    int BitsAllocated;
100    int BitsStored;
101    int HighBitPosition;
102    int SamplesPerPixel;
103    int PixelSize;
104    bool PixelSign;
105    int SwapCode;
106
107    bool IsRaw;
108    bool IsJPEG2000;
109    bool IsJPEGLS;
110    bool IsJPEGLossless;
111    bool IsJPEGLossy;
112    bool IsJPEG;
113    bool IsRLELossless;
114
115    RLEFramesInfo *RLEInfo;
116    JPEGFragmentsInfo *JPEGInfo;
117
118    // For handling color stage
119    int PlanarConfiguration;
120    bool IsMonochrome;
121    bool IsPaletteColor;
122    bool IsYBRFull;
123    bool HasLUT;
124    // The 3 LUT descriptors may be different:
125    std::string LutRedDescriptor;
126    std::string LutGreenDescriptor;
127    std::string LutBlueDescriptor;
128    uint8_t *LutRedData;
129    uint8_t *LutGreenData;
130    uint8_t *LutBlueData;
131
132 };
133 } // end namespace gdcm
134
135 //-----------------------------------------------------------------------------
136 #endif