1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxImage class
4 // Author: Robert Roebling
6 // Copyright: (c) Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
14 #pragma interface "image.h"
18 #include "wx/object.h"
19 #include "wx/string.h"
20 #include "wx/gdicmn.h"
21 #include "wx/hashmap.h"
24 # include "wx/stream.h"
29 // on some systems (Unixware 7.x) index is defined as a macro in the headers
30 // which breaks the compilation below
33 #define wxIMAGE_OPTION_QUALITY wxString(_T("quality"))
34 #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
36 #define wxIMAGE_OPTION_RESOLUTION wxString(_T("Resolution"))
37 #define wxIMAGE_OPTION_RESOLUTIONX wxString(_T("ResolutionX"))
38 #define wxIMAGE_OPTION_RESOLUTIONY wxString(_T("ResolutionY"))
40 #define wxIMAGE_OPTION_RESOLUTIONUNIT wxString(_T("ResolutionUnit"))
42 // constants used with wxIMAGE_OPTION_RESOLUTIONUNIT
45 wxIMAGE_RESOLUTION_INCHES
= 1,
46 wxIMAGE_RESOLUTION_CM
= 2
49 //-----------------------------------------------------------------------------
51 //-----------------------------------------------------------------------------
53 class WXDLLEXPORT wxImageHandler
;
54 class WXDLLEXPORT wxImage
;
55 class WXDLLEXPORT wxPalette
;
57 //-----------------------------------------------------------------------------
59 //-----------------------------------------------------------------------------
61 class WXDLLEXPORT wxImageHandler
: public wxObject
65 : m_name(wxEmptyString
), m_extension(wxEmptyString
), m_mime(), m_type(0)
69 virtual bool LoadFile( wxImage
*image
, wxInputStream
& stream
, bool verbose
=true, int index
=-1 );
70 virtual bool SaveFile( wxImage
*image
, wxOutputStream
& stream
, bool verbose
=true );
72 virtual int GetImageCount( wxInputStream
& stream
);
74 bool CanRead( wxInputStream
& stream
) { return CallDoCanRead(stream
); }
75 bool CanRead( const wxString
& name
);
76 #endif // wxUSE_STREAMS
78 void SetName(const wxString
& name
) { m_name
= name
; }
79 void SetExtension(const wxString
& ext
) { m_extension
= ext
; }
80 void SetType(long type
) { m_type
= type
; }
81 void SetMimeType(const wxString
& type
) { m_mime
= type
; }
82 wxString
GetName() const { return m_name
; }
83 wxString
GetExtension() const { return m_extension
; }
84 long GetType() const { return m_type
; }
85 wxString
GetMimeType() const { return m_mime
; }
89 virtual bool DoCanRead( wxInputStream
& stream
) = 0;
91 // save the stream position, call DoCanRead() and restore the position
92 bool CallDoCanRead(wxInputStream
& stream
);
93 #endif // wxUSE_STREAMS
101 DECLARE_CLASS(wxImageHandler
)
104 //-----------------------------------------------------------------------------
106 //-----------------------------------------------------------------------------
108 class WXDLLEXPORT wxImageHistogramEntry
111 wxImageHistogramEntry() { index
= value
= 0; }
116 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry
,
117 wxIntegerHash
, wxIntegerEqual
,
118 wxImageHistogramBase
);
120 class WXDLLEXPORT wxImageHistogram
: public wxImageHistogramBase
123 wxImageHistogram() : wxImageHistogramBase(256) { }
125 // get the key in the histogram for the given RGB values
126 static unsigned long MakeKey(unsigned char r
,
130 return (r
<< 16) | (g
<< 8) | b
;
133 // find first colour that is not used in the image and has higher
134 // RGB values than RGB(startR, startG, startB)
136 // returns true and puts this colour in r, g, b (each of which may be NULL)
137 // on success or returns false if there are no more free colours
138 bool FindFirstUnusedColour(unsigned char *r
,
141 unsigned char startR
= 1,
142 unsigned char startG
= 0,
143 unsigned char startB
= 0 ) const;
146 //-----------------------------------------------------------------------------
148 //-----------------------------------------------------------------------------
150 class WXDLLEXPORT wxImage
: public wxObject
154 wxImage( int width
, int height
, bool clear
= true );
155 wxImage( int width
, int height
, unsigned char* data
, bool static_data
= false );
156 wxImage( int width
, int height
, unsigned char* data
, unsigned char* alpha
, bool static_data
= false );
157 wxImage( const wxString
& name
, long type
= wxBITMAP_TYPE_ANY
, int index
= -1 );
158 wxImage( const wxString
& name
, const wxString
& mimetype
, int index
= -1 );
161 wxImage( wxInputStream
& stream
, long type
= wxBITMAP_TYPE_ANY
, int index
= -1 );
162 wxImage( wxInputStream
& stream
, const wxString
& mimetype
, int index
= -1 );
163 #endif // wxUSE_STREAMS
165 wxImage( const wxImage
& image
);
166 wxImage( const wxImage
* image
);
168 bool Create( int width
, int height
, bool clear
= true );
169 bool Create( int width
, int height
, unsigned char* data
, bool static_data
= false );
170 bool Create( int width
, int height
, unsigned char* data
, unsigned char* alpha
, bool static_data
= false );
173 // creates an identical copy of the image (the = operator
174 // just raises the ref count)
175 wxImage
Copy() const;
177 // return the new image with size width*height
178 wxImage
GetSubImage( const wxRect
& ) const;
180 // pastes image into this instance and takes care of
181 // the mask colour and out of bounds problems
182 void Paste( const wxImage
&image
, int x
, int y
);
184 // return the new image with size width*height
185 wxImage
Scale( int width
, int height
) const;
187 wxImage
ShrinkBy( int xFactor
, int yFactor
) const ;
189 // rescales the image in place
190 wxImage
& Rescale( int width
, int height
) { return *this = Scale(width
, height
); }
192 // Rotates the image about the given point, 'angle' radians.
193 // Returns the rotated image, leaving this image intact.
194 wxImage
Rotate(double angle
, const wxPoint
& centre_of_rotation
,
195 bool interpolating
= true, wxPoint
* offset_after_rotation
= (wxPoint
*) NULL
) const;
197 wxImage
Rotate90( bool clockwise
= true ) const;
198 wxImage
Mirror( bool horizontally
= true ) const;
200 // replace one colour with another
201 void Replace( unsigned char r1
, unsigned char g1
, unsigned char b1
,
202 unsigned char r2
, unsigned char g2
, unsigned char b2
);
204 // convert to monochrome image (<r,g,b> will be replaced by white,
205 // everything else by black)
206 wxImage
ConvertToMono( unsigned char r
, unsigned char g
, unsigned char b
) const;
208 // these routines are slow but safe
209 void SetRGB( int x
, int y
, unsigned char r
, unsigned char g
, unsigned char b
);
210 unsigned char GetRed( int x
, int y
) const;
211 unsigned char GetGreen( int x
, int y
) const;
212 unsigned char GetBlue( int x
, int y
) const;
214 void SetAlpha(int x
, int y
, unsigned char alpha
);
215 unsigned char GetAlpha(int x
, int y
) const;
217 // find first colour that is not used in the image and has higher
218 // RGB values than <startR,startG,startB>
219 bool FindFirstUnusedColour( unsigned char *r
, unsigned char *g
, unsigned char *b
,
220 unsigned char startR
= 1, unsigned char startG
= 0,
221 unsigned char startB
= 0 ) const;
222 // Set image's mask to the area of 'mask' that has <r,g,b> colour
223 bool SetMaskFromImage(const wxImage
& mask
,
224 unsigned char mr
, unsigned char mg
, unsigned char mb
);
226 // converts image's alpha channel to mask, if it has any, does nothing
228 bool ConvertAlphaToMask(unsigned char threshold
= 128);
230 // This method converts an image where the original alpha
231 // information is only available as a shades of a colour
232 // (actually shades of grey) typically when you draw anti-
233 // aliased text into a bitmap. The DC drawinf routines
234 // draw grey values on the black background although they
235 // actually mean to draw white with differnt alpha values.
236 // This method reverses it, assuming a black (!) background
237 // and white text (actually only the red channel is read).
238 // The method will then fill up the whole image with the
240 bool ConvertColourToAlpha( unsigned char r
, unsigned char g
, unsigned char b
);
242 static bool CanRead( const wxString
& name
);
243 static int GetImageCount( const wxString
& name
, long type
= wxBITMAP_TYPE_ANY
);
244 virtual bool LoadFile( const wxString
& name
, long type
= wxBITMAP_TYPE_ANY
, int index
= -1 );
245 virtual bool LoadFile( const wxString
& name
, const wxString
& mimetype
, int index
= -1 );
248 static bool CanRead( wxInputStream
& stream
);
249 static int GetImageCount( wxInputStream
& stream
, long type
= wxBITMAP_TYPE_ANY
);
250 virtual bool LoadFile( wxInputStream
& stream
, long type
= wxBITMAP_TYPE_ANY
, int index
= -1 );
251 virtual bool LoadFile( wxInputStream
& stream
, const wxString
& mimetype
, int index
= -1 );
254 virtual bool SaveFile( const wxString
& name
) const;
255 virtual bool SaveFile( const wxString
& name
, int type
) const;
256 virtual bool SaveFile( const wxString
& name
, const wxString
& mimetype
) const;
259 virtual bool SaveFile( wxOutputStream
& stream
, int type
) const;
260 virtual bool SaveFile( wxOutputStream
& stream
, const wxString
& mimetype
) const;
264 int GetWidth() const;
265 int GetHeight() const;
267 // these functions provide fastest access to wxImage data but should be
268 // used carefully as no checks are done
269 unsigned char *GetData() const;
270 void SetData( unsigned char *data
);
271 void SetData( unsigned char *data
, int new_width
, int new_height
);
273 unsigned char *GetAlpha() const; // may return NULL!
274 bool HasAlpha() const { return GetAlpha() != NULL
; }
275 void SetAlpha(unsigned char *alpha
= NULL
);
279 void SetMaskColour( unsigned char r
, unsigned char g
, unsigned char b
);
280 unsigned char GetMaskRed() const;
281 unsigned char GetMaskGreen() const;
282 unsigned char GetMaskBlue() const;
283 void SetMask( bool mask
= true );
284 bool HasMask() const;
288 bool HasPalette() const;
289 const wxPalette
& GetPalette() const;
290 void SetPalette(const wxPalette
& palette
);
291 #endif // wxUSE_PALETTE
293 // Option functions (arbitrary name/value mapping)
294 void SetOption(const wxString
& name
, const wxString
& value
);
295 void SetOption(const wxString
& name
, int value
);
296 wxString
GetOption(const wxString
& name
) const;
297 int GetOptionInt(const wxString
& name
) const;
298 bool HasOption(const wxString
& name
) const;
300 unsigned long CountColours( unsigned long stopafter
= (unsigned long) -1 ) const;
302 // Computes the histogram of the image and fills a hash table, indexed
303 // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry
304 // objects. Each of them contains an 'index' (useful to build a palette
305 // with the image colours) and a 'value', which is the number of pixels
306 // in the image with that colour.
307 // Returned value: # of entries in the histogram
308 unsigned long ComputeHistogram( wxImageHistogram
&h
) const;
310 wxImage
& operator = (const wxImage
& image
)
312 if ( (*this) != image
)
317 bool operator == (const wxImage
& image
) const
318 { return m_refData
== image
.m_refData
; }
319 bool operator != (const wxImage
& image
) const
320 { return m_refData
!= image
.m_refData
; }
322 static wxList
& GetHandlers() { return sm_handlers
; }
323 static void AddHandler( wxImageHandler
*handler
);
324 static void InsertHandler( wxImageHandler
*handler
);
325 static bool RemoveHandler( const wxString
& name
);
326 static wxImageHandler
*FindHandler( const wxString
& name
);
327 static wxImageHandler
*FindHandler( const wxString
& extension
, long imageType
);
328 static wxImageHandler
*FindHandler( long imageType
);
329 static wxImageHandler
*FindHandlerMime( const wxString
& mimetype
);
331 static wxString
GetImageExtWildcard();
333 static void CleanUpHandlers();
334 static void InitStandardHandlers();
337 static wxList sm_handlers
;
340 friend class WXDLLEXPORT wxImageHandler
;
342 DECLARE_DYNAMIC_CLASS(wxImage
)
346 extern void WXDLLEXPORT
wxInitAllImageHandlers();
348 extern WXDLLEXPORT_DATA(wxImage
) wxNullImage
;
350 //-----------------------------------------------------------------------------
352 //-----------------------------------------------------------------------------
354 #include "wx/imagbmp.h"
355 #include "wx/imagpng.h"
356 #include "wx/imaggif.h"
357 #include "wx/imagpcx.h"
358 #include "wx/imagjpeg.h"
359 #include "wx/imagtiff.h"
360 #include "wx/imagpnm.h"
361 #include "wx/imagxpm.h"
362 #include "wx/imagiff.h"
364 #endif // wxUSE_IMAGE