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