console.h

   1 #ifndef CONSOLE_H
   2 #define CONSOLE_H
   3
   4 #include "qemu-char.h"
   5 #include "qdict.h"
   6 #include "notify.h"
   7 #include "monitor.h"
   8 #include "trace.h"
   9 #include "qapi-types.h"
  10 #include "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 #define QEMU_REALPIXELS_FLAG    0x04
 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     uint8_t flags;
 124     int width;
 125     int height;
 126     int linesize;        /* bytes per line */
 127     uint8_t *data;
 128
 129     struct PixelFormat pf;
 130 };
 131
 132 /* cursor data format is 32bit RGBA */
 133 typedef struct QEMUCursor {
 134     int                 width, height;
 135     int                 hot_x, hot_y;
 136     int                 refcount;
 137     uint32_t            data[];
 138 } QEMUCursor;
 139
 140 QEMUCursor *cursor_alloc(int width, int height);
 141 void cursor_get(QEMUCursor *c);
 142 void cursor_put(QEMUCursor *c);
 143 QEMUCursor *cursor_builtin_hidden(void);
 144 QEMUCursor *cursor_builtin_left_ptr(void);
 145 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
 146 int cursor_get_mono_bpl(QEMUCursor *c);
 147 void cursor_set_mono(QEMUCursor *c,
 148                      uint32_t foreground, uint32_t background, uint8_t *image,
 149                      int transparent, uint8_t *mask);
 150 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
 151 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
 152
 153 struct DisplayChangeListener {
 154     int idle;
 155     uint64_t gui_timer_interval;
 156
 157     void (*dpy_refresh)(struct DisplayState *s);
 158
 159     void (*dpy_gfx_update)(struct DisplayState *s, int x, int y, int w, int h);
 160     void (*dpy_gfx_resize)(struct DisplayState *s);
 161     void (*dpy_gfx_setdata)(struct DisplayState *s);
 162     void (*dpy_gfx_copy)(struct DisplayState *s, int src_x, int src_y,
 163                          int dst_x, int dst_y, int w, int h);
 164     void (*dpy_gfx_fill)(struct DisplayState *s, int x, int y,
 165                          int w, int h, uint32_t c);
 166
 167     void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
 168     void (*dpy_text_resize)(struct DisplayState *s, int w, int h);
 169     void (*dpy_text_update)(struct DisplayState *s, int x, int y, int w, int h);
 170
 171     void (*dpy_mouse_set)(struct DisplayState *s, int x, int y, int on);
 172     void (*dpy_cursor_define)(struct DisplayState *s, QEMUCursor *cursor);
 173
 174     QLIST_ENTRY(DisplayChangeListener) next;
 175 };
 176
 177 struct DisplayAllocator {
 178     DisplaySurface* (*create_displaysurface)(int width, int height);
 179     DisplaySurface* (*resize_displaysurface)(DisplaySurface *surface, int width, int height);
 180     void (*free_displaysurface)(DisplaySurface *surface);
 181 };
 182
 183 struct DisplayState {
 184     struct DisplaySurface *surface;
 185     void *opaque;
 186     struct QEMUTimer *gui_timer;
 187     bool have_gfx;
 188     bool have_text;
 189
 190     struct DisplayAllocator* allocator;
 191     QLIST_HEAD(, DisplayChangeListener) listeners;
 192
 193     struct DisplayState *next;
 194 };
 195
 196 void register_displaystate(DisplayState *ds);
 197 DisplayState *get_displaystate(void);
 198 DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
 199                                                 int linesize, uint8_t *data);
 200 void qemu_alloc_display(DisplaySurface *surface, int width, int height,
 201                         int linesize, PixelFormat pf, int newflags);
 202 PixelFormat qemu_different_endianness_pixelformat(int bpp);
 203 PixelFormat qemu_default_pixelformat(int bpp);
 204
 205 DisplayAllocator *register_displayallocator(DisplayState *ds, DisplayAllocator *da);
 206
 207 static inline DisplaySurface* qemu_create_displaysurface(DisplayState *ds, int width, int height)
 208 {
 209     return ds->allocator->create_displaysurface(width, height);
 210 }
 211
 212 static inline DisplaySurface* qemu_resize_displaysurface(DisplayState *ds, int width, int height)
 213 {
 214     trace_displaysurface_resize(ds, ds->surface, width, height);
 215     return ds->allocator->resize_displaysurface(ds->surface, width, height);
 216 }
 217
 218 static inline void qemu_free_displaysurface(DisplayState *ds)
 219 {
 220     trace_displaysurface_free(ds, ds->surface);
 221     ds->allocator->free_displaysurface(ds->surface);
 222 }
 223
 224 static inline int is_surface_bgr(DisplaySurface *surface)
 225 {
 226     if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
 227         return 1;
 228     else
 229         return 0;
 230 }
 231
 232 static inline int is_buffer_shared(DisplaySurface *surface)
 233 {
 234     return (!(surface->flags & QEMU_ALLOCATED_FLAG) &&
 235             !(surface->flags & QEMU_REALPIXELS_FLAG));
 236 }
 237
 238 void gui_setup_refresh(DisplayState *ds);
 239
 240 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 241 {
 242     QLIST_INSERT_HEAD(&ds->listeners, dcl, next);
 243     gui_setup_refresh(ds);
 244 }
 245
 246 static inline void unregister_displaychangelistener(DisplayState *ds,
 247                                                     DisplayChangeListener *dcl)
 248 {
 249     QLIST_REMOVE(dcl, next);
 250     gui_setup_refresh(ds);
 251 }
 252
 253 static inline void dpy_gfx_update(DisplayState *s, int x, int y, int w, int h)
 254 {
 255     struct DisplayChangeListener *dcl;
 256     QLIST_FOREACH(dcl, &s->listeners, next) {
 257         if (dcl->dpy_gfx_update) {
 258             dcl->dpy_gfx_update(s, x, y, w, h);
 259         }
 260     }
 261 }
 262
 263 static inline void dpy_gfx_resize(DisplayState *s)
 264 {
 265     struct DisplayChangeListener *dcl;
 266     QLIST_FOREACH(dcl, &s->listeners, next) {
 267         if (dcl->dpy_gfx_resize) {
 268             dcl->dpy_gfx_resize(s);
 269         }
 270     }
 271 }
 272
 273 static inline void dpy_gfx_setdata(DisplayState *s)
 274 {
 275     struct DisplayChangeListener *dcl;
 276     QLIST_FOREACH(dcl, &s->listeners, next) {
 277         if (dcl->dpy_gfx_setdata) {
 278             dcl->dpy_gfx_setdata(s);
 279         }
 280     }
 281 }
 282
 283 static inline void dpy_refresh(DisplayState *s)
 284 {
 285     struct DisplayChangeListener *dcl;
 286     QLIST_FOREACH(dcl, &s->listeners, next) {
 287         if (dcl->dpy_refresh) {
 288             dcl->dpy_refresh(s);
 289         }
 290     }
 291 }
 292
 293 static inline void dpy_gfx_copy(struct DisplayState *s, int src_x, int src_y,
 294                              int dst_x, int dst_y, int w, int h)
 295 {
 296     struct DisplayChangeListener *dcl;
 297     QLIST_FOREACH(dcl, &s->listeners, next) {
 298         if (dcl->dpy_gfx_copy) {
 299             dcl->dpy_gfx_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 300         } else { /* TODO */
 301             dcl->dpy_gfx_update(s, dst_x, dst_y, w, h);
 302         }
 303     }
 304 }
 305
 306 static inline void dpy_gfx_fill(struct DisplayState *s, int x, int y,
 307                                 int w, int h, uint32_t c)
 308 {
 309     struct DisplayChangeListener *dcl;
 310     QLIST_FOREACH(dcl, &s->listeners, next) {
 311         if (dcl->dpy_gfx_fill) {
 312             dcl->dpy_gfx_fill(s, x, y, w, h, c);
 313         }
 314     }
 315 }
 316
 317 static inline void dpy_text_cursor(struct DisplayState *s, int x, int y)
 318 {
 319     struct DisplayChangeListener *dcl;
 320     QLIST_FOREACH(dcl, &s->listeners, next) {
 321         if (dcl->dpy_text_cursor) {
 322             dcl->dpy_text_cursor(s, x, y);
 323         }
 324     }
 325 }
 326
 327 static inline void dpy_text_update(DisplayState *s, int x, int y, int w, int h)
 328 {
 329     struct DisplayChangeListener *dcl;
 330     QLIST_FOREACH(dcl, &s->listeners, next) {
 331         if (dcl->dpy_text_update) {
 332             dcl->dpy_text_update(s, x, y, w, h);
 333         }
 334     }
 335 }
 336
 337 static inline void dpy_text_resize(DisplayState *s, int w, int h)
 338 {
 339     struct DisplayChangeListener *dcl;
 340     QLIST_FOREACH(dcl, &s->listeners, next) {
 341         if (dcl->dpy_text_resize) {
 342             dcl->dpy_text_resize(s, w, h);
 343         }
 344     }
 345 }
 346
 347 static inline void dpy_mouse_set(struct DisplayState *s, int x, int y, int on)
 348 {
 349     struct DisplayChangeListener *dcl;
 350     QLIST_FOREACH(dcl, &s->listeners, next) {
 351         if (dcl->dpy_mouse_set) {
 352             dcl->dpy_mouse_set(s, x, y, on);
 353         }
 354     }
 355 }
 356
 357 static inline void dpy_cursor_define(struct DisplayState *s, QEMUCursor *cursor)
 358 {
 359     struct DisplayChangeListener *dcl;
 360     QLIST_FOREACH(dcl, &s->listeners, next) {
 361         if (dcl->dpy_cursor_define) {
 362             dcl->dpy_cursor_define(s, cursor);
 363         }
 364     }
 365 }
 366
 367 static inline bool dpy_cursor_define_supported(struct DisplayState *s)
 368 {
 369     struct DisplayChangeListener *dcl;
 370     QLIST_FOREACH(dcl, &s->listeners, next) {
 371         if (dcl->dpy_cursor_define) {
 372             return true;
 373         }
 374     }
 375     return false;
 376 }
 377
 378 static inline int ds_get_linesize(DisplayState *ds)
 379 {
 380     return ds->surface->linesize;
 381 }
 382
 383 static inline uint8_t* ds_get_data(DisplayState *ds)
 384 {
 385     return ds->surface->data;
 386 }
 387
 388 static inline int ds_get_width(DisplayState *ds)
 389 {
 390     return ds->surface->width;
 391 }
 392
 393 static inline int ds_get_height(DisplayState *ds)
 394 {
 395     return ds->surface->height;
 396 }
 397
 398 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 399 {
 400     return ds->surface->pf.bits_per_pixel;
 401 }
 402
 403 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 404 {
 405     return ds->surface->pf.bytes_per_pixel;
 406 }
 407
 408 #ifdef CONFIG_CURSES
 409 #include <curses.h>
 410 typedef chtype console_ch_t;
 411 #else
 412 typedef unsigned long console_ch_t;
 413 #endif
 414 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 415 {
 416     if (!(ch & 0xff))
 417         ch |= ' ';
 418     *dest = ch;
 419 }
 420
 421 typedef void (*vga_hw_update_ptr)(void *);
 422 typedef void (*vga_hw_invalidate_ptr)(void *);
 423 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch,
 424                                        Error **errp);
 425 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 426
 427 DisplayState *graphic_console_init(vga_hw_update_ptr update,
 428                                    vga_hw_invalidate_ptr invalidate,
 429                                    vga_hw_screen_dump_ptr screen_dump,
 430                                    vga_hw_text_update_ptr text_update,
 431                                    void *opaque);
 432
 433 void vga_hw_update(void);
 434 void vga_hw_invalidate(void);
 435 void vga_hw_text_update(console_ch_t *chardata);
 436
 437 int is_graphic_console(void);
 438 int is_fixedsize_console(void);
 439 CharDriverState *text_console_init(QemuOpts *opts);
 440 void text_consoles_set_display(DisplayState *ds);
 441 void console_select(unsigned int index);
 442 void console_color_init(DisplayState *ds);
 443 void qemu_console_resize(DisplayState *ds, int width, int height);
 444 void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
 445                        int dst_x, int dst_y, int w, int h);
 446
 447 /* sdl.c */
 448 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 449
 450 /* cocoa.m */
 451 void cocoa_display_init(DisplayState *ds, int full_screen);
 452
 453 /* vnc.c */
 454 void vnc_display_init(DisplayState *ds);
 455 void vnc_display_close(DisplayState *ds);
 456 void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
 457 void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
 458 int vnc_display_disable_login(DisplayState *ds);
 459 char *vnc_display_local_addr(DisplayState *ds);
 460 #ifdef CONFIG_VNC
 461 int vnc_display_password(DisplayState *ds, const char *password);
 462 int vnc_display_pw_expire(DisplayState *ds, time_t expires);
 463 #else
 464 static inline int vnc_display_password(DisplayState *ds, const char *password)
 465 {
 466     return -ENODEV;
 467 }
 468 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
 469 {
 470     return -ENODEV;
 471 };
 472 #endif
 473
 474 /* curses.c */
 475 void curses_display_init(DisplayState *ds, int full_screen);
 476
 477 /* input.c */
 478 int index_from_key(const char *key);
 479 int index_from_keycode(int code);
 480
 481 #endif