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