X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1044a386f0521b9b805b142547783acb96d1a406..ef094fa075bc56bcbc33b12159c395ea28afda3b:/include/wx/image.h?ds=sidebyside diff --git a/include/wx/image.h b/include/wx/image.h index b02c3dddfe..12a0223cc7 100644 --- a/include/wx/image.h +++ b/include/wx/image.h @@ -10,7 +10,7 @@ #ifndef _WX_IMAGE_H_ #define _WX_IMAGE_H_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(__APPLE__) #pragma interface "image.h" #endif @@ -18,34 +18,30 @@ #include "wx/object.h" #include "wx/string.h" #include "wx/gdicmn.h" -#include "wx/bitmap.h" +#if WXWIN_COMPATIBILITY_2_2 +# include "wx/bitmap.h" +#endif +#include "wx/hashmap.h" #if wxUSE_STREAMS # include "wx/stream.h" #endif +#if wxUSE_IMAGE + +// on some systems (Unixware 7.x) index is defined as a macro in the headers +// which breaks the compilation below +#undef index + +#define wxIMAGE_OPTION_FILENAME wxString(_T("FileName")) + //----------------------------------------------------------------------------- // classes //----------------------------------------------------------------------------- class WXDLLEXPORT wxImageHandler; -#if wxUSE_LIBPNG -class WXDLLEXPORT wxPNGHandler; -#endif -#if wxUSE_LIBJPEG -class WXDLLEXPORT wxJPEGHandler; -#endif -class WXDLLEXPORT wxBMPHandler; -#if wxUSE_GIF -class WXDLLEXPORT wxGIFHandler; -#endif -#if wxUSE_PNM -class WXDLLEXPORT wxPNMHandler; -#endif -#if wxUSE_PCX -class WXDLLEXPORT wxPCXHandler; -#endif class WXDLLEXPORT wxImage; +class WXDLLEXPORT wxPalette; //----------------------------------------------------------------------------- // wxImageHandler @@ -53,301 +49,296 @@ class WXDLLEXPORT wxImage; class WXDLLEXPORT wxImageHandler: public wxObject { - DECLARE_DYNAMIC_CLASS(wxImageHandler) - public: - wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; } + wxImageHandler() + : m_name(wxT("")), m_extension(wxT("")), m_mime(), m_type(0) + { } #if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); + virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 ); + virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); - virtual bool CanRead( const wxString& name ); -#endif - - inline void SetName(const wxString& name) { m_name = name; } - inline void SetExtension(const wxString& ext) { m_extension = ext; } - inline void SetType(long type) { m_type = type; } - inline void SetMimeType(const wxString& type) { m_mime = type; } - inline wxString GetName() const { return m_name; } - inline wxString GetExtension() const { return m_extension; } - inline long GetType() const { return m_type; } - inline wxString GetMimeType() const { return m_mime; } - -protected: - wxString m_name; - wxString m_extension; - wxString m_mime; - long m_type; - -}; + virtual int GetImageCount( wxInputStream& stream ); -//----------------------------------------------------------------------------- -// wxPNGHandler -//----------------------------------------------------------------------------- + bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); } + bool CanRead( const wxString& name ); +#endif // wxUSE_STREAMS -#if wxUSE_LIBPNG -class WXDLLEXPORT wxPNGHandler: public wxImageHandler -{ - DECLARE_DYNAMIC_CLASS(wxPNGHandler) - -public: - - inline wxPNGHandler() - { - m_name = "PNG file"; - m_extension = "png"; - m_type = wxBITMAP_TYPE_PNG; - m_mime = "image/png"; - }; + void SetName(const wxString& name) { m_name = name; } + void SetExtension(const wxString& ext) { m_extension = ext; } + void SetType(long type) { m_type = type; } + void SetMimeType(const wxString& type) { m_mime = type; } + wxString GetName() const { return m_name; } + wxString GetExtension() const { return m_extension; } + long GetType() const { return m_type; } + wxString GetMimeType() const { return m_mime; } +protected: #if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); -#endif -}; -#endif + virtual bool DoCanRead( wxInputStream& stream ) = 0; -//----------------------------------------------------------------------------- -// wxJPEGHandler -//----------------------------------------------------------------------------- + // save the stream position, call DoCanRead() and restore the position + bool CallDoCanRead(wxInputStream& stream); +#endif // wxUSE_STREAMS -#if wxUSE_LIBJPEG -class WXDLLEXPORT wxJPEGHandler: public wxImageHandler -{ - DECLARE_DYNAMIC_CLASS(wxJPEGHandler) + wxString m_name; + wxString m_extension; + wxString m_mime; + long m_type; -public: - - inline wxJPEGHandler() - { - m_name = "JPEG file"; - m_extension = "jpg"; - m_type = wxBITMAP_TYPE_JPEG; - m_mime = "image/jpeg"; - }; - -#if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); -#endif +private: + DECLARE_CLASS(wxImageHandler) }; -#endif //----------------------------------------------------------------------------- -// wxBMPHandler +// wxImageHistogram //----------------------------------------------------------------------------- -class WXDLLEXPORT wxBMPHandler: public wxImageHandler +class WXDLLEXPORT wxImageHistogramEntry { - DECLARE_DYNAMIC_CLASS(wxBMPHandler) - public: - - inline wxBMPHandler() - { - m_name = "BMP file"; - m_extension = "bmp"; - m_type = wxBITMAP_TYPE_BMP; - m_mime = "image/bmp"; - }; - -#if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); -#endif + wxImageHistogramEntry() { index = value = 0; } + unsigned long index; + unsigned long value; }; -//----------------------------------------------------------------------------- -// wxGIFHandler -//----------------------------------------------------------------------------- +WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry, + wxIntegerHash, wxIntegerEqual, + wxImageHistogramBase); -#if wxUSE_LIBGIF - -class WXDLLEXPORT wxGIFHandler : public wxImageHandler +class WXDLLEXPORT wxImageHistogram : public wxImageHistogramBase { - DECLARE_DYNAMIC_CLASS(wxGIFHandler) - public: - - inline wxGIFHandler() - { - m_name = "GIF file"; - m_extension = "gif"; - m_type = wxBITMAP_TYPE_GIF; - m_mime = "image/gif"; - }; - -#if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); -#endif + wxImageHistogram() : wxImageHistogramBase(256) { } + + // get the key in the histogram for the given RGB values + static unsigned long MakeKey(unsigned char r, + unsigned char g, + unsigned char b) + { + return (r << 16) | (g << 8) | b; + } + + // find first colour that is not used in the image and has higher + // RGB values than RGB(startR, startG, startB) + // + // returns true and puts this colour in r, g, b (each of which may be NULL) + // on success or returns false if there are no more free colours + bool FindFirstUnusedColour(unsigned char *r, + unsigned char *g, + unsigned char *b, + unsigned char startR = 1, + unsigned char startG = 0, + unsigned char startB = 0 ) const; }; -#endif //----------------------------------------------------------------------------- -// wxPNMHandler +// wxImage //----------------------------------------------------------------------------- -#if wxUSE_PNM -class WXDLLEXPORT wxPNMHandler : public wxImageHandler +class WXDLLEXPORT wxImage: public wxObject { - DECLARE_DYNAMIC_CLASS(wxPNMHandler) - public: - - inline wxPNMHandler() - { - m_name = "PNM file"; - m_extension = "pnm"; - m_type = wxBITMAP_TYPE_PNM; - m_mime = "image/pnm"; - }; + wxImage(); + wxImage( int width, int height, bool clear = true ); + wxImage( int width, int height, unsigned char* data, bool static_data = FALSE ); + wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ); + wxImage( const wxString& name, const wxString& mimetype, int index = -1 ); #if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); + wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); + wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 ); +#endif // wxUSE_STREAMS + + wxImage( const wxImage& image ); + wxImage( const wxImage* image ); + +#if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI + // conversion to/from wxBitmap (deprecated, use wxBitmap's methods instead): + wxDEPRECATED( wxImage(const wxBitmap &bitmap) ); + wxDEPRECATED( wxBitmap ConvertToBitmap() const ); +#ifdef __WXGTK__ + wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const; #endif -}; #endif -//----------------------------------------------------------------------------- -// wxPCXHandler -//----------------------------------------------------------------------------- + bool Create( int width, int height, bool clear = true ); + bool Create( int width, int height, unsigned char* data, bool static_data = FALSE ); + void Destroy(); -#if wxUSE_PCX -class WXDLLEXPORT wxPCXHandler : public wxImageHandler -{ - DECLARE_DYNAMIC_CLASS(wxPCXHandler) + // creates an identical copy of the image (the = operator + // just raises the ref count) + wxImage Copy() const; -public: + // return the new image with size width*height + wxImage GetSubImage( const wxRect& ) const; - inline wxPCXHandler() - { - m_name = "PCX file"; - m_extension = "pcx"; - m_type = wxBITMAP_TYPE_PCX; - m_mime = "image/pcx"; - }; + // pastes image into this instance and takes care of + // the mask colour and out of bounds problems + void Paste( const wxImage &image, int x, int y ); -#if wxUSE_STREAMS - virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE ); - virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); - virtual bool CanRead( wxInputStream& stream ); -#endif -}; -#endif - -//----------------------------------------------------------------------------- -// wxImage -//----------------------------------------------------------------------------- + // return the new image with size width*height + wxImage Scale( int width, int height ) const; -class WXDLLEXPORT wxImage: public wxObject -{ - DECLARE_DYNAMIC_CLASS(wxImage) + wxImage ShrinkBy( int xFactor , int yFactor ) const ; - friend class WXDLLEXPORT wxImageHandler; + // rescales the image in place + wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); } -public: + // Rotates the image about the given point, 'angle' radians. + // Returns the rotated image, leaving this image intact. + wxImage Rotate(double angle, const wxPoint & centre_of_rotation, + bool interpolating = TRUE, wxPoint * offset_after_rotation = (wxPoint*) NULL) const; - wxImage(); - wxImage( int width, int height ); - wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY ); - wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); - wxImage( const wxString& name, const wxString& mimetype ); - wxImage( wxInputStream& stream, const wxString& mimetype ); + wxImage Rotate90( bool clockwise = TRUE ) const; + wxImage Mirror( bool horizontally = TRUE ) const; - wxImage( const wxImage& image ); - wxImage( const wxImage* image ); + // replace one colour with another + void Replace( unsigned char r1, unsigned char g1, unsigned char b1, + unsigned char r2, unsigned char g2, unsigned char b2 ); - // these functions get implemented in /src/(platform)/bitmap.cpp - wxImage( const wxBitmap &bitmap ); - operator wxBitmap() const { return ConvertToBitmap(); } - wxBitmap ConvertToBitmap() const; + // convert to monochrome image ( will be replaced by white, everything else by black) + wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const; - void Create( int width, int height ); - void Destroy(); + // these routines are slow but safe + void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b ); + unsigned char GetRed( int x, int y ) const; + unsigned char GetGreen( int x, int y ) const; + unsigned char GetBlue( int x, int y ) const; - // return the new image with size width*height - wxImage GetSubImage( const wxRect& ) const; + void SetAlpha(int x, int y, unsigned char alpha); + unsigned char GetAlpha(int x, int y); - // return the new image with size width*height - wxImage Scale( int width, int height ) const; + // find first colour that is not used in the image and has higher + // RGB values than + bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b, + unsigned char startR = 1, unsigned char startG = 0, + unsigned char startB = 0 ) const; + // Set image's mask to the area of 'mask' that has colour + bool SetMaskFromImage(const wxImage & mask, + unsigned char mr, unsigned char mg, unsigned char mb); - // rescales the image in place - void Rescale( int width, int height ) { *this = Scale(width, height); } - - // these routines are slow but safe - void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b ); - unsigned char GetRed( int x, int y ); - unsigned char GetGreen( int x, int y ); - unsigned char GetBlue( int x, int y ); - - virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY ); - virtual bool LoadFile( const wxString& name, const wxString& mimetype ); + static bool CanRead( const wxString& name ); + static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY ); + virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ); + virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 ); #if wxUSE_STREAMS - virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); - virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype ); + static bool CanRead( wxInputStream& stream ); + static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); + virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); + virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 ); #endif - virtual bool SaveFile( const wxString& name, int type ); - virtual bool SaveFile( const wxString& name, const wxString& mimetype ); + virtual bool SaveFile( const wxString& name ) const; + virtual bool SaveFile( const wxString& name, int type ) const; + virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const; #if wxUSE_STREAMS - virtual bool SaveFile( wxOutputStream& stream, int type ); - virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ); + virtual bool SaveFile( wxOutputStream& stream, int type ) const; + virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const; #endif - bool Ok() const; - int GetWidth() const; - int GetHeight() const; - - char unsigned *GetData() const; - void SetData( char unsigned *data ); - - void SetMaskColour( unsigned char r, unsigned char g, unsigned char b ); - unsigned char GetMaskRed() const; - unsigned char GetMaskGreen() const; - unsigned char GetMaskBlue() const; - void SetMask( bool mask = TRUE ); - bool HasMask() const; - - wxImage& operator = (const wxImage& image) - { - if ( (*this) != image ) - Ref(image); - return *this; - } - - bool operator == (const wxImage& image) - { return m_refData == image.m_refData; } - bool operator != (const wxImage& image) - { return m_refData != image.m_refData; } - - static wxList& GetHandlers() { return sm_handlers; } - static void AddHandler( wxImageHandler *handler ); - static void InsertHandler( wxImageHandler *handler ); - static bool RemoveHandler( const wxString& name ); - static wxImageHandler *FindHandler( const wxString& name ); - static wxImageHandler *FindHandler( const wxString& extension, long imageType ); - static wxImageHandler *FindHandler( long imageType ); - static wxImageHandler *FindHandlerMime( const wxString& mimetype ); - - static void CleanUpHandlers(); - static void InitStandardHandlers(); + bool Ok() const; + int GetWidth() const; + int GetHeight() const; + + // these functions provide fastest access to wxImage data but should be + // used carefully as no checks are done + unsigned char *GetData() const; + void SetData( unsigned char *data ); + void SetData( unsigned char *data, int new_width, int new_height ); + + unsigned char *GetAlpha() const; // may return NULL! + bool HasAlpha() const { return GetAlpha() != NULL; } + void SetAlpha(unsigned char *alpha = NULL); + + // Mask functions + void SetMaskColour( unsigned char r, unsigned char g, unsigned char b ); + unsigned char GetMaskRed() const; + unsigned char GetMaskGreen() const; + unsigned char GetMaskBlue() const; + void SetMask( bool mask = TRUE ); + bool HasMask() const; + +#if wxUSE_PALETTE + // Palette functions + bool HasPalette() const; + const wxPalette& GetPalette() const; + void SetPalette(const wxPalette& palette); +#endif // wxUSE_PALETTE + + // Option functions (arbitrary name/value mapping) + void SetOption(const wxString& name, const wxString& value); + void SetOption(const wxString& name, int value); + wxString GetOption(const wxString& name) const; + int GetOptionInt(const wxString& name) const; + bool HasOption(const wxString& name) const; + + unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ) const; + + // Computes the histogram of the image and fills a hash table, indexed + // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry + // objects. Each of them contains an 'index' (useful to build a palette + // with the image colours) and a 'value', which is the number of pixels + // in the image with that colour. + // Returned value: # of entries in the histogram + unsigned long ComputeHistogram( wxImageHistogram &h ) const; + + wxImage& operator = (const wxImage& image) + { + if ( (*this) != image ) + Ref(image); + return *this; + } + + bool operator == (const wxImage& image) const + { return m_refData == image.m_refData; } + bool operator != (const wxImage& image) const + { return m_refData != image.m_refData; } + + static wxList& GetHandlers() { return sm_handlers; } + static void AddHandler( wxImageHandler *handler ); + static void InsertHandler( wxImageHandler *handler ); + static bool RemoveHandler( const wxString& name ); + static wxImageHandler *FindHandler( const wxString& name ); + static wxImageHandler *FindHandler( const wxString& extension, long imageType ); + static wxImageHandler *FindHandler( long imageType ); + static wxImageHandler *FindHandlerMime( const wxString& mimetype ); + + static void CleanUpHandlers(); + static void InitStandardHandlers(); protected: + static wxList sm_handlers; - static wxList sm_handlers; +private: + friend class WXDLLEXPORT wxImageHandler; + DECLARE_DYNAMIC_CLASS(wxImage) }; + +extern void WXDLLEXPORT wxInitAllImageHandlers(); + +WXDLLEXPORT_DATA(extern wxImage) wxNullImage; + +//----------------------------------------------------------------------------- +// wxImage handlers +//----------------------------------------------------------------------------- + +#include "wx/imagbmp.h" +#include "wx/imagpng.h" +#include "wx/imaggif.h" +#include "wx/imagpcx.h" +#include "wx/imagjpeg.h" +#include "wx/imagtiff.h" +#include "wx/imagpnm.h" +#include "wx/imagxpm.h" +#include "wx/imagiff.h" + +#endif // wxUSE_IMAGE + #endif // _WX_IMAGE_H_