vid_sdl.c

   1 /*
   2 Copyright (C) 2003  T. Joseph Carter
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18 */
  19 #undef WIN32_LEAN_AND_MEAN  //hush a warning, SDL.h redefines this
  20 #include <SDL.h>
  21 #include <stdio.h>
  22
  23 #include "quakedef.h"
  24
  25 // Tell startup code that we have a client
  26 int cl_available = true;
  27
  28 qboolean vid_supportrefreshrate = false;
  29
  30 static qboolean vid_usingmouse;
  31 static qboolean vid_isfullscreen;
  32
  33 static SDL_Surface *screen;
  34
  35 /////////////////////////
  36 // Input handling
  37 ////
  38 //TODO: Add joystick support
  39 //TODO: Add error checking
  40
  41
  42 //keysym to quake keysym mapping
  43 #define tenoh   0,0,0,0,0, 0,0,0,0,0
  44 #define fiftyoh tenoh, tenoh, tenoh, tenoh, tenoh
  45 #define hundredoh fiftyoh, fiftyoh
  46 static unsigned int tbl_sdltoquake[] =
  47 {
  48         0,0,0,0,                //SDLK_UNKNOWN          = 0,
  49         0,0,0,0,                //SDLK_FIRST            = 0,
  50         K_BACKSPACE,    //SDLK_BACKSPACE        = 8,
  51         K_TAB,                  //SDLK_TAB                      = 9,
  52         0,0,
  53         0,                              //SDLK_CLEAR            = 12,
  54         K_ENTER,                //SDLK_RETURN           = 13,
  55     0,0,0,0,0,
  56         K_PAUSE,                //SDLK_PAUSE            = 19,
  57         0,0,0,0,0,0,0,
  58         K_ESCAPE,               //SDLK_ESCAPE           = 27,
  59         0,0,0,0,
  60         K_SPACE,                //SDLK_SPACE            = 32,
  61         '!',                    //SDLK_EXCLAIM          = 33,
  62         '"',                    //SDLK_QUOTEDBL         = 34,
  63         '#',                    //SDLK_HASH                     = 35,
  64         '$',                    //SDLK_DOLLAR           = 36,
  65         0,
  66         '&',                    //SDLK_AMPERSAND        = 38,
  67         '\'',                   //SDLK_QUOTE            = 39,
  68         '(',                    //SDLK_LEFTPAREN        = 40,
  69         ')',                    //SDLK_RIGHTPAREN       = 41,
  70         '*',                    //SDLK_ASTERISK         = 42,
  71         '+',                    //SDLK_PLUS                     = 43,
  72         ',',                    //SDLK_COMMA            = 44,
  73         '-',                    //SDLK_MINUS            = 45,
  74         '.',                    //SDLK_PERIOD           = 46,
  75         '/',                    //SDLK_SLASH            = 47,
  76         '0',                    //SDLK_0                        = 48,
  77         '1',                    //SDLK_1                        = 49,
  78         '2',                    //SDLK_2                        = 50,
  79         '3',                    //SDLK_3                        = 51,
  80         '4',                    //SDLK_4                        = 52,
  81         '5',                    //SDLK_5                        = 53,
  82         '6',                    //SDLK_6                        = 54,
  83         '7',                    //SDLK_7                        = 55,
  84         '8',                    //SDLK_8                        = 56,
  85         '9',                    //SDLK_9                        = 57,
  86         ':',                    //SDLK_COLON            = 58,
  87         ';',                    //SDLK_SEMICOLON        = 59,
  88         '<',                    //SDLK_LESS                     = 60,
  89         '=',                    //SDLK_EQUALS           = 61,
  90         '>',                    //SDLK_GREATER          = 62,
  91         '?',                    //SDLK_QUESTION         = 63,
  92         '@',                    //SDLK_AT                       = 64,
  93         0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
  94         '[',            //SDLK_LEFTBRACKET      = 91,
  95         '\\',           //SDLK_BACKSLASH        = 92,
  96         ']',            //SDLK_RIGHTBRACKET     = 93,
  97         '^',            //SDLK_CARET            = 94,
  98         '_',            //SDLK_UNDERSCORE       = 95,
  99         '`',            //SDLK_BACKQUOTE        = 96,
 100         'a',            //SDLK_a                        = 97,
 101         'b',            //SDLK_b                        = 98,
 102         'c',            //SDLK_c                        = 99,
 103         'd',            //SDLK_d                        = 100,
 104         'e',            //SDLK_e                        = 101,
 105         'f',            //SDLK_f                        = 102,
 106         'g',            //SDLK_g                        = 103,
 107         'h',            //SDLK_h                        = 104,
 108         'i',            //SDLK_i                        = 105,
 109         'j',            //SDLK_j                        = 106,
 110         'k',            //SDLK_k                        = 107,
 111         'l',            //SDLK_l                        = 108,
 112         'm',            //SDLK_m                        = 109,
 113         'n',            //SDLK_n                        = 110,
 114         'o',            //SDLK_o                        = 111,
 115         'p',            //SDLK_p                        = 112,
 116         'q',            //SDLK_q                        = 113,
 117         'r',            //SDLK_r                        = 114,
 118         's',            //SDLK_s                        = 115,
 119         't',            //SDLK_t                        = 116,
 120         'u',            //SDLK_u                        = 117,
 121         'v',            //SDLK_v                        = 118,
 122         'w',            //SDLK_w                        = 119,
 123         'x',            //SDLK_x                        = 120,
 124         'y',            //SDLK_y                        = 121,
 125         'z',            //SDLK_z                        = 122,
 126         0,0,0,0,
 127         K_DEL,          //SDLK_DELETE           = 127,
 128         hundredoh /*227*/, tenoh, tenoh, 0,0,0,0,0,0,0,0,
 129         K_KP_0,         //SDLK_KP0              = 256,
 130         K_KP_1,         //SDLK_KP1              = 257,
 131         K_KP_2,         //SDLK_KP2              = 258,
 132         K_KP_3,         //SDLK_KP3              = 259,
 133         K_KP_4,         //SDLK_KP4              = 260,
 134         K_KP_5,         //SDLK_KP5              = 261,
 135         K_KP_6,         //SDLK_KP6              = 262,
 136         K_KP_7,         //SDLK_KP7              = 263,
 137         K_KP_8,         //SDLK_KP8              = 264,
 138         K_KP_9,         //SDLK_KP9              = 265,
 139         K_KP_PERIOD,//SDLK_KP_PERIOD    = 266,
 140         K_KP_DIVIDE,//SDLK_KP_DIVIDE    = 267,
 141         K_KP_MULTIPLY,//SDLK_KP_MULTIPLY= 268,
 142         K_KP_MINUS,     //SDLK_KP_MINUS         = 269,
 143         K_KP_PLUS,      //SDLK_KP_PLUS          = 270,
 144         K_KP_ENTER,     //SDLK_KP_ENTER         = 271,
 145         K_KP_EQUALS,//SDLK_KP_EQUALS    = 272,
 146         K_UPARROW,      //SDLK_UP               = 273,
 147         K_DOWNARROW,//SDLK_DOWN         = 274,
 148         K_RIGHTARROW,//SDLK_RIGHT       = 275,
 149         K_LEFTARROW,//SDLK_LEFT         = 276,
 150         K_INS,          //SDLK_INSERT   = 277,
 151         K_HOME,         //SDLK_HOME             = 278,
 152         K_END,          //SDLK_END              = 279,
 153         K_PGUP,         //SDLK_PAGEUP   = 280,
 154         K_PGDN,         //SDLK_PAGEDOWN = 281,
 155         K_F1,           //SDLK_F1               = 282,
 156         K_F2,           //SDLK_F2               = 283,
 157         K_F3,           //SDLK_F3               = 284,
 158         K_F4,           //SDLK_F4               = 285,
 159         K_F5,           //SDLK_F5               = 286,
 160         K_F6,           //SDLK_F6               = 287,
 161         K_F7,           //SDLK_F7               = 288,
 162         K_F8,           //SDLK_F8               = 289,
 163         K_F9,           //SDLK_F9               = 290,
 164         K_F10,          //SDLK_F10              = 291,
 165         K_F11,          //SDLK_F11              = 292,
 166         K_F12,          //SDLK_F12              = 293,
 167         0,                      //SDLK_F13              = 294,
 168         0,                      //SDLK_F14              = 295,
 169         0,                      //SDLK_F15              = 296,
 170         0,0,0,
 171         K_NUMLOCK,      //SDLK_NUMLOCK  = 300,
 172         K_CAPSLOCK,     //SDLK_CAPSLOCK = 301,
 173         K_SCROLLOCK,//SDLK_SCROLLOCK= 302,
 174         K_SHIFT,        //SDLK_RSHIFT   = 303,
 175         K_SHIFT,        //SDLK_LSHIFT   = 304,
 176         K_CTRL,         //SDLK_RCTRL    = 305,
 177         K_CTRL,         //SDLK_LCTRL    = 306,
 178         K_ALT,          //SDLK_RALT             = 307,
 179         K_ALT,          //SDLK_LALT             = 308,
 180         0,                      //SDLK_RMETA    = 309,
 181         0,                      //SDLK_LMETA    = 310,
 182         0,                      //SDLK_LSUPER   = 311,          /* Left "Windows" key */
 183         0,                      //SDLK_RSUPER   = 312,          /* Right "Windows" key */
 184         K_ALT,                  //SDLK_MODE             = 313,          /* "Alt Gr" key */
 185         0,                      //SDLK_COMPOSE  = 314,          /* Multi-key compose key */
 186         0,                      //SDLK_HELP             = 315,
 187         0,                      //SDLK_PRINT    = 316,
 188         0,                      //SDLK_SYSREQ   = 317,
 189         K_PAUSE,        //SDLK_BREAK    = 318,
 190         0,                      //SDLK_MENU             = 319,
 191         0,                      //SDLK_POWER    = 320,          /* Power Macintosh power key */
 192         'e',            //SDLK_EURO             = 321,          /* Some european keyboards */
 193         0                       //SDLK_UNDO             = 322,          /* Atari keyboard has Undo */
 194 };
 195 #undef tenoh
 196 #undef fiftyoh
 197 #undef hundredoh
 198
 199 static int MapKey( unsigned int sdlkey )
 200 {
 201         if( sdlkey > sizeof(tbl_sdltoquake)/ sizeof(int) )
 202                 return 0;
 203     return tbl_sdltoquake[ sdlkey ];
 204 }
 205
 206 static void IN_Activate( qboolean grab )
 207 {
 208         if (grab)
 209         {
 210                 if (!vid_usingmouse)
 211                 {
 212                         vid_usingmouse = true;
 213                         cl_ignoremousemove = true;
 214                         SDL_WM_GrabInput( SDL_GRAB_ON );
 215                         SDL_ShowCursor( SDL_DISABLE );
 216                 }
 217         }
 218         else
 219         {
 220                 if (vid_usingmouse)
 221                 {
 222                         vid_usingmouse = false;
 223                         cl_ignoremousemove = true;
 224                         SDL_WM_GrabInput( SDL_GRAB_OFF );
 225                         SDL_ShowCursor( SDL_ENABLE );
 226                 }
 227         }
 228 }
 229
 230 void IN_Move( void )
 231 {
 232         if( vid_usingmouse )
 233         {
 234                 int x, y;
 235                 SDL_GetRelativeMouseState( &x, &y );
 236                 in_mouse_x = x;
 237                 in_mouse_y = y;
 238         }
 239 }
 240
 241 /////////////////////
 242 // Message Handling
 243 ////
 244
 245 static int Sys_EventFilter( SDL_Event *event )
 246 {
 247         //TODO: Add a quit query in linux, too - though linux user are more likely to know what they do
 248 #ifdef WIN32
 249         if( event->type == SDL_QUIT && MessageBox( NULL, "Are you sure you want to quit?", "Confirm Exit", MB_YESNO | MB_SETFOREGROUND | MB_ICONQUESTION ) == IDNO )
 250                 return 0;
 251         else
 252                 return 1;
 253 #else
 254         return 1;
 255 #endif
 256 }
 257
 258 static keynum_t buttonremap[18] =
 259 {
 260         K_MOUSE1,
 261         K_MOUSE3,
 262         K_MOUSE2,
 263         K_MWHEELUP,
 264         K_MWHEELDOWN,
 265         K_MOUSE4,
 266         K_MOUSE5,
 267         K_MOUSE6,
 268         K_MOUSE7,
 269         K_MOUSE8,
 270         K_MOUSE9,
 271         K_MOUSE10,
 272         K_MOUSE11,
 273         K_MOUSE12,
 274         K_MOUSE13,
 275         K_MOUSE14,
 276         K_MOUSE15,
 277         K_MOUSE16,
 278 };
 279
 280 void Sys_SendKeyEvents( void )
 281 {
 282         SDL_Event event;
 283
 284         while( SDL_PollEvent( &event ) )
 285                 switch( event.type ) {
 286                         case SDL_QUIT:
 287                                 Sys_Quit();
 288                                 break;
 289                         case SDL_KEYDOWN:
 290                         case SDL_KEYUP:
 291                                 Key_Event( MapKey( event.key.keysym.sym ), (char)event.key.keysym.unicode, (event.key.state == SDL_PRESSED) );
 292                                 break;
 293                         case SDL_ACTIVEEVENT:
 294                                 if( event.active.state == SDL_APPACTIVE )
 295                                 {
 296                                         if( event.active.gain )
 297                                                 vid_hidden = false;
 298                                         else
 299                                                 vid_hidden = true;
 300                                 }
 301                                 break;
 302                         case SDL_MOUSEBUTTONDOWN:
 303                                 if (event.button.button <= 18)
 304                                         Key_Event( buttonremap[event.button.button - 1], 0, true );
 305                                 break;
 306                         case SDL_MOUSEBUTTONUP:
 307                                 if (event.button.button <= 18)
 308                                         Key_Event( buttonremap[event.button.button - 1], 0, false );
 309                                 break;
 310                 }
 311 }
 312
 313 /////////////////
 314 // Video system
 315 ////
 316
 317 void *GL_GetProcAddress(const char *name)
 318 {
 319         void *p = NULL;
 320         p = SDL_GL_GetProcAddress(name);
 321         return p;
 322 }
 323
 324 static int Sys_EventFilter( SDL_Event *event );
 325 void VID_Init (void)
 326 {
 327         if (SDL_Init(SDL_INIT_VIDEO) < 0)
 328                 Sys_Error ("Failed to init video: %s", SDL_GetError());
 329         vid_isfullscreen = false;
 330 }
 331
 332 // set the icon (we dont use SDL here since it would be too much a PITA)
 333 #ifdef WIN32
 334 #include "resource.h"
 335 #include <SDL_syswm.h>
 336 static void VID_SetCaption()
 337 {
 338     SDL_SysWMinfo       info;
 339         HICON                   icon;
 340
 341         // set the caption
 342         SDL_WM_SetCaption( gamename, NULL );
 343
 344         // get the HWND handle
 345     SDL_VERSION( &info.version );
 346         if( !SDL_GetWMInfo( &info ) )
 347                 return;
 348
 349         icon = LoadIcon( GetModuleHandle( NULL ), MAKEINTRESOURCE( IDI_ICON1 ) );
 350 #ifndef _W64 //If Windows 64bit data types don't exist
 351 #define SetClassLongPtr SetClassLong
 352 #define GCLP_HICON GCL_HICON
 353 #define LONG_PTR LONG
 354 #endif
 355         SetClassLongPtr( info.window, GCLP_HICON, (LONG_PTR)icon );
 356 }
 357 #else
 358 static void VID_SetCaption()
 359 {
 360         SDL_WM_SetCaption( gamename, NULL );
 361 }
 362 #endif
 363
 364 static void VID_OutputVersion()
 365 {
 366         const SDL_version *version;
 367         version = SDL_Linked_Version();
 368         Con_Printf(     "Linked against SDL version %d.%d.%d\n"
 369                                         "Using SDL library version %d.%d.%d\n",
 370                                         SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL,
 371                                         version->major, version->minor, version->patch );
 372 }
 373
 374 int VID_InitMode(int fullscreen, int width, int height, int bpp, int refreshrate)
 375 {
 376         int i;
 377         int flags = SDL_OPENGL;
 378         const char *drivername;
 379
 380         VID_OutputVersion();
 381
 382         /*
 383         SDL Hack
 384                 We cant switch from one OpenGL video mode to another.
 385                 Thus we first switch to some stupid 2D mode and then back to OpenGL.
 386         */
 387         SDL_SetVideoMode( 0, 0, 0, 0 );
 388
 389         // SDL usually knows best
 390         drivername = NULL;
 391
 392 // COMMANDLINEOPTION: SDL GL: -gl_driver <drivername> selects a GL driver library, default is whatever SDL recommends, useful only for 3dfxogl.dll/3dfxvgl.dll or fxmesa or similar, if you don't know what this is for, you don't need it
 393         i = COM_CheckParm("-gl_driver");
 394         if (i && i < com_argc - 1)
 395                 drivername = com_argv[i + 1];
 396         if (SDL_GL_LoadLibrary(drivername) < 0)
 397         {
 398                 Con_Printf("Unable to load GL driver \"%s\": %s\n", drivername, SDL_GetError());
 399                 return false;
 400         }
 401
 402         if ((qglGetString = (const GLubyte* (GLAPIENTRY *)(GLenum name))GL_GetProcAddress("glGetString")) == NULL)
 403         {
 404                 VID_Shutdown();
 405                 Con_Print("Required OpenGL function glGetString not found\n");
 406                 return false;
 407         }
 408
 409         // Knghtbrd: should do platform-specific extension string function here
 410
 411         vid_isfullscreen = false;
 412         if (fullscreen) {
 413                 flags |= SDL_FULLSCREEN;
 414                 vid_isfullscreen = true;
 415         }
 416
 417         SDL_GL_SetAttribute (SDL_GL_DOUBLEBUFFER, 1);
 418         if (bpp >= 32)
 419         {
 420                 SDL_GL_SetAttribute (SDL_GL_RED_SIZE, 8);
 421                 SDL_GL_SetAttribute (SDL_GL_GREEN_SIZE, 8);
 422                 SDL_GL_SetAttribute (SDL_GL_BLUE_SIZE, 8);
 423                 SDL_GL_SetAttribute (SDL_GL_ALPHA_SIZE, 8);
 424                 SDL_GL_SetAttribute (SDL_GL_DEPTH_SIZE, 24);
 425                 SDL_GL_SetAttribute (SDL_GL_STENCIL_SIZE, 8);
 426         }
 427         else
 428         {
 429                 SDL_GL_SetAttribute (SDL_GL_RED_SIZE, 1);
 430                 SDL_GL_SetAttribute (SDL_GL_GREEN_SIZE, 1);
 431                 SDL_GL_SetAttribute (SDL_GL_BLUE_SIZE, 1);
 432                 SDL_GL_SetAttribute (SDL_GL_DEPTH_SIZE, 16);
 433         }
 434
 435         screen = SDL_SetVideoMode(width, height, bpp, flags);
 436         if (screen == NULL)
 437         {
 438                 Con_Printf("Failed to set video mode to %ix%i: %s\n", width, height, SDL_GetError);
 439                 VID_Shutdown();
 440                 return false;
 441         }
 442
 443         // set window title
 444         VID_SetCaption();
 445         // set up an event filter to ask confirmation on close button in WIN32
 446         SDL_SetEventFilter( (SDL_EventFilter) Sys_EventFilter );
 447         // init keyboard
 448         SDL_EnableUNICODE( SDL_ENABLE );
 449         // enable key repeat since everyone expects it
 450         SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
 451
 452         gl_renderer = (const char *)qglGetString(GL_RENDERER);
 453         gl_vendor = (const char *)qglGetString(GL_VENDOR);
 454         gl_version = (const char *)qglGetString(GL_VERSION);
 455         gl_extensions = (const char *)qglGetString(GL_EXTENSIONS);
 456         gl_platform = "SDL";
 457         // Knghtbrd: should assign platform-specific extensions here
 458         //TODO: maybe ;)
 459         gl_platformextensions = "";
 460         gl_videosyncavailable = false;
 461
 462         GL_Init();
 463
 464         vid_hidden = false;
 465         vid_activewindow = false;
 466         vid_usingmouse = false;
 467         return true;
 468 }
 469
 470 void VID_Shutdown (void)
 471 {
 472         IN_Activate(false);
 473         SDL_QuitSubSystem(SDL_INIT_VIDEO);
 474 }
 475
 476 int VID_SetGamma (unsigned short *ramps, int rampsize)
 477 {
 478         return !SDL_SetGammaRamp (ramps, ramps + rampsize, ramps + rampsize*2);
 479 }
 480
 481 int VID_GetGamma (unsigned short *ramps, int rampsize)
 482 {
 483         return !SDL_GetGammaRamp (ramps, ramps + rampsize, ramps + rampsize*2);
 484 }
 485
 486 void VID_Finish (qboolean allowmousegrab)
 487 {
 488         Uint8 appstate;
 489         qboolean vid_usemouse;
 490
 491         CHECKGLERROR
 492         if (r_speeds.integer || gl_finish.integer)
 493         {
 494                 qglFinish();CHECKGLERROR
 495         }
 496         SDL_GL_SwapBuffers();
 497
 498         //react on appstate changes
 499         appstate = SDL_GetAppState();
 500
 501         vid_hidden = !(appstate & SDL_APPACTIVE);
 502
 503         if( vid_hidden || !( appstate & SDL_APPMOUSEFOCUS ) || !( appstate & SDL_APPINPUTFOCUS ) )
 504                 vid_activewindow = false;
 505         else
 506                 vid_activewindow = true;
 507
 508         vid_usemouse = false;
 509         if( allowmousegrab && vid_mouse.integer && !key_consoleactive && (key_dest != key_game || !cls.demoplayback) )
 510                 vid_usemouse = true;
 511         if( vid_isfullscreen )
 512                 vid_usemouse = true;
 513         if( !vid_activewindow )
 514                 vid_usemouse = false;
 515
 516         IN_Activate(vid_usemouse);
 517
 518         VID_UpdateGamma(false, 256);
 519 }