1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/cocoa/bitmap.cpp
4 // Author: David Elliott
8 // Copyright: (c) 2003 David Elliott
9 // Licence: wxWidgets licence
10 /////////////////////////////////////////////////////////////////////////////
12 #include "wx/wxprec.h"
16 #include "wx/palette.h"
18 #include "wx/colour.h"
20 #include "wx/bitmap.h"
22 #include "wx/xpmdecod.h"
23 #include "wx/rawbmp.h"
25 #include "wx/cocoa/autorelease.h"
26 #include "wx/cocoa/string.h"
28 #import <AppKit/NSBitmapImageRep.h>
29 #import <AppKit/NSGraphics.h>
30 #import <AppKit/NSImage.h>
32 // ========================================================================
34 // ========================================================================
35 class wxBitmapRefData: public wxGDIRefData
37 friend class wxBitmap;
40 wxBitmapRefData( const wxBitmapRefData& data );
41 virtual ~wxBitmapRefData();
49 wxPalette m_bitmapPalette;
51 WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
52 wxMask *m_bitmapMask; // Optional mask
55 #define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
57 wxBitmapRefData::wxBitmapRefData()
65 m_cocoaNSBitmapImageRep = nil;
69 wxBitmapRefData::wxBitmapRefData( const wxBitmapRefData& data)
71 m_width = data.m_width;
72 m_height = data.m_height;
73 m_depth = data.m_depth;
75 m_numColors = data.m_numColors;
76 m_bitmapPalette = data.m_bitmapPalette;
77 m_quality = data.m_quality;
78 m_cocoaNSBitmapImageRep = [data.m_cocoaNSBitmapImageRep copyWithZone:nil];
79 m_bitmapMask = data.m_bitmapMask?new wxMask(*data.m_bitmapMask):NULL;
82 wxBitmapRefData::~wxBitmapRefData()
84 [m_cocoaNSBitmapImageRep release];
85 m_cocoaNSBitmapImageRep = NULL;
91 // ========================================================================
93 // ========================================================================
94 IMPLEMENT_DYNAMIC_CLASS(wxBitmap, wxGDIObject)
101 wxBitmap::~wxBitmap()
105 wxBitmap::wxBitmap(const char bits[], int the_width, int the_height, int no_bits)
107 m_refData = new wxBitmapRefData;
109 M_BITMAPDATA->m_width = the_width ;
110 M_BITMAPDATA->m_height = the_height ;
111 M_BITMAPDATA->m_depth = no_bits ;
112 M_BITMAPDATA->m_numColors = 0;
114 /* TODO: create the bitmap from data */
117 wxBitmap::wxBitmap(int w, int h, int d)
119 (void)Create(w, h, d);
122 wxBitmap::wxBitmap(void *data, wxBitmapType type, int width, int height, int depth)
124 (void) Create(data, type, width, height, depth);
127 wxBitmap::wxBitmap(const wxString& filename, wxBitmapType type)
129 LoadFile(filename, type);
132 wxObjectRefData *wxBitmap::CreateRefData() const
134 return new wxBitmapRefData;
137 wxObjectRefData *wxBitmap::CloneRefData(const wxObjectRefData *data) const
139 return new wxBitmapRefData(*(wxBitmapRefData*)data);
142 WX_NSBitmapImageRep wxBitmap::GetNSBitmapImageRep()
146 return M_BITMAPDATA->m_cocoaNSBitmapImageRep;
149 WX_NSImage wxBitmap::GetNSImage(bool useMask) const
153 NSImage *nsimage = [[[NSImage alloc]
154 initWithSize:NSMakeSize(GetWidth(), GetHeight())] autorelease];
157 [nsimage addRepresentation: M_BITMAPDATA->m_cocoaNSBitmapImageRep];
158 if(useMask && GetMask())
160 // Show before/after to prove that the bitmap itself is not changed
161 // even though we just composited onto the NSImage
162 wxLogTrace(wxTRACE_COCOA,wxT("Before: bpp=%d"),[M_BITMAPDATA->m_cocoaNSBitmapImageRep bitsPerPixel]);
163 NSImage *maskImage = [[NSImage alloc]
164 initWithSize:NSMakeSize(GetWidth(), GetHeight())];
165 [maskImage addRepresentation: GetMask()->GetNSBitmapImageRep()];
167 [maskImage compositeToPoint:NSZeroPoint operation:NSCompositeDestinationIn];
168 [nsimage unlockFocus];
170 wxLogTrace(wxTRACE_COCOA,wxT("After: bpp=%d"),[M_BITMAPDATA->m_cocoaNSBitmapImageRep bitsPerPixel]);
175 void wxBitmap::SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep)
179 // NOTE: No checking is done to make sure width/height agree
180 [bitmapImageRep retain];
181 [M_BITMAPDATA->m_cocoaNSBitmapImageRep release];
182 M_BITMAPDATA->m_cocoaNSBitmapImageRep = bitmapImageRep;
185 void wxBitmap::SetWidth(int w)
188 m_refData = new wxBitmapRefData;
190 M_BITMAPDATA->m_width = w;
193 void wxBitmap::SetHeight(int h)
196 m_refData = new wxBitmapRefData;
198 M_BITMAPDATA->m_height = h;
201 void wxBitmap::SetDepth(int d)
204 m_refData = new wxBitmapRefData;
206 M_BITMAPDATA->m_depth = d;
209 void wxBitmap::SetQuality(int q)
212 m_refData = new wxBitmapRefData;
214 M_BITMAPDATA->m_quality = q;
217 void wxBitmap::SetOk(bool isOk)
220 m_refData = new wxBitmapRefData;
222 M_BITMAPDATA->m_ok = isOk;
225 void wxBitmap::SetPalette(const wxPalette& palette)
228 m_refData = new wxBitmapRefData;
230 M_BITMAPDATA->m_bitmapPalette = palette ;
233 void wxBitmap::SetMask(wxMask *mask)
236 m_refData = new wxBitmapRefData;
238 M_BITMAPDATA->m_bitmapMask = mask ;
241 bool wxBitmap::Ok() const
243 return m_refData && M_BITMAPDATA->m_ok;
246 wxPalette* wxBitmap::GetPalette() const
250 return &M_BITMAPDATA->m_bitmapPalette;
253 wxMask* wxBitmap::GetMask() const
257 return M_BITMAPDATA->m_bitmapMask;
260 int wxBitmap::GetDepth() const
264 return M_BITMAPDATA->m_depth;
267 int wxBitmap::GetWidth() const
271 return M_BITMAPDATA->m_width;
274 int wxBitmap::GetHeight() const
278 return M_BITMAPDATA->m_height;
281 bool wxBitmap::Create(int w, int h, int d)
285 m_refData = new wxBitmapRefData;
287 M_BITMAPDATA->m_width = w;
288 M_BITMAPDATA->m_height = h;
289 M_BITMAPDATA->m_depth = d;
291 /* TODO: create new bitmap */
292 M_BITMAPDATA->m_cocoaNSBitmapImageRep = [[NSBitmapImageRep alloc]
293 initWithBitmapDataPlanes: NULL
300 colorSpaceName: NSCalibratedRGBColorSpace
304 wxLogTrace(wxTRACE_COCOA,wxT("M_BITMAPDATA=%p NSBitmapImageRep bitmapData=%p"), M_BITMAPDATA, [M_BITMAPDATA->m_cocoaNSBitmapImageRep bitmapData]);
305 M_BITMAPDATA->m_ok = true;
306 M_BITMAPDATA->m_numColors = 0;
307 M_BITMAPDATA->m_quality = 0;
308 M_BITMAPDATA->m_bitmapMask = NULL;
310 return M_BITMAPDATA->m_ok;
313 bool wxBitmap::LoadFile(const wxString& filename, wxBitmapType type)
315 wxAutoNSAutoreleasePool pool;
318 m_refData = new wxBitmapRefData;
320 NSBitmapImageRep *imageRep = [NSBitmapImageRep
321 imageRepWithContentsOfFile:wxNSStringWithWxString(filename)];
325 M_BITMAPDATA->m_width = [imageRep pixelsWide];
326 M_BITMAPDATA->m_height = [imageRep pixelsHigh];
327 M_BITMAPDATA->m_depth = 24; // FIXME
328 M_BITMAPDATA->m_ok = true;
329 M_BITMAPDATA->m_numColors = 0;
330 M_BITMAPDATA->m_quality = 0;
331 M_BITMAPDATA->m_cocoaNSBitmapImageRep = [imageRep retain];
332 M_BITMAPDATA->m_bitmapMask = NULL;
336 if(!image.LoadFile(filename,type))
340 *this = wxBitmap(image);
344 bool wxBitmap::Create(void *data, wxBitmapType type, int width, int height, int depth)
348 m_refData = new wxBitmapRefData;
353 bool wxBitmap::SaveFile(const wxString& filename, wxBitmapType type, const wxPalette *palette) const
358 bool wxBitmap::CopyFromIcon(const wxIcon& icon)
361 if(!icon.GetNSImage());
362 [icon.GetNSImage() lockFocus];
364 imageRect.origin.x = imageRect.origin.y = 0.0;
365 imageRect.size = [icon.GetNSImage() size];
366 NSBitmapImageRep *newBitmapRep = [[NSBitmapImageRep alloc] initWithFocusedViewRect:imageRect];
367 [icon.GetNSImage() unlockFocus];
370 m_refData = new wxBitmapRefData;
371 M_BITMAPDATA->m_cocoaNSBitmapImageRep = newBitmapRep;
372 M_BITMAPDATA->m_width = [newBitmapRep pixelsWide];
373 M_BITMAPDATA->m_height = [newBitmapRep pixelsHigh];
374 M_BITMAPDATA->m_depth = [newBitmapRep bitsPerSample]*[newBitmapRep samplesPerPixel];
375 M_BITMAPDATA->m_ok = true;
376 M_BITMAPDATA->m_numColors = 0;
377 M_BITMAPDATA->m_quality = 0;
378 M_BITMAPDATA->m_bitmapMask = NULL;
382 wxBitmap wxBitmap::GetSubBitmap(wxRect const&) const
387 wxImage wxBitmap::ConvertToImage() const
390 return /*wxImage(5,5)*/wxNullImage;
391 return wxImage(M_BITMAPDATA->m_width,M_BITMAPDATA->m_height);
394 bool wxBitmap::CreateFromXpm(const char **xpm)
396 #if wxUSE_IMAGE && wxUSE_XPM
399 wxCHECK_MSG( xpm, false, wxT("invalid XPM data") )
401 wxXPMDecoder decoder;
402 wxImage img = decoder.ReadData(xpm);
403 wxCHECK_MSG( img.Ok(), false, wxT("invalid XPM data") )
405 *this = wxBitmap(img);
412 bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
416 wxCHECK_MSG(image.Ok(), false, wxT("invalid image"));
417 wxCHECK_MSG(depth == -1 || depth == 1, false, wxT("invalid bitmap depth"));
419 m_refData = new wxBitmapRefData();
421 M_BITMAPDATA->m_width = image.GetWidth();
422 M_BITMAPDATA->m_height = image.GetHeight();
423 NSBitmapImageRep *bitmapImage = [[NSBitmapImageRep alloc]
424 initWithBitmapDataPlanes: NULL
425 pixelsWide: image.GetWidth()
426 pixelsHigh: image.GetHeight()
431 colorSpaceName: NSCalibratedRGBColorSpace
435 const int numBytes = image.GetWidth()*image.GetHeight()*3;
436 memcpy([bitmapImage bitmapData], image.GetData(), numBytes);
437 // TODO: Alpha and convert to desired depth
438 M_BITMAPDATA->m_depth = 24;
439 M_BITMAPDATA->m_ok = true;
440 M_BITMAPDATA->m_numColors = 0;
441 M_BITMAPDATA->m_quality = 0;
442 M_BITMAPDATA->m_cocoaNSBitmapImageRep = bitmapImage;
443 M_BITMAPDATA->m_bitmapMask = new wxMask(*this,wxColour(image.GetMaskRed(),image.GetMaskGreen(),image.GetMaskBlue()));
447 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
452 NSBitmapImageRep *bitmapRep = M_BITMAPDATA->m_cocoaNSBitmapImageRep;
456 if([bitmapRep bitsPerPixel]!=bpp)
458 wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
461 data.m_width = [bitmapRep pixelsWide];
462 data.m_height = [bitmapRep pixelsHigh];
463 data.m_stride = [bitmapRep bytesPerRow];
464 return [bitmapRep bitmapData];
466 // NOTE: It is up to the user to make sure they used the proper
467 // pixel format class that details what is actually inside the pixels
468 // We can only check to make sure that the total number of bits per
469 // pixel are being iterated over properly
470 // NSBitmapImageRep can contain grayscale or CMYK data and
471 // wxPixelDataBase doesn't really define the color format
474 void wxBitmap::UngetRawData(wxPixelDataBase& data)
478 void wxBitmap::UseAlpha()
482 // ========================================================================
484 // ========================================================================
486 IMPLEMENT_DYNAMIC_CLASS(wxMask, wxObject)
490 m_cocoaNSBitmapImageRep = nil;
493 // Construct a mask from a bitmap and a colour indicating
494 // the transparent area
495 wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
497 m_cocoaNSBitmapImageRep = nil;
498 Create(bitmap, colour);
501 // Construct a mask from a bitmap and a palette index indicating
502 // the transparent area
503 wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
505 m_cocoaNSBitmapImageRep = nil;
507 Create(bitmap, paletteIndex);
510 // Construct a mask from a mono bitmap (copies the bitmap).
511 wxMask::wxMask(const wxBitmap& bitmap)
513 m_cocoaNSBitmapImageRep = nil;
520 [m_cocoaNSBitmapImageRep release];
523 // Create a mask from a mono bitmap (copies the bitmap).
524 bool wxMask::Create(const wxBitmap& bitmap)
530 // Create a mask from a bitmap and a palette index indicating
531 // the transparent area
532 bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
538 template <typename PixelData>
539 static bool wxMask_CreateFromBitmapData(PixelData srcData, const wxColour& colour, unsigned char *dstData)
541 wxCHECK_MSG(dstData,false,wxT("Couldn't access mask data"));
542 typename PixelData::Iterator p(srcData);
543 const int nRows = srcData.GetHeight();
544 const int nCols = srcData.GetWidth();
545 // Total number of bytes per destination column
546 const int dstRowLength = (nCols+7)/8;
547 // Number of source columns that fit into a byte in the destination
548 const int width_aligned = nCols/8*8;
549 for(int y=0; y<nRows; ++y)
551 typename PixelData::Iterator rowStart(p);
552 unsigned char *dstRow = dstData + y*dstRowLength;
553 for(int x=0; x<width_aligned; x+=8)
555 unsigned char *dstByte = dstRow + x/8;
557 // Take source RGB, compare it with the wxColour
558 for(int j=0; j<8; ++j, ++p)
561 ( p.Red()!=colour.Red()
562 || p.Green()!=colour.Green()
563 || p.Blue()!=colour.Blue()
567 // Handle the remaining 0-7 pixels in the row
568 unsigned char *dstByte = dstRow + width_aligned/8;
571 for(int j=0; j<(nCols%8); ++j, ++p)
574 ( p.Red()!=colour.Red()
575 || p.Green()!=colour.Green()
576 || p.Blue()!=colour.Blue()
580 p.OffsetY(srcData,1);
585 // Create a mask from a bitmap and a colour indicating
586 // the transparent area
587 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
589 wxAutoNSAutoreleasePool pool;
592 int bmpWidth = bitmap.GetWidth();
593 int bmpHeight = bitmap.GetHeight();
594 int dstRowLength = (bmpWidth+7)/8;
596 // Create a bitmap image rep with 1-bit per pixel data representing
597 // the alpha channel padded such that rows end on byte boundaries
598 // Since NSBitmapImageRep doesn't have any sort of NSNullColorSpace
599 // we must have at least one channel of non-alpha data. In order to
600 // make our life easy, we use planar data which results in two
601 // separate arrays. We don't need to touch the first because it
602 // should never be used. The second is the 1-bit "alpha" data.
603 NSBitmapImageRep *maskRep = [[[NSBitmapImageRep alloc]
604 initWithBitmapDataPlanes:NULL pixelsWide:bmpWidth
605 pixelsHigh:bmpHeight bitsPerSample:1
606 samplesPerPixel:2 hasAlpha:YES isPlanar:YES
607 colorSpaceName:NSCalibratedWhiteColorSpace
608 bytesPerRow:dstRowLength bitsPerPixel:1] autorelease];
609 wxCHECK(maskRep,false);
611 // We need the source NSBitmapImageRep to detemine its pixel format
612 NSBitmapImageRep *srcBitmapRep = const_cast<wxBitmap&>(bitmap).GetNSBitmapImageRep();
613 wxCHECK_MSG(srcBitmapRep,false,wxT("Can't create mask for an uninitialized bitmap"));
615 // Get a pointer to the destination data
616 unsigned char *dstPlanes[5] = {NULL,NULL,NULL,NULL,NULL};
617 [maskRep getBitmapDataPlanes:dstPlanes];
618 unsigned char *dstData = dstPlanes[1];
619 // The wxImage format (which we use whenever we imported from wxImage)
620 if([srcBitmapRep bitsPerPixel]==24 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==3 && [srcBitmapRep hasAlpha]==NO)
622 wxPixelData<wxBitmap,wxNativePixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
623 wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
624 false, wxT("Unable to access raw data"));
626 // 32-bpp RGBx (x=throw away, no alpha)
627 else if([srcBitmapRep bitsPerPixel]==32 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==3 && [srcBitmapRep hasAlpha]==NO)
629 typedef wxPixelFormat<unsigned char,32,0,1,2> PixelFormat;
630 wxPixelData<wxBitmap,PixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
631 wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
632 false, wxT("Unable to access raw data"));
635 else if([srcBitmapRep bitsPerPixel]==32 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==4 && [srcBitmapRep hasAlpha]==YES)
637 wxPixelData<wxBitmap,wxAlphaPixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
638 wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
639 false, wxT("Unable to access raw data"));
642 { wxCHECK_MSG(false,false,wxT("Unimplemented pixel format")); }
644 // maskRep was autoreleased in case we had to exit quickly
645 m_cocoaNSBitmapImageRep = [maskRep retain];