1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/cocoa/bitmap.cpp
4 // Author: David Elliott
8 // Copyright: (c) 2003 David Elliott
9 // Licence: wxWindows 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& icno)
363 wxBitmap wxBitmap::GetSubBitmap(wxRect const&) const
368 wxImage wxBitmap::ConvertToImage() const
371 return /*wxImage(5,5)*/wxNullImage;
372 return wxImage(M_BITMAPDATA->m_width,M_BITMAPDATA->m_height);
375 bool wxBitmap::CreateFromXpm(const char **xpm)
377 #if wxUSE_IMAGE && wxUSE_XPM
380 wxCHECK_MSG( xpm, false, wxT("invalid XPM data") )
382 wxXPMDecoder decoder;
383 wxImage img = decoder.ReadData(xpm);
384 wxCHECK_MSG( img.Ok(), false, wxT("invalid XPM data") )
386 *this = wxBitmap(img);
393 bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
397 wxCHECK_MSG(image.Ok(), false, wxT("invalid image"));
398 wxCHECK_MSG(depth == -1 || depth == 1, false, wxT("invalid bitmap depth"));
400 m_refData = new wxBitmapRefData();
402 M_BITMAPDATA->m_width = image.GetWidth();
403 M_BITMAPDATA->m_height = image.GetHeight();
404 NSBitmapImageRep *bitmapImage = [[NSBitmapImageRep alloc]
405 initWithBitmapDataPlanes: NULL
406 pixelsWide: image.GetWidth()
407 pixelsHigh: image.GetHeight()
412 colorSpaceName: NSCalibratedRGBColorSpace
416 const int numBytes = image.GetWidth()*image.GetHeight()*3;
417 memcpy([bitmapImage bitmapData], image.GetData(), numBytes);
418 // TODO: Alpha and convert to desired depth
419 M_BITMAPDATA->m_depth = 24;
420 M_BITMAPDATA->m_ok = true;
421 M_BITMAPDATA->m_numColors = 0;
422 M_BITMAPDATA->m_quality = 0;
423 M_BITMAPDATA->m_cocoaNSBitmapImageRep = bitmapImage;
424 M_BITMAPDATA->m_bitmapMask = new wxMask(*this,wxColour(image.GetMaskRed(),image.GetMaskGreen(),image.GetMaskBlue()));
428 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
433 NSBitmapImageRep *bitmapRep = M_BITMAPDATA->m_cocoaNSBitmapImageRep;
437 if([bitmapRep bitsPerPixel]!=bpp)
439 wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
442 data.m_width = [bitmapRep pixelsWide];
443 data.m_height = [bitmapRep pixelsHigh];
444 data.m_stride = [bitmapRep bytesPerRow];
445 return [bitmapRep bitmapData];
447 // NOTE: It is up to the user to make sure they used the proper
448 // pixel format class that details what is actually inside the pixels
449 // We can only check to make sure that the total number of bits per
450 // pixel are being iterated over properly
451 // NSBitmapImageRep can contain grayscale or CMYK data and
452 // wxPixelDataBase doesn't really define the color format
455 void wxBitmap::UngetRawData(wxPixelDataBase& data)
459 // ========================================================================
461 // ========================================================================
463 IMPLEMENT_DYNAMIC_CLASS(wxMask, wxObject)
467 m_cocoaNSBitmapImageRep = nil;
470 // Construct a mask from a bitmap and a colour indicating
471 // the transparent area
472 wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
474 m_cocoaNSBitmapImageRep = nil;
475 Create(bitmap, colour);
478 // Construct a mask from a bitmap and a palette index indicating
479 // the transparent area
480 wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
482 m_cocoaNSBitmapImageRep = nil;
484 Create(bitmap, paletteIndex);
487 // Construct a mask from a mono bitmap (copies the bitmap).
488 wxMask::wxMask(const wxBitmap& bitmap)
490 m_cocoaNSBitmapImageRep = nil;
497 [m_cocoaNSBitmapImageRep release];
500 // Create a mask from a mono bitmap (copies the bitmap).
501 bool wxMask::Create(const wxBitmap& bitmap)
507 // Create a mask from a bitmap and a palette index indicating
508 // the transparent area
509 bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
515 template <typename PixelData>
516 static bool wxMask_CreateFromBitmapData(PixelData srcData, const wxColour& colour, unsigned char *dstData)
518 wxCHECK_MSG(dstData,false,wxT("Couldn't access mask data"));
519 typename PixelData::Iterator p(srcData);
520 const int nRows = srcData.GetHeight();
521 const int nCols = srcData.GetWidth();
522 // Total number of bytes per destination column
523 const int dstRowLength = (nCols+7)/8;
524 // Number of source columns that fit into a byte in the destination
525 const int width_aligned = nCols/8*8;
526 for(int y=0; y<nRows; ++y)
528 typename PixelData::Iterator rowStart(p);
529 unsigned char *dstRow = dstData + y*dstRowLength;
530 for(int x=0; x<width_aligned; x+=8)
532 unsigned char *dstByte = dstRow + x/8;
534 // Take source RGB, compare it with the wxColour
535 for(int j=0; j<8; ++j, ++p)
538 ( p.Red()!=colour.Red()
539 || p.Green()!=colour.Green()
540 || p.Blue()!=colour.Blue()
544 // Handle the remaining 0-7 pixels in the row
545 unsigned char *dstByte = dstRow + width_aligned/8;
548 for(int j=0; j<(nCols%8); ++j, ++p)
551 ( p.Red()!=colour.Red()
552 || p.Green()!=colour.Green()
553 || p.Blue()!=colour.Blue()
557 p.OffsetY(srcData,1);
562 // Create a mask from a bitmap and a colour indicating
563 // the transparent area
564 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
566 wxAutoNSAutoreleasePool pool;
569 int bmpWidth = bitmap.GetWidth();
570 int bmpHeight = bitmap.GetHeight();
571 int dstRowLength = (bmpWidth+7)/8;
573 // Create a bitmap image rep with 1-bit per pixel data representing
574 // the alpha channel padded such that rows end on byte boundaries
575 // Since NSBitmapImageRep doesn't have any sort of NSNullColorSpace
576 // we must have at least one channel of non-alpha data. In order to
577 // make our life easy, we use planar data which results in two
578 // separate arrays. We don't need to touch the first because it
579 // should never be used. The second is the 1-bit "alpha" data.
580 NSBitmapImageRep *maskRep = [[[NSBitmapImageRep alloc]
581 initWithBitmapDataPlanes:NULL pixelsWide:bmpWidth
582 pixelsHigh:bmpHeight bitsPerSample:1
583 samplesPerPixel:2 hasAlpha:YES isPlanar:YES
584 colorSpaceName:NSCalibratedWhiteColorSpace
585 bytesPerRow:dstRowLength bitsPerPixel:1] autorelease];
586 wxCHECK(maskRep,false);
588 // We need the source NSBitmapImageRep to detemine its pixel format
589 NSBitmapImageRep *srcBitmapRep = const_cast<wxBitmap&>(bitmap).GetNSBitmapImageRep();
590 wxCHECK_MSG(srcBitmapRep,false,wxT("Can't create mask for an uninitialized bitmap"));
592 // Get a pointer to the destination data
593 unsigned char *dstPlanes[5] = {NULL,NULL,NULL,NULL,NULL};
594 [maskRep getBitmapDataPlanes:dstPlanes];
595 unsigned char *dstData = dstPlanes[1];
596 // The wxImage format (which we use whenever we imported from wxImage)
597 if([srcBitmapRep bitsPerPixel]==24 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==3 && [srcBitmapRep hasAlpha]==NO)
599 wxPixelData<wxBitmap,wxNativePixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
600 wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
601 false, wxT("Unable to access raw data"));
603 // 32-bpp RGBx (x=throw away, no alpha)
604 else if([srcBitmapRep bitsPerPixel]==32 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==3 && [srcBitmapRep hasAlpha]==NO)
606 typedef wxPixelFormat<unsigned char,32,0,1,2> PixelFormat;
607 wxPixelData<wxBitmap,PixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
608 wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
609 false, wxT("Unable to access raw data"));
612 else if([srcBitmapRep bitsPerPixel]==32 && [srcBitmapRep bitsPerSample]==8 && [srcBitmapRep samplesPerPixel]==4 && [srcBitmapRep hasAlpha]==YES)
614 wxPixelData<wxBitmap,wxAlphaPixelFormat> pixelData(const_cast<wxBitmap&>(bitmap));
615 wxCHECK_MSG(wxMask_CreateFromBitmapData(pixelData, colour, dstData),
616 false, wxT("Unable to access raw data"));
619 { wxCHECK_MSG(false,false,wxT("Unimplemented pixel format")); }
621 // maskRep was autoreleased in case we had to exit quickly
622 m_cocoaNSBitmapImageRep = [maskRep retain];