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