console.h

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