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
   8 /* keyboard/mouse support */
   9
  10 #define MOUSE_EVENT_LBUTTON 0x01
  11 #define MOUSE_EVENT_RBUTTON 0x02
  12 #define MOUSE_EVENT_MBUTTON 0x04
  13
  14 /* identical to the ps/2 keyboard bits */
  15 #define QEMU_SCROLL_LOCK_LED (1 << 0)
  16 #define QEMU_NUM_LOCK_LED    (1 << 1)
  17 #define QEMU_CAPS_LOCK_LED   (1 << 2)
  18
  19 /* in ms */
  20 #define GUI_REFRESH_INTERVAL 30
  21
  22 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
  23 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
  24 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
  25
  26 typedef struct QEMUPutMouseEntry {
  27     QEMUPutMouseEvent *qemu_put_mouse_event;
  28     void *qemu_put_mouse_event_opaque;
  29     int qemu_put_mouse_event_absolute;
  30     char *qemu_put_mouse_event_name;
  31
  32     int index;
  33
  34     /* used internally by qemu for handling mice */
  35     QTAILQ_ENTRY(QEMUPutMouseEntry) node;
  36 } QEMUPutMouseEntry;
  37
  38 typedef struct QEMUPutLEDEntry {
  39     QEMUPutLEDEvent *put_led;
  40     void *opaque;
  41     QTAILQ_ENTRY(QEMUPutLEDEntry) next;
  42 } QEMUPutLEDEntry;
  43
  44 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
  45 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
  46                                                 void *opaque, int absolute,
  47                                                 const char *name);
  48 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
  49 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
  50
  51 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
  52 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
  53
  54 void kbd_put_keycode(int keycode);
  55 void kbd_put_ledstate(int ledstate);
  56 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
  57
  58 /* Does the current mouse generate absolute events */
  59 int kbd_mouse_is_absolute(void);
  60 void qemu_add_mouse_mode_change_notifier(Notifier *notify);
  61 void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
  62
  63 /* Of all the mice, is there one that generates absolute events */
  64 int kbd_mouse_has_absolute(void);
  65
  66 struct MouseTransformInfo {
  67     /* Touchscreen resolution */
  68     int x;
  69     int y;
  70     /* Calibration values as used/generated by tslib */
  71     int a[7];
  72 };
  73
  74 void do_info_mice_print(Monitor *mon, const QObject *data);
  75 void do_info_mice(Monitor *mon, QObject **ret_data);
  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 PixelFormat qemu_different_endianness_pixelformat(int bpp);
 192 PixelFormat qemu_default_pixelformat(int bpp);
 193
 194 DisplayAllocator *register_displayallocator(DisplayState *ds, DisplayAllocator *da);
 195
 196 static inline DisplaySurface* qemu_create_displaysurface(DisplayState *ds, int width, int height)
 197 {
 198     return ds->allocator->create_displaysurface(width, height);
 199 }
 200
 201 static inline DisplaySurface* qemu_resize_displaysurface(DisplayState *ds, int width, int height)
 202 {
 203     return ds->allocator->resize_displaysurface(ds->surface, width, height);
 204 }
 205
 206 static inline void qemu_free_displaysurface(DisplayState *ds)
 207 {
 208     ds->allocator->free_displaysurface(ds->surface);
 209 }
 210
 211 static inline int is_surface_bgr(DisplaySurface *surface)
 212 {
 213     if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
 214         return 1;
 215     else
 216         return 0;
 217 }
 218
 219 static inline int is_buffer_shared(DisplaySurface *surface)
 220 {
 221     return (!(surface->flags & QEMU_ALLOCATED_FLAG) &&
 222             !(surface->flags & QEMU_REALPIXELS_FLAG));
 223 }
 224
 225 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 226 {
 227     dcl->next = ds->listeners;
 228     ds->listeners = dcl;
 229 }
 230
 231 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
 232 {
 233     struct DisplayChangeListener *dcl = s->listeners;
 234     while (dcl != NULL) {
 235         dcl->dpy_update(s, x, y, w, h);
 236         dcl = dcl->next;
 237     }
 238 }
 239
 240 static inline void dpy_resize(DisplayState *s)
 241 {
 242     struct DisplayChangeListener *dcl = s->listeners;
 243     while (dcl != NULL) {
 244         dcl->dpy_resize(s);
 245         dcl = dcl->next;
 246     }
 247 }
 248
 249 static inline void dpy_setdata(DisplayState *s)
 250 {
 251     struct DisplayChangeListener *dcl = s->listeners;
 252     while (dcl != NULL) {
 253         if (dcl->dpy_setdata) dcl->dpy_setdata(s);
 254         dcl = dcl->next;
 255     }
 256 }
 257
 258 static inline void dpy_refresh(DisplayState *s)
 259 {
 260     struct DisplayChangeListener *dcl = s->listeners;
 261     while (dcl != NULL) {
 262         if (dcl->dpy_refresh) dcl->dpy_refresh(s);
 263         dcl = dcl->next;
 264     }
 265 }
 266
 267 static inline void dpy_copy(struct DisplayState *s, int src_x, int src_y,
 268                              int dst_x, int dst_y, int w, int h) {
 269     struct DisplayChangeListener *dcl = s->listeners;
 270     while (dcl != NULL) {
 271         if (dcl->dpy_copy)
 272             dcl->dpy_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 273         else /* TODO */
 274             dcl->dpy_update(s, dst_x, dst_y, w, h);
 275         dcl = dcl->next;
 276     }
 277 }
 278
 279 static inline void dpy_fill(struct DisplayState *s, int x, int y,
 280                              int w, int h, uint32_t c) {
 281     struct DisplayChangeListener *dcl = s->listeners;
 282     while (dcl != NULL) {
 283         if (dcl->dpy_fill) dcl->dpy_fill(s, x, y, w, h, c);
 284         dcl = dcl->next;
 285     }
 286 }
 287
 288 static inline void dpy_cursor(struct DisplayState *s, int x, int y) {
 289     struct DisplayChangeListener *dcl = s->listeners;
 290     while (dcl != NULL) {
 291         if (dcl->dpy_text_cursor) dcl->dpy_text_cursor(s, x, y);
 292         dcl = dcl->next;
 293     }
 294 }
 295
 296 static inline int ds_get_linesize(DisplayState *ds)
 297 {
 298     return ds->surface->linesize;
 299 }
 300
 301 static inline uint8_t* ds_get_data(DisplayState *ds)
 302 {
 303     return ds->surface->data;
 304 }
 305
 306 static inline int ds_get_width(DisplayState *ds)
 307 {
 308     return ds->surface->width;
 309 }
 310
 311 static inline int ds_get_height(DisplayState *ds)
 312 {
 313     return ds->surface->height;
 314 }
 315
 316 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 317 {
 318     return ds->surface->pf.bits_per_pixel;
 319 }
 320
 321 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 322 {
 323     return ds->surface->pf.bytes_per_pixel;
 324 }
 325
 326 typedef unsigned long console_ch_t;
 327 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 328 {
 329     if (!(ch & 0xff))
 330         ch |= ' ';
 331     cpu_to_le32wu((uint32_t *) dest, ch);
 332 }
 333
 334 typedef void (*vga_hw_update_ptr)(void *);
 335 typedef void (*vga_hw_invalidate_ptr)(void *);
 336 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *);
 337 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 338
 339 DisplayState *graphic_console_init(vga_hw_update_ptr update,
 340                                    vga_hw_invalidate_ptr invalidate,
 341                                    vga_hw_screen_dump_ptr screen_dump,
 342                                    vga_hw_text_update_ptr text_update,
 343                                    void *opaque);
 344
 345 void vga_hw_update(void);
 346 void vga_hw_invalidate(void);
 347 void vga_hw_screen_dump(const char *filename);
 348 void vga_hw_text_update(console_ch_t *chardata);
 349
 350 int is_graphic_console(void);
 351 int is_fixedsize_console(void);
 352 CharDriverState *text_console_init(QemuOpts *opts);
 353 void text_consoles_set_display(DisplayState *ds);
 354 void console_select(unsigned int index);
 355 void console_color_init(DisplayState *ds);
 356 void qemu_console_resize(DisplayState *ds, int width, int height);
 357 void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
 358                        int dst_x, int dst_y, int w, int h);
 359
 360 /* sdl.c */
 361 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 362
 363 /* cocoa.m */
 364 void cocoa_display_init(DisplayState *ds, int full_screen);
 365
 366 /* vnc.c */
 367 void vnc_display_init(DisplayState *ds);
 368 void vnc_display_close(DisplayState *ds);
 369 int vnc_display_open(DisplayState *ds, const char *display);
 370 int vnc_display_password(DisplayState *ds, const char *password);
 371 void do_info_vnc_print(Monitor *mon, const QObject *data);
 372 void do_info_vnc(Monitor *mon, QObject **ret_data);
 373 char *vnc_display_local_addr(DisplayState *ds);
 374
 375 /* curses.c */
 376 void curses_display_init(DisplayState *ds, int full_screen);
 377
 378 #endif