4 Mac OS X OpenGL and input module, using Carbon and AGL
6 Copyright (C) 2005-2006 Mathieu Olivier
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <Carbon/Carbon.h>
31 // Tell startup code that we have a client
32 int cl_available = true;
34 qboolean vid_supportrefreshrate = true;
37 AGLPixelFormat (*qaglChoosePixelFormat) (const AGLDevice *gdevs, GLint ndev, const GLint *attribList);
38 AGLContext (*qaglCreateContext) (AGLPixelFormat pix, AGLContext share);
39 GLboolean (*qaglDestroyContext) (AGLContext ctx);
40 void (*qaglDestroyPixelFormat) (AGLPixelFormat pix);
41 const GLubyte* (*qaglErrorString) (GLenum code);
42 GLenum (*qaglGetError) (void);
43 GLboolean (*qaglSetCurrentContext) (AGLContext ctx);
44 GLboolean (*qaglSetDrawable) (AGLContext ctx, AGLDrawable draw);
45 GLboolean (*qaglSetFullScreen) (AGLContext ctx, GLsizei width, GLsizei height, GLsizei freq, GLint device);
46 GLboolean (*qaglSetInteger) (AGLContext ctx, GLenum pname, const GLint *params);
47 void (*qaglSwapBuffers) (AGLContext ctx);
49 static qboolean mouse_avail = true;
50 static qboolean vid_usingmouse = false;
51 static float mouse_x, mouse_y;
53 static qboolean vid_isfullscreen = false;
54 static qboolean vid_usingvsync = false;
56 static int scr_width, scr_height;
58 static AGLContext context;
59 static WindowRef window;
62 void VID_GetWindowSize (int *x, int *y, int *width, int *height)
69 static void IN_Activate( qboolean grab )
73 if (!vid_usingmouse && mouse_avail && window)
79 CGDisplayHideCursor(CGMainDisplayID());
81 // Put the mouse cursor at the center of the window
82 GetWindowBounds (window, kWindowContentRgn, &winBounds);
83 winCenter.x = (winBounds.left + winBounds.right) / 2;
84 winCenter.y = (winBounds.top + winBounds.bottom) / 2;
85 CGWarpMouseCursorPosition(winCenter);
87 // Lock the mouse pointer at its current position
88 CGAssociateMouseAndMouseCursorPosition(false);
90 mouse_x = mouse_y = 0;
91 vid_usingmouse = true;
98 CGAssociateMouseAndMouseCursorPosition(true);
99 CGDisplayShowCursor(CGMainDisplayID());
101 vid_usingmouse = false;
106 #define GAMMA_TABLE_SIZE 256
107 void VID_Finish (qboolean allowmousegrab)
109 qboolean vid_usemouse;
110 qboolean vid_usevsync;
112 // handle the mouse state when windowed if that's changed
113 vid_usemouse = false;
114 if (allowmousegrab && vid_mouse.integer && !key_consoleactive && (key_dest != key_game || !cls.demoplayback))
116 if (!vid_activewindow)
117 vid_usemouse = false;
118 if (vid_isfullscreen)
120 IN_Activate(vid_usemouse);
122 // handle changes of the vsync option
123 vid_usevsync = (vid_vsync.integer && !cls.timedemo);
124 if (vid_usingvsync != vid_usevsync)
126 GLint sync = (vid_usevsync ? 1 : 0);
128 if (qaglSetInteger(context, AGL_SWAP_INTERVAL, &sync) == GL_TRUE)
130 vid_usingvsync = vid_usevsync;
131 Con_DPrintf("Vsync %s\n", vid_usevsync ? "activated" : "deactivated");
134 Con_Printf("ERROR: can't %s vsync\n", vid_usevsync ? "activate" : "deactivate");
137 if (r_render.integer)
139 if (r_speeds.integer || gl_finish.integer)
141 qaglSwapBuffers(context);
143 VID_UpdateGamma(false, GAMMA_TABLE_SIZE);
146 int VID_SetGamma(unsigned short *ramps, int rampsize)
148 CGGammaValue table_red [GAMMA_TABLE_SIZE];
149 CGGammaValue table_green [GAMMA_TABLE_SIZE];
150 CGGammaValue table_blue [GAMMA_TABLE_SIZE];
153 // Convert the unsigned short table into 3 float tables
154 for (i = 0; i < rampsize; i++)
155 table_red[i] = (float)ramps[i] / 65535.0f;
156 for (i = 0; i < rampsize; i++)
157 table_green[i] = (float)ramps[i + rampsize] / 65535.0f;
158 for (i = 0; i < rampsize; i++)
159 table_blue[i] = (float)ramps[i + 2 * rampsize] / 65535.0f;
161 if (CGSetDisplayTransferByTable(CGMainDisplayID(), rampsize, table_red, table_green, table_blue) != CGDisplayNoErr)
163 Con_Print("VID_SetGamma: ERROR: CGSetDisplayTransferByTable failed!\n");
170 int VID_GetGamma(unsigned short *ramps, int rampsize)
172 CGGammaValue table_red [GAMMA_TABLE_SIZE];
173 CGGammaValue table_green [GAMMA_TABLE_SIZE];
174 CGGammaValue table_blue [GAMMA_TABLE_SIZE];
175 CGTableCount actualsize = 0;
178 // Get the gamma ramps from the system
179 if (CGGetDisplayTransferByTable(CGMainDisplayID(), rampsize, table_red, table_green, table_blue, &actualsize) != CGDisplayNoErr)
181 Con_Print("VID_GetGamma: ERROR: CGGetDisplayTransferByTable failed!\n");
184 if (actualsize != (unsigned int)rampsize)
186 Con_Printf("VID_GetGamma: ERROR: invalid gamma table size (%u != %u)\n", actualsize, rampsize);
190 // Convert the 3 float tables into 1 unsigned short table
191 for (i = 0; i < rampsize; i++)
192 ramps[i] = table_red[i] * 65535.0f;
193 for (i = 0; i < rampsize; i++)
194 ramps[i + rampsize] = table_green[i] * 65535.0f;
195 for (i = 0; i < rampsize; i++)
196 ramps[i + 2 * rampsize] = table_blue[i] * 65535.0f;
201 void signal_handler(int sig)
203 printf("Received signal %d, exiting...\n", sig);
204 VID_RestoreSystemGamma();
211 signal(SIGHUP, signal_handler);
212 signal(SIGINT, signal_handler);
213 signal(SIGQUIT, signal_handler);
214 signal(SIGILL, signal_handler);
215 signal(SIGTRAP, signal_handler);
216 signal(SIGIOT, signal_handler);
217 signal(SIGBUS, signal_handler);
218 signal(SIGFPE, signal_handler);
219 signal(SIGSEGV, signal_handler);
220 signal(SIGTERM, signal_handler);
225 InitSig(); // trap evil signals
226 // COMMANDLINEOPTION: Input: -nomouse disables mouse support (see also vid_mouse cvar)
227 if (COM_CheckParm ("-nomouse") || COM_CheckParm("-safe"))
231 static void *prjobj = NULL;
233 static void GL_CloseLibrary(void)
241 gl_platformextensions = "";
244 static int GL_OpenLibrary(void)
246 const char *name = "/System/Library/Frameworks/AGL.framework/AGL";
248 Con_Printf("Loading OpenGL driver %s\n", name);
250 if (!(prjobj = dlopen(name, RTLD_LAZY)))
252 Con_Printf("Unable to open symbol list for %s\n", name);
255 strcpy(gl_driver, name);
259 void *GL_GetProcAddress(const char *name)
261 return dlsym(prjobj, name);
264 void VID_Shutdown(void)
266 if (context == NULL && window == NULL)
270 VID_RestoreSystemGamma();
274 qaglDestroyContext(context);
278 if (vid_isfullscreen)
279 CGReleaseAllDisplays();
283 DisposeWindow(window);
288 vid_isfullscreen = false;
294 // Since the event handler can be called at any time, we store the events for later processing
295 static qboolean AsyncEvent_Quitting = false;
296 static qboolean AsyncEvent_Collapsed = false;
297 static OSStatus MainWindowEventHandler (EventHandlerCallRef nextHandler, EventRef event, void *userData)
299 OSStatus err = noErr;
301 switch (GetEventKind (event))
303 case kEventWindowClosed:
304 AsyncEvent_Quitting = true;
308 case kEventWindowCollapsing:
309 AsyncEvent_Collapsed = true;
312 // Undocked / restored (end)
313 case kEventWindowExpanded:
314 AsyncEvent_Collapsed = false;
318 err = eventNotHandledErr;
325 static void VID_ProcessPendingAsyncEvents (void)
327 // Collapsed / expanded
328 if (AsyncEvent_Collapsed != vid_hidden)
330 vid_hidden = !vid_hidden;
331 vid_activewindow = false;
332 VID_RestoreSystemGamma();
336 if (AsyncEvent_Quitting)
342 static void VID_BuildAGLAttrib(GLint *attrib, qboolean stencil, qboolean fullscreen)
344 *attrib++ = AGL_RGBA;
345 *attrib++ = AGL_RED_SIZE;*attrib++ = 1;
346 *attrib++ = AGL_GREEN_SIZE;*attrib++ = 1;
347 *attrib++ = AGL_BLUE_SIZE;*attrib++ = 1;
348 *attrib++ = AGL_DOUBLEBUFFER;
349 *attrib++ = AGL_DEPTH_SIZE;*attrib++ = 1;
351 // if stencil is enabled, ask for alpha too
354 *attrib++ = AGL_STENCIL_SIZE;*attrib++ = 8;
355 *attrib++ = AGL_ALPHA_SIZE;*attrib++ = 1;
358 *attrib++ = AGL_FULLSCREEN;
359 *attrib++ = AGL_NONE;
362 int VID_InitMode(int fullscreen, int width, int height, int bpp, int refreshrate)
364 const EventTypeSpec winEvents[] =
366 { kEventClassWindow, kEventWindowClosed },
367 { kEventClassWindow, kEventWindowCollapsing },
368 { kEventClassWindow, kEventWindowExpanded },
370 OSStatus carbonError;
372 CFStringRef windowTitle;
373 AGLPixelFormat pixelFormat;
374 GLint attributes [32];
377 if (!GL_OpenLibrary())
379 Con_Printf("Unable to load GL driver\n");
383 if ((qaglChoosePixelFormat = (AGLPixelFormat (*) (const AGLDevice *gdevs, GLint ndev, const GLint *attribList))GL_GetProcAddress("aglChoosePixelFormat")) == NULL
384 || (qaglCreateContext = (AGLContext (*) (AGLPixelFormat pix, AGLContext share))GL_GetProcAddress("aglCreateContext")) == NULL
385 || (qaglDestroyContext = (GLboolean (*) (AGLContext ctx))GL_GetProcAddress("aglDestroyContext")) == NULL
386 || (qaglDestroyPixelFormat = (void (*) (AGLPixelFormat pix))GL_GetProcAddress("aglDestroyPixelFormat")) == NULL
387 || (qaglErrorString = (const GLubyte* (*) (GLenum code))GL_GetProcAddress("aglErrorString")) == NULL
388 || (qaglGetError = (GLenum (*) (void))GL_GetProcAddress("aglGetError")) == NULL
389 || (qaglSetCurrentContext = (GLboolean (*) (AGLContext ctx))GL_GetProcAddress("aglSetCurrentContext")) == NULL
390 || (qaglSetDrawable = (GLboolean (*) (AGLContext ctx, AGLDrawable draw))GL_GetProcAddress("aglSetDrawable")) == NULL
391 || (qaglSetFullScreen = (GLboolean (*) (AGLContext ctx, GLsizei width, GLsizei height, GLsizei freq, GLint device))GL_GetProcAddress("aglSetFullScreen")) == NULL
392 || (qaglSetInteger = (GLboolean (*) (AGLContext ctx, GLenum pname, const GLint *params))GL_GetProcAddress("aglSetInteger")) == NULL
393 || (qaglSwapBuffers = (void (*) (AGLContext ctx))GL_GetProcAddress("aglSwapBuffers")) == NULL
396 Con_Printf("AGL functions not found\n");
397 ReleaseWindow(window);
401 // Ignore the events from the previous window
402 AsyncEvent_Quitting = false;
403 AsyncEvent_Collapsed = false;
405 // Create the window, a bit towards the center of the screen
406 windowBounds.left = 100;
407 windowBounds.top = 100;
408 windowBounds.right = width + 100;
409 windowBounds.bottom = height + 100;
410 carbonError = CreateNewWindow(kDocumentWindowClass, kWindowStandardFloatingAttributes | kWindowStandardHandlerAttribute, &windowBounds, &window);
411 if (carbonError != noErr || window == NULL)
413 Con_Printf("Unable to create window (error %d)\n", carbonError);
417 // Set the window title
418 windowTitle = CFSTR("DarkPlaces AGL");
419 SetWindowTitleWithCFString(window, windowTitle);
421 // Install the callback function for the window events we can't get
422 // through ReceiveNextEvent (i.e. close, collapse, and expand)
423 InstallWindowEventHandler (window, NewEventHandlerUPP (MainWindowEventHandler),
424 GetEventTypeCount(winEvents), winEvents, window, NULL);
426 // Create the desired attribute list
427 VID_BuildAGLAttrib(attributes, bpp == 32, fullscreen);
432 pixelFormat = qaglChoosePixelFormat(NULL, 0, attributes);
433 error = qaglGetError();
434 if (error != AGL_NO_ERROR)
436 Con_Printf("qaglChoosePixelFormat FAILED: %s\n",
437 (char *)qaglErrorString(error));
438 ReleaseWindow(window);
442 else // Output is fullScreen
444 CGDirectDisplayID mainDisplay;
445 CFDictionaryRef refDisplayMode;
448 // Get the mainDisplay and set resolution to current
449 mainDisplay = CGMainDisplayID();
450 CGDisplayCapture(mainDisplay);
452 // TOCHECK: not sure whether or not it's necessary to change the resolution
453 // "by hand", or if aglSetFullscreen does the job anyway
454 refDisplayMode = CGDisplayBestModeForParametersAndRefreshRate(mainDisplay, bpp, width, height, refreshrate, NULL);
455 CGDisplaySwitchToMode(mainDisplay, refDisplayMode);
456 DMGetGDeviceByDisplayID((DisplayIDType)mainDisplay, &gdhDisplay, false);
458 // Set pixel format with built attribs
459 // Note: specifying a device is *required* for AGL_FullScreen
460 pixelFormat = qaglChoosePixelFormat(&gdhDisplay, 1, attributes);
461 error = qaglGetError();
462 if (error != AGL_NO_ERROR)
464 Con_Printf("qaglChoosePixelFormat FAILED: %s\n",
465 (char *)qaglErrorString(error));
466 ReleaseWindow(window);
471 // Create a context using the pform
472 context = qaglCreateContext(pixelFormat, NULL);
473 error = qaglGetError();
474 if (error != AGL_NO_ERROR)
476 Con_Printf("qaglCreateContext FAILED: %s\n",
477 (char *)qaglErrorString(error));
480 // Make the context the current one ('enable' it)
481 qaglSetCurrentContext(context);
482 error = qaglGetError();
483 if (error != AGL_NO_ERROR)
485 Con_Printf("qaglSetCurrentContext FAILED: %s\n",
486 (char *)qaglErrorString(error));
487 ReleaseWindow(window);
492 qaglDestroyPixelFormat(pixelFormat);
494 // Attempt fullscreen if requested
497 qaglSetFullScreen (context, width, height, refreshrate, 0);
498 error = qaglGetError();
499 if (error != AGL_NO_ERROR)
501 Con_Printf("qaglSetFullScreen FAILED: %s\n",
502 (char *)qaglErrorString(error));
508 // Set Window as Drawable
509 qaglSetDrawable(context, GetWindowPort(window));
510 error = qaglGetError();
511 if (error != AGL_NO_ERROR)
513 Con_Printf("qaglSetDrawable FAILED: %s\n",
514 (char *)qaglErrorString(error));
515 ReleaseWindow(window);
523 if ((qglGetString = (const GLubyte* (GLAPIENTRY *)(GLenum name))GL_GetProcAddress("glGetString")) == NULL)
524 Sys_Error("glGetString not found in %s", gl_driver);
526 gl_renderer = (const char *)qglGetString(GL_RENDERER);
527 gl_vendor = (const char *)qglGetString(GL_VENDOR);
528 gl_version = (const char *)qglGetString(GL_VERSION);
529 gl_extensions = (const char *)qglGetString(GL_EXTENSIONS);
531 gl_videosyncavailable = true;
533 vid_isfullscreen = fullscreen;
534 vid_usingmouse = false;
536 vid_activewindow = true;
539 SelectWindow(window);
545 static void Handle_KeyMod(UInt32 keymod)
547 const struct keymod_to_event_s { int keybit; keynum_t event; } keymod_events [] =
551 {alphaLock, K_CAPSLOCK},
553 {controlKey, K_CTRL},
554 {kEventKeyModifierNumLockMask, K_NUMLOCK},
555 {kEventKeyModifierFnMask, K_AUX2}
557 static UInt32 prev_keymod = 0;
561 modChanges = prev_keymod ^ keymod;
563 for (i = 0; i < sizeof(keymod_events) / sizeof(keymod_events[0]); i++)
565 int keybit = keymod_events[i].keybit;
567 if ((modChanges & keybit) != 0)
568 Key_Event(keymod_events[i].event, '\0', (keymod & keybit) != 0);
571 prev_keymod = keymod;
574 static void Handle_Key(unsigned char charcode, qboolean keypressed)
576 unsigned int keycode = 0;
585 keycode = K_KP_ENTER;
590 case kBackspaceCharCode:
591 keycode = K_BACKSPACE;
596 case kPageUpCharCode:
599 case kPageDownCharCode:
602 case kReturnCharCode:
605 case kEscapeCharCode:
608 case kLeftArrowCharCode:
609 keycode = K_LEFTARROW;
611 case kRightArrowCharCode:
612 keycode = K_RIGHTARROW;
614 case kUpArrowCharCode:
617 case kDownArrowCharCode :
618 keycode = K_DOWNARROW;
620 case kDeleteCharCode:
625 // characters 0 and 191 are sent by the mouse buttons (?!)
628 if ('A' <= charcode && charcode <= 'Z')
630 keycode = charcode + ('a' - 'A'); // lowercase it
633 else if (charcode >= 32)
639 Con_Printf(">> UNKNOWN charcode: %d <<\n", charcode);
643 Key_Event(keycode, ascii, keypressed);
646 void Sys_SendKeyEvents(void)
649 EventTargetRef theTarget;
651 // Start by processing the asynchronous events we received since the previous frame
652 VID_ProcessPendingAsyncEvents();
654 theTarget = GetEventDispatcherTarget();
655 while (ReceiveNextEvent(0, NULL, kEventDurationNoWait, true, &theEvent) == noErr)
657 UInt32 eventClass = GetEventClass(theEvent);
658 UInt32 eventKind = GetEventKind(theEvent);
662 case kEventClassMouse:
664 EventMouseButton theButton;
669 case kEventMouseDown:
671 GetEventParameter(theEvent, kEventParamMouseButton, typeMouseButton, NULL, sizeof(theButton), NULL, &theButton);
675 case kEventMouseButtonPrimary:
678 case kEventMouseButtonSecondary:
681 case kEventMouseButtonTertiary:
685 Key_Event(key, '\0', eventKind == kEventMouseDown);
688 // Note: These two events are mutual exclusives
689 // Treat MouseDragged in the same statement, so we don't block MouseMoved while a mousebutton is held
690 case kEventMouseMoved:
691 case kEventMouseDragged:
695 GetEventParameter(theEvent, kEventParamMouseDelta, typeHIPoint, NULL, sizeof(deltaPos), NULL, &deltaPos);
697 mouse_x += deltaPos.x;
698 mouse_y += deltaPos.y;
702 case kEventMouseWheelMoved:
705 unsigned int wheelEvent;
707 GetEventParameter(theEvent, kEventParamMouseWheelDelta, typeSInt32, NULL, sizeof(delta), NULL, &delta);
709 wheelEvent = (delta > 0) ? K_MWHEELUP : K_MWHEELDOWN;
710 Key_Event(wheelEvent, 0, true);
711 Key_Event(wheelEvent, 0, false);
716 Con_Printf (">> kEventClassMouse (UNKNOWN eventKind: %d) <<\n", eventKind);
721 case kEventClassKeyboard:
727 case kEventRawKeyDown:
728 GetEventParameter(theEvent, kEventParamKeyMacCharCodes, typeChar, NULL, sizeof(keycode), NULL, &keycode);
729 Handle_Key(keycode, true);
732 case kEventRawKeyRepeat:
736 GetEventParameter(theEvent, kEventParamKeyMacCharCodes, typeChar, NULL, sizeof(keycode), NULL, &keycode);
737 Handle_Key(keycode, false);
740 case kEventRawKeyModifiersChanged:
743 GetEventParameter(theEvent, kEventParamKeyModifiers, typeUInt32, NULL, sizeof(keymod), NULL, &keymod);
744 Handle_KeyMod(keymod);
748 case kEventHotKeyPressed:
751 case kEventHotKeyReleased:
754 case kEventMouseWheelMoved:
758 Con_Printf (">> kEventClassKeyboard (UNKNOWN eventKind: %d) <<\n", eventKind);
764 case kEventClassTextInput:
765 Con_Printf(">> kEventClassTextInput (%d) <<\n", eventKind);
768 case kEventClassApplication:
771 case kEventAppActivated :
772 vid_activewindow = true;
774 case kEventAppDeactivated:
775 vid_activewindow = false;
776 VID_RestoreSystemGamma();
781 case kEventAppActiveWindowChanged:
784 Con_Printf(">> kEventClassApplication (UNKNOWN eventKind: %d) <<\n", eventKind);
789 case kEventClassAppleEvent:
792 case kEventAppleEvent :
795 Con_Printf(">> kEventClassAppleEvent (UNKNOWN eventKind: %d) <<\n", eventKind);
800 case kEventClassWindow:
803 case kEventWindowUpdate :
806 Con_Printf(">> kEventClassWindow (UNKNOWN eventKind: %d) <<\n", eventKind);
811 case kEventClassControl:
815 /*Con_Printf(">> UNKNOWN eventClass: %c%c%c%c, eventKind: %d <<\n",
816 eventClass >> 24, (eventClass >> 16) & 0xFF,
817 (eventClass >> 8) & 0xFF, eventClass & 0xFF,
822 SendEventToEventTarget (theEvent, theTarget);
823 ReleaseEvent(theEvent);
831 in_mouse_x = mouse_x;
832 in_mouse_y = mouse_y;