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