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/setup.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_FILENAME wxString(_T("FileName"))
  34
  35 #define wxIMAGE_OPTION_RESOLUTION            wxString(_T("Resolution"))
  36 #define wxIMAGE_OPTION_RESOLUTIONX           wxString(_T("ResolutionX"))
  37 #define wxIMAGE_OPTION_RESOLUTIONY           wxString(_T("ResolutionY"))
  38
  39 #define wxIMAGE_OPTION_RESOLUTIONUNIT        wxString(_T("ResolutionUnit"))
  40
  41 // constants used with wxIMAGE_OPTION_RESOLUTIONUNIT
  42 enum
  43 {
  44     wxIMAGE_RESOLUTION_INCHES = 1,
  45     wxIMAGE_RESOLUTION_CM = 2
  46 };
  47
  48 //-----------------------------------------------------------------------------
  49 // classes
  50 //-----------------------------------------------------------------------------
  51
  52 class WXDLLEXPORT wxImageHandler;
  53 class WXDLLEXPORT wxImage;
  54 class WXDLLEXPORT wxPalette;
  55
  56 //-----------------------------------------------------------------------------
  57 // wxImageHandler
  58 //-----------------------------------------------------------------------------
  59
  60 class WXDLLEXPORT wxImageHandler: public wxObject
  61 {
  62 public:
  63     wxImageHandler()
  64         : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(0)
  65         { }
  66
  67 #if wxUSE_STREAMS
  68     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
  69     virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=true );
  70
  71     virtual int GetImageCount( wxInputStream& stream );
  72
  73     bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); }
  74     bool CanRead( const wxString& name );
  75 #endif // wxUSE_STREAMS
  76
  77     void SetName(const wxString& name) { m_name = name; }
  78     void SetExtension(const wxString& ext) { m_extension = ext; }
  79     void SetType(long type) { m_type = type; }
  80     void SetMimeType(const wxString& type) { m_mime = type; }
  81     wxString GetName() const { return m_name; }
  82     wxString GetExtension() const { return m_extension; }
  83     long GetType() const { return m_type; }
  84     wxString GetMimeType() const { return m_mime; }
  85
  86 protected:
  87 #if wxUSE_STREAMS
  88     virtual bool DoCanRead( wxInputStream& stream ) = 0;
  89
  90     // save the stream position, call DoCanRead() and restore the position
  91     bool CallDoCanRead(wxInputStream& stream);
  92 #endif // wxUSE_STREAMS
  93
  94     wxString  m_name;
  95     wxString  m_extension;
  96     wxString  m_mime;
  97     long      m_type;
  98
  99 private:
 100     DECLARE_CLASS(wxImageHandler)
 101 };
 102
 103 //-----------------------------------------------------------------------------
 104 // wxImageHistogram
 105 //-----------------------------------------------------------------------------
 106
 107 class WXDLLEXPORT wxImageHistogramEntry
 108 {
 109 public:
 110     wxImageHistogramEntry() { index = value = 0; }
 111     unsigned long index;
 112     unsigned long value;
 113 };
 114
 115 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
 116                              wxIntegerHash, wxIntegerEqual,
 117                              wxImageHistogramBase);
 118
 119 class WXDLLEXPORT wxImageHistogram : public wxImageHistogramBase
 120 {
 121 public:
 122     wxImageHistogram() : wxImageHistogramBase(256) { }
 123
 124     // get the key in the histogram for the given RGB values
 125     static unsigned long MakeKey(unsigned char r,
 126                                  unsigned char g,
 127                                  unsigned char b)
 128     {
 129         return (r << 16) | (g << 8) | b;
 130     }
 131
 132     // find first colour that is not used in the image and has higher
 133     // RGB values than RGB(startR, startG, startB)
 134     //
 135     // returns true and puts this colour in r, g, b (each of which may be NULL)
 136     // on success or returns false if there are no more free colours
 137     bool FindFirstUnusedColour(unsigned char *r,
 138                                unsigned char *g,
 139                                unsigned char *b,
 140                                unsigned char startR = 1,
 141                                unsigned char startG = 0,
 142                                unsigned char startB = 0 ) const;
 143 };
 144
 145 //-----------------------------------------------------------------------------
 146 // wxImage
 147 //-----------------------------------------------------------------------------
 148
 149 class WXDLLEXPORT wxImage: public wxObject
 150 {
 151 public:
 152     wxImage(){}
 153     wxImage( int width, int height, bool clear = true );
 154     wxImage( int width, int height, unsigned char* data, bool static_data = false );
 155     wxImage( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
 156     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 157     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );
 158
 159 #if wxUSE_STREAMS
 160     wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 161     wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 162 #endif // wxUSE_STREAMS
 163
 164     wxImage( const wxImage& image );
 165     wxImage( const wxImage* image );
 166
 167     bool Create( int width, int height, bool clear = true );
 168     bool Create( int width, int height, unsigned char* data, bool static_data = false );
 169     bool Create( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
 170     void Destroy();
 171
 172     // creates an identical copy of the image (the = operator
 173     // just raises the ref count)
 174     wxImage Copy() const;
 175
 176     // return the new image with size width*height
 177     wxImage GetSubImage( const wxRect& ) const;
 178
 179     // pastes image into this instance and takes care of
 180     // the mask colour and out of bounds problems
 181     void Paste( const wxImage &image, int x, int y );
 182
 183     // return the new image with size width*height
 184     wxImage Scale( int width, int height ) const;
 185
 186     wxImage ShrinkBy( int xFactor , int yFactor ) const ;
 187
 188     // rescales the image in place
 189     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 190
 191     // Rotates the image about the given point, 'angle' radians.
 192     // Returns the rotated image, leaving this image intact.
 193     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
 194                    bool interpolating = true, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;
 195
 196     wxImage Rotate90( bool clockwise = true ) const;
 197     wxImage Mirror( bool horizontally = true ) const;
 198
 199     // replace one colour with another
 200     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
 201                   unsigned char r2, unsigned char g2, unsigned char b2 );
 202
 203     // convert to monochrome image (<r,g,b> will be replaced by white,
 204     // everything else by black)
 205     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 206
 207     // these routines are slow but safe
 208     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
 209     unsigned char GetRed( int x, int y ) const;
 210     unsigned char GetGreen( int x, int y ) const;
 211     unsigned char GetBlue( int x, int y ) const;
 212
 213     void SetAlpha(int x, int y, unsigned char alpha);
 214     unsigned char GetAlpha(int x, int y) const;
 215
 216     // find first colour that is not used in the image and has higher
 217     // RGB values than <startR,startG,startB>
 218     bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b,
 219                                 unsigned char startR = 1, unsigned char startG = 0,
 220                                 unsigned char startB = 0 ) const;
 221     // Set image's mask to the area of 'mask' that has <r,g,b> colour
 222     bool SetMaskFromImage(const wxImage & mask,
 223                           unsigned char mr, unsigned char mg, unsigned char mb);
 224
 225     // converts image's alpha channel to mask, if it has any, does nothing
 226     // otherwise:
 227     bool ConvertAlphaToMask(unsigned char threshold = 128);
 228
 229     // This method converts an image where the original alpha
 230     // information is only available as a shades of a colour
 231     // (actually shades of grey) typically when you draw anti-
 232     // aliased text into a bitmap. The DC drawinf routines
 233     // draw grey values on the black background although they
 234     // actually mean to draw white with differnt alpha values.
 235     // This method reverses it, assuming a black (!) background
 236     // and white text (actually only the red channel is read).
 237     // The method will then fill up the whole image with the
 238     // colour given.
 239     bool ConvertColourToAlpha( unsigned char r, unsigned char g, unsigned char b );
 240
 241     static bool CanRead( const wxString& name );
 242     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
 243     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 244     virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );
 245
 246 #if wxUSE_STREAMS
 247     static bool CanRead( wxInputStream& stream );
 248     static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
 249     virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 250     virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 251 #endif
 252
 253     virtual bool SaveFile( const wxString& name ) const;
 254     virtual bool SaveFile( const wxString& name, int type ) const;
 255     virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const;
 256
 257 #if wxUSE_STREAMS
 258     virtual bool SaveFile( wxOutputStream& stream, int type ) const;
 259     virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const;
 260 #endif
 261
 262     bool Ok() const;
 263     int GetWidth() const;
 264     int GetHeight() const;
 265
 266     // these functions provide fastest access to wxImage data but should be
 267     // used carefully as no checks are done
 268     unsigned char *GetData() const;
 269     void SetData( unsigned char *data );
 270     void SetData( unsigned char *data, int new_width, int new_height );
 271
 272     unsigned char *GetAlpha() const;    // may return NULL!
 273     bool HasAlpha() const { return GetAlpha() != NULL; }
 274     void SetAlpha(unsigned char *alpha = NULL);
 275
 276     // Mask functions
 277     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
 278     unsigned char GetMaskRed() const;
 279     unsigned char GetMaskGreen() const;
 280     unsigned char GetMaskBlue() const;
 281     void SetMask( bool mask = true );
 282     bool HasMask() const;
 283
 284 #if wxUSE_PALETTE
 285     // Palette functions
 286     bool HasPalette() const;
 287     const wxPalette& GetPalette() const;
 288     void SetPalette(const wxPalette& palette);
 289 #endif // wxUSE_PALETTE
 290
 291     // Option functions (arbitrary name/value mapping)
 292     void SetOption(const wxString& name, const wxString& value);
 293     void SetOption(const wxString& name, int value);
 294     wxString GetOption(const wxString& name) const;
 295     int GetOptionInt(const wxString& name) const;
 296     bool HasOption(const wxString& name) const;
 297
 298     unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ) const;
 299
 300     // Computes the histogram of the image and fills a hash table, indexed
 301     // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry
 302     // objects. Each of them contains an 'index' (useful to build a palette
 303     // with the image colours) and a 'value', which is the number of pixels
 304     // in the image with that colour.
 305     // Returned value: # of entries in the histogram
 306     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
 307
 308     wxImage& operator = (const wxImage& image)
 309     {
 310         if ( (*this) != image )
 311             Ref(image);
 312         return *this;
 313     }
 314
 315     bool operator == (const wxImage& image) const
 316         { return m_refData == image.m_refData; }
 317     bool operator != (const wxImage& image) const
 318         { return m_refData != image.m_refData; }
 319
 320     static wxList& GetHandlers() { return sm_handlers; }
 321     static void AddHandler( wxImageHandler *handler );
 322     static void InsertHandler( wxImageHandler *handler );
 323     static bool RemoveHandler( const wxString& name );
 324     static wxImageHandler *FindHandler( const wxString& name );
 325     static wxImageHandler *FindHandler( const wxString& extension, long imageType );
 326     static wxImageHandler *FindHandler( long imageType );
 327     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 328
 329     static wxString GetImageExtWildcard();
 330
 331     static void CleanUpHandlers();
 332     static void InitStandardHandlers();
 333
 334 protected:
 335     static wxList   sm_handlers;
 336
 337 private:
 338     friend class WXDLLEXPORT wxImageHandler;
 339
 340     DECLARE_DYNAMIC_CLASS(wxImage)
 341 };
 342
 343
 344 extern void WXDLLEXPORT wxInitAllImageHandlers();
 345
 346 extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;
 347
 348 //-----------------------------------------------------------------------------
 349 // wxImage handlers
 350 //-----------------------------------------------------------------------------
 351
 352 #include "wx/imagbmp.h"
 353 #include "wx/imagpng.h"
 354 #include "wx/imaggif.h"
 355 #include "wx/imagpcx.h"
 356 #include "wx/imagjpeg.h"
 357 #include "wx/imagtiff.h"
 358 #include "wx/imagpnm.h"
 359 #include "wx/imagxpm.h"
 360 #include "wx/imagiff.h"
 361
 362 #endif // wxUSE_IMAGE
 363
 364 #endif
 365   // _WX_IMAGE_H_
 366