include/ui/console.h

   1 #ifndef CONSOLE_H
   2 #define CONSOLE_H
   3
   4 #include "ui/qemu-pixman.h"
   5 #include "qapi/qmp/qdict.h"
   6 #include "qemu/notify.h"
   7 #include "monitor/monitor.h"
   8 #include "trace.h"
   9 #include "qapi-types.h"
  10 #include "qapi/error.h"
  11
  12 /* keyboard/mouse support */
  13
  14 #define MOUSE_EVENT_LBUTTON 0x01
  15 #define MOUSE_EVENT_RBUTTON 0x02
  16 #define MOUSE_EVENT_MBUTTON 0x04
  17
  18 /* identical to the ps/2 keyboard bits */
  19 #define QEMU_SCROLL_LOCK_LED (1 << 0)
  20 #define QEMU_NUM_LOCK_LED    (1 << 1)
  21 #define QEMU_CAPS_LOCK_LED   (1 << 2)
  22
  23 /* in ms */
  24 #define GUI_REFRESH_INTERVAL 30
  25
  26 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
  27 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
  28 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
  29
  30 typedef struct QEMUPutMouseEntry {
  31     QEMUPutMouseEvent *qemu_put_mouse_event;
  32     void *qemu_put_mouse_event_opaque;
  33     int qemu_put_mouse_event_absolute;
  34     char *qemu_put_mouse_event_name;
  35
  36     int index;
  37
  38     /* used internally by qemu for handling mice */
  39     QTAILQ_ENTRY(QEMUPutMouseEntry) node;
  40 } QEMUPutMouseEntry;
  41
  42 typedef struct QEMUPutLEDEntry {
  43     QEMUPutLEDEvent *put_led;
  44     void *opaque;
  45     QTAILQ_ENTRY(QEMUPutLEDEntry) next;
  46 } QEMUPutLEDEntry;
  47
  48 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
  49 void qemu_remove_kbd_event_handler(void);
  50 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
  51                                                 void *opaque, int absolute,
  52                                                 const char *name);
  53 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
  54 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
  55
  56 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
  57 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
  58
  59 void kbd_put_keycode(int keycode);
  60 void kbd_put_ledstate(int ledstate);
  61 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
  62
  63 /* Does the current mouse generate absolute events */
  64 int kbd_mouse_is_absolute(void);
  65 void qemu_add_mouse_mode_change_notifier(Notifier *notify);
  66 void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
  67
  68 /* Of all the mice, is there one that generates absolute events */
  69 int kbd_mouse_has_absolute(void);
  70
  71 struct MouseTransformInfo {
  72     /* Touchscreen resolution */
  73     int x;
  74     int y;
  75     /* Calibration values as used/generated by tslib */
  76     int a[7];
  77 };
  78
  79 void do_mouse_set(Monitor *mon, const QDict *qdict);
  80
  81 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
  82    constants) */
  83 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
  84 #define QEMU_KEY_BACKSPACE  0x007f
  85 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
  86 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
  87 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
  88 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
  89 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
  90 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
  91 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
  92 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
  93 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
  94
  95 #define QEMU_KEY_CTRL_UP         0xe400
  96 #define QEMU_KEY_CTRL_DOWN       0xe401
  97 #define QEMU_KEY_CTRL_LEFT       0xe402
  98 #define QEMU_KEY_CTRL_RIGHT      0xe403
  99 #define QEMU_KEY_CTRL_HOME       0xe404
 100 #define QEMU_KEY_CTRL_END        0xe405
 101 #define QEMU_KEY_CTRL_PAGEUP     0xe406
 102 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
 103
 104 void kbd_put_keysym(int keysym);
 105
 106 /* consoles */
 107
 108 #define QEMU_BIG_ENDIAN_FLAG    0x01
 109 #define QEMU_ALLOCATED_FLAG     0x02
 110
 111 struct PixelFormat {
 112     uint8_t bits_per_pixel;
 113     uint8_t bytes_per_pixel;
 114     uint8_t depth; /* color depth in bits */
 115     uint32_t rmask, gmask, bmask, amask;
 116     uint8_t rshift, gshift, bshift, ashift;
 117     uint8_t rmax, gmax, bmax, amax;
 118     uint8_t rbits, gbits, bbits, abits;
 119 };
 120
 121 struct DisplaySurface {
 122     pixman_format_code_t format;
 123     pixman_image_t *image;
 124     uint8_t flags;
 125
 126     struct PixelFormat pf;
 127 };
 128
 129 /* cursor data format is 32bit RGBA */
 130 typedef struct QEMUCursor {
 131     int                 width, height;
 132     int                 hot_x, hot_y;
 133     int                 refcount;
 134     uint32_t            data[];
 135 } QEMUCursor;
 136
 137 QEMUCursor *cursor_alloc(int width, int height);
 138 void cursor_get(QEMUCursor *c);
 139 void cursor_put(QEMUCursor *c);
 140 QEMUCursor *cursor_builtin_hidden(void);
 141 QEMUCursor *cursor_builtin_left_ptr(void);
 142 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
 143 int cursor_get_mono_bpl(QEMUCursor *c);
 144 void cursor_set_mono(QEMUCursor *c,
 145                      uint32_t foreground, uint32_t background, uint8_t *image,
 146                      int transparent, uint8_t *mask);
 147 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
 148 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
 149
 150 struct DisplayChangeListener {
 151     int idle;
 152     uint64_t gui_timer_interval;
 153
 154     void (*dpy_refresh)(struct DisplayState *s);
 155
 156     void (*dpy_gfx_update)(struct DisplayState *s, int x, int y, int w, int h);
 157     void (*dpy_gfx_resize)(struct DisplayState *s);
 158     void (*dpy_gfx_setdata)(struct DisplayState *s);
 159     void (*dpy_gfx_copy)(struct DisplayState *s, int src_x, int src_y,
 160                          int dst_x, int dst_y, int w, int h);
 161
 162     void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
 163     void (*dpy_text_resize)(struct DisplayState *s, int w, int h);
 164     void (*dpy_text_update)(struct DisplayState *s, int x, int y, int w, int h);
 165
 166     void (*dpy_mouse_set)(struct DisplayState *s, int x, int y, int on);
 167     void (*dpy_cursor_define)(struct DisplayState *s, QEMUCursor *cursor);
 168
 169     QLIST_ENTRY(DisplayChangeListener) next;
 170 };
 171
 172 struct DisplayState {
 173     struct DisplaySurface *surface;
 174     void *opaque;
 175     struct QEMUTimer *gui_timer;
 176     bool have_gfx;
 177     bool have_text;
 178
 179     QLIST_HEAD(, DisplayChangeListener) listeners;
 180
 181     struct DisplayState *next;
 182 };
 183
 184 void register_displaystate(DisplayState *ds);
 185 DisplayState *get_displaystate(void);
 186 DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
 187                                                 int linesize, uint8_t *data);
 188 PixelFormat qemu_different_endianness_pixelformat(int bpp);
 189 PixelFormat qemu_default_pixelformat(int bpp);
 190
 191 DisplaySurface *qemu_create_displaysurface(DisplayState *ds,
 192                                            int width, int height);
 193 DisplaySurface *qemu_resize_displaysurface(DisplayState *ds,
 194                                            int width, int height);
 195 void qemu_free_displaysurface(DisplayState *ds);
 196
 197 static inline int is_surface_bgr(DisplaySurface *surface)
 198 {
 199     if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
 200         return 1;
 201     else
 202         return 0;
 203 }
 204
 205 static inline int is_buffer_shared(DisplaySurface *surface)
 206 {
 207     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 208 }
 209
 210 void gui_setup_refresh(DisplayState *ds);
 211
 212 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 213 {
 214     QLIST_INSERT_HEAD(&ds->listeners, dcl, next);
 215     gui_setup_refresh(ds);
 216     if (dcl->dpy_gfx_resize) {
 217         dcl->dpy_gfx_resize(ds);
 218     }
 219 }
 220
 221 static inline void unregister_displaychangelistener(DisplayState *ds,
 222                                                     DisplayChangeListener *dcl)
 223 {
 224     QLIST_REMOVE(dcl, next);
 225     gui_setup_refresh(ds);
 226 }
 227
 228 static inline void dpy_gfx_update(DisplayState *s, int x, int y, int w, int h)
 229 {
 230     struct DisplayChangeListener *dcl;
 231     int width = pixman_image_get_width(s->surface->image);
 232     int height = pixman_image_get_height(s->surface->image);
 233
 234     x = MAX(x, 0);
 235     y = MAX(y, 0);
 236     x = MIN(x, width);
 237     y = MIN(y, height);
 238     w = MIN(w, width - x);
 239     h = MIN(h, height - y);
 240
 241     QLIST_FOREACH(dcl, &s->listeners, next) {
 242         if (dcl->dpy_gfx_update) {
 243             dcl->dpy_gfx_update(s, x, y, w, h);
 244         }
 245     }
 246 }
 247
 248 static inline void dpy_gfx_resize(DisplayState *s)
 249 {
 250     struct DisplayChangeListener *dcl;
 251     QLIST_FOREACH(dcl, &s->listeners, next) {
 252         if (dcl->dpy_gfx_resize) {
 253             dcl->dpy_gfx_resize(s);
 254         }
 255     }
 256 }
 257
 258 static inline void dpy_gfx_setdata(DisplayState *s)
 259 {
 260     struct DisplayChangeListener *dcl;
 261     QLIST_FOREACH(dcl, &s->listeners, next) {
 262         if (dcl->dpy_gfx_setdata) {
 263             dcl->dpy_gfx_setdata(s);
 264         }
 265     }
 266 }
 267
 268 static inline void dpy_refresh(DisplayState *s)
 269 {
 270     struct DisplayChangeListener *dcl;
 271     QLIST_FOREACH(dcl, &s->listeners, next) {
 272         if (dcl->dpy_refresh) {
 273             dcl->dpy_refresh(s);
 274         }
 275     }
 276 }
 277
 278 static inline void dpy_gfx_copy(struct DisplayState *s, int src_x, int src_y,
 279                              int dst_x, int dst_y, int w, int h)
 280 {
 281     struct DisplayChangeListener *dcl;
 282     QLIST_FOREACH(dcl, &s->listeners, next) {
 283         if (dcl->dpy_gfx_copy) {
 284             dcl->dpy_gfx_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 285         } else { /* TODO */
 286             dcl->dpy_gfx_update(s, dst_x, dst_y, w, h);
 287         }
 288     }
 289 }
 290
 291 static inline void dpy_text_cursor(struct DisplayState *s, int x, int y)
 292 {
 293     struct DisplayChangeListener *dcl;
 294     QLIST_FOREACH(dcl, &s->listeners, next) {
 295         if (dcl->dpy_text_cursor) {
 296             dcl->dpy_text_cursor(s, x, y);
 297         }
 298     }
 299 }
 300
 301 static inline void dpy_text_update(DisplayState *s, int x, int y, int w, int h)
 302 {
 303     struct DisplayChangeListener *dcl;
 304     QLIST_FOREACH(dcl, &s->listeners, next) {
 305         if (dcl->dpy_text_update) {
 306             dcl->dpy_text_update(s, x, y, w, h);
 307         }
 308     }
 309 }
 310
 311 static inline void dpy_text_resize(DisplayState *s, int w, int h)
 312 {
 313     struct DisplayChangeListener *dcl;
 314     QLIST_FOREACH(dcl, &s->listeners, next) {
 315         if (dcl->dpy_text_resize) {
 316             dcl->dpy_text_resize(s, w, h);
 317         }
 318     }
 319 }
 320
 321 static inline void dpy_mouse_set(struct DisplayState *s, int x, int y, int on)
 322 {
 323     struct DisplayChangeListener *dcl;
 324     QLIST_FOREACH(dcl, &s->listeners, next) {
 325         if (dcl->dpy_mouse_set) {
 326             dcl->dpy_mouse_set(s, x, y, on);
 327         }
 328     }
 329 }
 330
 331 static inline void dpy_cursor_define(struct DisplayState *s, QEMUCursor *cursor)
 332 {
 333     struct DisplayChangeListener *dcl;
 334     QLIST_FOREACH(dcl, &s->listeners, next) {
 335         if (dcl->dpy_cursor_define) {
 336             dcl->dpy_cursor_define(s, cursor);
 337         }
 338     }
 339 }
 340
 341 static inline bool dpy_cursor_define_supported(struct DisplayState *s)
 342 {
 343     struct DisplayChangeListener *dcl;
 344     QLIST_FOREACH(dcl, &s->listeners, next) {
 345         if (dcl->dpy_cursor_define) {
 346             return true;
 347         }
 348     }
 349     return false;
 350 }
 351
 352 static inline int ds_get_linesize(DisplayState *ds)
 353 {
 354     return pixman_image_get_stride(ds->surface->image);
 355 }
 356
 357 static inline uint8_t* ds_get_data(DisplayState *ds)
 358 {
 359     return (void *)pixman_image_get_data(ds->surface->image);
 360 }
 361
 362 static inline int ds_get_width(DisplayState *ds)
 363 {
 364     return pixman_image_get_width(ds->surface->image);
 365 }
 366
 367 static inline int ds_get_height(DisplayState *ds)
 368 {
 369     return pixman_image_get_height(ds->surface->image);
 370 }
 371
 372 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 373 {
 374     int bits = PIXMAN_FORMAT_BPP(ds->surface->format);
 375     return bits;
 376 }
 377
 378 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 379 {
 380     int bits = PIXMAN_FORMAT_BPP(ds->surface->format);
 381     return (bits + 7) / 8;
 382 }
 383
 384 static inline pixman_format_code_t ds_get_format(DisplayState *ds)
 385 {
 386     return ds->surface->format;
 387 }
 388
 389 static inline pixman_image_t *ds_get_image(DisplayState *ds)
 390 {
 391     return ds->surface->image;
 392 }
 393
 394 static inline int ds_get_depth(DisplayState *ds)
 395 {
 396     return ds->surface->pf.depth;
 397 }
 398
 399 static inline int ds_get_rmask(DisplayState *ds)
 400 {
 401     return ds->surface->pf.rmask;
 402 }
 403
 404 static inline int ds_get_gmask(DisplayState *ds)
 405 {
 406     return ds->surface->pf.gmask;
 407 }
 408
 409 static inline int ds_get_bmask(DisplayState *ds)
 410 {
 411     return ds->surface->pf.bmask;
 412 }
 413
 414 #ifdef CONFIG_CURSES
 415 #include <curses.h>
 416 typedef chtype console_ch_t;
 417 #else
 418 typedef unsigned long console_ch_t;
 419 #endif
 420 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 421 {
 422     if (!(ch & 0xff))
 423         ch |= ' ';
 424     *dest = ch;
 425 }
 426
 427 typedef void (*vga_hw_update_ptr)(void *);
 428 typedef void (*vga_hw_invalidate_ptr)(void *);
 429 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch,
 430                                        Error **errp);
 431 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 432
 433 DisplayState *graphic_console_init(vga_hw_update_ptr update,
 434                                    vga_hw_invalidate_ptr invalidate,
 435                                    vga_hw_screen_dump_ptr screen_dump,
 436                                    vga_hw_text_update_ptr text_update,
 437                                    void *opaque);
 438
 439 void vga_hw_update(void);
 440 void vga_hw_invalidate(void);
 441 void vga_hw_text_update(console_ch_t *chardata);
 442
 443 int is_graphic_console(void);
 444 int is_fixedsize_console(void);
 445 CharDriverState *text_console_init(QemuOpts *opts);
 446 void text_consoles_set_display(DisplayState *ds);
 447 void console_select(unsigned int index);
 448 void console_color_init(DisplayState *ds);
 449 void qemu_console_resize(DisplayState *ds, int width, int height);
 450 void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
 451                        int dst_x, int dst_y, int w, int h);
 452
 453 /* sdl.c */
 454 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 455
 456 /* cocoa.m */
 457 void cocoa_display_init(DisplayState *ds, int full_screen);
 458
 459 /* vnc.c */
 460 void vnc_display_init(DisplayState *ds);
 461 void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
 462 void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
 463 char *vnc_display_local_addr(DisplayState *ds);
 464 #ifdef CONFIG_VNC
 465 int vnc_display_password(DisplayState *ds, const char *password);
 466 int vnc_display_pw_expire(DisplayState *ds, time_t expires);
 467 #else
 468 static inline int vnc_display_password(DisplayState *ds, const char *password)
 469 {
 470     return -ENODEV;
 471 }
 472 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
 473 {
 474     return -ENODEV;
 475 };
 476 #endif
 477
 478 /* curses.c */
 479 void curses_display_init(DisplayState *ds, int full_screen);
 480
 481 /* input.c */
 482 int index_from_key(const char *key);
 483 int index_from_keycode(int code);
 484
 485 #endif