/* vid_agl.c Mac OS X OpenGL and input module, using Carbon and AGL Copyright (C) 2005-2006 Mathieu Olivier This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include #include #include #include #include "quakedef.h" // Tell startup code that we have a client int cl_available = true; qboolean vid_supportrefreshrate = true; // AGL prototypes AGLPixelFormat (*qaglChoosePixelFormat) (const AGLDevice *gdevs, GLint ndev, const GLint *attribList); AGLContext (*qaglCreateContext) (AGLPixelFormat pix, AGLContext share); GLboolean (*qaglDestroyContext) (AGLContext ctx); void (*qaglDestroyPixelFormat) (AGLPixelFormat pix); const GLubyte* (*qaglErrorString) (GLenum code); GLenum (*qaglGetError) (void); GLboolean (*qaglSetCurrentContext) (AGLContext ctx); GLboolean (*qaglSetDrawable) (AGLContext ctx, AGLDrawable draw); GLboolean (*qaglSetFullScreen) (AGLContext ctx, GLsizei width, GLsizei height, GLsizei freq, GLint device); GLboolean (*qaglSetInteger) (AGLContext ctx, GLenum pname, const GLint *params); void (*qaglSwapBuffers) (AGLContext ctx); static qboolean mouse_avail = true; static qboolean vid_usingmouse = false; static float mouse_x, mouse_y; static qboolean vid_isfullscreen = false; static qboolean vid_usingvsync = false; static qboolean sound_active = true; static int scr_width, scr_height; static AGLContext context; static WindowRef window; void VID_GetWindowSize (int *x, int *y, int *width, int *height) { *x = *y = 0; *width = scr_width; *height = scr_height; } static void IN_Activate( qboolean grab ) { if (grab) { if (!vid_usingmouse && mouse_avail && window) { Rect winBounds; CGPoint winCenter; SelectWindow(window); CGDisplayHideCursor(CGMainDisplayID()); // Put the mouse cursor at the center of the window GetWindowBounds (window, kWindowContentRgn, &winBounds); winCenter.x = (winBounds.left + winBounds.right) / 2; winCenter.y = (winBounds.top + winBounds.bottom) / 2; CGWarpMouseCursorPosition(winCenter); // Lock the mouse pointer at its current position CGAssociateMouseAndMouseCursorPosition(false); mouse_x = mouse_y = 0; vid_usingmouse = true; } } else { if (vid_usingmouse) { CGAssociateMouseAndMouseCursorPosition(true); CGDisplayShowCursor(CGMainDisplayID()); vid_usingmouse = false; } } } #define GAMMA_TABLE_SIZE 256 void VID_Finish (qboolean allowmousegrab) { qboolean vid_usemouse; qboolean vid_usevsync; // handle the mouse state when windowed if that's changed vid_usemouse = false; if (allowmousegrab && vid_mouse.integer && !key_consoleactive && (key_dest != key_game || !cls.demoplayback)) vid_usemouse = true; if (!vid_activewindow) vid_usemouse = false; if (vid_isfullscreen) vid_usemouse = true; IN_Activate(vid_usemouse); // handle changes of the vsync option vid_usevsync = (vid_vsync.integer && !cls.timedemo); if (vid_usingvsync != vid_usevsync) { GLint sync = (vid_usevsync ? 1 : 0); if (qaglSetInteger(context, AGL_SWAP_INTERVAL, &sync) == GL_TRUE) { vid_usingvsync = vid_usevsync; Con_DPrintf("Vsync %s\n", vid_usevsync ? "activated" : "deactivated"); } else Con_Printf("ERROR: can't %s vsync\n", vid_usevsync ? "activate" : "deactivate"); } if (r_render.integer) { CHECKGLERROR if (r_speeds.integer || gl_finish.integer) { qglFinish();CHECKGLERROR } qaglSwapBuffers(context); } VID_UpdateGamma(false, GAMMA_TABLE_SIZE); } int VID_SetGamma(unsigned short *ramps, int rampsize) { CGGammaValue table_red [GAMMA_TABLE_SIZE]; CGGammaValue table_green [GAMMA_TABLE_SIZE]; CGGammaValue table_blue [GAMMA_TABLE_SIZE]; int i; // Convert the unsigned short table into 3 float tables for (i = 0; i < rampsize; i++) table_red[i] = (float)ramps[i] / 65535.0f; for (i = 0; i < rampsize; i++) table_green[i] = (float)ramps[i + rampsize] / 65535.0f; for (i = 0; i < rampsize; i++) table_blue[i] = (float)ramps[i + 2 * rampsize] / 65535.0f; if (CGSetDisplayTransferByTable(CGMainDisplayID(), rampsize, table_red, table_green, table_blue) != CGDisplayNoErr) { Con_Print("VID_SetGamma: ERROR: CGSetDisplayTransferByTable failed!\n"); return false; } return true; } int VID_GetGamma(unsigned short *ramps, int rampsize) { CGGammaValue table_red [GAMMA_TABLE_SIZE]; CGGammaValue table_green [GAMMA_TABLE_SIZE]; CGGammaValue table_blue [GAMMA_TABLE_SIZE]; CGTableCount actualsize = 0; int i; // Get the gamma ramps from the system if (CGGetDisplayTransferByTable(CGMainDisplayID(), rampsize, table_red, table_green, table_blue, &actualsize) != CGDisplayNoErr) { Con_Print("VID_GetGamma: ERROR: CGGetDisplayTransferByTable failed!\n"); return false; } if (actualsize != (unsigned int)rampsize) { Con_Printf("VID_GetGamma: ERROR: invalid gamma table size (%u != %u)\n", actualsize, rampsize); return false; } // Convert the 3 float tables into 1 unsigned short table for (i = 0; i < rampsize; i++) ramps[i] = table_red[i] * 65535.0f; for (i = 0; i < rampsize; i++) ramps[i + rampsize] = table_green[i] * 65535.0f; for (i = 0; i < rampsize; i++) ramps[i + 2 * rampsize] = table_blue[i] * 65535.0f; return true; } void signal_handler(int sig) { printf("Received signal %d, exiting...\n", sig); VID_RestoreSystemGamma(); Sys_Quit(); exit(0); } void InitSig(void) { signal(SIGHUP, signal_handler); signal(SIGINT, signal_handler); signal(SIGQUIT, signal_handler); signal(SIGILL, signal_handler); signal(SIGTRAP, signal_handler); signal(SIGIOT, signal_handler); signal(SIGBUS, signal_handler); signal(SIGFPE, signal_handler); signal(SIGSEGV, signal_handler); signal(SIGTERM, signal_handler); } void VID_Init(void) { InitSig(); // trap evil signals // COMMANDLINEOPTION: Input: -nomouse disables mouse support (see also vid_mouse cvar) if (COM_CheckParm ("-nomouse") || COM_CheckParm("-safe")) mouse_avail = false; } static void *prjobj = NULL; static void GL_CloseLibrary(void) { if (prjobj) dlclose(prjobj); prjobj = NULL; gl_driver[0] = 0; gl_extensions = ""; gl_platform = ""; gl_platformextensions = ""; } static int GL_OpenLibrary(void) { const char *name = "/System/Library/Frameworks/AGL.framework/AGL"; Con_Printf("Loading OpenGL driver %s\n", name); GL_CloseLibrary(); if (!(prjobj = dlopen(name, RTLD_LAZY))) { Con_Printf("Unable to open symbol list for %s\n", name); return false; } strcpy(gl_driver, name); return true; } void *GL_GetProcAddress(const char *name) { return dlsym(prjobj, name); } void VID_Shutdown(void) { if (context == NULL && window == NULL) return; IN_Activate(false); VID_RestoreSystemGamma(); if (context != NULL) { qaglDestroyContext(context); context = NULL; } if (vid_isfullscreen) CGReleaseAllDisplays(); if (window != NULL) { DisposeWindow(window); window = NULL; } vid_hidden = true; vid_isfullscreen = false; GL_CloseLibrary(); Key_ClearStates (); } // Since the event handler can be called at any time, we store the events for later processing static qboolean AsyncEvent_Quitting = false; static qboolean AsyncEvent_Collapsed = false; static OSStatus MainWindowEventHandler (EventHandlerCallRef nextHandler, EventRef event, void *userData) { OSStatus err = noErr; switch (GetEventKind (event)) { case kEventWindowClosed: AsyncEvent_Quitting = true; break; // Docked (start) case kEventWindowCollapsing: AsyncEvent_Collapsed = true; break; // Undocked / restored (end) case kEventWindowExpanded: AsyncEvent_Collapsed = false; break; default: err = eventNotHandledErr; break; } return err; } static void VID_AppFocusChanged(qboolean windowIsActive) { if (vid_activewindow != windowIsActive) { vid_activewindow = windowIsActive; if (!vid_activewindow) VID_RestoreSystemGamma(); } if (sound_active != windowIsActive) { sound_active = windowIsActive; if (sound_active) S_UnblockSound (); else S_BlockSound (); } } static void VID_ProcessPendingAsyncEvents (void) { // Collapsed / expanded if (AsyncEvent_Collapsed != vid_hidden) { vid_hidden = !vid_hidden; VID_AppFocusChanged(!vid_hidden); } // Closed if (AsyncEvent_Quitting) Sys_Quit(); } static void VID_BuildAGLAttrib(GLint *attrib, qboolean stencil, qboolean fullscreen) { *attrib++ = AGL_RGBA; *attrib++ = AGL_RED_SIZE;*attrib++ = 1; *attrib++ = AGL_GREEN_SIZE;*attrib++ = 1; *attrib++ = AGL_BLUE_SIZE;*attrib++ = 1; *attrib++ = AGL_DOUBLEBUFFER; *attrib++ = AGL_DEPTH_SIZE;*attrib++ = 1; // if stencil is enabled, ask for alpha too if (stencil) { *attrib++ = AGL_STENCIL_SIZE;*attrib++ = 8; *attrib++ = AGL_ALPHA_SIZE;*attrib++ = 1; } if (fullscreen) *attrib++ = AGL_FULLSCREEN; *attrib++ = AGL_NONE; } int VID_InitMode(int fullscreen, int width, int height, int bpp, int refreshrate) { const EventTypeSpec winEvents[] = { { kEventClassWindow, kEventWindowClosed }, { kEventClassWindow, kEventWindowCollapsing }, { kEventClassWindow, kEventWindowExpanded }, }; OSStatus carbonError; Rect windowBounds; CFStringRef windowTitle; AGLPixelFormat pixelFormat; GLint attributes [32]; GLenum error; if (!GL_OpenLibrary()) { Con_Printf("Unable to load GL driver\n"); return false; } if ((qaglChoosePixelFormat = (AGLPixelFormat (*) (const AGLDevice *gdevs, GLint ndev, const GLint *attribList))GL_GetProcAddress("aglChoosePixelFormat")) == NULL || (qaglCreateContext = (AGLContext (*) (AGLPixelFormat pix, AGLContext share))GL_GetProcAddress("aglCreateContext")) == NULL || (qaglDestroyContext = (GLboolean (*) (AGLContext ctx))GL_GetProcAddress("aglDestroyContext")) == NULL || (qaglDestroyPixelFormat = (void (*) (AGLPixelFormat pix))GL_GetProcAddress("aglDestroyPixelFormat")) == NULL || (qaglErrorString = (const GLubyte* (*) (GLenum code))GL_GetProcAddress("aglErrorString")) == NULL || (qaglGetError = (GLenum (*) (void))GL_GetProcAddress("aglGetError")) == NULL || (qaglSetCurrentContext = (GLboolean (*) (AGLContext ctx))GL_GetProcAddress("aglSetCurrentContext")) == NULL || (qaglSetDrawable = (GLboolean (*) (AGLContext ctx, AGLDrawable draw))GL_GetProcAddress("aglSetDrawable")) == NULL || (qaglSetFullScreen = (GLboolean (*) (AGLContext ctx, GLsizei width, GLsizei height, GLsizei freq, GLint device))GL_GetProcAddress("aglSetFullScreen")) == NULL || (qaglSetInteger = (GLboolean (*) (AGLContext ctx, GLenum pname, const GLint *params))GL_GetProcAddress("aglSetInteger")) == NULL || (qaglSwapBuffers = (void (*) (AGLContext ctx))GL_GetProcAddress("aglSwapBuffers")) == NULL ) { Con_Printf("AGL functions not found\n"); ReleaseWindow(window); return false; } // Ignore the events from the previous window AsyncEvent_Quitting = false; AsyncEvent_Collapsed = false; // Create the window, a bit towards the center of the screen windowBounds.left = 100; windowBounds.top = 100; windowBounds.right = width + 100; windowBounds.bottom = height + 100; carbonError = CreateNewWindow(kDocumentWindowClass, kWindowStandardFloatingAttributes | kWindowStandardHandlerAttribute, &windowBounds, &window); if (carbonError != noErr || window == NULL) { Con_Printf("Unable to create window (error %d)\n", carbonError); return false; } // Set the window title windowTitle = CFSTR("DarkPlaces AGL"); SetWindowTitleWithCFString(window, windowTitle); // Install the callback function for the window events we can't get // through ReceiveNextEvent (i.e. close, collapse, and expand) InstallWindowEventHandler (window, NewEventHandlerUPP (MainWindowEventHandler), GetEventTypeCount(winEvents), winEvents, window, NULL); // Create the desired attribute list VID_BuildAGLAttrib(attributes, bpp == 32, fullscreen); if (!fullscreen) { // Output to Window pixelFormat = qaglChoosePixelFormat(NULL, 0, attributes); error = qaglGetError(); if (error != AGL_NO_ERROR) { Con_Printf("qaglChoosePixelFormat FAILED: %s\n", (char *)qaglErrorString(error)); ReleaseWindow(window); return false; } } else // Output is fullScreen { CGDirectDisplayID mainDisplay; CFDictionaryRef refDisplayMode; GDHandle gdhDisplay; // Get the mainDisplay and set resolution to current mainDisplay = CGMainDisplayID(); CGDisplayCapture(mainDisplay); // TOCHECK: not sure whether or not it's necessary to change the resolution // "by hand", or if aglSetFullscreen does the job anyway refDisplayMode = CGDisplayBestModeForParametersAndRefreshRate(mainDisplay, bpp, width, height, refreshrate, NULL); CGDisplaySwitchToMode(mainDisplay, refDisplayMode); DMGetGDeviceByDisplayID((DisplayIDType)mainDisplay, &gdhDisplay, false); // Set pixel format with built attribs // Note: specifying a device is *required* for AGL_FullScreen pixelFormat = qaglChoosePixelFormat(&gdhDisplay, 1, attributes); error = qaglGetError(); if (error != AGL_NO_ERROR) { Con_Printf("qaglChoosePixelFormat FAILED: %s\n", (char *)qaglErrorString(error)); ReleaseWindow(window); return false; } } // Create a context using the pform context = qaglCreateContext(pixelFormat, NULL); error = qaglGetError(); if (error != AGL_NO_ERROR) { Con_Printf("qaglCreateContext FAILED: %s\n", (char *)qaglErrorString(error)); } // Make the context the current one ('enable' it) qaglSetCurrentContext(context); error = qaglGetError(); if (error != AGL_NO_ERROR) { Con_Printf("qaglSetCurrentContext FAILED: %s\n", (char *)qaglErrorString(error)); ReleaseWindow(window); return false; } // Discard pform qaglDestroyPixelFormat(pixelFormat); // Attempt fullscreen if requested if (fullscreen) { qaglSetFullScreen (context, width, height, refreshrate, 0); error = qaglGetError(); if (error != AGL_NO_ERROR) { Con_Printf("qaglSetFullScreen FAILED: %s\n", (char *)qaglErrorString(error)); return false; } } else { // Set Window as Drawable qaglSetDrawable(context, GetWindowPort(window)); error = qaglGetError(); if (error != AGL_NO_ERROR) { Con_Printf("qaglSetDrawable FAILED: %s\n", (char *)qaglErrorString(error)); ReleaseWindow(window); return false; } } scr_width = width; scr_height = height; if ((qglGetString = (const GLubyte* (GLAPIENTRY *)(GLenum name))GL_GetProcAddress("glGetString")) == NULL) Sys_Error("glGetString not found in %s", gl_driver); gl_renderer = (const char *)qglGetString(GL_RENDERER); gl_vendor = (const char *)qglGetString(GL_VENDOR); gl_version = (const char *)qglGetString(GL_VERSION); gl_extensions = (const char *)qglGetString(GL_EXTENSIONS); gl_platform = "AGL"; gl_videosyncavailable = true; vid_isfullscreen = fullscreen; vid_usingmouse = false; vid_hidden = false; vid_activewindow = true; sound_active = true; GL_Init(); SelectWindow(window); ShowWindow(window); return true; } static void Handle_KeyMod(UInt32 keymod) { const struct keymod_to_event_s { UInt32 keybit; keynum_t event; } keymod_events [] = { { cmdKey, K_AUX1 }, { shiftKey, K_SHIFT }, { alphaLock, K_CAPSLOCK }, { optionKey, K_ALT }, { controlKey, K_CTRL }, { kEventKeyModifierNumLockMask, K_NUMLOCK }, { kEventKeyModifierFnMask, K_AUX2 } }; static UInt32 prev_keymod = 0; unsigned int i; UInt32 modChanges; modChanges = prev_keymod ^ keymod; if (modChanges == 0) return; for (i = 0; i < sizeof(keymod_events) / sizeof(keymod_events[0]); i++) { UInt32 keybit = keymod_events[i].keybit; if ((modChanges & keybit) != 0) Key_Event(keymod_events[i].event, '\0', (keymod & keybit) != 0); } prev_keymod = keymod; } static void Handle_Key(unsigned char charcode, qboolean keypressed) { unsigned int keycode = 0; char ascii = '\0'; switch (charcode) { case kHomeCharCode: keycode = K_HOME; break; case kEnterCharCode: keycode = K_KP_ENTER; break; case kEndCharCode: keycode = K_END; break; case kBackspaceCharCode: keycode = K_BACKSPACE; break; case kTabCharCode: keycode = K_TAB; break; case kPageUpCharCode: keycode = K_PGUP; break; case kPageDownCharCode: keycode = K_PGDN; break; case kReturnCharCode: keycode = K_ENTER; break; case kEscapeCharCode: keycode = K_ESCAPE; break; case kLeftArrowCharCode: keycode = K_LEFTARROW; break; case kRightArrowCharCode: keycode = K_RIGHTARROW; break; case kUpArrowCharCode: keycode = K_UPARROW; break; case kDownArrowCharCode : keycode = K_DOWNARROW; break; case kDeleteCharCode: keycode = K_DEL; break; case 0: case 191: // characters 0 and 191 are sent by the mouse buttons (?!) break; default: if ('A' <= charcode && charcode <= 'Z') { keycode = charcode + ('a' - 'A'); // lowercase it ascii = charcode; } else if (charcode >= 32) { keycode = charcode; ascii = charcode; } else Con_Printf(">> UNKNOWN charcode: %d <<\n", charcode); } if (keycode != 0) Key_Event(keycode, ascii, keypressed); } void Sys_SendKeyEvents(void) { EventRef theEvent; EventTargetRef theTarget; // Start by processing the asynchronous events we received since the previous frame VID_ProcessPendingAsyncEvents(); theTarget = GetEventDispatcherTarget(); while (ReceiveNextEvent(0, NULL, kEventDurationNoWait, true, &theEvent) == noErr) { UInt32 eventClass = GetEventClass(theEvent); UInt32 eventKind = GetEventKind(theEvent); switch (eventClass) { case kEventClassMouse: { EventMouseButton theButton; int key; switch (eventKind) { case kEventMouseDown: case kEventMouseUp: GetEventParameter(theEvent, kEventParamMouseButton, typeMouseButton, NULL, sizeof(theButton), NULL, &theButton); switch (theButton) { default: case kEventMouseButtonPrimary: key = K_MOUSE1; break; case kEventMouseButtonSecondary: key = K_MOUSE2; break; case kEventMouseButtonTertiary: key = K_MOUSE3; break; } Key_Event(key, '\0', eventKind == kEventMouseDown); break; // Note: These two events are mutual exclusives // Treat MouseDragged in the same statement, so we don't block MouseMoved while a mousebutton is held case kEventMouseMoved: case kEventMouseDragged: { HIPoint deltaPos; GetEventParameter(theEvent, kEventParamMouseDelta, typeHIPoint, NULL, sizeof(deltaPos), NULL, &deltaPos); mouse_x += deltaPos.x; mouse_y += deltaPos.y; break; } case kEventMouseWheelMoved: { SInt32 delta; unsigned int wheelEvent; GetEventParameter(theEvent, kEventParamMouseWheelDelta, typeSInt32, NULL, sizeof(delta), NULL, &delta); wheelEvent = (delta > 0) ? K_MWHEELUP : K_MWHEELDOWN; Key_Event(wheelEvent, 0, true); Key_Event(wheelEvent, 0, false); break; } default: Con_Printf (">> kEventClassMouse (UNKNOWN eventKind: %d) <<\n", eventKind); break; } } case kEventClassKeyboard: { char keycode; switch (eventKind) { case kEventRawKeyDown: GetEventParameter(theEvent, kEventParamKeyMacCharCodes, typeChar, NULL, sizeof(keycode), NULL, &keycode); Handle_Key(keycode, true); break; case kEventRawKeyRepeat: break; case kEventRawKeyUp: GetEventParameter(theEvent, kEventParamKeyMacCharCodes, typeChar, NULL, sizeof(keycode), NULL, &keycode); Handle_Key(keycode, false); break; case kEventRawKeyModifiersChanged: { UInt32 keymod = 0; GetEventParameter(theEvent, kEventParamKeyModifiers, typeUInt32, NULL, sizeof(keymod), NULL, &keymod); Handle_KeyMod(keymod); break; } case kEventHotKeyPressed: break; case kEventHotKeyReleased: break; case kEventMouseWheelMoved: break; default: Con_Printf (">> kEventClassKeyboard (UNKNOWN eventKind: %d) <<\n", eventKind); break; } break; } case kEventClassTextInput: Con_Printf(">> kEventClassTextInput (%d) <<\n", eventKind); break; case kEventClassApplication: switch (eventKind) { case kEventAppActivated : VID_AppFocusChanged(true); break; case kEventAppDeactivated: VID_AppFocusChanged(false); break; case kEventAppQuit: Sys_Quit(); break; case kEventAppActiveWindowChanged: break; default: Con_Printf(">> kEventClassApplication (UNKNOWN eventKind: %d) <<\n", eventKind); break; } break; case kEventClassAppleEvent: switch (eventKind) { case kEventAppleEvent : break; default: Con_Printf(">> kEventClassAppleEvent (UNKNOWN eventKind: %d) <<\n", eventKind); break; } break; case kEventClassWindow: switch (eventKind) { case kEventWindowUpdate : break; default: Con_Printf(">> kEventClassWindow (UNKNOWN eventKind: %d) <<\n", eventKind); break; } break; case kEventClassControl: break; default: /*Con_Printf(">> UNKNOWN eventClass: %c%c%c%c, eventKind: %d <<\n", eventClass >> 24, (eventClass >> 16) & 0xFF, (eventClass >> 8) & 0xFF, eventClass & 0xFF, eventKind);*/ break; } SendEventToEventTarget (theEvent, theTarget); ReleaseEvent(theEvent); } } void IN_Move (void) { if (mouse_avail) { in_mouse_x = mouse_x; in_mouse_y = mouse_y; } mouse_x = 0; mouse_y = 0; }