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-common.h"
27 #include "ui/console.h"
30 #include "sysemu/sysemu.h"
32 static int sdl2_num_outputs;
33 static struct sdl2_console *sdl2_console;
35 static SDL_Surface *guest_sprite_surface;
36 static int gui_grab; /* if true, all keyboard/mouse events are grabbed */
38 static int gui_saved_grab;
39 static int gui_fullscreen;
40 static int gui_noframe;
41 static int gui_key_modifier_pressed;
42 static int gui_keysym;
43 static int gui_grab_code = KMOD_LALT | KMOD_LCTRL;
44 static SDL_Cursor *sdl_cursor_normal;
45 static SDL_Cursor *sdl_cursor_hidden;
46 static int absolute_enabled;
47 static int guest_cursor;
48 static int guest_x, guest_y;
49 static SDL_Cursor *guest_sprite;
50 static Notifier mouse_mode_notifier;
52 #define SDL2_REFRESH_INTERVAL_BUSY 10
53 #define SDL2_MAX_IDLE_COUNT (2 * GUI_REFRESH_INTERVAL_DEFAULT \
54 / SDL2_REFRESH_INTERVAL_BUSY + 1)
56 static void sdl_update_caption(struct sdl2_console *scon);
58 static struct sdl2_console *get_scon_from_window(uint32_t window_id)
61 for (i = 0; i < sdl2_num_outputs; i++) {
62 if (sdl2_console[i].real_window == SDL_GetWindowFromID(window_id)) {
63 return &sdl2_console[i];
69 void sdl2_window_create(struct sdl2_console *scon)
76 assert(!scon->real_window);
79 flags |= SDL_WINDOW_FULLSCREEN_DESKTOP;
81 flags |= SDL_WINDOW_RESIZABLE;
84 flags |= SDL_WINDOW_HIDDEN;
87 scon->real_window = SDL_CreateWindow("", SDL_WINDOWPOS_UNDEFINED,
88 SDL_WINDOWPOS_UNDEFINED,
89 surface_width(scon->surface),
90 surface_height(scon->surface),
92 scon->real_renderer = SDL_CreateRenderer(scon->real_window, -1, 0);
94 scon->winctx = SDL_GL_GetCurrentContext();
96 sdl_update_caption(scon);
99 void sdl2_window_destroy(struct sdl2_console *scon)
101 if (!scon->real_window) {
105 SDL_DestroyRenderer(scon->real_renderer);
106 scon->real_renderer = NULL;
107 SDL_DestroyWindow(scon->real_window);
108 scon->real_window = NULL;
111 void sdl2_window_resize(struct sdl2_console *scon)
113 if (!scon->real_window) {
117 SDL_SetWindowSize(scon->real_window,
118 surface_width(scon->surface),
119 surface_height(scon->surface));
122 static void sdl2_redraw(struct sdl2_console *scon)
126 sdl2_gl_redraw(scon);
129 sdl2_2d_redraw(scon);
133 static void sdl_update_caption(struct sdl2_console *scon)
135 char win_title[1024];
136 char icon_title[1024];
137 const char *status = "";
139 if (!runstate_is_running()) {
140 status = " [Stopped]";
141 } else if (gui_grab) {
143 status = " - Press Ctrl-Alt-Shift to exit grab";
144 } else if (ctrl_grab) {
145 status = " - Press Right-Ctrl to exit grab";
147 status = " - Press Ctrl-Alt to exit grab";
152 snprintf(win_title, sizeof(win_title), "QEMU (%s-%d)%s", qemu_name,
154 snprintf(icon_title, sizeof(icon_title), "QEMU (%s)", qemu_name);
156 snprintf(win_title, sizeof(win_title), "QEMU%s", status);
157 snprintf(icon_title, sizeof(icon_title), "QEMU");
160 if (scon->real_window) {
161 SDL_SetWindowTitle(scon->real_window, win_title);
165 static void sdl_hide_cursor(void)
171 if (qemu_input_is_absolute()) {
173 SDL_SetCursor(sdl_cursor_hidden);
175 SDL_SetRelativeMouseMode(SDL_TRUE);
179 static void sdl_show_cursor(void)
185 if (!qemu_input_is_absolute()) {
186 SDL_SetRelativeMouseMode(SDL_FALSE);
189 (gui_grab || qemu_input_is_absolute() || absolute_enabled)) {
190 SDL_SetCursor(guest_sprite);
192 SDL_SetCursor(sdl_cursor_normal);
197 static void sdl_grab_start(struct sdl2_console *scon)
199 QemuConsole *con = scon ? scon->dcl.con : NULL;
201 if (!con || !qemu_console_is_graphic(con)) {
205 * If the application is not active, do not try to enter grab state. This
206 * prevents 'SDL_WM_GrabInput(SDL_GRAB_ON)' from blocking all the
207 * application (SDL bug).
209 if (!(SDL_GetWindowFlags(scon->real_window) & SDL_WINDOW_INPUT_FOCUS)) {
213 SDL_SetCursor(guest_sprite);
214 if (!qemu_input_is_absolute() && !absolute_enabled) {
215 SDL_WarpMouseInWindow(scon->real_window, guest_x, guest_y);
220 SDL_SetWindowGrab(scon->real_window, SDL_TRUE);
222 sdl_update_caption(scon);
225 static void sdl_grab_end(struct sdl2_console *scon)
227 SDL_SetWindowGrab(scon->real_window, SDL_FALSE);
230 sdl_update_caption(scon);
233 static void absolute_mouse_grab(struct sdl2_console *scon)
235 int mouse_x, mouse_y;
237 SDL_GetMouseState(&mouse_x, &mouse_y);
238 SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
239 if (mouse_x > 0 && mouse_x < scr_w - 1 &&
240 mouse_y > 0 && mouse_y < scr_h - 1) {
241 sdl_grab_start(scon);
245 static void sdl_mouse_mode_change(Notifier *notify, void *data)
247 if (qemu_input_is_absolute()) {
248 if (!absolute_enabled) {
249 absolute_enabled = 1;
250 absolute_mouse_grab(&sdl2_console[0]);
252 } else if (absolute_enabled) {
253 if (!gui_fullscreen) {
254 sdl_grab_end(&sdl2_console[0]);
256 absolute_enabled = 0;
260 static void sdl_send_mouse_event(struct sdl2_console *scon, int dx, int dy,
261 int x, int y, int state)
263 static uint32_t bmap[INPUT_BUTTON__MAX] = {
264 [INPUT_BUTTON_LEFT] = SDL_BUTTON(SDL_BUTTON_LEFT),
265 [INPUT_BUTTON_MIDDLE] = SDL_BUTTON(SDL_BUTTON_MIDDLE),
266 [INPUT_BUTTON_RIGHT] = SDL_BUTTON(SDL_BUTTON_RIGHT),
268 static uint32_t prev_state;
270 if (prev_state != state) {
271 qemu_input_update_buttons(scon->dcl.con, bmap, prev_state, state);
275 if (qemu_input_is_absolute()) {
277 int max_w = 0, max_h = 0;
278 int off_x = 0, off_y = 0;
279 int cur_off_x = 0, cur_off_y = 0;
282 for (i = 0; i < sdl2_num_outputs; i++) {
283 struct sdl2_console *thiscon = &sdl2_console[i];
284 if (thiscon->real_window && thiscon->surface) {
285 SDL_GetWindowSize(thiscon->real_window, &scr_w, &scr_h);
286 cur_off_x = thiscon->x;
287 cur_off_y = thiscon->y;
288 if (scr_w + cur_off_x > max_w) {
289 max_w = scr_w + cur_off_x;
291 if (scr_h + cur_off_y > max_h) {
292 max_h = scr_h + cur_off_y;
294 if (i == scon->idx) {
300 qemu_input_queue_abs(scon->dcl.con, INPUT_AXIS_X, off_x + x, max_w);
301 qemu_input_queue_abs(scon->dcl.con, INPUT_AXIS_Y, off_y + y, max_h);
311 qemu_input_queue_rel(scon->dcl.con, INPUT_AXIS_X, dx);
312 qemu_input_queue_rel(scon->dcl.con, INPUT_AXIS_Y, dy);
314 qemu_input_event_sync();
317 static void toggle_full_screen(struct sdl2_console *scon)
319 gui_fullscreen = !gui_fullscreen;
320 if (gui_fullscreen) {
321 SDL_SetWindowFullscreen(scon->real_window,
322 SDL_WINDOW_FULLSCREEN_DESKTOP);
323 gui_saved_grab = gui_grab;
324 sdl_grab_start(scon);
326 if (!gui_saved_grab) {
329 SDL_SetWindowFullscreen(scon->real_window, 0);
334 static void handle_keydown(SDL_Event *ev)
337 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
340 mod_state = (SDL_GetModState() & (gui_grab_code | KMOD_LSHIFT)) ==
341 (gui_grab_code | KMOD_LSHIFT);
342 } else if (ctrl_grab) {
343 mod_state = (SDL_GetModState() & KMOD_RCTRL) == KMOD_RCTRL;
345 mod_state = (SDL_GetModState() & gui_grab_code) == gui_grab_code;
347 gui_key_modifier_pressed = mod_state;
349 if (gui_key_modifier_pressed) {
350 switch (ev->key.keysym.scancode) {
359 win = ev->key.keysym.scancode - SDL_SCANCODE_1;
360 if (win < sdl2_num_outputs) {
361 sdl2_console[win].hidden = !sdl2_console[win].hidden;
362 if (sdl2_console[win].real_window) {
363 if (sdl2_console[win].hidden) {
364 SDL_HideWindow(sdl2_console[win].real_window);
366 SDL_ShowWindow(sdl2_console[win].real_window);
373 toggle_full_screen(scon);
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);
420 mod_state = (ev->key.keysym.mod & gui_grab_code);
422 mod_state = (ev->key.keysym.mod & (gui_grab_code | KMOD_LSHIFT));
424 if (!mod_state && gui_key_modifier_pressed) {
425 gui_key_modifier_pressed = 0;
426 if (gui_keysym == 0) {
427 /* exit/enter grab if pressing Ctrl-Alt */
429 sdl_grab_start(scon);
430 } else if (!gui_fullscreen) {
433 /* SDL does not send back all the modifiers key, so we must
435 sdl2_reset_keys(scon);
441 sdl2_process_key(scon, &ev->key);
445 static void handle_textinput(SDL_Event *ev)
447 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
448 QemuConsole *con = scon ? scon->dcl.con : NULL;
450 if (qemu_console_is_graphic(con)) {
453 kbd_put_string_console(con, ev->text.text, strlen(ev->text.text));
456 static void handle_mousemotion(SDL_Event *ev)
459 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
461 if (qemu_input_is_absolute() || absolute_enabled) {
463 SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
466 if (gui_grab && (ev->motion.x == 0 || ev->motion.y == 0 ||
467 ev->motion.x == max_x || ev->motion.y == max_y)) {
471 (ev->motion.x > 0 && ev->motion.x < max_x &&
472 ev->motion.y > 0 && ev->motion.y < max_y)) {
473 sdl_grab_start(scon);
476 if (gui_grab || qemu_input_is_absolute() || absolute_enabled) {
477 sdl_send_mouse_event(scon, ev->motion.xrel, ev->motion.yrel,
478 ev->motion.x, ev->motion.y, ev->motion.state);
482 static void handle_mousebutton(SDL_Event *ev)
484 int buttonstate = SDL_GetMouseState(NULL, NULL);
485 SDL_MouseButtonEvent *bev;
486 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
489 if (!gui_grab && !qemu_input_is_absolute()) {
490 if (ev->type == SDL_MOUSEBUTTONUP && bev->button == SDL_BUTTON_LEFT) {
491 /* start grabbing all events */
492 sdl_grab_start(scon);
495 if (ev->type == SDL_MOUSEBUTTONDOWN) {
496 buttonstate |= SDL_BUTTON(bev->button);
498 buttonstate &= ~SDL_BUTTON(bev->button);
500 sdl_send_mouse_event(scon, 0, 0, bev->x, bev->y, buttonstate);
504 static void handle_mousewheel(SDL_Event *ev)
506 struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
507 SDL_MouseWheelEvent *wev = &ev->wheel;
511 btn = INPUT_BUTTON_WHEELUP;
512 } else if (wev->y < 0) {
513 btn = INPUT_BUTTON_WHEELDOWN;
518 qemu_input_queue_btn(scon->dcl.con, btn, true);
519 qemu_input_event_sync();
520 qemu_input_queue_btn(scon->dcl.con, btn, false);
521 qemu_input_event_sync();
524 static void handle_windowevent(SDL_Event *ev)
526 struct sdl2_console *scon = get_scon_from_window(ev->window.windowID);
532 switch (ev->window.event) {
533 case SDL_WINDOWEVENT_RESIZED:
536 memset(&info, 0, sizeof(info));
537 info.width = ev->window.data1;
538 info.height = ev->window.data2;
539 dpy_set_ui_info(scon->dcl.con, &info);
543 case SDL_WINDOWEVENT_EXPOSED:
546 case SDL_WINDOWEVENT_FOCUS_GAINED:
547 case SDL_WINDOWEVENT_ENTER:
548 if (!gui_grab && (qemu_input_is_absolute() || absolute_enabled)) {
549 absolute_mouse_grab(scon);
552 case SDL_WINDOWEVENT_FOCUS_LOST:
553 if (gui_grab && !gui_fullscreen) {
557 case SDL_WINDOWEVENT_RESTORED:
558 update_displaychangelistener(&scon->dcl, GUI_REFRESH_INTERVAL_DEFAULT);
560 case SDL_WINDOWEVENT_MINIMIZED:
561 update_displaychangelistener(&scon->dcl, 500);
563 case SDL_WINDOWEVENT_CLOSE:
566 qemu_system_shutdown_request();
569 case SDL_WINDOWEVENT_SHOWN:
571 SDL_HideWindow(scon->real_window);
574 case SDL_WINDOWEVENT_HIDDEN:
576 SDL_ShowWindow(scon->real_window);
582 void sdl2_poll_events(struct sdl2_console *scon)
584 SDL_Event ev1, *ev = &ev1;
587 if (scon->last_vm_running != runstate_is_running()) {
588 scon->last_vm_running = runstate_is_running();
589 sdl_update_caption(scon);
592 while (SDL_PollEvent(ev)) {
604 handle_textinput(ev);
609 qemu_system_shutdown_request();
612 case SDL_MOUSEMOTION:
614 handle_mousemotion(ev);
616 case SDL_MOUSEBUTTONDOWN:
617 case SDL_MOUSEBUTTONUP:
619 handle_mousebutton(ev);
623 handle_mousewheel(ev);
625 case SDL_WINDOWEVENT:
626 handle_windowevent(ev);
634 if (scon->idle_counter < SDL2_MAX_IDLE_COUNT) {
635 scon->idle_counter++;
636 if (scon->idle_counter >= SDL2_MAX_IDLE_COUNT) {
637 scon->dcl.update_interval = GUI_REFRESH_INTERVAL_DEFAULT;
641 scon->idle_counter = 0;
642 scon->dcl.update_interval = SDL2_REFRESH_INTERVAL_BUSY;
646 static void sdl_mouse_warp(DisplayChangeListener *dcl,
647 int x, int y, int on)
649 struct sdl2_console *scon = container_of(dcl, struct sdl2_console, dcl);
654 if (gui_grab || qemu_input_is_absolute() || absolute_enabled) {
655 SDL_SetCursor(guest_sprite);
656 if (!qemu_input_is_absolute() && !absolute_enabled) {
657 SDL_WarpMouseInWindow(scon->real_window, x, y);
660 } else if (gui_grab) {
664 guest_x = x, guest_y = y;
667 static void sdl_mouse_define(DisplayChangeListener *dcl,
672 SDL_FreeCursor(guest_sprite);
675 if (guest_sprite_surface) {
676 SDL_FreeSurface(guest_sprite_surface);
679 guest_sprite_surface =
680 SDL_CreateRGBSurfaceFrom(c->data, c->width, c->height, 32, c->width * 4,
681 0xff0000, 0x00ff00, 0xff, 0xff000000);
683 if (!guest_sprite_surface) {
684 fprintf(stderr, "Failed to make rgb surface from %p\n", c);
687 guest_sprite = SDL_CreateColorCursor(guest_sprite_surface,
690 fprintf(stderr, "Failed to make color cursor from %p\n", c);
694 (gui_grab || qemu_input_is_absolute() || absolute_enabled)) {
695 SDL_SetCursor(guest_sprite);
699 static void sdl_cleanup(void)
702 SDL_FreeCursor(guest_sprite);
704 SDL_QuitSubSystem(SDL_INIT_VIDEO);
707 static const DisplayChangeListenerOps dcl_2d_ops = {
708 .dpy_name = "sdl2-2d",
709 .dpy_gfx_update = sdl2_2d_update,
710 .dpy_gfx_switch = sdl2_2d_switch,
711 .dpy_gfx_check_format = sdl2_2d_check_format,
712 .dpy_refresh = sdl2_2d_refresh,
713 .dpy_mouse_set = sdl_mouse_warp,
714 .dpy_cursor_define = sdl_mouse_define,
718 static const DisplayChangeListenerOps dcl_gl_ops = {
719 .dpy_name = "sdl2-gl",
720 .dpy_gfx_update = sdl2_gl_update,
721 .dpy_gfx_switch = sdl2_gl_switch,
722 .dpy_gfx_check_format = console_gl_check_format,
723 .dpy_refresh = sdl2_gl_refresh,
724 .dpy_mouse_set = sdl_mouse_warp,
725 .dpy_cursor_define = sdl_mouse_define,
727 .dpy_gl_ctx_create = sdl2_gl_create_context,
728 .dpy_gl_ctx_destroy = sdl2_gl_destroy_context,
729 .dpy_gl_ctx_make_current = sdl2_gl_make_context_current,
730 .dpy_gl_ctx_get_current = sdl2_gl_get_current_context,
731 .dpy_gl_scanout = sdl2_gl_scanout,
732 .dpy_gl_update = sdl2_gl_scanout_flush,
736 void sdl_display_early_init(int opengl)
739 case -1: /* default */
748 g_assert_not_reached();
753 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame)
765 /* on Linux, SDL may use fbcon|directfb|svgalib when run without
766 * accessible $DISPLAY to open X11 window. This is often the case
767 * when qemu is run using sudo. But in this case, and when actually
768 * run in X11 environment, SDL fights with X11 for the video card,
769 * making current display unavailable, often until reboot.
770 * So make x11 the default SDL video driver if this variable is unset.
771 * This is a bit hackish but saves us from bigger problem.
772 * Maybe it's a good idea to fix this in SDL instead.
774 setenv("SDL_VIDEODRIVER", "x11", 0);
777 flags = SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE;
778 if (SDL_Init(flags)) {
779 fprintf(stderr, "Could not initialize SDL(%s) - exiting\n",
783 SDL_SetHint(SDL_HINT_GRAB_KEYBOARD, "1");
786 QemuConsole *con = qemu_console_lookup_by_index(i);
791 sdl2_num_outputs = i;
792 sdl2_console = g_new0(struct sdl2_console, sdl2_num_outputs);
793 for (i = 0; i < sdl2_num_outputs; i++) {
794 QemuConsole *con = qemu_console_lookup_by_index(i);
795 if (!qemu_console_is_graphic(con)) {
796 sdl2_console[i].hidden = true;
798 sdl2_console[i].idx = i;
800 sdl2_console[i].opengl = display_opengl;
801 sdl2_console[i].dcl.ops = display_opengl ? &dcl_gl_ops : &dcl_2d_ops;
803 sdl2_console[i].opengl = 0;
804 sdl2_console[i].dcl.ops = &dcl_2d_ops;
806 sdl2_console[i].dcl.con = con;
807 register_displaychangelistener(&sdl2_console[i].dcl);
810 /* Load a 32x32x4 image. White pixels are transparent. */
811 filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, "qemu-icon.bmp");
813 SDL_Surface *image = SDL_LoadBMP(filename);
815 uint32_t colorkey = SDL_MapRGB(image->format, 255, 255, 255);
816 SDL_SetColorKey(image, SDL_TRUE, colorkey);
817 SDL_SetWindowIcon(sdl2_console[0].real_window, image);
827 mouse_mode_notifier.notify = sdl_mouse_mode_change;
828 qemu_add_mouse_mode_change_notifier(&mouse_mode_notifier);
832 sdl_cursor_hidden = SDL_CreateCursor(&data, &data, 8, 1, 0, 0);
833 sdl_cursor_normal = SDL_GetCursor();