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 do_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_keysym(int keysym);
  87
  88 /* consoles */
  89
  90 #define TYPE_QEMU_CONSOLE "qemu-console"
  91 #define QEMU_CONSOLE(obj) \
  92     OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
  93 #define QEMU_CONSOLE_GET_CLASS(obj) \
  94     OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
  95 #define QEMU_CONSOLE_CLASS(klass) \
  96     OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
  97
  98 typedef struct QemuConsoleClass QemuConsoleClass;
  99
 100 struct QemuConsoleClass {
 101     ObjectClass parent_class;
 102 };
 103
 104 #define QEMU_BIG_ENDIAN_FLAG    0x01
 105 #define QEMU_ALLOCATED_FLAG     0x02
 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     struct PixelFormat pf;
 123 };
 124
 125 typedef struct QemuUIInfo {
 126     /* geometry */
 127     int       xoff;
 128     int       yoff;
 129     uint32_t  width;
 130     uint32_t  height;
 131 } QemuUIInfo;
 132
 133 /* cursor data format is 32bit RGBA */
 134 typedef struct QEMUCursor {
 135     int                 width, height;
 136     int                 hot_x, hot_y;
 137     int                 refcount;
 138     uint32_t            data[];
 139 } QEMUCursor;
 140
 141 QEMUCursor *cursor_alloc(int width, int height);
 142 void cursor_get(QEMUCursor *c);
 143 void cursor_put(QEMUCursor *c);
 144 QEMUCursor *cursor_builtin_hidden(void);
 145 QEMUCursor *cursor_builtin_left_ptr(void);
 146 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
 147 int cursor_get_mono_bpl(QEMUCursor *c);
 148 void cursor_set_mono(QEMUCursor *c,
 149                      uint32_t foreground, uint32_t background, uint8_t *image,
 150                      int transparent, uint8_t *mask);
 151 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
 152 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
 153
 154 typedef struct DisplayChangeListenerOps {
 155     const char *dpy_name;
 156
 157     void (*dpy_refresh)(DisplayChangeListener *dcl);
 158
 159     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
 160                            int x, int y, int w, int h);
 161     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
 162                            struct DisplaySurface *new_surface);
 163     void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
 164                          int src_x, int src_y,
 165                          int dst_x, int dst_y, int w, int h);
 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, int bpp,
 191                                                 int linesize, uint8_t *data,
 192                                                 bool byteswap);
 193 PixelFormat qemu_different_endianness_pixelformat(int bpp);
 194 PixelFormat qemu_default_pixelformat(int bpp);
 195
 196 DisplaySurface *qemu_create_displaysurface(int width, int height);
 197 void qemu_free_displaysurface(DisplaySurface *surface);
 198
 199 static inline int is_surface_bgr(DisplaySurface *surface)
 200 {
 201     if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
 202         return 1;
 203     else
 204         return 0;
 205 }
 206
 207 static inline int is_buffer_shared(DisplaySurface *surface)
 208 {
 209     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 210 }
 211
 212 void register_displaychangelistener(DisplayChangeListener *dcl);
 213 void update_displaychangelistener(DisplayChangeListener *dcl,
 214                                   uint64_t interval);
 215 void unregister_displaychangelistener(DisplayChangeListener *dcl);
 216
 217 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
 218
 219 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
 220 void dpy_gfx_replace_surface(QemuConsole *con,
 221                              DisplaySurface *surface);
 222 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
 223                   int dst_x, int dst_y, int w, int h);
 224 void dpy_text_cursor(QemuConsole *con, int x, int y);
 225 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
 226 void dpy_text_resize(QemuConsole *con, int w, int h);
 227 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
 228 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
 229 bool dpy_cursor_define_supported(QemuConsole *con);
 230
 231 static inline int surface_stride(DisplaySurface *s)
 232 {
 233     return pixman_image_get_stride(s->image);
 234 }
 235
 236 static inline void *surface_data(DisplaySurface *s)
 237 {
 238     return pixman_image_get_data(s->image);
 239 }
 240
 241 static inline int surface_width(DisplaySurface *s)
 242 {
 243     return pixman_image_get_width(s->image);
 244 }
 245
 246 static inline int surface_height(DisplaySurface *s)
 247 {
 248     return pixman_image_get_height(s->image);
 249 }
 250
 251 static inline int surface_bits_per_pixel(DisplaySurface *s)
 252 {
 253     int bits = PIXMAN_FORMAT_BPP(s->format);
 254     return bits;
 255 }
 256
 257 static inline int surface_bytes_per_pixel(DisplaySurface *s)
 258 {
 259     int bits = PIXMAN_FORMAT_BPP(s->format);
 260     return (bits + 7) / 8;
 261 }
 262
 263 #ifdef CONFIG_CURSES
 264 #include <curses.h>
 265 typedef chtype console_ch_t;
 266 #else
 267 typedef unsigned long console_ch_t;
 268 #endif
 269 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 270 {
 271     if (!(ch & 0xff))
 272         ch |= ' ';
 273     *dest = ch;
 274 }
 275
 276 typedef struct GraphicHwOps {
 277     void (*invalidate)(void *opaque);
 278     void (*gfx_update)(void *opaque);
 279     void (*text_update)(void *opaque, console_ch_t *text);
 280     void (*update_interval)(void *opaque, uint64_t interval);
 281     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
 282 } GraphicHwOps;
 283
 284 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
 285                                   const GraphicHwOps *ops,
 286                                   void *opaque);
 287
 288 void graphic_hw_update(QemuConsole *con);
 289 void graphic_hw_invalidate(QemuConsole *con);
 290 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
 291
 292 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
 293 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
 294 bool qemu_console_is_visible(QemuConsole *con);
 295 bool qemu_console_is_graphic(QemuConsole *con);
 296 bool qemu_console_is_fixedsize(QemuConsole *con);
 297 int qemu_console_get_index(QemuConsole *con);
 298 uint32_t qemu_console_get_head(QemuConsole *con);
 299 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
 300 int qemu_console_get_width(QemuConsole *con, int fallback);
 301 int qemu_console_get_height(QemuConsole *con, int fallback);
 302
 303 void text_consoles_set_display(DisplayState *ds);
 304 void console_select(unsigned int index);
 305 void console_color_init(DisplayState *ds);
 306 void qemu_console_resize(QemuConsole *con, int width, int height);
 307 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
 308                        int dst_x, int dst_y, int w, int h);
 309 DisplaySurface *qemu_console_surface(QemuConsole *con);
 310 DisplayState *qemu_console_displaystate(QemuConsole *console);
 311
 312 typedef CharDriverState *(VcHandler)(ChardevVC *vc);
 313
 314 CharDriverState *vc_init(ChardevVC *vc);
 315 void register_vc_handler(VcHandler *handler);
 316
 317 /* sdl.c */
 318 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 319
 320 /* cocoa.m */
 321 void cocoa_display_init(DisplayState *ds, int full_screen);
 322
 323 /* vnc.c */
 324 void vnc_display_init(DisplayState *ds);
 325 void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
 326 void vnc_display_add_client(DisplayState *ds, int csock, bool skipauth);
 327 char *vnc_display_local_addr(DisplayState *ds);
 328 #ifdef CONFIG_VNC
 329 int vnc_display_password(DisplayState *ds, const char *password);
 330 int vnc_display_pw_expire(DisplayState *ds, time_t expires);
 331 #else
 332 static inline int vnc_display_password(DisplayState *ds, const char *password)
 333 {
 334     return -ENODEV;
 335 }
 336 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
 337 {
 338     return -ENODEV;
 339 };
 340 #endif
 341
 342 /* curses.c */
 343 void curses_display_init(DisplayState *ds, int full_screen);
 344
 345 /* input.c */
 346 int index_from_key(const char *key);
 347
 348 /* gtk.c */
 349 void early_gtk_display_init(void);
 350 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
 351
 352 #endif