]> git.saurik.com Git - wxWidgets.git/blobdiff - src/cocoa/bitmap.mm
Update from Hartwig for OS X implementation
[wxWidgets.git] / src / cocoa / bitmap.mm
index ca82c1a4e4380e5b47a4ea33adac5831d54ba515..cddc8c192f545a6c9c5e6903a1262b300e74c5ae 100644 (file)
@@ -1,28 +1,39 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        src/cocoa/bitmap.cpp
+// Name:        src/cocoa/bitmap.mm
 // Purpose:     wxBitmap
 // Author:      David Elliott
 // Modified by:
 // Created:     2003/07/19
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 David Elliott
-// Licence:     wxWindows licence
+// Licence:     wxWidgets licence
 /////////////////////////////////////////////////////////////////////////////
 
-#include "wx/setup.h"
-#include "wx/utils.h"
-#include "wx/palette.h"
+#include "wx/wxprec.h"
+
 #include "wx/bitmap.h"
-#include "wx/icon.h"
-#include "wx/log.h"
-#include "wx/image.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/utils.h"
+    #include "wx/palette.h"
+    #include "wx/icon.h"
+    #include "wx/colour.h"
+    #include "wx/image.h"
+#endif //WX_PRECOMP
+
 #include "wx/xpmdecod.h"
+#include "wx/rawbmp.h"
 
 #include "wx/cocoa/autorelease.h"
 #include "wx/cocoa/string.h"
 
 #import <AppKit/NSBitmapImageRep.h>
 #import <AppKit/NSGraphics.h>
+#import <AppKit/NSImage.h>
+#import <AppKit/NSColor.h>
+
+IMPLEMENT_ABSTRACT_CLASS(wxBitmapHandler, wxBitmapHandlerBase)
 
 // ========================================================================
 // wxBitmapRefData
@@ -70,8 +81,7 @@ wxBitmapRefData::wxBitmapRefData( const wxBitmapRefData& data)
     m_numColors = data.m_numColors;
     m_bitmapPalette = data.m_bitmapPalette;
     m_quality = data.m_quality;
-    m_cocoaNSBitmapImageRep = data.m_cocoaNSBitmapImageRep;
-    [m_cocoaNSBitmapImageRep retain];
+    m_cocoaNSBitmapImageRep = [data.m_cocoaNSBitmapImageRep copyWithZone:nil];
     m_bitmapMask = data.m_bitmapMask?new wxMask(*data.m_bitmapMask):NULL;
 }
 
@@ -115,7 +125,17 @@ wxBitmap::wxBitmap(int w, int h, int d)
     (void)Create(w, h, d);
 }
 
-wxBitmap::wxBitmap(void *data, wxBitmapType type, int width, int height, int depth)
+wxBitmap::wxBitmap(NSImage* cocoaNSImage)
+{
+    (void) Create(cocoaNSImage);
+}
+
+wxBitmap::wxBitmap(NSBitmapImageRep* cocoaNSBitmapImageRep)
+{
+    (void) Create(cocoaNSBitmapImageRep);
+}
+
+wxBitmap::wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth)
 {
     (void) Create(data, type, width, height, depth);
 }
@@ -142,6 +162,42 @@ WX_NSBitmapImageRep wxBitmap::GetNSBitmapImageRep()
     return M_BITMAPDATA->m_cocoaNSBitmapImageRep;
 }
 
+WX_NSImage wxBitmap::GetNSImage(bool useMask) const
+{
+    if(!Ok())
+        return nil;
+    NSImage *nsimage = [[[NSImage alloc]
+            initWithSize:NSMakeSize(GetWidth(), GetHeight())] autorelease];
+    if(!nsimage)
+        return nil;
+    [nsimage addRepresentation: M_BITMAPDATA->m_cocoaNSBitmapImageRep];
+    if(useMask && GetMask())
+    {
+        // Show before/after to prove that the bitmap itself is not changed
+        // even though we just composited onto the NSImage
+        wxLogTrace(wxTRACE_COCOA,wxT("Before: bpp=%d"),[M_BITMAPDATA->m_cocoaNSBitmapImageRep bitsPerPixel]);
+        NSImage *maskImage = [[NSImage alloc]
+                initWithSize:NSMakeSize(GetWidth(), GetHeight())];
+        [maskImage addRepresentation: GetMask()->GetNSBitmapImageRep()];
+        [nsimage lockFocus];
+        [maskImage compositeToPoint:NSZeroPoint operation:NSCompositeDestinationIn];
+        [nsimage unlockFocus];
+        [maskImage release];
+        wxLogTrace(wxTRACE_COCOA,wxT("After: bpp=%d"),[M_BITMAPDATA->m_cocoaNSBitmapImageRep bitsPerPixel]);
+    }
+    return nsimage;
+}
+
+void wxBitmap::SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep)
+{
+    if(!M_BITMAPDATA)
+        return;
+    // NOTE: No checking is done to make sure width/height agree
+    [bitmapImageRep retain];
+    [M_BITMAPDATA->m_cocoaNSBitmapImageRep release];
+    M_BITMAPDATA->m_cocoaNSBitmapImageRep = bitmapImageRep;
+}
+
 void wxBitmap::SetWidth(int w)
 {
     if (!M_BITMAPDATA)
@@ -198,7 +254,7 @@ void wxBitmap::SetMask(wxMask *mask)
     M_BITMAPDATA->m_bitmapMask = mask ;
 }
 
-bool wxBitmap::Ok() const
+bool wxBitmap::IsOk() const
 {
     return m_refData && M_BITMAPDATA->m_ok;
 }
@@ -249,6 +305,24 @@ bool wxBitmap::Create(int w, int h, int d)
     M_BITMAPDATA->m_depth = d;
 
     /* TODO: create new bitmap */
+    M_BITMAPDATA->m_cocoaNSBitmapImageRep = [[NSBitmapImageRep alloc]
+            initWithBitmapDataPlanes: NULL
+            pixelsWide: w
+            pixelsHigh: h
+            bitsPerSample: 8
+            samplesPerPixel: 3
+            hasAlpha: NO
+            isPlanar: NO
+            colorSpaceName: NSCalibratedRGBColorSpace
+            bytesPerRow: 0  // NOTE: Contrary to Apple documentation Mac OS
+                            // 10.4 will add padding bytes when 0 is used here
+            bitsPerPixel: 0];
+
+    wxLogTrace(wxTRACE_COCOA,wxT("M_BITMAPDATA=%p NSBitmapImageRep bitmapData=%p"), M_BITMAPDATA, [M_BITMAPDATA->m_cocoaNSBitmapImageRep bitmapData]);
+    M_BITMAPDATA->m_ok = true;
+    M_BITMAPDATA->m_numColors = 0;
+    M_BITMAPDATA->m_quality = 0;
+    M_BITMAPDATA->m_bitmapMask = NULL;
 
     return M_BITMAPDATA->m_ok;
 }
@@ -284,7 +358,34 @@ bool wxBitmap::LoadFile(const wxString& filename, wxBitmapType type)
     return true;
 }
 
-bool wxBitmap::Create(void *data, wxBitmapType type, int width, int height, int depth)
+bool wxBitmap::Create(NSImage* cocoaNSImage)
+{
+    wxAutoNSAutoreleasePool pool;
+    NSBitmapImageRep *bitmapImageRep = [NSBitmapImageRep imageRepWithData:[cocoaNSImage TIFFRepresentation]];
+    return Create(bitmapImageRep);
+}
+
+bool wxBitmap::Create(NSBitmapImageRep *imageRep)
+{
+    UnRef();
+    m_refData = new wxBitmapRefData;
+    if(imageRep != nil)
+    {
+        M_BITMAPDATA->m_width = [imageRep pixelsWide];
+        M_BITMAPDATA->m_height = [imageRep pixelsHigh];
+        M_BITMAPDATA->m_depth = [imageRep bitsPerPixel];
+        M_BITMAPDATA->m_ok = true;
+        M_BITMAPDATA->m_numColors = 0;
+        M_BITMAPDATA->m_quality = 0;
+        M_BITMAPDATA->m_cocoaNSBitmapImageRep = [imageRep retain];
+        M_BITMAPDATA->m_bitmapMask = NULL;
+        return true;
+    }
+    else
+        return false;
+}
+
+bool wxBitmap::Create(const void* data, wxBitmapType type, int width, int height, int depth)
 {
     UnRef();
 
@@ -298,9 +399,31 @@ bool wxBitmap::SaveFile(const wxString& filename, wxBitmapType type, const wxPal
     return false;
 }
 
-bool wxBitmap::CopyFromIcon(const wxIcon& icno)
+bool wxBitmap::CopyFromIcon(const wxIcon& icon)
 {
-    return false;
+    // Pool here due to lack of one during wx init phase
+    wxAutoNSAutoreleasePool pool;
+
+    UnRef();
+    if(!icon.GetNSImage());
+    [icon.GetNSImage() lockFocus];
+    NSRect imageRect;
+    imageRect.origin.x = imageRect.origin.y = 0.0;
+    imageRect.size = [icon.GetNSImage() size];
+    NSBitmapImageRep *newBitmapRep = [[NSBitmapImageRep alloc] initWithFocusedViewRect:imageRect];
+    [icon.GetNSImage() unlockFocus];
+    if(!newBitmapRep)
+        return false;
+    m_refData = new wxBitmapRefData;
+    M_BITMAPDATA->m_cocoaNSBitmapImageRep = newBitmapRep;
+    M_BITMAPDATA->m_width = [newBitmapRep pixelsWide];
+    M_BITMAPDATA->m_height = [newBitmapRep pixelsHigh];
+    M_BITMAPDATA->m_depth = [newBitmapRep bitsPerSample]*[newBitmapRep samplesPerPixel];
+    M_BITMAPDATA->m_ok = true;
+    M_BITMAPDATA->m_numColors = 0;
+    M_BITMAPDATA->m_quality = 0;
+    M_BITMAPDATA->m_bitmapMask = NULL;
+    return true;
 }
 
 wxBitmap wxBitmap::GetSubBitmap(wxRect const&) const
@@ -310,27 +433,26 @@ wxBitmap wxBitmap::GetSubBitmap(wxRect const&) const
 
 wxImage wxBitmap::ConvertToImage() const
 {
-    if(!M_BITMAPDATA->m_ok)
-        return wxImage(5,5)/*wxNullImage*/;
-    return wxImage(M_BITMAPDATA->m_width,M_BITMAPDATA->m_height);
-}
-
-bool wxBitmap::CreateFromXpm(const char **xpm)
-{
-#if wxUSE_IMAGE && wxUSE_XPM
-    UnRef();
-
-    wxCHECK_MSG( xpm, false, wxT("invalid XPM data") )
-
-    wxXPMDecoder decoder;
-    wxImage img = decoder.ReadData(xpm);
-    wxCHECK_MSG( img.Ok(), false, wxT("invalid XPM data") )
-
-    *this = wxBitmap(img);
-    return true;
-#else
-    return false;
-#endif
+    wxAutoNSAutoreleasePool pool;
+    if(!Ok())
+        return /*wxImage(5,5)*/wxNullImage;
+    NSImage *nsimage = GetNSImage(false /* don't use mask */);
+    wxImage newImage(M_BITMAPDATA->m_width,M_BITMAPDATA->m_height);
+    [nsimage lockFocus];
+    for(int i=0; i < M_BITMAPDATA->m_width; i++)
+    {
+        // Don't let the pool get too big as you'll notice we're creating
+        // two autoreleased NSColor objects with every iteration.
+        wxAutoNSAutoreleasePool loopPool;
+        for(int j=0; j < M_BITMAPDATA->m_height; j++)
+        {
+            NSColor *pixelColor = NSReadPixel(NSMakePoint(i,M_BITMAPDATA->m_height - j - 1));
+            NSColor *color = [pixelColor colorUsingColorSpaceName:NSCalibratedRGBColorSpace];
+            newImage.SetRGB(i,j,int([color redComponent]*255.0), int([color greenComponent]*255.0), int([color blueComponent]*255.0));
+        }
+    }
+    [nsimage unlockFocus];
+    return newImage;
 }
 
 bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
@@ -353,9 +475,11 @@ bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
             hasAlpha: NO
             isPlanar: NO
             colorSpaceName: NSCalibratedRGBColorSpace
-            bytesPerRow: 0
+            bytesPerRow: image.GetWidth()*3
             bitsPerPixel: 0];
 
+    // TODO: Specify bytesPerRow:0 and then use [bitmapImage bytesPerRow]
+    // so that the rows are aligned suitably for altivec by the OS (Tiger)
     const int numBytes = image.GetWidth()*image.GetHeight()*3;
     memcpy([bitmapImage bitmapData], image.GetData(), numBytes);
     // TODO: Alpha and convert to desired depth
@@ -364,10 +488,41 @@ bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
     M_BITMAPDATA->m_numColors = 0;
     M_BITMAPDATA->m_quality = 0;
     M_BITMAPDATA->m_cocoaNSBitmapImageRep = bitmapImage;
-    M_BITMAPDATA->m_bitmapMask = NULL;
+    M_BITMAPDATA->m_bitmapMask = new wxMask(*this,wxColour(image.GetMaskRed(),image.GetMaskGreen(),image.GetMaskBlue()));
     return true;
 }
 
+void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
+{
+    if(!Ok())
+        return NULL;
+
+    NSBitmapImageRep *bitmapRep = M_BITMAPDATA->m_cocoaNSBitmapImageRep;
+    if(!bitmapRep)
+        return NULL;
+
+    if([bitmapRep bitsPerPixel]!=bpp)
+    {
+        wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
+        return NULL;
+    }
+    data.m_width = [bitmapRep pixelsWide];
+    data.m_height = [bitmapRep pixelsHigh];
+    data.m_stride = [bitmapRep bytesPerRow];
+    return [bitmapRep bitmapData];
+
+    // NOTE: It is up to the user to make sure they used the proper
+    // pixel format class that details what is actually inside the pixels
+    // We can only check to make sure that the total number of bits per
+    // pixel are being iterated over properly
+    // NSBitmapImageRep can contain grayscale or CMYK data and
+    // wxPixelDataBase doesn't really define the color format
+}
+
+void wxBitmap::UngetRawData(wxPixelDataBase& data)
+{   // TODO
+}
+
 // ========================================================================
 // wxMask
 // ========================================================================
@@ -376,18 +531,14 @@ IMPLEMENT_DYNAMIC_CLASS(wxMask, wxObject)
 
 wxMask::wxMask()
 {
-/* TODO
-    m_maskBitmap = 0;
-*/
+    m_cocoaNSBitmapImageRep = nil;
 }
 
 // Construct a mask from a bitmap and a colour indicating
 // the transparent area
 wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
 {
-/* TODO
-    m_maskBitmap = 0;
-*/
+    m_cocoaNSBitmapImageRep = nil;
     Create(bitmap, colour);
 }
 
@@ -395,9 +546,7 @@ wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
 // the transparent area
 wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
 {
-/* TODO
-    m_maskBitmap = 0;
-*/
+    m_cocoaNSBitmapImageRep = nil;
 
     Create(bitmap, paletteIndex);
 }
@@ -405,22 +554,28 @@ wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
 // Construct a mask from a mono bitmap (copies the bitmap).
 wxMask::wxMask(const wxBitmap& bitmap)
 {
-/* TODO
-    m_maskBitmap = 0;
-*/
+    m_cocoaNSBitmapImageRep = nil;
 
     Create(bitmap);
 }
 
+// Copy constructor
+wxMask::wxMask(const wxMask& src)
+:   wxObject(src)
+,   m_cocoaNSBitmapImageRep([src.m_cocoaNSBitmapImageRep retain])
+{
+}
+
 wxMask::~wxMask()
 {
-// TODO: delete mask bitmap
+    [m_cocoaNSBitmapImageRep release];
 }
 
 // Create a mask from a mono bitmap (copies the bitmap).
 bool wxMask::Create(const wxBitmap& bitmap)
 {
 // TODO
+    wxLogDebug(wxT("Cannot yet create a mask from a mono bitmap"));
     return FALSE;
 }
 
@@ -429,14 +584,125 @@ bool wxMask::Create(const wxBitmap& bitmap)
 bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
 {
 // TODO
+    wxLogDebug(wxT("Cannot yet create a mask from a palette bitmap"));
     return FALSE;
 }
 
+template <typename PixelData>
+static bool wxMask_CreateFromBitmapData(PixelData srcData, const wxColour& colour, unsigned char *dstData)
+{
+    wxCHECK_MSG(dstData,false,wxT("Couldn't access mask data"));
+    typename PixelData::Iterator p(srcData);
+    const int nRows = srcData.GetHeight();
+    const int nCols = srcData.GetWidth();
+    // Total number of bytes per destination column
+    const int dstRowLength = (nCols+7)/8;
+    // Number of source columns that fit into a byte in the destination
+    const int width_aligned = nCols/8*8;
+    for(int y=0; y<nRows; ++y)
+    {
+        typename PixelData::Iterator rowStart(p);
+        unsigned char *dstRow = dstData + y*dstRowLength;
+        for(int x=0; x<width_aligned; x+=8)
+        {
+            unsigned char *dstByte = dstRow + x/8;
+            *dstByte = 0;
+            // Take source RGB, compare it with the wxColour
+            for(int j=0; j<8; ++j, ++p)
+            {
+                *dstByte +=
+                (   p.Red()!=colour.Red()
+                ||  p.Green()!=colour.Green()
+                ||  p.Blue()!=colour.Blue()
+                )   << (7-j);
+            }
+        }
+        // Handle the remaining 0-7 pixels in the row
+        unsigned char *dstByte = dstRow + width_aligned/8;
+        if(nCols%8>0)
+            *dstByte = 0;
+        for(int j=0; j<(nCols%8); ++j, ++p)
+        {
+            *dstByte +=
+            (   p.Red()!=colour.Red()
+            ||  p.Green()!=colour.Green()
+            ||  p.Blue()!=colour.Blue()
+            )   << (7-j);
+        }
+        p = rowStart;
+        p.OffsetY(srcData,1);
+    }
+    return true;
+}
+
 // Create a mask from a bitmap and a colour indicating
 // the transparent area
 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
 {
-// TODO
-    return FALSE;
-}
+    wxAutoNSAutoreleasePool pool;
+    if(!bitmap.Ok())
+        return false;
+    int bmpWidth = bitmap.GetWidth();
+    int bmpHeight = bitmap.GetHeight();
+    int dstRowLength = (bmpWidth+7)/8;
+
+    // Create a bitmap image rep with 1-bit per pixel data representing
+    // the alpha channel padded such that rows end on byte boundaries
+    // Since NSBitmapImageRep doesn't have any sort of NSNullColorSpace
+    // we must have at least one channel of non-alpha data.  In order to
+    // make our life easy, we use planar data which results in two
+    // separate arrays.  We don't need to touch the first because it
+    // should never be used.  The second is the 1-bit "alpha" data.
+    NSBitmapImageRep *maskRep = [[[NSBitmapImageRep alloc]
+        initWithBitmapDataPlanes:NULL pixelsWide:bmpWidth
+        pixelsHigh:bmpHeight bitsPerSample:1
+        samplesPerPixel:2 hasAlpha:YES isPlanar:YES
+        colorSpaceName:NSCalibratedWhiteColorSpace
+        bytesPerRow:dstRowLength bitsPerPixel:1] autorelease];
+    wxCHECK(maskRep,false);
+
+    // We need the source NSBitmapImageRep to detemine its pixel format
+    NSBitmapImageRep *srcBitmapRep = const_cast<wxBitmap&>(bitmap).GetNSBitmapImageRep();
+    wxCHECK_MSG(srcBitmapRep,false,wxT("Can't create mask for an uninitialized bitmap"));
+
+    // Get a pointer to the destination data
+    unsigned char *dstPlanes[5] = {NULL,NULL,NULL,NULL,NULL};
+    [maskRep getBitmapDataPlanes:dstPlanes];
+    unsigned char *dstData = dstPlanes[1];
+    // The wxImage format (which we use whenever we imported from wxImage)
+    if([srcBitmapRep bitsPerPixel]==24 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==3 && [srcBitmapRep hasAlpha]==NO)
+    {
+        wxPixelData<wxBitmap,wxNativePixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
+        wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
+            false, wxT("Unable to access raw data"));
+    }
+    // 32-bpp RGBx (x=throw away, no alpha)
+    else if([srcBitmapRep bitsPerPixel]==32 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==3 && [srcBitmapRep hasAlpha]==NO)
+    {
+        typedef wxPixelFormat<unsigned char,32,0,1,2> PixelFormat;
+        wxPixelData<wxBitmap,PixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
+        wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
+            false, wxT("Unable to access raw data"));
+    }
+    // 32-bpp RGBA
+    else if([srcBitmapRep bitsPerPixel]==32 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==4 && [srcBitmapRep hasAlpha]==YES)
+    {
+        wxPixelData<wxBitmap,wxAlphaPixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
+        wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
+            false, wxT("Unable to access raw data"));
+    }
+    else if([srcBitmapRep bitsPerPixel]==8 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==1 && [srcBitmapRep hasAlpha]==NO)
+    // 8-bpp Grayscale, no alpha
+    {   // Force all RGB to access the same grayscale component
+        typedef wxPixelFormat<unsigned char,8,0,0,0> PixelFormat;
+        wxPixelData<wxBitmap,PixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
+        wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
+            false, wxT("Unable to access raw data"));
+    }
+    else
+    {   wxCHECK_MSG(false,false,wxT("Unimplemented pixel format")); }
 
+    // maskRep was autoreleased in case we had to exit quickly
+    m_cocoaNSBitmapImageRep = [maskRep retain];
+    return true;
+}