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)
140 if (r_speeds.integer || gl_finish.integer)
142 qglFinish();CHECKGLERROR
144 qaglSwapBuffers(context);
146 VID_UpdateGamma(false, GAMMA_TABLE_SIZE);
149 int VID_SetGamma(unsigned short *ramps, int rampsize)
151 CGGammaValue table_red [GAMMA_TABLE_SIZE];
152 CGGammaValue table_green [GAMMA_TABLE_SIZE];
153 CGGammaValue table_blue [GAMMA_TABLE_SIZE];
156 // Convert the unsigned short table into 3 float tables
157 for (i = 0; i < rampsize; i++)
158 table_red[i] = (float)ramps[i] / 65535.0f;
159 for (i = 0; i < rampsize; i++)
160 table_green[i] = (float)ramps[i + rampsize] / 65535.0f;
161 for (i = 0; i < rampsize; i++)
162 table_blue[i] = (float)ramps[i + 2 * rampsize] / 65535.0f;
164 if (CGSetDisplayTransferByTable(CGMainDisplayID(), rampsize, table_red, table_green, table_blue) != CGDisplayNoErr)
166 Con_Print("VID_SetGamma: ERROR: CGSetDisplayTransferByTable failed!\n");
173 int VID_GetGamma(unsigned short *ramps, int rampsize)
175 CGGammaValue table_red [GAMMA_TABLE_SIZE];
176 CGGammaValue table_green [GAMMA_TABLE_SIZE];
177 CGGammaValue table_blue [GAMMA_TABLE_SIZE];
178 CGTableCount actualsize = 0;
181 // Get the gamma ramps from the system
182 if (CGGetDisplayTransferByTable(CGMainDisplayID(), rampsize, table_red, table_green, table_blue, &actualsize) != CGDisplayNoErr)
184 Con_Print("VID_GetGamma: ERROR: CGGetDisplayTransferByTable failed!\n");
187 if (actualsize != (unsigned int)rampsize)
189 Con_Printf("VID_GetGamma: ERROR: invalid gamma table size (%u != %u)\n", actualsize, rampsize);
193 // Convert the 3 float tables into 1 unsigned short table
194 for (i = 0; i < rampsize; i++)
195 ramps[i] = table_red[i] * 65535.0f;
196 for (i = 0; i < rampsize; i++)
197 ramps[i + rampsize] = table_green[i] * 65535.0f;
198 for (i = 0; i < rampsize; i++)
199 ramps[i + 2 * rampsize] = table_blue[i] * 65535.0f;
204 void signal_handler(int sig)
206 printf("Received signal %d, exiting...\n", sig);
207 VID_RestoreSystemGamma();
214 signal(SIGHUP, signal_handler);
215 signal(SIGINT, signal_handler);
216 signal(SIGQUIT, signal_handler);
217 signal(SIGILL, signal_handler);
218 signal(SIGTRAP, signal_handler);
219 signal(SIGIOT, signal_handler);
220 signal(SIGBUS, signal_handler);
221 signal(SIGFPE, signal_handler);
222 signal(SIGSEGV, signal_handler);
223 signal(SIGTERM, signal_handler);
228 InitSig(); // trap evil signals
229 // COMMANDLINEOPTION: Input: -nomouse disables mouse support (see also vid_mouse cvar)
230 if (COM_CheckParm ("-nomouse") || COM_CheckParm("-safe"))
234 static void *prjobj = NULL;
236 static void GL_CloseLibrary(void)
244 gl_platformextensions = "";
247 static int GL_OpenLibrary(void)
249 const char *name = "/System/Library/Frameworks/AGL.framework/AGL";
251 Con_Printf("Loading OpenGL driver %s\n", name);
253 if (!(prjobj = dlopen(name, RTLD_LAZY)))
255 Con_Printf("Unable to open symbol list for %s\n", name);
258 strcpy(gl_driver, name);
262 void *GL_GetProcAddress(const char *name)
264 return dlsym(prjobj, name);
267 void VID_Shutdown(void)
269 if (context == NULL && window == NULL)
273 VID_RestoreSystemGamma();
277 qaglDestroyContext(context);
281 if (vid_isfullscreen)
282 CGReleaseAllDisplays();
286 DisposeWindow(window);
291 vid_isfullscreen = false;
297 // Since the event handler can be called at any time, we store the events for later processing
298 static qboolean AsyncEvent_Quitting = false;
299 static qboolean AsyncEvent_Collapsed = false;
300 static OSStatus MainWindowEventHandler (EventHandlerCallRef nextHandler, EventRef event, void *userData)
302 OSStatus err = noErr;
304 switch (GetEventKind (event))
306 case kEventWindowClosed:
307 AsyncEvent_Quitting = true;
311 case kEventWindowCollapsing:
312 AsyncEvent_Collapsed = true;
315 // Undocked / restored (end)
316 case kEventWindowExpanded:
317 AsyncEvent_Collapsed = false;
321 err = eventNotHandledErr;
328 static void VID_ProcessPendingAsyncEvents (void)
330 // Collapsed / expanded
331 if (AsyncEvent_Collapsed != vid_hidden)
333 vid_hidden = !vid_hidden;
334 vid_activewindow = false;
335 VID_RestoreSystemGamma();
339 if (AsyncEvent_Quitting)
345 static void VID_BuildAGLAttrib(GLint *attrib, qboolean stencil, qboolean fullscreen)
347 *attrib++ = AGL_RGBA;
348 *attrib++ = AGL_RED_SIZE;*attrib++ = 1;
349 *attrib++ = AGL_GREEN_SIZE;*attrib++ = 1;
350 *attrib++ = AGL_BLUE_SIZE;*attrib++ = 1;
351 *attrib++ = AGL_DOUBLEBUFFER;
352 *attrib++ = AGL_DEPTH_SIZE;*attrib++ = 1;
354 // if stencil is enabled, ask for alpha too
357 *attrib++ = AGL_STENCIL_SIZE;*attrib++ = 8;
358 *attrib++ = AGL_ALPHA_SIZE;*attrib++ = 1;
361 *attrib++ = AGL_FULLSCREEN;
362 *attrib++ = AGL_NONE;
365 int VID_InitMode(int fullscreen, int width, int height, int bpp, int refreshrate)
367 const EventTypeSpec winEvents[] =
369 { kEventClassWindow, kEventWindowClosed },
370 { kEventClassWindow, kEventWindowCollapsing },
371 { kEventClassWindow, kEventWindowExpanded },
373 OSStatus carbonError;
375 CFStringRef windowTitle;
376 AGLPixelFormat pixelFormat;
377 GLint attributes [32];
380 if (!GL_OpenLibrary())
382 Con_Printf("Unable to load GL driver\n");
386 if ((qaglChoosePixelFormat = (AGLPixelFormat (*) (const AGLDevice *gdevs, GLint ndev, const GLint *attribList))GL_GetProcAddress("aglChoosePixelFormat")) == NULL
387 || (qaglCreateContext = (AGLContext (*) (AGLPixelFormat pix, AGLContext share))GL_GetProcAddress("aglCreateContext")) == NULL
388 || (qaglDestroyContext = (GLboolean (*) (AGLContext ctx))GL_GetProcAddress("aglDestroyContext")) == NULL
389 || (qaglDestroyPixelFormat = (void (*) (AGLPixelFormat pix))GL_GetProcAddress("aglDestroyPixelFormat")) == NULL
390 || (qaglErrorString = (const GLubyte* (*) (GLenum code))GL_GetProcAddress("aglErrorString")) == NULL
391 || (qaglGetError = (GLenum (*) (void))GL_GetProcAddress("aglGetError")) == NULL
392 || (qaglSetCurrentContext = (GLboolean (*) (AGLContext ctx))GL_GetProcAddress("aglSetCurrentContext")) == NULL
393 || (qaglSetDrawable = (GLboolean (*) (AGLContext ctx, AGLDrawable draw))GL_GetProcAddress("aglSetDrawable")) == NULL
394 || (qaglSetFullScreen = (GLboolean (*) (AGLContext ctx, GLsizei width, GLsizei height, GLsizei freq, GLint device))GL_GetProcAddress("aglSetFullScreen")) == NULL
395 || (qaglSetInteger = (GLboolean (*) (AGLContext ctx, GLenum pname, const GLint *params))GL_GetProcAddress("aglSetInteger")) == NULL
396 || (qaglSwapBuffers = (void (*) (AGLContext ctx))GL_GetProcAddress("aglSwapBuffers")) == NULL
399 Con_Printf("AGL functions not found\n");
400 ReleaseWindow(window);
404 // Ignore the events from the previous window
405 AsyncEvent_Quitting = false;
406 AsyncEvent_Collapsed = false;
408 // Create the window, a bit towards the center of the screen
409 windowBounds.left = 100;
410 windowBounds.top = 100;
411 windowBounds.right = width + 100;
412 windowBounds.bottom = height + 100;
413 carbonError = CreateNewWindow(kDocumentWindowClass, kWindowStandardFloatingAttributes | kWindowStandardHandlerAttribute, &windowBounds, &window);
414 if (carbonError != noErr || window == NULL)
416 Con_Printf("Unable to create window (error %d)\n", carbonError);
420 // Set the window title
421 windowTitle = CFSTR("DarkPlaces AGL");
422 SetWindowTitleWithCFString(window, windowTitle);
424 // Install the callback function for the window events we can't get
425 // through ReceiveNextEvent (i.e. close, collapse, and expand)
426 InstallWindowEventHandler (window, NewEventHandlerUPP (MainWindowEventHandler),
427 GetEventTypeCount(winEvents), winEvents, window, NULL);
429 // Create the desired attribute list
430 VID_BuildAGLAttrib(attributes, bpp == 32, fullscreen);
435 pixelFormat = qaglChoosePixelFormat(NULL, 0, attributes);
436 error = qaglGetError();
437 if (error != AGL_NO_ERROR)
439 Con_Printf("qaglChoosePixelFormat FAILED: %s\n",
440 (char *)qaglErrorString(error));
441 ReleaseWindow(window);
445 else // Output is fullScreen
447 CGDirectDisplayID mainDisplay;
448 CFDictionaryRef refDisplayMode;
451 // Get the mainDisplay and set resolution to current
452 mainDisplay = CGMainDisplayID();
453 CGDisplayCapture(mainDisplay);
455 // TOCHECK: not sure whether or not it's necessary to change the resolution
456 // "by hand", or if aglSetFullscreen does the job anyway
457 refDisplayMode = CGDisplayBestModeForParametersAndRefreshRate(mainDisplay, bpp, width, height, refreshrate, NULL);
458 CGDisplaySwitchToMode(mainDisplay, refDisplayMode);
459 DMGetGDeviceByDisplayID((DisplayIDType)mainDisplay, &gdhDisplay, false);
461 // Set pixel format with built attribs
462 // Note: specifying a device is *required* for AGL_FullScreen
463 pixelFormat = qaglChoosePixelFormat(&gdhDisplay, 1, attributes);
464 error = qaglGetError();
465 if (error != AGL_NO_ERROR)
467 Con_Printf("qaglChoosePixelFormat FAILED: %s\n",
468 (char *)qaglErrorString(error));
469 ReleaseWindow(window);
474 // Create a context using the pform
475 context = qaglCreateContext(pixelFormat, NULL);
476 error = qaglGetError();
477 if (error != AGL_NO_ERROR)
479 Con_Printf("qaglCreateContext FAILED: %s\n",
480 (char *)qaglErrorString(error));
483 // Make the context the current one ('enable' it)
484 qaglSetCurrentContext(context);
485 error = qaglGetError();
486 if (error != AGL_NO_ERROR)
488 Con_Printf("qaglSetCurrentContext FAILED: %s\n",
489 (char *)qaglErrorString(error));
490 ReleaseWindow(window);
495 qaglDestroyPixelFormat(pixelFormat);
497 // Attempt fullscreen if requested
500 qaglSetFullScreen (context, width, height, refreshrate, 0);
501 error = qaglGetError();
502 if (error != AGL_NO_ERROR)
504 Con_Printf("qaglSetFullScreen FAILED: %s\n",
505 (char *)qaglErrorString(error));
511 // Set Window as Drawable
512 qaglSetDrawable(context, GetWindowPort(window));
513 error = qaglGetError();
514 if (error != AGL_NO_ERROR)
516 Con_Printf("qaglSetDrawable FAILED: %s\n",
517 (char *)qaglErrorString(error));
518 ReleaseWindow(window);
526 if ((qglGetString = (const GLubyte* (GLAPIENTRY *)(GLenum name))GL_GetProcAddress("glGetString")) == NULL)
527 Sys_Error("glGetString not found in %s", gl_driver);
529 gl_renderer = (const char *)qglGetString(GL_RENDERER);
530 gl_vendor = (const char *)qglGetString(GL_VENDOR);
531 gl_version = (const char *)qglGetString(GL_VERSION);
532 gl_extensions = (const char *)qglGetString(GL_EXTENSIONS);
534 gl_videosyncavailable = true;
536 vid_isfullscreen = fullscreen;
537 vid_usingmouse = false;
539 vid_activewindow = true;
542 SelectWindow(window);
548 static void Handle_KeyMod(UInt32 keymod)
550 const struct keymod_to_event_s { int keybit; keynum_t event; } keymod_events [] =
554 {alphaLock, K_CAPSLOCK},
556 {controlKey, K_CTRL},
557 {kEventKeyModifierNumLockMask, K_NUMLOCK},
558 {kEventKeyModifierFnMask, K_AUX2}
560 static UInt32 prev_keymod = 0;
564 modChanges = prev_keymod ^ keymod;
566 for (i = 0; i < sizeof(keymod_events) / sizeof(keymod_events[0]); i++)
568 int keybit = keymod_events[i].keybit;
570 if ((modChanges & keybit) != 0)
571 Key_Event(keymod_events[i].event, '\0', (keymod & keybit) != 0);
574 prev_keymod = keymod;
577 static void Handle_Key(unsigned char charcode, qboolean keypressed)
579 unsigned int keycode = 0;
588 keycode = K_KP_ENTER;
593 case kBackspaceCharCode:
594 keycode = K_BACKSPACE;
599 case kPageUpCharCode:
602 case kPageDownCharCode:
605 case kReturnCharCode:
608 case kEscapeCharCode:
611 case kLeftArrowCharCode:
612 keycode = K_LEFTARROW;
614 case kRightArrowCharCode:
615 keycode = K_RIGHTARROW;
617 case kUpArrowCharCode:
620 case kDownArrowCharCode :
621 keycode = K_DOWNARROW;
623 case kDeleteCharCode:
628 // characters 0 and 191 are sent by the mouse buttons (?!)
631 if ('A' <= charcode && charcode <= 'Z')
633 keycode = charcode + ('a' - 'A'); // lowercase it
636 else if (charcode >= 32)
642 Con_Printf(">> UNKNOWN charcode: %d <<\n", charcode);
646 Key_Event(keycode, ascii, keypressed);
649 void Sys_SendKeyEvents(void)
652 EventTargetRef theTarget;
654 // Start by processing the asynchronous events we received since the previous frame
655 VID_ProcessPendingAsyncEvents();
657 theTarget = GetEventDispatcherTarget();
658 while (ReceiveNextEvent(0, NULL, kEventDurationNoWait, true, &theEvent) == noErr)
660 UInt32 eventClass = GetEventClass(theEvent);
661 UInt32 eventKind = GetEventKind(theEvent);
665 case kEventClassMouse:
667 EventMouseButton theButton;
672 case kEventMouseDown:
674 GetEventParameter(theEvent, kEventParamMouseButton, typeMouseButton, NULL, sizeof(theButton), NULL, &theButton);
678 case kEventMouseButtonPrimary:
681 case kEventMouseButtonSecondary:
684 case kEventMouseButtonTertiary:
688 Key_Event(key, '\0', eventKind == kEventMouseDown);
691 // Note: These two events are mutual exclusives
692 // Treat MouseDragged in the same statement, so we don't block MouseMoved while a mousebutton is held
693 case kEventMouseMoved:
694 case kEventMouseDragged:
698 GetEventParameter(theEvent, kEventParamMouseDelta, typeHIPoint, NULL, sizeof(deltaPos), NULL, &deltaPos);
700 mouse_x += deltaPos.x;
701 mouse_y += deltaPos.y;
705 case kEventMouseWheelMoved:
708 unsigned int wheelEvent;
710 GetEventParameter(theEvent, kEventParamMouseWheelDelta, typeSInt32, NULL, sizeof(delta), NULL, &delta);
712 wheelEvent = (delta > 0) ? K_MWHEELUP : K_MWHEELDOWN;
713 Key_Event(wheelEvent, 0, true);
714 Key_Event(wheelEvent, 0, false);
719 Con_Printf (">> kEventClassMouse (UNKNOWN eventKind: %d) <<\n", eventKind);
724 case kEventClassKeyboard:
730 case kEventRawKeyDown:
731 GetEventParameter(theEvent, kEventParamKeyMacCharCodes, typeChar, NULL, sizeof(keycode), NULL, &keycode);
732 Handle_Key(keycode, true);
735 case kEventRawKeyRepeat:
739 GetEventParameter(theEvent, kEventParamKeyMacCharCodes, typeChar, NULL, sizeof(keycode), NULL, &keycode);
740 Handle_Key(keycode, false);
743 case kEventRawKeyModifiersChanged:
746 GetEventParameter(theEvent, kEventParamKeyModifiers, typeUInt32, NULL, sizeof(keymod), NULL, &keymod);
747 Handle_KeyMod(keymod);
751 case kEventHotKeyPressed:
754 case kEventHotKeyReleased:
757 case kEventMouseWheelMoved:
761 Con_Printf (">> kEventClassKeyboard (UNKNOWN eventKind: %d) <<\n", eventKind);
767 case kEventClassTextInput:
768 Con_Printf(">> kEventClassTextInput (%d) <<\n", eventKind);
771 case kEventClassApplication:
774 case kEventAppActivated :
775 vid_activewindow = true;
777 case kEventAppDeactivated:
778 vid_activewindow = false;
779 VID_RestoreSystemGamma();
784 case kEventAppActiveWindowChanged:
787 Con_Printf(">> kEventClassApplication (UNKNOWN eventKind: %d) <<\n", eventKind);
792 case kEventClassAppleEvent:
795 case kEventAppleEvent :
798 Con_Printf(">> kEventClassAppleEvent (UNKNOWN eventKind: %d) <<\n", eventKind);
803 case kEventClassWindow:
806 case kEventWindowUpdate :
809 Con_Printf(">> kEventClassWindow (UNKNOWN eventKind: %d) <<\n", eventKind);
814 case kEventClassControl:
818 /*Con_Printf(">> UNKNOWN eventClass: %c%c%c%c, eventKind: %d <<\n",
819 eventClass >> 24, (eventClass >> 16) & 0xFF,
820 (eventClass >> 8) & 0xFF, eventClass & 0xFF,
825 SendEventToEventTarget (theEvent, theTarget);
826 ReleaseEvent(theEvent);
834 in_mouse_x = mouse_x;
835 in_mouse_y = mouse_y;