Handle terminating signals (Gerd Hoffmann)
[qemu] / sdl.c
1 /*
2  * QEMU SDL display driver
3  *
4  * Copyright (c) 2003 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #include "qemu-common.h"
25 #include "console.h"
26 #include "sysemu.h"
27
28 #include <SDL.h>
29
30 #ifndef _WIN32
31 #include <signal.h>
32 #endif
33
34 static SDL_Surface *screen;
35 static int gui_grab; /* if true, all keyboard/mouse events are grabbed */
36 static int last_vm_running;
37 static int gui_saved_grab;
38 static int gui_fullscreen;
39 static int gui_noframe;
40 static int gui_key_modifier_pressed;
41 static int gui_keysym;
42 static int gui_fullscreen_initial_grab;
43 static int gui_grab_code = KMOD_LALT | KMOD_LCTRL;
44 static uint8_t modifiers_state[256];
45 static int width, height;
46 static SDL_Cursor *sdl_cursor_normal;
47 static SDL_Cursor *sdl_cursor_hidden;
48 static int absolute_enabled = 0;
49 static int guest_cursor = 0;
50 static int guest_x, guest_y;
51 static SDL_Cursor *guest_sprite = 0;
52
53 static void sdl_update(DisplayState *ds, int x, int y, int w, int h)
54 {
55     //    printf("updating x=%d y=%d w=%d h=%d\n", x, y, w, h);
56     SDL_UpdateRect(screen, x, y, w, h);
57 }
58
59 static void sdl_resize(DisplayState *ds, int w, int h)
60 {
61     int flags;
62
63     //    printf("resizing to %d %d\n", w, h);
64
65     flags = SDL_HWSURFACE|SDL_ASYNCBLIT|SDL_HWACCEL;
66     if (gui_fullscreen)
67         flags |= SDL_FULLSCREEN;
68     if (gui_noframe)
69         flags |= SDL_NOFRAME;
70
71     width = w;
72     height = h;
73
74  again:
75     screen = SDL_SetVideoMode(w, h, 0, flags);
76     if (!screen) {
77         fprintf(stderr, "Could not open SDL display\n");
78         exit(1);
79     }
80     if (!screen->pixels && (flags & SDL_HWSURFACE) && (flags & SDL_FULLSCREEN)) {
81         flags &= ~SDL_HWSURFACE;
82         goto again;
83     }
84
85     if (!screen->pixels) {
86         fprintf(stderr, "Could not open SDL display\n");
87         exit(1);
88     }
89     ds->data = screen->pixels;
90     ds->linesize = screen->pitch;
91     ds->depth = screen->format->BitsPerPixel;
92     /* SDL BitsPerPixel never indicates any values other than
93        multiples of 8, so we need to check for strange depths. */
94     if (ds->depth == 16) {
95         uint32_t mask;
96
97         mask = screen->format->Rmask;
98         mask |= screen->format->Gmask;
99         mask |= screen->format->Bmask;
100         if ((mask & 0x8000) == 0)
101             ds->depth = 15;
102     }
103     if (ds->depth == 32 && screen->format->Rshift == 0) {
104         ds->bgr = 1;
105     } else {
106         ds->bgr = 0;
107     }
108     ds->width = w;
109     ds->height = h;
110 }
111
112 /* generic keyboard conversion */
113
114 #include "sdl_keysym.h"
115 #include "keymaps.c"
116
117 static kbd_layout_t *kbd_layout = NULL;
118
119 static uint8_t sdl_keyevent_to_keycode_generic(const SDL_KeyboardEvent *ev)
120 {
121     int keysym;
122     /* workaround for X11+SDL bug with AltGR */
123     keysym = ev->keysym.sym;
124     if (keysym == 0 && ev->keysym.scancode == 113)
125         keysym = SDLK_MODE;
126     /* For Japanese key '\' and '|' */
127     if (keysym == 92 && ev->keysym.scancode == 133) {
128         keysym = 0xa5;
129     }
130     return keysym2scancode(kbd_layout, keysym);
131 }
132
133 /* specific keyboard conversions from scan codes */
134
135 #if defined(_WIN32)
136
137 static uint8_t sdl_keyevent_to_keycode(const SDL_KeyboardEvent *ev)
138 {
139     return ev->keysym.scancode;
140 }
141
142 #else
143
144 static uint8_t sdl_keyevent_to_keycode(const SDL_KeyboardEvent *ev)
145 {
146     int keycode;
147
148     keycode = ev->keysym.scancode;
149
150     if (keycode < 9) {
151         keycode = 0;
152     } else if (keycode < 97) {
153         keycode -= 8; /* just an offset */
154     } else if (keycode < 212) {
155         /* use conversion table */
156         keycode = _translate_keycode(keycode - 97);
157     } else {
158         keycode = 0;
159     }
160     return keycode;
161 }
162
163 #endif
164
165 static void reset_keys(void)
166 {
167     int i;
168     for(i = 0; i < 256; i++) {
169         if (modifiers_state[i]) {
170             if (i & 0x80)
171                 kbd_put_keycode(0xe0);
172             kbd_put_keycode(i | 0x80);
173             modifiers_state[i] = 0;
174         }
175     }
176 }
177
178 static void sdl_process_key(SDL_KeyboardEvent *ev)
179 {
180     int keycode, v;
181
182     if (ev->keysym.sym == SDLK_PAUSE) {
183         /* specific case */
184         v = 0;
185         if (ev->type == SDL_KEYUP)
186             v |= 0x80;
187         kbd_put_keycode(0xe1);
188         kbd_put_keycode(0x1d | v);
189         kbd_put_keycode(0x45 | v);
190         return;
191     }
192
193     if (kbd_layout) {
194         keycode = sdl_keyevent_to_keycode_generic(ev);
195     } else {
196         keycode = sdl_keyevent_to_keycode(ev);
197     }
198
199     switch(keycode) {
200     case 0x00:
201         /* sent when leaving window: reset the modifiers state */
202         reset_keys();
203         return;
204     case 0x2a:                          /* Left Shift */
205     case 0x36:                          /* Right Shift */
206     case 0x1d:                          /* Left CTRL */
207     case 0x9d:                          /* Right CTRL */
208     case 0x38:                          /* Left ALT */
209     case 0xb8:                         /* Right ALT */
210         if (ev->type == SDL_KEYUP)
211             modifiers_state[keycode] = 0;
212         else
213             modifiers_state[keycode] = 1;
214         break;
215     case 0x45: /* num lock */
216     case 0x3a: /* caps lock */
217         /* SDL does not send the key up event, so we generate it */
218         kbd_put_keycode(keycode);
219         kbd_put_keycode(keycode | 0x80);
220         return;
221     }
222
223     /* now send the key code */
224     if (keycode & 0x80)
225         kbd_put_keycode(0xe0);
226     if (ev->type == SDL_KEYUP)
227         kbd_put_keycode(keycode | 0x80);
228     else
229         kbd_put_keycode(keycode & 0x7f);
230 }
231
232 static void sdl_update_caption(void)
233 {
234     char buf[1024];
235     const char *status = "";
236
237     if (!vm_running)
238         status = " [Stopped]";
239     else if (gui_grab) {
240         if (!alt_grab)
241             status = " - Press Ctrl-Alt to exit grab";
242         else
243             status = " - Press Ctrl-Alt-Shift to exit grab";
244     }
245
246     if (qemu_name)
247         snprintf(buf, sizeof(buf), "QEMU (%s)%s", qemu_name, status);
248     else
249         snprintf(buf, sizeof(buf), "QEMU%s", status);
250
251     SDL_WM_SetCaption(buf, "QEMU");
252 }
253
254 static void sdl_hide_cursor(void)
255 {
256     if (!cursor_hide)
257         return;
258
259     if (kbd_mouse_is_absolute()) {
260         SDL_ShowCursor(1);
261         SDL_SetCursor(sdl_cursor_hidden);
262     } else {
263         SDL_ShowCursor(0);
264     }
265 }
266
267 static void sdl_show_cursor(void)
268 {
269     if (!cursor_hide)
270         return;
271
272     if (!kbd_mouse_is_absolute()) {
273         SDL_ShowCursor(1);
274         if (guest_cursor &&
275                 (gui_grab || kbd_mouse_is_absolute() || absolute_enabled))
276             SDL_SetCursor(guest_sprite);
277         else
278             SDL_SetCursor(sdl_cursor_normal);
279     }
280 }
281
282 static void sdl_grab_start(void)
283 {
284     if (guest_cursor) {
285         SDL_SetCursor(guest_sprite);
286         SDL_WarpMouse(guest_x, guest_y);
287     } else
288         sdl_hide_cursor();
289     SDL_WM_GrabInput(SDL_GRAB_ON);
290     gui_grab = 1;
291     sdl_update_caption();
292 }
293
294 static void sdl_grab_end(void)
295 {
296     SDL_WM_GrabInput(SDL_GRAB_OFF);
297     gui_grab = 0;
298     sdl_show_cursor();
299     sdl_update_caption();
300 }
301
302 static void sdl_send_mouse_event(int dx, int dy, int dz, int x, int y, int state)
303 {
304     int buttons;
305     buttons = 0;
306     if (state & SDL_BUTTON(SDL_BUTTON_LEFT))
307         buttons |= MOUSE_EVENT_LBUTTON;
308     if (state & SDL_BUTTON(SDL_BUTTON_RIGHT))
309         buttons |= MOUSE_EVENT_RBUTTON;
310     if (state & SDL_BUTTON(SDL_BUTTON_MIDDLE))
311         buttons |= MOUSE_EVENT_MBUTTON;
312
313     if (kbd_mouse_is_absolute()) {
314         if (!absolute_enabled) {
315             sdl_hide_cursor();
316             if (gui_grab) {
317                 sdl_grab_end();
318             }
319             absolute_enabled = 1;
320         }
321
322        dx = x * 0x7FFF / (width - 1);
323        dy = y * 0x7FFF / (height - 1);
324     } else if (absolute_enabled) {
325         sdl_show_cursor();
326         absolute_enabled = 0;
327     } else if (guest_cursor) {
328         x -= guest_x;
329         y -= guest_y;
330         guest_x += x;
331         guest_y += y;
332         dx = x;
333         dy = y;
334     }
335
336     kbd_mouse_event(dx, dy, dz, buttons);
337 }
338
339 static void toggle_full_screen(DisplayState *ds)
340 {
341     gui_fullscreen = !gui_fullscreen;
342     sdl_resize(ds, screen->w, screen->h);
343     if (gui_fullscreen) {
344         gui_saved_grab = gui_grab;
345         sdl_grab_start();
346     } else {
347         if (!gui_saved_grab)
348             sdl_grab_end();
349     }
350     vga_hw_invalidate();
351     vga_hw_update();
352 }
353
354 static void sdl_refresh(DisplayState *ds)
355 {
356     SDL_Event ev1, *ev = &ev1;
357     int mod_state;
358     int buttonstate = SDL_GetMouseState(NULL, NULL);
359
360     if (last_vm_running != vm_running) {
361         last_vm_running = vm_running;
362         sdl_update_caption();
363     }
364
365     vga_hw_update();
366     SDL_EnableUNICODE(!is_graphic_console());
367
368     while (SDL_PollEvent(ev)) {
369         switch (ev->type) {
370         case SDL_VIDEOEXPOSE:
371             sdl_update(ds, 0, 0, screen->w, screen->h);
372             break;
373         case SDL_KEYDOWN:
374         case SDL_KEYUP:
375             if (ev->type == SDL_KEYDOWN) {
376                 if (!alt_grab) {
377                     mod_state = (SDL_GetModState() & gui_grab_code) ==
378                                 gui_grab_code;
379                 } else {
380                     mod_state = (SDL_GetModState() & (gui_grab_code | KMOD_LSHIFT)) ==
381                                 (gui_grab_code | KMOD_LSHIFT);
382                 }
383                 gui_key_modifier_pressed = mod_state;
384                 if (gui_key_modifier_pressed) {
385                     int keycode;
386                     keycode = sdl_keyevent_to_keycode(&ev->key);
387                     switch(keycode) {
388                     case 0x21: /* 'f' key on US keyboard */
389                         toggle_full_screen(ds);
390                         gui_keysym = 1;
391                         break;
392                     case 0x02 ... 0x0a: /* '1' to '9' keys */
393                         /* Reset the modifiers sent to the current console */
394                         reset_keys();
395                         console_select(keycode - 0x02);
396                         if (!is_graphic_console()) {
397                             /* display grab if going to a text console */
398                             if (gui_grab)
399                                 sdl_grab_end();
400                         }
401                         gui_keysym = 1;
402                         break;
403                     default:
404                         break;
405                     }
406                 } else if (!is_graphic_console()) {
407                     int keysym;
408                     keysym = 0;
409                     if (ev->key.keysym.mod & (KMOD_LCTRL | KMOD_RCTRL)) {
410                         switch(ev->key.keysym.sym) {
411                         case SDLK_UP: keysym = QEMU_KEY_CTRL_UP; break;
412                         case SDLK_DOWN: keysym = QEMU_KEY_CTRL_DOWN; break;
413                         case SDLK_LEFT: keysym = QEMU_KEY_CTRL_LEFT; break;
414                         case SDLK_RIGHT: keysym = QEMU_KEY_CTRL_RIGHT; break;
415                         case SDLK_HOME: keysym = QEMU_KEY_CTRL_HOME; break;
416                         case SDLK_END: keysym = QEMU_KEY_CTRL_END; break;
417                         case SDLK_PAGEUP: keysym = QEMU_KEY_CTRL_PAGEUP; break;
418                         case SDLK_PAGEDOWN: keysym = QEMU_KEY_CTRL_PAGEDOWN; break;
419                         default: break;
420                         }
421                     } else {
422                         switch(ev->key.keysym.sym) {
423                         case SDLK_UP: keysym = QEMU_KEY_UP; break;
424                         case SDLK_DOWN: keysym = QEMU_KEY_DOWN; break;
425                         case SDLK_LEFT: keysym = QEMU_KEY_LEFT; break;
426                         case SDLK_RIGHT: keysym = QEMU_KEY_RIGHT; break;
427                         case SDLK_HOME: keysym = QEMU_KEY_HOME; break;
428                         case SDLK_END: keysym = QEMU_KEY_END; break;
429                         case SDLK_PAGEUP: keysym = QEMU_KEY_PAGEUP; break;
430                         case SDLK_PAGEDOWN: keysym = QEMU_KEY_PAGEDOWN; break;
431                         case SDLK_BACKSPACE: keysym = QEMU_KEY_BACKSPACE; break;
432                         case SDLK_DELETE: keysym = QEMU_KEY_DELETE; break;
433                         default: break;
434                         }
435                     }
436                     if (keysym) {
437                         kbd_put_keysym(keysym);
438                     } else if (ev->key.keysym.unicode != 0) {
439                         kbd_put_keysym(ev->key.keysym.unicode);
440                     }
441                 }
442             } else if (ev->type == SDL_KEYUP) {
443                 if (!alt_grab) {
444                     mod_state = (ev->key.keysym.mod & gui_grab_code);
445                 } else {
446                     mod_state = (ev->key.keysym.mod &
447                                  (gui_grab_code | KMOD_LSHIFT));
448                 }
449                 if (!mod_state) {
450                     if (gui_key_modifier_pressed) {
451                         gui_key_modifier_pressed = 0;
452                         if (gui_keysym == 0) {
453                             /* exit/enter grab if pressing Ctrl-Alt */
454                             if (!gui_grab) {
455                                 /* if the application is not active,
456                                    do not try to enter grab state. It
457                                    prevents
458                                    'SDL_WM_GrabInput(SDL_GRAB_ON)'
459                                    from blocking all the application
460                                    (SDL bug). */
461                                 if (SDL_GetAppState() & SDL_APPACTIVE)
462                                     sdl_grab_start();
463                             } else {
464                                 sdl_grab_end();
465                             }
466                             /* SDL does not send back all the
467                                modifiers key, so we must correct it */
468                             reset_keys();
469                             break;
470                         }
471                         gui_keysym = 0;
472                     }
473                 }
474             }
475             if (is_graphic_console() && !gui_keysym)
476                 sdl_process_key(&ev->key);
477             break;
478         case SDL_QUIT:
479             if (!no_quit)
480                 qemu_system_shutdown_request();
481             break;
482         case SDL_MOUSEMOTION:
483             if (gui_grab || kbd_mouse_is_absolute() ||
484                 absolute_enabled) {
485                 sdl_send_mouse_event(ev->motion.xrel, ev->motion.yrel, 0,
486                        ev->motion.x, ev->motion.y, ev->motion.state);
487             }
488             break;
489         case SDL_MOUSEBUTTONDOWN:
490         case SDL_MOUSEBUTTONUP:
491             {
492                 SDL_MouseButtonEvent *bev = &ev->button;
493                 if (!gui_grab && !kbd_mouse_is_absolute()) {
494                     if (ev->type == SDL_MOUSEBUTTONDOWN &&
495                         (bev->button == SDL_BUTTON_LEFT)) {
496                         /* start grabbing all events */
497                         sdl_grab_start();
498                     }
499                 } else {
500                     int dz;
501                     dz = 0;
502                     if (ev->type == SDL_MOUSEBUTTONDOWN) {
503                         buttonstate |= SDL_BUTTON(bev->button);
504                     } else {
505                         buttonstate &= ~SDL_BUTTON(bev->button);
506                     }
507 #ifdef SDL_BUTTON_WHEELUP
508                     if (bev->button == SDL_BUTTON_WHEELUP && ev->type == SDL_MOUSEBUTTONDOWN) {
509                         dz = -1;
510                     } else if (bev->button == SDL_BUTTON_WHEELDOWN && ev->type == SDL_MOUSEBUTTONDOWN) {
511                         dz = 1;
512                     }
513 #endif
514                     sdl_send_mouse_event(0, 0, dz, bev->x, bev->y, buttonstate);
515                 }
516             }
517             break;
518         case SDL_ACTIVEEVENT:
519             if (gui_grab && ev->active.state == SDL_APPINPUTFOCUS &&
520                 !ev->active.gain && !gui_fullscreen_initial_grab) {
521                 sdl_grab_end();
522             }
523             if (ev->active.state & SDL_APPACTIVE) {
524                 if (ev->active.gain) {
525                     /* Back to default interval */
526                     ds->gui_timer_interval = 0;
527                 } else {
528                     /* Sleeping interval */
529                     ds->gui_timer_interval = 500;
530                 }
531             }
532             break;
533         default:
534             break;
535         }
536     }
537 }
538
539 static void sdl_fill(DisplayState *ds, int x, int y, int w, int h, uint32_t c)
540 {
541     SDL_Rect dst = { x, y, w, h };
542     SDL_FillRect(screen, &dst, c);
543 }
544
545 static void sdl_mouse_warp(int x, int y, int on)
546 {
547     if (on) {
548         if (!guest_cursor)
549             sdl_show_cursor();
550         if (gui_grab || kbd_mouse_is_absolute() || absolute_enabled) {
551             SDL_SetCursor(guest_sprite);
552             SDL_WarpMouse(x, y);
553         }
554     } else if (gui_grab)
555         sdl_hide_cursor();
556     guest_cursor = on;
557     guest_x = x, guest_y = y;
558 }
559
560 static void sdl_mouse_define(int width, int height, int bpp,
561                              int hot_x, int hot_y,
562                              uint8_t *image, uint8_t *mask)
563 {
564     uint8_t sprite[256], *line;
565     int x, y, dst, bypl, src = 0;
566     if (guest_sprite)
567         SDL_FreeCursor(guest_sprite);
568
569     memset(sprite, 0, 256);
570     bypl = ((width * bpp + 31) >> 5) << 2;
571     for (y = 0, dst = 0; y < height; y ++, image += bypl) {
572         line = image;
573         for (x = 0; x < width; x ++, dst ++) {
574             switch (bpp) {
575             case 24:
576                 src = *(line ++); src |= *(line ++); src |= *(line ++);
577                 break;
578             case 16:
579             case 15:
580                 src = *(line ++); src |= *(line ++);
581                 break;
582             case 8:
583                 src = *(line ++);
584                 break;
585             case 4:
586                 src = 0xf & (line[x >> 1] >> ((x & 1)) << 2);
587                 break;
588             case 2:
589                 src = 3 & (line[x >> 2] >> ((x & 3)) << 1);
590                 break;
591             case 1:
592                 src = 1 & (line[x >> 3] >> (x & 7));
593                 break;
594             }
595             if (!src)
596                 sprite[dst >> 3] |= (1 << (~dst & 7)) & mask[dst >> 3];
597         }
598     }
599     guest_sprite = SDL_CreateCursor(sprite, mask, width, height, hot_x, hot_y);
600
601     if (guest_cursor &&
602             (gui_grab || kbd_mouse_is_absolute() || absolute_enabled))
603         SDL_SetCursor(guest_sprite);
604 }
605
606 static void sdl_cleanup(void)
607 {
608     if (guest_sprite)
609         SDL_FreeCursor(guest_sprite);
610     SDL_Quit();
611 }
612
613 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame)
614 {
615     int flags;
616     uint8_t data = 0;
617
618 #if defined(__APPLE__)
619     /* always use generic keymaps */
620     if (!keyboard_layout)
621         keyboard_layout = "en-us";
622 #endif
623     if(keyboard_layout) {
624         kbd_layout = init_keyboard_layout(keyboard_layout);
625         if (!kbd_layout)
626             exit(1);
627     }
628
629     if (no_frame)
630         gui_noframe = 1;
631
632     flags = SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE;
633     if (SDL_Init (flags)) {
634         fprintf(stderr, "Could not initialize SDL - exiting\n");
635         exit(1);
636     }
637
638     ds->dpy_update = sdl_update;
639     ds->dpy_resize = sdl_resize;
640     ds->dpy_refresh = sdl_refresh;
641     ds->dpy_fill = sdl_fill;
642     ds->mouse_set = sdl_mouse_warp;
643     ds->cursor_define = sdl_mouse_define;
644
645     sdl_resize(ds, 640, 400);
646     sdl_update_caption();
647     SDL_EnableKeyRepeat(250, 50);
648     gui_grab = 0;
649
650     sdl_cursor_hidden = SDL_CreateCursor(&data, &data, 8, 1, 0, 0);
651     sdl_cursor_normal = SDL_GetCursor();
652
653     atexit(sdl_cleanup);
654     if (full_screen) {
655         gui_fullscreen = 1;
656         gui_fullscreen_initial_grab = 1;
657         sdl_grab_start();
658     }
659 }