include/wx/image.h

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