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     if (ds->depth == 32 && screen->format->Rshift == 0) {
  93         ds->bgr = 1;
  94     } else {
  95         ds->bgr = 0;
  96     }
  97     ds->width = w;
  98     ds->height = h;
  99 }
 100
 101 /* generic keyboard conversion */
 102
 103 #include "sdl_keysym.h"
 104 #include "keymaps.c"
 105
 106 static kbd_layout_t *kbd_layout = NULL;
 107
 108 static uint8_t sdl_keyevent_to_keycode_generic(const SDL_KeyboardEvent *ev)
 109 {
 110     int keysym;
 111     /* workaround for X11+SDL bug with AltGR */
 112     keysym = ev->keysym.sym;
 113     if (keysym == 0 && ev->keysym.scancode == 113)
 114         keysym = SDLK_MODE;
 115     /* For Japanese key '\' and '|' */
 116     if (keysym == 92 && ev->keysym.scancode == 133) {
 117         keysym = 0xa5;
 118     }
 119     return keysym2scancode(kbd_layout, keysym);
 120 }
 121
 122 /* specific keyboard conversions from scan codes */
 123
 124 #if defined(_WIN32)
 125
 126 static uint8_t sdl_keyevent_to_keycode(const SDL_KeyboardEvent *ev)
 127 {
 128     return ev->keysym.scancode;
 129 }
 130
 131 #else
 132
 133 static uint8_t sdl_keyevent_to_keycode(const SDL_KeyboardEvent *ev)
 134 {
 135     int keycode;
 136
 137     keycode = ev->keysym.scancode;
 138
 139     if (keycode < 9) {
 140         keycode = 0;
 141     } else if (keycode < 97) {
 142         keycode -= 8; /* just an offset */
 143     } else if (keycode < 212) {
 144         /* use conversion table */
 145         keycode = _translate_keycode(keycode - 97);
 146     } else {
 147         keycode = 0;
 148     }
 149     return keycode;
 150 }
 151
 152 #endif
 153
 154 static void reset_keys(void)
 155 {
 156     int i;
 157     for(i = 0; i < 256; i++) {
 158         if (modifiers_state[i]) {
 159             if (i & 0x80)
 160                 kbd_put_keycode(0xe0);
 161             kbd_put_keycode(i | 0x80);
 162             modifiers_state[i] = 0;
 163         }
 164     }
 165 }
 166
 167 static void sdl_process_key(SDL_KeyboardEvent *ev)
 168 {
 169     int keycode, v;
 170
 171     if (ev->keysym.sym == SDLK_PAUSE) {
 172         /* specific case */
 173         v = 0;
 174         if (ev->type == SDL_KEYUP)
 175             v |= 0x80;
 176         kbd_put_keycode(0xe1);
 177         kbd_put_keycode(0x1d | v);
 178         kbd_put_keycode(0x45 | v);
 179         return;
 180     }
 181
 182     if (kbd_layout) {
 183         keycode = sdl_keyevent_to_keycode_generic(ev);
 184     } else {
 185         keycode = sdl_keyevent_to_keycode(ev);
 186     }
 187
 188     switch(keycode) {
 189     case 0x00:
 190         /* sent when leaving window: reset the modifiers state */
 191         reset_keys();
 192         return;
 193     case 0x2a:                          /* Left Shift */
 194     case 0x36:                          /* Right Shift */
 195     case 0x1d:                          /* Left CTRL */
 196     case 0x9d:                          /* Right CTRL */
 197     case 0x38:                          /* Left ALT */
 198     case 0xb8:                         /* Right ALT */
 199         if (ev->type == SDL_KEYUP)
 200             modifiers_state[keycode] = 0;
 201         else
 202             modifiers_state[keycode] = 1;
 203         break;
 204     case 0x45: /* num lock */
 205     case 0x3a: /* caps lock */
 206         /* SDL does not send the key up event, so we generate it */
 207         kbd_put_keycode(keycode);
 208         kbd_put_keycode(keycode | 0x80);
 209         return;
 210     }
 211
 212     /* now send the key code */
 213     if (keycode & 0x80)
 214         kbd_put_keycode(0xe0);
 215     if (ev->type == SDL_KEYUP)
 216         kbd_put_keycode(keycode | 0x80);
 217     else
 218         kbd_put_keycode(keycode & 0x7f);
 219 }
 220
 221 static void sdl_update_caption(void)
 222 {
 223     char buf[1024], appname[20] = "QEMU";
 224     const char *status = "";
 225
 226     if (!vm_running)
 227         status = " [Stopped]";
 228     else if (gui_grab) {
 229         if (!alt_grab)
 230             status = " - Press Ctrl-Alt to exit grab";
 231         else
 232             status = " - Press Ctrl-Alt-Shift to exit grab";
 233     }
 234
 235     decorate_application_name(appname, sizeof appname);
 236
 237     if (qemu_name)
 238         snprintf(buf, sizeof(buf), "%s (%s)%s", appname, qemu_name, status);
 239     else
 240         snprintf(buf, sizeof(buf), "%s%s", appname, status);
 241
 242     SDL_WM_SetCaption(buf, appname);
 243 }
 244
 245 static void sdl_hide_cursor(void)
 246 {
 247     if (!cursor_hide)
 248         return;
 249
 250     if (kbd_mouse_is_absolute()) {
 251         SDL_ShowCursor(1);
 252         SDL_SetCursor(sdl_cursor_hidden);
 253     } else {
 254         SDL_ShowCursor(0);
 255     }
 256 }
 257
 258 static void sdl_show_cursor(void)
 259 {
 260     if (!cursor_hide)
 261         return;
 262
 263     if (!kbd_mouse_is_absolute()) {
 264         SDL_ShowCursor(1);
 265         if (guest_cursor &&
 266                 (gui_grab || kbd_mouse_is_absolute() || absolute_enabled))
 267             SDL_SetCursor(guest_sprite);
 268         else
 269             SDL_SetCursor(sdl_cursor_normal);
 270     }
 271 }
 272
 273 static void sdl_grab_start(void)
 274 {
 275     if (guest_cursor) {
 276         SDL_SetCursor(guest_sprite);
 277         SDL_WarpMouse(guest_x, guest_y);
 278     } else
 279         sdl_hide_cursor();
 280     SDL_WM_GrabInput(SDL_GRAB_ON);
 281     /* dummy read to avoid moving the mouse */
 282     SDL_GetRelativeMouseState(NULL, NULL);
 283     gui_grab = 1;
 284     sdl_update_caption();
 285 }
 286
 287 static void sdl_grab_end(void)
 288 {
 289     SDL_WM_GrabInput(SDL_GRAB_OFF);
 290     gui_grab = 0;
 291     sdl_show_cursor();
 292     sdl_update_caption();
 293 }
 294
 295 static void sdl_send_mouse_event(int dz)
 296 {
 297     int dx, dy, state, buttons;
 298     state = SDL_GetRelativeMouseState(&dx, &dy);
 299     buttons = 0;
 300     if (state & SDL_BUTTON(SDL_BUTTON_LEFT))
 301         buttons |= MOUSE_EVENT_LBUTTON;
 302     if (state & SDL_BUTTON(SDL_BUTTON_RIGHT))
 303         buttons |= MOUSE_EVENT_RBUTTON;
 304     if (state & SDL_BUTTON(SDL_BUTTON_MIDDLE))
 305         buttons |= MOUSE_EVENT_MBUTTON;
 306
 307     if (kbd_mouse_is_absolute()) {
 308         if (!absolute_enabled) {
 309             sdl_hide_cursor();
 310             if (gui_grab) {
 311                 sdl_grab_end();
 312             }
 313             absolute_enabled = 1;
 314         }
 315
 316         SDL_GetMouseState(&dx, &dy);
 317         dx = dx * 0x7FFF / width;
 318         dy = dy * 0x7FFF / height;
 319     } else if (absolute_enabled) {
 320         sdl_show_cursor();
 321         absolute_enabled = 0;
 322     } else if (guest_cursor) {
 323         SDL_GetMouseState(&dx, &dy);
 324         dx -= guest_x;
 325         dy -= guest_y;
 326         guest_x += dx;
 327         guest_y += dy;
 328     }
 329
 330     kbd_mouse_event(dx, dy, dz, buttons);
 331 }
 332
 333 static void toggle_full_screen(DisplayState *ds)
 334 {
 335     gui_fullscreen = !gui_fullscreen;
 336     sdl_resize(ds, screen->w, screen->h);
 337     if (gui_fullscreen) {
 338         gui_saved_grab = gui_grab;
 339         sdl_grab_start();
 340     } else {
 341         if (!gui_saved_grab)
 342             sdl_grab_end();
 343     }
 344     vga_hw_invalidate();
 345     vga_hw_update();
 346 }
 347
 348 static void sdl_refresh(DisplayState *ds)
 349 {
 350     SDL_Event ev1, *ev = &ev1;
 351     int mod_state;
 352
 353     if (last_vm_running != vm_running) {
 354         last_vm_running = vm_running;
 355         sdl_update_caption();
 356     }
 357
 358     vga_hw_update();
 359
 360     while (SDL_PollEvent(ev)) {
 361         switch (ev->type) {
 362         case SDL_VIDEOEXPOSE:
 363             sdl_update(ds, 0, 0, screen->w, screen->h);
 364             break;
 365         case SDL_KEYDOWN:
 366         case SDL_KEYUP:
 367             if (ev->type == SDL_KEYDOWN) {
 368                 if (!alt_grab) {
 369                     mod_state = (SDL_GetModState() & gui_grab_code) ==
 370                                 gui_grab_code;
 371                 } else {
 372                     mod_state = (SDL_GetModState() & (gui_grab_code | KMOD_LSHIFT)) ==
 373                                 (gui_grab_code | KMOD_LSHIFT);
 374                 }
 375                 gui_key_modifier_pressed = mod_state;
 376                 if (gui_key_modifier_pressed) {
 377                     int keycode;
 378                     keycode = sdl_keyevent_to_keycode(&ev->key);
 379                     switch(keycode) {
 380                     case 0x21: /* 'f' key on US keyboard */
 381                         toggle_full_screen(ds);
 382                         gui_keysym = 1;
 383                         break;
 384                     case 0x02 ... 0x0a: /* '1' to '9' keys */
 385                         /* Reset the modifiers sent to the current console */
 386                         reset_keys();
 387                         console_select(keycode - 0x02);
 388                         if (!is_graphic_console()) {
 389                             /* display grab if going to a text console */
 390                             if (gui_grab)
 391                                 sdl_grab_end();
 392                         }
 393                         gui_keysym = 1;
 394                         break;
 395                     default:
 396                         break;
 397                     }
 398                 } else if (!is_graphic_console()) {
 399                     int keysym;
 400                     keysym = 0;
 401                     if (ev->key.keysym.mod & (KMOD_LCTRL | KMOD_RCTRL)) {
 402                         switch(ev->key.keysym.sym) {
 403                         case SDLK_UP: keysym = QEMU_KEY_CTRL_UP; break;
 404                         case SDLK_DOWN: keysym = QEMU_KEY_CTRL_DOWN; break;
 405                         case SDLK_LEFT: keysym = QEMU_KEY_CTRL_LEFT; break;
 406                         case SDLK_RIGHT: keysym = QEMU_KEY_CTRL_RIGHT; break;
 407                         case SDLK_HOME: keysym = QEMU_KEY_CTRL_HOME; break;
 408                         case SDLK_END: keysym = QEMU_KEY_CTRL_END; break;
 409                         case SDLK_PAGEUP: keysym = QEMU_KEY_CTRL_PAGEUP; break;
 410                         case SDLK_PAGEDOWN: keysym = QEMU_KEY_CTRL_PAGEDOWN; break;
 411                         default: break;
 412                         }
 413                     } else {
 414                         switch(ev->key.keysym.sym) {
 415                         case SDLK_UP: keysym = QEMU_KEY_UP; break;
 416                         case SDLK_DOWN: keysym = QEMU_KEY_DOWN; break;
 417                         case SDLK_LEFT: keysym = QEMU_KEY_LEFT; break;
 418                         case SDLK_RIGHT: keysym = QEMU_KEY_RIGHT; break;
 419                         case SDLK_HOME: keysym = QEMU_KEY_HOME; break;
 420                         case SDLK_END: keysym = QEMU_KEY_END; break;
 421                         case SDLK_PAGEUP: keysym = QEMU_KEY_PAGEUP; break;
 422                         case SDLK_PAGEDOWN: keysym = QEMU_KEY_PAGEDOWN; break;
 423                         case SDLK_BACKSPACE: keysym = QEMU_KEY_BACKSPACE; break;
 424                         case SDLK_DELETE: keysym = QEMU_KEY_DELETE; break;
 425                         default: break;
 426                         }
 427                     }
 428                     if (keysym) {
 429                         kbd_put_keysym(keysym);
 430                     } else if (ev->key.keysym.unicode != 0) {
 431                         kbd_put_keysym(ev->key.keysym.unicode);
 432                     }
 433                 }
 434             } else if (ev->type == SDL_KEYUP) {
 435                 if (!alt_grab) {
 436                     mod_state = (ev->key.keysym.mod & gui_grab_code);
 437                 } else {
 438                     mod_state = (ev->key.keysym.mod &
 439                                  (gui_grab_code | KMOD_LSHIFT));
 440                 }
 441                 if (!mod_state) {
 442                     if (gui_key_modifier_pressed) {
 443                         gui_key_modifier_pressed = 0;
 444                         if (gui_keysym == 0) {
 445                             /* exit/enter grab if pressing Ctrl-Alt */
 446                             if (!gui_grab) {
 447                                 /* if the application is not active,
 448                                    do not try to enter grab state. It
 449                                    prevents
 450                                    'SDL_WM_GrabInput(SDL_GRAB_ON)'
 451                                    from blocking all the application
 452                                    (SDL bug). */
 453                                 if (SDL_GetAppState() & SDL_APPACTIVE)
 454                                     sdl_grab_start();
 455                             } else {
 456                                 sdl_grab_end();
 457                             }
 458                             /* SDL does not send back all the
 459                                modifiers key, so we must correct it */
 460                             reset_keys();
 461                             break;
 462                         }
 463                         gui_keysym = 0;
 464                     }
 465                 }
 466             }
 467             if (is_graphic_console() && !gui_keysym)
 468                 sdl_process_key(&ev->key);
 469             break;
 470         case SDL_QUIT:
 471             if (!no_quit) {
 472                 qemu_system_shutdown_request();
 473                 vm_start();     /* In case we're paused */
 474             }
 475             break;
 476         case SDL_MOUSEMOTION:
 477             if (gui_grab || kbd_mouse_is_absolute() ||
 478                 absolute_enabled) {
 479                 sdl_send_mouse_event(0);
 480             }
 481             break;
 482         case SDL_MOUSEBUTTONDOWN:
 483         case SDL_MOUSEBUTTONUP:
 484             {
 485                 SDL_MouseButtonEvent *bev = &ev->button;
 486                 if (!gui_grab && !kbd_mouse_is_absolute()) {
 487                     if (ev->type == SDL_MOUSEBUTTONDOWN &&
 488                         (bev->state & SDL_BUTTON_LMASK)) {
 489                         /* start grabbing all events */
 490                         sdl_grab_start();
 491                     }
 492                 } else {
 493                     int dz;
 494                     dz = 0;
 495 #ifdef SDL_BUTTON_WHEELUP
 496                     if (bev->button == SDL_BUTTON_WHEELUP && ev->type == SDL_MOUSEBUTTONDOWN) {
 497                         dz = -1;
 498                     } else if (bev->button == SDL_BUTTON_WHEELDOWN && ev->type == SDL_MOUSEBUTTONDOWN) {
 499                         dz = 1;
 500                     }
 501 #endif
 502                     sdl_send_mouse_event(dz);
 503                 }
 504             }
 505             break;
 506         case SDL_ACTIVEEVENT:
 507             if (gui_grab && ev->active.state == SDL_APPINPUTFOCUS &&
 508                 !ev->active.gain && !gui_fullscreen_initial_grab) {
 509                 sdl_grab_end();
 510             }
 511             break;
 512         default:
 513             break;
 514         }
 515     }
 516 }
 517
 518 static void sdl_fill(DisplayState *ds, int x, int y, int w, int h, uint32_t c)
 519 {
 520     SDL_Rect dst = { x, y, w, h };
 521     SDL_FillRect(screen, &dst, c);
 522 }
 523
 524 static void sdl_mouse_warp(int x, int y, int on)
 525 {
 526     if (on) {
 527         if (!guest_cursor)
 528             sdl_show_cursor();
 529         if (gui_grab || kbd_mouse_is_absolute() || absolute_enabled) {
 530             SDL_SetCursor(guest_sprite);
 531             SDL_WarpMouse(x, y);
 532         }
 533     } else if (gui_grab)
 534         sdl_hide_cursor();
 535     guest_cursor = on;
 536     guest_x = x, guest_y = y;
 537 }
 538
 539 static void sdl_mouse_define(int width, int height, int bpp,
 540                              int hot_x, int hot_y,
 541                              uint8_t *image, uint8_t *mask)
 542 {
 543     uint8_t sprite[256], *line;
 544     int x, y, dst, bypl, src = 0;
 545     if (guest_sprite)
 546         SDL_FreeCursor(guest_sprite);
 547
 548     memset(sprite, 0, 256);
 549     bypl = ((width * bpp + 31) >> 5) << 2;
 550     for (y = 0, dst = 0; y < height; y ++, image += bypl) {
 551         line = image;
 552         for (x = 0; x < width; x ++, dst ++) {
 553             switch (bpp) {
 554             case 24:
 555                 src = *(line ++); src |= *(line ++); src |= *(line ++);
 556                 break;
 557             case 16:
 558             case 15:
 559                 src = *(line ++); src |= *(line ++);
 560                 break;
 561             case 8:
 562                 src = *(line ++);
 563                 break;
 564             case 4:
 565                 src = 0xf & (line[x >> 1] >> ((x & 1)) << 2);
 566                 break;
 567             case 2:
 568                 src = 3 & (line[x >> 2] >> ((x & 3)) << 1);
 569                 break;
 570             case 1:
 571                 src = 1 & (line[x >> 3] >> (x & 7));
 572                 break;
 573             }
 574             if (!src)
 575                 sprite[dst >> 3] |= (1 << (~dst & 7)) & mask[dst >> 3];
 576         }
 577     }
 578     guest_sprite = SDL_CreateCursor(sprite, mask, width, height, hot_x, hot_y);
 579
 580     if (guest_cursor &&
 581             (gui_grab || kbd_mouse_is_absolute() || absolute_enabled))
 582         SDL_SetCursor(guest_sprite);
 583 }
 584
 585 static void sdl_cleanup(void)
 586 {
 587     if (guest_sprite)
 588         SDL_FreeCursor(guest_sprite);
 589     SDL_Quit();
 590 }
 591
 592 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame)
 593 {
 594     int flags;
 595     uint8_t data = 0;
 596
 597 #if defined(__APPLE__)
 598     /* always use generic keymaps */
 599     if (!keyboard_layout)
 600         keyboard_layout = "en-us";
 601 #endif
 602     if(keyboard_layout) {
 603         kbd_layout = init_keyboard_layout(keyboard_layout);
 604         if (!kbd_layout)
 605             exit(1);
 606     }
 607
 608     if (no_frame)
 609         gui_noframe = 1;
 610
 611     flags = SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE;
 612     if (SDL_Init (flags)) {
 613         fprintf(stderr, "Could not initialize SDL - exiting\n");
 614         exit(1);
 615     }
 616 #ifndef _WIN32
 617     /* NOTE: we still want Ctrl-C to work, so we undo the SDL redirections */
 618     signal(SIGINT, SIG_DFL);
 619     signal(SIGQUIT, SIG_DFL);
 620 #endif
 621
 622     ds->dpy_update = sdl_update;
 623     ds->dpy_resize = sdl_resize;
 624     ds->dpy_refresh = sdl_refresh;
 625     ds->dpy_fill = sdl_fill;
 626     ds->mouse_set = sdl_mouse_warp;
 627     ds->cursor_define = sdl_mouse_define;
 628
 629     sdl_resize(ds, 640, 400);
 630     sdl_update_caption();
 631     SDL_EnableKeyRepeat(250, 50);
 632     SDL_EnableUNICODE(1);
 633     gui_grab = 0;
 634
 635     sdl_cursor_hidden = SDL_CreateCursor(&data, &data, 8, 1, 0, 0);
 636     sdl_cursor_normal = SDL_GetCursor();
 637
 638     atexit(sdl_cleanup);
 639     if (full_screen) {
 640         gui_fullscreen = 1;
 641         gui_fullscreen_initial_grab = 1;
 642         sdl_grab_start();
 643     }
 644 }