4 #include "ui/qemu-pixman.h"
5 #include "qom/object.h"
6 #include "qapi/qmp/qdict.h"
7 #include "qemu/notify.h"
8 #include "qapi-types.h"
11 # include <epoxy/gl.h>
14 /* keyboard/mouse support */
16 #define MOUSE_EVENT_LBUTTON 0x01
17 #define MOUSE_EVENT_RBUTTON 0x02
18 #define MOUSE_EVENT_MBUTTON 0x04
19 #define MOUSE_EVENT_WHEELUP 0x08
20 #define MOUSE_EVENT_WHEELDN 0x10
22 /* identical to the ps/2 keyboard bits */
23 #define QEMU_SCROLL_LOCK_LED (1 << 0)
24 #define QEMU_NUM_LOCK_LED (1 << 1)
25 #define QEMU_CAPS_LOCK_LED (1 << 2)
28 #define GUI_REFRESH_INTERVAL_DEFAULT 30
29 #define GUI_REFRESH_INTERVAL_IDLE 3000
31 /* Color number is match to standard vga palette */
32 enum qemu_color_names {
38 QEMU_COLOR_MAGENTA = 5,
39 QEMU_COLOR_YELLOW = 6,
42 /* Convert to curses char attributes */
43 #define ATTR2CHTYPE(c, fg, bg, bold) \
44 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
46 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
47 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
48 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
50 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
51 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
52 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
54 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
56 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
57 void *opaque, int absolute,
59 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
60 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
62 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
63 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
65 void kbd_put_ledstate(int ledstate);
67 struct MouseTransformInfo {
68 /* Touchscreen resolution */
71 /* Calibration values as used/generated by tslib */
75 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
77 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
79 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
80 #define QEMU_KEY_BACKSPACE 0x007f
81 #define QEMU_KEY_UP QEMU_KEY_ESC1('A')
82 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
83 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
84 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
85 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
86 #define QEMU_KEY_END QEMU_KEY_ESC1(4)
87 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
88 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
89 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
91 #define QEMU_KEY_CTRL_UP 0xe400
92 #define QEMU_KEY_CTRL_DOWN 0xe401
93 #define QEMU_KEY_CTRL_LEFT 0xe402
94 #define QEMU_KEY_CTRL_RIGHT 0xe403
95 #define QEMU_KEY_CTRL_HOME 0xe404
96 #define QEMU_KEY_CTRL_END 0xe405
97 #define QEMU_KEY_CTRL_PAGEUP 0xe406
98 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407
100 void kbd_put_keysym_console(QemuConsole *s, int keysym);
101 bool kbd_put_qcode_console(QemuConsole *s, int qcode);
102 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
103 void kbd_put_keysym(int keysym);
107 #define TYPE_QEMU_CONSOLE "qemu-console"
108 #define QEMU_CONSOLE(obj) \
109 OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
110 #define QEMU_CONSOLE_GET_CLASS(obj) \
111 OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
112 #define QEMU_CONSOLE_CLASS(klass) \
113 OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
115 typedef struct QemuConsoleClass QemuConsoleClass;
117 struct QemuConsoleClass {
118 ObjectClass parent_class;
121 #define QEMU_ALLOCATED_FLAG 0x01
124 uint8_t bits_per_pixel;
125 uint8_t bytes_per_pixel;
126 uint8_t depth; /* color depth in bits */
127 uint32_t rmask, gmask, bmask, amask;
128 uint8_t rshift, gshift, bshift, ashift;
129 uint8_t rmax, gmax, bmax, amax;
130 uint8_t rbits, gbits, bbits, abits;
133 struct DisplaySurface {
134 pixman_format_code_t format;
135 pixman_image_t *image;
144 typedef struct QemuUIInfo {
152 /* cursor data format is 32bit RGBA */
153 typedef struct QEMUCursor {
160 QEMUCursor *cursor_alloc(int width, int height);
161 void cursor_get(QEMUCursor *c);
162 void cursor_put(QEMUCursor *c);
163 QEMUCursor *cursor_builtin_hidden(void);
164 QEMUCursor *cursor_builtin_left_ptr(void);
165 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
166 int cursor_get_mono_bpl(QEMUCursor *c);
167 void cursor_set_mono(QEMUCursor *c,
168 uint32_t foreground, uint32_t background, uint8_t *image,
169 int transparent, uint8_t *mask);
170 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
171 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
173 typedef void *QEMUGLContext;
174 typedef struct QEMUGLParams QEMUGLParams;
176 struct QEMUGLParams {
181 typedef struct DisplayChangeListenerOps {
182 const char *dpy_name;
184 void (*dpy_refresh)(DisplayChangeListener *dcl);
186 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
187 int x, int y, int w, int h);
188 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
189 struct DisplaySurface *new_surface);
190 void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
191 int src_x, int src_y,
192 int dst_x, int dst_y, int w, int h);
193 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
194 pixman_format_code_t format);
196 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
198 void (*dpy_text_resize)(DisplayChangeListener *dcl,
200 void (*dpy_text_update)(DisplayChangeListener *dcl,
201 int x, int y, int w, int h);
203 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
204 int x, int y, int on);
205 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
208 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
209 QEMUGLParams *params);
210 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
212 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
214 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);
216 void (*dpy_gl_scanout)(DisplayChangeListener *dcl,
217 uint32_t backing_id, bool backing_y_0_top,
218 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
219 void (*dpy_gl_update)(DisplayChangeListener *dcl,
220 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
222 } DisplayChangeListenerOps;
224 struct DisplayChangeListener {
225 uint64_t update_interval;
226 const DisplayChangeListenerOps *ops;
230 QLIST_ENTRY(DisplayChangeListener) next;
233 DisplayState *init_displaystate(void);
234 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
235 pixman_format_code_t format,
236 int linesize, uint8_t *data);
237 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
238 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
239 pixman_format_code_t format,
242 PixelFormat qemu_default_pixelformat(int bpp);
244 DisplaySurface *qemu_create_displaysurface(int width, int height);
245 void qemu_free_displaysurface(DisplaySurface *surface);
247 static inline int is_surface_bgr(DisplaySurface *surface)
249 if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
250 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
257 static inline int is_buffer_shared(DisplaySurface *surface)
259 return !(surface->flags & QEMU_ALLOCATED_FLAG);
262 void register_displaychangelistener(DisplayChangeListener *dcl);
263 void update_displaychangelistener(DisplayChangeListener *dcl,
265 void unregister_displaychangelistener(DisplayChangeListener *dcl);
267 bool dpy_ui_info_supported(QemuConsole *con);
268 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
270 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
271 void dpy_gfx_replace_surface(QemuConsole *con,
272 DisplaySurface *surface);
273 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
274 int dst_x, int dst_y, int w, int h);
275 void dpy_text_cursor(QemuConsole *con, int x, int y);
276 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
277 void dpy_text_resize(QemuConsole *con, int w, int h);
278 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
279 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
280 bool dpy_cursor_define_supported(QemuConsole *con);
281 bool dpy_gfx_check_format(QemuConsole *con,
282 pixman_format_code_t format);
284 void dpy_gl_scanout(QemuConsole *con,
285 uint32_t backing_id, bool backing_y_0_top,
286 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
287 void dpy_gl_update(QemuConsole *con,
288 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
290 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
291 QEMUGLParams *params);
292 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
293 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
294 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
296 bool console_has_gl(QemuConsole *con);
298 static inline int surface_stride(DisplaySurface *s)
300 return pixman_image_get_stride(s->image);
303 static inline void *surface_data(DisplaySurface *s)
305 return pixman_image_get_data(s->image);
308 static inline int surface_width(DisplaySurface *s)
310 return pixman_image_get_width(s->image);
313 static inline int surface_height(DisplaySurface *s)
315 return pixman_image_get_height(s->image);
318 static inline int surface_bits_per_pixel(DisplaySurface *s)
320 int bits = PIXMAN_FORMAT_BPP(s->format);
324 static inline int surface_bytes_per_pixel(DisplaySurface *s)
326 int bits = PIXMAN_FORMAT_BPP(s->format);
327 return (bits + 7) / 8;
330 static inline pixman_format_code_t surface_format(DisplaySurface *s)
337 typedef chtype console_ch_t;
338 extern chtype vga_to_curses[];
340 typedef unsigned long console_ch_t;
342 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
346 if (vga_to_curses[c]) {
347 ch &= ~(console_ch_t)0xff;
348 ch |= vga_to_curses[c];
358 typedef struct GraphicHwOps {
359 void (*invalidate)(void *opaque);
360 void (*gfx_update)(void *opaque);
361 void (*text_update)(void *opaque, console_ch_t *text);
362 void (*update_interval)(void *opaque, uint64_t interval);
363 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
364 void (*gl_block)(void *opaque, bool block);
367 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
368 const GraphicHwOps *ops,
370 void graphic_console_set_hwops(QemuConsole *con,
371 const GraphicHwOps *hw_ops,
374 void graphic_hw_update(QemuConsole *con);
375 void graphic_hw_invalidate(QemuConsole *con);
376 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
377 void graphic_hw_gl_block(QemuConsole *con, bool block);
379 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
380 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
381 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
382 uint32_t head, Error **errp);
383 bool qemu_console_is_visible(QemuConsole *con);
384 bool qemu_console_is_graphic(QemuConsole *con);
385 bool qemu_console_is_fixedsize(QemuConsole *con);
386 char *qemu_console_get_label(QemuConsole *con);
387 int qemu_console_get_index(QemuConsole *con);
388 uint32_t qemu_console_get_head(QemuConsole *con);
389 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
390 int qemu_console_get_width(QemuConsole *con, int fallback);
391 int qemu_console_get_height(QemuConsole *con, int fallback);
393 void text_consoles_set_display(DisplayState *ds);
394 void console_select(unsigned int index);
395 void console_color_init(DisplayState *ds);
396 void qemu_console_resize(QemuConsole *con, int width, int height);
397 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
398 int dst_x, int dst_y, int w, int h);
399 DisplaySurface *qemu_console_surface(QemuConsole *con);
402 typedef struct ConsoleGLState ConsoleGLState;
404 ConsoleGLState *console_gl_init_context(void);
405 void console_gl_fini_context(ConsoleGLState *gls);
406 bool console_gl_check_format(DisplayChangeListener *dcl,
407 pixman_format_code_t format);
408 void surface_gl_create_texture(ConsoleGLState *gls,
409 DisplaySurface *surface);
410 void surface_gl_update_texture(ConsoleGLState *gls,
411 DisplaySurface *surface,
412 int x, int y, int w, int h);
413 void surface_gl_render_texture(ConsoleGLState *gls,
414 DisplaySurface *surface);
415 void surface_gl_destroy_texture(ConsoleGLState *gls,
416 DisplaySurface *surface);
417 void surface_gl_setup_viewport(ConsoleGLState *gls,
418 DisplaySurface *surface,
423 void sdl_display_early_init(int opengl);
424 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
427 void cocoa_display_init(DisplayState *ds, int full_screen);
430 void vnc_display_init(const char *id);
431 void vnc_display_open(const char *id, Error **errp);
432 void vnc_display_add_client(const char *id, int csock, bool skipauth);
433 char *vnc_display_local_addr(const char *id);
435 int vnc_display_password(const char *id, const char *password);
436 int vnc_display_pw_expire(const char *id, time_t expires);
437 QemuOpts *vnc_parse(const char *str, Error **errp);
438 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
440 static inline int vnc_display_password(const char *id, const char *password)
444 static inline int vnc_display_pw_expire(const char *id, time_t expires)
451 void curses_display_init(DisplayState *ds, int full_screen);
454 int index_from_key(const char *key, size_t key_length);
457 void early_gtk_display_init(int opengl);
458 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);