include/wx/image.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        image.h
   3 // Purpose:     wxImage class
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_IMAGE_H_
  11 #define _WX_IMAGE_H_
  12
  13 #include "wx/defs.h"
  14 #include "wx/object.h"
  15 #include "wx/string.h"
  16 #include "wx/gdicmn.h"
  17 #include "wx/hashmap.h"
  18
  19 #if wxUSE_STREAMS
  20 #  include "wx/stream.h"
  21 #endif
  22
  23 #if wxUSE_IMAGE
  24
  25 // on some systems (Unixware 7.x) index is defined as a macro in the headers
  26 // which breaks the compilation below
  27 #undef index
  28
  29 #define wxIMAGE_OPTION_QUALITY  wxString(_T("quality"))
  30 #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
  31
  32 #define wxIMAGE_OPTION_RESOLUTION            wxString(_T("Resolution"))
  33 #define wxIMAGE_OPTION_RESOLUTIONX           wxString(_T("ResolutionX"))
  34 #define wxIMAGE_OPTION_RESOLUTIONY           wxString(_T("ResolutionY"))
  35
  36 #define wxIMAGE_OPTION_RESOLUTIONUNIT        wxString(_T("ResolutionUnit"))
  37
  38 // constants used with wxIMAGE_OPTION_RESOLUTIONUNIT
  39 enum
  40 {
  41     wxIMAGE_RESOLUTION_INCHES = 1,
  42     wxIMAGE_RESOLUTION_CM = 2
  43 };
  44
  45 // alpha channel values: fully transparent, default threshold separating
  46 // transparent pixels from opaque for a few functions dealing with alpha and
  47 // fully opaque
  48 const unsigned char wxIMAGE_ALPHA_TRANSPARENT = 0;
  49 const unsigned char wxIMAGE_ALPHA_THRESHOLD = 0x80;
  50 const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff;
  51
  52 //-----------------------------------------------------------------------------
  53 // classes
  54 //-----------------------------------------------------------------------------
  55
  56 class WXDLLEXPORT wxImageHandler;
  57 class WXDLLEXPORT wxImage;
  58 class WXDLLEXPORT wxPalette;
  59
  60 //-----------------------------------------------------------------------------
  61 // wxImageHandler
  62 //-----------------------------------------------------------------------------
  63
  64 class WXDLLEXPORT wxImageHandler: public wxObject
  65 {
  66 public:
  67     wxImageHandler()
  68         : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(0)
  69         { }
  70
  71 #if wxUSE_STREAMS
  72     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
  73     virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=true );
  74
  75     virtual int GetImageCount( wxInputStream& stream );
  76
  77     bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); }
  78     bool CanRead( const wxString& name );
  79 #endif // wxUSE_STREAMS
  80
  81     void SetName(const wxString& name) { m_name = name; }
  82     void SetExtension(const wxString& ext) { m_extension = ext; }
  83     void SetType(long type) { m_type = type; }
  84     void SetMimeType(const wxString& type) { m_mime = type; }
  85     wxString GetName() const { return m_name; }
  86     wxString GetExtension() const { return m_extension; }
  87     long GetType() const { return m_type; }
  88     wxString GetMimeType() const { return m_mime; }
  89
  90 protected:
  91 #if wxUSE_STREAMS
  92     virtual bool DoCanRead( wxInputStream& stream ) = 0;
  93
  94     // save the stream position, call DoCanRead() and restore the position
  95     bool CallDoCanRead(wxInputStream& stream);
  96 #endif // wxUSE_STREAMS
  97
  98     wxString  m_name;
  99     wxString  m_extension;
 100     wxString  m_mime;
 101     long      m_type;
 102
 103 private:
 104     DECLARE_CLASS(wxImageHandler)
 105 };
 106
 107 //-----------------------------------------------------------------------------
 108 // wxImageHistogram
 109 //-----------------------------------------------------------------------------
 110
 111 class WXDLLEXPORT wxImageHistogramEntry
 112 {
 113 public:
 114     wxImageHistogramEntry() { index = value = 0; }
 115     unsigned long index;
 116     unsigned long value;
 117 };
 118
 119 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
 120                              wxIntegerHash, wxIntegerEqual,
 121                              wxImageHistogramBase);
 122
 123 class WXDLLEXPORT wxImageHistogram : public wxImageHistogramBase
 124 {
 125 public:
 126     wxImageHistogram() : wxImageHistogramBase(256) { }
 127
 128     // get the key in the histogram for the given RGB values
 129     static unsigned long MakeKey(unsigned char r,
 130                                  unsigned char g,
 131                                  unsigned char b)
 132     {
 133         return (r << 16) | (g << 8) | b;
 134     }
 135
 136     // find first colour that is not used in the image and has higher
 137     // RGB values than RGB(startR, startG, startB)
 138     //
 139     // returns true and puts this colour in r, g, b (each of which may be NULL)
 140     // on success or returns false if there are no more free colours
 141     bool FindFirstUnusedColour(unsigned char *r,
 142                                unsigned char *g,
 143                                unsigned char *b,
 144                                unsigned char startR = 1,
 145                                unsigned char startG = 0,
 146                                unsigned char startB = 0 ) const;
 147 };
 148
 149 //-----------------------------------------------------------------------------
 150 // wxImage
 151 //-----------------------------------------------------------------------------
 152
 153 class WXDLLEXPORT wxImage: public wxObject
 154 {
 155 public:
 156     // red, green and blue are 8 bit unsigned integers in the range of 0..255
 157     // We use the identifier RGBValue instead of RGB, since RGB is #defined
 158     class RGBValue
 159     {
 160     public:
 161       RGBValue(unsigned char r=0, unsigned char g=0, unsigned char b=0)
 162         : red(r), green(g), blue(b) {}
 163         unsigned char red;
 164         unsigned char green;
 165         unsigned char blue;
 166     };
 167
 168     // hue, saturation and value are doubles in the range 0.0..1.0
 169     class HSVValue
 170     {
 171     public:
 172         HSVValue(double h=0.0, double s=0.0, double v=0.0)
 173             : hue(h), saturation(s), value(v) {}
 174         double hue;
 175         double saturation;
 176         double value;
 177     };
 178
 179     wxImage(){}
 180     wxImage( int width, int height, bool clear = true );
 181     wxImage( int width, int height, unsigned char* data, bool static_data = false );
 182     wxImage( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
 183     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 184     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );
 185     wxImage( const char** xpmData );
 186     wxImage( char** xpmData );
 187
 188 #if wxUSE_STREAMS
 189     wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 190     wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 191 #endif // wxUSE_STREAMS
 192
 193     wxImage( const wxImage& image );
 194     wxImage( const wxImage* image );
 195
 196     bool Create( int width, int height, bool clear = true );
 197     bool Create( int width, int height, unsigned char* data, bool static_data = false );
 198     bool Create( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
 199     bool Create( const char** xpmData );
 200     void Destroy();
 201
 202     // creates an identical copy of the image (the = operator
 203     // just raises the ref count)
 204     wxImage Copy() const;
 205
 206     // return the new image with size width*height
 207     wxImage GetSubImage( const wxRect& rect) const;
 208
 209     // Paste the image or part of this image into an image of the given size at the pos
 210     //  any newly exposed areas will be filled with the rgb colour
 211     //  by default if r = g = b = -1 then fill with this image's mask colour or find and
 212     //  set a suitable mask colour
 213     wxImage Size( const wxSize& size, const wxPoint& pos,
 214                   int r = -1, int g = -1, int b = -1 ) const;
 215
 216     // pastes image into this instance and takes care of
 217     // the mask colour and out of bounds problems
 218     void Paste( const wxImage &image, int x, int y );
 219
 220     // return the new image with size width*height
 221     wxImage Scale( int width, int height ) const;
 222
 223     wxImage ShrinkBy( int xFactor , int yFactor ) const ;
 224
 225     // rescales the image in place
 226     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 227
 228     // resizes the image in place
 229     wxImage& Resize( const wxSize& size, const wxPoint& pos,
 230                      int r = -1, int g = -1, int b = -1 ) { return *this = Size(size, pos, r, g, b); }
 231
 232     // Rotates the image about the given point, 'angle' radians.
 233     // Returns the rotated image, leaving this image intact.
 234     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
 235                    bool interpolating = true, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;
 236
 237     wxImage Rotate90( bool clockwise = true ) const;
 238     wxImage Mirror( bool horizontally = true ) const;
 239
 240     // replace one colour with another
 241     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
 242                   unsigned char r2, unsigned char g2, unsigned char b2 );
 243
 244     // convert to monochrome image (<r,g,b> will be replaced by white,
 245     // everything else by black)
 246     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 247
 248     // these routines are slow but safe
 249     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
 250     void SetRGB( const wxRect& rect, unsigned char r, unsigned char g, unsigned char b );
 251     unsigned char GetRed( int x, int y ) const;
 252     unsigned char GetGreen( int x, int y ) const;
 253     unsigned char GetBlue( int x, int y ) const;
 254
 255     void SetAlpha(int x, int y, unsigned char alpha);
 256     unsigned char GetAlpha(int x, int y) const;
 257
 258     // find first colour that is not used in the image and has higher
 259     // RGB values than <startR,startG,startB>
 260     bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b,
 261                                 unsigned char startR = 1, unsigned char startG = 0,
 262                                 unsigned char startB = 0 ) const;
 263     // Set image's mask to the area of 'mask' that has <r,g,b> colour
 264     bool SetMaskFromImage(const wxImage & mask,
 265                           unsigned char mr, unsigned char mg, unsigned char mb);
 266
 267     // converts image's alpha channel to mask, if it has any, does nothing
 268     // otherwise:
 269     bool ConvertAlphaToMask(unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD);
 270
 271     // This method converts an image where the original alpha
 272     // information is only available as a shades of a colour
 273     // (actually shades of grey) typically when you draw anti-
 274     // aliased text into a bitmap. The DC drawinf routines
 275     // draw grey values on the black background although they
 276     // actually mean to draw white with differnt alpha values.
 277     // This method reverses it, assuming a black (!) background
 278     // and white text (actually only the red channel is read).
 279     // The method will then fill up the whole image with the
 280     // colour given.
 281     bool ConvertColourToAlpha( unsigned char r, unsigned char g, unsigned char b );
 282
 283     static bool CanRead( const wxString& name );
 284     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
 285     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 286     virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );
 287
 288 #if wxUSE_STREAMS
 289     static bool CanRead( wxInputStream& stream );
 290     static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
 291     virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 292     virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 293 #endif
 294
 295     virtual bool SaveFile( const wxString& name ) const;
 296     virtual bool SaveFile( const wxString& name, int type ) const;
 297     virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const;
 298
 299 #if wxUSE_STREAMS
 300     virtual bool SaveFile( wxOutputStream& stream, int type ) const;
 301     virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const;
 302 #endif
 303
 304     bool Ok() const;
 305     int GetWidth() const;
 306     int GetHeight() const;
 307
 308     // these functions provide fastest access to wxImage data but should be
 309     // used carefully as no checks are done
 310     unsigned char *GetData() const;
 311     void SetData( unsigned char *data, bool static_data=false );
 312     void SetData( unsigned char *data, int new_width, int new_height, bool static_data=false );
 313
 314     unsigned char *GetAlpha() const;    // may return NULL!
 315     bool HasAlpha() const { return GetAlpha() != NULL; }
 316     void SetAlpha(unsigned char *alpha = NULL, bool static_data=false);
 317     void InitAlpha();
 318
 319     // return true if this pixel is masked or has alpha less than specified
 320     // threshold
 321     bool IsTransparent(int x, int y,
 322                        unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD) const;
 323
 324     // Mask functions
 325     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
 326     // Get the current mask colour or find a suitable colour
 327     // returns true if using current mask colour
 328     bool GetOrFindMaskColour( unsigned char *r, unsigned char *g, unsigned char *b ) const;
 329     unsigned char GetMaskRed() const;
 330     unsigned char GetMaskGreen() const;
 331     unsigned char GetMaskBlue() const;
 332     void SetMask( bool mask = true );
 333     bool HasMask() const;
 334
 335 #if wxUSE_PALETTE
 336     // Palette functions
 337     bool HasPalette() const;
 338     const wxPalette& GetPalette() const;
 339     void SetPalette(const wxPalette& palette);
 340 #endif // wxUSE_PALETTE
 341
 342     // Option functions (arbitrary name/value mapping)
 343     void SetOption(const wxString& name, const wxString& value);
 344     void SetOption(const wxString& name, int value);
 345     wxString GetOption(const wxString& name) const;
 346     int GetOptionInt(const wxString& name) const;
 347     bool HasOption(const wxString& name) const;
 348
 349     unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ) const;
 350
 351     // Computes the histogram of the image and fills a hash table, indexed
 352     // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry
 353     // objects. Each of them contains an 'index' (useful to build a palette
 354     // with the image colours) and a 'value', which is the number of pixels
 355     // in the image with that colour.
 356     // Returned value: # of entries in the histogram
 357     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
 358
 359     // Rotates the hue of each pixel of the image. angle is a double in the range
 360     // -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
 361     void RotateHue(double angle);
 362
 363     wxImage& operator = (const wxImage& image)
 364     {
 365         if ( (*this) != image )
 366             Ref(image);
 367         return *this;
 368     }
 369
 370     bool operator == (const wxImage& image) const
 371         { return m_refData == image.m_refData; }
 372     bool operator != (const wxImage& image) const
 373         { return m_refData != image.m_refData; }
 374
 375     static wxList& GetHandlers() { return sm_handlers; }
 376     static void AddHandler( wxImageHandler *handler );
 377     static void InsertHandler( wxImageHandler *handler );
 378     static bool RemoveHandler( const wxString& name );
 379     static wxImageHandler *FindHandler( const wxString& name );
 380     static wxImageHandler *FindHandler( const wxString& extension, long imageType );
 381     static wxImageHandler *FindHandler( long imageType );
 382     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 383
 384     static wxString GetImageExtWildcard();
 385
 386     static void CleanUpHandlers();
 387     static void InitStandardHandlers();
 388
 389     static HSVValue RGBtoHSV(const RGBValue& rgb);
 390     static RGBValue HSVtoRGB(const HSVValue& hsv);
 391
 392
 393 protected:
 394     static wxList   sm_handlers;
 395
 396     // return the index of the point with the given coordinates or -1 if the
 397     // image is invalid of the coordinates are out of range
 398     //
 399     // note that index must be multiplied by 3 when using it with RGB array
 400     long XYToIndex(int x, int y) const;
 401
 402 private:
 403     friend class WXDLLEXPORT wxImageHandler;
 404
 405     DECLARE_DYNAMIC_CLASS(wxImage)
 406 };
 407
 408
 409 extern void WXDLLEXPORT wxInitAllImageHandlers();
 410
 411 extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;
 412
 413 //-----------------------------------------------------------------------------
 414 // wxImage handlers
 415 //-----------------------------------------------------------------------------
 416
 417 #include "wx/imagbmp.h"
 418 #include "wx/imagpng.h"
 419 #include "wx/imaggif.h"
 420 #include "wx/imagpcx.h"
 421 #include "wx/imagjpeg.h"
 422 #include "wx/imagtiff.h"
 423 #include "wx/imagpnm.h"
 424 #include "wx/imagxpm.h"
 425 #include "wx/imagiff.h"
 426
 427 #endif // wxUSE_IMAGE
 428
 429 #endif
 430   // _WX_IMAGE_H_
 431