1 /* xscreensaver, Copyright (c) 1992-2012 Jamie Zawinski <jwz@jwz.org>
3 * Permission to use, copy, modify, distribute, and sell this software and its
4 * documentation for any purpose is hereby granted without fee, provided that
5 * the above copyright notice appear in all copies and that both that
6 * copyright notice and this permission notice appear in supporting
7 * documentation. No representations are made about the suitability of this
8 * software for any purpose. It is provided "as is" without express or
12 /* This is the OSX implementation of desktop-grabbing and image-loading.
13 This code is invoked by "utils/grabclient.c", which is linked directly
14 in to each screen saver bundle.
16 X11-based builds of the savers do not use this code (even on MacOS).
17 This is used only by the Cocoa build of the savers.
23 # import <Cocoa/Cocoa.h>
25 # import "SaverRunner.h"
27 #import "jwxyz-cocoa.h"
28 #import "grabscreen.h"
35 # define NSImage UIImage
39 #ifndef MAC_OS_X_VERSION_10_6
40 # define MAC_OS_X_VERSION_10_6 1060 /* undefined in 10.4 SDK, grr */
43 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
47 This version of the code works on 10.4, but is flaky. There is
48 a better way to do it on 10.5 and newer, but taking this path,
49 then we are being compiled against the 10.4 SDK instead of the
50 10.5 SDK, and the newer API is not available to us.
54 copy_framebuffer_to_ximage (CGDirectDisplayID cgdpy, XImage *xim,
55 int window_x, int window_y)
57 unsigned char *data = (unsigned char *)
58 CGDisplayAddressForPosition (cgdpy, window_x, window_y);
59 int bpp = CGDisplayBitsPerPixel (cgdpy);
60 int spp = CGDisplaySamplesPerPixel (cgdpy);
61 int bps = CGDisplayBitsPerSample (cgdpy);
62 int bpr = CGDisplayBytesPerRow (cgdpy);
65 int ximw = xim->width;
66 int ximh = xim->height;
68 uint32_t *odata = (uint32_t *) xim->data;
72 if (spp != 3) abort();
73 if (bps != 8) abort();
74 int xwpl = xim->bytes_per_line/4;
75 for (y = 0; y < ximh; y++) {
76 // We can do this because the frame buffer and XImage are both ARGB 32.
77 // Both PPC and Intel use ARGB, viewed in word order (not byte-order).
78 memcpy (odata, data, ximw * 4);
85 if (spp != 3) abort();
86 if (bps != 5) abort();
87 for (y = 0; y < ximh; y++) {
88 uint16_t *ip = (uint16_t *) data;
90 for (x = 0; x < ximw; x++) {
92 // This should be ok on both PPC and Intel (ARGB, word order)
93 unsigned char r = (p >> 10) & 0x1F;
94 unsigned char g = (p >> 5) & 0x1F;
95 unsigned char b = (p ) & 0x1F;
96 r = (r << 3) | (r >> 2);
97 g = (g << 3) | (g >> 2);
98 b = (b << 3) | (b >> 2);
99 uint32_t pixel = 0xFF000000 | (r << 16) | (g << 8) | b;
100 // XPutPixel (xim, x, y, pixel);
109 /* Get the current palette of the display. */
110 CGDirectPaletteRef pal = CGPaletteCreateWithDisplay (cgdpy);
112 /* Map it to 32bpp pixels */
114 for (y = 0; y < 256; y++) {
115 CGDeviceColor c = CGPaletteGetColorAtIndex (pal, y);
116 unsigned char r = c.red * 255.0;
117 unsigned char g = c.green * 255.0;
118 unsigned char b = c.blue * 255.0;
119 uint32_t pixel = 0xFF000000 | (r << 16) | (g << 8) | b;
123 for (y = 0; y < ximh; y++) {
124 unsigned char *ip = data;
126 for (x = 0; x < ximw; x++) {
127 *odata++ = map[*ip++];
131 CGPaletteRelease (pal);
142 /* Loads an image into the Drawable, returning once the image is loaded.
145 osx_grab_desktop_image (Screen *screen, Window xwindow, Drawable drawable,
146 XRectangle *geom_ret)
148 Display *dpy = DisplayOfScreen (screen);
149 NSView *nsview = jwxyz_window_view (xwindow);
150 NSWindow *nswindow = [nsview window];
151 XWindowAttributes xgwa;
152 int window_x, window_y;
155 // Figure out where this window is on the screen.
157 XGetWindowAttributes (dpy, xwindow, &xgwa);
158 XTranslateCoordinates (dpy, xwindow, RootWindowOfScreen (screen), 0, 0,
159 &window_x, &window_y, &unused);
161 // Use the size of the Drawable, not the Window.
165 unsigned int w, h, bbw, d;
166 XGetGeometry (dpy, drawable, &r, &x, &y, &w, &h, &bbw, &d);
171 // Create a tmp ximage to hold the screen data.
173 XImage *xim = XCreateImage (dpy, xgwa.visual, 32, ZPixmap, 0, 0,
174 xgwa.width, xgwa.height, 8, 0);
175 xim->data = (char *) malloc (xim->height * xim->bytes_per_line);
178 // Find the address in the frame buffer of the top left of this window.
180 CGDirectDisplayID cgdpy = 0;
183 // #### this isn't quite right for screen 2: it's offset slightly.
187 CGGetDisplaysWithPoint (p, 1, &cgdpy, &n);
191 // Paint a transparent "hole" in this window.
193 BOOL oopaque = [nswindow isOpaque];
194 [nswindow setOpaque:NO];
196 [[NSColor clearColor] set];
197 NSRectFill ([nsview frame]);
198 [[nswindow graphicsContext] flushGraphics];
201 // Without this, we get a dozen black scanlines at the top.
202 // #### But with this, the screen saver loops, because calling this
203 // seems to implicitly mark the display as non-idle!
204 // CGDisplayCaptureWithOptions (cgdpy, kCGCaptureNoFill);
206 // #### So let's try waiting for the vertical blank instead...
207 // Nope, that doesn't work.
209 // CGDisplayWaitForBeamPositionOutsideLines (cgdpy, 0,
210 // window_y + [nswindow frame].size.height);
212 // #### Ok, try a busy-wait?
216 // #### Ok, just fuckin' sleep!
221 // Pull the bits out of the frame buffer.
223 copy_framebuffer_to_ximage (cgdpy, xim, window_x, window_y);
225 // CGDisplayRelease (cgdpy);
227 // Make the window visible again.
229 [nswindow setOpaque:oopaque];
231 // Splat the XImage onto the target drawable (probably the window)
232 // and free the bits.
235 GC gc = XCreateGC (dpy, drawable, 0, &gcv);
236 XPutImage (dpy, drawable, gc, xim, 0, 0, 0, 0, xim->width, xim->height);
242 geom_ret->width = xim->width;
243 geom_ret->height = xim->height;
251 #elif defined(USE_IPHONE)
255 On iOS, our application delegate, SaverRunner, grabs an image
256 of itself as a UIImage before mapping the XScreenSaverView.
257 In this code, we ask SaverRunner for that UIImage, then copy
258 it to the root window.
262 osx_grab_desktop_image (Screen *screen, Window xwindow, Drawable drawable,
263 XRectangle *geom_ret)
266 (SaverRunner *) [[UIApplication sharedApplication] delegate];
269 if (! [s isKindOfClass:[SaverRunner class]])
271 UIImage *img = [s screenshot];
274 jwxyz_draw_NSImage_or_CGImage (DisplayOfScreen (screen), drawable,
275 True, img, geom_ret, 0);
280 #else /* MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
284 This version of the code is simpler and more reliable, but
285 uses an API that only exist on 10.5 and newer, so we can only
286 use it if when being compiled against the 10.5 SDK or later.
289 /* Loads an image into the Drawable, returning once the image is loaded.
292 osx_grab_desktop_image (Screen *screen, Window xwindow, Drawable drawable,
293 XRectangle *geom_ret)
295 Display *dpy = DisplayOfScreen (screen);
296 NSView *nsview = jwxyz_window_view (xwindow);
297 XWindowAttributes xgwa;
298 int window_x, window_y;
301 // Figure out where this window is on the screen.
303 XGetWindowAttributes (dpy, xwindow, &xgwa);
304 XTranslateCoordinates (dpy, xwindow, RootWindowOfScreen (screen), 0, 0,
305 &window_x, &window_y, &unused);
307 // Grab only the rectangle of the screen underlying this window.
310 cgrect.origin.x = window_x;
311 cgrect.origin.y = window_y;
312 cgrect.size.width = xgwa.width;
313 cgrect.size.height = xgwa.height;
315 /* If a password is required to unlock the screen, a large black
316 window will be on top of all of the desktop windows by the time
317 we reach here, making the screen-grab rather uninteresting. If
318 we move ourselves temporarily below the login-window windows
319 before capturing the image, we capture the real desktop as
323 // save our current level so we can restore it later
324 int oldLevel = [[nsview window] level];
326 [[nsview window] setLevel:CGWindowLevelForKey(kCGPopUpMenuWindowLevelKey)];
328 // Grab a screen shot of those windows below this one
329 // (hey, X11 can't do that!)
332 CGWindowListCreateImage (cgrect,
333 kCGWindowListOptionOnScreenBelowWindow,
334 [[nsview window] windowNumber],
335 kCGWindowImageDefault);
337 // put us back above the login windows so the screensaver is visible.
338 [[nsview window] setLevel:oldLevel];
340 if (! img) return False;
342 // Render the grabbed CGImage into the Drawable.
343 jwxyz_draw_NSImage_or_CGImage (DisplayOfScreen (screen), drawable,
344 False, img, geom_ret, 0);
345 CGImageRelease (img);
349 #endif /* 10.5+ code */
354 /* Returns the EXIF rotation property of the image, if any.
357 exif_rotation (const char *filename)
359 /* As of 10.6, NSImage rotates according to EXIF by default:
360 http://developer.apple.com/mac/library/releasenotes/cocoa/appkit.html
361 So this function should return -1 when *running* on 10.6 systems.
362 But when running against older systems, we need to examine the image
363 to figure out its rotation.
366 # if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6 /* 10.6 SDK */
368 /* When we have compiled against the 10.6 SDK, we know that we are
369 running on a 10.6 or later system.
373 # else /* Compiled against 10.5 SDK or earlier */
375 /* If this selector exists, then we are running against a 10.6 runtime
376 that does automatic EXIF rotation (despite the fact that we were
377 compiled against the 10.5 or earlier SDK). So in that case, this
378 function should no-op.
380 if ([NSImage instancesRespondToSelector:
381 @selector(initWithDataIgnoringOrientation:)])
384 /* Otherwise, go ahead and figure out what the rotational characteristics
385 of this image are. */
389 /* This is a ridiculous amount of rigamarole to go through, but for some
390 reason the "Orientation" tag does not exist in the "NSImageEXIFData"
391 dictionary inside the NSBitmapImageRep of the NSImage. Several other
392 EXIF tags are there (e.g., shutter speed) but not orientation. WTF?
394 CFStringRef s = CFStringCreateWithCString (NULL, filename,
395 kCFStringEncodingUTF8);
396 CFURLRef url = CFURLCreateWithFileSystemPath (NULL, s,
397 kCFURLPOSIXPathStyle, 0);
398 CGImageSourceRef cgimg = CGImageSourceCreateWithURL (url, NULL);
399 if (! cgimg) return -1;
401 NSDictionary *props = (NSDictionary *)
402 CGImageSourceCopyPropertiesAtIndex (cgimg, 0, NULL);
403 int rot = [[props objectForKey:@"Orientation"] intValue];
412 # endif /* USE_IPHONE */
416 /* Loads an image file and splats it onto the drawable.
417 The image is drawn as large as possible while preserving its aspect ratio.
418 If geom_ret is provided, the actual rectangle the rendered image takes
419 up will be returned there.
422 osx_load_image_file (Screen *screen, Window xwindow, Drawable drawable,
423 const char *filename, XRectangle *geom_ret)
427 if (!filename || !*filename) return False;
429 NSImage *img = [[NSImage alloc] initWithContentsOfFile:
430 [NSString stringWithCString:filename
431 encoding:NSUTF8StringEncoding]];
435 jwxyz_draw_NSImage_or_CGImage (DisplayOfScreen (screen), drawable,
437 exif_rotation (filename));
441 # else /* USE_IPHONE */
443 /* This is handled differently: see grabclient.c and iosgrabimage.m. */
446 # endif /* USE_IPHONE */