include/ui/console.h

   1 #ifndef CONSOLE_H
   2 #define CONSOLE_H
   3
   4 #include "ui/qemu-pixman.h"
   5 #include "qom/object.h"
   6 #include "qapi/qmp/qdict.h"
   7 #include "qemu/notify.h"
   8 #include "monitor/monitor.h"
   9 #include "qapi-types.h"
  10 #include "qapi/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 #define MOUSE_EVENT_WHEELUP 0x08
  18 #define MOUSE_EVENT_WHEELDN 0x10
  19
  20 /* identical to the ps/2 keyboard bits */
  21 #define QEMU_SCROLL_LOCK_LED (1 << 0)
  22 #define QEMU_NUM_LOCK_LED    (1 << 1)
  23 #define QEMU_CAPS_LOCK_LED   (1 << 2)
  24
  25 /* in ms */
  26 #define GUI_REFRESH_INTERVAL_DEFAULT    30
  27 #define GUI_REFRESH_INTERVAL_IDLE     3000
  28
  29 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
  30 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
  31 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
  32
  33 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
  34 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
  35 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
  36
  37 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
  38                                             void *opaque);
  39 void qemu_remove_kbd_event_handler(QEMUPutKbdEntry *entry);
  40 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
  41                                                 void *opaque, int absolute,
  42                                                 const char *name);
  43 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
  44 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
  45
  46 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
  47 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
  48
  49 void kbd_put_ledstate(int ledstate);
  50
  51 struct MouseTransformInfo {
  52     /* Touchscreen resolution */
  53     int x;
  54     int y;
  55     /* Calibration values as used/generated by tslib */
  56     int a[7];
  57 };
  58
  59 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
  60
  61 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
  62    constants) */
  63 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
  64 #define QEMU_KEY_BACKSPACE  0x007f
  65 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
  66 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
  67 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
  68 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
  69 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
  70 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
  71 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
  72 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
  73 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
  74
  75 #define QEMU_KEY_CTRL_UP         0xe400
  76 #define QEMU_KEY_CTRL_DOWN       0xe401
  77 #define QEMU_KEY_CTRL_LEFT       0xe402
  78 #define QEMU_KEY_CTRL_RIGHT      0xe403
  79 #define QEMU_KEY_CTRL_HOME       0xe404
  80 #define QEMU_KEY_CTRL_END        0xe405
  81 #define QEMU_KEY_CTRL_PAGEUP     0xe406
  82 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
  83
  84 void kbd_put_keysym_console(QemuConsole *s, int keysym);
  85 bool kbd_put_qcode_console(QemuConsole *s, int qcode);
  86 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
  87 void kbd_put_keysym(int keysym);
  88
  89 /* consoles */
  90
  91 #define TYPE_QEMU_CONSOLE "qemu-console"
  92 #define QEMU_CONSOLE(obj) \
  93     OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
  94 #define QEMU_CONSOLE_GET_CLASS(obj) \
  95     OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
  96 #define QEMU_CONSOLE_CLASS(klass) \
  97     OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
  98
  99 typedef struct QemuConsoleClass QemuConsoleClass;
 100
 101 struct QemuConsoleClass {
 102     ObjectClass parent_class;
 103 };
 104
 105 #define QEMU_ALLOCATED_FLAG     0x01
 106
 107 struct PixelFormat {
 108     uint8_t bits_per_pixel;
 109     uint8_t bytes_per_pixel;
 110     uint8_t depth; /* color depth in bits */
 111     uint32_t rmask, gmask, bmask, amask;
 112     uint8_t rshift, gshift, bshift, ashift;
 113     uint8_t rmax, gmax, bmax, amax;
 114     uint8_t rbits, gbits, bbits, abits;
 115 };
 116
 117 struct DisplaySurface {
 118     pixman_format_code_t format;
 119     pixman_image_t *image;
 120     uint8_t flags;
 121 };
 122
 123 typedef struct QemuUIInfo {
 124     /* geometry */
 125     int       xoff;
 126     int       yoff;
 127     uint32_t  width;
 128     uint32_t  height;
 129 } QemuUIInfo;
 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 typedef struct DisplayChangeListenerOps {
 153     const char *dpy_name;
 154
 155     void (*dpy_refresh)(DisplayChangeListener *dcl);
 156
 157     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
 158                            int x, int y, int w, int h);
 159     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
 160                            struct DisplaySurface *new_surface);
 161     void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
 162                          int src_x, int src_y,
 163                          int dst_x, int dst_y, int w, int h);
 164     bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
 165                                  pixman_format_code_t format);
 166
 167     void (*dpy_text_cursor)(DisplayChangeListener *dcl,
 168                             int x, int y);
 169     void (*dpy_text_resize)(DisplayChangeListener *dcl,
 170                             int w, int h);
 171     void (*dpy_text_update)(DisplayChangeListener *dcl,
 172                             int x, int y, int w, int h);
 173
 174     void (*dpy_mouse_set)(DisplayChangeListener *dcl,
 175                           int x, int y, int on);
 176     void (*dpy_cursor_define)(DisplayChangeListener *dcl,
 177                               QEMUCursor *cursor);
 178 } DisplayChangeListenerOps;
 179
 180 struct DisplayChangeListener {
 181     uint64_t update_interval;
 182     const DisplayChangeListenerOps *ops;
 183     DisplayState *ds;
 184     QemuConsole *con;
 185
 186     QLIST_ENTRY(DisplayChangeListener) next;
 187 };
 188
 189 DisplayState *init_displaystate(void);
 190 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
 191                                                 pixman_format_code_t format,
 192                                                 int linesize, uint8_t *data);
 193 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
 194                                                     pixman_format_code_t format,
 195                                                     int linesize,
 196                                                     uint64_t addr);
 197 PixelFormat qemu_different_endianness_pixelformat(int bpp);
 198 PixelFormat qemu_default_pixelformat(int bpp);
 199
 200 DisplaySurface *qemu_create_displaysurface(int width, int height);
 201 void qemu_free_displaysurface(DisplaySurface *surface);
 202
 203 static inline int is_surface_bgr(DisplaySurface *surface)
 204 {
 205     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
 206         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
 207         return 1;
 208     } else {
 209         return 0;
 210     }
 211 }
 212
 213 static inline int is_buffer_shared(DisplaySurface *surface)
 214 {
 215     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 216 }
 217
 218 void register_displaychangelistener(DisplayChangeListener *dcl);
 219 void update_displaychangelistener(DisplayChangeListener *dcl,
 220                                   uint64_t interval);
 221 void unregister_displaychangelistener(DisplayChangeListener *dcl);
 222
 223 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
 224
 225 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
 226 void dpy_gfx_replace_surface(QemuConsole *con,
 227                              DisplaySurface *surface);
 228 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
 229                   int dst_x, int dst_y, int w, int h);
 230 void dpy_text_cursor(QemuConsole *con, int x, int y);
 231 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
 232 void dpy_text_resize(QemuConsole *con, int w, int h);
 233 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
 234 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
 235 bool dpy_cursor_define_supported(QemuConsole *con);
 236 void dpy_gfx_update_dirty(QemuConsole *con,
 237                           MemoryRegion *address_space,
 238                           uint64_t base,
 239                           bool invalidate);
 240 bool dpy_gfx_check_format(QemuConsole *con,
 241                           pixman_format_code_t format);
 242
 243 static inline int surface_stride(DisplaySurface *s)
 244 {
 245     return pixman_image_get_stride(s->image);
 246 }
 247
 248 static inline void *surface_data(DisplaySurface *s)
 249 {
 250     return pixman_image_get_data(s->image);
 251 }
 252
 253 static inline int surface_width(DisplaySurface *s)
 254 {
 255     return pixman_image_get_width(s->image);
 256 }
 257
 258 static inline int surface_height(DisplaySurface *s)
 259 {
 260     return pixman_image_get_height(s->image);
 261 }
 262
 263 static inline int surface_bits_per_pixel(DisplaySurface *s)
 264 {
 265     int bits = PIXMAN_FORMAT_BPP(s->format);
 266     return bits;
 267 }
 268
 269 static inline int surface_bytes_per_pixel(DisplaySurface *s)
 270 {
 271     int bits = PIXMAN_FORMAT_BPP(s->format);
 272     return (bits + 7) / 8;
 273 }
 274
 275 #ifdef CONFIG_CURSES
 276 #include <curses.h>
 277 typedef chtype console_ch_t;
 278 #else
 279 typedef unsigned long console_ch_t;
 280 #endif
 281 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 282 {
 283     if (!(ch & 0xff))
 284         ch |= ' ';
 285     *dest = ch;
 286 }
 287
 288 typedef struct GraphicHwOps {
 289     void (*invalidate)(void *opaque);
 290     void (*gfx_update)(void *opaque);
 291     void (*text_update)(void *opaque, console_ch_t *text);
 292     void (*update_interval)(void *opaque, uint64_t interval);
 293     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
 294 } GraphicHwOps;
 295
 296 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
 297                                   const GraphicHwOps *ops,
 298                                   void *opaque);
 299 void graphic_console_set_hwops(QemuConsole *con,
 300                                const GraphicHwOps *hw_ops,
 301                                void *opaque);
 302
 303 void graphic_hw_update(QemuConsole *con);
 304 void graphic_hw_invalidate(QemuConsole *con);
 305 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
 306
 307 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
 308 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
 309 bool qemu_console_is_visible(QemuConsole *con);
 310 bool qemu_console_is_graphic(QemuConsole *con);
 311 bool qemu_console_is_fixedsize(QemuConsole *con);
 312 int qemu_console_get_index(QemuConsole *con);
 313 uint32_t qemu_console_get_head(QemuConsole *con);
 314 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
 315 int qemu_console_get_width(QemuConsole *con, int fallback);
 316 int qemu_console_get_height(QemuConsole *con, int fallback);
 317
 318 void text_consoles_set_display(DisplayState *ds);
 319 void console_select(unsigned int index);
 320 void console_color_init(DisplayState *ds);
 321 void qemu_console_resize(QemuConsole *con, int width, int height);
 322 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
 323                        int dst_x, int dst_y, int w, int h);
 324 DisplaySurface *qemu_console_surface(QemuConsole *con);
 325 DisplayState *qemu_console_displaystate(QemuConsole *console);
 326
 327 /* sdl.c */
 328 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 329
 330 /* cocoa.m */
 331 void cocoa_display_init(DisplayState *ds, int full_screen);
 332
 333 /* vnc.c */
 334 void vnc_display_init(const char *id);
 335 void vnc_display_open(const char *id, Error **errp);
 336 void vnc_display_add_client(const char *id, int csock, bool skipauth);
 337 char *vnc_display_local_addr(const char *id);
 338 void vnc_auto_assign_id(QemuOptsList *olist, QemuOpts *opts);
 339 #ifdef CONFIG_VNC
 340 int vnc_display_password(const char *id, const char *password);
 341 int vnc_display_pw_expire(const char *id, time_t expires);
 342 QemuOpts *vnc_parse_func(const char *str);
 343 int vnc_init_func(QemuOpts *opts, void *opaque);
 344 #else
 345 static inline int vnc_display_password(const char *id, const char *password)
 346 {
 347     return -ENODEV;
 348 }
 349 static inline int vnc_display_pw_expire(const char *id, time_t expires)
 350 {
 351     return -ENODEV;
 352 };
 353 #endif
 354
 355 /* curses.c */
 356 void curses_display_init(DisplayState *ds, int full_screen);
 357
 358 /* input.c */
 359 int index_from_key(const char *key);
 360
 361 /* gtk.c */
 362 void early_gtk_display_init(void);
 363 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
 364
 365 #endif