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
  11 /* keyboard/mouse support */
  12
  13 #define MOUSE_EVENT_LBUTTON 0x01
  14 #define MOUSE_EVENT_RBUTTON 0x02
  15 #define MOUSE_EVENT_MBUTTON 0x04
  16
  17 /* identical to the ps/2 keyboard bits */
  18 #define QEMU_SCROLL_LOCK_LED (1 << 0)
  19 #define QEMU_NUM_LOCK_LED    (1 << 1)
  20 #define QEMU_CAPS_LOCK_LED   (1 << 2)
  21
  22 /* in ms */
  23 #define GUI_REFRESH_INTERVAL 30
  24
  25 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
  26 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
  27 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
  28
  29 typedef struct QEMUPutMouseEntry {
  30     QEMUPutMouseEvent *qemu_put_mouse_event;
  31     void *qemu_put_mouse_event_opaque;
  32     int qemu_put_mouse_event_absolute;
  33     char *qemu_put_mouse_event_name;
  34
  35     int index;
  36
  37     /* used internally by qemu for handling mice */
  38     QTAILQ_ENTRY(QEMUPutMouseEntry) node;
  39 } QEMUPutMouseEntry;
  40
  41 typedef struct QEMUPutLEDEntry {
  42     QEMUPutLEDEvent *put_led;
  43     void *opaque;
  44     QTAILQ_ENTRY(QEMUPutLEDEntry) next;
  45 } QEMUPutLEDEntry;
  46
  47 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
  48 void qemu_remove_kbd_event_handler(void);
  49 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
  50                                                 void *opaque, int absolute,
  51                                                 const char *name);
  52 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
  53 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
  54
  55 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
  56 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
  57
  58 void kbd_put_keycode(int keycode);
  59 void kbd_put_ledstate(int ledstate);
  60 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
  61
  62 /* Does the current mouse generate absolute events */
  63 int kbd_mouse_is_absolute(void);
  64 void qemu_add_mouse_mode_change_notifier(Notifier *notify);
  65 void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
  66
  67 /* Of all the mice, is there one that generates absolute events */
  68 int kbd_mouse_has_absolute(void);
  69
  70 struct MouseTransformInfo {
  71     /* Touchscreen resolution */
  72     int x;
  73     int y;
  74     /* Calibration values as used/generated by tslib */
  75     int a[7];
  76 };
  77
  78 void do_mouse_set(Monitor *mon, const QDict *qdict);
  79
  80 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
  81    constants) */
  82 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
  83 #define QEMU_KEY_BACKSPACE  0x007f
  84 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
  85 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
  86 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
  87 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
  88 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
  89 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
  90 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
  91 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
  92 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
  93
  94 #define QEMU_KEY_CTRL_UP         0xe400
  95 #define QEMU_KEY_CTRL_DOWN       0xe401
  96 #define QEMU_KEY_CTRL_LEFT       0xe402
  97 #define QEMU_KEY_CTRL_RIGHT      0xe403
  98 #define QEMU_KEY_CTRL_HOME       0xe404
  99 #define QEMU_KEY_CTRL_END        0xe405
 100 #define QEMU_KEY_CTRL_PAGEUP     0xe406
 101 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
 102
 103 void kbd_put_keysym(int keysym);
 104
 105 /* consoles */
 106
 107 #define QEMU_BIG_ENDIAN_FLAG    0x01
 108 #define QEMU_ALLOCATED_FLAG     0x02
 109 #define QEMU_REALPIXELS_FLAG    0x04
 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_update)(struct DisplayState *s, int x, int y, int w, int h);
 157     void (*dpy_resize)(struct DisplayState *s);
 158     void (*dpy_setdata)(struct DisplayState *s);
 159     void (*dpy_refresh)(struct DisplayState *s);
 160     void (*dpy_copy)(struct DisplayState *s, int src_x, int src_y,
 161                      int dst_x, int dst_y, int w, int h);
 162     void (*dpy_fill)(struct DisplayState *s, int x, int y,
 163                      int w, int h, uint32_t c);
 164     void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
 165
 166     struct DisplayChangeListener *next;
 167 };
 168
 169 struct DisplayAllocator {
 170     DisplaySurface* (*create_displaysurface)(int width, int height);
 171     DisplaySurface* (*resize_displaysurface)(DisplaySurface *surface, int width, int height);
 172     void (*free_displaysurface)(DisplaySurface *surface);
 173 };
 174
 175 struct DisplayState {
 176     struct DisplaySurface *surface;
 177     void *opaque;
 178     struct QEMUTimer *gui_timer;
 179
 180     struct DisplayAllocator* allocator;
 181     struct DisplayChangeListener* listeners;
 182
 183     void (*mouse_set)(int x, int y, int on);
 184     void (*cursor_define)(QEMUCursor *cursor);
 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 DisplayAllocator *register_displayallocator(DisplayState *ds, DisplayAllocator *da);
 199
 200 static inline DisplaySurface* qemu_create_displaysurface(DisplayState *ds, int width, int height)
 201 {
 202     return ds->allocator->create_displaysurface(width, height);
 203 }
 204
 205 static inline DisplaySurface* qemu_resize_displaysurface(DisplayState *ds, int width, int height)
 206 {
 207     trace_displaysurface_resize(ds, ds->surface, width, height);
 208     return ds->allocator->resize_displaysurface(ds->surface, width, height);
 209 }
 210
 211 static inline void qemu_free_displaysurface(DisplayState *ds)
 212 {
 213     trace_displaysurface_free(ds, ds->surface);
 214     ds->allocator->free_displaysurface(ds->surface);
 215 }
 216
 217 static inline int is_surface_bgr(DisplaySurface *surface)
 218 {
 219     if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
 220         return 1;
 221     else
 222         return 0;
 223 }
 224
 225 static inline int is_buffer_shared(DisplaySurface *surface)
 226 {
 227     return (!(surface->flags & QEMU_ALLOCATED_FLAG) &&
 228             !(surface->flags & QEMU_REALPIXELS_FLAG));
 229 }
 230
 231 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 232 {
 233     dcl->next = ds->listeners;
 234     ds->listeners = dcl;
 235 }
 236
 237 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
 238 {
 239     struct DisplayChangeListener *dcl = s->listeners;
 240     while (dcl != NULL) {
 241         dcl->dpy_update(s, x, y, w, h);
 242         dcl = dcl->next;
 243     }
 244 }
 245
 246 static inline void dpy_resize(DisplayState *s)
 247 {
 248     struct DisplayChangeListener *dcl = s->listeners;
 249     while (dcl != NULL) {
 250         dcl->dpy_resize(s);
 251         dcl = dcl->next;
 252     }
 253 }
 254
 255 static inline void dpy_setdata(DisplayState *s)
 256 {
 257     struct DisplayChangeListener *dcl = s->listeners;
 258     while (dcl != NULL) {
 259         if (dcl->dpy_setdata) dcl->dpy_setdata(s);
 260         dcl = dcl->next;
 261     }
 262 }
 263
 264 static inline void dpy_refresh(DisplayState *s)
 265 {
 266     struct DisplayChangeListener *dcl = s->listeners;
 267     while (dcl != NULL) {
 268         if (dcl->dpy_refresh) dcl->dpy_refresh(s);
 269         dcl = dcl->next;
 270     }
 271 }
 272
 273 static inline void dpy_copy(struct DisplayState *s, int src_x, int src_y,
 274                              int dst_x, int dst_y, int w, int h) {
 275     struct DisplayChangeListener *dcl = s->listeners;
 276     while (dcl != NULL) {
 277         if (dcl->dpy_copy)
 278             dcl->dpy_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 279         else /* TODO */
 280             dcl->dpy_update(s, dst_x, dst_y, w, h);
 281         dcl = dcl->next;
 282     }
 283 }
 284
 285 static inline void dpy_fill(struct DisplayState *s, int x, int y,
 286                              int w, int h, uint32_t c) {
 287     struct DisplayChangeListener *dcl = s->listeners;
 288     while (dcl != NULL) {
 289         if (dcl->dpy_fill) dcl->dpy_fill(s, x, y, w, h, c);
 290         dcl = dcl->next;
 291     }
 292 }
 293
 294 static inline void dpy_cursor(struct DisplayState *s, int x, int y) {
 295     struct DisplayChangeListener *dcl = s->listeners;
 296     while (dcl != NULL) {
 297         if (dcl->dpy_text_cursor) dcl->dpy_text_cursor(s, x, y);
 298         dcl = dcl->next;
 299     }
 300 }
 301
 302 static inline int ds_get_linesize(DisplayState *ds)
 303 {
 304     return ds->surface->linesize;
 305 }
 306
 307 static inline uint8_t* ds_get_data(DisplayState *ds)
 308 {
 309     return ds->surface->data;
 310 }
 311
 312 static inline int ds_get_width(DisplayState *ds)
 313 {
 314     return ds->surface->width;
 315 }
 316
 317 static inline int ds_get_height(DisplayState *ds)
 318 {
 319     return ds->surface->height;
 320 }
 321
 322 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 323 {
 324     return ds->surface->pf.bits_per_pixel;
 325 }
 326
 327 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 328 {
 329     return ds->surface->pf.bytes_per_pixel;
 330 }
 331
 332 #ifdef CONFIG_CURSES
 333 #include <curses.h>
 334 typedef chtype console_ch_t;
 335 #else
 336 typedef unsigned long console_ch_t;
 337 #endif
 338 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 339 {
 340     if (!(ch & 0xff))
 341         ch |= ' ';
 342     *dest = ch;
 343 }
 344
 345 typedef void (*vga_hw_update_ptr)(void *);
 346 typedef void (*vga_hw_invalidate_ptr)(void *);
 347 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch);
 348 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 349
 350 DisplayState *graphic_console_init(vga_hw_update_ptr update,
 351                                    vga_hw_invalidate_ptr invalidate,
 352                                    vga_hw_screen_dump_ptr screen_dump,
 353                                    vga_hw_text_update_ptr text_update,
 354                                    void *opaque);
 355
 356 void vga_hw_update(void);
 357 void vga_hw_invalidate(void);
 358 void vga_hw_screen_dump(const char *filename);
 359 void vga_hw_text_update(console_ch_t *chardata);
 360
 361 int is_graphic_console(void);
 362 int is_fixedsize_console(void);
 363 CharDriverState *text_console_init(QemuOpts *opts);
 364 void text_consoles_set_display(DisplayState *ds);
 365 void console_select(unsigned int index);
 366 void console_color_init(DisplayState *ds);
 367 void qemu_console_resize(DisplayState *ds, int width, int height);
 368 void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
 369                        int dst_x, int dst_y, int w, int h);
 370
 371 /* sdl.c */
 372 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 373
 374 /* cocoa.m */
 375 void cocoa_display_init(DisplayState *ds, int full_screen);
 376
 377 /* vnc.c */
 378 void vnc_display_init(DisplayState *ds);
 379 void vnc_display_close(DisplayState *ds);
 380 int vnc_display_open(DisplayState *ds, const char *display);
 381 void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
 382 int vnc_display_disable_login(DisplayState *ds);
 383 char *vnc_display_local_addr(DisplayState *ds);
 384 #ifdef CONFIG_VNC
 385 int vnc_display_password(DisplayState *ds, const char *password);
 386 int vnc_display_pw_expire(DisplayState *ds, time_t expires);
 387 #else
 388 static inline int vnc_display_password(DisplayState *ds, const char *password)
 389 {
 390     return -ENODEV;
 391 }
 392 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
 393 {
 394     return -ENODEV;
 395 };
 396 #endif
 397
 398 /* curses.c */
 399 void curses_display_init(DisplayState *ds, int full_screen);
 400
 401 /* input.c */
 402 extern const int key_defs[];
 403 int index_from_key(const char *key);
 404 int index_from_keycode(int code);
 405
 406 #endif