X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/25acfd4ca34c7b1beb34eca73ee33c5297f5c021..b404a8f3b072129c107c6d9a5e0f6f53cd34807b:/src/msw/bitmap.cpp diff --git a/src/msw/bitmap.cpp b/src/msw/bitmap.cpp index c4b2b8bed5..10756fee7c 100644 --- a/src/msw/bitmap.cpp +++ b/src/msw/bitmap.cpp @@ -1,12 +1,12 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: bitmap.cpp +//////////////////////////////////////////////////////////////////////////// +// Name: src/msw/bitmap.cpp // Purpose: wxBitmap // Author: Julian Smart // Modified by: // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "bitmap.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,6 +24,8 @@ #pragma hdrstop #endif +#include "wx/bitmap.h" + #ifndef WX_PRECOMP #include @@ -36,25 +34,94 @@ #include "wx/app.h" #include "wx/palette.h" #include "wx/dcmemory.h" - #include "wx/bitmap.h" #include "wx/icon.h" + #include "wx/log.h" + #include "wx/image.h" #endif #include "wx/msw/private.h" -#include "wx/log.h" +#include "wx/msw/dc.h" -#if !defined(__WXMICROWIN__) -#include "wx/msw/dib.h" +#if wxUSE_WXDIB + #include "wx/msw/dib.h" #endif -#include "wx/image.h" -#include "wx/xpmdecod.h" +#ifdef wxHAS_RAW_BITMAP + #include "wx/rawbmp.h" +#endif // missing from mingw32 header #ifndef CLR_INVALID #define CLR_INVALID ((COLORREF)-1) #endif // no CLR_INVALID +// ---------------------------------------------------------------------------- +// wxBitmapRefData +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData +{ +public: + wxBitmapRefData(); + wxBitmapRefData(const wxBitmapRefData& data); + virtual ~wxBitmapRefData() { Free(); } + + virtual void Free(); + + // set the mask object to use as the mask, we take ownership of it + void SetMask(wxMask *mask) + { + delete m_bitmapMask; + m_bitmapMask = mask; + } + + // set the HBITMAP to use as the mask + void SetMask(HBITMAP hbmpMask) + { + SetMask(new wxMask((WXHBITMAP)hbmpMask)); + } + + // return the mask + wxMask *GetMask() const { return m_bitmapMask; } + +public: +#if wxUSE_PALETTE + wxPalette m_bitmapPalette; +#endif // wxUSE_PALETTE + + // MSW-specific + // ------------ + +#if wxDEBUG_LEVEL + // this field is solely for error checking: we detect selecting a bitmap + // into more than one DC at once or deleting a bitmap still selected into a + // DC (both are serious programming errors under Windows) + wxDC *m_selectedInto; +#endif // wxDEBUG_LEVEL + +#if wxUSE_WXDIB + // when GetRawData() is called for a DDB we need to convert it to a DIB + // first to be able to provide direct access to it and we cache that DIB + // here and convert it back to DDB when UngetRawData() is called + wxDIB *m_dib; +#endif + + // true if we have alpha transparency info and can be drawn using + // AlphaBlend() + bool m_hasAlpha; + + // true if our HBITMAP is a DIB section, false if it is a DDB + bool m_isDIB; + +private: + // optional mask for transparent drawing + wxMask *m_bitmapMask; + + + // not implemented + wxBitmapRefData& operator=(const wxBitmapRefData&); +}; + // ---------------------------------------------------------------------------- // macros // ---------------------------------------------------------------------------- @@ -68,17 +135,90 @@ IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler, wxObject) // implementation // ============================================================================ +// ---------------------------------------------------------------------------- +// helper functions +// ---------------------------------------------------------------------------- + +// decide whether we should create a DIB or a DDB for the given parameters +// +// NB: we always use DIBs under Windows CE as this is much simpler (even if +// also less efficient...) and we obviously can't use them if there is no +// DIB support compiled in at all +#ifdef __WXWINCE__ + static inline bool wxShouldCreateDIB(int, int, int, WXHDC) { return true; } + + #define ALWAYS_USE_DIB +#elif !wxUSE_WXDIB + // no sense in defining wxShouldCreateDIB() as we can't compile code + // executed if it is true, so we have to use #if's anyhow + #define NEVER_USE_DIB +#else // wxUSE_WXDIB && !__WXWINCE__ + static inline bool wxShouldCreateDIB(int w, int h, int d, WXHDC hdc) + { + // here is the logic: + // + // (a) if hdc is specified, the caller explicitly wants DDB + // (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp + // or less DIBs anyhow) + // (c) finally, create DIBs under Win9x even if the depth hasn't been + // explicitly specified but the current display depth is 24 or + // more and the image is "big", i.e. > 16Mb which is the + // theoretical limit for DDBs under Win9x + // + // consequences (all of which seem to make sense): + // + // (i) by default, DDBs are created (depth == -1 usually) + // (ii) DIBs can be created by explicitly specifying the depth + // (iii) using a DC always forces creating a DDB + return !hdc && + (d >= 24 || + (d == -1 && + wxDIB::GetLineSize(w, wxDisplayDepth())*h > 16*1024*1024)); + } + + #define SOMETIMES_USE_DIB +#endif // different DIB usage scenarious + // ---------------------------------------------------------------------------- // wxBitmapRefData // ---------------------------------------------------------------------------- wxBitmapRefData::wxBitmapRefData() { - m_quality = 0; +#if wxDEBUG_LEVEL m_selectedInto = NULL; - m_numColors = 0; +#endif m_bitmapMask = NULL; + m_hBitmap = (WXHBITMAP) NULL; +#if wxUSE_WXDIB + m_dib = NULL; +#endif + + m_isDIB = + m_hasAlpha = false; +} + +wxBitmapRefData::wxBitmapRefData(const wxBitmapRefData& data) + : wxGDIImageRefData(data) +{ +#if wxDEBUG_LEVEL + m_selectedInto = NULL; +#endif + + // (deep) copy the mask if present + m_bitmapMask = NULL; + if (data.m_bitmapMask) + m_bitmapMask = new wxMask(*data.m_bitmapMask); + + // FIXME: we don't copy m_hBitmap currently but we should, see wxBitmap:: + // CloneGDIRefData() + + wxASSERT_MSG( !data.m_isDIB, + wxT("can't copy bitmap locked for raw access!") ); + m_isDIB = false; + + m_hasAlpha = data.m_hasAlpha; } void wxBitmapRefData::Free() @@ -86,6 +226,10 @@ void wxBitmapRefData::Free() wxASSERT_MSG( !m_selectedInto, wxT("deleting bitmap still selected into wxMemoryDC") ); +#if wxUSE_WXDIB + wxASSERT_MSG( !m_dib, wxT("forgot to call wxBitmap::UngetRawData()!") ); +#endif + if ( m_hBitmap) { if ( !::DeleteObject((HBITMAP)m_hBitmap) ) @@ -94,28 +238,64 @@ void wxBitmapRefData::Free() } } - delete m_bitmapMask; - m_bitmapMask = NULL; + wxDELETE(m_bitmapMask); } // ---------------------------------------------------------------------------- // wxBitmap creation // ---------------------------------------------------------------------------- -// this function should be called from all wxBitmap ctors -void wxBitmap::Init() +wxGDIImageRefData *wxBitmap::CreateData() const { - // m_refData = NULL; done in the base class ctor - - if ( wxTheBitmapList ) - wxTheBitmapList->AddBitmap(this); + return new wxBitmapRefData; } -#ifdef __WIN32__ +wxGDIRefData *wxBitmap::CloneGDIRefData(const wxGDIRefData *dataOrig) const +{ + const wxBitmapRefData * + data = static_cast(dataOrig); + if ( !data ) + return NULL; + + // FIXME: this method is backwards, it should just create a new + // wxBitmapRefData using its copy ctor but instead it modifies this + // bitmap itself and then returns its m_refData -- which works, of + // course (except in !wxUSE_WXDIB), but is completely illogical + wxBitmap *self = const_cast(this); + + wxBitmapRefData *selfdata; +#if wxUSE_WXDIB + // copy the other bitmap + if ( data->m_hBitmap ) + { + wxDIB dib((HBITMAP)(data->m_hBitmap)); + self->CopyFromDIB(dib); + + selfdata = static_cast(m_refData); + selfdata->m_hasAlpha = data->m_hasAlpha; + } + else +#endif // wxUSE_WXDIB + { + // copy the bitmap data + selfdata = new wxBitmapRefData(*data); + self->m_refData = selfdata; + } -bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon) + // copy also the mask + wxMask * const maskSrc = data->GetMask(); + if ( maskSrc ) + { + selfdata->SetMask(new wxMask(*maskSrc)); + } + + return selfdata; +} + +bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon, + wxBitmapTransparency transp) { -#ifndef __WXMICROWIN__ +#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__) // it may be either HICON or HCURSOR HICON hicon = (HICON)icon.GetHandle(); @@ -124,7 +304,7 @@ bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon) { wxLogLastError(wxT("GetIconInfo")); - return FALSE; + return false; } wxBitmapRefData *refData = new wxBitmapRefData; @@ -139,97 +319,136 @@ bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon) refData->m_hBitmap = (WXHBITMAP)iconInfo.hbmColor; - // the mask returned by GetIconInfo() is inversed compared to the usual - // wxWin convention - refData->m_bitmapMask = new wxMask((WXHBITMAP) - wxInvertMask(iconInfo.hbmMask, w, h)); + switch ( transp ) + { + default: + wxFAIL_MSG( wxT("unknown wxBitmapTransparency value") ); + + case wxBitmapTransparency_None: + // nothing to do, refData->m_hasAlpha is false by default + break; + + case wxBitmapTransparency_Auto: +#if wxUSE_WXDIB + // If the icon is 32 bits per pixel then it may have alpha channel + // data, although there are some icons that are 32 bpp but have no + // alpha... So convert to a DIB and manually check the 4th byte for + // each pixel. + { + BITMAP bm; + if ( ::GetObject(iconInfo.hbmColor, sizeof(bm), &bm) && + (bm.bmBitsPixel == 32) ) + { + wxDIB dib(iconInfo.hbmColor); + if (dib.IsOk()) + { + const unsigned char* pixels = dib.GetData(); + for (int idx = 0; idx < w*h*4; idx+=4) + { + if (pixels[idx+3] != 0) + { + // If there is an alpha byte that is non-zero + // then set the alpha flag and stop checking + refData->m_hasAlpha = true; + break; + } + } + } + } + } + break; +#endif // wxUSE_WXDIB + case wxBitmapTransparency_Always: + refData->m_hasAlpha = true; + break; + } + + if ( !refData->m_hasAlpha ) + { + // the mask returned by GetIconInfo() is inverted compared to the usual + // wxWin convention + refData->SetMask(wxInvertMask(iconInfo.hbmMask, w, h)); + } // delete the old one now as we don't need it any more ::DeleteObject(iconInfo.hbmMask); -#if WXWIN_COMPATIBILITY_2 - refData->m_ok = TRUE; -#endif // WXWIN_COMPATIBILITY_2 + return true; +#else // __WXMICROWIN__ || __WXWINCE__ + wxUnusedVar(icon); + wxUnusedVar(transp); - return TRUE; -#else - return FALSE; -#endif + return false; +#endif // !__WXWINCE__/__WXWINCE__ } -#endif // Win32 - -bool wxBitmap::CopyFromCursor(const wxCursor& cursor) +bool wxBitmap::CopyFromCursor(const wxCursor& cursor, wxBitmapTransparency transp) { UnRef(); - if ( !cursor.Ok() ) - return FALSE; + if ( !cursor.IsOk() ) + return false; -#ifdef __WIN16__ - wxFAIL_MSG( _T("don't know how to convert cursor to bitmap") ); - - return FALSE; -#else - return CopyFromIconOrCursor(cursor); -#endif // Win16 + return CopyFromIconOrCursor(cursor, transp); } -bool wxBitmap::CopyFromIcon(const wxIcon& icon) +bool wxBitmap::CopyFromIcon(const wxIcon& icon, wxBitmapTransparency transp) { UnRef(); - if ( !icon.Ok() ) - return FALSE; + if ( !icon.IsOk() ) + return false; - // GetIconInfo() doesn't exist under Win16 and I don't know any other way - // to create a bitmap from icon there - but using this way we won't have - // the mask (FIXME) -#ifdef __WIN16__ - int width = icon.GetWidth(), - height = icon.GetHeight(); + return CopyFromIconOrCursor(icon, transp); +} - // copy the icon to the bitmap - ScreenHDC hdcScreen; - HDC hdc = ::CreateCompatibleDC(hdcScreen); - HBITMAP hbitmap = ::CreateCompatibleBitmap(hdcScreen, width, height); - HBITMAP hbmpOld = (HBITMAP)::SelectObject(hdc, hbitmap); +#ifndef NEVER_USE_DIB - ::DrawIcon(hdc, 0, 0, GetHiconOf(icon)); +bool wxBitmap::CopyFromDIB(const wxDIB& dib) +{ + wxCHECK_MSG( dib.IsOk(), false, wxT("invalid DIB in CopyFromDIB") ); - ::SelectObject(hdc, hbmpOld); - ::DeleteDC(hdc); +#ifdef SOMETIMES_USE_DIB + HBITMAP hbitmap = dib.CreateDDB(); + if ( !hbitmap ) + return false; +#else // ALWAYS_USE_DIB + HBITMAP hbitmap = const_cast(dib).Detach(); +#endif // SOMETIMES_USE_DIB/ALWAYS_USE_DIB + + UnRef(); wxBitmapRefData *refData = new wxBitmapRefData; m_refData = refData; - refData->m_width = width; - refData->m_height = height; - refData->m_depth = wxDisplayDepth(); + refData->m_width = dib.GetWidth(); + refData->m_height = dib.GetHeight(); + refData->m_depth = dib.GetDepth(); refData->m_hBitmap = (WXHBITMAP)hbitmap; -#if WXWIN_COMPATIBILITY_2 - refData->m_ok = TRUE; -#endif // WXWIN_COMPATIBILITY_2 +#if wxUSE_PALETTE + wxPalette *palette = dib.CreatePalette(); + if ( palette ) + { + refData->m_bitmapPalette = *palette; + } + + delete palette; +#endif // wxUSE_PALETTE - return TRUE; -#else // Win32 - return CopyFromIconOrCursor(icon); -#endif // Win16/Win32 + return true; } +#endif // NEVER_USE_DIB + wxBitmap::~wxBitmap() { - if (wxTheBitmapList) - wxTheBitmapList->DeleteObject(this); } wxBitmap::wxBitmap(const char bits[], int width, int height, int depth) { - Init(); - #ifndef __WXMICROWIN__ wxBitmapRefData *refData = new wxBitmapRefData; m_refData = refData; @@ -237,15 +456,13 @@ wxBitmap::wxBitmap(const char bits[], int width, int height, int depth) refData->m_width = width; refData->m_height = height; refData->m_depth = depth; - refData->m_numColors = 0; - refData->m_selectedInto = NULL; char *data; if ( depth == 1 ) { // we assume that it is in XBM format which is not quite the same as // the format CreateBitmap() wants because the order of bytes in the - // line is inversed! + // line is reversed! const size_t bytesPerLine = (width + 7) / 8; const size_t padding = bytesPerLine % 2; const size_t len = height * ( padding + bytesPerLine ); @@ -263,10 +480,10 @@ wxBitmap::wxBitmap(const char bits[], int width, int height, int depth) for ( int bits = 0; bits < 8; bits++) { reversed <<= 1; - reversed |= (val & 0x01); + reversed |= (unsigned char)(val & 0x01); val >>= 1; } - *dst++ = reversed; + *dst++ = ~reversed; } if ( padding ) @@ -276,7 +493,7 @@ wxBitmap::wxBitmap(const char bits[], int width, int height, int depth) else { // bits should already be in Windows standard format - data = (char *)bits; // const_cast is harmless + data = const_cast(bits); } HBITMAP hbmp = ::CreateBitmap(width, height, 1, depth, data); @@ -294,343 +511,243 @@ wxBitmap::wxBitmap(const char bits[], int width, int height, int depth) #endif } -// Create from XPM data -bool wxBitmap::CreateFromXpm(const char **data) +wxBitmap::wxBitmap(int w, int h, const wxDC& dc) { -#if wxUSE_IMAGE && wxUSE_XPM - Init(); - - wxCHECK_MSG( data != NULL, FALSE, wxT("invalid bitmap data") ) - - wxXPMDecoder decoder; - wxImage img = decoder.ReadData(data); - wxCHECK_MSG( img.Ok(), FALSE, wxT("invalid bitmap data") ) - - *this = wxBitmap(img); - return TRUE; -#else - return FALSE; -#endif + (void)Create(w, h, dc); } -wxBitmap::wxBitmap(int w, int h, int d) +wxBitmap::wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth) { - Init(); - - (void)Create(w, h, d); + (void)Create(data, type, width, height, depth); } -wxBitmap::wxBitmap(void *data, long type, int width, int height, int depth) +wxBitmap::wxBitmap(const wxString& filename, wxBitmapType type) { - Init(); + LoadFile(filename, type); +} - (void)Create(data, type, width, height, depth); +bool wxBitmap::Create(int width, int height, int depth) +{ + return DoCreate(width, height, depth, 0); } -wxBitmap::wxBitmap(const wxString& filename, wxBitmapType type) +bool wxBitmap::Create(int width, int height, const wxDC& dc) { - Init(); + wxCHECK_MSG( dc.IsOk(), false, wxT("invalid HDC in wxBitmap::Create()") ); + + const wxMSWDCImpl *impl = wxDynamicCast( dc.GetImpl(), wxMSWDCImpl ); - LoadFile(filename, (int)type); + if (impl) + return DoCreate(width, height, -1, impl->GetHDC()); + else + return false; } -bool wxBitmap::Create(int w, int h, int d) +bool wxBitmap::DoCreate(int w, int h, int d, WXHDC hdc) { -#ifndef __WXMICROWIN__ UnRef(); m_refData = new wxBitmapRefData; GetBitmapData()->m_width = w; GetBitmapData()->m_height = h; - GetBitmapData()->m_depth = d; - HBITMAP hbmp; + HBITMAP hbmp wxDUMMY_INITIALIZE(0); - if ( d > 0 ) +#ifndef NEVER_USE_DIB + if ( wxShouldCreateDIB(w, h, d, hdc) ) { - hbmp = ::CreateBitmap(w, h, 1, d, NULL); - if ( !hbmp ) + if ( d == -1 ) { - wxLogLastError(wxT("CreateBitmap")); + // create DIBs without alpha channel by default + d = 24; } + + wxDIB dib(w, h, d); + if ( !dib.IsOk() ) + return false; + + // don't delete the DIB section in dib object dtor + hbmp = dib.Detach(); + + GetBitmapData()->m_isDIB = true; + GetBitmapData()->m_depth = d; } - else + else // create a DDB +#endif // NEVER_USE_DIB { - ScreenHDC dc; - hbmp = ::CreateCompatibleBitmap(dc, w, h); - if ( !hbmp ) +#ifndef ALWAYS_USE_DIB +#ifndef __WXMICROWIN__ + if ( d > 0 ) { - wxLogLastError(wxT("CreateCompatibleBitmap")); + hbmp = ::CreateBitmap(w, h, 1, d, NULL); + if ( !hbmp ) + { + wxLogLastError(wxT("CreateBitmap")); + } + + GetBitmapData()->m_depth = d; } + else // d == 0, create bitmap compatible with the screen +#endif // !__WXMICROWIN__ + { + ScreenHDC dc; + hbmp = ::CreateCompatibleBitmap(dc, w, h); + if ( !hbmp ) + { + wxLogLastError(wxT("CreateCompatibleBitmap")); + } - GetBitmapData()->m_depth = wxDisplayDepth(); + GetBitmapData()->m_depth = wxDisplayDepth(); + } +#endif // !ALWAYS_USE_DIB } SetHBITMAP((WXHBITMAP)hbmp); -#if WXWIN_COMPATIBILITY_2 - GetBitmapData()->m_ok = hbmp != 0; -#endif // WXWIN_COMPATIBILITY_2 - return Ok(); -#else - return FALSE; -#endif + return IsOk(); } +#if wxUSE_IMAGE + // ---------------------------------------------------------------------------- -// wxImage to/from conversions +// wxImage to/from conversions for Microwin // ---------------------------------------------------------------------------- -#if wxUSE_IMAGE +// Microwin versions are so different from normal ones that it really doesn't +// make sense to use #ifdefs inside the function bodies +#ifdef __WXMICROWIN__ -bool wxBitmap::CreateFromImage( const wxImage& image, int depth ) +bool wxBitmap::CreateFromImage(const wxImage& image, int depth, const wxDC& dc) { -#ifdef __WXMICROWIN__ - // TODO - return FALSE; -#else - wxCHECK_MSG( image.Ok(), FALSE, wxT("invalid image") ) + // Set this to 1 to experiment with mask code, + // which currently doesn't work + #define USE_MASKS 0 m_refData = new wxBitmapRefData(); - // sizeLimit is the MS upper limit for the DIB size -#ifdef WIN32 - int sizeLimit = 1024*768*3; -#else - int sizeLimit = 0x7fff ; -#endif - - // width and height of the device-dependent bitmap - int width = image.GetWidth(); - int bmpHeight = image.GetHeight(); - - // calc the number of bytes per scanline and padding - int bytePerLine = width*3; - int sizeDWORD = sizeof( DWORD ); - int lineBoundary = bytePerLine % sizeDWORD; - int padding = 0; - if( lineBoundary > 0 ) - { - padding = sizeDWORD - lineBoundary; - bytePerLine += padding; - } - // calc the number of DIBs and heights of DIBs - int numDIB = 1; - int hRemain = 0; - int height = sizeLimit/bytePerLine; - if( height >= bmpHeight ) - height = bmpHeight; - else - { - numDIB = bmpHeight / height; - hRemain = bmpHeight % height; - if( hRemain >0 ) numDIB++; - } + // Initial attempt at a simple-minded implementation. + // The bitmap will always be created at the screen depth, + // so the 'depth' argument is ignored. - // set bitmap parameters - wxCHECK_MSG( image.Ok(), FALSE, wxT("invalid image") ); - SetWidth( width ); - SetHeight( bmpHeight ); - if (depth == -1) depth = wxDisplayDepth(); - SetDepth( depth ); - - // Copy the palette from the source image - SetPalette(image.GetPalette()); + HDC hScreenDC = ::GetDC(NULL); + int screenDepth = ::GetDeviceCaps(hScreenDC, BITSPIXEL); - // create a DIB header - int headersize = sizeof(BITMAPINFOHEADER); - BITMAPINFO *lpDIBh = (BITMAPINFO *) malloc( headersize ); - wxCHECK_MSG( lpDIBh, FALSE, wxT("could not allocate memory for DIB header") ); - // Fill in the DIB header - lpDIBh->bmiHeader.biSize = headersize; - lpDIBh->bmiHeader.biWidth = (DWORD)width; - lpDIBh->bmiHeader.biHeight = (DWORD)(-height); - lpDIBh->bmiHeader.biSizeImage = bytePerLine*height; - // the general formula for biSizeImage: - // ( ( ( ((DWORD)width*24) +31 ) & ~31 ) >> 3 ) * height; - lpDIBh->bmiHeader.biPlanes = 1; - lpDIBh->bmiHeader.biBitCount = 24; - lpDIBh->bmiHeader.biCompression = BI_RGB; - lpDIBh->bmiHeader.biClrUsed = 0; - // These seem not really needed for our purpose here. - lpDIBh->bmiHeader.biClrImportant = 0; - lpDIBh->bmiHeader.biXPelsPerMeter = 0; - lpDIBh->bmiHeader.biYPelsPerMeter = 0; - // memory for DIB data - unsigned char *lpBits; - lpBits = (unsigned char *)malloc( lpDIBh->bmiHeader.biSizeImage ); - if( !lpBits ) - { - wxFAIL_MSG( wxT("could not allocate memory for DIB") ); - free( lpDIBh ); - return FALSE; - } - - // create and set the device-dependent bitmap - HDC hdc = ::GetDC(NULL); - HDC memdc = ::CreateCompatibleDC( hdc ); - HBITMAP hbitmap; - hbitmap = ::CreateCompatibleBitmap( hdc, width, bmpHeight ); - ::SelectObject( memdc, hbitmap); + HBITMAP hBitmap = ::CreateCompatibleBitmap(hScreenDC, image.GetWidth(), image.GetHeight()); + HBITMAP hMaskBitmap = NULL; + HBITMAP hOldMaskBitmap = NULL; + HDC hMaskDC = NULL; + unsigned char maskR = 0; + unsigned char maskG = 0; + unsigned char maskB = 0; -#if wxUSE_PALETTE - HPALETTE hOldPalette = 0; - if (image.GetPalette().Ok()) + // printf("Created bitmap %d\n", (int) hBitmap); + if (hBitmap == NULL) { - hOldPalette = ::SelectPalette(memdc, (HPALETTE) image.GetPalette().GetHPALETTE(), FALSE); - ::RealizePalette(memdc); + ::ReleaseDC(NULL, hScreenDC); + return false; } -#endif // wxUSE_PALETTE + HDC hMemDC = ::CreateCompatibleDC(hScreenDC); - // copy image data into DIB data and then into DDB (in a loop) - unsigned char *data = image.GetData(); - int i, j, n; - int origin = 0; - unsigned char *ptdata = data; - unsigned char *ptbits; + HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap); + ::ReleaseDC(NULL, hScreenDC); + + // created an mono-bitmap for the possible mask + bool hasMask = image.HasMask(); - for( n=0; n 1 && n == numDIB-1 && hRemain > 0 ) +#if USE_MASKS + // FIXME: we should be able to pass bpp = 1, but + // GdBlit can't handle a different depth +#if 0 + hMaskBitmap = ::CreateBitmap( (WORD)image.GetWidth(), (WORD)image.GetHeight(), 1, 1, NULL ); +#else + hMaskBitmap = ::CreateCompatibleBitmap( hMemDC, (WORD)image.GetWidth(), (WORD)image.GetHeight()); +#endif + maskR = image.GetMaskRed(); + maskG = image.GetMaskGreen(); + maskB = image.GetMaskBlue(); + + if (!hMaskBitmap) { - // redefine height and size of the (possibly) last smaller DIB - // memory is not reallocated - height = hRemain; - lpDIBh->bmiHeader.biHeight = (DWORD)(-height); - lpDIBh->bmiHeader.biSizeImage = bytePerLine*height; + hasMask = false; } - ptbits = lpBits; + else + { + hScreenDC = ::GetDC(NULL); + hMaskDC = ::CreateCompatibleDC(hScreenDC); + ::ReleaseDC(NULL, hScreenDC); - for( j=0; jbmiHeader), CBM_INIT, lpBits, lpDIBh, DIB_RGB_COLORS ); - // The above line is equivalent to the following two lines. - // hbitmap = ::CreateCompatibleBitmap( hdc, width, height ); - // ::SetDIBits( hdc, hbitmap, 0, height, lpBits, lpDIBh, DIB_RGB_COLORS); - // or the following lines - // hbitmap = ::CreateCompatibleBitmap( hdc, width, height ); - // HDC memdc = ::CreateCompatibleDC( hdc ); - // ::SelectObject( memdc, hbitmap); - // ::SetDIBitsToDevice( memdc, 0, 0, width, height, - // 0, 0, 0, height, (void *)lpBits, lpDIBh, DIB_RGB_COLORS); - // ::SelectObject( memdc, 0 ); - // ::DeleteDC( memdc ); - } - SetHBITMAP( (WXHBITMAP) hbitmap ); + } + + ::SelectObject(hMemDC, hOldBitmap); + ::DeleteDC(hMemDC); + if (hasMask) + { + ::SelectObject(hMaskDC, hOldMaskBitmap); + ::DeleteDC(hMaskDC); + + ((wxBitmapRefData*)m_refData)->SetMask(hMaskBitmap); + } + + SetWidth(image.GetWidth()); + SetHeight(image.GetHeight()); + SetDepth(screenDepth); + SetHBITMAP( (WXHBITMAP) hBitmap ); #if wxUSE_PALETTE - if (hOldPalette) - SelectPalette(memdc, hOldPalette, FALSE); + // Copy the palette from the source image + SetPalette(image.GetPalette()); #endif // wxUSE_PALETTE - // similarly, created an mono-bitmap for the possible mask - if( image.HasMask() ) - { - hbitmap = ::CreateBitmap( (WORD)width, (WORD)bmpHeight, 1, 1, NULL ); - HGDIOBJ hbmpOld = ::SelectObject( memdc, hbitmap); - if( numDIB == 1 ) height = bmpHeight; - else height = sizeLimit/bytePerLine; - lpDIBh->bmiHeader.biHeight = (DWORD)(-height); - lpDIBh->bmiHeader.biSizeImage = bytePerLine*height; - origin = 0; - unsigned char r = image.GetMaskRed(); - unsigned char g = image.GetMaskGreen(); - unsigned char b = image.GetMaskBlue(); - unsigned char zero = 0, one = 255; - ptdata = data; - for( n=0; n 1 && n == numDIB - 1 && hRemain > 0 ) - { - // redefine height and size of the (possibly) last smaller DIB - // memory is not reallocated - height = hRemain; - lpDIBh->bmiHeader.biHeight = (DWORD)(-height); - lpDIBh->bmiHeader.biSizeImage = bytePerLine*height; - } - ptbits = lpBits; - for( int j=0; jSetMaskBitmap( (WXHBITMAP) hbitmap ); - SetMask( mask ); - // It will be deleted when the wxBitmap object is deleted (as of 01/1999) - /* The following can also be used but is slow to run - wxColour colour( GetMaskRed(), GetMaskGreen(), GetMaskBlue()); - wxMask *mask = new wxMask( *this, colour ); - SetMask( mask ); - */ - - ::SelectObject( memdc, hbmpOld ); - } - - // free allocated resources - ::DeleteDC( memdc ); - ::ReleaseDC(NULL, hdc); - free(lpDIBh); - free(lpBits); - -#if WXWIN_COMPATIBILITY_2 - // check the wxBitmap object - GetBitmapData()->SetOk(); -#endif // WXWIN_COMPATIBILITY_2 - - if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this); - - return TRUE; -#endif + return true; } wxImage wxBitmap::ConvertToImage() const { -#ifdef __WXMICROWIN__ - // TODO - return wxImage(); -#else + // Initial attempt at a simple-minded implementation. + // The bitmap will always be created at the screen depth, + // so the 'depth' argument is ignored. + // TODO: transparency (create a mask image) + + if (!IsOk()) + { + wxFAIL_MSG( wxT("bitmap is invalid") ); + return wxNullImage; + } + wxImage image; - wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") ); + wxCHECK_MSG( IsOk(), wxNullImage, wxT("invalid bitmap") ); // create an wxImage object int width = GetWidth(); @@ -643,121 +760,270 @@ wxImage wxBitmap::ConvertToImage() const return wxNullImage; } - // calc the number of bytes per scanline and padding in the DIB - int bytePerLine = width*3; - int sizeDWORD = sizeof( DWORD ); - int lineBoundary = bytePerLine % sizeDWORD; - int padding = 0; - if( lineBoundary > 0 ) + HDC hScreenDC = ::GetDC(NULL); + + HDC hMemDC = ::CreateCompatibleDC(hScreenDC); + ::ReleaseDC(NULL, hScreenDC); + + HBITMAP hBitmap = (HBITMAP) GetHBITMAP(); + + HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap); + + int i, j; + for (i = 0; i < GetWidth(); i++) { - padding = sizeDWORD - lineBoundary; - bytePerLine += padding; + for (j = 0; j < GetHeight(); j++) + { + COLORREF color = ::GetPixel(hMemDC, i, j); + unsigned char red = GetRValue(color); + unsigned char green = GetGValue(color); + unsigned char blue = GetBValue(color); + + image.SetRGB(i, j, red, green, blue); + } } - // create a DIB header - int headersize = sizeof(BITMAPINFOHEADER); - BITMAPINFO *lpDIBh = (BITMAPINFO *) malloc( headersize ); - if( !lpDIBh ) + ::SelectObject(hMemDC, hOldBitmap); + ::DeleteDC(hMemDC); + +#if wxUSE_PALETTE + // Copy the palette from the source image + if (GetPalette()) + image.SetPalette(* GetPalette()); +#endif // wxUSE_PALETTE + + return image; +} + +#endif // __WXMICROWIN__ + +// ---------------------------------------------------------------------------- +// wxImage to/from conversions +// ---------------------------------------------------------------------------- + +bool wxBitmap::CreateFromImage(const wxImage& image, int depth) +{ + return CreateFromImage(image, depth, 0); +} + +bool wxBitmap::CreateFromImage(const wxImage& image, const wxDC& dc) +{ + wxCHECK_MSG( dc.IsOk(), false, + wxT("invalid HDC in wxBitmap::CreateFromImage()") ); + + const wxMSWDCImpl *impl = wxDynamicCast( dc.GetImpl(), wxMSWDCImpl ); + + if (impl) + return CreateFromImage(image, -1, impl->GetHDC()); + else + return false; +} + +#if wxUSE_WXDIB + +bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc) +{ + wxCHECK_MSG( image.IsOk(), false, wxT("invalid image") ); + + UnRef(); + + // first convert the image to DIB + const int h = image.GetHeight(); + const int w = image.GetWidth(); + + wxDIB dib(image); + if ( !dib.IsOk() ) + return false; + + const bool hasAlpha = image.HasAlpha(); + + if (depth == -1) + depth = dib.GetDepth(); + + // store the bitmap parameters + wxBitmapRefData * const refData = new wxBitmapRefData; + refData->m_width = w; + refData->m_height = h; + refData->m_hasAlpha = hasAlpha; + refData->m_depth = depth; + + m_refData = refData; + + + // next either store DIB as is or create a DDB from it + HBITMAP hbitmap wxDUMMY_INITIALIZE(0); + + // are we going to use DIB? + // + // NB: DDBs don't support alpha so if we have alpha channel we must use DIB + if ( hasAlpha || wxShouldCreateDIB(w, h, depth, hdc) ) { - wxFAIL_MSG( wxT("could not allocate data for DIB header") ); - free( data ); - return wxNullImage; + // don't delete the DIB section in dib object dtor + hbitmap = dib.Detach(); + + refData->m_isDIB = true; } - // Fill in the DIB header - lpDIBh->bmiHeader.biSize = headersize; - lpDIBh->bmiHeader.biWidth = width; - lpDIBh->bmiHeader.biHeight = -height; - lpDIBh->bmiHeader.biSizeImage = bytePerLine * height; - lpDIBh->bmiHeader.biPlanes = 1; - lpDIBh->bmiHeader.biBitCount = 24; - lpDIBh->bmiHeader.biCompression = BI_RGB; - lpDIBh->bmiHeader.biClrUsed = 0; - // These seem not really needed for our purpose here. - lpDIBh->bmiHeader.biClrImportant = 0; - lpDIBh->bmiHeader.biXPelsPerMeter = 0; - lpDIBh->bmiHeader.biYPelsPerMeter = 0; - // memory for DIB data - unsigned char *lpBits; - lpBits = (unsigned char *) malloc( lpDIBh->bmiHeader.biSizeImage ); - if( !lpBits ) - { - wxFAIL_MSG( wxT("could not allocate data for DIB") ); - free( data ); - free( lpDIBh ); - return wxNullImage; +#ifndef ALWAYS_USE_DIB + else // we need to convert DIB to DDB + { + hbitmap = dib.CreateDDB((HDC)hdc); } +#endif // !ALWAYS_USE_DIB - // copy data from the device-dependent bitmap to the DIB - HDC hdc = ::GetDC(NULL); - HBITMAP hbitmap; - hbitmap = (HBITMAP) GetHBITMAP(); - ::GetDIBits( hdc, hbitmap, 0, height, lpBits, lpDIBh, DIB_RGB_COLORS ); + // validate this object + SetHBITMAP((WXHBITMAP)hbitmap); - // copy DIB data into the wxImage object - int i, j; - unsigned char *ptdata = data; - unsigned char *ptbits = lpBits; - for( i=0; iGetMaskBitmap() ) - { - hbitmap = (HBITMAP) GetMask()->GetMaskBitmap(); - // memory DC created, color set, data copied, and memory DC deleted - HDC memdc = ::CreateCompatibleDC( hdc ); - ::SetTextColor( memdc, RGB( 0, 0, 0 ) ); - ::SetBkColor( memdc, RGB( 255, 255, 255 ) ); - ::GetDIBits( memdc, hbitmap, 0, height, lpBits, lpDIBh, DIB_RGB_COLORS ); - ::DeleteDC( memdc ); - // background color set to RGB(16,16,16) in consistent with wxGTK - unsigned char r=16, g=16, b=16; - ptdata = data; - ptbits = lpBits; - for( i=0; i>= 1) == 0 ) { - *(ptdata++) = r; - *(ptdata++) = g; - *(ptdata++) = b; + dstLine++; + mask = 0x80; } - ptbits += 3; } - ptbits += padding; } - image.SetMaskColour( r, g, b ); - image.SetMask( TRUE ); + + hbitmap = ::CreateBitmap(w, h, 1, 1, data); + if ( !hbitmap ) + { + wxLogLastError(wxT("CreateBitmap(mask)")); + } + else + { + SetMask(new wxMask((WXHBITMAP)hbitmap)); + } + + delete[] data; } - else + + return true; +} + +wxImage wxBitmap::ConvertToImage() const +{ + // convert DDB to DIB + wxDIB dib(*this); + + if ( !dib.IsOk() ) { - image.SetMask( FALSE ); + return wxNullImage; + } + + // and then DIB to our wxImage + wxImage image = dib.ConvertToImage(); + if ( !image.IsOk() ) + { + return wxNullImage; + } + + // now do the same for the mask, if we have any + HBITMAP hbmpMask = GetMask() ? (HBITMAP) GetMask()->GetMaskBitmap() : NULL; + if ( hbmpMask ) + { + wxDIB dibMask(hbmpMask); + if ( dibMask.IsOk() ) + { + // TODO: use wxRawBitmap to iterate over DIB + + // we hard code the mask colour for now but we could also make an + // effort (and waste time) to choose a colour not present in the + // image already to avoid having to fudge the pixels below -- + // whether it's worth to do it is unclear however + static const int MASK_RED = 1; + static const int MASK_GREEN = 2; + static const int MASK_BLUE = 3; + static const int MASK_BLUE_REPLACEMENT = 2; + + const int h = dibMask.GetHeight(); + const int w = dibMask.GetWidth(); + const int bpp = dibMask.GetDepth(); + const int maskBytesPerPixel = bpp >> 3; + const int maskBytesPerLine = wxDIB::GetLineSize(w, bpp); + unsigned char *data = image.GetData(); + + // remember that DIBs are stored in bottom to top order + unsigned char * + maskLineStart = dibMask.GetData() + ((h - 1) * maskBytesPerLine); + + for ( int y = 0; y < h; y++, maskLineStart -= maskBytesPerLine ) + { + // traverse one mask DIB line + unsigned char *mask = maskLineStart; + for ( int x = 0; x < w; x++, mask += maskBytesPerPixel ) + { + // should this pixel be transparent? + if ( *mask ) + { + // no, check that it isn't transparent by accident + if ( (data[0] == MASK_RED) && + (data[1] == MASK_GREEN) && + (data[2] == MASK_BLUE) ) + { + // we have to fudge the colour a bit to prevent + // this pixel from appearing transparent + data[2] = MASK_BLUE_REPLACEMENT; + } + + data += 3; + } + else // yes, transparent pixel + { + *data++ = MASK_RED; + *data++ = MASK_GREEN; + *data++ = MASK_BLUE; + } + } + } + + image.SetMaskColour(MASK_RED, MASK_GREEN, MASK_BLUE); + } } - // free allocated resources - ::ReleaseDC(NULL, hdc); - free(lpDIBh); - free(lpBits); return image; -#endif } +#else // !wxUSE_WXDIB + +bool +wxBitmap::CreateFromImage(const wxImage& WXUNUSED(image), + int WXUNUSED(depth), + WXHDC WXUNUSED(hdc)) +{ + return false; +} + +wxImage wxBitmap::ConvertToImage() const +{ + return wxImage(); +} + +#endif // wxUSE_WXDIB/!wxUSE_WXDIB + #endif // wxUSE_IMAGE -bool wxBitmap::LoadFile(const wxString& filename, long type) +// ---------------------------------------------------------------------------- +// loading and saving bitmaps +// ---------------------------------------------------------------------------- + +bool wxBitmap::LoadFile(const wxString& filename, wxBitmapType type) { UnRef(); @@ -769,23 +1035,23 @@ bool wxBitmap::LoadFile(const wxString& filename, long type) return handler->LoadFile(this, filename, type, -1, -1); } -#if wxUSE_IMAGE - else +#if wxUSE_IMAGE && wxUSE_WXDIB + else // no bitmap handler found { wxImage image; - if ( image.LoadFile( filename, type ) && image.Ok() ) + if ( image.LoadFile( filename, type ) && image.IsOk() ) { - *this = image.ConvertToBitmap(); + *this = wxBitmap(image); - return TRUE; + return true; } } #endif // wxUSE_IMAGE - return FALSE; + return false; } -bool wxBitmap::Create(void *data, long type, int width, int height, int depth) +bool wxBitmap::Create(const void* data, wxBitmapType type, int width, int height, int depth) { UnRef(); @@ -793,9 +1059,9 @@ bool wxBitmap::Create(void *data, long type, int width, int height, int depth) if ( !handler ) { - wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %d defined."), type); + wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type); - return FALSE; + return false; } m_refData = new wxBitmapRefData; @@ -804,8 +1070,8 @@ bool wxBitmap::Create(void *data, long type, int width, int height, int depth) } bool wxBitmap::SaveFile(const wxString& filename, - int type, - const wxPalette *palette) + wxBitmapType type, + const wxPalette *palette) const { wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler); @@ -813,93 +1079,153 @@ bool wxBitmap::SaveFile(const wxString& filename, { return handler->SaveFile(this, filename, type, palette); } -#if wxUSE_IMAGE - else +#if wxUSE_IMAGE && wxUSE_WXDIB + else // no bitmap handler found { // FIXME what about palette? shouldn't we use it? - wxImage image( *this ); - if ( image.Ok() ) + wxImage image = ConvertToImage(); + if ( image.IsOk() ) { return image.SaveFile(filename, type); } } #endif // wxUSE_IMAGE - return FALSE; + return false; } // ---------------------------------------------------------------------------- // sub bitmap extraction // ---------------------------------------------------------------------------- +wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect ) const +{ + MemoryHDC dcSrc; + SelectInHDC selectSrc(dcSrc, GetHbitmap()); + return GetSubBitmapOfHDC( rect, (WXHDC)dcSrc ); +} -wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect) const +wxBitmap wxBitmap::GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const { -#ifndef __WXMICROWIN__ - wxCHECK_MSG( Ok() && + wxCHECK_MSG( IsOk() && (rect.x >= 0) && (rect.y >= 0) && (rect.x+rect.width <= GetWidth()) && (rect.y+rect.height <= GetHeight()), wxNullBitmap, wxT("Invalid bitmap or bitmap region") ); wxBitmap ret( rect.width, rect.height, GetDepth() ); - wxASSERT_MSG( ret.Ok(), wxT("GetSubBitmap error") ); + wxASSERT_MSG( ret.IsOk(), wxT("GetSubBitmap error") ); + +#ifndef __WXMICROWIN__ + // handle alpha channel, if any + if (HasAlpha()) + ret.UseAlpha(); // copy bitmap data - HDC dcSrc = ::CreateCompatibleDC(NULL); - HDC dcDst = ::CreateCompatibleDC(NULL); - SelectObject(dcSrc, (HBITMAP) GetHBITMAP()); - SelectObject(dcDst, (HBITMAP) ret.GetHBITMAP()); - BitBlt(dcDst, 0, 0, rect.width, rect.height, dcSrc, rect.x, rect.y, SRCCOPY); + MemoryHDC dcSrc, + dcDst; + + { + SelectInHDC selectDst(dcDst, GetHbitmapOf(ret)); + + if ( !selectDst ) + { + wxLogLastError(wxT("SelectObject(destBitmap)")); + } + + if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height, + (HDC)hdc, rect.x, rect.y, SRCCOPY) ) + { + wxLogLastError(wxT("BitBlt")); + } + } // copy mask if there is one - if (GetMask()) + if ( GetMask() ) { HBITMAP hbmpMask = ::CreateBitmap(rect.width, rect.height, 1, 1, 0); - SelectObject(dcSrc, (HBITMAP) GetMask()->GetMaskBitmap()); - SelectObject(dcDst, (HBITMAP) hbmpMask); - BitBlt(dcDst, 0, 0, rect.width, rect.height, dcSrc, rect.x, rect.y, SRCCOPY); + SelectInHDC selectSrc(dcSrc, (HBITMAP) GetMask()->GetMaskBitmap()), + selectDst(dcDst, hbmpMask); + + if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height, + dcSrc, rect.x, rect.y, SRCCOPY) ) + { + wxLogLastError(wxT("BitBlt")); + } wxMask *mask = new wxMask((WXHBITMAP) hbmpMask); ret.SetMask(mask); } - - SelectObject(dcDst, NULL); - SelectObject(dcSrc, NULL); - DeleteDC(dcDst); - DeleteDC(dcSrc); +#endif // !__WXMICROWIN__ return ret; -#else - return wxBitmap(); -#endif } // ---------------------------------------------------------------------------- // wxBitmap accessors // ---------------------------------------------------------------------------- -void wxBitmap::SetQuality(int q) +#if wxUSE_PALETTE +wxPalette* wxBitmap::GetPalette() const +{ + return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette + : NULL; +} +#endif + +wxMask *wxBitmap::GetMask() const +{ + return GetBitmapData() ? GetBitmapData()->GetMask() : NULL; +} + +wxBitmap wxBitmap::GetMaskBitmap() const { - EnsureHasData(); + wxBitmap bmp; + wxMask *mask = GetMask(); + if ( mask ) + bmp.SetHBITMAP(mask->GetMaskBitmap()); + return bmp; +} - GetBitmapData()->m_quality = q; +wxDC *wxBitmap::GetSelectedInto() const +{ +#if wxDEBUG_LEVEL + return GetBitmapData() ? GetBitmapData()->m_selectedInto : NULL; +#else + return NULL; +#endif } -#if WXWIN_COMPATIBILITY_2 -void wxBitmap::SetOk(bool isOk) +void wxBitmap::UseAlpha() { - EnsureHasData(); + if ( GetBitmapData() ) + GetBitmapData()->m_hasAlpha = true; +} - GetBitmapData()->m_ok = isOk; +bool wxBitmap::HasAlpha() const +{ + return GetBitmapData() && GetBitmapData()->m_hasAlpha; +} + +// ---------------------------------------------------------------------------- +// wxBitmap setters +// ---------------------------------------------------------------------------- + +void wxBitmap::SetSelectedInto(wxDC *dc) +{ +#if wxDEBUG_LEVEL + if ( GetBitmapData() ) + GetBitmapData()->m_selectedInto = dc; +#else + wxUnusedVar(dc); +#endif } -#endif // WXWIN_COMPATIBILITY_2 #if wxUSE_PALETTE void wxBitmap::SetPalette(const wxPalette& palette) { - EnsureHasData(); + AllocExclusive(); GetBitmapData()->m_bitmapPalette = palette; } @@ -908,71 +1234,124 @@ void wxBitmap::SetPalette(const wxPalette& palette) void wxBitmap::SetMask(wxMask *mask) { - EnsureHasData(); + AllocExclusive(); - GetBitmapData()->m_bitmapMask = mask; + GetBitmapData()->SetMask(mask); } -// Creates a bitmap that matches the device context, from -// an arbitray bitmap. At present, the original bitmap must have an -// associated palette. TODO: use a default palette if no palette exists. -// Contributed by Frederic Villeneuve -wxBitmap wxBitmap::GetBitmapForDC(wxDC& dc) const +// ---------------------------------------------------------------------------- +// raw bitmap access support +// ---------------------------------------------------------------------------- + +#ifdef wxHAS_RAW_BITMAP + +void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp) { -#ifdef __WXMICROWIN__ - return wxBitmap(); -#else - wxMemoryDC memDC; - wxBitmap tmpBitmap(GetWidth(), GetHeight(), dc.GetDepth()); - HPALETTE hPal = (HPALETTE) NULL; - LPBITMAPINFO lpDib; - void *lpBits = (void*) NULL; +#if wxUSE_WXDIB + if ( !IsOk() ) + { + // no bitmap, no data (raw or otherwise) + return NULL; + } -#if wxUSE_PALETTE - if( GetPalette() && GetPalette()->Ok() ) + // if we're already a DIB we can access our data directly, but if not we + // need to convert this DDB to a DIB section and use it for raw access and + // then convert it back + HBITMAP hDIB; + if ( !GetBitmapData()->m_isDIB ) { - tmpBitmap.SetPalette(*GetPalette()); - memDC.SelectObject(tmpBitmap); - memDC.SetPalette(*GetPalette()); - hPal = (HPALETTE)GetPalette()->GetHPALETTE(); + wxCHECK_MSG( !GetBitmapData()->m_dib, NULL, + wxT("GetRawData() may be called only once") ); + + wxDIB *dib = new wxDIB(*this); + if ( !dib->IsOk() ) + { + delete dib; + + return NULL; + } + + // we'll free it in UngetRawData() + GetBitmapData()->m_dib = dib; + + hDIB = dib->GetHandle(); } - else + else // we're a DIB { - hPal = (HPALETTE) ::GetStockObject(DEFAULT_PALETTE); - wxPalette palette; - palette.SetHPALETTE( (WXHPALETTE)hPal ); - tmpBitmap.SetPalette( palette ); - memDC.SelectObject(tmpBitmap); - memDC.SetPalette( palette ); + hDIB = GetHbitmap(); } -#else // !wxUSE_PALETTE - hPal = (HPALETTE) ::GetStockObject(DEFAULT_PALETTE); -#endif // wxUSE_PALETTE/!wxUSE_PALETTE - // set the height negative because in a DIB the order of the lines is - // reversed - if ( !wxCreateDIB(GetWidth(), -GetHeight(), GetDepth(), hPal, &lpDib) ) + DIBSECTION ds; + if ( ::GetObject(hDIB, sizeof(ds), &ds) != sizeof(DIBSECTION) ) { - return wxNullBitmap; + wxFAIL_MSG( wxT("failed to get DIBSECTION from a DIB?") ); + + return NULL; } - lpBits = malloc(lpDib->bmiHeader.biSizeImage); + // check that the bitmap is in correct format + if ( ds.dsBm.bmBitsPixel != bpp ) + { + wxFAIL_MSG( wxT("incorrect bitmap type in wxBitmap::GetRawData()") ); + + return NULL; + } - ::GetBitmapBits(GetHbitmap(), lpDib->bmiHeader.biSizeImage, lpBits); + // ok, store the relevant info in wxPixelDataBase + const LONG h = ds.dsBm.bmHeight; - ::SetDIBitsToDevice(GetHdcOf(memDC), 0, 0, - GetWidth(), GetHeight(), - 0, 0, 0, GetHeight(), - lpBits, lpDib, DIB_RGB_COLORS); + data.m_width = ds.dsBm.bmWidth; + data.m_height = h; - free(lpBits); + // remember that DIBs are stored in top to bottom order! + // (We can't just use ds.dsBm.bmWidthBytes here, because it isn't always a + // multiple of 2, as required by the documentation. So we use the official + // formula, which we already use elsewhere.) + const LONG bytesPerRow = + wxDIB::GetLineSize(ds.dsBm.bmWidth, ds.dsBm.bmBitsPixel); + data.m_stride = -bytesPerRow; - wxFreeDIB(lpDib); + char *bits = (char *)ds.dsBm.bmBits; + if ( h > 1 ) + { + bits += (h - 1)*bytesPerRow; + } - return tmpBitmap; + return bits; +#else + return NULL; #endif } +void wxBitmap::UngetRawData(wxPixelDataBase& dataBase) +{ +#if wxUSE_WXDIB + if ( !IsOk() ) + return; + + if ( !&dataBase ) + { + // invalid data, don't crash -- but don't assert neither as we're + // called automatically from wxPixelDataBase dtor and so there is no + // way to prevent this from happening + return; + } + + // if we're a DDB we need to convert DIB back to DDB now to make the + // changes made via raw bitmap access effective + if ( !GetBitmapData()->m_isDIB ) + { + wxDIB *dib = GetBitmapData()->m_dib; + GetBitmapData()->m_dib = NULL; + + // TODO: convert + + delete dib; + } +#endif // wxUSE_WXDIB +} +#endif // wxHAS_RAW_BITMAP + // ---------------------------------------------------------------------------- // wxMask // ---------------------------------------------------------------------------- @@ -982,6 +1361,39 @@ wxMask::wxMask() m_maskBitmap = 0; } +// Copy constructor +wxMask::wxMask(const wxMask &mask) + : wxObject() +{ + BITMAP bmp; + + HDC srcDC = CreateCompatibleDC(0); + HDC destDC = CreateCompatibleDC(0); + + // GetBitmapDimensionEx won't work if SetBitmapDimensionEx wasn't used + // so we'll use GetObject() API here: + if (::GetObject((HGDIOBJ)mask.m_maskBitmap, sizeof(bmp), &bmp) == 0) + { + wxFAIL_MSG(wxT("Cannot retrieve the dimensions of the wxMask to copy")); + return; + } + + // create our HBITMAP + int w = bmp.bmWidth, h = bmp.bmHeight; + m_maskBitmap = (WXHBITMAP)CreateCompatibleBitmap(srcDC, w, h); + + // copy the mask's HBITMAP into our HBITMAP + SelectObject(srcDC, (HBITMAP) mask.m_maskBitmap); + SelectObject(destDC, (HBITMAP) m_maskBitmap); + + BitBlt(destDC, 0, 0, w, h, srcDC, 0, 0, SRCCOPY); + + SelectObject(srcDC, 0); + DeleteDC(srcDC); + SelectObject(destDC, 0); + DeleteDC(destDC); +} + // Construct a mask from a bitmap and a colour indicating // the transparent area wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour) @@ -1015,8 +1427,8 @@ wxMask::~wxMask() bool wxMask::Create(const wxBitmap& bitmap) { #ifndef __WXMICROWIN__ - wxCHECK_MSG( bitmap.Ok() && bitmap.GetDepth() == 1, FALSE, - _T("can't create mask from invalid or not monochrome bitmap") ); + wxCHECK_MSG( bitmap.IsOk() && bitmap.GetDepth() == 1, false, + wxT("can't create mask from invalid or not monochrome bitmap") ); if ( m_maskBitmap ) { @@ -1038,9 +1450,10 @@ bool wxMask::Create(const wxBitmap& bitmap) DeleteDC(srcDC); SelectObject(destDC, 0); DeleteDC(destDC); - return TRUE; + return true; #else - return FALSE; + wxUnusedVar(bitmap); + return false; #endif } @@ -1055,7 +1468,7 @@ bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex) } #if wxUSE_PALETTE - if (bitmap.Ok() && bitmap.GetPalette()->Ok()) + if (bitmap.IsOk() && bitmap.GetPalette()->IsOk()) { unsigned char red, green, blue; if (bitmap.GetPalette()->GetRGB(paletteIndex, &red, &green, &blue)) @@ -1066,7 +1479,7 @@ bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex) } #endif // wxUSE_PALETTE - return FALSE; + return false; } // Create a mask from a bitmap and a colour indicating @@ -1074,7 +1487,7 @@ bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex) bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour) { #ifndef __WXMICROWIN__ - wxCHECK_MSG( bitmap.Ok(), FALSE, _T("invalid bitmap in wxMask::Create") ); + wxCHECK_MSG( bitmap.IsOk(), false, wxT("invalid bitmap in wxMask::Create") ); if ( m_maskBitmap ) { @@ -1087,7 +1500,7 @@ bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour) // scan the bitmap for the transparent colour and set the corresponding // pixels in the mask to BLACK and the rest to WHITE - COLORREF maskColour = RGB(colour.Red(), colour.Green(), colour.Blue()); + COLORREF maskColour = wxColourToPalRGB(colour); m_maskBitmap = (WXHBITMAP)::CreateBitmap(width, height, 1, 1, 0); HDC srcDC = ::CreateCompatibleDC(NULL); @@ -1097,18 +1510,18 @@ bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour) wxLogLastError(wxT("CreateCompatibleDC")); } - bool ok = TRUE; + bool ok = true; // SelectObject() will fail wxASSERT_MSG( !bitmap.GetSelectedInto(), - _T("bitmap can't be selected in another DC") ); + wxT("bitmap can't be selected in another DC") ); HGDIOBJ hbmpSrcOld = ::SelectObject(srcDC, GetHbitmapOf(bitmap)); if ( !hbmpSrcOld ) { wxLogLastError(wxT("SelectObject")); - ok = FALSE; + ok = false; } HGDIOBJ hbmpDstOld = ::SelectObject(destDC, (HBITMAP)m_maskBitmap); @@ -1116,35 +1529,16 @@ bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour) { wxLogLastError(wxT("SelectObject")); - ok = FALSE; + ok = false; } - // this is not very efficient, but I can't think of a better way of doing - // it - for ( int w = 0; ok && (w < width); w++ ) + if ( ok ) { - for ( int h = 0; ok && (h < height); h++ ) - { - COLORREF col = GetPixel(srcDC, w, h); - if ( col == CLR_INVALID ) - { - wxLogLastError(wxT("GetPixel")); - - // doesn't make sense to continue - ok = FALSE; - - break; - } - - if ( col == maskColour ) - { - ::SetPixel(destDC, w, h, RGB(0, 0, 0)); - } - else - { - ::SetPixel(destDC, w, h, RGB(255, 255, 255)); - } - } + // this will create a monochrome bitmap with 0 points for the pixels + // which have the same value as the background colour and 1 for the + // others + ::SetBkColor(srcDC, maskColour); + ::BitBlt(destDC, 0, 0, width, height, srcDC, 0, 0, NOTSRCCOPY); } ::SelectObject(srcDC, hbmpSrcOld); @@ -1153,9 +1547,11 @@ bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour) ::DeleteDC(destDC); return ok; -#else - return FALSE; -#endif +#else // __WXMICROWIN__ + wxUnusedVar(bitmap); + wxUnusedVar(colour); + return false; +#endif // __WXMICROWIN__/!__WXMICROWIN__ } // ---------------------------------------------------------------------------- @@ -1163,123 +1559,177 @@ bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour) // ---------------------------------------------------------------------------- bool wxBitmapHandler::Create(wxGDIImage *image, - void *data, - long flags, + const void* data, + wxBitmapType type, int width, int height, int depth) { wxBitmap *bitmap = wxDynamicCast(image, wxBitmap); - return bitmap ? Create(bitmap, data, flags, width, height, depth) : FALSE; + return bitmap && Create(bitmap, data, type, width, height, depth); } bool wxBitmapHandler::Load(wxGDIImage *image, const wxString& name, - long flags, + wxBitmapType type, int width, int height) { wxBitmap *bitmap = wxDynamicCast(image, wxBitmap); - return bitmap ? LoadFile(bitmap, name, flags, width, height) : FALSE; + return bitmap && LoadFile(bitmap, name, type, width, height); } -bool wxBitmapHandler::Save(wxGDIImage *image, +bool wxBitmapHandler::Save(const wxGDIImage *image, const wxString& name, - int type) + wxBitmapType type) const { wxBitmap *bitmap = wxDynamicCast(image, wxBitmap); - return bitmap ? SaveFile(bitmap, name, type) : FALSE; + return bitmap && SaveFile(bitmap, name, type); } bool wxBitmapHandler::Create(wxBitmap *WXUNUSED(bitmap), - void *WXUNUSED(data), - long WXUNUSED(type), + const void* WXUNUSED(data), + wxBitmapType WXUNUSED(type), int WXUNUSED(width), int WXUNUSED(height), int WXUNUSED(depth)) { - return FALSE; + return false; } bool wxBitmapHandler::LoadFile(wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name), - long WXUNUSED(type), + wxBitmapType WXUNUSED(type), int WXUNUSED(desiredWidth), int WXUNUSED(desiredHeight)) { - return FALSE; + return false; } -bool wxBitmapHandler::SaveFile(wxBitmap *WXUNUSED(bitmap), +bool wxBitmapHandler::SaveFile(const wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name), - int WXUNUSED(type), - const wxPalette *WXUNUSED(palette)) + wxBitmapType WXUNUSED(type), + const wxPalette *WXUNUSED(palette)) const { - return FALSE; + return false; } // ---------------------------------------------------------------------------- -// DIB functions +// global helper functions implemented here // ---------------------------------------------------------------------------- -#ifndef __WXMICROWIN__ -bool wxCreateDIB(long xSize, long ySize, long bitsPerPixel, - HPALETTE hPal, LPBITMAPINFO* lpDIBHeader) +// helper of wxBitmapToHICON/HCURSOR +static +HICON wxBitmapToIconOrCursor(const wxBitmap& bmp, + bool iconWanted, + int hotSpotX, + int hotSpotY) { - unsigned long i, headerSize; - LPBITMAPINFO lpDIBheader = NULL; - LPPALETTEENTRY lpPe = NULL; + if ( !bmp.IsOk() ) + { + // we can't create an icon/cursor form nothing + return 0; + } + if ( bmp.HasAlpha() ) + { + HBITMAP hbmp; + +#if wxUSE_WXDIB && wxUSE_IMAGE + // CreateIconIndirect() requires non-pre-multiplied pixel data on input + // as it does pre-multiplication internally itself so we need to create + // a special DIB in such format to pass to it. This is inefficient but + // better than creating an icon with wrong colours. + AutoHBITMAP hbmpRelease; + hbmp = wxDIB(bmp.ConvertToImage(), + wxDIB::PixelFormat_NotPreMultiplied).Detach(); + hbmpRelease.Init(hbmp); +#else // !(wxUSE_WXDIB && wxUSE_IMAGE) + hbmp = GetHbitmapOf(bmp); +#endif // wxUSE_WXDIB && wxUSE_IMAGE + + // Create an empty mask bitmap. + // it doesn't seem to work if we mess with the mask at all. + AutoHBITMAP + hMonoBitmap(CreateBitmap(bmp.GetWidth(),bmp.GetHeight(),1,1,NULL)); + + ICONINFO iconInfo; + wxZeroMemory(iconInfo); + iconInfo.fIcon = iconWanted; // do we want an icon or a cursor? + if ( !iconWanted ) + { + iconInfo.xHotspot = hotSpotX; + iconInfo.yHotspot = hotSpotY; + } - // Allocate space for a DIB header - headerSize = (sizeof(BITMAPINFOHEADER) + (256 * sizeof(PALETTEENTRY))); - lpDIBheader = (BITMAPINFO *) malloc(headerSize); - lpPe = (PALETTEENTRY *)((BYTE*)lpDIBheader + sizeof(BITMAPINFOHEADER)); + iconInfo.hbmMask = hMonoBitmap; + iconInfo.hbmColor = hbmp; - GetPaletteEntries(hPal, 0, 256, lpPe); + return ::CreateIconIndirect(&iconInfo); + } - memset(lpDIBheader, 0x00, sizeof(BITMAPINFOHEADER)); + wxMask* mask = bmp.GetMask(); + + if ( !mask ) + { + // we must have a mask for an icon, so even if it's probably incorrect, + // do create it (grey is the "standard" transparent colour) + mask = new wxMask(bmp, *wxLIGHT_GREY); + } + + ICONINFO iconInfo; + wxZeroMemory(iconInfo); + iconInfo.fIcon = iconWanted; // do we want an icon or a cursor? + if ( !iconWanted ) + { + iconInfo.xHotspot = hotSpotX; + iconInfo.yHotspot = hotSpotY; + } - // Fill in the static parts of the DIB header - lpDIBheader->bmiHeader.biSize = sizeof(BITMAPINFOHEADER); - lpDIBheader->bmiHeader.biWidth = xSize; - lpDIBheader->bmiHeader.biHeight = ySize; - lpDIBheader->bmiHeader.biPlanes = 1; + AutoHBITMAP hbmpMask(wxInvertMask((HBITMAP)mask->GetMaskBitmap())); + iconInfo.hbmMask = hbmpMask; + iconInfo.hbmColor = GetHbitmapOf(bmp); - // this value must be 1, 4, 8 or 24 so PixelDepth can only be - lpDIBheader->bmiHeader.biBitCount = (WORD)(bitsPerPixel); - lpDIBheader->bmiHeader.biCompression = BI_RGB; - lpDIBheader->bmiHeader.biSizeImage = xSize * abs(ySize) * bitsPerPixel >> 3; - lpDIBheader->bmiHeader.biClrUsed = 256; + // black out the transparent area to preserve background colour, because + // Windows blits the original bitmap using SRCINVERT (XOR) after applying + // the mask to the dest rect. + { + MemoryHDC dcSrc, dcDst; + SelectInHDC selectMask(dcSrc, (HBITMAP)mask->GetMaskBitmap()), + selectBitmap(dcDst, iconInfo.hbmColor); + if ( !::BitBlt(dcDst, 0, 0, bmp.GetWidth(), bmp.GetHeight(), + dcSrc, 0, 0, SRCAND) ) + { + wxLogLastError(wxT("BitBlt")); + } + } - // Initialize the DIB palette - for (i = 0; i < 256; i++) { - lpDIBheader->bmiColors[i].rgbReserved = lpPe[i].peFlags; - lpDIBheader->bmiColors[i].rgbRed = lpPe[i].peRed; - lpDIBheader->bmiColors[i].rgbGreen = lpPe[i].peGreen; - lpDIBheader->bmiColors[i].rgbBlue = lpPe[i].peBlue; - } + HICON hicon = ::CreateIconIndirect(&iconInfo); - *lpDIBHeader = lpDIBheader; + if ( !bmp.GetMask() && !bmp.HasAlpha() ) + { + // we created the mask, now delete it + delete mask; + } - return TRUE; + return hicon; } -void wxFreeDIB(LPBITMAPINFO lpDIBHeader) +HICON wxBitmapToHICON(const wxBitmap& bmp) { - free(lpDIBHeader); + return wxBitmapToIconOrCursor(bmp, true, 0, 0); } -#endif -// ---------------------------------------------------------------------------- -// other helper functions -// ---------------------------------------------------------------------------- +HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY) +{ + return (HCURSOR)wxBitmapToIconOrCursor(bmp, false, hotSpotX, hotSpotY); +} -extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h) +HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h) { #ifndef __WXMICROWIN__ - wxCHECK_MSG( hbmpMask, 0, _T("invalid bitmap in wxInvertMask") ); + wxCHECK_MSG( hbmpMask, 0, wxT("invalid bitmap in wxInvertMask") ); // get width/height from the bitmap if not given if ( !w || !h ) @@ -1303,8 +1753,8 @@ extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h) wxLogLastError(wxT("CreateBitmap")); } - ::SelectObject(hdcSrc, hbmpMask); - ::SelectObject(hdcDst, hbmpInvMask); + HGDIOBJ srcTmp = ::SelectObject(hdcSrc, hbmpMask); + HGDIOBJ dstTmp = ::SelectObject(hdcDst, hbmpInvMask); if ( !::BitBlt(hdcDst, 0, 0, w, h, hdcSrc, 0, 0, NOTSRCCOPY) ) @@ -1312,6 +1762,10 @@ extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h) wxLogLastError(wxT("BitBlt")); } + // Deselect objects + SelectObject(hdcSrc,srcTmp); + SelectObject(hdcDst,dstTmp); + ::DeleteDC(hdcSrc); ::DeleteDC(hdcDst);