include/ui/console.h

   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_disable)(DisplayChangeListener *dcl);
 219     void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
 220                                    uint32_t backing_id,
 221                                    bool backing_y_0_top,
 222                                    uint32_t backing_width,
 223                                    uint32_t backing_height,
 224                                    uint32_t x, uint32_t y,
 225                                    uint32_t w, uint32_t h);
 226     void (*dpy_gl_update)(DisplayChangeListener *dcl,
 227                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 228
 229 } DisplayChangeListenerOps;
 230
 231 struct DisplayChangeListener {
 232     uint64_t update_interval;
 233     const DisplayChangeListenerOps *ops;
 234     DisplayState *ds;
 235     QemuConsole *con;
 236
 237     QLIST_ENTRY(DisplayChangeListener) next;
 238 };
 239
 240 DisplayState *init_displaystate(void);
 241 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
 242                                                 pixman_format_code_t format,
 243                                                 int linesize, uint8_t *data);
 244 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
 245 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
 246                                                     pixman_format_code_t format,
 247                                                     int linesize,
 248                                                     uint64_t addr);
 249 PixelFormat qemu_default_pixelformat(int bpp);
 250
 251 DisplaySurface *qemu_create_displaysurface(int width, int height);
 252 void qemu_free_displaysurface(DisplaySurface *surface);
 253
 254 static inline int is_surface_bgr(DisplaySurface *surface)
 255 {
 256     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
 257         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
 258         return 1;
 259     } else {
 260         return 0;
 261     }
 262 }
 263
 264 static inline int is_buffer_shared(DisplaySurface *surface)
 265 {
 266     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 267 }
 268
 269 void register_displaychangelistener(DisplayChangeListener *dcl);
 270 void update_displaychangelistener(DisplayChangeListener *dcl,
 271                                   uint64_t interval);
 272 void unregister_displaychangelistener(DisplayChangeListener *dcl);
 273
 274 bool dpy_ui_info_supported(QemuConsole *con);
 275 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
 276
 277 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
 278 void dpy_gfx_replace_surface(QemuConsole *con,
 279                              DisplaySurface *surface);
 280 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
 281                   int dst_x, int dst_y, int w, int h);
 282 void dpy_text_cursor(QemuConsole *con, int x, int y);
 283 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
 284 void dpy_text_resize(QemuConsole *con, int w, int h);
 285 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
 286 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
 287 bool dpy_cursor_define_supported(QemuConsole *con);
 288 bool dpy_gfx_check_format(QemuConsole *con,
 289                           pixman_format_code_t format);
 290
 291 void dpy_gl_scanout_disable(QemuConsole *con);
 292 void dpy_gl_scanout_texture(QemuConsole *con,
 293                             uint32_t backing_id, bool backing_y_0_top,
 294                             uint32_t backing_width, uint32_t backing_height,
 295                             uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 296 void dpy_gl_update(QemuConsole *con,
 297                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 298
 299 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
 300                                 QEMUGLParams *params);
 301 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
 302 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
 303 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
 304
 305 bool console_has_gl(QemuConsole *con);
 306
 307 static inline int surface_stride(DisplaySurface *s)
 308 {
 309     return pixman_image_get_stride(s->image);
 310 }
 311
 312 static inline void *surface_data(DisplaySurface *s)
 313 {
 314     return pixman_image_get_data(s->image);
 315 }
 316
 317 static inline int surface_width(DisplaySurface *s)
 318 {
 319     return pixman_image_get_width(s->image);
 320 }
 321
 322 static inline int surface_height(DisplaySurface *s)
 323 {
 324     return pixman_image_get_height(s->image);
 325 }
 326
 327 static inline int surface_bits_per_pixel(DisplaySurface *s)
 328 {
 329     int bits = PIXMAN_FORMAT_BPP(s->format);
 330     return bits;
 331 }
 332
 333 static inline int surface_bytes_per_pixel(DisplaySurface *s)
 334 {
 335     int bits = PIXMAN_FORMAT_BPP(s->format);
 336     return (bits + 7) / 8;
 337 }
 338
 339 static inline pixman_format_code_t surface_format(DisplaySurface *s)
 340 {
 341     return s->format;
 342 }
 343
 344 #ifdef CONFIG_CURSES
 345 /* KEY_EVENT is defined in wincon.h and in curses.h. Avoid redefinition. */
 346 #undef KEY_EVENT
 347 #include <curses.h>
 348 #undef KEY_EVENT
 349 typedef chtype console_ch_t;
 350 extern chtype vga_to_curses[];
 351 #else
 352 typedef unsigned long console_ch_t;
 353 #endif
 354 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 355 {
 356     uint8_t c = ch;
 357 #ifdef CONFIG_CURSES
 358     if (vga_to_curses[c]) {
 359         ch &= ~(console_ch_t)0xff;
 360         ch |= vga_to_curses[c];
 361     }
 362 #else
 363     if (c == '\0') {
 364         ch |= ' ';
 365     }
 366 #endif
 367     *dest = ch;
 368 }
 369
 370 typedef struct GraphicHwOps {
 371     void (*invalidate)(void *opaque);
 372     void (*gfx_update)(void *opaque);
 373     void (*text_update)(void *opaque, console_ch_t *text);
 374     void (*update_interval)(void *opaque, uint64_t interval);
 375     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
 376     void (*gl_block)(void *opaque, bool block);
 377 } GraphicHwOps;
 378
 379 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
 380                                   const GraphicHwOps *ops,
 381                                   void *opaque);
 382 void graphic_console_set_hwops(QemuConsole *con,
 383                                const GraphicHwOps *hw_ops,
 384                                void *opaque);
 385
 386 void graphic_hw_update(QemuConsole *con);
 387 void graphic_hw_invalidate(QemuConsole *con);
 388 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
 389 void graphic_hw_gl_block(QemuConsole *con, bool block);
 390
 391 void qemu_console_early_init(void);
 392
 393 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
 394 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
 395 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
 396                                                 uint32_t head, Error **errp);
 397 bool qemu_console_is_visible(QemuConsole *con);
 398 bool qemu_console_is_graphic(QemuConsole *con);
 399 bool qemu_console_is_fixedsize(QemuConsole *con);
 400 bool qemu_console_is_gl_blocked(QemuConsole *con);
 401 char *qemu_console_get_label(QemuConsole *con);
 402 int qemu_console_get_index(QemuConsole *con);
 403 uint32_t qemu_console_get_head(QemuConsole *con);
 404 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
 405 int qemu_console_get_width(QemuConsole *con, int fallback);
 406 int qemu_console_get_height(QemuConsole *con, int fallback);
 407 /* Return the low-level window id for the console */
 408 int qemu_console_get_window_id(QemuConsole *con);
 409 /* Set the low-level window id for the console */
 410 void qemu_console_set_window_id(QemuConsole *con, int window_id);
 411
 412 void console_select(unsigned int index);
 413 void qemu_console_resize(QemuConsole *con, int width, int height);
 414 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
 415                        int dst_x, int dst_y, int w, int h);
 416 DisplaySurface *qemu_console_surface(QemuConsole *con);
 417
 418 /* console-gl.c */
 419 typedef struct ConsoleGLState ConsoleGLState;
 420 #ifdef CONFIG_OPENGL
 421 ConsoleGLState *console_gl_init_context(void);
 422 void console_gl_fini_context(ConsoleGLState *gls);
 423 bool console_gl_check_format(DisplayChangeListener *dcl,
 424                              pixman_format_code_t format);
 425 void surface_gl_create_texture(ConsoleGLState *gls,
 426                                DisplaySurface *surface);
 427 void surface_gl_update_texture(ConsoleGLState *gls,
 428                                DisplaySurface *surface,
 429                                int x, int y, int w, int h);
 430 void surface_gl_render_texture(ConsoleGLState *gls,
 431                                DisplaySurface *surface);
 432 void surface_gl_destroy_texture(ConsoleGLState *gls,
 433                                DisplaySurface *surface);
 434 void surface_gl_setup_viewport(ConsoleGLState *gls,
 435                                DisplaySurface *surface,
 436                                int ww, int wh);
 437 #endif
 438
 439 /* sdl.c */
 440 #ifdef CONFIG_SDL
 441 void sdl_display_early_init(int opengl);
 442 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 443 #else
 444 static inline void sdl_display_early_init(int opengl)
 445 {
 446     /* This must never be called if CONFIG_SDL is disabled */
 447     error_report("SDL support is disabled");
 448     abort();
 449 }
 450 static inline void sdl_display_init(DisplayState *ds, int full_screen,
 451                                     int no_frame)
 452 {
 453     /* This must never be called if CONFIG_SDL is disabled */
 454     error_report("SDL support is disabled");
 455     abort();
 456 }
 457 #endif
 458
 459 /* cocoa.m */
 460 #ifdef CONFIG_COCOA
 461 void cocoa_display_init(DisplayState *ds, int full_screen);
 462 #else
 463 static inline void cocoa_display_init(DisplayState *ds, int full_screen)
 464 {
 465     /* This must never be called if CONFIG_COCOA is disabled */
 466     error_report("Cocoa support is disabled");
 467     abort();
 468 }
 469 #endif
 470
 471 /* vnc.c */
 472 void vnc_display_init(const char *id);
 473 void vnc_display_open(const char *id, Error **errp);
 474 void vnc_display_add_client(const char *id, int csock, bool skipauth);
 475 #ifdef CONFIG_VNC
 476 int vnc_display_password(const char *id, const char *password);
 477 int vnc_display_pw_expire(const char *id, time_t expires);
 478 QemuOpts *vnc_parse(const char *str, Error **errp);
 479 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
 480 #else
 481 static inline int vnc_display_password(const char *id, const char *password)
 482 {
 483     return -ENODEV;
 484 }
 485 static inline int vnc_display_pw_expire(const char *id, time_t expires)
 486 {
 487     return -ENODEV;
 488 };
 489 static inline QemuOpts *vnc_parse(const char *str, Error **errp)
 490 {
 491     error_setg(errp, "VNC support is disabled");
 492     return NULL;
 493 }
 494 static inline int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp)
 495 {
 496     error_setg(errp, "VNC support is disabled");
 497     return -1;
 498 }
 499 #endif
 500
 501 /* curses.c */
 502 #ifdef CONFIG_CURSES
 503 void curses_display_init(DisplayState *ds, int full_screen);
 504 #else
 505 static inline void curses_display_init(DisplayState *ds, int full_screen)
 506 {
 507     /* This must never be called if CONFIG_CURSES is disabled */
 508     error_report("curses support is disabled");
 509     abort();
 510 }
 511 #endif
 512
 513 /* input.c */
 514 int index_from_key(const char *key, size_t key_length);
 515
 516 /* gtk.c */
 517 #ifdef CONFIG_GTK
 518 void early_gtk_display_init(int opengl);
 519 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
 520 #else
 521 static inline void gtk_display_init(DisplayState *ds, bool full_screen,
 522                                     bool grab_on_hover)
 523 {
 524     /* This must never be called if CONFIG_GTK is disabled */
 525     error_report("GTK support is disabled");
 526     abort();
 527 }
 528
 529 static inline void early_gtk_display_init(int opengl)
 530 {
 531     /* This must never be called if CONFIG_GTK is disabled */
 532     error_report("GTK support is disabled");
 533     abort();
 534 }
 535 #endif
 536
 537 #endif