xref: /qemu/include/ui/console.h (revision 3d100d0f) 
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 /* keyboard/mouse support */
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 /* 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)
26 
27 /* in ms */
28 #define GUI_REFRESH_INTERVAL_DEFAULT    30
29 #define GUI_REFRESH_INTERVAL_IDLE     3000
30 
31 /* Color number is match to standard vga palette */
32 enum 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 /* Convert to curses char attributes */
43 #define ATTR2CHTYPE(c, fg, bg, bold) \
44     ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
45 
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);
49 
50 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
51 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
52 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
53 
54 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
55                                             void *opaque);
56 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
57                                                 void *opaque, int absolute,
58                                                 const char *name);
59 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
60 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
61 
62 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
63 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
64 
65 void kbd_put_ledstate(int ledstate);
66 
67 struct MouseTransformInfo {
68     /* Touchscreen resolution */
69     int x;
70     int y;
71     /* Calibration values as used/generated by tslib */
72     int a[7];
73 };
74 
75 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
76 
77 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
78    constants) */
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 
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);
104 
105 /* consoles */
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 
115 typedef struct QemuConsoleClass QemuConsoleClass;
116 
117 struct QemuConsoleClass {
118     ObjectClass parent_class;
119 };
120 
121 #define QEMU_ALLOCATED_FLAG     0x01
122 
123 struct PixelFormat {
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;
131 };
132 
133 struct 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 
144 typedef struct QemuUIInfo {
145     /* geometry */
146     int       xoff;
147     int       yoff;
148     uint32_t  width;
149     uint32_t  height;
150 } QemuUIInfo;
151 
152 /* cursor data format is 32bit RGBA */
153 typedef struct QEMUCursor {
154     int                 width, height;
155     int                 hot_x, hot_y;
156     int                 refcount;
157     uint32_t            data[];
158 } QEMUCursor;
159 
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);
172 
173 typedef void *QEMUGLContext;
174 typedef struct QEMUGLParams QEMUGLParams;
175 
176 struct QEMUGLParams {
177     int major_ver;
178     int minor_ver;
179 };
180 
181 typedef 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 
224 struct DisplayChangeListener {
225     uint64_t update_interval;
226     const DisplayChangeListenerOps *ops;
227     DisplayState *ds;
228     QemuConsole *con;
229 
230     QLIST_ENTRY(DisplayChangeListener) next;
231 };
232 
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_guestmem(int width, int height,
238                                                     pixman_format_code_t format,
239                                                     int linesize,
240                                                     uint64_t addr);
241 PixelFormat qemu_default_pixelformat(int bpp);
242 
243 DisplaySurface *qemu_create_displaysurface(int width, int height);
244 void qemu_free_displaysurface(DisplaySurface *surface);
245 
246 static inline int is_surface_bgr(DisplaySurface *surface)
247 {
248     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
249         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
250         return 1;
251     } else {
252         return 0;
253     }
254 }
255 
256 static inline int is_buffer_shared(DisplaySurface *surface)
257 {
258     return !(surface->flags & QEMU_ALLOCATED_FLAG);
259 }
260 
261 void register_displaychangelistener(DisplayChangeListener *dcl);
262 void update_displaychangelistener(DisplayChangeListener *dcl,
263                                   uint64_t interval);
264 void unregister_displaychangelistener(DisplayChangeListener *dcl);
265 
266 bool dpy_ui_info_supported(QemuConsole *con);
267 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
268 
269 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
270 void dpy_gfx_replace_surface(QemuConsole *con,
271                              DisplaySurface *surface);
272 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
273                   int dst_x, int dst_y, int w, int h);
274 void dpy_text_cursor(QemuConsole *con, int x, int y);
275 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
276 void dpy_text_resize(QemuConsole *con, int w, int h);
277 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
278 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
279 bool dpy_cursor_define_supported(QemuConsole *con);
280 bool dpy_gfx_check_format(QemuConsole *con,
281                           pixman_format_code_t format);
282 
283 void dpy_gl_scanout(QemuConsole *con,
284                     uint32_t backing_id, bool backing_y_0_top,
285                     uint32_t x, uint32_t y, uint32_t w, uint32_t h);
286 void dpy_gl_update(QemuConsole *con,
287                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
288 
289 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
290                                 QEMUGLParams *params);
291 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
292 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
293 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
294 
295 bool console_has_gl(QemuConsole *con);
296 
297 static inline int surface_stride(DisplaySurface *s)
298 {
299     return pixman_image_get_stride(s->image);
300 }
301 
302 static inline void *surface_data(DisplaySurface *s)
303 {
304     return pixman_image_get_data(s->image);
305 }
306 
307 static inline int surface_width(DisplaySurface *s)
308 {
309     return pixman_image_get_width(s->image);
310 }
311 
312 static inline int surface_height(DisplaySurface *s)
313 {
314     return pixman_image_get_height(s->image);
315 }
316 
317 static inline int surface_bits_per_pixel(DisplaySurface *s)
318 {
319     int bits = PIXMAN_FORMAT_BPP(s->format);
320     return bits;
321 }
322 
323 static inline int surface_bytes_per_pixel(DisplaySurface *s)
324 {
325     int bits = PIXMAN_FORMAT_BPP(s->format);
326     return (bits + 7) / 8;
327 }
328 
329 static inline pixman_format_code_t surface_format(DisplaySurface *s)
330 {
331     return s->format;
332 }
333 
334 #ifdef CONFIG_CURSES
335 #include <curses.h>
336 typedef chtype console_ch_t;
337 extern chtype vga_to_curses[];
338 #else
339 typedef unsigned long console_ch_t;
340 #endif
341 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
342 {
343     uint8_t c = ch;
344 #ifdef CONFIG_CURSES
345     if (vga_to_curses[c]) {
346         ch &= ~(console_ch_t)0xff;
347         ch |= vga_to_curses[c];
348     }
349 #else
350     if (c == '\0') {
351         ch |= ' ';
352     }
353 #endif
354     *dest = ch;
355 }
356 
357 typedef struct GraphicHwOps {
358     void (*invalidate)(void *opaque);
359     void (*gfx_update)(void *opaque);
360     void (*text_update)(void *opaque, console_ch_t *text);
361     void (*update_interval)(void *opaque, uint64_t interval);
362     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
363     void (*gl_block)(void *opaque, bool block);
364 } GraphicHwOps;
365 
366 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
367                                   const GraphicHwOps *ops,
368                                   void *opaque);
369 void graphic_console_set_hwops(QemuConsole *con,
370                                const GraphicHwOps *hw_ops,
371                                void *opaque);
372 
373 void graphic_hw_update(QemuConsole *con);
374 void graphic_hw_invalidate(QemuConsole *con);
375 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
376 void graphic_hw_gl_block(QemuConsole *con, bool block);
377 
378 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
379 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
380 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
381                                                 uint32_t head, Error **errp);
382 bool qemu_console_is_visible(QemuConsole *con);
383 bool qemu_console_is_graphic(QemuConsole *con);
384 bool qemu_console_is_fixedsize(QemuConsole *con);
385 char *qemu_console_get_label(QemuConsole *con);
386 int qemu_console_get_index(QemuConsole *con);
387 uint32_t qemu_console_get_head(QemuConsole *con);
388 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
389 int qemu_console_get_width(QemuConsole *con, int fallback);
390 int qemu_console_get_height(QemuConsole *con, int fallback);
391 
392 void text_consoles_set_display(DisplayState *ds);
393 void console_select(unsigned int index);
394 void console_color_init(DisplayState *ds);
395 void qemu_console_resize(QemuConsole *con, int width, int height);
396 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
397                        int dst_x, int dst_y, int w, int h);
398 DisplaySurface *qemu_console_surface(QemuConsole *con);
399 
400 /* console-gl.c */
401 typedef struct ConsoleGLState ConsoleGLState;
402 #ifdef CONFIG_OPENGL
403 ConsoleGLState *console_gl_init_context(void);
404 void console_gl_fini_context(ConsoleGLState *gls);
405 bool console_gl_check_format(DisplayChangeListener *dcl,
406                              pixman_format_code_t format);
407 void surface_gl_create_texture(ConsoleGLState *gls,
408                                DisplaySurface *surface);
409 void surface_gl_update_texture(ConsoleGLState *gls,
410                                DisplaySurface *surface,
411                                int x, int y, int w, int h);
412 void surface_gl_render_texture(ConsoleGLState *gls,
413                                DisplaySurface *surface);
414 void surface_gl_destroy_texture(ConsoleGLState *gls,
415                                DisplaySurface *surface);
416 void surface_gl_setup_viewport(ConsoleGLState *gls,
417                                DisplaySurface *surface,
418                                int ww, int wh);
419 #endif
420 
421 /* sdl.c */
422 void sdl_display_early_init(int opengl);
423 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
424 
425 /* cocoa.m */
426 void cocoa_display_init(DisplayState *ds, int full_screen);
427 
428 /* vnc.c */
429 void vnc_display_init(const char *id);
430 void vnc_display_open(const char *id, Error **errp);
431 void vnc_display_add_client(const char *id, int csock, bool skipauth);
432 char *vnc_display_local_addr(const char *id);
433 #ifdef CONFIG_VNC
434 int vnc_display_password(const char *id, const char *password);
435 int vnc_display_pw_expire(const char *id, time_t expires);
436 QemuOpts *vnc_parse(const char *str, Error **errp);
437 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
438 #else
439 static inline int vnc_display_password(const char *id, const char *password)
440 {
441     return -ENODEV;
442 }
443 static inline int vnc_display_pw_expire(const char *id, time_t expires)
444 {
445     return -ENODEV;
446 };
447 #endif
448 
449 /* curses.c */
450 void curses_display_init(DisplayState *ds, int full_screen);
451 
452 /* input.c */
453 int index_from_key(const char *key, size_t key_length);
454 
455 /* gtk.c */
456 void early_gtk_display_init(int opengl);
457 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
458 
459 #endif
460