xref: /openbmc/qemu/ui/sdl2.c (revision 7eceff5b)
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 /* Ported SDL 1.2 code to 2.0 by Dave Airlie. */
25 
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "ui/console.h"
29 #include "ui/input.h"
30 #include "ui/sdl2.h"
31 #include "sysemu/sysemu.h"
32 
33 static int sdl2_num_outputs;
34 static struct sdl2_console *sdl2_console;
35 static DisplayOptions *opts;
36 
37 static SDL_Surface *guest_sprite_surface;
38 static int gui_grab; /* if true, all keyboard/mouse events are grabbed */
39 
40 static int gui_saved_grab;
41 static int gui_fullscreen;
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;
51 
52 #define SDL2_REFRESH_INTERVAL_BUSY 10
53 #define SDL2_MAX_IDLE_COUNT (2 * GUI_REFRESH_INTERVAL_DEFAULT \
54                              / SDL2_REFRESH_INTERVAL_BUSY + 1)
55 
56 static void sdl_update_caption(struct sdl2_console *scon);
57 
58 static struct sdl2_console *get_scon_from_window(uint32_t window_id)
59 {
60     int i;
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];
64         }
65     }
66     return NULL;
67 }
68 
69 void sdl2_window_create(struct sdl2_console *scon)
70 {
71     int flags = 0;
72 
73     if (!scon->surface) {
74         return;
75     }
76     assert(!scon->real_window);
77 
78     if (gui_fullscreen) {
79         flags |= SDL_WINDOW_FULLSCREEN_DESKTOP;
80     } else {
81         flags |= SDL_WINDOW_RESIZABLE;
82     }
83     if (scon->hidden) {
84         flags |= SDL_WINDOW_HIDDEN;
85     }
86 
87     scon->real_window = SDL_CreateWindow("", SDL_WINDOWPOS_UNDEFINED,
88                                          SDL_WINDOWPOS_UNDEFINED,
89                                          surface_width(scon->surface),
90                                          surface_height(scon->surface),
91                                          flags);
92     scon->real_renderer = SDL_CreateRenderer(scon->real_window, -1, 0);
93     if (scon->opengl) {
94         scon->winctx = SDL_GL_GetCurrentContext();
95     }
96     sdl_update_caption(scon);
97 }
98 
99 void sdl2_window_destroy(struct sdl2_console *scon)
100 {
101     if (!scon->real_window) {
102         return;
103     }
104 
105     SDL_DestroyRenderer(scon->real_renderer);
106     scon->real_renderer = NULL;
107     SDL_DestroyWindow(scon->real_window);
108     scon->real_window = NULL;
109 }
110 
111 void sdl2_window_resize(struct sdl2_console *scon)
112 {
113     if (!scon->real_window) {
114         return;
115     }
116 
117     SDL_SetWindowSize(scon->real_window,
118                       surface_width(scon->surface),
119                       surface_height(scon->surface));
120 }
121 
122 static void sdl2_redraw(struct sdl2_console *scon)
123 {
124     if (scon->opengl) {
125 #ifdef CONFIG_OPENGL
126         sdl2_gl_redraw(scon);
127 #endif
128     } else {
129         sdl2_2d_redraw(scon);
130     }
131 }
132 
133 static void sdl_update_caption(struct sdl2_console *scon)
134 {
135     char win_title[1024];
136     char icon_title[1024];
137     const char *status = "";
138 
139     if (!runstate_is_running()) {
140         status = " [Stopped]";
141     } else if (gui_grab) {
142         if (alt_grab) {
143             status = " - Press Ctrl-Alt-Shift-G to exit grab";
144         } else if (ctrl_grab) {
145             status = " - Press Right-Ctrl-G to exit grab";
146         } else {
147             status = " - Press Ctrl-Alt-G to exit grab";
148         }
149     }
150 
151     if (qemu_name) {
152         snprintf(win_title, sizeof(win_title), "QEMU (%s-%d)%s", qemu_name,
153                  scon->idx, status);
154         snprintf(icon_title, sizeof(icon_title), "QEMU (%s)", qemu_name);
155     } else {
156         snprintf(win_title, sizeof(win_title), "QEMU%s", status);
157         snprintf(icon_title, sizeof(icon_title), "QEMU");
158     }
159 
160     if (scon->real_window) {
161         SDL_SetWindowTitle(scon->real_window, win_title);
162     }
163 }
164 
165 static void sdl_hide_cursor(void)
166 {
167     if (!cursor_hide) {
168         return;
169     }
170 
171     SDL_ShowCursor(SDL_DISABLE);
172     SDL_SetCursor(sdl_cursor_hidden);
173 
174     if (!qemu_input_is_absolute()) {
175         SDL_SetRelativeMouseMode(SDL_TRUE);
176     }
177 }
178 
179 static void sdl_show_cursor(void)
180 {
181     if (!cursor_hide) {
182         return;
183     }
184 
185     if (!qemu_input_is_absolute()) {
186         SDL_SetRelativeMouseMode(SDL_FALSE);
187     }
188 
189     if (guest_cursor &&
190         (gui_grab || qemu_input_is_absolute() || absolute_enabled)) {
191         SDL_SetCursor(guest_sprite);
192     } else {
193         SDL_SetCursor(sdl_cursor_normal);
194     }
195 
196     SDL_ShowCursor(SDL_ENABLE);
197 }
198 
199 static void sdl_grab_start(struct sdl2_console *scon)
200 {
201     QemuConsole *con = scon ? scon->dcl.con : NULL;
202 
203     if (!con || !qemu_console_is_graphic(con)) {
204         return;
205     }
206     /*
207      * If the application is not active, do not try to enter grab state. This
208      * prevents 'SDL_WM_GrabInput(SDL_GRAB_ON)' from blocking all the
209      * application (SDL bug).
210      */
211     if (!(SDL_GetWindowFlags(scon->real_window) & SDL_WINDOW_INPUT_FOCUS)) {
212         return;
213     }
214     if (guest_cursor) {
215         SDL_SetCursor(guest_sprite);
216         if (!qemu_input_is_absolute() && !absolute_enabled) {
217             SDL_WarpMouseInWindow(scon->real_window, guest_x, guest_y);
218         }
219     } else {
220         sdl_hide_cursor();
221     }
222     SDL_SetWindowGrab(scon->real_window, SDL_TRUE);
223     gui_grab = 1;
224     sdl_update_caption(scon);
225 }
226 
227 static void sdl_grab_end(struct sdl2_console *scon)
228 {
229     SDL_SetWindowGrab(scon->real_window, SDL_FALSE);
230     gui_grab = 0;
231     sdl_show_cursor();
232     sdl_update_caption(scon);
233 }
234 
235 static void absolute_mouse_grab(struct sdl2_console *scon)
236 {
237     int mouse_x, mouse_y;
238     int scr_w, scr_h;
239     SDL_GetMouseState(&mouse_x, &mouse_y);
240     SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
241     if (mouse_x > 0 && mouse_x < scr_w - 1 &&
242         mouse_y > 0 && mouse_y < scr_h - 1) {
243         sdl_grab_start(scon);
244     }
245 }
246 
247 static void sdl_mouse_mode_change(Notifier *notify, void *data)
248 {
249     if (qemu_input_is_absolute()) {
250         if (!absolute_enabled) {
251             absolute_enabled = 1;
252             SDL_SetRelativeMouseMode(SDL_FALSE);
253             absolute_mouse_grab(&sdl2_console[0]);
254         }
255     } else if (absolute_enabled) {
256         if (!gui_fullscreen) {
257             sdl_grab_end(&sdl2_console[0]);
258         }
259         absolute_enabled = 0;
260     }
261 }
262 
263 static void sdl_send_mouse_event(struct sdl2_console *scon, int dx, int dy,
264                                  int x, int y, int state)
265 {
266     static uint32_t bmap[INPUT_BUTTON__MAX] = {
267         [INPUT_BUTTON_LEFT]       = SDL_BUTTON(SDL_BUTTON_LEFT),
268         [INPUT_BUTTON_MIDDLE]     = SDL_BUTTON(SDL_BUTTON_MIDDLE),
269         [INPUT_BUTTON_RIGHT]      = SDL_BUTTON(SDL_BUTTON_RIGHT),
270     };
271     static uint32_t prev_state;
272 
273     if (prev_state != state) {
274         qemu_input_update_buttons(scon->dcl.con, bmap, prev_state, state);
275         prev_state = state;
276     }
277 
278     if (qemu_input_is_absolute()) {
279         qemu_input_queue_abs(scon->dcl.con, INPUT_AXIS_X,
280                              x, 0, surface_width(scon->surface));
281         qemu_input_queue_abs(scon->dcl.con, INPUT_AXIS_Y,
282                              y, 0, surface_height(scon->surface));
283     } else {
284         if (guest_cursor) {
285             x -= guest_x;
286             y -= guest_y;
287             guest_x += x;
288             guest_y += y;
289             dx = x;
290             dy = y;
291         }
292         qemu_input_queue_rel(scon->dcl.con, INPUT_AXIS_X, dx);
293         qemu_input_queue_rel(scon->dcl.con, INPUT_AXIS_Y, dy);
294     }
295     qemu_input_event_sync();
296 }
297 
298 static void toggle_full_screen(struct sdl2_console *scon)
299 {
300     gui_fullscreen = !gui_fullscreen;
301     if (gui_fullscreen) {
302         SDL_SetWindowFullscreen(scon->real_window,
303                                 SDL_WINDOW_FULLSCREEN_DESKTOP);
304         gui_saved_grab = gui_grab;
305         sdl_grab_start(scon);
306     } else {
307         if (!gui_saved_grab) {
308             sdl_grab_end(scon);
309         }
310         SDL_SetWindowFullscreen(scon->real_window, 0);
311     }
312     sdl2_redraw(scon);
313 }
314 
315 static int get_mod_state(void)
316 {
317     SDL_Keymod mod = SDL_GetModState();
318 
319     if (alt_grab) {
320         return (mod & (gui_grab_code | KMOD_LSHIFT)) ==
321             (gui_grab_code | KMOD_LSHIFT);
322     } else if (ctrl_grab) {
323         return (mod & KMOD_RCTRL) == KMOD_RCTRL;
324     } else {
325         return (mod & gui_grab_code) == gui_grab_code;
326     }
327 }
328 
329 static void handle_keydown(SDL_Event *ev)
330 {
331     int win;
332     struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
333     int gui_key_modifier_pressed = get_mod_state();
334 
335     if (!scon->ignore_hotkeys && gui_key_modifier_pressed && !ev->key.repeat) {
336         switch (ev->key.keysym.scancode) {
337         case SDL_SCANCODE_2:
338         case SDL_SCANCODE_3:
339         case SDL_SCANCODE_4:
340         case SDL_SCANCODE_5:
341         case SDL_SCANCODE_6:
342         case SDL_SCANCODE_7:
343         case SDL_SCANCODE_8:
344         case SDL_SCANCODE_9:
345             if (gui_grab) {
346                 sdl_grab_end(scon);
347             }
348 
349             win = ev->key.keysym.scancode - SDL_SCANCODE_1;
350             if (win < sdl2_num_outputs) {
351                 sdl2_console[win].hidden = !sdl2_console[win].hidden;
352                 if (sdl2_console[win].real_window) {
353                     if (sdl2_console[win].hidden) {
354                         SDL_HideWindow(sdl2_console[win].real_window);
355                     } else {
356                         SDL_ShowWindow(sdl2_console[win].real_window);
357                     }
358                 }
359                 gui_keysym = 1;
360             }
361             break;
362         case SDL_SCANCODE_F:
363             toggle_full_screen(scon);
364             gui_keysym = 1;
365             break;
366         case SDL_SCANCODE_G:
367             gui_keysym = 1;
368             if (!gui_grab) {
369                 sdl_grab_start(scon);
370             } else if (!gui_fullscreen) {
371                 sdl_grab_end(scon);
372             }
373             break;
374         case SDL_SCANCODE_U:
375             sdl2_window_destroy(scon);
376             sdl2_window_create(scon);
377             if (!scon->opengl) {
378                 /* re-create scon->texture */
379                 sdl2_2d_switch(&scon->dcl, scon->surface);
380             }
381             gui_keysym = 1;
382             break;
383 #if 0
384         case SDL_SCANCODE_KP_PLUS:
385         case SDL_SCANCODE_KP_MINUS:
386             if (!gui_fullscreen) {
387                 int scr_w, scr_h;
388                 int width, height;
389                 SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
390 
391                 width = MAX(scr_w + (ev->key.keysym.scancode ==
392                                      SDL_SCANCODE_KP_PLUS ? 50 : -50),
393                             160);
394                 height = (surface_height(scon->surface) * width) /
395                     surface_width(scon->surface);
396                 fprintf(stderr, "%s: scale to %dx%d\n",
397                         __func__, width, height);
398                 sdl_scale(scon, width, height);
399                 sdl2_redraw(scon);
400                 gui_keysym = 1;
401             }
402 #endif
403         default:
404             break;
405         }
406     }
407     if (!gui_keysym) {
408         sdl2_process_key(scon, &ev->key);
409     }
410 }
411 
412 static void handle_keyup(SDL_Event *ev)
413 {
414     struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
415     int gui_key_modifier_pressed = get_mod_state();
416 
417     scon->ignore_hotkeys = false;
418 
419     if (!gui_key_modifier_pressed) {
420         gui_keysym = 0;
421     }
422     if (!gui_keysym) {
423         sdl2_process_key(scon, &ev->key);
424     }
425 }
426 
427 static void handle_textinput(SDL_Event *ev)
428 {
429     struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
430     QemuConsole *con = scon ? scon->dcl.con : NULL;
431 
432     if (qemu_console_is_graphic(con)) {
433         return;
434     }
435     kbd_put_string_console(con, ev->text.text, strlen(ev->text.text));
436 }
437 
438 static void handle_mousemotion(SDL_Event *ev)
439 {
440     int max_x, max_y;
441     struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
442 
443     if (!qemu_console_is_graphic(scon->dcl.con)) {
444         return;
445     }
446 
447     if (qemu_input_is_absolute() || absolute_enabled) {
448         int scr_w, scr_h;
449         SDL_GetWindowSize(scon->real_window, &scr_w, &scr_h);
450         max_x = scr_w - 1;
451         max_y = scr_h - 1;
452         if (gui_grab && !gui_fullscreen
453             && (ev->motion.x == 0 || ev->motion.y == 0 ||
454                 ev->motion.x == max_x || ev->motion.y == max_y)) {
455             sdl_grab_end(scon);
456         }
457         if (!gui_grab &&
458             (ev->motion.x > 0 && ev->motion.x < max_x &&
459              ev->motion.y > 0 && ev->motion.y < max_y)) {
460             sdl_grab_start(scon);
461         }
462     }
463     if (gui_grab || qemu_input_is_absolute() || absolute_enabled) {
464         sdl_send_mouse_event(scon, ev->motion.xrel, ev->motion.yrel,
465                              ev->motion.x, ev->motion.y, ev->motion.state);
466     }
467 }
468 
469 static void handle_mousebutton(SDL_Event *ev)
470 {
471     int buttonstate = SDL_GetMouseState(NULL, NULL);
472     SDL_MouseButtonEvent *bev;
473     struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
474 
475     if (!qemu_console_is_graphic(scon->dcl.con)) {
476         return;
477     }
478 
479     bev = &ev->button;
480     if (!gui_grab && !qemu_input_is_absolute()) {
481         if (ev->type == SDL_MOUSEBUTTONUP && bev->button == SDL_BUTTON_LEFT) {
482             /* start grabbing all events */
483             sdl_grab_start(scon);
484         }
485     } else {
486         if (ev->type == SDL_MOUSEBUTTONDOWN) {
487             buttonstate |= SDL_BUTTON(bev->button);
488         } else {
489             buttonstate &= ~SDL_BUTTON(bev->button);
490         }
491         sdl_send_mouse_event(scon, 0, 0, bev->x, bev->y, buttonstate);
492     }
493 }
494 
495 static void handle_mousewheel(SDL_Event *ev)
496 {
497     struct sdl2_console *scon = get_scon_from_window(ev->key.windowID);
498     SDL_MouseWheelEvent *wev = &ev->wheel;
499     InputButton btn;
500 
501     if (!qemu_console_is_graphic(scon->dcl.con)) {
502         return;
503     }
504 
505     if (wev->y > 0) {
506         btn = INPUT_BUTTON_WHEEL_UP;
507     } else if (wev->y < 0) {
508         btn = INPUT_BUTTON_WHEEL_DOWN;
509     } else {
510         return;
511     }
512 
513     qemu_input_queue_btn(scon->dcl.con, btn, true);
514     qemu_input_event_sync();
515     qemu_input_queue_btn(scon->dcl.con, btn, false);
516     qemu_input_event_sync();
517 }
518 
519 static void handle_windowevent(SDL_Event *ev)
520 {
521     struct sdl2_console *scon = get_scon_from_window(ev->window.windowID);
522     bool allow_close = true;
523 
524     if (!scon) {
525         return;
526     }
527 
528     switch (ev->window.event) {
529     case SDL_WINDOWEVENT_RESIZED:
530         {
531             QemuUIInfo info;
532             memset(&info, 0, sizeof(info));
533             info.width = ev->window.data1;
534             info.height = ev->window.data2;
535             dpy_set_ui_info(scon->dcl.con, &info);
536         }
537         sdl2_redraw(scon);
538         break;
539     case SDL_WINDOWEVENT_EXPOSED:
540         sdl2_redraw(scon);
541         break;
542     case SDL_WINDOWEVENT_FOCUS_GAINED:
543     case SDL_WINDOWEVENT_ENTER:
544         if (!gui_grab && (qemu_input_is_absolute() || absolute_enabled)) {
545             absolute_mouse_grab(scon);
546         }
547         /* If a new console window opened using a hotkey receives the
548          * focus, SDL sends another KEYDOWN event to the new window,
549          * closing the console window immediately after.
550          *
551          * Work around this by ignoring further hotkey events until a
552          * key is released.
553          */
554         scon->ignore_hotkeys = get_mod_state();
555         break;
556     case SDL_WINDOWEVENT_FOCUS_LOST:
557         if (gui_grab && !gui_fullscreen) {
558             sdl_grab_end(scon);
559         }
560         break;
561     case SDL_WINDOWEVENT_RESTORED:
562         update_displaychangelistener(&scon->dcl, GUI_REFRESH_INTERVAL_DEFAULT);
563         break;
564     case SDL_WINDOWEVENT_MINIMIZED:
565         update_displaychangelistener(&scon->dcl, 500);
566         break;
567     case SDL_WINDOWEVENT_CLOSE:
568         if (qemu_console_is_graphic(scon->dcl.con)) {
569             if (opts->has_window_close && !opts->window_close) {
570                 allow_close = false;
571             }
572             if (allow_close) {
573                 no_shutdown = 0;
574                 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
575             }
576         } else {
577             SDL_HideWindow(scon->real_window);
578             scon->hidden = true;
579         }
580         break;
581     case SDL_WINDOWEVENT_SHOWN:
582         scon->hidden = false;
583         break;
584     case SDL_WINDOWEVENT_HIDDEN:
585         scon->hidden = true;
586         break;
587     }
588 }
589 
590 void sdl2_poll_events(struct sdl2_console *scon)
591 {
592     SDL_Event ev1, *ev = &ev1;
593     bool allow_close = true;
594     int idle = 1;
595 
596     if (scon->last_vm_running != runstate_is_running()) {
597         scon->last_vm_running = runstate_is_running();
598         sdl_update_caption(scon);
599     }
600 
601     while (SDL_PollEvent(ev)) {
602         switch (ev->type) {
603         case SDL_KEYDOWN:
604             idle = 0;
605             handle_keydown(ev);
606             break;
607         case SDL_KEYUP:
608             idle = 0;
609             handle_keyup(ev);
610             break;
611         case SDL_TEXTINPUT:
612             idle = 0;
613             handle_textinput(ev);
614             break;
615         case SDL_QUIT:
616             if (opts->has_window_close && !opts->window_close) {
617                 allow_close = false;
618             }
619             if (allow_close) {
620                 no_shutdown = 0;
621                 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
622             }
623             break;
624         case SDL_MOUSEMOTION:
625             idle = 0;
626             handle_mousemotion(ev);
627             break;
628         case SDL_MOUSEBUTTONDOWN:
629         case SDL_MOUSEBUTTONUP:
630             idle = 0;
631             handle_mousebutton(ev);
632             break;
633         case SDL_MOUSEWHEEL:
634             idle = 0;
635             handle_mousewheel(ev);
636             break;
637         case SDL_WINDOWEVENT:
638             handle_windowevent(ev);
639             break;
640         default:
641             break;
642         }
643     }
644 
645     if (idle) {
646         if (scon->idle_counter < SDL2_MAX_IDLE_COUNT) {
647             scon->idle_counter++;
648             if (scon->idle_counter >= SDL2_MAX_IDLE_COUNT) {
649                 scon->dcl.update_interval = GUI_REFRESH_INTERVAL_DEFAULT;
650             }
651         }
652     } else {
653         scon->idle_counter = 0;
654         scon->dcl.update_interval = SDL2_REFRESH_INTERVAL_BUSY;
655     }
656 }
657 
658 static void sdl_mouse_warp(DisplayChangeListener *dcl,
659                            int x, int y, int on)
660 {
661     struct sdl2_console *scon = container_of(dcl, struct sdl2_console, dcl);
662 
663     if (!qemu_console_is_graphic(scon->dcl.con)) {
664         return;
665     }
666 
667     if (on) {
668         if (!guest_cursor) {
669             sdl_show_cursor();
670         }
671         if (gui_grab || qemu_input_is_absolute() || absolute_enabled) {
672             SDL_SetCursor(guest_sprite);
673             if (!qemu_input_is_absolute() && !absolute_enabled) {
674                 SDL_WarpMouseInWindow(scon->real_window, x, y);
675             }
676         }
677     } else if (gui_grab) {
678         sdl_hide_cursor();
679     }
680     guest_cursor = on;
681     guest_x = x, guest_y = y;
682 }
683 
684 static void sdl_mouse_define(DisplayChangeListener *dcl,
685                              QEMUCursor *c)
686 {
687 
688     if (guest_sprite) {
689         SDL_FreeCursor(guest_sprite);
690     }
691 
692     if (guest_sprite_surface) {
693         SDL_FreeSurface(guest_sprite_surface);
694     }
695 
696     guest_sprite_surface =
697         SDL_CreateRGBSurfaceFrom(c->data, c->width, c->height, 32, c->width * 4,
698                                  0xff0000, 0x00ff00, 0xff, 0xff000000);
699 
700     if (!guest_sprite_surface) {
701         fprintf(stderr, "Failed to make rgb surface from %p\n", c);
702         return;
703     }
704     guest_sprite = SDL_CreateColorCursor(guest_sprite_surface,
705                                          c->hot_x, c->hot_y);
706     if (!guest_sprite) {
707         fprintf(stderr, "Failed to make color cursor from %p\n", c);
708         return;
709     }
710     if (guest_cursor &&
711         (gui_grab || qemu_input_is_absolute() || absolute_enabled)) {
712         SDL_SetCursor(guest_sprite);
713     }
714 }
715 
716 static void sdl_cleanup(void)
717 {
718     if (guest_sprite) {
719         SDL_FreeCursor(guest_sprite);
720     }
721     SDL_QuitSubSystem(SDL_INIT_VIDEO);
722 }
723 
724 static const DisplayChangeListenerOps dcl_2d_ops = {
725     .dpy_name             = "sdl2-2d",
726     .dpy_gfx_update       = sdl2_2d_update,
727     .dpy_gfx_switch       = sdl2_2d_switch,
728     .dpy_gfx_check_format = sdl2_2d_check_format,
729     .dpy_refresh          = sdl2_2d_refresh,
730     .dpy_mouse_set        = sdl_mouse_warp,
731     .dpy_cursor_define    = sdl_mouse_define,
732 };
733 
734 #ifdef CONFIG_OPENGL
735 static const DisplayChangeListenerOps dcl_gl_ops = {
736     .dpy_name                = "sdl2-gl",
737     .dpy_gfx_update          = sdl2_gl_update,
738     .dpy_gfx_switch          = sdl2_gl_switch,
739     .dpy_gfx_check_format    = console_gl_check_format,
740     .dpy_refresh             = sdl2_gl_refresh,
741     .dpy_mouse_set           = sdl_mouse_warp,
742     .dpy_cursor_define       = sdl_mouse_define,
743 
744     .dpy_gl_ctx_create       = sdl2_gl_create_context,
745     .dpy_gl_ctx_destroy      = sdl2_gl_destroy_context,
746     .dpy_gl_ctx_make_current = sdl2_gl_make_context_current,
747     .dpy_gl_ctx_get_current  = sdl2_gl_get_current_context,
748     .dpy_gl_scanout_disable  = sdl2_gl_scanout_disable,
749     .dpy_gl_scanout_texture  = sdl2_gl_scanout_texture,
750     .dpy_gl_update           = sdl2_gl_scanout_flush,
751 };
752 #endif
753 
754 static void sdl2_display_early_init(DisplayOptions *o)
755 {
756     assert(o->type == DISPLAY_TYPE_SDL);
757     if (o->has_gl && o->gl) {
758 #ifdef CONFIG_OPENGL
759         display_opengl = 1;
760 #endif
761     }
762 }
763 
764 static void sdl2_display_init(DisplayState *ds, DisplayOptions *o)
765 {
766     int flags;
767     uint8_t data = 0;
768     char *filename;
769     int i;
770     SDL_SysWMinfo info;
771 
772     assert(o->type == DISPLAY_TYPE_SDL);
773     opts = o;
774 
775 #ifdef __linux__
776     /* on Linux, SDL may use fbcon|directfb|svgalib when run without
777      * accessible $DISPLAY to open X11 window.  This is often the case
778      * when qemu is run using sudo.  But in this case, and when actually
779      * run in X11 environment, SDL fights with X11 for the video card,
780      * making current display unavailable, often until reboot.
781      * So make x11 the default SDL video driver if this variable is unset.
782      * This is a bit hackish but saves us from bigger problem.
783      * Maybe it's a good idea to fix this in SDL instead.
784      */
785     setenv("SDL_VIDEODRIVER", "x11", 0);
786 #endif
787 
788     flags = SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE;
789     if (SDL_Init(flags)) {
790         fprintf(stderr, "Could not initialize SDL(%s) - exiting\n",
791                 SDL_GetError());
792         exit(1);
793     }
794     SDL_SetHint(SDL_HINT_GRAB_KEYBOARD, "1");
795     memset(&info, 0, sizeof(info));
796     SDL_VERSION(&info.version);
797 
798     for (i = 0;; i++) {
799         QemuConsole *con = qemu_console_lookup_by_index(i);
800         if (!con) {
801             break;
802         }
803     }
804     sdl2_num_outputs = i;
805     if (sdl2_num_outputs == 0) {
806         return;
807     }
808     sdl2_console = g_new0(struct sdl2_console, sdl2_num_outputs);
809     for (i = 0; i < sdl2_num_outputs; i++) {
810         QemuConsole *con = qemu_console_lookup_by_index(i);
811         assert(con != NULL);
812         if (!qemu_console_is_graphic(con)) {
813             sdl2_console[i].hidden = true;
814         }
815         sdl2_console[i].idx = i;
816 #ifdef CONFIG_OPENGL
817         sdl2_console[i].opengl = display_opengl;
818         sdl2_console[i].dcl.ops = display_opengl ? &dcl_gl_ops : &dcl_2d_ops;
819 #else
820         sdl2_console[i].opengl = 0;
821         sdl2_console[i].dcl.ops = &dcl_2d_ops;
822 #endif
823         sdl2_console[i].dcl.con = con;
824         register_displaychangelistener(&sdl2_console[i].dcl);
825 
826 #if defined(SDL_VIDEO_DRIVER_WINDOWS) || defined(SDL_VIDEO_DRIVER_X11)
827         if (SDL_GetWindowWMInfo(sdl2_console[i].real_window, &info)) {
828 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
829             qemu_console_set_window_id(con, (uintptr_t)info.info.win.window);
830 #elif defined(SDL_VIDEO_DRIVER_X11)
831             qemu_console_set_window_id(con, info.info.x11.window);
832 #endif
833         }
834 #endif
835     }
836 
837     /* Load a 32x32x4 image. White pixels are transparent. */
838     filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, "qemu-icon.bmp");
839     if (filename) {
840         SDL_Surface *image = SDL_LoadBMP(filename);
841         if (image) {
842             uint32_t colorkey = SDL_MapRGB(image->format, 255, 255, 255);
843             SDL_SetColorKey(image, SDL_TRUE, colorkey);
844             SDL_SetWindowIcon(sdl2_console[0].real_window, image);
845         }
846         g_free(filename);
847     }
848 
849     if (opts->has_full_screen && opts->full_screen) {
850         gui_fullscreen = 1;
851         sdl_grab_start(0);
852     }
853 
854     mouse_mode_notifier.notify = sdl_mouse_mode_change;
855     qemu_add_mouse_mode_change_notifier(&mouse_mode_notifier);
856 
857     gui_grab = 0;
858 
859     sdl_cursor_hidden = SDL_CreateCursor(&data, &data, 8, 1, 0, 0);
860     sdl_cursor_normal = SDL_GetCursor();
861 
862     atexit(sdl_cleanup);
863 }
864 
865 static QemuDisplay qemu_display_sdl2 = {
866     .type       = DISPLAY_TYPE_SDL,
867     .early_init = sdl2_display_early_init,
868     .init       = sdl2_display_init,
869 };
870 
871 static void register_sdl1(void)
872 {
873     qemu_display_register(&qemu_display_sdl2);
874 }
875 
876 type_init(register_sdl1);
877