2 * QEMU SDL display driver
4 * Copyright (c) 2003 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 /* Ported SDL 1.2 code to 2.0 by Dave Airlie. */
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "ui/console.h"
31 #include "sysemu/sysemu.h"
33 static int sdl2_num_outputs;
34 static struct sdl2_console *sdl2_console;
35 static DisplayOptions *opts;
37 static SDL_Surface *guest_sprite_surface;
38 static int gui_grab; /* if true, all keyboard/mouse events are grabbed */
40 static int gui_saved_grab;
41 static int gui_fullscreen;
42 static int gui_key_modifier_pressed;
43 static int gui_keysym;
44 static int gui_grab_code = KMOD_LALT | KMOD_LCTRL;
45 static SDL_Cursor *sdl_cursor_normal;
46 static SDL_Cursor *sdl_cursor_hidden;
47 static int absolute_enabled;
48 static int guest_cursor;
49 static int guest_x, guest_y;
50 static SDL_Cursor *guest_sprite;
51 static Notifier mouse_mode_notifier;
53 #define SDL2_REFRESH_INTERVAL_BUSY 10
54 #define SDL2_MAX_IDLE_COUNT (2 * GUI_REFRESH_INTERVAL_DEFAULT \
55 / SDL2_REFRESH_INTERVAL_BUSY + 1)
57 static void sdl_update_caption(struct sdl2_console *scon);
59 static struct sdl2_console *get_scon_from_window(uint32_t window_id)
62 for (i = 0; i < sdl2_num_outputs; i++) {
63 if (sdl2_console[i].real_window == SDL_GetWindowFromID(window_id)) {
64 return &sdl2_console[i];
70 void sdl2_window_create(struct sdl2_console *scon)
77 assert(!scon->real_window);
80 flags |= SDL_WINDOW_FULLSCREEN_DESKTOP;
82 flags |= SDL_WINDOW_RESIZABLE;
85 flags |= SDL_WINDOW_HIDDEN;
88 scon->real_window = SDL_CreateWindow("", SDL_WINDOWPOS_UNDEFINED,
89 SDL_WINDOWPOS_UNDEFINED,
90 surface_width(scon->surface),
91 surface_height(scon->surface),
93 scon->real_renderer = SDL_CreateRenderer(scon->real_window, -1, 0);
95 scon->winctx = SDL_GL_GetCurrentContext();
97 sdl_update_caption(scon);
100 void sdl2_window_destroy(struct sdl2_console *scon)
102 if (!scon->real_window) {
106 SDL_DestroyRenderer(scon->real_renderer);
107 scon->real_renderer = NULL;
108 SDL_DestroyWindow(scon->real_window);
109 scon->real_window = NULL;
112 void sdl2_window_resize(struct sdl2_console *scon)
114 if (!scon->real_window) {
118 SDL_SetWindowSize(scon->real_window,
119 surface_width(scon->surface),
120 surface_height(scon->surface));
123 static void sdl2_redraw(struct sdl2_console *scon)
127 sdl2_gl_redraw(scon);
130 sdl2_2d_redraw(scon);
134 static void sdl_update_caption(struct sdl2_console *scon)
136 char win_title[1024];
137 char icon_title[1024];
138 const char *status = "";
140 if (!runstate_is_running()) {
141 status = " [Stopped]";
142 } else if (gui_grab) {
144 status = " - Press Ctrl-Alt-Shift-G to exit grab";
145 } else if (ctrl_grab) {
146 status = " - Press Right-Ctrl-G to exit grab";
148 status = " - Press Ctrl-Alt-G to exit grab";
153 snprintf(win_title, sizeof(win_title), "QEMU (%s-%d)%s", qemu_name,
155 snprintf(icon_title, sizeof(icon_title), "QEMU (%s)", qemu_name);
157 snprintf(win_title, sizeof(win_title), "QEMU%s", status);
158 snprintf(icon_title, sizeof(icon_title), "QEMU");
161 if (scon->real_window) {
162 SDL_SetWindowTitle(scon->real_window, win_title);
166 static void sdl_hide_cursor(void)
172 SDL_ShowCursor(SDL_DISABLE);
173 SDL_SetCursor(sdl_cursor_hidden);
175 if (!qemu_input_is_absolute()) {
176 SDL_SetRelativeMouseMode(SDL_TRUE);
180 static void sdl_show_cursor(void)
186 if (!qemu_input_is_absolute()) {
187 SDL_SetRelativeMouseMode(SDL_FALSE);
191 (gui_grab || qemu_input_is_absolute() || absolute_enabled)) {
192 SDL_SetCursor(guest_sprite);
194 SDL_SetCursor(sdl_cursor_normal);
197 SDL_ShowCursor(SDL_ENABLE);
200 static void sdl_grab_start(struct sdl2_console *scon)
202 QemuConsole *con = scon ? scon->dcl.con : NULL;
204 if (!con || !qemu_console_is_graphic(con)) {
208 * If the application is not active, do not try to enter grab state. This
209 * prevents 'SDL_WM_GrabInput(SDL_GRAB_ON)' from blocking all the
210 * application (SDL bug).
212 if (!(SDL_GetWindowFlags(scon->real_window) & SDL_WINDOW_INPUT_FOCUS)) {
216 SDL_SetCursor(guest_sprite);
217 if (!qemu_input_is_absolute() && !absolute_enabled) {
218 SDL_WarpMouseInWindow(scon->real_window, guest_x, guest_y);
223 SDL_SetWindowGrab(scon->real_window, SDL_TRUE);
225 sdl_update_caption(scon);
228 static void sdl_grab_end(struct sdl2_console *scon)
230 SDL_SetWindowGrab(scon->real_window, SDL_FALSE);
233 sdl_update_caption(scon);
236 static void absolute_mouse_grab(struct sdl2_console *scon)
238 int mouse_x, mouse_y;
240 SDL_GetMouseState(&mouse_x, &mouse_y);
241 SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
242 if (mouse_x > 0 && mouse_x < scr_w - 1 &&
243 mouse_y > 0 && mouse_y < scr_h - 1) {
244 sdl_grab_start(scon);
248 static void sdl_mouse_mode_change(Notifier *notify, void *data)
250 if (qemu_input_is_absolute()) {
251 if (!absolute_enabled) {
252 absolute_enabled = 1;
253 SDL_SetRelativeMouseMode(SDL_FALSE);
254 absolute_mouse_grab(&sdl2_console[0]);
256 } else if (absolute_enabled) {
257 if (!gui_fullscreen) {
258 sdl_grab_end(&sdl2_console[0]);
260 absolute_enabled = 0;
264 static void sdl_send_mouse_event(struct sdl2_console *scon, int dx, int dy,
265 int x, int y, int state)
267 static uint32_t bmap[INPUT_BUTTON__MAX] = {
268 [INPUT_BUTTON_LEFT] = SDL_BUTTON(SDL_BUTTON_LEFT),
269 [INPUT_BUTTON_MIDDLE] = SDL_BUTTON(SDL_BUTTON_MIDDLE),
270 [INPUT_BUTTON_RIGHT] = SDL_BUTTON(SDL_BUTTON_RIGHT),
272 static uint32_t prev_state;
274 if (prev_state != state) {
275 qemu_input_update_buttons(scon->dcl.con, bmap, prev_state, state);
279 if (qemu_input_is_absolute()) {
280 qemu_input_queue_abs(scon->dcl.con, INPUT_AXIS_X,
281 x, 0, surface_width(scon->surface));
282 qemu_input_queue_abs(scon->dcl.con, INPUT_AXIS_Y,
283 y, 0, surface_height(scon->surface));
293 qemu_input_queue_rel(scon->dcl.con, INPUT_AXIS_X, dx);
294 qemu_input_queue_rel(scon->dcl.con, INPUT_AXIS_Y, dy);
296 qemu_input_event_sync();
299 static void toggle_full_screen(struct sdl2_console *scon)
301 gui_fullscreen = !gui_fullscreen;
302 if (gui_fullscreen) {
303 SDL_SetWindowFullscreen(scon->real_window,
304 SDL_WINDOW_FULLSCREEN_DESKTOP);
305 gui_saved_grab = gui_grab;
306 sdl_grab_start(scon);
308 if (!gui_saved_grab) {
311 SDL_SetWindowFullscreen(scon->real_window, 0);
316 static int get_mod_state(void)
318 SDL_Keymod mod = SDL_GetModState();
321 return (mod & (gui_grab_code | KMOD_LSHIFT)) ==
322 (gui_grab_code | KMOD_LSHIFT);
323 } else if (ctrl_grab) {
324 return (mod & KMOD_RCTRL) == KMOD_RCTRL;
326 return (mod & gui_grab_code) == gui_grab_code;
330 static void handle_keydown(SDL_Event *ev)
333 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
335 gui_key_modifier_pressed = get_mod_state();
337 if (!scon->ignore_hotkeys && gui_key_modifier_pressed && !ev->key.repeat) {
338 switch (ev->key.keysym.scancode) {
351 win = ev->key.keysym.scancode - SDL_SCANCODE_1;
352 if (win < sdl2_num_outputs) {
353 sdl2_console[win].hidden = !sdl2_console[win].hidden;
354 if (sdl2_console[win].real_window) {
355 if (sdl2_console[win].hidden) {
356 SDL_HideWindow(sdl2_console[win].real_window);
358 SDL_ShowWindow(sdl2_console[win].real_window);
365 toggle_full_screen(scon);
371 sdl_grab_start(scon);
372 } else if (!gui_fullscreen) {
377 sdl2_window_destroy(scon);
378 sdl2_window_create(scon);
380 /* re-create scon->texture */
381 sdl2_2d_switch(&scon->dcl, scon->surface);
386 case SDL_SCANCODE_KP_PLUS:
387 case SDL_SCANCODE_KP_MINUS:
388 if (!gui_fullscreen) {
391 SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
393 width = MAX(scr_w + (ev->key.keysym.scancode ==
394 SDL_SCANCODE_KP_PLUS ? 50 : -50),
396 height = (surface_height(scon->surface) * width) /
397 surface_width(scon->surface);
398 fprintf(stderr, "%s: scale to %dx%d\n",
399 __func__, width, height);
400 sdl_scale(scon, width, height);
410 sdl2_process_key(scon, &ev->key);
414 static void handle_keyup(SDL_Event *ev)
417 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
419 scon->ignore_hotkeys = false;
422 mod_state = (ev->key.keysym.mod & gui_grab_code);
424 mod_state = (ev->key.keysym.mod & (gui_grab_code | KMOD_LSHIFT));
426 if (!mod_state && gui_key_modifier_pressed) {
427 gui_key_modifier_pressed = 0;
431 sdl2_process_key(scon, &ev->key);
435 static void handle_textinput(SDL_Event *ev)
437 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
438 QemuConsole *con = scon ? scon->dcl.con : NULL;
440 if (qemu_console_is_graphic(con)) {
443 kbd_put_string_console(con, ev->text.text, strlen(ev->text.text));
446 static void handle_mousemotion(SDL_Event *ev)
449 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
451 if (!qemu_console_is_graphic(scon->dcl.con)) {
455 if (qemu_input_is_absolute() || absolute_enabled) {
457 SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
460 if (gui_grab && !gui_fullscreen
461 && (ev->motion.x == 0 || ev->motion.y == 0 ||
462 ev->motion.x == max_x || ev->motion.y == max_y)) {
466 (ev->motion.x > 0 && ev->motion.x < max_x &&
467 ev->motion.y > 0 && ev->motion.y < max_y)) {
468 sdl_grab_start(scon);
471 if (gui_grab || qemu_input_is_absolute() || absolute_enabled) {
472 sdl_send_mouse_event(scon, ev->motion.xrel, ev->motion.yrel,
473 ev->motion.x, ev->motion.y, ev->motion.state);
477 static void handle_mousebutton(SDL_Event *ev)
479 int buttonstate = SDL_GetMouseState(NULL, NULL);
480 SDL_MouseButtonEvent *bev;
481 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
483 if (!qemu_console_is_graphic(scon->dcl.con)) {
488 if (!gui_grab && !qemu_input_is_absolute()) {
489 if (ev->type == SDL_MOUSEBUTTONUP && bev->button == SDL_BUTTON_LEFT) {
490 /* start grabbing all events */
491 sdl_grab_start(scon);
494 if (ev->type == SDL_MOUSEBUTTONDOWN) {
495 buttonstate |= SDL_BUTTON(bev->button);
497 buttonstate &= ~SDL_BUTTON(bev->button);
499 sdl_send_mouse_event(scon, 0, 0, bev->x, bev->y, buttonstate);
503 static void handle_mousewheel(SDL_Event *ev)
505 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
506 SDL_MouseWheelEvent *wev = &ev->wheel;
509 if (!qemu_console_is_graphic(scon->dcl.con)) {
514 btn = INPUT_BUTTON_WHEEL_UP;
515 } else if (wev->y < 0) {
516 btn = INPUT_BUTTON_WHEEL_DOWN;
521 qemu_input_queue_btn(scon->dcl.con, btn, true);
522 qemu_input_event_sync();
523 qemu_input_queue_btn(scon->dcl.con, btn, false);
524 qemu_input_event_sync();
527 static void handle_windowevent(SDL_Event *ev)
529 struct sdl2_console *scon = get_scon_from_window(ev->window.windowID);
530 bool allow_close = true;
536 switch (ev->window.event) {
537 case SDL_WINDOWEVENT_RESIZED:
540 memset(&info, 0, sizeof(info));
541 info.width = ev->window.data1;
542 info.height = ev->window.data2;
543 dpy_set_ui_info(scon->dcl.con, &info);
547 case SDL_WINDOWEVENT_EXPOSED:
550 case SDL_WINDOWEVENT_FOCUS_GAINED:
551 case SDL_WINDOWEVENT_ENTER:
552 if (!gui_grab && (qemu_input_is_absolute() || absolute_enabled)) {
553 absolute_mouse_grab(scon);
555 /* If a new console window opened using a hotkey receives the
556 * focus, SDL sends another KEYDOWN event to the new window,
557 * closing the console window immediately after.
559 * Work around this by ignoring further hotkey events until a
562 scon->ignore_hotkeys = get_mod_state();
564 case SDL_WINDOWEVENT_FOCUS_LOST:
565 if (gui_grab && !gui_fullscreen) {
569 case SDL_WINDOWEVENT_RESTORED:
570 update_displaychangelistener(&scon->dcl, GUI_REFRESH_INTERVAL_DEFAULT);
572 case SDL_WINDOWEVENT_MINIMIZED:
573 update_displaychangelistener(&scon->dcl, 500);
575 case SDL_WINDOWEVENT_CLOSE:
576 if (qemu_console_is_graphic(scon->dcl.con)) {
577 if (opts->has_window_close && !opts->window_close) {
582 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
585 SDL_HideWindow(scon->real_window);
589 case SDL_WINDOWEVENT_SHOWN:
590 scon->hidden = false;
592 case SDL_WINDOWEVENT_HIDDEN:
598 void sdl2_poll_events(struct sdl2_console *scon)
600 SDL_Event ev1, *ev = &ev1;
601 bool allow_close = true;
604 if (scon->last_vm_running != runstate_is_running()) {
605 scon->last_vm_running = runstate_is_running();
606 sdl_update_caption(scon);
609 while (SDL_PollEvent(ev)) {
621 handle_textinput(ev);
624 if (opts->has_window_close && !opts->window_close) {
629 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
632 case SDL_MOUSEMOTION:
634 handle_mousemotion(ev);
636 case SDL_MOUSEBUTTONDOWN:
637 case SDL_MOUSEBUTTONUP:
639 handle_mousebutton(ev);
643 handle_mousewheel(ev);
645 case SDL_WINDOWEVENT:
646 handle_windowevent(ev);
654 if (scon->idle_counter < SDL2_MAX_IDLE_COUNT) {
655 scon->idle_counter++;
656 if (scon->idle_counter >= SDL2_MAX_IDLE_COUNT) {
657 scon->dcl.update_interval = GUI_REFRESH_INTERVAL_DEFAULT;
661 scon->idle_counter = 0;
662 scon->dcl.update_interval = SDL2_REFRESH_INTERVAL_BUSY;
666 static void sdl_mouse_warp(DisplayChangeListener *dcl,
667 int x, int y, int on)
669 struct sdl2_console *scon = container_of(dcl, struct sdl2_console, dcl);
671 if (!qemu_console_is_graphic(scon->dcl.con)) {
679 if (gui_grab || qemu_input_is_absolute() || absolute_enabled) {
680 SDL_SetCursor(guest_sprite);
681 if (!qemu_input_is_absolute() && !absolute_enabled) {
682 SDL_WarpMouseInWindow(scon->real_window, x, y);
685 } else if (gui_grab) {
689 guest_x = x, guest_y = y;
692 static void sdl_mouse_define(DisplayChangeListener *dcl,
697 SDL_FreeCursor(guest_sprite);
700 if (guest_sprite_surface) {
701 SDL_FreeSurface(guest_sprite_surface);
704 guest_sprite_surface =
705 SDL_CreateRGBSurfaceFrom(c->data, c->width, c->height, 32, c->width * 4,
706 0xff0000, 0x00ff00, 0xff, 0xff000000);
708 if (!guest_sprite_surface) {
709 fprintf(stderr, "Failed to make rgb surface from %p\n", c);
712 guest_sprite = SDL_CreateColorCursor(guest_sprite_surface,
715 fprintf(stderr, "Failed to make color cursor from %p\n", c);
719 (gui_grab || qemu_input_is_absolute() || absolute_enabled)) {
720 SDL_SetCursor(guest_sprite);
724 static void sdl_cleanup(void)
727 SDL_FreeCursor(guest_sprite);
729 SDL_QuitSubSystem(SDL_INIT_VIDEO);
732 static const DisplayChangeListenerOps dcl_2d_ops = {
733 .dpy_name = "sdl2-2d",
734 .dpy_gfx_update = sdl2_2d_update,
735 .dpy_gfx_switch = sdl2_2d_switch,
736 .dpy_gfx_check_format = sdl2_2d_check_format,
737 .dpy_refresh = sdl2_2d_refresh,
738 .dpy_mouse_set = sdl_mouse_warp,
739 .dpy_cursor_define = sdl_mouse_define,
743 static const DisplayChangeListenerOps dcl_gl_ops = {
744 .dpy_name = "sdl2-gl",
745 .dpy_gfx_update = sdl2_gl_update,
746 .dpy_gfx_switch = sdl2_gl_switch,
747 .dpy_gfx_check_format = console_gl_check_format,
748 .dpy_refresh = sdl2_gl_refresh,
749 .dpy_mouse_set = sdl_mouse_warp,
750 .dpy_cursor_define = sdl_mouse_define,
752 .dpy_gl_ctx_create = sdl2_gl_create_context,
753 .dpy_gl_ctx_destroy = sdl2_gl_destroy_context,
754 .dpy_gl_ctx_make_current = sdl2_gl_make_context_current,
755 .dpy_gl_ctx_get_current = sdl2_gl_get_current_context,
756 .dpy_gl_scanout_disable = sdl2_gl_scanout_disable,
757 .dpy_gl_scanout_texture = sdl2_gl_scanout_texture,
758 .dpy_gl_update = sdl2_gl_scanout_flush,
762 void sdl_display_early_init(DisplayOptions *o)
764 assert(o->type == DISPLAY_TYPE_SDL);
765 if (o->has_gl && o->gl) {
772 void sdl_display_init(DisplayState *ds, DisplayOptions *o)
780 assert(o->type == DISPLAY_TYPE_SDL);
784 /* on Linux, SDL may use fbcon|directfb|svgalib when run without
785 * accessible $DISPLAY to open X11 window. This is often the case
786 * when qemu is run using sudo. But in this case, and when actually
787 * run in X11 environment, SDL fights with X11 for the video card,
788 * making current display unavailable, often until reboot.
789 * So make x11 the default SDL video driver if this variable is unset.
790 * This is a bit hackish but saves us from bigger problem.
791 * Maybe it's a good idea to fix this in SDL instead.
793 setenv("SDL_VIDEODRIVER", "x11", 0);
796 flags = SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE;
797 if (SDL_Init(flags)) {
798 fprintf(stderr, "Could not initialize SDL(%s) - exiting\n",
802 SDL_SetHint(SDL_HINT_GRAB_KEYBOARD, "1");
803 memset(&info, 0, sizeof(info));
804 SDL_VERSION(&info.version);
807 QemuConsole *con = qemu_console_lookup_by_index(i);
812 sdl2_num_outputs = i;
813 if (sdl2_num_outputs == 0) {
816 sdl2_console = g_new0(struct sdl2_console, sdl2_num_outputs);
817 for (i = 0; i < sdl2_num_outputs; i++) {
818 QemuConsole *con = qemu_console_lookup_by_index(i);
820 if (!qemu_console_is_graphic(con)) {
821 sdl2_console[i].hidden = true;
823 sdl2_console[i].idx = i;
825 sdl2_console[i].opengl = display_opengl;
826 sdl2_console[i].dcl.ops = display_opengl ? &dcl_gl_ops : &dcl_2d_ops;
828 sdl2_console[i].opengl = 0;
829 sdl2_console[i].dcl.ops = &dcl_2d_ops;
831 sdl2_console[i].dcl.con = con;
832 register_displaychangelistener(&sdl2_console[i].dcl);
834 #if defined(SDL_VIDEO_DRIVER_WINDOWS) || defined(SDL_VIDEO_DRIVER_X11)
835 if (SDL_GetWindowWMInfo(sdl2_console[i].real_window, &info)) {
836 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
837 qemu_console_set_window_id(con, (uintptr_t)info.info.win.window);
838 #elif defined(SDL_VIDEO_DRIVER_X11)
839 qemu_console_set_window_id(con, info.info.x11.window);
845 /* Load a 32x32x4 image. White pixels are transparent. */
846 filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, "qemu-icon.bmp");
848 SDL_Surface *image = SDL_LoadBMP(filename);
850 uint32_t colorkey = SDL_MapRGB(image->format, 255, 255, 255);
851 SDL_SetColorKey(image, SDL_TRUE, colorkey);
852 SDL_SetWindowIcon(sdl2_console[0].real_window, image);
857 if (opts->has_full_screen && opts->full_screen) {
862 mouse_mode_notifier.notify = sdl_mouse_mode_change;
863 qemu_add_mouse_mode_change_notifier(&mouse_mode_notifier);
867 sdl_cursor_hidden = SDL_CreateCursor(&data, &data, 8, 1, 0, 0);
868 sdl_cursor_normal = SDL_GetCursor();