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