4 #include "ui/qemu-pixman.h"
5 #include "qom/object.h"
6 #include "qemu/notify.h"
7 #include "qapi/qapi-types-ui.h"
11 # include <epoxy/gl.h>
12 # include "ui/shader.h"
15 /* keyboard/mouse support */
17 #define MOUSE_EVENT_LBUTTON 0x01
18 #define MOUSE_EVENT_RBUTTON 0x02
19 #define MOUSE_EVENT_MBUTTON 0x04
20 #define MOUSE_EVENT_WHEELUP 0x08
21 #define MOUSE_EVENT_WHEELDN 0x10
23 /* identical to the ps/2 keyboard bits */
24 #define QEMU_SCROLL_LOCK_LED (1 << 0)
25 #define QEMU_NUM_LOCK_LED (1 << 1)
26 #define QEMU_CAPS_LOCK_LED (1 << 2)
29 #define GUI_REFRESH_INTERVAL_DEFAULT 30
30 #define GUI_REFRESH_INTERVAL_IDLE 3000
32 /* Color number is match to standard vga palette */
33 enum qemu_color_names
{
39 QEMU_COLOR_MAGENTA
= 5,
40 QEMU_COLOR_YELLOW
= 6,
43 /* Convert to curses char attributes */
44 #define ATTR2CHTYPE(c, fg, bg, bold) \
45 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
47 typedef void QEMUPutKBDEvent(void *opaque
, int keycode
);
48 typedef void QEMUPutLEDEvent(void *opaque
, int ledstate
);
49 typedef void QEMUPutMouseEvent(void *opaque
, int dx
, int dy
, int dz
, int buttons_state
);
51 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry
;
52 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry
;
53 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry
;
55 QEMUPutKbdEntry
*qemu_add_kbd_event_handler(QEMUPutKBDEvent
*func
,
57 QEMUPutMouseEntry
*qemu_add_mouse_event_handler(QEMUPutMouseEvent
*func
,
58 void *opaque
, int absolute
,
60 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry
*entry
);
61 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry
*entry
);
63 QEMUPutLEDEntry
*qemu_add_led_event_handler(QEMUPutLEDEvent
*func
, void *opaque
);
64 void qemu_remove_led_event_handler(QEMUPutLEDEntry
*entry
);
66 void kbd_put_ledstate(int ledstate
);
68 bool qemu_mouse_set(int index
, Error
**errp
);
70 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
72 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
73 #define QEMU_KEY_TAB 0x0009
74 #define QEMU_KEY_BACKSPACE 0x007f
75 #define QEMU_KEY_UP QEMU_KEY_ESC1('A')
76 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
77 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
78 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
79 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
80 #define QEMU_KEY_END QEMU_KEY_ESC1(4)
81 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
82 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
83 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
85 #define QEMU_KEY_CTRL_UP 0xe400
86 #define QEMU_KEY_CTRL_DOWN 0xe401
87 #define QEMU_KEY_CTRL_LEFT 0xe402
88 #define QEMU_KEY_CTRL_RIGHT 0xe403
89 #define QEMU_KEY_CTRL_HOME 0xe404
90 #define QEMU_KEY_CTRL_END 0xe405
91 #define QEMU_KEY_CTRL_PAGEUP 0xe406
92 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407
94 void kbd_put_keysym_console(QemuConsole
*s
, int keysym
);
95 bool kbd_put_qcode_console(QemuConsole
*s
, int qcode
, bool ctrl
);
96 void kbd_put_string_console(QemuConsole
*s
, const char *str
, int len
);
97 void kbd_put_keysym(int keysym
);
100 typedef struct touch_slot
{
106 void console_handle_touch_event(QemuConsole
*con
,
107 struct touch_slot touch_slots
[INPUT_EVENT_SLOTS_MAX
],
109 int width
, int height
,
111 InputMultiTouchType type
,
115 #define TYPE_QEMU_CONSOLE "qemu-console"
116 OBJECT_DECLARE_TYPE(QemuConsole
, QemuConsoleClass
, QEMU_CONSOLE
)
119 struct QemuConsoleClass
{
120 ObjectClass parent_class
;
123 #define QEMU_ALLOCATED_FLAG 0x01
124 #define QEMU_PLACEHOLDER_FLAG 0x02
126 typedef struct ScanoutTexture
{
128 bool backing_y_0_top
;
129 uint32_t backing_width
;
130 uint32_t backing_height
;
138 typedef struct DisplaySurface
{
139 pixman_format_code_t format
;
140 pixman_image_t
*image
;
149 uint32_t handle_offset
;
153 typedef struct QemuUIInfo
{
154 /* physical dimension */
162 uint32_t refresh_rate
;
165 /* cursor data format is 32bit RGBA */
166 typedef struct QEMUCursor
{
167 uint16_t width
, height
;
173 QEMUCursor
*cursor_alloc(uint16_t width
, uint16_t height
);
174 QEMUCursor
*cursor_ref(QEMUCursor
*c
);
175 void cursor_unref(QEMUCursor
*c
);
176 QEMUCursor
*cursor_builtin_hidden(void);
177 QEMUCursor
*cursor_builtin_left_ptr(void);
178 void cursor_print_ascii_art(QEMUCursor
*c
, const char *prefix
);
179 int cursor_get_mono_bpl(QEMUCursor
*c
);
180 void cursor_set_mono(QEMUCursor
*c
,
181 uint32_t foreground
, uint32_t background
, uint8_t *image
,
182 int transparent
, uint8_t *mask
);
183 void cursor_get_mono_image(QEMUCursor
*c
, int foreground
, uint8_t *mask
);
184 void cursor_get_mono_mask(QEMUCursor
*c
, int transparent
, uint8_t *mask
);
186 typedef void *QEMUGLContext
;
187 typedef struct QEMUGLParams QEMUGLParams
;
189 struct QEMUGLParams
{
194 typedef struct QemuDmaBuf
{
204 uint32_t scanout_width
;
205 uint32_t scanout_height
;
213 enum display_scanout
{
220 typedef struct DisplayScanout
{
221 enum display_scanout kind
;
223 /* DisplaySurface *surface; is kept in QemuConsole */
224 ScanoutTexture texture
;
229 typedef struct DisplayState DisplayState
;
230 typedef struct DisplayGLCtx DisplayGLCtx
;
232 typedef struct DisplayChangeListenerOps
{
233 const char *dpy_name
;
236 void (*dpy_refresh
)(DisplayChangeListener
*dcl
);
239 void (*dpy_gfx_update
)(DisplayChangeListener
*dcl
,
240 int x
, int y
, int w
, int h
);
242 void (*dpy_gfx_switch
)(DisplayChangeListener
*dcl
,
243 struct DisplaySurface
*new_surface
);
245 bool (*dpy_gfx_check_format
)(DisplayChangeListener
*dcl
,
246 pixman_format_code_t format
);
249 void (*dpy_text_cursor
)(DisplayChangeListener
*dcl
,
252 void (*dpy_text_resize
)(DisplayChangeListener
*dcl
,
255 void (*dpy_text_update
)(DisplayChangeListener
*dcl
,
256 int x
, int y
, int w
, int h
);
259 void (*dpy_mouse_set
)(DisplayChangeListener
*dcl
,
260 int x
, int y
, int on
);
262 void (*dpy_cursor_define
)(DisplayChangeListener
*dcl
,
266 void (*dpy_gl_scanout_disable
)(DisplayChangeListener
*dcl
);
268 void (*dpy_gl_scanout_texture
)(DisplayChangeListener
*dcl
,
270 bool backing_y_0_top
,
271 uint32_t backing_width
,
272 uint32_t backing_height
,
273 uint32_t x
, uint32_t y
,
274 uint32_t w
, uint32_t h
,
276 /* optional (default to true if has dpy_gl_scanout_dmabuf) */
277 bool (*dpy_has_dmabuf
)(DisplayChangeListener
*dcl
);
279 void (*dpy_gl_scanout_dmabuf
)(DisplayChangeListener
*dcl
,
282 void (*dpy_gl_cursor_dmabuf
)(DisplayChangeListener
*dcl
,
283 QemuDmaBuf
*dmabuf
, bool have_hot
,
284 uint32_t hot_x
, uint32_t hot_y
);
286 void (*dpy_gl_cursor_position
)(DisplayChangeListener
*dcl
,
287 uint32_t pos_x
, uint32_t pos_y
);
289 void (*dpy_gl_release_dmabuf
)(DisplayChangeListener
*dcl
,
292 void (*dpy_gl_update
)(DisplayChangeListener
*dcl
,
293 uint32_t x
, uint32_t y
, uint32_t w
, uint32_t h
);
295 } DisplayChangeListenerOps
;
297 struct DisplayChangeListener
{
298 uint64_t update_interval
;
299 const DisplayChangeListenerOps
*ops
;
303 QLIST_ENTRY(DisplayChangeListener
) next
;
306 typedef struct DisplayGLCtxOps
{
307 bool (*dpy_gl_ctx_is_compatible_dcl
)(DisplayGLCtx
*dgc
,
308 DisplayChangeListener
*dcl
);
309 QEMUGLContext (*dpy_gl_ctx_create
)(DisplayGLCtx
*dgc
,
310 QEMUGLParams
*params
);
311 void (*dpy_gl_ctx_destroy
)(DisplayGLCtx
*dgc
,
313 int (*dpy_gl_ctx_make_current
)(DisplayGLCtx
*dgc
,
315 void (*dpy_gl_ctx_create_texture
)(DisplayGLCtx
*dgc
,
316 DisplaySurface
*surface
);
317 void (*dpy_gl_ctx_destroy_texture
)(DisplayGLCtx
*dgc
,
318 DisplaySurface
*surface
);
319 void (*dpy_gl_ctx_update_texture
)(DisplayGLCtx
*dgc
,
320 DisplaySurface
*surface
,
321 int x
, int y
, int w
, int h
);
324 struct DisplayGLCtx
{
325 const DisplayGLCtxOps
*ops
;
327 QemuGLShader
*gls
; /* optional shared shader */
331 DisplayState
*init_displaystate(void);
332 DisplaySurface
*qemu_create_displaysurface_from(int width
, int height
,
333 pixman_format_code_t format
,
334 int linesize
, uint8_t *data
);
335 DisplaySurface
*qemu_create_displaysurface_pixman(pixman_image_t
*image
);
336 DisplaySurface
*qemu_create_placeholder_surface(int w
, int h
,
339 void qemu_displaysurface_win32_set_handle(DisplaySurface
*surface
,
340 HANDLE h
, uint32_t offset
);
342 PixelFormat
qemu_default_pixelformat(int bpp
);
344 DisplaySurface
*qemu_create_displaysurface(int width
, int height
);
345 void qemu_free_displaysurface(DisplaySurface
*surface
);
347 static inline int is_buffer_shared(DisplaySurface
*surface
)
349 return !(surface
->flags
& QEMU_ALLOCATED_FLAG
);
352 static inline int is_placeholder(DisplaySurface
*surface
)
354 return surface
->flags
& QEMU_PLACEHOLDER_FLAG
;
357 void register_displaychangelistener(DisplayChangeListener
*dcl
);
358 void update_displaychangelistener(DisplayChangeListener
*dcl
,
360 void unregister_displaychangelistener(DisplayChangeListener
*dcl
);
362 bool dpy_ui_info_supported(QemuConsole
*con
);
363 const QemuUIInfo
*dpy_get_ui_info(const QemuConsole
*con
);
364 int dpy_set_ui_info(QemuConsole
*con
, QemuUIInfo
*info
, bool delay
);
366 void dpy_gfx_update(QemuConsole
*con
, int x
, int y
, int w
, int h
);
367 void dpy_gfx_update_full(QemuConsole
*con
);
368 void dpy_gfx_replace_surface(QemuConsole
*con
,
369 DisplaySurface
*surface
);
370 void dpy_text_cursor(QemuConsole
*con
, int x
, int y
);
371 void dpy_text_update(QemuConsole
*con
, int x
, int y
, int w
, int h
);
372 void dpy_text_resize(QemuConsole
*con
, int w
, int h
);
373 void dpy_mouse_set(QemuConsole
*con
, int x
, int y
, int on
);
374 void dpy_cursor_define(QemuConsole
*con
, QEMUCursor
*cursor
);
375 bool dpy_cursor_define_supported(QemuConsole
*con
);
376 bool dpy_gfx_check_format(QemuConsole
*con
,
377 pixman_format_code_t format
);
379 void dpy_gl_scanout_disable(QemuConsole
*con
);
380 void dpy_gl_scanout_texture(QemuConsole
*con
,
381 uint32_t backing_id
, bool backing_y_0_top
,
382 uint32_t backing_width
, uint32_t backing_height
,
383 uint32_t x
, uint32_t y
, uint32_t w
, uint32_t h
,
385 void dpy_gl_scanout_dmabuf(QemuConsole
*con
,
387 void dpy_gl_cursor_dmabuf(QemuConsole
*con
, QemuDmaBuf
*dmabuf
,
388 bool have_hot
, uint32_t hot_x
, uint32_t hot_y
);
389 void dpy_gl_cursor_position(QemuConsole
*con
,
390 uint32_t pos_x
, uint32_t pos_y
);
391 void dpy_gl_release_dmabuf(QemuConsole
*con
,
393 void dpy_gl_update(QemuConsole
*con
,
394 uint32_t x
, uint32_t y
, uint32_t w
, uint32_t h
);
396 QEMUGLContext
dpy_gl_ctx_create(QemuConsole
*con
,
397 QEMUGLParams
*params
);
398 void dpy_gl_ctx_destroy(QemuConsole
*con
, QEMUGLContext ctx
);
399 int dpy_gl_ctx_make_current(QemuConsole
*con
, QEMUGLContext ctx
);
401 bool console_has_gl(QemuConsole
*con
);
403 static inline int surface_stride(DisplaySurface
*s
)
405 return pixman_image_get_stride(s
->image
);
408 static inline void *surface_data(DisplaySurface
*s
)
410 return pixman_image_get_data(s
->image
);
413 static inline int surface_width(DisplaySurface
*s
)
415 return pixman_image_get_width(s
->image
);
418 static inline int surface_height(DisplaySurface
*s
)
420 return pixman_image_get_height(s
->image
);
423 static inline int surface_bits_per_pixel(DisplaySurface
*s
)
425 int bits
= PIXMAN_FORMAT_BPP(s
->format
);
429 static inline int surface_bytes_per_pixel(DisplaySurface
*s
)
431 int bits
= PIXMAN_FORMAT_BPP(s
->format
);
432 return DIV_ROUND_UP(bits
, 8);
435 static inline pixman_format_code_t
surface_format(DisplaySurface
*s
)
440 typedef uint32_t console_ch_t
;
442 static inline void console_write_ch(console_ch_t
*dest
, uint32_t ch
)
448 GRAPHIC_FLAGS_NONE
= 0,
449 /* require a console/display with GL callbacks */
450 GRAPHIC_FLAGS_GL
= 1 << 0,
451 /* require a console/display with DMABUF import */
452 GRAPHIC_FLAGS_DMABUF
= 1 << 1,
455 typedef struct GraphicHwOps
{
456 int (*get_flags
)(void *opaque
); /* optional, default 0 */
457 void (*invalidate
)(void *opaque
);
458 void (*gfx_update
)(void *opaque
);
459 bool gfx_update_async
; /* if true, calls graphic_hw_update_done() */
460 void (*text_update
)(void *opaque
, console_ch_t
*text
);
461 void (*ui_info
)(void *opaque
, uint32_t head
, QemuUIInfo
*info
);
462 void (*gl_block
)(void *opaque
, bool block
);
465 QemuConsole
*graphic_console_init(DeviceState
*dev
, uint32_t head
,
466 const GraphicHwOps
*ops
,
468 void graphic_console_set_hwops(QemuConsole
*con
,
469 const GraphicHwOps
*hw_ops
,
471 void graphic_console_close(QemuConsole
*con
);
473 void graphic_hw_update(QemuConsole
*con
);
474 void graphic_hw_update_done(QemuConsole
*con
);
475 void graphic_hw_invalidate(QemuConsole
*con
);
476 void graphic_hw_text_update(QemuConsole
*con
, console_ch_t
*chardata
);
477 void graphic_hw_gl_block(QemuConsole
*con
, bool block
);
479 void qemu_console_early_init(void);
481 void qemu_console_set_display_gl_ctx(QemuConsole
*con
, DisplayGLCtx
*ctx
);
483 QemuConsole
*qemu_console_lookup_by_index(unsigned int index
);
484 QemuConsole
*qemu_console_lookup_by_device(DeviceState
*dev
, uint32_t head
);
485 QemuConsole
*qemu_console_lookup_by_device_name(const char *device_id
,
486 uint32_t head
, Error
**errp
);
487 QemuConsole
*qemu_console_lookup_unused(void);
488 QEMUCursor
*qemu_console_get_cursor(QemuConsole
*con
);
489 bool qemu_console_is_visible(QemuConsole
*con
);
490 bool qemu_console_is_graphic(QemuConsole
*con
);
491 bool qemu_console_is_fixedsize(QemuConsole
*con
);
492 bool qemu_console_is_gl_blocked(QemuConsole
*con
);
493 bool qemu_console_is_multihead(DeviceState
*dev
);
494 char *qemu_console_get_label(QemuConsole
*con
);
495 int qemu_console_get_index(QemuConsole
*con
);
496 uint32_t qemu_console_get_head(QemuConsole
*con
);
497 int qemu_console_get_width(QemuConsole
*con
, int fallback
);
498 int qemu_console_get_height(QemuConsole
*con
, int fallback
);
499 /* Return the low-level window id for the console */
500 int qemu_console_get_window_id(QemuConsole
*con
);
501 /* Set the low-level window id for the console */
502 void qemu_console_set_window_id(QemuConsole
*con
, int window_id
);
504 void console_select(unsigned int index
);
505 void qemu_console_resize(QemuConsole
*con
, int width
, int height
);
506 DisplaySurface
*qemu_console_surface(QemuConsole
*con
);
510 bool console_gl_check_format(DisplayChangeListener
*dcl
,
511 pixman_format_code_t format
);
512 void surface_gl_create_texture(QemuGLShader
*gls
,
513 DisplaySurface
*surface
);
514 void surface_gl_update_texture(QemuGLShader
*gls
,
515 DisplaySurface
*surface
,
516 int x
, int y
, int w
, int h
);
517 void surface_gl_render_texture(QemuGLShader
*gls
,
518 DisplaySurface
*surface
);
519 void surface_gl_destroy_texture(QemuGLShader
*gls
,
520 DisplaySurface
*surface
);
521 void surface_gl_setup_viewport(QemuGLShader
*gls
,
522 DisplaySurface
*surface
,
526 typedef struct QemuDisplay QemuDisplay
;
530 void (*early_init
)(DisplayOptions
*opts
);
531 void (*init
)(DisplayState
*ds
, DisplayOptions
*opts
);
534 void qemu_display_register(QemuDisplay
*ui
);
535 bool qemu_display_find_default(DisplayOptions
*opts
);
536 void qemu_display_early_init(DisplayOptions
*opts
);
537 void qemu_display_init(DisplayState
*ds
, DisplayOptions
*opts
);
538 void qemu_display_help(void);
541 void vnc_display_init(const char *id
, Error
**errp
);
542 void vnc_display_open(const char *id
, Error
**errp
);
543 void vnc_display_add_client(const char *id
, int csock
, bool skipauth
);
544 int vnc_display_password(const char *id
, const char *password
);
545 int vnc_display_pw_expire(const char *id
, time_t expires
);
546 void vnc_parse(const char *str
);
547 int vnc_init_func(void *opaque
, QemuOpts
*opts
, Error
**errp
);
548 bool vnc_display_reload_certs(const char *id
, Error
**errp
);
549 bool vnc_display_update(DisplayUpdateOptionsVNC
*arg
, Error
**errp
);
552 int index_from_key(const char *key
, size_t key_length
);
556 int udmabuf_fd(void);
560 bool qemu_console_fill_device_address(QemuConsole
*con
,
561 char *device_address
,