1#ifndef CONSOLE_H
2#define CONSOLE_H
3
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"
9
10#ifdef CONFIG_OPENGL
11# include <epoxy/gl.h>
12#endif
13
14
15
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
21
22
23#define QEMU_SCROLL_LOCK_LED (1 << 0)
24#define QEMU_NUM_LOCK_LED (1 << 1)
25#define QEMU_CAPS_LOCK_LED (1 << 2)
26
27
28#define GUI_REFRESH_INTERVAL_DEFAULT 30
29#define GUI_REFRESH_INTERVAL_IDLE 3000
30
31
32enum qemu_color_names {
33 QEMU_COLOR_BLACK = 0,
34 QEMU_COLOR_BLUE = 1,
35 QEMU_COLOR_GREEN = 2,
36 QEMU_COLOR_CYAN = 3,
37 QEMU_COLOR_RED = 4,
38 QEMU_COLOR_MAGENTA = 5,
39 QEMU_COLOR_YELLOW = 6,
40 QEMU_COLOR_WHITE = 7
41};
42
43#define ATTR2CHTYPE(c, fg, bg, bold) \
44 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
45
46typedef void QEMUPutKBDEvent(void *opaque, int keycode);
47typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
48typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
49
50typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
51typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
52typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
53
54QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
55 void *opaque);
56QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
57 void *opaque, int absolute,
58 const char *name);
59void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
60void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
61
62QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
63void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
64
65void kbd_put_ledstate(int ledstate);
66
67struct MouseTransformInfo {
68
69 int x;
70 int y;
71
72 int a[7];
73};
74
75void hmp_mouse_set(Monitor *mon, const QDict *qdict);
76
77
78
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)
90
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
99
100void kbd_put_keysym_console(QemuConsole *s, int keysym);
101bool kbd_put_qcode_console(QemuConsole *s, int qcode);
102void kbd_put_string_console(QemuConsole *s, const char *str, int len);
103void kbd_put_keysym(int keysym);
104
105
106
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)
114
115typedef struct QemuConsoleClass QemuConsoleClass;
116
117struct QemuConsoleClass {
118 ObjectClass parent_class;
119};
120
121#define QEMU_ALLOCATED_FLAG 0x01
122
123struct PixelFormat {
124 uint8_t bits_per_pixel;
125 uint8_t bytes_per_pixel;
126 uint8_t depth;
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;
131};
132
133struct DisplaySurface {
134 pixman_format_code_t format;
135 pixman_image_t *image;
136 uint8_t flags;
137#ifdef CONFIG_OPENGL
138 GLenum glformat;
139 GLenum gltype;
140 GLuint texture;
141#endif
142};
143
144typedef struct QemuUIInfo {
145
146 int xoff;
147 int yoff;
148 uint32_t width;
149 uint32_t height;
150} QemuUIInfo;
151
152
153typedef struct QEMUCursor {
154 int width, height;
155 int hot_x, hot_y;
156 int refcount;
157 uint32_t data[];
158} QEMUCursor;
159
160QEMUCursor *cursor_alloc(int width, int height);
161void cursor_get(QEMUCursor *c);
162void cursor_put(QEMUCursor *c);
163QEMUCursor *cursor_builtin_hidden(void);
164QEMUCursor *cursor_builtin_left_ptr(void);
165void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
166int cursor_get_mono_bpl(QEMUCursor *c);
167void cursor_set_mono(QEMUCursor *c,
168 uint32_t foreground, uint32_t background, uint8_t *image,
169 int transparent, uint8_t *mask);
170void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
171void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
172
173typedef void *QEMUGLContext;
174typedef struct QEMUGLParams QEMUGLParams;
175
176struct QEMUGLParams {
177 int major_ver;
178 int minor_ver;
179};
180
181typedef struct DisplayChangeListenerOps {
182 const char *dpy_name;
183
184 void (*dpy_refresh)(DisplayChangeListener *dcl);
185
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);
195
196 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
197 int x, int y);
198 void (*dpy_text_resize)(DisplayChangeListener *dcl,
199 int w, int h);
200 void (*dpy_text_update)(DisplayChangeListener *dcl,
201 int x, int y, int w, int h);
202
203 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
204 int x, int y, int on);
205 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
206 QEMUCursor *cursor);
207
208 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
209 QEMUGLParams *params);
210 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
211 QEMUGLContext ctx);
212 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
213 QEMUGLContext ctx);
214 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);
215
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);
221
222} DisplayChangeListenerOps;
223
224struct DisplayChangeListener {
225 uint64_t update_interval;
226 const DisplayChangeListenerOps *ops;
227 DisplayState *ds;
228 QemuConsole *con;
229
230 QLIST_ENTRY(DisplayChangeListener) next;
231};
232
233DisplayState *init_displaystate(void);
234DisplaySurface *qemu_create_displaysurface_from(int width, int height,
235 pixman_format_code_t format,
236 int linesize, uint8_t *data);
237DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
238DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
239 pixman_format_code_t format,
240 int linesize,
241 uint64_t addr);
242PixelFormat qemu_default_pixelformat(int bpp);
243
244DisplaySurface *qemu_create_displaysurface(int width, int height);
245void qemu_free_displaysurface(DisplaySurface *surface);
246
247static inline int is_surface_bgr(DisplaySurface *surface)
248{
249 if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
250 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
251 return 1;
252 } else {
253 return 0;
254 }
255}
256
257static inline int is_buffer_shared(DisplaySurface *surface)
258{
259 return !(surface->flags & QEMU_ALLOCATED_FLAG);
260}
261
262void register_displaychangelistener(DisplayChangeListener *dcl);
263void update_displaychangelistener(DisplayChangeListener *dcl,
264 uint64_t interval);
265void unregister_displaychangelistener(DisplayChangeListener *dcl);
266
267bool dpy_ui_info_supported(QemuConsole *con);
268int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
269
270void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
271void dpy_gfx_replace_surface(QemuConsole *con,
272 DisplaySurface *surface);
273void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
274 int dst_x, int dst_y, int w, int h);
275void dpy_text_cursor(QemuConsole *con, int x, int y);
276void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
277void dpy_text_resize(QemuConsole *con, int w, int h);
278void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
279void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
280bool dpy_cursor_define_supported(QemuConsole *con);
281bool dpy_gfx_check_format(QemuConsole *con,
282 pixman_format_code_t format);
283
284void 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);
287void dpy_gl_update(QemuConsole *con,
288 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
289
290QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
291 QEMUGLParams *params);
292void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
293int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
294QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
295
296bool console_has_gl(QemuConsole *con);
297
298static inline int surface_stride(DisplaySurface *s)
299{
300 return pixman_image_get_stride(s->image);
301}
302
303static inline void *surface_data(DisplaySurface *s)
304{
305 return pixman_image_get_data(s->image);
306}
307
308static inline int surface_width(DisplaySurface *s)
309{
310 return pixman_image_get_width(s->image);
311}
312
313static inline int surface_height(DisplaySurface *s)
314{
315 return pixman_image_get_height(s->image);
316}
317
318static inline int surface_bits_per_pixel(DisplaySurface *s)
319{
320 int bits = PIXMAN_FORMAT_BPP(s->format);
321 return bits;
322}
323
324static inline int surface_bytes_per_pixel(DisplaySurface *s)
325{
326 int bits = PIXMAN_FORMAT_BPP(s->format);
327 return (bits + 7) / 8;
328}
329
330static inline pixman_format_code_t surface_format(DisplaySurface *s)
331{
332 return s->format;
333}
334
335#ifdef CONFIG_CURSES
336#include <curses.h>
337typedef chtype console_ch_t;
338extern chtype vga_to_curses[];
339#else
340typedef unsigned long console_ch_t;
341#endif
342static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
343{
344 uint8_t c = ch;
345#ifdef CONFIG_CURSES
346 if (vga_to_curses[c]) {
347 ch &= ~(console_ch_t)0xff;
348 ch |= vga_to_curses[c];
349 }
350#else
351 if (c == '\0') {
352 ch |= ' ';
353 }
354#endif
355 *dest = ch;
356}
357
358typedef 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);
365} GraphicHwOps;
366
367QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
368 const GraphicHwOps *ops,
369 void *opaque);
370void graphic_console_set_hwops(QemuConsole *con,
371 const GraphicHwOps *hw_ops,
372 void *opaque);
373
374void graphic_hw_update(QemuConsole *con);
375void graphic_hw_invalidate(QemuConsole *con);
376void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
377void graphic_hw_gl_block(QemuConsole *con, bool block);
378
379QemuConsole *qemu_console_lookup_by_index(unsigned int index);
380QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
381QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
382 uint32_t head, Error **errp);
383bool qemu_console_is_visible(QemuConsole *con);
384bool qemu_console_is_graphic(QemuConsole *con);
385bool qemu_console_is_fixedsize(QemuConsole *con);
386char *qemu_console_get_label(QemuConsole *con);
387int qemu_console_get_index(QemuConsole *con);
388uint32_t qemu_console_get_head(QemuConsole *con);
389QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
390int qemu_console_get_width(QemuConsole *con, int fallback);
391int qemu_console_get_height(QemuConsole *con, int fallback);
392
393void text_consoles_set_display(DisplayState *ds);
394void console_select(unsigned int index);
395void console_color_init(DisplayState *ds);
396void qemu_console_resize(QemuConsole *con, int width, int height);
397void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
398 int dst_x, int dst_y, int w, int h);
399DisplaySurface *qemu_console_surface(QemuConsole *con);
400
401
402typedef struct ConsoleGLState ConsoleGLState;
403#ifdef CONFIG_OPENGL
404ConsoleGLState *console_gl_init_context(void);
405void console_gl_fini_context(ConsoleGLState *gls);
406bool console_gl_check_format(DisplayChangeListener *dcl,
407 pixman_format_code_t format);
408void surface_gl_create_texture(ConsoleGLState *gls,
409 DisplaySurface *surface);
410void surface_gl_update_texture(ConsoleGLState *gls,
411 DisplaySurface *surface,
412 int x, int y, int w, int h);
413void surface_gl_render_texture(ConsoleGLState *gls,
414 DisplaySurface *surface);
415void surface_gl_destroy_texture(ConsoleGLState *gls,
416 DisplaySurface *surface);
417void surface_gl_setup_viewport(ConsoleGLState *gls,
418 DisplaySurface *surface,
419 int ww, int wh);
420#endif
421
422
423void sdl_display_early_init(int opengl);
424void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
425
426
427void cocoa_display_init(DisplayState *ds, int full_screen);
428
429
430void vnc_display_init(const char *id);
431void vnc_display_open(const char *id, Error **errp);
432void vnc_display_add_client(const char *id, int csock, bool skipauth);
433char *vnc_display_local_addr(const char *id);
434#ifdef CONFIG_VNC
435int vnc_display_password(const char *id, const char *password);
436int vnc_display_pw_expire(const char *id, time_t expires);
437QemuOpts *vnc_parse(const char *str, Error **errp);
438int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
439#else
440static inline int vnc_display_password(const char *id, const char *password)
441{
442 return -ENODEV;
443}
444static inline int vnc_display_pw_expire(const char *id, time_t expires)
445{
446 return -ENODEV;
447};
448#endif
449
450
451void curses_display_init(DisplayState *ds, int full_screen);
452
453
454int index_from_key(const char *key, size_t key_length);
455
456
457void early_gtk_display_init(int opengl);
458void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
459
460#endif
461
