// Name: src/common/image.cpp
// Purpose: wxImage
// Author: Robert Roebling
-// RCS-ID: $Id$
// Copyright: (c) Robert Roebling
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/module.h"
#include "wx/palette.h"
#include "wx/intl.h"
+ #include "wx/colour.h"
#endif
-#include "wx/filefn.h"
#include "wx/wfstream.h"
-
-#if wxUSE_XPM
- #include "wx/xpmdecod.h"
-#endif
+#include "wx/xpmdecod.h"
// For memcpy
#include <string.h>
#define HAS_FILE_STREAMS (wxUSE_STREAMS && (wxUSE_FILE || wxUSE_FFILE))
#if HAS_FILE_STREAMS
- #if wxUSE_FILE
- typedef wxFileInputStream wxImageFileInputStream;
- typedef wxFileOutputStream wxImageFileOutputStream;
- #elif wxUSE_FFILE
+ #if wxUSE_FFILE
typedef wxFFileInputStream wxImageFileInputStream;
typedef wxFFileOutputStream wxImageFileOutputStream;
+ #elif wxUSE_FILE
+ typedef wxFileInputStream wxImageFileInputStream;
+ typedef wxFileOutputStream wxImageFileOutputStream;
#endif // wxUSE_FILE/wxUSE_FFILE
#endif // HAS_FILE_STREAMS
+#if wxUSE_VARIANT
+IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(wxImage,WXDLLEXPORT)
+#endif
+
//-----------------------------------------------------------------------------
-// wxImage
+// global data
+//-----------------------------------------------------------------------------
+
+wxList wxImage::sm_handlers;
+wxImage wxNullImage;
+
+//-----------------------------------------------------------------------------
+// wxImageRefData
//-----------------------------------------------------------------------------
class wxImageRefData: public wxObjectRefData
int m_width;
int m_height;
+ wxBitmapType m_type;
unsigned char *m_data;
bool m_hasMask;
wxArrayString m_optionNames;
wxArrayString m_optionValues;
- DECLARE_NO_COPY_CLASS(wxImageRefData)
+ wxDECLARE_NO_COPY_CLASS(wxImageRefData);
};
wxImageRefData::wxImageRefData()
{
m_width = 0;
m_height = 0;
+ m_type = wxBITMAP_TYPE_INVALID;
m_data =
m_alpha = (unsigned char *) NULL;
free( m_alpha );
}
-wxList wxImage::sm_handlers;
-
-wxImage wxNullImage;
+//-----------------------------------------------------------------------------
+// wxImage
//-----------------------------------------------------------------------------
-#define M_IMGDATA wx_static_cast(wxImageRefData*, m_refData)
+#define M_IMGDATA static_cast<wxImageRefData*>(m_refData)
IMPLEMENT_DYNAMIC_CLASS(wxImage, wxObject)
-wxImage::wxImage( int width, int height, bool clear )
-{
- Create( width, height, clear );
-}
-
-wxImage::wxImage( int width, int height, unsigned char* data, bool static_data )
-{
- Create( width, height, data, static_data );
-}
-
-wxImage::wxImage( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data )
-{
- Create( width, height, data, alpha, static_data );
-}
-
-wxImage::wxImage( const wxString& name, long type, int index )
-{
- LoadFile( name, type, index );
-}
-
-wxImage::wxImage( const wxString& name, const wxString& mimetype, int index )
-{
- LoadFile( name, mimetype, index );
-}
-
-#if wxUSE_STREAMS
-wxImage::wxImage( wxInputStream& stream, long type, int index )
-{
- LoadFile( stream, type, index );
-}
-
-wxImage::wxImage( wxInputStream& stream, const wxString& mimetype, int index )
-{
- LoadFile( stream, mimetype, index );
-}
-#endif // wxUSE_STREAMS
-
-wxImage::wxImage( const char** xpmData )
-{
- Create(xpmData);
-}
-
-wxImage::wxImage( char** xpmData )
-{
- Create((const char**) xpmData);
-}
-
-bool wxImage::Create( const char** xpmData )
+bool wxImage::Create(const char* const* xpmData)
{
#if wxUSE_XPM
UnRef();
wxXPMDecoder decoder;
(*this) = decoder.ReadData(xpmData);
- return Ok();
+ return IsOk();
#else
+ wxUnusedVar(xpmData);
return false;
#endif
}
return false;
}
- if (clear)
- memset(M_IMGDATA->m_data, 0, width*height*3);
-
M_IMGDATA->m_width = width;
M_IMGDATA->m_height = height;
M_IMGDATA->m_ok = true;
+ if (clear)
+ {
+ Clear();
+ }
+
return true;
}
{
UnRef();
- wxCHECK_MSG( data, false, _T("NULL data in wxImage::Create") );
+ wxCHECK_MSG( data, false, wxT("NULL data in wxImage::Create") );
m_refData = new wxImageRefData();
{
UnRef();
- wxCHECK_MSG( data, false, _T("NULL data in wxImage::Create") );
+ wxCHECK_MSG( data, false, wxT("NULL data in wxImage::Create") );
m_refData = new wxImageRefData();
M_IMGDATA->m_height = height;
M_IMGDATA->m_ok = true;
M_IMGDATA->m_static = static_data;
+ M_IMGDATA->m_staticAlpha = static_data;
return true;
}
UnRef();
}
+void wxImage::Clear(unsigned char value)
+{
+ memset(M_IMGDATA->m_data, value, M_IMGDATA->m_width*M_IMGDATA->m_height*3);
+}
+
wxObjectRefData* wxImage::CreateRefData() const
{
return new wxImageRefData;
wxObjectRefData* wxImage::CloneRefData(const wxObjectRefData* that) const
{
- const wxImageRefData* refData = wx_static_cast(const wxImageRefData*, that);
+ const wxImageRefData* refData = static_cast<const wxImageRefData*>(that);
wxCHECK_MSG(refData->m_ok, NULL, wxT("invalid image") );
wxImageRefData* refData_new = new wxImageRefData;
return refData_new;
}
+// returns a new image with the same dimensions, alpha, and mask as *this
+// if on_its_side is true, width and height are swapped
+wxImage wxImage::MakeEmptyClone(int flags) const
+{
+ wxImage image;
+
+ wxCHECK_MSG( IsOk(), image, wxS("invalid image") );
+
+ long height = M_IMGDATA->m_height;
+ long width = M_IMGDATA->m_width;
+
+ if ( flags & Clone_SwapOrientation )
+ wxSwap( width, height );
+
+ if ( !image.Create( width, height, false ) )
+ {
+ wxFAIL_MSG( wxS("unable to create image") );
+ return image;
+ }
+
+ if ( M_IMGDATA->m_alpha )
+ {
+ image.SetAlpha();
+ wxCHECK2_MSG( image.GetAlpha(), return wxImage(),
+ wxS("unable to create alpha channel") );
+ }
+
+ if ( M_IMGDATA->m_hasMask )
+ {
+ image.SetMaskColour( M_IMGDATA->m_maskRed,
+ M_IMGDATA->m_maskGreen,
+ M_IMGDATA->m_maskBlue );
+ }
+
+ return image;
+}
+
wxImage wxImage::Copy() const
{
wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), image, wxT("invalid image") );
image.m_refData = CloneRefData(m_refData);
wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), image, wxT("invalid image") );
// can't scale to/from 0 size
wxCHECK_MSG( (xFactor > 0) && (yFactor > 0), image,
bool hasMask = false ;
unsigned char maskRed = 0;
unsigned char maskGreen = 0;
- unsigned char maskBlue =0 ;
+ unsigned char maskBlue = 0 ;
- unsigned char *source_data = M_IMGDATA->m_data;
+ const unsigned char *source_data = M_IMGDATA->m_data;
unsigned char *target_data = data;
- unsigned char *source_alpha = 0 ;
+ const unsigned char *source_alpha = 0 ;
unsigned char *target_alpha = 0 ;
if (M_IMGDATA->m_hasMask)
{
long y_offset = (y * yFactor + y1) * old_width;
for ( int x1 = 0 ; x1 < xFactor ; ++x1 )
{
- unsigned char *pixel = source_data + 3 * ( y_offset + x * xFactor + x1 ) ;
+ const unsigned char *pixel = source_data + 3 * ( y_offset + x * xFactor + x1 ) ;
unsigned char red = pixel[0] ;
unsigned char green = pixel[1] ;
unsigned char blue = pixel[2] ;
return image;
}
-wxImage wxImage::Scale( int width, int height ) const
+wxImage
+wxImage::Scale( int width, int height, wxImageResizeQuality quality ) const
{
wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), image, wxT("invalid image") );
// can't scale to/from 0 size
wxCHECK_MSG( (width > 0) && (height > 0), image,
wxCHECK_MSG( (old_height > 0) && (old_width > 0), image,
wxT("invalid old image size") );
- if ( old_width % width == 0 && old_width >= width &&
- old_height % height == 0 && old_height >= height )
+ // If the image's new width and height are the same as the original, no
+ // need to waste time or CPU cycles
+ if ( old_width == width && old_height == height )
+ return *this;
+
+ // Resample the image using the method as specified.
+ switch ( quality )
+ {
+ case wxIMAGE_QUALITY_NEAREST:
+ if ( old_width % width == 0 && old_width >= width &&
+ old_height % height == 0 && old_height >= height )
+ {
+ return ShrinkBy( old_width / width , old_height / height );
+ }
+
+ image = ResampleNearest(width, height);
+ break;
+
+ case wxIMAGE_QUALITY_BILINEAR:
+ image = ResampleBilinear(width, height);
+ break;
+
+ case wxIMAGE_QUALITY_BICUBIC:
+ image = ResampleBicubic(width, height);
+ break;
+
+ case wxIMAGE_QUALITY_BOX_AVERAGE:
+ image = ResampleBox(width, height);
+ break;
+
+ case wxIMAGE_QUALITY_HIGH:
+ image = width < old_width && height < old_height
+ ? ResampleBox(width, height)
+ : ResampleBicubic(width, height);
+ break;
+ }
+
+ // If the original image has a mask, apply the mask to the new image
+ if (M_IMGDATA->m_hasMask)
{
- return ShrinkBy( old_width / width , old_height / height ) ;
+ image.SetMaskColour( M_IMGDATA->m_maskRed,
+ M_IMGDATA->m_maskGreen,
+ M_IMGDATA->m_maskBlue );
}
+
+ // In case this is a cursor, make sure the hotspot is scaled accordingly:
+ if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X) )
+ image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X,
+ (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X)*width)/old_width);
+ if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y) )
+ image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y,
+ (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y)*height)/old_height);
+
+ return image;
+}
+
+wxImage wxImage::ResampleNearest(int width, int height) const
+{
+ wxImage image;
image.Create( width, height, false );
unsigned char *data = image.GetData();
wxCHECK_MSG( data, image, wxT("unable to create image") );
- unsigned char *source_data = M_IMGDATA->m_data;
+ const unsigned char *source_data = M_IMGDATA->m_data;
unsigned char *target_data = data;
- unsigned char *source_alpha = 0 ;
+ const unsigned char *source_alpha = 0 ;
unsigned char *target_alpha = 0 ;
- if (M_IMGDATA->m_hasMask)
- {
- image.SetMaskColour( M_IMGDATA->m_maskRed,
- M_IMGDATA->m_maskGreen,
- M_IMGDATA->m_maskBlue );
- }
- else
+ if ( !M_IMGDATA->m_hasMask )
{
source_alpha = M_IMGDATA->m_alpha ;
if ( source_alpha )
}
}
+ long old_height = M_IMGDATA->m_height,
+ old_width = M_IMGDATA->m_width;
long x_delta = (old_width<<16) / width;
long y_delta = (old_height<<16) / height;
long y = 0;
for ( long j = 0; j < height; j++ )
- {
- unsigned char* src_line = &source_data[(y>>16)*old_width*3];
- unsigned char* src_alpha_line = source_alpha ? &source_alpha[(y>>16)*old_width] : 0 ;
+ {
+ const unsigned char* src_line = &source_data[(y>>16)*old_width*3];
+ const unsigned char* src_alpha_line = source_alpha ? &source_alpha[(y>>16)*old_width] : 0 ;
long x = 0;
for ( long i = 0; i < width; i++ )
{
- unsigned char* src_pixel = &src_line[(x>>16)*3];
- unsigned char* src_alpha_pixel = source_alpha ? &src_alpha_line[(x>>16)] : 0 ;
- dest_pixel[0] = src_pixel[0];
- dest_pixel[1] = src_pixel[1];
- dest_pixel[2] = src_pixel[2];
- dest_pixel += 3;
- if ( source_alpha )
+ const unsigned char* src_pixel = &src_line[(x>>16)*3];
+ const unsigned char* src_alpha_pixel = source_alpha ? &src_alpha_line[(x>>16)] : 0 ;
+ dest_pixel[0] = src_pixel[0];
+ dest_pixel[1] = src_pixel[1];
+ dest_pixel[2] = src_pixel[2];
+ dest_pixel += 3;
+ if ( source_alpha )
*(target_alpha++) = *src_alpha_pixel ;
- x += x_delta;
+ x += x_delta;
}
y += y_delta;
}
- // In case this is a cursor, make sure the hotspot is scaled accordingly:
- if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X) )
- image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X,
- (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X)*width)/old_width);
- if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y) )
- image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y,
- (GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y)*height)/old_height);
-
return image;
}
-wxImage wxImage::Rotate90( bool clockwise ) const
+namespace
{
- wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+struct BoxPrecalc
+{
+ int boxStart;
+ int boxEnd;
+};
- image.Create( M_IMGDATA->m_height, M_IMGDATA->m_width, false );
+inline int BoxBetween(int value, int low, int high)
+{
+ return wxMax(wxMin(value, high), low);
+}
- unsigned char *data = image.GetData();
+void ResampleBoxPrecalc(wxVector<BoxPrecalc>& boxes, int oldDim)
+{
+ const int newDim = boxes.size();
+ const double scale_factor_1 = double(oldDim) / newDim;
+ const int scale_factor_2 = (int)(scale_factor_1 / 2);
- wxCHECK_MSG( data, image, wxT("unable to create image") );
+ for ( int dst = 0; dst < newDim; ++dst )
+ {
+ // Source pixel in the Y direction
+ const int src_p = int(dst * scale_factor_1);
- unsigned char *source_data = M_IMGDATA->m_data;
- unsigned char *target_data;
- unsigned char *alpha_data = 0 ;
- unsigned char *source_alpha = 0 ;
- unsigned char *target_alpha = 0 ;
+ BoxPrecalc& precalc = boxes[dst];
+ precalc.boxStart = BoxBetween(int(src_p - scale_factor_1/2.0 + 1),
+ 0, oldDim - 1);
+ precalc.boxEnd = BoxBetween(wxMax(precalc.boxStart + 1,
+ int(src_p + scale_factor_2)),
+ 0, oldDim - 1);
+ }
+}
- if (M_IMGDATA->m_hasMask)
+} // anonymous namespace
+
+wxImage wxImage::ResampleBox(int width, int height) const
+{
+ // This function implements a simple pre-blur/box averaging method for
+ // downsampling that gives reasonably smooth results To scale the image
+ // down we will need to gather a grid of pixels of the size of the scale
+ // factor in each direction and then do an averaging of the pixels.
+
+ wxImage ret_image(width, height, false);
+
+ wxVector<BoxPrecalc> vPrecalcs(height);
+ wxVector<BoxPrecalc> hPrecalcs(width);
+
+ ResampleBoxPrecalc(vPrecalcs, M_IMGDATA->m_height);
+ ResampleBoxPrecalc(hPrecalcs, M_IMGDATA->m_width);
+
+
+ const unsigned char* src_data = M_IMGDATA->m_data;
+ const unsigned char* src_alpha = M_IMGDATA->m_alpha;
+ unsigned char* dst_data = ret_image.GetData();
+ unsigned char* dst_alpha = NULL;
+
+ if ( src_alpha )
{
- image.SetMaskColour( M_IMGDATA->m_maskRed, M_IMGDATA->m_maskGreen, M_IMGDATA->m_maskBlue );
+ ret_image.SetAlpha();
+ dst_alpha = ret_image.GetAlpha();
}
- else
+
+ int averaged_pixels, src_pixel_index;
+ double sum_r, sum_g, sum_b, sum_a;
+
+ for ( int y = 0; y < height; y++ ) // Destination image - Y direction
{
- source_alpha = M_IMGDATA->m_alpha ;
- if ( source_alpha )
+ // Source pixel in the Y direction
+ const BoxPrecalc& vPrecalc = vPrecalcs[y];
+
+ for ( int x = 0; x < width; x++ ) // Destination image - X direction
{
- image.SetAlpha() ;
- alpha_data = image.GetAlpha() ;
+ // Source pixel in the X direction
+ const BoxPrecalc& hPrecalc = hPrecalcs[x];
+
+ // Box of pixels to average
+ averaged_pixels = 0;
+ sum_r = sum_g = sum_b = sum_a = 0.0;
+
+ for ( int j = vPrecalc.boxStart; j <= vPrecalc.boxEnd; ++j )
+ {
+ for ( int i = hPrecalc.boxStart; i <= hPrecalc.boxEnd; ++i )
+ {
+ // Calculate the actual index in our source pixels
+ src_pixel_index = j * M_IMGDATA->m_width + i;
+
+ sum_r += src_data[src_pixel_index * 3 + 0];
+ sum_g += src_data[src_pixel_index * 3 + 1];
+ sum_b += src_data[src_pixel_index * 3 + 2];
+ if ( src_alpha )
+ sum_a += src_alpha[src_pixel_index];
+
+ averaged_pixels++;
+ }
+ }
+
+ // Calculate the average from the sum and number of averaged pixels
+ dst_data[0] = (unsigned char)(sum_r / averaged_pixels);
+ dst_data[1] = (unsigned char)(sum_g / averaged_pixels);
+ dst_data[2] = (unsigned char)(sum_b / averaged_pixels);
+ dst_data += 3;
+ if ( src_alpha )
+ *dst_alpha++ = (unsigned char)(sum_a / averaged_pixels);
}
}
- long height = M_IMGDATA->m_height;
- long width = M_IMGDATA->m_width;
+ return ret_image;
+}
- for (long j = 0; j < height; j++)
+namespace
+{
+
+struct BilinearPrecalc
+{
+ int offset1;
+ int offset2;
+ double dd;
+ double dd1;
+};
+
+void ResampleBilinearPrecalc(wxVector<BilinearPrecalc>& precalcs, int oldDim)
+{
+ const int newDim = precalcs.size();
+ const double scale_factor = double(oldDim) / newDim;
+ const int srcpixmax = oldDim - 1;
+
+ for ( int dsty = 0; dsty < newDim; dsty++ )
{
- for (long i = 0; i < width; i++)
+ // We need to calculate the source pixel to interpolate from - Y-axis
+ double srcpix = double(dsty) * scale_factor;
+ double srcpix1 = int(srcpix);
+ double srcpix2 = srcpix1 == srcpixmax ? srcpix1 : srcpix1 + 1.0;
+
+ BilinearPrecalc& precalc = precalcs[dsty];
+
+ precalc.dd = srcpix - (int)srcpix;
+ precalc.dd1 = 1.0 - precalc.dd;
+ precalc.offset1 = srcpix1 < 0.0
+ ? 0
+ : srcpix1 > srcpixmax
+ ? srcpixmax
+ : (int)srcpix1;
+ precalc.offset2 = srcpix2 < 0.0
+ ? 0
+ : srcpix2 > srcpixmax
+ ? srcpixmax
+ : (int)srcpix2;
+ }
+}
+
+} // anonymous namespace
+
+wxImage wxImage::ResampleBilinear(int width, int height) const
+{
+ // This function implements a Bilinear algorithm for resampling.
+ wxImage ret_image(width, height, false);
+ const unsigned char* src_data = M_IMGDATA->m_data;
+ const unsigned char* src_alpha = M_IMGDATA->m_alpha;
+ unsigned char* dst_data = ret_image.GetData();
+ unsigned char* dst_alpha = NULL;
+
+ if ( src_alpha )
+ {
+ ret_image.SetAlpha();
+ dst_alpha = ret_image.GetAlpha();
+ }
+
+ wxVector<BilinearPrecalc> vPrecalcs(height);
+ wxVector<BilinearPrecalc> hPrecalcs(width);
+ ResampleBilinearPrecalc(vPrecalcs, M_IMGDATA->m_height);
+ ResampleBilinearPrecalc(hPrecalcs, M_IMGDATA->m_width);
+
+ // initialize alpha values to avoid g++ warnings about possibly
+ // uninitialized variables
+ double r1, g1, b1, a1 = 0;
+ double r2, g2, b2, a2 = 0;
+
+ for ( int dsty = 0; dsty < height; dsty++ )
+ {
+ // We need to calculate the source pixel to interpolate from - Y-axis
+ const BilinearPrecalc& vPrecalc = vPrecalcs[dsty];
+ const int y_offset1 = vPrecalc.offset1;
+ const int y_offset2 = vPrecalc.offset2;
+ const double dy = vPrecalc.dd;
+ const double dy1 = vPrecalc.dd1;
+
+
+ for ( int dstx = 0; dstx < width; dstx++ )
+ {
+ // X-axis of pixel to interpolate from
+ const BilinearPrecalc& hPrecalc = hPrecalcs[dstx];
+
+ const int x_offset1 = hPrecalc.offset1;
+ const int x_offset2 = hPrecalc.offset2;
+ const double dx = hPrecalc.dd;
+ const double dx1 = hPrecalc.dd1;
+
+ int src_pixel_index00 = y_offset1 * M_IMGDATA->m_width + x_offset1;
+ int src_pixel_index01 = y_offset1 * M_IMGDATA->m_width + x_offset2;
+ int src_pixel_index10 = y_offset2 * M_IMGDATA->m_width + x_offset1;
+ int src_pixel_index11 = y_offset2 * M_IMGDATA->m_width + x_offset2;
+
+ // first line
+ r1 = src_data[src_pixel_index00 * 3 + 0] * dx1 + src_data[src_pixel_index01 * 3 + 0] * dx;
+ g1 = src_data[src_pixel_index00 * 3 + 1] * dx1 + src_data[src_pixel_index01 * 3 + 1] * dx;
+ b1 = src_data[src_pixel_index00 * 3 + 2] * dx1 + src_data[src_pixel_index01 * 3 + 2] * dx;
+ if ( src_alpha )
+ a1 = src_alpha[src_pixel_index00] * dx1 + src_alpha[src_pixel_index01] * dx;
+
+ // second line
+ r2 = src_data[src_pixel_index10 * 3 + 0] * dx1 + src_data[src_pixel_index11 * 3 + 0] * dx;
+ g2 = src_data[src_pixel_index10 * 3 + 1] * dx1 + src_data[src_pixel_index11 * 3 + 1] * dx;
+ b2 = src_data[src_pixel_index10 * 3 + 2] * dx1 + src_data[src_pixel_index11 * 3 + 2] * dx;
+ if ( src_alpha )
+ a2 = src_alpha[src_pixel_index10] * dx1 + src_alpha[src_pixel_index11] * dx;
+
+ // result lines
+
+ dst_data[0] = static_cast<unsigned char>(r1 * dy1 + r2 * dy);
+ dst_data[1] = static_cast<unsigned char>(g1 * dy1 + g2 * dy);
+ dst_data[2] = static_cast<unsigned char>(b1 * dy1 + b2 * dy);
+ dst_data += 3;
+
+ if ( src_alpha )
+ *dst_alpha++ = static_cast<unsigned char>(a1 * dy1 + a2 * dy);
+ }
+ }
+
+ return ret_image;
+}
+
+// The following two local functions are for the B-spline weighting of the
+// bicubic sampling algorithm
+static inline double spline_cube(double value)
+{
+ return value <= 0.0 ? 0.0 : value * value * value;
+}
+
+static inline double spline_weight(double value)
+{
+ return (spline_cube(value + 2) -
+ 4 * spline_cube(value + 1) +
+ 6 * spline_cube(value) -
+ 4 * spline_cube(value - 1)) / 6;
+}
+
+
+namespace
+{
+
+struct BicubicPrecalc
+{
+ double weight[4];
+ int offset[4];
+};
+
+void ResampleBicubicPrecalc(wxVector<BicubicPrecalc> &aWeight, int oldDim)
+{
+ const int newDim = aWeight.size();
+ for ( int dstd = 0; dstd < newDim; dstd++ )
+ {
+ // We need to calculate the source pixel to interpolate from - Y-axis
+ const double srcpixd = static_cast<double>(dstd * oldDim) / newDim;
+ const double dd = srcpixd - static_cast<int>(srcpixd);
+
+ BicubicPrecalc &precalc = aWeight[dstd];
+
+ for ( int k = -1; k <= 2; k++ )
{
- if (clockwise)
+ precalc.offset[k + 1] = srcpixd + k < 0.0
+ ? 0
+ : srcpixd + k >= oldDim
+ ? oldDim - 1
+ : static_cast<int>(srcpixd + k);
+
+ precalc.weight[k + 1] = spline_weight(k - dd);
+ }
+ }
+}
+
+} // anonymous namespace
+
+// This is the bicubic resampling algorithm
+wxImage wxImage::ResampleBicubic(int width, int height) const
+{
+ // This function implements a Bicubic B-Spline algorithm for resampling.
+ // This method is certainly a little slower than wxImage's default pixel
+ // replication method, however for most reasonably sized images not being
+ // upsampled too much on a fairly average CPU this difference is hardly
+ // noticeable and the results are far more pleasing to look at.
+ //
+ // This particular bicubic algorithm does pixel weighting according to a
+ // B-Spline that basically implements a Gaussian bell-like weighting
+ // kernel. Because of this method the results may appear a bit blurry when
+ // upsampling by large factors. This is basically because a slight
+ // gaussian blur is being performed to get the smooth look of the upsampled
+ // image.
+
+ // Edge pixels: 3-4 possible solutions
+ // - (Wrap/tile) Wrap the image, take the color value from the opposite
+ // side of the image.
+ // - (Mirror) Duplicate edge pixels, so that pixel at coordinate (2, n),
+ // where n is nonpositive, will have the value of (2, 1).
+ // - (Ignore) Simply ignore the edge pixels and apply the kernel only to
+ // pixels which do have all neighbours.
+ // - (Clamp) Choose the nearest pixel along the border. This takes the
+ // border pixels and extends them out to infinity.
+ //
+ // NOTE: below the y_offset and x_offset variables are being set for edge
+ // pixels using the "Mirror" method mentioned above
+
+ wxImage ret_image;
+
+ ret_image.Create(width, height, false);
+
+ const unsigned char* src_data = M_IMGDATA->m_data;
+ const unsigned char* src_alpha = M_IMGDATA->m_alpha;
+ unsigned char* dst_data = ret_image.GetData();
+ unsigned char* dst_alpha = NULL;
+
+ if ( src_alpha )
+ {
+ ret_image.SetAlpha();
+ dst_alpha = ret_image.GetAlpha();
+ }
+
+ // Precalculate weights
+ wxVector<BicubicPrecalc> vPrecalcs(height);
+ wxVector<BicubicPrecalc> hPrecalcs(width);
+
+ ResampleBicubicPrecalc(vPrecalcs, M_IMGDATA->m_height);
+ ResampleBicubicPrecalc(hPrecalcs, M_IMGDATA->m_width);
+
+ for ( int dsty = 0; dsty < height; dsty++ )
+ {
+ // We need to calculate the source pixel to interpolate from - Y-axis
+ const BicubicPrecalc& vPrecalc = vPrecalcs[dsty];
+
+ for ( int dstx = 0; dstx < width; dstx++ )
+ {
+ // X-axis of pixel to interpolate from
+ const BicubicPrecalc& hPrecalc = hPrecalcs[dstx];
+
+ // Sums for each color channel
+ double sum_r = 0, sum_g = 0, sum_b = 0, sum_a = 0;
+
+ // Here we actually determine the RGBA values for the destination pixel
+ for ( int k = -1; k <= 2; k++ )
{
- target_data = data + (((i+1)*height) - j - 1)*3;
- if(source_alpha)
- target_alpha = alpha_data + (((i+1)*height) - j - 1);
+ // Y offset
+ const int y_offset = vPrecalc.offset[k + 1];
+
+ // Loop across the X axis
+ for ( int i = -1; i <= 2; i++ )
+ {
+ // X offset
+ const int x_offset = hPrecalc.offset[i + 1];
+
+ // Calculate the exact position where the source data
+ // should be pulled from based on the x_offset and y_offset
+ int src_pixel_index = y_offset*M_IMGDATA->m_width + x_offset;
+
+ // Calculate the weight for the specified pixel according
+ // to the bicubic b-spline kernel we're using for
+ // interpolation
+ const double
+ pixel_weight = vPrecalc.weight[k + 1] * hPrecalc.weight[i + 1];
+
+ // Create a sum of all velues for each color channel
+ // adjusted for the pixel's calculated weight
+ sum_r += src_data[src_pixel_index * 3 + 0] * pixel_weight;
+ sum_g += src_data[src_pixel_index * 3 + 1] * pixel_weight;
+ sum_b += src_data[src_pixel_index * 3 + 2] * pixel_weight;
+ if ( src_alpha )
+ sum_a += src_alpha[src_pixel_index] * pixel_weight;
+ }
}
+
+ // Put the data into the destination image. The summed values are
+ // of double data type and are rounded here for accuracy
+ dst_data[0] = (unsigned char)(sum_r + 0.5);
+ dst_data[1] = (unsigned char)(sum_g + 0.5);
+ dst_data[2] = (unsigned char)(sum_b + 0.5);
+ dst_data += 3;
+
+ if ( src_alpha )
+ *dst_alpha++ = (unsigned char)sum_a;
+ }
+ }
+
+ return ret_image;
+}
+
+// Blur in the horizontal direction
+wxImage wxImage::BlurHorizontal(int blurRadius) const
+{
+ wxImage ret_image(MakeEmptyClone());
+
+ wxCHECK( ret_image.IsOk(), ret_image );
+
+ const unsigned char* src_data = M_IMGDATA->m_data;
+ unsigned char* dst_data = ret_image.GetData();
+ const unsigned char* src_alpha = M_IMGDATA->m_alpha;
+ unsigned char* dst_alpha = ret_image.GetAlpha();
+
+ // number of pixels we average over
+ const int blurArea = blurRadius*2 + 1;
+
+ // Horizontal blurring algorithm - average all pixels in the specified blur
+ // radius in the X or horizontal direction
+ for ( int y = 0; y < M_IMGDATA->m_height; y++ )
+ {
+ // Variables used in the blurring algorithm
+ long sum_r = 0,
+ sum_g = 0,
+ sum_b = 0,
+ sum_a = 0;
+
+ long pixel_idx;
+ const unsigned char *src;
+ unsigned char *dst;
+
+ // Calculate the average of all pixels in the blur radius for the first
+ // pixel of the row
+ for ( int kernel_x = -blurRadius; kernel_x <= blurRadius; kernel_x++ )
+ {
+ // To deal with the pixels at the start of a row so it's not
+ // grabbing GOK values from memory at negative indices of the
+ // image's data or grabbing from the previous row
+ if ( kernel_x < 0 )
+ pixel_idx = y * M_IMGDATA->m_width;
+ else
+ pixel_idx = kernel_x + y * M_IMGDATA->m_width;
+
+ src = src_data + pixel_idx*3;
+ sum_r += src[0];
+ sum_g += src[1];
+ sum_b += src[2];
+ if ( src_alpha )
+ sum_a += src_alpha[pixel_idx];
+ }
+
+ dst = dst_data + y * M_IMGDATA->m_width*3;
+ dst[0] = (unsigned char)(sum_r / blurArea);
+ dst[1] = (unsigned char)(sum_g / blurArea);
+ dst[2] = (unsigned char)(sum_b / blurArea);
+ if ( src_alpha )
+ dst_alpha[y * M_IMGDATA->m_width] = (unsigned char)(sum_a / blurArea);
+
+ // Now average the values of the rest of the pixels by just moving the
+ // blur radius box along the row
+ for ( int x = 1; x < M_IMGDATA->m_width; x++ )
+ {
+ // Take care of edge pixels on the left edge by essentially
+ // duplicating the edge pixel
+ if ( x - blurRadius - 1 < 0 )
+ pixel_idx = y * M_IMGDATA->m_width;
else
+ pixel_idx = (x - blurRadius - 1) + y * M_IMGDATA->m_width;
+
+ // Subtract the value of the pixel at the left side of the blur
+ // radius box
+ src = src_data + pixel_idx*3;
+ sum_r -= src[0];
+ sum_g -= src[1];
+ sum_b -= src[2];
+ if ( src_alpha )
+ sum_a -= src_alpha[pixel_idx];
+
+ // Take care of edge pixels on the right edge
+ if ( x + blurRadius > M_IMGDATA->m_width - 1 )
+ pixel_idx = M_IMGDATA->m_width - 1 + y * M_IMGDATA->m_width;
+ else
+ pixel_idx = x + blurRadius + y * M_IMGDATA->m_width;
+
+ // Add the value of the pixel being added to the end of our box
+ src = src_data + pixel_idx*3;
+ sum_r += src[0];
+ sum_g += src[1];
+ sum_b += src[2];
+ if ( src_alpha )
+ sum_a += src_alpha[pixel_idx];
+
+ // Save off the averaged data
+ dst = dst_data + x*3 + y*M_IMGDATA->m_width*3;
+ dst[0] = (unsigned char)(sum_r / blurArea);
+ dst[1] = (unsigned char)(sum_g / blurArea);
+ dst[2] = (unsigned char)(sum_b / blurArea);
+ if ( src_alpha )
+ dst_alpha[x + y * M_IMGDATA->m_width] = (unsigned char)(sum_a / blurArea);
+ }
+ }
+
+ return ret_image;
+}
+
+// Blur in the vertical direction
+wxImage wxImage::BlurVertical(int blurRadius) const
+{
+ wxImage ret_image(MakeEmptyClone());
+
+ wxCHECK( ret_image.IsOk(), ret_image );
+
+ const unsigned char* src_data = M_IMGDATA->m_data;
+ unsigned char* dst_data = ret_image.GetData();
+ const unsigned char* src_alpha = M_IMGDATA->m_alpha;
+ unsigned char* dst_alpha = ret_image.GetAlpha();
+
+ // number of pixels we average over
+ const int blurArea = blurRadius*2 + 1;
+
+ // Vertical blurring algorithm - same as horizontal but switched the
+ // opposite direction
+ for ( int x = 0; x < M_IMGDATA->m_width; x++ )
+ {
+ // Variables used in the blurring algorithm
+ long sum_r = 0,
+ sum_g = 0,
+ sum_b = 0,
+ sum_a = 0;
+
+ long pixel_idx;
+ const unsigned char *src;
+ unsigned char *dst;
+
+ // Calculate the average of all pixels in our blur radius box for the
+ // first pixel of the column
+ for ( int kernel_y = -blurRadius; kernel_y <= blurRadius; kernel_y++ )
+ {
+ // To deal with the pixels at the start of a column so it's not
+ // grabbing GOK values from memory at negative indices of the
+ // image's data or grabbing from the previous column
+ if ( kernel_y < 0 )
+ pixel_idx = x;
+ else
+ pixel_idx = x + kernel_y * M_IMGDATA->m_width;
+
+ src = src_data + pixel_idx*3;
+ sum_r += src[0];
+ sum_g += src[1];
+ sum_b += src[2];
+ if ( src_alpha )
+ sum_a += src_alpha[pixel_idx];
+ }
+
+ dst = dst_data + x*3;
+ dst[0] = (unsigned char)(sum_r / blurArea);
+ dst[1] = (unsigned char)(sum_g / blurArea);
+ dst[2] = (unsigned char)(sum_b / blurArea);
+ if ( src_alpha )
+ dst_alpha[x] = (unsigned char)(sum_a / blurArea);
+
+ // Now average the values of the rest of the pixels by just moving the
+ // box along the column from top to bottom
+ for ( int y = 1; y < M_IMGDATA->m_height; y++ )
+ {
+ // Take care of pixels that would be beyond the top edge by
+ // duplicating the top edge pixel for the column
+ if ( y - blurRadius - 1 < 0 )
+ pixel_idx = x;
+ else
+ pixel_idx = x + (y - blurRadius - 1) * M_IMGDATA->m_width;
+
+ // Subtract the value of the pixel at the top of our blur radius box
+ src = src_data + pixel_idx*3;
+ sum_r -= src[0];
+ sum_g -= src[1];
+ sum_b -= src[2];
+ if ( src_alpha )
+ sum_a -= src_alpha[pixel_idx];
+
+ // Take care of the pixels that would be beyond the bottom edge of
+ // the image similar to the top edge
+ if ( y + blurRadius > M_IMGDATA->m_height - 1 )
+ pixel_idx = x + (M_IMGDATA->m_height - 1) * M_IMGDATA->m_width;
+ else
+ pixel_idx = x + (blurRadius + y) * M_IMGDATA->m_width;
+
+ // Add the value of the pixel being added to the end of our box
+ src = src_data + pixel_idx*3;
+ sum_r += src[0];
+ sum_g += src[1];
+ sum_b += src[2];
+ if ( src_alpha )
+ sum_a += src_alpha[pixel_idx];
+
+ // Save off the averaged data
+ dst = dst_data + (x + y * M_IMGDATA->m_width) * 3;
+ dst[0] = (unsigned char)(sum_r / blurArea);
+ dst[1] = (unsigned char)(sum_g / blurArea);
+ dst[2] = (unsigned char)(sum_b / blurArea);
+ if ( src_alpha )
+ dst_alpha[x + y * M_IMGDATA->m_width] = (unsigned char)(sum_a / blurArea);
+ }
+ }
+
+ return ret_image;
+}
+
+// The new blur function
+wxImage wxImage::Blur(int blurRadius) const
+{
+ wxImage ret_image;
+ ret_image.Create(M_IMGDATA->m_width, M_IMGDATA->m_height, false);
+
+ // Blur the image in each direction
+ ret_image = BlurHorizontal(blurRadius);
+ ret_image = ret_image.BlurVertical(blurRadius);
+
+ return ret_image;
+}
+
+wxImage wxImage::Rotate90( bool clockwise ) const
+{
+ wxImage image(MakeEmptyClone(Clone_SwapOrientation));
+
+ wxCHECK( image.IsOk(), image );
+
+ long height = M_IMGDATA->m_height;
+ long width = M_IMGDATA->m_width;
+
+ if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X) )
+ {
+ int hot_x = GetOptionInt( wxIMAGE_OPTION_CUR_HOTSPOT_X );
+ image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y,
+ clockwise ? hot_x : width - 1 - hot_x);
+ }
+
+ if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y) )
+ {
+ int hot_y = GetOptionInt( wxIMAGE_OPTION_CUR_HOTSPOT_Y );
+ image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X,
+ clockwise ? height - 1 - hot_y : hot_y);
+ }
+
+ unsigned char *data = image.GetData();
+ unsigned char *target_data;
+
+ // we rotate the image in 21-pixel (63-byte) wide strips
+ // to make better use of cpu cache - memory transfers
+ // (note: while much better than single-pixel "strips",
+ // our vertical strips will still generally straddle 64-byte cachelines)
+ for (long ii = 0; ii < width; )
+ {
+ long next_ii = wxMin(ii + 21, width);
+
+ for (long j = 0; j < height; j++)
+ {
+ const unsigned char *source_data
+ = M_IMGDATA->m_data + (j*width + ii)*3;
+
+ for (long i = ii; i < next_ii; i++)
{
- target_data = data + ((height*(width-1)) + j - (i*height))*3;
- if(source_alpha)
- target_alpha = alpha_data + ((height*(width-1)) + j - (i*height));
+ if ( clockwise )
+ {
+ target_data = data + ((i + 1)*height - j - 1)*3;
+ }
+ else
+ {
+ target_data = data + (height*(width - 1 - i) + j)*3;
+ }
+ memcpy( target_data, source_data, 3 );
+ source_data += 3;
}
- memcpy( target_data, source_data, 3 );
- source_data += 3;
+ }
+
+ ii = next_ii;
+ }
+
+ const unsigned char *source_alpha = M_IMGDATA->m_alpha;
- if(source_alpha)
+ if ( source_alpha )
+ {
+ unsigned char *alpha_data = image.GetAlpha();
+ unsigned char *target_alpha = 0 ;
+
+ for (long ii = 0; ii < width; )
+ {
+ long next_ii = wxMin(ii + 64, width);
+
+ for (long j = 0; j < height; j++)
{
- memcpy( target_alpha, source_alpha, 1 );
- source_alpha += 1;
+ source_alpha = M_IMGDATA->m_alpha + j*width + ii;
+
+ for (long i = ii; i < next_ii; i++)
+ {
+ if ( clockwise )
+ {
+ target_alpha = alpha_data + (i+1)*height - j - 1;
+ }
+ else
+ {
+ target_alpha = alpha_data + height*(width - i - 1) + j;
+ }
+
+ *target_alpha = *source_alpha++;
+ }
}
+
+ ii = next_ii;
}
}
return image;
}
-wxImage wxImage::Mirror( bool horizontally ) const
+wxImage wxImage::Rotate180() const
{
- wxImage image;
+ wxImage image(MakeEmptyClone());
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK( image.IsOk(), image );
- image.Create( M_IMGDATA->m_width, M_IMGDATA->m_height, false );
+ long height = M_IMGDATA->m_height;
+ long width = M_IMGDATA->m_width;
+
+ if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X) )
+ {
+ image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X,
+ width - 1 - GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X));
+ }
+
+ if ( HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y) )
+ {
+ image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y,
+ height - 1 - GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y));
+ }
unsigned char *data = image.GetData();
- unsigned char *alpha = NULL;
+ unsigned char *alpha = image.GetAlpha();
+ const unsigned char *source_data = M_IMGDATA->m_data;
+ unsigned char *target_data = data + width * height * 3;
- wxCHECK_MSG( data, image, wxT("unable to create image") );
+ for (long j = 0; j < height; j++)
+ {
+ for (long i = 0; i < width; i++)
+ {
+ target_data -= 3;
+ memcpy( target_data, source_data, 3 );
+ source_data += 3;
+ }
+ }
- if (M_IMGDATA->m_alpha != NULL) {
- image.SetAlpha();
- alpha = image.GetAlpha();
- wxCHECK_MSG( alpha, image, wxT("unable to create alpha channel") );
+ if ( alpha )
+ {
+ const unsigned char *src_alpha = M_IMGDATA->m_alpha;
+ unsigned char *dest_alpha = alpha + width * height;
+
+ for (long j = 0; j < height; ++j)
+ {
+ for (long i = 0; i < width; ++i)
+ {
+ *(--dest_alpha) = *(src_alpha++);
+ }
+ }
}
- if (M_IMGDATA->m_hasMask)
- image.SetMaskColour( M_IMGDATA->m_maskRed, M_IMGDATA->m_maskGreen, M_IMGDATA->m_maskBlue );
+ return image;
+}
+
+wxImage wxImage::Mirror( bool horizontally ) const
+{
+ wxImage image(MakeEmptyClone());
+
+ wxCHECK( image.IsOk(), image );
long height = M_IMGDATA->m_height;
long width = M_IMGDATA->m_width;
- unsigned char *source_data = M_IMGDATA->m_data;
+ unsigned char *data = image.GetData();
+ unsigned char *alpha = image.GetAlpha();
+ const unsigned char *source_data = M_IMGDATA->m_data;
unsigned char *target_data;
if (horizontally)
source_data += 3*width;
}
- if (alpha != NULL)
+ if ( alpha )
{
// src_alpha starts at the first pixel and increases by 1 width after each step
// (a step here is the copy of the alpha channel of an entire line)
{
wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), image, wxT("invalid image") );
wxCHECK_MSG( (rect.GetLeft()>=0) && (rect.GetTop()>=0) &&
(rect.GetRight()<=GetWidth()) && (rect.GetBottom()<=GetHeight()),
wxCHECK_MSG( subdata, image, wxT("unable to create image") );
- if (src_alpha != NULL) {
+ if ( src_alpha ) {
image.SetAlpha();
subalpha = image.GetAlpha();
wxCHECK_MSG( subalpha, image, wxT("unable to create alpha channel"));
{
wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), image, wxT("invalid image") );
wxCHECK_MSG( (size.GetWidth() > 0) && (size.GetHeight() > 0), image, wxT("invalid size") );
int width = GetWidth(), height = GetHeight();
image.SetRGB(wxRect(), r, g, b);
- wxRect subRect(pos.x, pos.y, width, height);
- wxRect finalRect(0, 0, size.GetWidth(), size.GetHeight());
- if (pos.x < 0)
- finalRect.width -= pos.x;
- if (pos.y < 0)
- finalRect.height -= pos.y;
+ // we have two coordinate systems:
+ // source: starting at 0,0 of source image
+ // destination starting at 0,0 of destination image
+ // Documentation says:
+ // "The image is pasted into a new image [...] at the position pos relative
+ // to the upper left of the new image." this means the transition rule is:
+ // "dest coord" = "source coord" + pos;
- subRect.Intersect(finalRect);
+ // calculate the intersection using source coordinates:
+ wxRect srcRect(0, 0, width, height);
+ wxRect dstRect(-pos, size);
- if (!subRect.IsEmpty())
+ srcRect.Intersect(dstRect);
+
+ if (!srcRect.IsEmpty())
{
- if ((subRect.GetWidth() == width) && (subRect.GetHeight() == height))
- image.Paste(*this, pos.x, pos.y);
+ // insertion point is needed in destination coordinates.
+ // NB: it is not always "pos"!
+ wxPoint ptInsert = srcRect.GetTopLeft() + pos;
+
+ if ((srcRect.GetWidth() == width) && (srcRect.GetHeight() == height))
+ image.Paste(*this, ptInsert.x, ptInsert.y);
else
- image.Paste(GetSubImage(subRect), pos.x, pos.y);
+ image.Paste(GetSubImage(srcRect), ptInsert.x, ptInsert.y);
}
return image;
void wxImage::Paste( const wxImage &image, int x, int y )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
- wxCHECK_RET( image.Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
+ wxCHECK_RET( image.IsOk(), wxT("invalid image") );
AllocExclusive();
if (width < 1) return;
if (height < 1) return;
- if ((!HasMask() && !image.HasMask()) ||
- (HasMask() && !image.HasMask()) ||
- ((HasMask() && image.HasMask() &&
+ // If we can, copy the data using memcpy() as this is the fastest way. But
+ // for this the image being pasted must have "compatible" mask with this
+ // one meaning that either it must not have one at all or it must use the
+ // same masked colour.
+ if ( !image.HasMask() ||
+ ((HasMask() &&
(GetMaskRed()==image.GetMaskRed()) &&
(GetMaskGreen()==image.GetMaskGreen()) &&
- (GetMaskBlue()==image.GetMaskBlue()))))
+ (GetMaskBlue()==image.GetMaskBlue()))) )
{
- width *= 3;
- unsigned char* source_data = image.GetData() + xx*3 + yy*3*image.GetWidth();
+ const unsigned char* source_data = image.GetData() + 3*(xx + yy*image.GetWidth());
int source_step = image.GetWidth()*3;
- unsigned char* target_data = GetData() + (x+xx)*3 + (y+yy)*3*M_IMGDATA->m_width;
+ unsigned char* target_data = GetData() + 3*((x+xx) + (y+yy)*M_IMGDATA->m_width);
int target_step = M_IMGDATA->m_width*3;
for (int j = 0; j < height; j++)
{
- memcpy( target_data, source_data, width );
+ memcpy( target_data, source_data, width*3 );
source_data += source_step;
target_data += target_step;
}
- return;
+ }
+
+ // Copy over the alpha channel from the original image
+ if ( image.HasAlpha() )
+ {
+ if ( !HasAlpha() )
+ InitAlpha();
+
+ const unsigned char* source_data = image.GetAlpha() + xx + yy*image.GetWidth();
+ int source_step = image.GetWidth();
+
+ unsigned char* target_data = GetAlpha() + (x+xx) + (y+yy)*M_IMGDATA->m_width;
+ int target_step = M_IMGDATA->m_width;
+
+ for (int j = 0; j < height; j++,
+ source_data += source_step,
+ target_data += target_step)
+ {
+ memcpy( target_data, source_data, width );
+ }
}
if (!HasMask() && image.HasMask())
unsigned char g = image.GetMaskGreen();
unsigned char b = image.GetMaskBlue();
- width *= 3;
- unsigned char* source_data = image.GetData() + xx*3 + yy*3*image.GetWidth();
+ const unsigned char* source_data = image.GetData() + 3*(xx + yy*image.GetWidth());
int source_step = image.GetWidth()*3;
- unsigned char* target_data = GetData() + (x+xx)*3 + (y+yy)*3*M_IMGDATA->m_width;
+ unsigned char* target_data = GetData() + 3*((x+xx) + (y+yy)*M_IMGDATA->m_width);
int target_step = M_IMGDATA->m_width*3;
for (int j = 0; j < height; j++)
{
- for (int i = 0; i < width; i+=3)
+ for (int i = 0; i < width*3; i+=3)
{
- if ((source_data[i] != r) &&
- (source_data[i+1] != g) &&
+ if ((source_data[i] != r) ||
+ (source_data[i+1] != g) ||
(source_data[i+2] != b))
{
memcpy( target_data+i, source_data+i, 3 );
void wxImage::Replace( unsigned char r1, unsigned char g1, unsigned char b1,
unsigned char r2, unsigned char g2, unsigned char b2 )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
AllocExclusive();
}
}
-wxImage wxImage::ConvertToGreyscale( double lr, double lg, double lb ) const
+wxImage wxImage::ConvertToGreyscale(void) const
{
- wxImage image;
-
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
-
- image.Create(M_IMGDATA->m_width, M_IMGDATA->m_height, false);
-
- unsigned char *dest = image.GetData();
-
- wxCHECK_MSG( dest, image, wxT("unable to create image") );
-
- unsigned char *src = M_IMGDATA->m_data;
- bool hasMask = M_IMGDATA->m_hasMask;
- unsigned char maskRed = M_IMGDATA->m_maskRed;
- unsigned char maskGreen = M_IMGDATA->m_maskGreen;
- unsigned char maskBlue = M_IMGDATA->m_maskBlue;
-
- if ( hasMask )
- image.SetMaskColour(maskRed, maskGreen, maskBlue);
+ return ConvertToGreyscale(0.299, 0.587, 0.114);
+}
- const long size = M_IMGDATA->m_width * M_IMGDATA->m_height;
- for ( long i = 0; i < size; i++, src += 3, dest += 3 )
- {
- // don't modify the mask
- if ( hasMask && src[0] == maskRed && src[1] == maskGreen && src[2] == maskBlue )
- {
- memcpy(dest, src, 3);
- }
- else
- {
- // calculate the luma
- double luma = (src[0] * lr + src[1] * lg + src[2] * lb) + 0.5;
- dest[0] = dest[1] = dest[2] = wx_static_cast(unsigned char, luma);
- }
- }
+wxImage wxImage::ConvertToGreyscale(double weight_r, double weight_g, double weight_b) const
+{
+ wxImage image;
+ wxCHECK_MSG(IsOk(), image, "invalid image");
- // copy the alpha channel, if any
- if (HasAlpha())
+ const int w = M_IMGDATA->m_width;
+ const int h = M_IMGDATA->m_height;
+ size_t size = size_t(w) * h;
+ image.Create(w, h, false);
+ const unsigned char* alpha = M_IMGDATA->m_alpha;
+ if (alpha)
{
- const size_t alphaSize = GetWidth() * GetHeight();
- unsigned char *alpha = (unsigned char*)malloc(alphaSize);
- memcpy(alpha, GetAlpha(), alphaSize);
- image.InitAlpha();
- image.SetAlpha(alpha);
+ image.SetAlpha();
+ memcpy(image.GetAlpha(), alpha, size);
+ }
+ const unsigned char mask_r = M_IMGDATA->m_maskRed;
+ const unsigned char mask_g = M_IMGDATA->m_maskGreen;
+ const unsigned char mask_b = M_IMGDATA->m_maskBlue;
+ const bool hasMask = M_IMGDATA->m_hasMask;
+ if (hasMask)
+ image.SetMaskColour(mask_r, mask_g, mask_b);
+
+ const unsigned char* src = M_IMGDATA->m_data;
+ unsigned char* dst = image.GetData();
+ while (size--)
+ {
+ unsigned char r = *src++;
+ unsigned char g = *src++;
+ unsigned char b = *src++;
+ if (!hasMask || r != mask_r || g != mask_g || b != mask_b)
+ wxColour::MakeGrey(&r, &g, &b, weight_r, weight_g, weight_b);
+ *dst++ = r;
+ *dst++ = g;
+ *dst++ = b;
}
-
return image;
}
{
wxImage image;
- wxCHECK_MSG( Ok(), image, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), image, wxT("invalid image") );
image.Create( M_IMGDATA->m_width, M_IMGDATA->m_height, false );
for ( long i = 0; i < size; i++, srcd += 3, tard += 3 )
{
- if (srcd[0] == r && srcd[1] == g && srcd[2] == b)
- tard[0] = tard[1] = tard[2] = 255;
- else
- tard[0] = tard[1] = tard[2] = 0;
+ bool on = (srcd[0] == r) && (srcd[1] == g) && (srcd[2] == b);
+ wxColourBase::MakeMono(tard + 0, tard + 1, tard + 2, on);
}
return image;
}
+wxImage wxImage::ConvertToDisabled(unsigned char brightness) const
+{
+ wxImage image;
+ wxCHECK_MSG(IsOk(), image, "invalid image");
+
+ const int w = M_IMGDATA->m_width;
+ const int h = M_IMGDATA->m_height;
+ size_t size = size_t(w) * h;
+ image.Create(w, h, false);
+ const unsigned char* alpha = M_IMGDATA->m_alpha;
+ if (alpha)
+ {
+ image.SetAlpha();
+ memcpy(image.GetAlpha(), alpha, size);
+ }
+ const unsigned char mask_r = M_IMGDATA->m_maskRed;
+ const unsigned char mask_g = M_IMGDATA->m_maskGreen;
+ const unsigned char mask_b = M_IMGDATA->m_maskBlue;
+ const bool hasMask = M_IMGDATA->m_hasMask;
+ if (hasMask)
+ image.SetMaskColour(mask_r, mask_g, mask_b);
+
+ const unsigned char* src = M_IMGDATA->m_data;
+ unsigned char* dst = image.GetData();
+ while (size--)
+ {
+ unsigned char r = *src++;
+ unsigned char g = *src++;
+ unsigned char b = *src++;
+ if (!hasMask || r != mask_r || g != mask_g || b != mask_b)
+ wxColour::MakeDisabled(&r, &g, &b, brightness);
+ *dst++ = r;
+ *dst++ = g;
+ *dst++ = b;
+ }
+ return image;
+}
+
int wxImage::GetWidth() const
{
- wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), 0, wxT("invalid image") );
return M_IMGDATA->m_width;
}
int wxImage::GetHeight() const
{
- wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), 0, wxT("invalid image") );
return M_IMGDATA->m_height;
}
+wxBitmapType wxImage::GetType() const
+{
+ wxCHECK_MSG( IsOk(), wxBITMAP_TYPE_INVALID, wxT("invalid image") );
+
+ return M_IMGDATA->m_type;
+}
+
+void wxImage::SetType(wxBitmapType type)
+{
+ wxCHECK_RET( IsOk(), "must create the image before setting its type");
+
+ // type can be wxBITMAP_TYPE_INVALID to reset the image type to default
+ wxASSERT_MSG( type != wxBITMAP_TYPE_MAX, "invalid bitmap type" );
+
+ M_IMGDATA->m_type = type;
+}
+
long wxImage::XYToIndex(int x, int y) const
{
- if ( Ok() &&
+ if ( IsOk() &&
x >= 0 && y >= 0 &&
x < M_IMGDATA->m_width && y < M_IMGDATA->m_height )
{
void wxImage::SetRGB( const wxRect& rect_, unsigned char r, unsigned char g, unsigned char b )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
AllocExclusive();
return M_IMGDATA->m_data[pos+2];
}
-bool wxImage::Ok() const
+bool wxImage::IsOk() const
{
// image of 0 width or height can't be considered ok - at least because it
// causes crashes in ConvertToBitmap() if we don't catch it in time
unsigned char *wxImage::GetData() const
{
- wxCHECK_MSG( Ok(), (unsigned char *)NULL, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), (unsigned char *)NULL, wxT("invalid image") );
return M_IMGDATA->m_data;
}
void wxImage::SetData( unsigned char *data, bool static_data )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
wxImageRefData *newRefData = new wxImageRefData();
void wxImage::SetAlpha( unsigned char *alpha, bool static_data )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
AllocExclusive();
alpha = (unsigned char *)malloc(M_IMGDATA->m_width*M_IMGDATA->m_height);
}
- free(M_IMGDATA->m_alpha);
+ if( !M_IMGDATA->m_staticAlpha )
+ free(M_IMGDATA->m_alpha);
+
M_IMGDATA->m_alpha = alpha;
M_IMGDATA->m_staticAlpha = static_data;
}
unsigned char *wxImage::GetAlpha() const
{
- wxCHECK_MSG( Ok(), (unsigned char *)NULL, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), (unsigned char *)NULL, wxT("invalid image") );
return M_IMGDATA->m_alpha;
}
}
}
+void wxImage::ClearAlpha()
+{
+ wxCHECK_RET( HasAlpha(), wxT("image already doesn't have an alpha channel") );
+
+ if ( !M_IMGDATA->m_staticAlpha )
+ free( M_IMGDATA->m_alpha );
+
+ M_IMGDATA->m_alpha = NULL;
+}
+
+
// ----------------------------------------------------------------------------
// mask support
// ----------------------------------------------------------------------------
void wxImage::SetMaskColour( unsigned char r, unsigned char g, unsigned char b )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
AllocExclusive();
bool wxImage::GetOrFindMaskColour( unsigned char *r, unsigned char *g, unsigned char *b ) const
{
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), false, wxT("invalid image") );
if (M_IMGDATA->m_hasMask)
{
unsigned char wxImage::GetMaskRed() const
{
- wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), 0, wxT("invalid image") );
return M_IMGDATA->m_maskRed;
}
unsigned char wxImage::GetMaskGreen() const
{
- wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), 0, wxT("invalid image") );
return M_IMGDATA->m_maskGreen;
}
unsigned char wxImage::GetMaskBlue() const
{
- wxCHECK_MSG( Ok(), 0, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), 0, wxT("invalid image") );
return M_IMGDATA->m_maskBlue;
}
void wxImage::SetMask( bool mask )
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
AllocExclusive();
bool wxImage::HasMask() const
{
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), false, wxT("invalid image") );
return M_IMGDATA->m_hasMask;
}
bool wxImage::ConvertAlphaToMask(unsigned char threshold)
{
- if (!HasAlpha())
- return true;
+ if ( !HasAlpha() )
+ return false;
unsigned char mr, mg, mb;
- if (!FindFirstUnusedColour(&mr, &mg, &mb))
+ if ( !FindFirstUnusedColour(&mr, &mg, &mb) )
{
wxLogError( _("No unused colour in image being masked.") );
return false;
}
+ return ConvertAlphaToMask(mr, mg, mb, threshold);
+}
+
+bool wxImage::ConvertAlphaToMask(unsigned char mr,
+ unsigned char mg,
+ unsigned char mb,
+ unsigned char threshold)
+{
+ if ( !HasAlpha() )
+ return false;
+
AllocExclusive();
SetMask(true);
}
}
- free(M_IMGDATA->m_alpha);
+ if ( !M_IMGDATA->m_staticAlpha )
+ free(M_IMGDATA->m_alpha);
+
M_IMGDATA->m_alpha = NULL;
+ M_IMGDATA->m_staticAlpha = false;
return true;
}
bool wxImage::HasPalette() const
{
- if (!Ok())
+ if (!IsOk())
return false;
- return M_IMGDATA->m_palette.Ok();
+ return M_IMGDATA->m_palette.IsOk();
}
const wxPalette& wxImage::GetPalette() const
{
- wxCHECK_MSG( Ok(), wxNullPalette, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), wxNullPalette, wxT("invalid image") );
return M_IMGDATA->m_palette;
}
void wxImage::SetPalette(const wxPalette& palette)
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
+ wxCHECK_RET( IsOk(), wxT("invalid image") );
AllocExclusive();
void wxImage::SetOption(const wxString& name, const wxString& value)
{
- wxCHECK_RET( Ok(), wxT("invalid image") );
-
AllocExclusive();
int idx = M_IMGDATA->m_optionNames.Index(name, false);
- if (idx == wxNOT_FOUND)
+ if ( idx == wxNOT_FOUND )
{
M_IMGDATA->m_optionNames.Add(name);
M_IMGDATA->m_optionValues.Add(value);
wxString wxImage::GetOption(const wxString& name) const
{
- wxCHECK_MSG( Ok(), wxEmptyString, wxT("invalid image") );
+ if ( !M_IMGDATA )
+ return wxEmptyString;
int idx = M_IMGDATA->m_optionNames.Index(name, false);
- if (idx == wxNOT_FOUND)
+ if ( idx == wxNOT_FOUND )
return wxEmptyString;
else
return M_IMGDATA->m_optionValues[idx];
bool wxImage::HasOption(const wxString& name) const
{
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
-
- return (M_IMGDATA->m_optionNames.Index(name, false) != wxNOT_FOUND);
+ return M_IMGDATA ? M_IMGDATA->m_optionNames.Index(name, false) != wxNOT_FOUND
+ : false;
}
// ----------------------------------------------------------------------------
// image I/O
// ----------------------------------------------------------------------------
-bool wxImage::LoadFile( const wxString& WXUNUSED_UNLESS_STREAMS(filename),
- long WXUNUSED_UNLESS_STREAMS(type),
- int WXUNUSED_UNLESS_STREAMS(index) )
+// Under Windows we can load wxImage not only from files but also from
+// resources.
+#if defined(__WINDOWS__) && wxUSE_WXDIB && wxUSE_IMAGE
+ #define HAS_LOAD_FROM_RESOURCE
+#endif
+
+#ifdef HAS_LOAD_FROM_RESOURCE
+
+#include "wx/msw/dib.h"
+#include "wx/msw/private.h"
+
+static wxImage LoadImageFromResource(const wxString &name, wxBitmapType type)
{
-#if HAS_FILE_STREAMS
- if (wxFileExists(filename))
+ AutoHBITMAP
+ hBitmap,
+ hMask;
+
+ if ( type == wxBITMAP_TYPE_BMP_RESOURCE )
{
- wxImageFileInputStream stream(filename);
- wxBufferedInputStream bstream( stream );
- return LoadFile(bstream, type, index);
+ hBitmap.Init( ::LoadBitmap(wxGetInstance(), name.t_str()) );
+
+ if ( !hBitmap )
+ {
+ wxLogError(_("Failed to load bitmap \"%s\" from resources."), name);
+ }
+ }
+ else if ( type == wxBITMAP_TYPE_ICO_RESOURCE )
+ {
+ const HICON hIcon = ::LoadIcon(wxGetInstance(), name.t_str());
+
+ if ( !hIcon )
+ {
+ wxLogError(_("Failed to load icon \"%s\" from resources."), name);
+ }
+ else
+ {
+ ICONINFO info;
+ if ( !::GetIconInfo(hIcon, &info) )
+ {
+ wxLogLastError(wxT("GetIconInfo"));
+ return wxImage();
+ }
+
+ hBitmap.Init(info.hbmColor);
+ hMask.Init(info.hbmMask);
+ }
+ }
+ else if ( type == wxBITMAP_TYPE_CUR_RESOURCE )
+ {
+ wxLogDebug(wxS("Loading cursors from resources is not implemented."));
}
else
{
- wxLogError( _("Can't load image from file '%s': file does not exist."), filename.c_str() );
+ wxFAIL_MSG(wxS("Invalid bitmap resource type."));
+ }
- return false;
+ if ( !hBitmap )
+ return wxImage();
+
+ wxImage image = wxDIB(hBitmap).ConvertToImage();
+ if ( hMask )
+ {
+ const wxImage mask = wxDIB(hMask).ConvertToImage();
+ image.SetMaskFromImage(mask, 255, 255, 255);
}
-#else // !HAS_FILE_STREAMS
- return false;
+ else
+ {
+ // Light gray colour is a default mask
+ image.SetMaskColour(0xc0, 0xc0, 0xc0);
+ }
+
+ // We could have already loaded alpha from the resources, but if not,
+ // initialize it now using the mask.
+ if ( !image.HasAlpha() )
+ image.InitAlpha();
+
+ return image;
+}
+
+#endif // HAS_LOAD_FROM_RESOURCE
+
+bool wxImage::LoadFile( const wxString& filename,
+ wxBitmapType type,
+ int WXUNUSED_UNLESS_STREAMS(index) )
+{
+#ifdef HAS_LOAD_FROM_RESOURCE
+ if ( type == wxBITMAP_TYPE_BMP_RESOURCE
+ || type == wxBITMAP_TYPE_ICO_RESOURCE
+ || type == wxBITMAP_TYPE_CUR_RESOURCE)
+ {
+ const wxImage image = ::LoadImageFromResource(filename, type);
+ if ( image.IsOk() )
+ {
+ *this = image;
+ return true;
+ }
+ }
+#endif // HAS_LOAD_FROM_RESOURCE
+
+#if HAS_FILE_STREAMS
+ wxImageFileInputStream stream(filename);
+ if ( stream.IsOk() )
+ {
+ wxBufferedInputStream bstream( stream );
+ if ( LoadFile(bstream, type, index) )
+ return true;
+ }
+
+ wxLogError(_("Failed to load image from file \"%s\"."), filename);
#endif // HAS_FILE_STREAMS
+
+ return false;
}
bool wxImage::LoadFile( const wxString& WXUNUSED_UNLESS_STREAMS(filename),
int WXUNUSED_UNLESS_STREAMS(index) )
{
#if HAS_FILE_STREAMS
- if (wxFileExists(filename))
+ wxImageFileInputStream stream(filename);
+ if ( stream.IsOk() )
{
- wxImageFileInputStream stream(filename);
wxBufferedInputStream bstream( stream );
- return LoadFile(bstream, mimetype, index);
+ if ( LoadFile(bstream, mimetype, index) )
+ return true;
}
- else
- {
- wxLogError( _("Can't load image from file '%s': file does not exist."), filename.c_str() );
- return false;
- }
-#else // !HAS_FILE_STREAMS
- return false;
+ wxLogError(_("Failed to load image from file \"%s\"."), filename);
#endif // HAS_FILE_STREAMS
-}
+ return false;
+}
bool wxImage::SaveFile( const wxString& filename ) const
{
wxString ext = filename.AfterLast('.').Lower();
- wxImageHandler * pHandler = FindHandler(ext, -1);
- if (pHandler)
+ wxImageHandler *handler = FindHandler(ext, wxBITMAP_TYPE_ANY);
+ if ( !handler)
{
- SaveFile(filename, pHandler->GetType());
- return true;
+ wxLogError(_("Can't save image to file '%s': unknown extension."),
+ filename);
+ return false;
}
- wxLogError(_("Can't save image to file '%s': unknown extension."), filename.c_str());
-
- return false;
+ return SaveFile(filename, handler->GetType());
}
bool wxImage::SaveFile( const wxString& WXUNUSED_UNLESS_STREAMS(filename),
- int WXUNUSED_UNLESS_STREAMS(type) ) const
+ wxBitmapType WXUNUSED_UNLESS_STREAMS(type) ) const
{
#if HAS_FILE_STREAMS
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), false, wxT("invalid image") );
((wxImage*)this)->SetOption(wxIMAGE_OPTION_FILENAME, filename);
const wxString& WXUNUSED_UNLESS_STREAMS(mimetype) ) const
{
#if HAS_FILE_STREAMS
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), false, wxT("invalid image") );
((wxImage*)this)->SetOption(wxIMAGE_OPTION_FILENAME, filename);
}
int wxImage::GetImageCount( const wxString& WXUNUSED_UNLESS_STREAMS(name),
- long WXUNUSED_UNLESS_STREAMS(type) )
+ wxBitmapType WXUNUSED_UNLESS_STREAMS(type) )
{
#if HAS_FILE_STREAMS
wxImageFileInputStream stream(name);
- if (stream.Ok())
+ if (stream.IsOk())
return GetImageCount(stream, type);
#endif
return false;
}
-int wxImage::GetImageCount( wxInputStream &stream, long type )
+int wxImage::GetImageCount( wxInputStream &stream, wxBitmapType type )
{
wxImageHandler *handler;
if ( type == wxBITMAP_TYPE_ANY )
{
- wxList &list=GetHandlers();
+ const wxList& list = GetHandlers();
- for (wxList::compatibility_iterator node = list.GetFirst(); node; node = node->GetNext())
+ for ( wxList::compatibility_iterator node = list.GetFirst();
+ node;
+ node = node->GetNext() )
{
- handler=(wxImageHandler*)node->GetData();
+ handler = (wxImageHandler*)node->GetData();
if ( handler->CanRead(stream) )
- return handler->GetImageCount(stream);
+ {
+ const int count = handler->GetImageCount(stream);
+ if ( count >= 0 )
+ return count;
+ }
}
if ( !handler )
{
- wxLogWarning(_("No image handler for type %ld defined."), type);
+ wxLogWarning(_("No image handler for type %d defined."), type);
return false;
}
}
else
{
- wxLogError(_("Image file is not of type %ld."), type);
+ wxLogError(_("Image file is not of type %d."), type);
return 0;
}
}
-bool wxImage::LoadFile( wxInputStream& stream, long type, int index )
+bool wxImage::DoLoad(wxImageHandler& handler, wxInputStream& stream, int index)
{
- UnRef();
+ // save the options values which can be clobbered by the handler (e.g. many
+ // of them call Destroy() before trying to load the file)
+ const unsigned maxWidth = GetOptionInt(wxIMAGE_OPTION_MAX_WIDTH),
+ maxHeight = GetOptionInt(wxIMAGE_OPTION_MAX_HEIGHT);
- m_refData = new wxImageRefData;
+ // Preserve the original stream position if possible to rewind back to it
+ // if we failed to load the file -- maybe the next handler that we try can
+ // succeed after us then.
+ wxFileOffset posOld = wxInvalidOffset;
+ if ( stream.IsSeekable() )
+ posOld = stream.TellI();
+
+ if ( !handler.LoadFile(this, stream, true/*verbose*/, index) )
+ {
+ if ( posOld != wxInvalidOffset )
+ stream.SeekI(posOld);
+
+ return false;
+ }
+
+ // rescale the image to the specified size if needed
+ if ( maxWidth || maxHeight )
+ {
+ const unsigned widthOrig = GetWidth(),
+ heightOrig = GetHeight();
+
+ // this uses the same (trivial) algorithm as the JPEG handler
+ unsigned width = widthOrig,
+ height = heightOrig;
+ while ( (maxWidth && width > maxWidth) ||
+ (maxHeight && height > maxHeight) )
+ {
+ width /= 2;
+ height /= 2;
+ }
+
+ if ( width != widthOrig || height != heightOrig )
+ {
+ // get the original size if it was set by the image handler
+ // but also in order to restore it after Rescale
+ int widthOrigOption = GetOptionInt(wxIMAGE_OPTION_ORIGINAL_WIDTH),
+ heightOrigOption = GetOptionInt(wxIMAGE_OPTION_ORIGINAL_HEIGHT);
+
+ Rescale(width, height, wxIMAGE_QUALITY_HIGH);
+
+ SetOption(wxIMAGE_OPTION_ORIGINAL_WIDTH, widthOrigOption ? widthOrigOption : widthOrig);
+ SetOption(wxIMAGE_OPTION_ORIGINAL_HEIGHT, heightOrigOption ? heightOrigOption : heightOrig);
+ }
+ }
+
+ // Set this after Rescale, which currently does not preserve it
+ M_IMGDATA->m_type = handler.GetType();
+
+ return true;
+}
+
+bool wxImage::LoadFile( wxInputStream& stream, wxBitmapType type, int index )
+{
+ AllocExclusive();
wxImageHandler *handler;
if ( type == wxBITMAP_TYPE_ANY )
{
- wxList &list=GetHandlers();
-
- for ( wxList::compatibility_iterator node = list.GetFirst(); node; node = node->GetNext() )
+ if ( !stream.IsSeekable() )
{
- handler=(wxImageHandler*)node->GetData();
- if ( handler->CanRead(stream) )
- return handler->LoadFile(this, stream, true/*verbose*/, index);
+ // The error message about image data format being unknown below
+ // would be misleading in this case as we are not even going to try
+ // any handlers because CanRead() never does anything for not
+ // seekable stream, so try to be more precise here.
+ wxLogError(_("Can't automatically determine the image format "
+ "for non-seekable input."));
+ return false;
+ }
+ const wxList& list = GetHandlers();
+ for ( wxList::compatibility_iterator node = list.GetFirst();
+ node;
+ node = node->GetNext() )
+ {
+ handler = (wxImageHandler*)node->GetData();
+ if ( handler->CanRead(stream) && DoLoad(*handler, stream, index) )
+ return true;
}
- wxLogWarning( _("No handler found for image type.") );
+ wxLogWarning( _("Unknown image data format.") );
+
return false;
}
+ //else: have specific type
handler = FindHandler(type);
-
- if (handler == 0)
+ if ( !handler )
{
- wxLogWarning( _("No image handler for type %ld defined."), type );
-
+ wxLogWarning( _("No image handler for type %d defined."), type );
return false;
}
- if (stream.IsSeekable() && !handler->CanRead(stream))
+ if ( stream.IsSeekable() && !handler->CanRead(stream) )
{
- wxLogError(_("Image file is not of type %ld."), type);
+ wxLogError(_("This is not a %s."), handler->GetName());
return false;
}
- else
- return handler->LoadFile(this, stream, true/*verbose*/, index);
+
+ return DoLoad(*handler, stream, index);
}
bool wxImage::LoadFile( wxInputStream& stream, const wxString& mimetype, int index )
wxImageHandler *handler = FindHandlerMime(mimetype);
- if (handler == 0)
+ if ( !handler )
{
wxLogWarning( _("No image handler for type %s defined."), mimetype.GetData() );
-
return false;
}
- if (stream.IsSeekable() && !handler->CanRead(stream))
+ if ( stream.IsSeekable() && !handler->CanRead(stream) )
{
- wxLogError(_("Image file is not of type %s."), (const wxChar*) mimetype);
+ wxLogError(_("Image is not of type %s."), mimetype);
return false;
}
- else
- return handler->LoadFile( this, stream, true/*verbose*/, index );
+
+ return DoLoad(*handler, stream, index);
}
-bool wxImage::SaveFile( wxOutputStream& stream, int type ) const
+bool wxImage::DoSave(wxImageHandler& handler, wxOutputStream& stream) const
{
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
+ wxImage * const self = const_cast<wxImage *>(this);
+ if ( !handler.SaveFile(self, stream) )
+ return false;
+
+ M_IMGDATA->m_type = handler.GetType();
+ return true;
+}
+
+bool wxImage::SaveFile( wxOutputStream& stream, wxBitmapType type ) const
+{
+ wxCHECK_MSG( IsOk(), false, wxT("invalid image") );
wxImageHandler *handler = FindHandler(type);
if ( !handler )
{
wxLogWarning( _("No image handler for type %d defined."), type );
-
return false;
}
- return handler->SaveFile( (wxImage*)this, stream );
+ return DoSave(*handler, stream);
}
bool wxImage::SaveFile( wxOutputStream& stream, const wxString& mimetype ) const
{
- wxCHECK_MSG( Ok(), false, wxT("invalid image") );
+ wxCHECK_MSG( IsOk(), false, wxT("invalid image") );
wxImageHandler *handler = FindHandlerMime(mimetype);
if ( !handler )
{
wxLogWarning( _("No image handler for type %s defined."), mimetype.GetData() );
-
return false;
}
- return handler->SaveFile( (wxImage*)this, stream );
+ return DoSave(*handler, stream);
}
+
#endif // wxUSE_STREAMS
// ----------------------------------------------------------------------------
// may) we should probably refcount the duplicates.
// also an issue in InsertHandler below.
- wxLogDebug( _T("Adding duplicate image handler for '%s'"),
+ wxLogDebug( wxT("Adding duplicate image handler for '%s'"),
handler->GetName().c_str() );
delete handler;
}
else
{
// see AddHandler for additional comments.
- wxLogDebug( _T("Inserting duplicate image handler for '%s'"),
+ wxLogDebug( wxT("Inserting duplicate image handler for '%s'"),
handler->GetName().c_str() );
delete handler;
}
node = node->GetNext();
}
- return 0;
+ return NULL;
}
-wxImageHandler *wxImage::FindHandler( const wxString& extension, long bitmapType )
+wxImageHandler *wxImage::FindHandler( const wxString& extension, wxBitmapType bitmapType )
{
wxList::compatibility_iterator node = sm_handlers.GetFirst();
while (node)
{
wxImageHandler *handler = (wxImageHandler*)node->GetData();
- if ( (handler->GetExtension().Cmp(extension) == 0) &&
- (bitmapType == -1 || handler->GetType() == bitmapType) )
- return handler;
+ if ((bitmapType == wxBITMAP_TYPE_ANY) || (handler->GetType() == bitmapType))
+ {
+ if (handler->GetExtension() == extension)
+ return handler;
+ if (handler->GetAltExtensions().Index(extension, false) != wxNOT_FOUND)
+ return handler;
+ }
node = node->GetNext();
}
- return 0;
+ return NULL;
}
-wxImageHandler *wxImage::FindHandler( long bitmapType )
+wxImageHandler *wxImage::FindHandler(wxBitmapType bitmapType )
{
wxList::compatibility_iterator node = sm_handlers.GetFirst();
while (node)
if (handler->GetType() == bitmapType) return handler;
node = node->GetNext();
}
- return 0;
+ return NULL;
}
wxImageHandler *wxImage::FindHandlerMime( const wxString& mimetype )
if (handler->GetMimeType().IsSameAs(mimetype, false)) return handler;
node = node->GetNext();
}
- return 0;
+ return NULL;
}
void wxImage::InitStandardHandlers()
{
wxImageHandler* Handler = (wxImageHandler*)Node->GetData();
fmts += wxT("*.") + Handler->GetExtension();
+ for (size_t i = 0; i < Handler->GetAltExtensions().size(); i++)
+ fmts += wxT(";*.") + Handler->GetAltExtensions()[i];
Node = Node->GetNext();
if ( Node ) fmts += wxT(";");
}
case BLUE:
hue = 4.0 + (red - green) / deltaRGB;
break;
-
- default:
- wxFAIL_MSG(wxT("hue not specified"));
- break;
}
hue /= 6.0;
IMPLEMENT_ABSTRACT_CLASS(wxImageHandler,wxObject)
#if wxUSE_STREAMS
-bool wxImageHandler::LoadFile( wxImage *WXUNUSED(image), wxInputStream& WXUNUSED(stream), bool WXUNUSED(verbose), int WXUNUSED(index) )
+int wxImageHandler::GetImageCount( wxInputStream& stream )
{
- return false;
-}
+ // NOTE: this code is the same of wxAnimationDecoder::CanRead and
+ // wxImageHandler::CallDoCanRead
-bool wxImageHandler::SaveFile( wxImage *WXUNUSED(image), wxOutputStream& WXUNUSED(stream), bool WXUNUSED(verbose) )
-{
- return false;
-}
+ if ( !stream.IsSeekable() )
+ return false; // can't test unseekable stream
-int wxImageHandler::GetImageCount( wxInputStream& WXUNUSED(stream) )
-{
- return 1;
+ wxFileOffset posOld = stream.TellI();
+ int n = DoGetImageCount(stream);
+
+ // restore the old position to be able to test other formats and so on
+ if ( stream.SeekI(posOld) == wxInvalidOffset )
+ {
+ wxLogDebug(wxT("Failed to rewind the stream in wxImageHandler!"));
+
+ // reading would fail anyhow as we're not at the right position
+ return false;
+ }
+
+ return n;
}
bool wxImageHandler::CanRead( const wxString& name )
{
- if (wxFileExists(name))
+ wxImageFileInputStream stream(name);
+ if ( !stream.IsOk() )
{
- wxImageFileInputStream stream(name);
- return CanRead(stream);
- }
+ wxLogError(_("Failed to check format of image file \"%s\"."), name);
- wxLogError( _("Can't check image format of file '%s': file does not exist."), name.c_str() );
+ return false;
+ }
- return false;
+ return CanRead(stream);
}
bool wxImageHandler::CallDoCanRead(wxInputStream& stream)
{
- wxFileOffset posOld = stream.TellI();
- if ( posOld == wxInvalidOffset )
- {
- // can't test unseekable stream
- return false;
- }
+ // NOTE: this code is the same of wxAnimationDecoder::CanRead and
+ // wxImageHandler::GetImageCount
+
+ if ( !stream.IsSeekable() )
+ return false; // can't test unseekable stream
+ wxFileOffset posOld = stream.TellI();
bool ok = DoCanRead(stream);
// restore the old position to be able to test other formats and so on
if ( stream.SeekI(posOld) == wxInvalidOffset )
{
- wxLogDebug(_T("Failed to rewind the stream in wxImageHandler!"));
+ wxLogDebug(wxT("Failed to rewind the stream in wxImageHandler!"));
// reading would fail anyhow as we're not at the right position
return false;
#endif // wxUSE_STREAMS
+/* static */
+wxImageResolution
+wxImageHandler::GetResolutionFromOptions(const wxImage& image, int *x, int *y)
+{
+ wxCHECK_MSG( x && y, wxIMAGE_RESOLUTION_NONE, wxT("NULL pointer") );
+
+ if ( image.HasOption(wxIMAGE_OPTION_RESOLUTIONX) &&
+ image.HasOption(wxIMAGE_OPTION_RESOLUTIONY) )
+ {
+ *x = image.GetOptionInt(wxIMAGE_OPTION_RESOLUTIONX);
+ *y = image.GetOptionInt(wxIMAGE_OPTION_RESOLUTIONY);
+ }
+ else if ( image.HasOption(wxIMAGE_OPTION_RESOLUTION) )
+ {
+ *x =
+ *y = image.GetOptionInt(wxIMAGE_OPTION_RESOLUTION);
+ }
+ else // no resolution options specified
+ {
+ *x =
+ *y = 0;
+
+ return wxIMAGE_RESOLUTION_NONE;
+ }
+
+ // get the resolution unit too
+ int resUnit = image.GetOptionInt(wxIMAGE_OPTION_RESOLUTIONUNIT);
+ if ( !resUnit )
+ {
+ // this is the default
+ resUnit = wxIMAGE_RESOLUTION_INCHES;
+ }
+
+ return (wxImageResolution)resUnit;
+}
+
// ----------------------------------------------------------------------------
// image histogram stuff
// ----------------------------------------------------------------------------
* Rotation code by Carlos Moreno
*/
-// GRG: I've removed wxRotationPoint - we already have wxRealPoint which
-// does exactly the same thing. And I also got rid of wxRotationPixel
-// bacause of potential problems in architectures where alignment
-// is an issue, so I had to rewrite parts of the code.
-
-static const double gs_Epsilon = 1e-10;
-
-static inline int wxCint (double x)
-{
- return (x > 0) ? (int) (x + 0.5) : (int) (x - 0.5);
-}
-
+static const double wxROTATE_EPSILON = 1e-10;
// Auxiliary function to rotate a point (x,y) with respect to point p0
// make it inline and use a straight return to facilitate optimization
// repeating the time-consuming calls to these functions -- sin/cos can
// be computed and stored in the calling function.
-inline wxRealPoint rotated_point (const wxRealPoint & p, double cos_angle, double sin_angle, const wxRealPoint & p0)
+static inline wxRealPoint
+wxRotatePoint(const wxRealPoint& p, double cos_angle, double sin_angle,
+ const wxRealPoint& p0)
{
- return wxRealPoint (p0.x + (p.x - p0.x) * cos_angle - (p.y - p0.y) * sin_angle,
- p0.y + (p.y - p0.y) * cos_angle + (p.x - p0.x) * sin_angle);
+ return wxRealPoint(p0.x + (p.x - p0.x) * cos_angle - (p.y - p0.y) * sin_angle,
+ p0.y + (p.y - p0.y) * cos_angle + (p.x - p0.x) * sin_angle);
}
-inline wxRealPoint rotated_point (double x, double y, double cos_angle, double sin_angle, const wxRealPoint & p0)
+static inline wxRealPoint
+wxRotatePoint(double x, double y, double cos_angle, double sin_angle,
+ const wxRealPoint & p0)
{
- return rotated_point (wxRealPoint(x,y), cos_angle, sin_angle, p0);
+ return wxRotatePoint (wxRealPoint(x,y), cos_angle, sin_angle, p0);
}
-wxImage wxImage::Rotate(double angle, const wxPoint & centre_of_rotation, bool interpolating, wxPoint * offset_after_rotation) const
+wxImage wxImage::Rotate(double angle,
+ const wxPoint& centre_of_rotation,
+ bool interpolating,
+ wxPoint *offset_after_rotation) const
{
- int i;
- angle = -angle; // screen coordinates are a mirror image of "real" coordinates
+ // screen coordinates are a mirror image of "real" coordinates
+ angle = -angle;
+
+ const bool has_alpha = HasAlpha();
+
+ const int w = GetWidth();
+ const int h = GetHeight();
- bool has_alpha = HasAlpha();
+ int i;
// Create pointer-based array to accelerate access to wxImage's data
- unsigned char ** data = new unsigned char * [GetHeight()];
+ unsigned char ** data = new unsigned char * [h];
data[0] = GetData();
- for (i = 1; i < GetHeight(); i++)
- data[i] = data[i - 1] + (3 * GetWidth());
+ for (i = 1; i < h; i++)
+ data[i] = data[i - 1] + (3 * w);
// Same for alpha channel
unsigned char ** alpha = NULL;
if (has_alpha)
{
- alpha = new unsigned char * [GetHeight()];
+ alpha = new unsigned char * [h];
alpha[0] = GetAlpha();
- for (i = 1; i < GetHeight(); i++)
- alpha[i] = alpha[i - 1] + GetWidth();
+ for (i = 1; i < h; i++)
+ alpha[i] = alpha[i - 1] + w;
}
// precompute coefficients for rotation formula
- // (sine and cosine of the angle)
const double cos_angle = cos(angle);
const double sin_angle = sin(angle);
const wxRealPoint p0(centre_of_rotation.x, centre_of_rotation.y);
- wxRealPoint p1 = rotated_point (0, 0, cos_angle, sin_angle, p0);
- wxRealPoint p2 = rotated_point (0, GetHeight(), cos_angle, sin_angle, p0);
- wxRealPoint p3 = rotated_point (GetWidth(), 0, cos_angle, sin_angle, p0);
- wxRealPoint p4 = rotated_point (GetWidth(), GetHeight(), cos_angle, sin_angle, p0);
+ wxRealPoint p1 = wxRotatePoint (0, 0, cos_angle, sin_angle, p0);
+ wxRealPoint p2 = wxRotatePoint (0, h, cos_angle, sin_angle, p0);
+ wxRealPoint p3 = wxRotatePoint (w, 0, cos_angle, sin_angle, p0);
+ wxRealPoint p4 = wxRotatePoint (w, h, cos_angle, sin_angle, p0);
int x1a = (int) floor (wxMin (wxMin(p1.x, p2.x), wxMin(p3.x, p4.x)));
int y1a = (int) floor (wxMin (wxMin(p1.y, p2.y), wxMin(p3.y, p4.y)));
*offset_after_rotation = wxPoint (x1a, y1a);
}
- // GRG: The rotated (destination) image is always accessed
- // sequentially, so there is no need for a pointer-based
- // array here (and in fact it would be slower).
- //
- unsigned char * dst = rotated.GetData();
+ // the rotated (destination) image is always accessed sequentially via this
+ // pointer, there is no need for pointer-based arrays here
+ unsigned char *dst = rotated.GetData();
- unsigned char * alpha_dst = NULL;
- if (has_alpha)
- alpha_dst = rotated.GetAlpha();
+ unsigned char *alpha_dst = has_alpha ? rotated.GetAlpha() : NULL;
- // GRG: if the original image has a mask, use its RGB values
- // as the blank pixel, else, fall back to default (black).
- //
+ // if the original image has a mask, use its RGB values as the blank pixel,
+ // else, fall back to default (black).
unsigned char blank_r = 0;
unsigned char blank_g = 0;
unsigned char blank_b = 0;
// performing an inverse rotation (a rotation of -angle) and getting the
// pixel at those coordinates
- // GRG: I've taken the (interpolating) test out of the loops, so that
- // it is done only once, instead of repeating it for each pixel.
+ const int rH = rotated.GetHeight();
+ const int rW = rotated.GetWidth();
- int x;
+ // do the (interpolating) test outside of the loops, so that it is done
+ // only once, instead of repeating it for each pixel.
if (interpolating)
{
- for (int y = 0; y < rotated.GetHeight(); y++)
+ for (int y = 0; y < rH; y++)
{
- for (x = 0; x < rotated.GetWidth(); x++)
+ for (int x = 0; x < rW; x++)
{
- wxRealPoint src = rotated_point (x + x1a, y + y1a, cos_angle, -sin_angle, p0);
+ wxRealPoint src = wxRotatePoint (x + x1a, y + y1a, cos_angle, -sin_angle, p0);
- if (-0.25 < src.x && src.x < GetWidth() - 0.75 &&
- -0.25 < src.y && src.y < GetHeight() - 0.75)
+ if (-0.25 < src.x && src.x < w - 0.75 &&
+ -0.25 < src.y && src.y < h - 0.75)
{
// interpolate using the 4 enclosing grid-points. Those
// points can be obtained using floor and ceiling of the
// exact coordinates of the point
int x1, y1, x2, y2;
- if (0 < src.x && src.x < GetWidth() - 1)
+ if (0 < src.x && src.x < w - 1)
{
- x1 = wxCint(floor(src.x));
- x2 = wxCint(ceil(src.x));
+ x1 = wxRound(floor(src.x));
+ x2 = wxRound(ceil(src.x));
}
else // else means that x is near one of the borders (0 or width-1)
{
- x1 = x2 = wxCint (src.x);
+ x1 = x2 = wxRound (src.x);
}
- if (0 < src.y && src.y < GetHeight() - 1)
+ if (0 < src.y && src.y < h - 1)
{
- y1 = wxCint(floor(src.y));
- y2 = wxCint(ceil(src.y));
+ y1 = wxRound(floor(src.y));
+ y2 = wxRound(ceil(src.y));
}
else
{
- y1 = y2 = wxCint (src.y);
+ y1 = y2 = wxRound (src.y);
}
// get four points and the distances (square of the distance,
// GRG: Do not calculate the points until they are
// really needed -- this way we can calculate
// just one, instead of four, if d1, d2, d3
- // or d4 are < gs_Epsilon
+ // or d4 are < wxROTATE_EPSILON
const double d1 = (src.x - x1) * (src.x - x1) + (src.y - y1) * (src.y - y1);
const double d2 = (src.x - x2) * (src.x - x2) + (src.y - y1) * (src.y - y1);
// If the point is exactly at one point of the grid of the source
// image, then don't interpolate -- just assign the pixel
- if (d1 < gs_Epsilon) // d1,d2,d3,d4 are positive -- no need for abs()
+ // d1,d2,d3,d4 are positive -- no need for abs()
+ if (d1 < wxROTATE_EPSILON)
{
unsigned char *p = data[y1] + (3 * x1);
*(dst++) = *(p++);
if (has_alpha)
*(alpha_dst++) = *(alpha[y1] + x1);
}
- else if (d2 < gs_Epsilon)
+ else if (d2 < wxROTATE_EPSILON)
{
unsigned char *p = data[y1] + (3 * x2);
*(dst++) = *(p++);
if (has_alpha)
*(alpha_dst++) = *(alpha[y1] + x2);
}
- else if (d3 < gs_Epsilon)
+ else if (d3 < wxROTATE_EPSILON)
{
unsigned char *p = data[y2] + (3 * x2);
*(dst++) = *(p++);
if (has_alpha)
*(alpha_dst++) = *(alpha[y2] + x2);
}
- else if (d4 < gs_Epsilon)
+ else if (d4 < wxROTATE_EPSILON)
{
unsigned char *p = data[y2] + (3 * x1);
*(dst++) = *(p++);
}
}
}
- else // not interpolating
+ else // not interpolating
{
- for (int y = 0; y < rotated.GetHeight(); y++)
+ for (int y = 0; y < rH; y++)
{
- for (x = 0; x < rotated.GetWidth(); x++)
+ for (int x = 0; x < rW; x++)
{
- wxRealPoint src = rotated_point (x + x1a, y + y1a, cos_angle, -sin_angle, p0);
+ wxRealPoint src = wxRotatePoint (x + x1a, y + y1a, cos_angle, -sin_angle, p0);
- const int xs = wxCint (src.x); // wxCint rounds to the
- const int ys = wxCint (src.y); // closest integer
+ const int xs = wxRound (src.x); // wxRound rounds to the
+ const int ys = wxRound (src.y); // closest integer
- if (0 <= xs && xs < GetWidth() &&
- 0 <= ys && ys < GetHeight())
+ if (0 <= xs && xs < w && 0 <= ys && ys < h)
{
unsigned char *p = data[ys] + (3 * xs);
*(dst++) = *(p++);
}
delete [] data;
-
- if (has_alpha)
- delete [] alpha;
+ delete [] alpha;
return rotated;
}
DECLARE_DYNAMIC_CLASS(wxImageModule)
public:
wxImageModule() {}
- bool OnInit() { wxImage::InitStandardHandlers(); return true; };
- void OnExit() { wxImage::CleanUpHandlers(); };
+ bool OnInit() { wxImage::InitStandardHandlers(); return true; }
+ void OnExit() { wxImage::CleanUpHandlers(); }
};
IMPLEMENT_DYNAMIC_CLASS(wxImageModule, wxModule)