xref: /qemu/include/ui/console.h (revision b25f23e7) 
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 #include "qemu/error-report.h"
10 #include "qapi/error.h"
11 
12 #ifdef CONFIG_OPENGL
13 # include <epoxy/gl.h>
14 #endif
15 
16 /* keyboard/mouse support */
17 
18 #define MOUSE_EVENT_LBUTTON 0x01
19 #define MOUSE_EVENT_RBUTTON 0x02
20 #define MOUSE_EVENT_MBUTTON 0x04
21 #define MOUSE_EVENT_WHEELUP 0x08
22 #define MOUSE_EVENT_WHEELDN 0x10
23 
24 /* identical to the ps/2 keyboard bits */
25 #define QEMU_SCROLL_LOCK_LED (1 << 0)
26 #define QEMU_NUM_LOCK_LED    (1 << 1)
27 #define QEMU_CAPS_LOCK_LED   (1 << 2)
28 
29 /* in ms */
30 #define GUI_REFRESH_INTERVAL_DEFAULT    30
31 #define GUI_REFRESH_INTERVAL_IDLE     3000
32 
33 /* Color number is match to standard vga palette */
34 enum qemu_color_names {
35     QEMU_COLOR_BLACK   = 0,
36     QEMU_COLOR_BLUE    = 1,
37     QEMU_COLOR_GREEN   = 2,
38     QEMU_COLOR_CYAN    = 3,
39     QEMU_COLOR_RED     = 4,
40     QEMU_COLOR_MAGENTA = 5,
41     QEMU_COLOR_YELLOW  = 6,
42     QEMU_COLOR_WHITE   = 7
43 };
44 /* Convert to curses char attributes */
45 #define ATTR2CHTYPE(c, fg, bg, bold) \
46     ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
47 
48 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
49 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
50 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
51 
52 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
53 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
54 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
55 
56 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
57                                             void *opaque);
58 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
59                                                 void *opaque, int absolute,
60                                                 const char *name);
61 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
62 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
63 
64 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
65 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
66 
67 void kbd_put_ledstate(int ledstate);
68 
69 struct MouseTransformInfo {
70     /* Touchscreen resolution */
71     int x;
72     int y;
73     /* Calibration values as used/generated by tslib */
74     int a[7];
75 };
76 
77 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
78 
79 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
80    constants) */
81 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
82 #define QEMU_KEY_BACKSPACE  0x007f
83 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
84 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
85 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
86 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
87 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
88 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
89 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
90 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
91 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
92 
93 #define QEMU_KEY_CTRL_UP         0xe400
94 #define QEMU_KEY_CTRL_DOWN       0xe401
95 #define QEMU_KEY_CTRL_LEFT       0xe402
96 #define QEMU_KEY_CTRL_RIGHT      0xe403
97 #define QEMU_KEY_CTRL_HOME       0xe404
98 #define QEMU_KEY_CTRL_END        0xe405
99 #define QEMU_KEY_CTRL_PAGEUP     0xe406
100 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
101 
102 void kbd_put_keysym_console(QemuConsole *s, int keysym);
103 bool kbd_put_qcode_console(QemuConsole *s, int qcode);
104 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
105 void kbd_put_keysym(int keysym);
106 
107 /* consoles */
108 
109 #define TYPE_QEMU_CONSOLE "qemu-console"
110 #define QEMU_CONSOLE(obj) \
111     OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
112 #define QEMU_CONSOLE_GET_CLASS(obj) \
113     OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
114 #define QEMU_CONSOLE_CLASS(klass) \
115     OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
116 
117 typedef struct QemuConsoleClass QemuConsoleClass;
118 
119 struct QemuConsoleClass {
120     ObjectClass parent_class;
121 };
122 
123 #define QEMU_ALLOCATED_FLAG     0x01
124 
125 struct PixelFormat {
126     uint8_t bits_per_pixel;
127     uint8_t bytes_per_pixel;
128     uint8_t depth; /* color depth in bits */
129     uint32_t rmask, gmask, bmask, amask;
130     uint8_t rshift, gshift, bshift, ashift;
131     uint8_t rmax, gmax, bmax, amax;
132     uint8_t rbits, gbits, bbits, abits;
133 };
134 
135 struct DisplaySurface {
136     pixman_format_code_t format;
137     pixman_image_t *image;
138     uint8_t flags;
139 #ifdef CONFIG_OPENGL
140     GLenum glformat;
141     GLenum gltype;
142     GLuint texture;
143 #endif
144 };
145 
146 typedef struct QemuUIInfo {
147     /* geometry */
148     int       xoff;
149     int       yoff;
150     uint32_t  width;
151     uint32_t  height;
152 } QemuUIInfo;
153 
154 /* cursor data format is 32bit RGBA */
155 typedef struct QEMUCursor {
156     int                 width, height;
157     int                 hot_x, hot_y;
158     int                 refcount;
159     uint32_t            data[];
160 } QEMUCursor;
161 
162 QEMUCursor *cursor_alloc(int width, int height);
163 void cursor_get(QEMUCursor *c);
164 void cursor_put(QEMUCursor *c);
165 QEMUCursor *cursor_builtin_hidden(void);
166 QEMUCursor *cursor_builtin_left_ptr(void);
167 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
168 int cursor_get_mono_bpl(QEMUCursor *c);
169 void cursor_set_mono(QEMUCursor *c,
170                      uint32_t foreground, uint32_t background, uint8_t *image,
171                      int transparent, uint8_t *mask);
172 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
173 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
174 
175 typedef void *QEMUGLContext;
176 typedef struct QEMUGLParams QEMUGLParams;
177 
178 struct QEMUGLParams {
179     int major_ver;
180     int minor_ver;
181 };
182 
183 typedef struct DisplayChangeListenerOps {
184     const char *dpy_name;
185 
186     void (*dpy_refresh)(DisplayChangeListener *dcl);
187 
188     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
189                            int x, int y, int w, int h);
190     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
191                            struct DisplaySurface *new_surface);
192     void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
193                          int src_x, int src_y,
194                          int dst_x, int dst_y, int w, int h);
195     bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
196                                  pixman_format_code_t format);
197 
198     void (*dpy_text_cursor)(DisplayChangeListener *dcl,
199                             int x, int y);
200     void (*dpy_text_resize)(DisplayChangeListener *dcl,
201                             int w, int h);
202     void (*dpy_text_update)(DisplayChangeListener *dcl,
203                             int x, int y, int w, int h);
204 
205     void (*dpy_mouse_set)(DisplayChangeListener *dcl,
206                           int x, int y, int on);
207     void (*dpy_cursor_define)(DisplayChangeListener *dcl,
208                               QEMUCursor *cursor);
209 
210     QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
211                                        QEMUGLParams *params);
212     void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
213                                QEMUGLContext ctx);
214     int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
215                                    QEMUGLContext ctx);
216     QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);
217 
218     void (*dpy_gl_scanout)(DisplayChangeListener *dcl,
219                            uint32_t backing_id, bool backing_y_0_top,
220                            uint32_t backing_width, uint32_t backing_height,
221                            uint32_t x, uint32_t y, uint32_t w, uint32_t h);
222     void (*dpy_gl_update)(DisplayChangeListener *dcl,
223                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
224 
225 } DisplayChangeListenerOps;
226 
227 struct DisplayChangeListener {
228     uint64_t update_interval;
229     const DisplayChangeListenerOps *ops;
230     DisplayState *ds;
231     QemuConsole *con;
232 
233     QLIST_ENTRY(DisplayChangeListener) next;
234 };
235 
236 DisplayState *init_displaystate(void);
237 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
238                                                 pixman_format_code_t format,
239                                                 int linesize, uint8_t *data);
240 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
241 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
242                                                     pixman_format_code_t format,
243                                                     int linesize,
244                                                     uint64_t addr);
245 PixelFormat qemu_default_pixelformat(int bpp);
246 
247 DisplaySurface *qemu_create_displaysurface(int width, int height);
248 void qemu_free_displaysurface(DisplaySurface *surface);
249 
250 static inline int is_surface_bgr(DisplaySurface *surface)
251 {
252     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
253         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
254         return 1;
255     } else {
256         return 0;
257     }
258 }
259 
260 static inline int is_buffer_shared(DisplaySurface *surface)
261 {
262     return !(surface->flags & QEMU_ALLOCATED_FLAG);
263 }
264 
265 void register_displaychangelistener(DisplayChangeListener *dcl);
266 void update_displaychangelistener(DisplayChangeListener *dcl,
267                                   uint64_t interval);
268 void unregister_displaychangelistener(DisplayChangeListener *dcl);
269 
270 bool dpy_ui_info_supported(QemuConsole *con);
271 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
272 
273 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
274 void dpy_gfx_replace_surface(QemuConsole *con,
275                              DisplaySurface *surface);
276 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
277                   int dst_x, int dst_y, int w, int h);
278 void dpy_text_cursor(QemuConsole *con, int x, int y);
279 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
280 void dpy_text_resize(QemuConsole *con, int w, int h);
281 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
282 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
283 bool dpy_cursor_define_supported(QemuConsole *con);
284 bool dpy_gfx_check_format(QemuConsole *con,
285                           pixman_format_code_t format);
286 
287 void dpy_gl_scanout(QemuConsole *con,
288                     uint32_t backing_id, bool backing_y_0_top,
289                     uint32_t backing_width, uint32_t backing_height,
290                     uint32_t x, uint32_t y, uint32_t w, uint32_t h);
291 void dpy_gl_update(QemuConsole *con,
292                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
293 
294 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
295                                 QEMUGLParams *params);
296 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
297 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
298 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
299 
300 bool console_has_gl(QemuConsole *con);
301 
302 static inline int surface_stride(DisplaySurface *s)
303 {
304     return pixman_image_get_stride(s->image);
305 }
306 
307 static inline void *surface_data(DisplaySurface *s)
308 {
309     return pixman_image_get_data(s->image);
310 }
311 
312 static inline int surface_width(DisplaySurface *s)
313 {
314     return pixman_image_get_width(s->image);
315 }
316 
317 static inline int surface_height(DisplaySurface *s)
318 {
319     return pixman_image_get_height(s->image);
320 }
321 
322 static inline int surface_bits_per_pixel(DisplaySurface *s)
323 {
324     int bits = PIXMAN_FORMAT_BPP(s->format);
325     return bits;
326 }
327 
328 static inline int surface_bytes_per_pixel(DisplaySurface *s)
329 {
330     int bits = PIXMAN_FORMAT_BPP(s->format);
331     return (bits + 7) / 8;
332 }
333 
334 static inline pixman_format_code_t surface_format(DisplaySurface *s)
335 {
336     return s->format;
337 }
338 
339 #ifdef CONFIG_CURSES
340 /* KEY_EVENT is defined in wincon.h and in curses.h. Avoid redefinition. */
341 #undef KEY_EVENT
342 #include <curses.h>
343 #undef KEY_EVENT
344 typedef chtype console_ch_t;
345 extern chtype vga_to_curses[];
346 #else
347 typedef unsigned long console_ch_t;
348 #endif
349 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
350 {
351     uint8_t c = ch;
352 #ifdef CONFIG_CURSES
353     if (vga_to_curses[c]) {
354         ch &= ~(console_ch_t)0xff;
355         ch |= vga_to_curses[c];
356     }
357 #else
358     if (c == '\0') {
359         ch |= ' ';
360     }
361 #endif
362     *dest = ch;
363 }
364 
365 typedef struct GraphicHwOps {
366     void (*invalidate)(void *opaque);
367     void (*gfx_update)(void *opaque);
368     void (*text_update)(void *opaque, console_ch_t *text);
369     void (*update_interval)(void *opaque, uint64_t interval);
370     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
371     void (*gl_block)(void *opaque, bool block);
372 } GraphicHwOps;
373 
374 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
375                                   const GraphicHwOps *ops,
376                                   void *opaque);
377 void graphic_console_set_hwops(QemuConsole *con,
378                                const GraphicHwOps *hw_ops,
379                                void *opaque);
380 
381 void graphic_hw_update(QemuConsole *con);
382 void graphic_hw_invalidate(QemuConsole *con);
383 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
384 void graphic_hw_gl_block(QemuConsole *con, bool block);
385 
386 void qemu_console_early_init(void);
387 
388 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
389 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
390 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
391                                                 uint32_t head, Error **errp);
392 bool qemu_console_is_visible(QemuConsole *con);
393 bool qemu_console_is_graphic(QemuConsole *con);
394 bool qemu_console_is_fixedsize(QemuConsole *con);
395 bool qemu_console_is_gl_blocked(QemuConsole *con);
396 char *qemu_console_get_label(QemuConsole *con);
397 int qemu_console_get_index(QemuConsole *con);
398 uint32_t qemu_console_get_head(QemuConsole *con);
399 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
400 int qemu_console_get_width(QemuConsole *con, int fallback);
401 int qemu_console_get_height(QemuConsole *con, int fallback);
402 /* Return the low-level window id for the console */
403 int qemu_console_get_window_id(QemuConsole *con);
404 /* Set the low-level window id for the console */
405 void qemu_console_set_window_id(QemuConsole *con, int window_id);
406 
407 void console_select(unsigned int index);
408 void qemu_console_resize(QemuConsole *con, int width, int height);
409 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
410                        int dst_x, int dst_y, int w, int h);
411 DisplaySurface *qemu_console_surface(QemuConsole *con);
412 
413 /* console-gl.c */
414 typedef struct ConsoleGLState ConsoleGLState;
415 #ifdef CONFIG_OPENGL
416 ConsoleGLState *console_gl_init_context(void);
417 void console_gl_fini_context(ConsoleGLState *gls);
418 bool console_gl_check_format(DisplayChangeListener *dcl,
419                              pixman_format_code_t format);
420 void surface_gl_create_texture(ConsoleGLState *gls,
421                                DisplaySurface *surface);
422 void surface_gl_update_texture(ConsoleGLState *gls,
423                                DisplaySurface *surface,
424                                int x, int y, int w, int h);
425 void surface_gl_render_texture(ConsoleGLState *gls,
426                                DisplaySurface *surface);
427 void surface_gl_destroy_texture(ConsoleGLState *gls,
428                                DisplaySurface *surface);
429 void surface_gl_setup_viewport(ConsoleGLState *gls,
430                                DisplaySurface *surface,
431                                int ww, int wh);
432 #endif
433 
434 /* sdl.c */
435 #ifdef CONFIG_SDL
436 void sdl_display_early_init(int opengl);
437 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
438 #else
439 static inline void sdl_display_early_init(int opengl)
440 {
441     /* This must never be called if CONFIG_SDL is disabled */
442     error_report("SDL support is disabled");
443     abort();
444 }
445 static inline void sdl_display_init(DisplayState *ds, int full_screen,
446                                     int no_frame)
447 {
448     /* This must never be called if CONFIG_SDL is disabled */
449     error_report("SDL support is disabled");
450     abort();
451 }
452 #endif
453 
454 /* cocoa.m */
455 #ifdef CONFIG_COCOA
456 void cocoa_display_init(DisplayState *ds, int full_screen);
457 #else
458 static inline void cocoa_display_init(DisplayState *ds, int full_screen)
459 {
460     /* This must never be called if CONFIG_COCOA is disabled */
461     error_report("Cocoa support is disabled");
462     abort();
463 }
464 #endif
465 
466 /* vnc.c */
467 void vnc_display_init(const char *id);
468 void vnc_display_open(const char *id, Error **errp);
469 void vnc_display_add_client(const char *id, int csock, bool skipauth);
470 #ifdef CONFIG_VNC
471 int vnc_display_password(const char *id, const char *password);
472 int vnc_display_pw_expire(const char *id, time_t expires);
473 QemuOpts *vnc_parse(const char *str, Error **errp);
474 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
475 #else
476 static inline int vnc_display_password(const char *id, const char *password)
477 {
478     return -ENODEV;
479 }
480 static inline int vnc_display_pw_expire(const char *id, time_t expires)
481 {
482     return -ENODEV;
483 };
484 static inline QemuOpts *vnc_parse(const char *str, Error **errp)
485 {
486     error_setg(errp, "VNC support is disabled");
487     return NULL;
488 }
489 static inline int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp)
490 {
491     error_setg(errp, "VNC support is disabled");
492     return -1;
493 }
494 #endif
495 
496 /* curses.c */
497 #ifdef CONFIG_CURSES
498 void curses_display_init(DisplayState *ds, int full_screen);
499 #else
500 static inline void curses_display_init(DisplayState *ds, int full_screen)
501 {
502     /* This must never be called if CONFIG_CURSES is disabled */
503     error_report("curses support is disabled");
504     abort();
505 }
506 #endif
507 
508 /* input.c */
509 int index_from_key(const char *key, size_t key_length);
510 
511 /* gtk.c */
512 #ifdef CONFIG_GTK
513 void early_gtk_display_init(int opengl);
514 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
515 #else
516 static inline void gtk_display_init(DisplayState *ds, bool full_screen,
517                                     bool grab_on_hover)
518 {
519     /* This must never be called if CONFIG_GTK is disabled */
520     error_report("GTK support is disabled");
521     abort();
522 }
523 
524 static inline void early_gtk_display_init(int opengl)
525 {
526     /* This must never be called if CONFIG_GTK is disabled */
527     error_report("GTK support is disabled");
528     abort();
529 }
530 #endif
531 
532 #endif
533