4 #include "ui/qemu-pixman.h"
5 #include "qom/object.h"
6 #include "qemu/notify.h"
7 #include "qemu/error-report.h"
8 #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 void hmp_mouse_set(Monitor
*mon
, const QDict
*qdict
);
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_BACKSPACE 0x007f
74 #define QEMU_KEY_UP QEMU_KEY_ESC1('A')
75 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
76 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
77 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
78 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
79 #define QEMU_KEY_END QEMU_KEY_ESC1(4)
80 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
81 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
82 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
84 #define QEMU_KEY_CTRL_UP 0xe400
85 #define QEMU_KEY_CTRL_DOWN 0xe401
86 #define QEMU_KEY_CTRL_LEFT 0xe402
87 #define QEMU_KEY_CTRL_RIGHT 0xe403
88 #define QEMU_KEY_CTRL_HOME 0xe404
89 #define QEMU_KEY_CTRL_END 0xe405
90 #define QEMU_KEY_CTRL_PAGEUP 0xe406
91 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407
93 void kbd_put_keysym_console(QemuConsole
*s
, int keysym
);
94 bool kbd_put_qcode_console(QemuConsole
*s
, int qcode
, bool ctrl
);
95 void kbd_put_string_console(QemuConsole
*s
, const char *str
, int len
);
96 void kbd_put_keysym(int keysym
);
100 #define TYPE_QEMU_CONSOLE "qemu-console"
101 OBJECT_DECLARE_TYPE(QemuConsole
, QemuConsoleClass
, QEMU_CONSOLE
)
104 struct QemuConsoleClass
{
105 ObjectClass parent_class
;
108 #define QEMU_ALLOCATED_FLAG 0x01
109 #define QEMU_PLACEHOLDER_FLAG 0x02
111 typedef struct DisplaySurface
{
112 pixman_format_code_t format
;
113 pixman_image_t
*image
;
122 typedef struct QemuUIInfo
{
123 /* physical dimension */
133 /* cursor data format is 32bit RGBA */
134 typedef struct QEMUCursor
{
141 QEMUCursor
*cursor_alloc(int width
, int height
);
142 void cursor_get(QEMUCursor
*c
);
143 void cursor_put(QEMUCursor
*c
);
144 QEMUCursor
*cursor_builtin_hidden(void);
145 QEMUCursor
*cursor_builtin_left_ptr(void);
146 void cursor_print_ascii_art(QEMUCursor
*c
, const char *prefix
);
147 int cursor_get_mono_bpl(QEMUCursor
*c
);
148 void cursor_set_mono(QEMUCursor
*c
,
149 uint32_t foreground
, uint32_t background
, uint8_t *image
,
150 int transparent
, uint8_t *mask
);
151 void cursor_get_mono_image(QEMUCursor
*c
, int foreground
, uint8_t *mask
);
152 void cursor_get_mono_mask(QEMUCursor
*c
, int transparent
, uint8_t *mask
);
154 typedef void *QEMUGLContext
;
155 typedef struct QEMUGLParams QEMUGLParams
;
157 struct QEMUGLParams
{
162 typedef struct QemuDmaBuf
{
173 typedef struct DisplayState DisplayState
;
175 typedef struct DisplayChangeListenerOps
{
176 const char *dpy_name
;
179 void (*dpy_refresh
)(DisplayChangeListener
*dcl
);
182 void (*dpy_gfx_update
)(DisplayChangeListener
*dcl
,
183 int x
, int y
, int w
, int h
);
185 void (*dpy_gfx_switch
)(DisplayChangeListener
*dcl
,
186 struct DisplaySurface
*new_surface
);
188 bool (*dpy_gfx_check_format
)(DisplayChangeListener
*dcl
,
189 pixman_format_code_t format
);
192 void (*dpy_text_cursor
)(DisplayChangeListener
*dcl
,
195 void (*dpy_text_resize
)(DisplayChangeListener
*dcl
,
198 void (*dpy_text_update
)(DisplayChangeListener
*dcl
,
199 int x
, int y
, int w
, int h
);
202 void (*dpy_mouse_set
)(DisplayChangeListener
*dcl
,
203 int x
, int y
, int on
);
205 void (*dpy_cursor_define
)(DisplayChangeListener
*dcl
,
209 QEMUGLContext (*dpy_gl_ctx_create
)(DisplayChangeListener
*dcl
,
210 QEMUGLParams
*params
);
212 void (*dpy_gl_ctx_destroy
)(DisplayChangeListener
*dcl
,
215 int (*dpy_gl_ctx_make_current
)(DisplayChangeListener
*dcl
,
219 void (*dpy_gl_scanout_disable
)(DisplayChangeListener
*dcl
);
221 void (*dpy_gl_scanout_texture
)(DisplayChangeListener
*dcl
,
223 bool backing_y_0_top
,
224 uint32_t backing_width
,
225 uint32_t backing_height
,
226 uint32_t x
, uint32_t y
,
227 uint32_t w
, uint32_t h
);
228 /* optional (default to true if has dpy_gl_scanout_dmabuf) */
229 bool (*dpy_has_dmabuf
)(DisplayChangeListener
*dcl
);
231 void (*dpy_gl_scanout_dmabuf
)(DisplayChangeListener
*dcl
,
234 void (*dpy_gl_cursor_dmabuf
)(DisplayChangeListener
*dcl
,
235 QemuDmaBuf
*dmabuf
, bool have_hot
,
236 uint32_t hot_x
, uint32_t hot_y
);
238 void (*dpy_gl_cursor_position
)(DisplayChangeListener
*dcl
,
239 uint32_t pos_x
, uint32_t pos_y
);
241 void (*dpy_gl_release_dmabuf
)(DisplayChangeListener
*dcl
,
244 void (*dpy_gl_update
)(DisplayChangeListener
*dcl
,
245 uint32_t x
, uint32_t y
, uint32_t w
, uint32_t h
);
247 } DisplayChangeListenerOps
;
249 struct DisplayChangeListener
{
250 uint64_t update_interval
;
251 const DisplayChangeListenerOps
*ops
;
255 QLIST_ENTRY(DisplayChangeListener
) next
;
258 DisplayState
*init_displaystate(void);
259 DisplaySurface
*qemu_create_displaysurface_from(int width
, int height
,
260 pixman_format_code_t format
,
261 int linesize
, uint8_t *data
);
262 DisplaySurface
*qemu_create_displaysurface_pixman(pixman_image_t
*image
);
263 DisplaySurface
*qemu_create_placeholder_surface(int w
, int h
,
265 PixelFormat
qemu_default_pixelformat(int bpp
);
267 DisplaySurface
*qemu_create_displaysurface(int width
, int height
);
268 void qemu_free_displaysurface(DisplaySurface
*surface
);
270 static inline int is_surface_bgr(DisplaySurface
*surface
)
272 if (PIXMAN_FORMAT_BPP(surface
->format
) == 32 &&
273 PIXMAN_FORMAT_TYPE(surface
->format
) == PIXMAN_TYPE_ABGR
) {
280 static inline int is_buffer_shared(DisplaySurface
*surface
)
282 return !(surface
->flags
& QEMU_ALLOCATED_FLAG
);
285 static inline int is_placeholder(DisplaySurface
*surface
)
287 return surface
->flags
& QEMU_PLACEHOLDER_FLAG
;
290 void register_displaychangelistener(DisplayChangeListener
*dcl
);
291 void update_displaychangelistener(DisplayChangeListener
*dcl
,
293 void unregister_displaychangelistener(DisplayChangeListener
*dcl
);
295 bool dpy_ui_info_supported(QemuConsole
*con
);
296 const QemuUIInfo
*dpy_get_ui_info(const QemuConsole
*con
);
297 int dpy_set_ui_info(QemuConsole
*con
, QemuUIInfo
*info
);
299 void dpy_gfx_update(QemuConsole
*con
, int x
, int y
, int w
, int h
);
300 void dpy_gfx_update_full(QemuConsole
*con
);
301 void dpy_gfx_replace_surface(QemuConsole
*con
,
302 DisplaySurface
*surface
);
303 void dpy_text_cursor(QemuConsole
*con
, int x
, int y
);
304 void dpy_text_update(QemuConsole
*con
, int x
, int y
, int w
, int h
);
305 void dpy_text_resize(QemuConsole
*con
, int w
, int h
);
306 void dpy_mouse_set(QemuConsole
*con
, int x
, int y
, int on
);
307 void dpy_cursor_define(QemuConsole
*con
, QEMUCursor
*cursor
);
308 bool dpy_cursor_define_supported(QemuConsole
*con
);
309 bool dpy_gfx_check_format(QemuConsole
*con
,
310 pixman_format_code_t format
);
312 void dpy_gl_scanout_disable(QemuConsole
*con
);
313 void dpy_gl_scanout_texture(QemuConsole
*con
,
314 uint32_t backing_id
, bool backing_y_0_top
,
315 uint32_t backing_width
, uint32_t backing_height
,
316 uint32_t x
, uint32_t y
, uint32_t w
, uint32_t h
);
317 void dpy_gl_scanout_dmabuf(QemuConsole
*con
,
319 void dpy_gl_cursor_dmabuf(QemuConsole
*con
, QemuDmaBuf
*dmabuf
,
320 bool have_hot
, uint32_t hot_x
, uint32_t hot_y
);
321 void dpy_gl_cursor_position(QemuConsole
*con
,
322 uint32_t pos_x
, uint32_t pos_y
);
323 void dpy_gl_release_dmabuf(QemuConsole
*con
,
325 void dpy_gl_update(QemuConsole
*con
,
326 uint32_t x
, uint32_t y
, uint32_t w
, uint32_t h
);
328 QEMUGLContext
dpy_gl_ctx_create(QemuConsole
*con
,
329 QEMUGLParams
*params
);
330 void dpy_gl_ctx_destroy(QemuConsole
*con
, QEMUGLContext ctx
);
331 int dpy_gl_ctx_make_current(QemuConsole
*con
, QEMUGLContext ctx
);
333 bool console_has_gl(QemuConsole
*con
);
335 static inline int surface_stride(DisplaySurface
*s
)
337 return pixman_image_get_stride(s
->image
);
340 static inline void *surface_data(DisplaySurface
*s
)
342 return pixman_image_get_data(s
->image
);
345 static inline int surface_width(DisplaySurface
*s
)
347 return pixman_image_get_width(s
->image
);
350 static inline int surface_height(DisplaySurface
*s
)
352 return pixman_image_get_height(s
->image
);
355 static inline int surface_bits_per_pixel(DisplaySurface
*s
)
357 int bits
= PIXMAN_FORMAT_BPP(s
->format
);
361 static inline int surface_bytes_per_pixel(DisplaySurface
*s
)
363 int bits
= PIXMAN_FORMAT_BPP(s
->format
);
364 return DIV_ROUND_UP(bits
, 8);
367 static inline pixman_format_code_t
surface_format(DisplaySurface
*s
)
372 typedef uint32_t console_ch_t
;
374 static inline void console_write_ch(console_ch_t
*dest
, uint32_t ch
)
380 GRAPHIC_FLAGS_NONE
= 0,
381 /* require a console/display with GL callbacks */
382 GRAPHIC_FLAGS_GL
= 1 << 0,
383 /* require a console/display with DMABUF import */
384 GRAPHIC_FLAGS_DMABUF
= 1 << 1,
387 typedef struct GraphicHwOps
{
388 int (*get_flags
)(void *opaque
); /* optional, default 0 */
389 void (*invalidate
)(void *opaque
);
390 void (*gfx_update
)(void *opaque
);
391 bool gfx_update_async
; /* if true, calls graphic_hw_update_done() */
392 void (*text_update
)(void *opaque
, console_ch_t
*text
);
393 void (*update_interval
)(void *opaque
, uint64_t interval
);
394 int (*ui_info
)(void *opaque
, uint32_t head
, QemuUIInfo
*info
);
395 void (*gl_block
)(void *opaque
, bool block
);
396 void (*gl_flushed
)(void *opaque
);
399 QemuConsole
*graphic_console_init(DeviceState
*dev
, uint32_t head
,
400 const GraphicHwOps
*ops
,
402 void graphic_console_set_hwops(QemuConsole
*con
,
403 const GraphicHwOps
*hw_ops
,
405 void graphic_console_close(QemuConsole
*con
);
407 void graphic_hw_update(QemuConsole
*con
);
408 void graphic_hw_update_done(QemuConsole
*con
);
409 void graphic_hw_invalidate(QemuConsole
*con
);
410 void graphic_hw_text_update(QemuConsole
*con
, console_ch_t
*chardata
);
411 void graphic_hw_gl_block(QemuConsole
*con
, bool block
);
412 void graphic_hw_gl_flushed(QemuConsole
*con
);
414 void qemu_console_early_init(void);
416 QemuConsole
*qemu_console_lookup_by_index(unsigned int index
);
417 QemuConsole
*qemu_console_lookup_by_device(DeviceState
*dev
, uint32_t head
);
418 QemuConsole
*qemu_console_lookup_by_device_name(const char *device_id
,
419 uint32_t head
, Error
**errp
);
420 QemuConsole
*qemu_console_lookup_unused(void);
421 bool qemu_console_is_visible(QemuConsole
*con
);
422 bool qemu_console_is_graphic(QemuConsole
*con
);
423 bool qemu_console_is_fixedsize(QemuConsole
*con
);
424 bool qemu_console_is_gl_blocked(QemuConsole
*con
);
425 char *qemu_console_get_label(QemuConsole
*con
);
426 int qemu_console_get_index(QemuConsole
*con
);
427 uint32_t qemu_console_get_head(QemuConsole
*con
);
428 int qemu_console_get_width(QemuConsole
*con
, int fallback
);
429 int qemu_console_get_height(QemuConsole
*con
, int fallback
);
430 /* Return the low-level window id for the console */
431 int qemu_console_get_window_id(QemuConsole
*con
);
432 /* Set the low-level window id for the console */
433 void qemu_console_set_window_id(QemuConsole
*con
, int window_id
);
435 void console_select(unsigned int index
);
436 void qemu_console_resize(QemuConsole
*con
, int width
, int height
);
437 DisplaySurface
*qemu_console_surface(QemuConsole
*con
);
441 bool console_gl_check_format(DisplayChangeListener
*dcl
,
442 pixman_format_code_t format
);
443 void surface_gl_create_texture(QemuGLShader
*gls
,
444 DisplaySurface
*surface
);
445 void surface_gl_update_texture(QemuGLShader
*gls
,
446 DisplaySurface
*surface
,
447 int x
, int y
, int w
, int h
);
448 void surface_gl_render_texture(QemuGLShader
*gls
,
449 DisplaySurface
*surface
);
450 void surface_gl_destroy_texture(QemuGLShader
*gls
,
451 DisplaySurface
*surface
);
452 void surface_gl_setup_viewport(QemuGLShader
*gls
,
453 DisplaySurface
*surface
,
457 typedef struct QemuDisplay QemuDisplay
;
461 void (*early_init
)(DisplayOptions
*opts
);
462 void (*init
)(DisplayState
*ds
, DisplayOptions
*opts
);
465 void qemu_display_register(QemuDisplay
*ui
);
466 bool qemu_display_find_default(DisplayOptions
*opts
);
467 void qemu_display_early_init(DisplayOptions
*opts
);
468 void qemu_display_init(DisplayState
*ds
, DisplayOptions
*opts
);
469 void qemu_display_help(void);
472 void vnc_display_init(const char *id
, Error
**errp
);
473 void vnc_display_open(const char *id
, Error
**errp
);
474 void vnc_display_add_client(const char *id
, int csock
, bool skipauth
);
475 int vnc_display_password(const char *id
, const char *password
);
476 int vnc_display_pw_expire(const char *id
, time_t expires
);
477 void vnc_parse(const char *str
);
478 int vnc_init_func(void *opaque
, QemuOpts
*opts
, Error
**errp
);
481 int index_from_key(const char *key
, size_t key_length
);