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 "qemu/typedefs.h"
   9 #include "qapi-types.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 x, uint32_t y, uint32_t w, uint32_t h);
 221     void (*dpy_gl_update)(DisplayChangeListener *dcl,
 222                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 223
 224 } DisplayChangeListenerOps;
 225
 226 struct DisplayChangeListener {
 227     uint64_t update_interval;
 228     const DisplayChangeListenerOps *ops;
 229     DisplayState *ds;
 230     QemuConsole *con;
 231
 232     QLIST_ENTRY(DisplayChangeListener) next;
 233 };
 234
 235 DisplayState *init_displaystate(void);
 236 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
 237                                                 pixman_format_code_t format,
 238                                                 int linesize, uint8_t *data);
 239 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
 240                                                     pixman_format_code_t format,
 241                                                     int linesize,
 242                                                     uint64_t addr);
 243 PixelFormat qemu_default_pixelformat(int bpp);
 244
 245 DisplaySurface *qemu_create_displaysurface(int width, int height);
 246 void qemu_free_displaysurface(DisplaySurface *surface);
 247
 248 static inline int is_surface_bgr(DisplaySurface *surface)
 249 {
 250     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
 251         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
 252         return 1;
 253     } else {
 254         return 0;
 255     }
 256 }
 257
 258 static inline int is_buffer_shared(DisplaySurface *surface)
 259 {
 260     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 261 }
 262
 263 void register_displaychangelistener(DisplayChangeListener *dcl);
 264 void update_displaychangelistener(DisplayChangeListener *dcl,
 265                                   uint64_t interval);
 266 void unregister_displaychangelistener(DisplayChangeListener *dcl);
 267
 268 bool dpy_ui_info_supported(QemuConsole *con);
 269 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
 270
 271 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
 272 void dpy_gfx_replace_surface(QemuConsole *con,
 273                              DisplaySurface *surface);
 274 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
 275                   int dst_x, int dst_y, int w, int h);
 276 void dpy_text_cursor(QemuConsole *con, int x, int y);
 277 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
 278 void dpy_text_resize(QemuConsole *con, int w, int h);
 279 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
 280 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
 281 bool dpy_cursor_define_supported(QemuConsole *con);
 282 bool dpy_gfx_check_format(QemuConsole *con,
 283                           pixman_format_code_t format);
 284
 285 void dpy_gl_scanout(QemuConsole *con,
 286                     uint32_t backing_id, bool backing_y_0_top,
 287                     uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 288 void dpy_gl_update(QemuConsole *con,
 289                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 290
 291 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
 292                                 QEMUGLParams *params);
 293 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
 294 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
 295 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
 296
 297 bool console_has_gl(QemuConsole *con);
 298
 299 static inline int surface_stride(DisplaySurface *s)
 300 {
 301     return pixman_image_get_stride(s->image);
 302 }
 303
 304 static inline void *surface_data(DisplaySurface *s)
 305 {
 306     return pixman_image_get_data(s->image);
 307 }
 308
 309 static inline int surface_width(DisplaySurface *s)
 310 {
 311     return pixman_image_get_width(s->image);
 312 }
 313
 314 static inline int surface_height(DisplaySurface *s)
 315 {
 316     return pixman_image_get_height(s->image);
 317 }
 318
 319 static inline int surface_bits_per_pixel(DisplaySurface *s)
 320 {
 321     int bits = PIXMAN_FORMAT_BPP(s->format);
 322     return bits;
 323 }
 324
 325 static inline int surface_bytes_per_pixel(DisplaySurface *s)
 326 {
 327     int bits = PIXMAN_FORMAT_BPP(s->format);
 328     return (bits + 7) / 8;
 329 }
 330
 331 static inline pixman_format_code_t surface_format(DisplaySurface *s)
 332 {
 333     return s->format;
 334 }
 335
 336 #ifdef CONFIG_CURSES
 337 #include <curses.h>
 338 typedef chtype console_ch_t;
 339 extern chtype vga_to_curses[];
 340 #else
 341 typedef unsigned long console_ch_t;
 342 #endif
 343 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 344 {
 345     uint8_t c = ch;
 346 #ifdef CONFIG_CURSES
 347     if (vga_to_curses[c]) {
 348         ch &= ~(console_ch_t)0xff;
 349         ch |= vga_to_curses[c];
 350     }
 351 #else
 352     if (c == '\0') {
 353         ch |= ' ';
 354     }
 355 #endif
 356     *dest = ch;
 357 }
 358
 359 typedef struct GraphicHwOps {
 360     void (*invalidate)(void *opaque);
 361     void (*gfx_update)(void *opaque);
 362     void (*text_update)(void *opaque, console_ch_t *text);
 363     void (*update_interval)(void *opaque, uint64_t interval);
 364     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
 365     void (*gl_block)(void *opaque, bool block);
 366 } GraphicHwOps;
 367
 368 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
 369                                   const GraphicHwOps *ops,
 370                                   void *opaque);
 371 void graphic_console_set_hwops(QemuConsole *con,
 372                                const GraphicHwOps *hw_ops,
 373                                void *opaque);
 374
 375 void graphic_hw_update(QemuConsole *con);
 376 void graphic_hw_invalidate(QemuConsole *con);
 377 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
 378 void graphic_hw_gl_block(QemuConsole *con, bool block);
 379
 380 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
 381 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
 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