changed VID_Finish to take an allowmousegrab parameter, this avoids mousegrab on...
[divverent/darkplaces.git] / 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 #include <SDL.h>
20 #include <stdio.h>
21
22 #include "quakedef.h"
23
24 // Tell startup code that we have a client
25 int cl_available = true;
26
27 qboolean vid_supportrefreshrate = false;
28
29 static qboolean vid_usingmouse;
30 static qboolean vid_isfullscreen;
31
32 static SDL_Surface *screen;
33
34 /////////////////////////
35 // Input handling
36 ////
37 //TODO: Add joystick support
38 //TODO: Add error checking
39
40
41 //keysym to quake keysym mapping
42 #define tenoh   0,0,0,0,0, 0,0,0,0,0
43 #define fiftyoh tenoh, tenoh, tenoh, tenoh, tenoh
44 #define hundredoh fiftyoh, fiftyoh
45 static unsigned int tbl_sdltoquake[] =
46 {
47         0,0,0,0,                //SDLK_UNKNOWN          = 0,
48         0,0,0,0,                //SDLK_FIRST            = 0,
49         K_BACKSPACE,    //SDLK_BACKSPACE        = 8,
50         K_TAB,                  //SDLK_TAB                      = 9,
51         0,0,
52         0,                              //SDLK_CLEAR            = 12,
53         K_ENTER,                //SDLK_RETURN           = 13,
54     0,0,0,0,0,
55         K_PAUSE,                //SDLK_PAUSE            = 19,
56         0,0,0,0,0,0,0,
57         K_ESCAPE,               //SDLK_ESCAPE           = 27,
58         0,0,0,0,
59         K_SPACE,                //SDLK_SPACE            = 32,
60         '!',                    //SDLK_EXCLAIM          = 33,
61         '"',                    //SDLK_QUOTEDBL         = 34,
62         '#',                    //SDLK_HASH                     = 35,
63         '$',                    //SDLK_DOLLAR           = 36,
64         0,
65         '&',                    //SDLK_AMPERSAND        = 38,
66         '\'',                   //SDLK_QUOTE            = 39,
67         '(',                    //SDLK_LEFTPAREN        = 40,
68         ')',                    //SDLK_RIGHTPAREN       = 41,
69         '*',                    //SDLK_ASTERISK         = 42,
70         '+',                    //SDLK_PLUS                     = 43,
71         ',',                    //SDLK_COMMA            = 44,
72         '-',                    //SDLK_MINUS            = 45,
73         '.',                    //SDLK_PERIOD           = 46,
74         '/',                    //SDLK_SLASH            = 47,
75         '0',                    //SDLK_0                        = 48,
76         '1',                    //SDLK_1                        = 49,
77         '2',                    //SDLK_2                        = 50,
78         '3',                    //SDLK_3                        = 51,
79         '4',                    //SDLK_4                        = 52,
80         '5',                    //SDLK_5                        = 53,
81         '6',                    //SDLK_6                        = 54,
82         '7',                    //SDLK_7                        = 55,
83         '8',                    //SDLK_8                        = 56,
84         '9',                    //SDLK_9                        = 57,
85         ':',                    //SDLK_COLON            = 58,
86         ';',                    //SDLK_SEMICOLON        = 59,
87         '<',                    //SDLK_LESS                     = 60,
88         '=',                    //SDLK_EQUALS           = 61,
89         '>',                    //SDLK_GREATER          = 62,
90         '?',                    //SDLK_QUESTION         = 63,
91         '@',                    //SDLK_AT                       = 64,
92         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,
93         '[',            //SDLK_LEFTBRACKET      = 91,
94         '\\',           //SDLK_BACKSLASH        = 92,
95         ']',            //SDLK_RIGHTBRACKET     = 93,
96         '^',            //SDLK_CARET            = 94,
97         '_',            //SDLK_UNDERSCORE       = 95,
98         '`',            //SDLK_BACKQUOTE        = 96,
99         'a',            //SDLK_a                        = 97,
100         'b',            //SDLK_b                        = 98,
101         'c',            //SDLK_c                        = 99,
102         'd',            //SDLK_d                        = 100,
103         'e',            //SDLK_e                        = 101,
104         'f',            //SDLK_f                        = 102,
105         'g',            //SDLK_g                        = 103,
106         'h',            //SDLK_h                        = 104,
107         'i',            //SDLK_i                        = 105,
108         'j',            //SDLK_j                        = 106,
109         'k',            //SDLK_k                        = 107,
110         'l',            //SDLK_l                        = 108,
111         'm',            //SDLK_m                        = 109,
112         'n',            //SDLK_n                        = 110,
113         'o',            //SDLK_o                        = 111,
114         'p',            //SDLK_p                        = 112,
115         'q',            //SDLK_q                        = 113,
116         'r',            //SDLK_r                        = 114,
117         's',            //SDLK_s                        = 115,
118         't',            //SDLK_t                        = 116,
119         'u',            //SDLK_u                        = 117,
120         'v',            //SDLK_v                        = 118,
121         'w',            //SDLK_w                        = 119,
122         'x',            //SDLK_x                        = 120,
123         'y',            //SDLK_y                        = 121,
124         'z',            //SDLK_z                        = 122,
125         0,0,0,0,
126         K_DEL,          //SDLK_DELETE           = 127,
127         hundredoh /*227*/, tenoh, tenoh, 0,0,0,0,0,0,0,0,
128         K_KP_0,         //SDLK_KP0              = 256,
129         K_KP_1,         //SDLK_KP1              = 257,
130         K_KP_2,         //SDLK_KP2              = 258,
131         K_KP_3,         //SDLK_KP3              = 259,
132         K_KP_4,         //SDLK_KP4              = 260,
133         K_KP_5,         //SDLK_KP5              = 261,
134         K_KP_6,         //SDLK_KP6              = 262,
135         K_KP_7,         //SDLK_KP7              = 263,
136         K_KP_8,         //SDLK_KP8              = 264,
137         K_KP_9,         //SDLK_KP9              = 265,
138         K_KP_PERIOD,//SDLK_KP_PERIOD    = 266,
139         K_KP_DIVIDE,//SDLK_KP_DIVIDE    = 267,
140         K_KP_MULTIPLY,//SDLK_KP_MULTIPLY= 268,
141         K_KP_MINUS,     //SDLK_KP_MINUS         = 269,
142         K_KP_PLUS,      //SDLK_KP_PLUS          = 270,
143         K_KP_ENTER,     //SDLK_KP_ENTER         = 271,
144         K_KP_EQUALS,//SDLK_KP_EQUALS    = 272,
145         K_UPARROW,      //SDLK_UP               = 273,
146         K_DOWNARROW,//SDLK_DOWN         = 274,
147         K_RIGHTARROW,//SDLK_RIGHT       = 275,
148         K_LEFTARROW,//SDLK_LEFT         = 276,
149         K_INS,          //SDLK_INSERT   = 277,
150         K_HOME,         //SDLK_HOME             = 278,
151         K_END,          //SDLK_END              = 279,
152         K_PGUP,         //SDLK_PAGEUP   = 280,
153         K_PGDN,         //SDLK_PAGEDOWN = 281,
154         K_F1,           //SDLK_F1               = 282,
155         K_F2,           //SDLK_F2               = 283,
156         K_F3,           //SDLK_F3               = 284,
157         K_F4,           //SDLK_F4               = 285,
158         K_F5,           //SDLK_F5               = 286,
159         K_F6,           //SDLK_F6               = 287,
160         K_F7,           //SDLK_F7               = 288,
161         K_F8,           //SDLK_F8               = 289,
162         K_F9,           //SDLK_F9               = 290,
163         K_F10,          //SDLK_F10              = 291,
164         K_F11,          //SDLK_F11              = 292,
165         K_F12,          //SDLK_F12              = 293,
166         0,                      //SDLK_F13              = 294,
167         0,                      //SDLK_F14              = 295,
168         0,                      //SDLK_F15              = 296,
169         0,0,0,
170         K_NUMLOCK,      //SDLK_NUMLOCK  = 300,
171         K_CAPSLOCK,     //SDLK_CAPSLOCK = 301,
172         K_SCROLLOCK,//SDLK_SCROLLOCK= 302,
173         K_SHIFT,        //SDLK_RSHIFT   = 303,
174         K_SHIFT,        //SDLK_LSHIFT   = 304,
175         K_CTRL,         //SDLK_RCTRL    = 305,
176         K_CTRL,         //SDLK_LCTRL    = 306,
177         K_ALT,          //SDLK_RALT             = 307,
178         K_ALT,          //SDLK_LALT             = 308,
179         0,                      //SDLK_RMETA    = 309,
180         0,                      //SDLK_LMETA    = 310,
181         0,                      //SDLK_LSUPER   = 311,          /* Left "Windows" key */
182         0,                      //SDLK_RSUPER   = 312,          /* Right "Windows" key */
183         0,                      //SDLK_MODE             = 313,          /* "Alt Gr" key */
184         0,                      //SDLK_COMPOSE  = 314,          /* Multi-key compose key */
185         0,                      //SDLK_HELP             = 315,
186         0,                      //SDLK_PRINT    = 316,
187         0,                      //SDLK_SYSREQ   = 317,
188         K_PAUSE,        //SDLK_BREAK    = 318,
189         0,                      //SDLK_MENU             = 319,
190         0,                      //SDLK_POWER    = 320,          /* Power Macintosh power key */
191         'e',            //SDLK_EURO             = 321,          /* Some european keyboards */
192         0                       //SDLK_UNDO             = 322,          /* Atari keyboard has Undo */
193 };
194 #undef tenoh
195 #undef fiftyoh
196 #undef hundredoh
197
198 static int MapKey( unsigned int sdlkey )
199 {
200         if( sdlkey > sizeof(tbl_sdltoquake)/ sizeof(int) )
201                 return 0;
202     return tbl_sdltoquake[ sdlkey ];
203 }
204
205 static void IN_Activate( qboolean grab )
206 {
207         if (grab)
208         {
209                 if (!vid_usingmouse)
210                 {
211                         vid_usingmouse = true;
212                         cl_ignoremousemove = true;
213                         SDL_WM_GrabInput( SDL_GRAB_ON );
214                         SDL_ShowCursor( SDL_DISABLE );
215                 }
216         }
217         else
218         {
219                 if (vid_usingmouse)
220                 {
221                         vid_usingmouse = false;
222                         cl_ignoremousemove = true;
223                         SDL_WM_GrabInput( SDL_GRAB_OFF );
224                         SDL_ShowCursor( SDL_ENABLE );
225                 }
226         }
227 }
228
229 void IN_Move( void )
230 {
231         if( vid_usingmouse )
232         {
233                 int x, y;
234                 SDL_GetRelativeMouseState( &x, &y );
235                 in_mouse_x = x;
236                 in_mouse_y = y;
237         }
238 }
239
240 /////////////////////
241 // Message Handling
242 ////
243
244 static int Sys_EventFilter( SDL_Event *event )
245 {
246         //TODO: Add a quit query in linux, too - though linux user are more likely to know what they do
247 #ifdef WIN32
248         if( event->type == SDL_QUIT && MessageBox( NULL, "Are you sure you want to quit?", "Confirm Exit", MB_YESNO | MB_SETFOREGROUND | MB_ICONQUESTION ) == IDNO )
249                 return 0;
250         else
251                 return 1;
252 #else
253         return 1;
254 #endif
255 }
256
257 static keynum_t buttonremap[18] =
258 {
259         K_MOUSE1,
260         K_MOUSE3,
261         K_MOUSE2,
262         K_MWHEELUP,
263         K_MWHEELDOWN,
264         K_MOUSE4,
265         K_MOUSE5,
266         K_MOUSE6,
267         K_MOUSE7,
268         K_MOUSE8,
269         K_MOUSE9,
270         K_MOUSE10,
271         K_MOUSE11,
272         K_MOUSE12,
273         K_MOUSE13,
274         K_MOUSE14,
275         K_MOUSE15,
276         K_MOUSE16,
277 };
278
279 void Sys_SendKeyEvents( void )
280 {
281         SDL_Event event;
282
283         while( SDL_PollEvent( &event ) )
284                 switch( event.type ) {
285                         case SDL_QUIT:
286                                 Sys_Quit();
287                                 break;
288                         case SDL_KEYDOWN:
289                         case SDL_KEYUP:
290                                 Key_Event( MapKey( event.key.keysym.sym ), (char)event.key.keysym.unicode, (event.key.state == SDL_PRESSED) );
291                                 break;
292                         case SDL_ACTIVEEVENT:
293                                 if( event.active.state == SDL_APPACTIVE )
294                                 {
295                                         if( event.active.gain )
296                                                 vid_hidden = false;
297                                         else
298                                                 vid_hidden = true;
299                                 }
300                                 break;
301                         case SDL_MOUSEBUTTONDOWN:
302                                 if (event.button.button <= 18)
303                                         Key_Event( buttonremap[event.button.button - 1], 0, true );
304                                 break;
305                         case SDL_MOUSEBUTTONUP:
306                                 if (event.button.button <= 18)
307                                         Key_Event( buttonremap[event.button.button - 1], 0, false );
308                                 break;
309                 }
310 }
311
312 /////////////////
313 // Video system
314 ////
315
316 void *GL_GetProcAddress(const char *name)
317 {
318         void *p = NULL;
319         p = SDL_GL_GetProcAddress(name);
320         return p;
321 }
322
323 static int Sys_EventFilter( SDL_Event *event );
324 void VID_Init (void)
325 {
326         if (SDL_Init(SDL_INIT_VIDEO) < 0)
327                 Sys_Error ("Failed to init video: %s", SDL_GetError());
328         vid_isfullscreen = false;
329 }
330
331 // set the icon (we dont use SDL here since it would be too much a PITA)
332 #ifdef WIN32
333 #include "resource.h"
334 #include <SDL_syswm.h>
335 static void VID_SetCaption()
336 {
337     SDL_SysWMinfo       info;
338         HICON                   icon;
339
340         // set the caption
341         SDL_WM_SetCaption( gamename, NULL );
342
343         // get the HWND handle
344     SDL_VERSION( &info.version );
345         if( !SDL_GetWMInfo( &info ) )
346                 return;
347
348         icon = LoadIcon( GetModuleHandle( NULL ), MAKEINTRESOURCE( IDI_ICON1 ) );
349 #ifndef SetClassLongPtr
350 #define SetClassLongPtr SetClassLong
351 #endif
352 #ifndef GCLP_HICON
353 #define GCLP_HICON GCL_HICON
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)
477 {
478         return !SDL_SetGammaRamp (ramps, ramps + 256, ramps + 512);
479 }
480
481 int VID_GetGamma (unsigned short *ramps)
482 {
483         return !SDL_GetGammaRamp( ramps, ramps + 256, ramps + 512);
484 }
485
486 void VID_Finish (qboolean allowmousegrab)
487 {
488         Uint8 appstate;
489         qboolean vid_usemouse;
490
491         if (r_speeds.integer || gl_finish.integer)
492                 qglFinish();
493         SDL_GL_SwapBuffers();
494
495         //react on appstate changes
496         appstate = SDL_GetAppState();
497
498         vid_hidden = !(appstate & SDL_APPACTIVE);
499
500         if( vid_hidden || !( appstate & SDL_APPMOUSEFOCUS ) || !( appstate & SDL_APPINPUTFOCUS ) )
501                 vid_activewindow = false;
502         else
503                 vid_activewindow = true;
504
505         vid_usemouse = false;
506         if( allowmousegrab && vid_mouse.integer && !key_consoleactive && !cls.demoplayback )
507                 vid_usemouse = true;
508         if( vid_isfullscreen )
509                 vid_usemouse = true;
510         if( !vid_activewindow )
511                 vid_usemouse = false;
512
513         IN_Activate(vid_usemouse);
514 }