fixes #12220

[wxWidgets.git] / src / msw / dib.cpp

diff --git a/src/msw/dib.cpp b/src/msw/dib.cpp
index f79d16a1132704059b1f87ab9a8926b5288931f4..14a44e23394582065a967058d9af90c1659f6083 100644 (file)
--- a/src/msw/dib.cpp
+++ b/src/msw/dib.cpp
@@ -6,7 +6,7 @@
 // Created:     03.03.03 (replaces the old file with the same name)
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
 // Created:     03.03.03 (replaces the old file with the same name)
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>

-// License:     wxWindows licence
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 /*
 ///////////////////////////////////////////////////////////////////////////////
 
 /*


@@ -45,7 +45,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 
 #include <stdio.h>
 #include <stdlib.h>
 

-#if !defined(__MWERKS__) && !defined(__SALFORDC__)
+#if !defined(__MWERKS__)

     #include <memory.h>
 #endif
 
     #include <memory.h>
 #endif
 


@@ -91,44 +91,38 @@ bool wxDIB::Create(int width, int height, int depth)
 {
     // we don't support formats using palettes right now so we only create
     // either 24bpp (RGB) or 32bpp (RGBA) bitmaps
 {
     // we don't support formats using palettes right now so we only create
     // either 24bpp (RGB) or 32bpp (RGBA) bitmaps

-    wxASSERT_MSG( depth, _T("invalid image depth in wxDIB::Create()") );
+    wxASSERT_MSG( depth, wxT("invalid image depth in wxDIB::Create()") );

     if ( depth < 24 )
         depth = 24;
 
     // allocate memory for bitmap structures
     if ( depth < 24 )
         depth = 24;
 
     // allocate memory for bitmap structures

-    static const int sizeHeader = sizeof(BITMAPINFOHEADER);
+    BITMAPINFO info;
+    wxZeroMemory(info);

 
 

-    BITMAPINFO *info = (BITMAPINFO *)malloc(sizeHeader);
-    wxCHECK_MSG( info, false, _T("malloc(BITMAPINFO) failed") );
-
-    memset(info, 0, sizeHeader);
-
-    info->bmiHeader.biSize = sizeHeader;
-    info->bmiHeader.biWidth = width;
+    info.bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
+    info.bmiHeader.biWidth = width;

 
     // we use positive height here which corresponds to a DIB with normal, i.e.
     // bottom to top, order -- normally using negative height (which means
     // reversed for MS and hence natural for all the normal people top to
     // bottom line scan order) could be used to avoid the need for the image
     // reversal in Create(image) but this doesn't work under NT, only Win9x!
 
     // we use positive height here which corresponds to a DIB with normal, i.e.
     // bottom to top, order -- normally using negative height (which means
     // reversed for MS and hence natural for all the normal people top to
     // bottom line scan order) could be used to avoid the need for the image
     // reversal in Create(image) but this doesn't work under NT, only Win9x!

-    info->bmiHeader.biHeight = height;
+    info.bmiHeader.biHeight = height;

 
 

-    info->bmiHeader.biPlanes = 1;
-    info->bmiHeader.biBitCount = (WORD)depth;
-    info->bmiHeader.biSizeImage = GetLineSize(width, depth)*height;
+    info.bmiHeader.biPlanes = 1;
+    info.bmiHeader.biBitCount = (WORD)depth;
+    info.bmiHeader.biSizeImage = GetLineSize(width, depth)*height;

 
     m_handle = ::CreateDIBSection
                  (
                     0,              // hdc (unused with DIB_RGB_COLORS)
 
     m_handle = ::CreateDIBSection
                  (
                     0,              // hdc (unused with DIB_RGB_COLORS)

-                    info,           // bitmap description
+                    &info,          // bitmap description

                     DIB_RGB_COLORS, // use RGB, not palette
                     &m_data,        // [out] DIB bits
                     NULL,           // don't use file mapping
                     0               // file mapping offset (not used here)
                  );
 
                     DIB_RGB_COLORS, // use RGB, not palette
                     &m_data,        // [out] DIB bits
                     NULL,           // don't use file mapping
                     0               // file mapping offset (not used here)
                  );
 

-    free(info);
-

     if ( !m_handle )
     {
         wxLogLastError(wxT("CreateDIBSection"));
     if ( !m_handle )
     {
         wxLogLastError(wxT("CreateDIBSection"));


@@ -143,20 +137,10 @@ bool wxDIB::Create(int width, int height, int depth)
     return true;
 }
 
     return true;
 }
 

-bool wxDIB::Create(const wxBitmap& bmp)
-{
-    wxCHECK_MSG( bmp.Ok(), false, _T("wxDIB::Create(): invalid bitmap") );
-
-    if ( !Create(GetHbitmapOf(bmp)) )
-        return false;
-
-    m_hasAlpha = bmp.HasAlpha();
-
-    return true;
-}
-

 bool wxDIB::Create(HBITMAP hbmp)
 {
 bool wxDIB::Create(HBITMAP hbmp)
 {

+    wxCHECK_MSG( hbmp, false, wxT("wxDIB::Create(): invalid bitmap") );
+

     // this bitmap could already be a DIB section in which case we don't need
     // to convert it to DIB
     DIBSECTION ds;
     // this bitmap could already be a DIB section in which case we don't need
     // to convert it to DIB
     DIBSECTION ds;


@@ -232,7 +216,7 @@ bool wxDIB::CopyFromDDB(HBITMAP hbmp)
                     SRCCOPY
                   ) )
     {
                     SRCCOPY
                   ) )
     {

-        wxLogLastError(_T("BitBlt(DDB -> DIB)"));
+        wxLogLastError(wxT("BitBlt(DDB -> DIB)"));

 
         return false;
     }
 
         return false;
     }


@@ -248,7 +232,7 @@ bool wxDIB::CopyFromDDB(HBITMAP hbmp)
     if ( !GetDIBSection(m_handle, &ds) )
     {
         // we're sure that our handle is a DIB section, so this should work
     if ( !GetDIBSection(m_handle, &ds) )
     {
         // we're sure that our handle is a DIB section, so this should work

-        wxFAIL_MSG( _T("GetObject(DIBSECTION) unexpectedly failed") );
+        wxFAIL_MSG( wxT("GetObject(DIBSECTION) unexpectedly failed") );

 
         return false;
     }
 
         return false;
     }


@@ -286,7 +270,7 @@ bool wxDIB::Load(const wxString& filename)
     m_handle = (HBITMAP)::LoadImage
                          (
                             wxGetInstance(),
     m_handle = (HBITMAP)::LoadImage
                          (
                             wxGetInstance(),

-                            filename.fn_str(),
+                            filename.t_str(),

                             IMAGE_BITMAP,
                             0, 0, // don't specify the size
                             LR_CREATEDIBSECTION | LR_LOADFROMFILE
                             IMAGE_BITMAP,
                             0, 0, // don't specify the size
                             LR_CREATEDIBSECTION | LR_LOADFROMFILE


@@ -295,7 +279,7 @@ bool wxDIB::Load(const wxString& filename)
 
     if ( !m_handle )
     {
 
     if ( !m_handle )
     {

-        wxLogLastError(_T("Loading DIB from file"));
+        wxLogLastError(wxT("Loading DIB from file"));

 
         return false;
     }
 
         return false;
     }


@@ -305,7 +289,7 @@ bool wxDIB::Load(const wxString& filename)
 
 bool wxDIB::Save(const wxString& filename)
 {
 
 bool wxDIB::Save(const wxString& filename)
 {

-    wxCHECK_MSG( m_handle, false, _T("wxDIB::Save(): invalid object") );
+    wxCHECK_MSG( m_handle, false, wxT("wxDIB::Save(): invalid object") );

 
 #if wxUSE_FILE
     wxFile file(filename, wxFile::write);
 
 #if wxUSE_FILE
     wxFile file(filename, wxFile::write);


@@ -315,7 +299,7 @@ bool wxDIB::Save(const wxString& filename)
         DIBSECTION ds;
         if ( !GetDIBSection(m_handle, &ds) )
         {
         DIBSECTION ds;
         if ( !GetDIBSection(m_handle, &ds) )
         {

-            wxLogLastError(_T("GetObject(hDIB)"));
+            wxLogLastError(wxT("GetObject(hDIB)"));

         }
         else
         {
         }
         else
         {


@@ -367,7 +351,7 @@ void wxDIB::DoGetObject() const
         DIBSECTION ds;
         if ( !GetDIBSection(m_handle, &ds) )
         {
         DIBSECTION ds;
         if ( !GetDIBSection(m_handle, &ds) )
         {

-            wxLogLastError(_T("GetObject(hDIB)"));
+            wxLogLastError(wxT("GetObject(hDIB)"));

             return;
         }
 
             return;
         }
 


@@ -388,12 +372,12 @@ void wxDIB::DoGetObject() const
 
 HBITMAP wxDIB::CreateDDB(HDC hdc) const
 {
 
 HBITMAP wxDIB::CreateDDB(HDC hdc) const
 {

-    wxCHECK_MSG( m_handle, 0, _T("wxDIB::CreateDDB(): invalid object") );
+    wxCHECK_MSG( m_handle, 0, wxT("wxDIB::CreateDDB(): invalid object") );

 
     DIBSECTION ds;
     if ( !GetDIBSection(m_handle, &ds) )
     {
 
     DIBSECTION ds;
     if ( !GetDIBSection(m_handle, &ds) )
     {

-        wxLogLastError(_T("GetObject(hDIB)"));
+        wxLogLastError(wxT("GetObject(hDIB)"));

 
         return 0;
     }
 
         return 0;
     }


@@ -428,7 +412,7 @@ HBITMAP wxDIB::CreateDDB(HDC hdc) const
 /* static */
 HBITMAP wxDIB::ConvertToBitmap(const BITMAPINFO *pbmi, HDC hdc, void *bits)
 {
 /* static */
 HBITMAP wxDIB::ConvertToBitmap(const BITMAPINFO *pbmi, HDC hdc, void *bits)
 {

-    wxCHECK_MSG( pbmi, 0, _T("invalid DIB in ConvertToBitmap") );
+    wxCHECK_MSG( pbmi, 0, wxT("invalid DIB in ConvertToBitmap") );

 
     // here we get BITMAPINFO struct followed by the actual bitmap bits and
     // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info
 
     // here we get BITMAPINFO struct followed by the actual bitmap bits and
     // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info


@@ -564,7 +548,7 @@ HGLOBAL wxDIB::ConvertFromBitmap(HBITMAP hbmp)
     {
         // this is an error which does risk to happen especially under Win9x
         // and which the user may understand so let him know about it
     {
         // this is an error which does risk to happen especially under Win9x
         // and which the user may understand so let him know about it

-        wxLogError(_("Failed to allocated %luKb of memory for bitmap data."),
+        wxLogError(_("Failed to allocate %luKb of memory for bitmap data."),

                    (unsigned long)(size / 1024));
 
         return NULL;
                    (unsigned long)(size / 1024));
 
         return NULL;


@@ -574,7 +558,7 @@ HGLOBAL wxDIB::ConvertFromBitmap(HBITMAP hbmp)
     {
         // this really shouldn't happen... it worked the first time, why not
         // now?
     {
         // this really shouldn't happen... it worked the first time, why not
         // now?

-        wxFAIL_MSG( _T("wxDIB::ConvertFromBitmap() unexpectedly failed") );
+        wxFAIL_MSG( wxT("wxDIB::ConvertFromBitmap() unexpectedly failed") );

 
         return NULL;
     }
 
         return NULL;
     }


@@ -596,12 +580,12 @@ wxPalette *wxDIB::CreatePalette() const
 #if defined(_WIN32_WCE) && _WIN32_WCE < 400
     return NULL;
 #else
 #if defined(_WIN32_WCE) && _WIN32_WCE < 400
     return NULL;
 #else

-    wxCHECK_MSG( m_handle, NULL, _T("wxDIB::CreatePalette(): invalid object") );
+    wxCHECK_MSG( m_handle, NULL, wxT("wxDIB::CreatePalette(): invalid object") );

 
     DIBSECTION ds;
     if ( !GetDIBSection(m_handle, &ds) )
     {
 
     DIBSECTION ds;
     if ( !GetDIBSection(m_handle, &ds) )
     {

-        wxLogLastError(_T("GetObject(hDIB)"));
+        wxLogLastError(wxT("GetObject(hDIB)"));

 
         return 0;
     }
 
         return 0;
     }


@@ -629,7 +613,7 @@ wxPalette *wxDIB::CreatePalette() const
     // going to have biClrUsed of them so add necessary space
     LOGPALETTE *pPalette = (LOGPALETTE *)
         malloc(sizeof(LOGPALETTE) + (biClrUsed - 1)*sizeof(PALETTEENTRY));
     // going to have biClrUsed of them so add necessary space
     LOGPALETTE *pPalette = (LOGPALETTE *)
         malloc(sizeof(LOGPALETTE) + (biClrUsed - 1)*sizeof(PALETTEENTRY));

-    wxCHECK_MSG( pPalette, NULL, _T("out of memory") );
+    wxCHECK_MSG( pPalette, NULL, wxT("out of memory") );

 
     // initialize the palette header
     pPalette->palVersion = 0x300;  // magic number, not in docs but works
 
     // initialize the palette header
     pPalette->palVersion = 0x300;  // magic number, not in docs but works


@@ -654,7 +638,7 @@ wxPalette *wxDIB::CreatePalette() const
 
     if ( !hPalette )
     {
 
     if ( !hPalette )
     {

-        wxLogLastError(_T("CreatePalette"));
+        wxLogLastError(wxT("CreatePalette"));

 
         return NULL;
     }
 
         return NULL;
     }


@@ -674,17 +658,17 @@ wxPalette *wxDIB::CreatePalette() const
 
 #if wxUSE_IMAGE
 
 
 #if wxUSE_IMAGE
 

-bool wxDIB::Create(const wxImage& image)
+bool wxDIB::Create(const wxImage& image, PixelFormat pf)

 {
 {

-    wxCHECK_MSG( image.Ok(), false, _T("invalid wxImage in wxDIB ctor") );
+    wxCHECK_MSG( image.Ok(), false, wxT("invalid wxImage in wxDIB ctor") );

 
     const int h = image.GetHeight();
     const int w = image.GetWidth();
 
     // if we have alpha channel, we need to create a 32bpp RGBA DIB, otherwise
     // a 24bpp RGB is sufficient
 
     const int h = image.GetHeight();
     const int w = image.GetWidth();
 
     // if we have alpha channel, we need to create a 32bpp RGBA DIB, otherwise
     // a 24bpp RGB is sufficient

-    m_hasAlpha = image.HasAlpha();
-    const int bpp = m_hasAlpha ? 32 : 24;
+    const bool hasAlpha = image.HasAlpha();
+    const int bpp = hasAlpha ? 32 : 24;

 
     if ( !Create(w, h, bpp) )
         return false;
 
     if ( !Create(w, h, bpp) )
         return false;


@@ -694,32 +678,53 @@ bool wxDIB::Create(const wxImage& image)
     const int srcBytesPerLine = w * 3;
     const int dstBytesPerLine = GetLineSize(w, bpp);
     const unsigned char *src = image.GetData() + ((h - 1) * srcBytesPerLine);
     const int srcBytesPerLine = w * 3;
     const int dstBytesPerLine = GetLineSize(w, bpp);
     const unsigned char *src = image.GetData() + ((h - 1) * srcBytesPerLine);

-    const unsigned char *alpha = m_hasAlpha ? image.GetAlpha() + (h - 1)*w
-                                            : NULL;
+    const unsigned char *alpha = hasAlpha ? image.GetAlpha() + (h - 1)*w
+                                          : NULL;

     unsigned char *dstLineStart = (unsigned char *)m_data;
     for ( int y = 0; y < h; y++ )
     {
     unsigned char *dstLineStart = (unsigned char *)m_data;
     for ( int y = 0; y < h; y++ )
     {

-        // copy one DIB line
+        // Copy one DIB line. Note that RGB components order is reversed in
+        // Windows bitmaps compared to wxImage and is actually BGR.

         unsigned char *dst = dstLineStart;
         if ( alpha )
         {
         unsigned char *dst = dstLineStart;
         if ( alpha )
         {

-            for ( int x = 0; x < w; x++ )
+            int x;
+
+            switch ( pf )

             {
             {

-                // RGB order is reversed, and we need to premultiply
-                // all channels by alpha value for use with ::AlphaBlend.
-                const unsigned char a = *alpha++;
-                *dst++ = (unsigned char)((src[2] * a + 127) / 255);
-                *dst++ = (unsigned char)((src[1] * a + 127) / 255);
-                *dst++ = (unsigned char)((src[0] * a + 127) / 255);
-                *dst++ = a;
-                src += 3;
+                case PixelFormat_PreMultiplied:
+                    // Pre-multiply pixel values so that the DIB could be used
+                    // with ::AlphaBlend().
+                    for ( x = 0; x < w; x++ )
+                    {
+                        const unsigned char a = *alpha++;
+                        *dst++ = (unsigned char)((src[2] * a + 127) / 255);
+                        *dst++ = (unsigned char)((src[1] * a + 127) / 255);
+                        *dst++ = (unsigned char)((src[0] * a + 127) / 255);
+                        *dst++ = a;
+                        src += 3;
+                    }
+                    break;
+
+                case PixelFormat_NotPreMultiplied:
+                    // Just copy pixel data without changing it.
+                    for ( x = 0; x < w; x++ )
+                    {
+                        *dst++ = src[2];
+                        *dst++ = src[1];
+                        *dst++ = src[0];
+
+                        *dst++ = *alpha++;
+                        src += 3;
+                    }
+                    break;

             }
             }

+

         }
         else // no alpha channel
         {
             for ( int x = 0; x < w; x++ )
             {
         }
         else // no alpha channel
         {
             for ( int x = 0; x < w; x++ )
             {

-                // RGB order is reversed.

                 *dst++ = src[2];
                 *dst++ = src[1];
                 *dst++ = src[0];
                 *dst++ = src[2];
                 *dst++ = src[1];
                 *dst++ = src[0];


@@ -754,20 +759,30 @@ wxImage wxDIB::ConvertToImage() const
         return wxNullImage;
     }
 
         return wxNullImage;
     }
 

-    if ( m_hasAlpha )
+    const int bpp = GetDepth();
+
+    // Remember if we have any "real" transparency, i.e. either any partially
+    // transparent pixels or not all pixels are fully opaque or fully
+    // transparent.
+    bool hasAlpha = false;
+    bool hasOpaque = false;
+    bool hasTransparent = false;
+
+    if ( bpp == 32 )

     {
     {

+        // 32 bit bitmaps may be either 0RGB or ARGB and we don't know in
+        // advance which one do we have so suppose we have alpha of them and
+        // get rid of it later if it turns out we didn't.

         image.SetAlpha();
     }
 
     // this is the same loop as in Create() just above but with copy direction
     // reversed
         image.SetAlpha();
     }
 
     // this is the same loop as in Create() just above but with copy direction
     // reversed

-    const int bpp = GetDepth();

     const int dstBytesPerLine = w * 3;
     const int srcBytesPerLine = GetLineSize(w, bpp);
     unsigned char *dst = image.GetData() + ((h - 1) * dstBytesPerLine);
     unsigned char *alpha = image.HasAlpha() ? image.GetAlpha() + (h - 1)*w
                                             : NULL;
     const int dstBytesPerLine = w * 3;
     const int srcBytesPerLine = GetLineSize(w, bpp);
     unsigned char *dst = image.GetData() + ((h - 1) * dstBytesPerLine);
     unsigned char *alpha = image.HasAlpha() ? image.GetAlpha() + (h - 1)*w
                                             : NULL;

-    const bool is32bit = bpp == 32;

     const unsigned char *srcLineStart = (unsigned char *)GetData();
     for ( int y = 0; y < h; y++ )
     {
     const unsigned char *srcLineStart = (unsigned char *)GetData();
     for ( int y = 0; y < h; y++ )
     {


@@ -779,20 +794,36 @@ wxImage wxDIB::ConvertToImage() const
             dst[1] = *src++;
             dst[0] = *src++;
 
             dst[1] = *src++;
             dst[0] = *src++;
 

-            if ( is32bit )
+            if ( bpp == 32 )

             {
             {

-                if ( alpha )
+                // wxImage uses non premultiplied alpha so undo
+                // premultiplication done in Create() above
+                const unsigned char a = *src;
+                *alpha++ = a;
+
+                // Check what kind of alpha do we have.
+                switch ( a )

                 {
                 {

-                    // wxImage uses non premultiplied alpha so undo
-                    // premultiplication done in Create() above
-                    const unsigned char a = *src;
-                    *alpha++ = a;
-                    if ( a > 0 )
-                    {
-                        dst[0] = (dst[0] * 255 - 127) / a;
-                        dst[1] = (dst[1] * 255 - 127) / a;
-                        dst[2] = (dst[2] * 255 - 127) / a;
-                    }
+                    case 0:
+                        hasTransparent = true;
+                        break;
+
+                    default:
+                        // Anything in between means we have real transparency
+                        // and must use alpha channel.
+                        hasAlpha = true;
+                        break;
+
+                    case 255:
+                        hasOpaque = true;
+                        break;
+                }
+
+                if ( a > 0 )
+                {
+                    dst[0] = (dst[0] * 255) / a;
+                    dst[1] = (dst[1] * 255) / a;
+                    dst[2] = (dst[2] * 255) / a;

                 }
 
                 src++;
                 }
 
                 src++;


@@ -810,6 +841,12 @@ wxImage wxDIB::ConvertToImage() const
         srcLineStart += srcBytesPerLine;
     }
 
         srcLineStart += srcBytesPerLine;
     }
 

+    if ( hasOpaque && hasTransparent )
+        hasAlpha = true;
+
+    if ( !hasAlpha && image.HasAlpha() )
+        image.ClearAlpha();
+

     return image;
 }
 
     return image;
 }