[mirror_qemu.git] / include / ui / console.h

#ifndef CONSOLE_H
#define CONSOLE_H

#include "ui/qemu-pixman.h"
#include "qom/object.h"
#include "qapi/qmp/qdict.h"
#include "qemu/notify.h"
#include "qemu/typedefs.h"
#include "qapi-types.h"
#include "qemu/error-report.h"
#include "qapi/error.h"

#ifdef CONFIG_OPENGL
# include <epoxy/gl.h>
# include "ui/shader.h"
#endif

/* keyboard/mouse support */

#define MOUSE_EVENT_LBUTTON 0x01
#define MOUSE_EVENT_RBUTTON 0x02
#define MOUSE_EVENT_MBUTTON 0x04
#define MOUSE_EVENT_WHEELUP 0x08
#define MOUSE_EVENT_WHEELDN 0x10

/* identical to the ps/2 keyboard bits */
#define QEMU_SCROLL_LOCK_LED (1 << 0)
#define QEMU_NUM_LOCK_LED    (1 << 1)
#define QEMU_CAPS_LOCK_LED   (1 << 2)

/* in ms */
#define GUI_REFRESH_INTERVAL_DEFAULT    30
#define GUI_REFRESH_INTERVAL_IDLE     3000

/* Color number is match to standard vga palette */
enum qemu_color_names {
    QEMU_COLOR_BLACK   = 0,
    QEMU_COLOR_BLUE    = 1,
    QEMU_COLOR_GREEN   = 2,
    QEMU_COLOR_CYAN    = 3,
    QEMU_COLOR_RED     = 4,
    QEMU_COLOR_MAGENTA = 5,
    QEMU_COLOR_YELLOW  = 6,
    QEMU_COLOR_WHITE   = 7
};
/* Convert to curses char attributes */
#define ATTR2CHTYPE(c, fg, bg, bold) \
    ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))

typedef void QEMUPutKBDEvent(void *opaque, int keycode);
typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);

typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;

QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
                                            void *opaque);
QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
                                                void *opaque, int absolute,
                                                const char *name);
void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);

QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);

void kbd_put_ledstate(int ledstate);

struct MouseTransformInfo {
    /* Touchscreen resolution */
    int x;
    int y;
    /* Calibration values as used/generated by tslib */
    int a[7];
};

void hmp_mouse_set(Monitor *mon, const QDict *qdict);

/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
   constants) */
#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
#define QEMU_KEY_BACKSPACE  0x007f
#define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
#define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
#define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
#define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
#define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
#define QEMU_KEY_END        QEMU_KEY_ESC1(4)
#define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
#define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
#define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)

#define QEMU_KEY_CTRL_UP         0xe400
#define QEMU_KEY_CTRL_DOWN       0xe401
#define QEMU_KEY_CTRL_LEFT       0xe402
#define QEMU_KEY_CTRL_RIGHT      0xe403
#define QEMU_KEY_CTRL_HOME       0xe404
#define QEMU_KEY_CTRL_END        0xe405
#define QEMU_KEY_CTRL_PAGEUP     0xe406
#define QEMU_KEY_CTRL_PAGEDOWN   0xe407

void kbd_put_keysym_console(QemuConsole *s, int keysym);
bool kbd_put_qcode_console(QemuConsole *s, int qcode);
void kbd_put_string_console(QemuConsole *s, const char *str, int len);
void kbd_put_keysym(int keysym);

/* consoles */

#define TYPE_QEMU_CONSOLE "qemu-console"
#define QEMU_CONSOLE(obj) \
    OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
#define QEMU_CONSOLE_GET_CLASS(obj) \
    OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
#define QEMU_CONSOLE_CLASS(klass) \
    OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)

typedef struct QemuConsoleClass QemuConsoleClass;

struct QemuConsoleClass {
    ObjectClass parent_class;
};

#define QEMU_ALLOCATED_FLAG     0x01

struct PixelFormat {
    uint8_t bits_per_pixel;
    uint8_t bytes_per_pixel;
    uint8_t depth; /* color depth in bits */
    uint32_t rmask, gmask, bmask, amask;
    uint8_t rshift, gshift, bshift, ashift;
    uint8_t rmax, gmax, bmax, amax;
    uint8_t rbits, gbits, bbits, abits;
};

struct DisplaySurface {
    pixman_format_code_t format;
    pixman_image_t *image;
    uint8_t flags;
#ifdef CONFIG_OPENGL
    GLenum glformat;
    GLenum gltype;
    GLuint texture;
#endif
};

typedef struct QemuUIInfo {
    /* geometry */
    int       xoff;
    int       yoff;
    uint32_t  width;
    uint32_t  height;
} QemuUIInfo;

/* cursor data format is 32bit RGBA */
typedef struct QEMUCursor {
    int                 width, height;
    int                 hot_x, hot_y;
    int                 refcount;
    uint32_t            data[];
} QEMUCursor;

QEMUCursor *cursor_alloc(int width, int height);
void cursor_get(QEMUCursor *c);
void cursor_put(QEMUCursor *c);
QEMUCursor *cursor_builtin_hidden(void);
QEMUCursor *cursor_builtin_left_ptr(void);
void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
int cursor_get_mono_bpl(QEMUCursor *c);
void cursor_set_mono(QEMUCursor *c,
                     uint32_t foreground, uint32_t background, uint8_t *image,
                     int transparent, uint8_t *mask);
void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);

typedef void *QEMUGLContext;
typedef struct QEMUGLParams QEMUGLParams;

struct QEMUGLParams {
    int major_ver;
    int minor_ver;
};

struct QemuDmaBuf {
    int       fd;
    uint32_t  width;
    uint32_t  height;
    uint32_t  stride;
    uint32_t  fourcc;
    uint32_t  texture;
};

typedef struct DisplayChangeListenerOps {
    const char *dpy_name;

    void (*dpy_refresh)(DisplayChangeListener *dcl);

    void (*dpy_gfx_update)(DisplayChangeListener *dcl,
                           int x, int y, int w, int h);
    void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
                           struct DisplaySurface *new_surface);
    bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
                                 pixman_format_code_t format);

    void (*dpy_text_cursor)(DisplayChangeListener *dcl,
                            int x, int y);
    void (*dpy_text_resize)(DisplayChangeListener *dcl,
                            int w, int h);
    void (*dpy_text_update)(DisplayChangeListener *dcl,
                            int x, int y, int w, int h);

    void (*dpy_mouse_set)(DisplayChangeListener *dcl,
                          int x, int y, int on);
    void (*dpy_cursor_define)(DisplayChangeListener *dcl,
                              QEMUCursor *cursor);

    QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
                                       QEMUGLParams *params);
    void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
                               QEMUGLContext ctx);
    int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
                                   QEMUGLContext ctx);
    QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);

    void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
    void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
                                   uint32_t backing_id,
                                   bool backing_y_0_top,
                                   uint32_t backing_width,
                                   uint32_t backing_height,
                                   uint32_t x, uint32_t y,
                                   uint32_t w, uint32_t h);
    void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
                                  QemuDmaBuf *dmabuf);
    void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
                                 QemuDmaBuf *dmabuf,
                                 uint32_t pos_x, uint32_t pos_y);
    void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
                                  QemuDmaBuf *dmabuf);
    void (*dpy_gl_update)(DisplayChangeListener *dcl,
                          uint32_t x, uint32_t y, uint32_t w, uint32_t h);

} DisplayChangeListenerOps;

struct DisplayChangeListener {
    uint64_t update_interval;
    const DisplayChangeListenerOps *ops;
    DisplayState *ds;
    QemuConsole *con;

    QLIST_ENTRY(DisplayChangeListener) next;
};

DisplayState *init_displaystate(void);
DisplaySurface *qemu_create_displaysurface_from(int width, int height,
                                                pixman_format_code_t format,
                                                int linesize, uint8_t *data);
DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
                                                    pixman_format_code_t format,
                                                    int linesize,
                                                    uint64_t addr);
PixelFormat qemu_default_pixelformat(int bpp);

DisplaySurface *qemu_create_displaysurface(int width, int height);
void qemu_free_displaysurface(DisplaySurface *surface);

static inline int is_surface_bgr(DisplaySurface *surface)
{
    if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
        PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
        return 1;
    } else {
        return 0;
    }
}

static inline int is_buffer_shared(DisplaySurface *surface)
{
    return !(surface->flags & QEMU_ALLOCATED_FLAG);
}

void register_displaychangelistener(DisplayChangeListener *dcl);
void update_displaychangelistener(DisplayChangeListener *dcl,
                                  uint64_t interval);
void unregister_displaychangelistener(DisplayChangeListener *dcl);

bool dpy_ui_info_supported(QemuConsole *con);
int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);

void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
void dpy_gfx_replace_surface(QemuConsole *con,
                             DisplaySurface *surface);
void dpy_text_cursor(QemuConsole *con, int x, int y);
void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
void dpy_text_resize(QemuConsole *con, int w, int h);
void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
bool dpy_cursor_define_supported(QemuConsole *con);
bool dpy_gfx_check_format(QemuConsole *con,
                          pixman_format_code_t format);

void dpy_gl_scanout_disable(QemuConsole *con);
void dpy_gl_scanout_texture(QemuConsole *con,
                            uint32_t backing_id, bool backing_y_0_top,
                            uint32_t backing_width, uint32_t backing_height,
                            uint32_t x, uint32_t y, uint32_t w, uint32_t h);
void dpy_gl_scanout_dmabuf(QemuConsole *con,
                           QemuDmaBuf *dmabuf);
void dpy_gl_cursor_dmabuf(QemuConsole *con,
                          QemuDmaBuf *dmabuf,
                          uint32_t pos_x, uint32_t pos_y);
void dpy_gl_release_dmabuf(QemuConsole *con,
                           QemuDmaBuf *dmabuf);
void dpy_gl_update(QemuConsole *con,
                   uint32_t x, uint32_t y, uint32_t w, uint32_t h);

QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
                                QEMUGLParams *params);
void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);

bool console_has_gl(QemuConsole *con);
bool console_has_gl_dmabuf(QemuConsole *con);

static inline int surface_stride(DisplaySurface *s)
{
    return pixman_image_get_stride(s->image);
}

static inline void *surface_data(DisplaySurface *s)
{
    return pixman_image_get_data(s->image);
}

static inline int surface_width(DisplaySurface *s)
{
    return pixman_image_get_width(s->image);
}

static inline int surface_height(DisplaySurface *s)
{
    return pixman_image_get_height(s->image);
}

static inline int surface_bits_per_pixel(DisplaySurface *s)
{
    int bits = PIXMAN_FORMAT_BPP(s->format);
    return bits;
}

static inline int surface_bytes_per_pixel(DisplaySurface *s)
{
    int bits = PIXMAN_FORMAT_BPP(s->format);
    return DIV_ROUND_UP(bits, 8);
}

static inline pixman_format_code_t surface_format(DisplaySurface *s)
{
    return s->format;
}

typedef uint32_t console_ch_t;

static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
{
    *dest = ch;
}

typedef struct GraphicHwOps {
    void (*invalidate)(void *opaque);
    void (*gfx_update)(void *opaque);
    void (*text_update)(void *opaque, console_ch_t *text);
    void (*update_interval)(void *opaque, uint64_t interval);
    int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
    void (*gl_block)(void *opaque, bool block);
} GraphicHwOps;

QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
                                  const GraphicHwOps *ops,
                                  void *opaque);
void graphic_console_set_hwops(QemuConsole *con,
                               const GraphicHwOps *hw_ops,
                               void *opaque);

void graphic_hw_update(QemuConsole *con);
void graphic_hw_invalidate(QemuConsole *con);
void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
void graphic_hw_gl_block(QemuConsole *con, bool block);

void qemu_console_early_init(void);

QemuConsole *qemu_console_lookup_by_index(unsigned int index);
QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
                                                uint32_t head, Error **errp);
bool qemu_console_is_visible(QemuConsole *con);
bool qemu_console_is_graphic(QemuConsole *con);
bool qemu_console_is_fixedsize(QemuConsole *con);
bool qemu_console_is_gl_blocked(QemuConsole *con);
char *qemu_console_get_label(QemuConsole *con);
int qemu_console_get_index(QemuConsole *con);
uint32_t qemu_console_get_head(QemuConsole *con);
QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
int qemu_console_get_width(QemuConsole *con, int fallback);
int qemu_console_get_height(QemuConsole *con, int fallback);
/* Return the low-level window id for the console */
int qemu_console_get_window_id(QemuConsole *con);
/* Set the low-level window id for the console */
void qemu_console_set_window_id(QemuConsole *con, int window_id);

void console_select(unsigned int index);
void qemu_console_resize(QemuConsole *con, int width, int height);
DisplaySurface *qemu_console_surface(QemuConsole *con);

/* console-gl.c */
#ifdef CONFIG_OPENGL
bool console_gl_check_format(DisplayChangeListener *dcl,
                             pixman_format_code_t format);
void surface_gl_create_texture(QemuGLShader *gls,
                               DisplaySurface *surface);
void surface_gl_update_texture(QemuGLShader *gls,
                               DisplaySurface *surface,
                               int x, int y, int w, int h);
void surface_gl_render_texture(QemuGLShader *gls,
                               DisplaySurface *surface);
void surface_gl_destroy_texture(QemuGLShader *gls,
                               DisplaySurface *surface);
void surface_gl_setup_viewport(QemuGLShader *gls,
                               DisplaySurface *surface,
                               int ww, int wh);
#endif

/* sdl.c */
#ifdef CONFIG_SDL
void sdl_display_early_init(int opengl);
void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
#else
static inline void sdl_display_early_init(int opengl)
{
    /* This must never be called if CONFIG_SDL is disabled */
    error_report("SDL support is disabled");
    abort();
}
static inline void sdl_display_init(DisplayState *ds, int full_screen,
                                    int no_frame)
{
    /* This must never be called if CONFIG_SDL is disabled */
    error_report("SDL support is disabled");
    abort();
}
#endif

/* cocoa.m */
#ifdef CONFIG_COCOA
void cocoa_display_init(DisplayState *ds, int full_screen);
#else
static inline void cocoa_display_init(DisplayState *ds, int full_screen)
{
    /* This must never be called if CONFIG_COCOA is disabled */
    error_report("Cocoa support is disabled");
    abort();
}
#endif

/* vnc.c */
void vnc_display_init(const char *id);
void vnc_display_open(const char *id, Error **errp);
void vnc_display_add_client(const char *id, int csock, bool skipauth);
#ifdef CONFIG_VNC
int vnc_display_password(const char *id, const char *password);
int vnc_display_pw_expire(const char *id, time_t expires);
QemuOpts *vnc_parse(const char *str, Error **errp);
int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
#else
static inline int vnc_display_password(const char *id, const char *password)
{
    return -ENODEV;
}
static inline int vnc_display_pw_expire(const char *id, time_t expires)
{
    return -ENODEV;
};
static inline QemuOpts *vnc_parse(const char *str, Error **errp)
{
    error_setg(errp, "VNC support is disabled");
    return NULL;
}
static inline int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp)
{
    error_setg(errp, "VNC support is disabled");
    return -1;
}
#endif

/* curses.c */
#ifdef CONFIG_CURSES
void curses_display_init(DisplayState *ds, int full_screen);
#else
static inline void curses_display_init(DisplayState *ds, int full_screen)
{
    /* This must never be called if CONFIG_CURSES is disabled */
    error_report("curses support is disabled");
    abort();
}
#endif

/* input.c */
int index_from_key(const char *key, size_t key_length);

/* gtk.c */
#ifdef CONFIG_GTK
void early_gtk_display_init(int opengl);
void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
#else
static inline void gtk_display_init(DisplayState *ds, bool full_screen,
                                    bool grab_on_hover)
{
    /* This must never be called if CONFIG_GTK is disabled */
    error_report("GTK support is disabled");
    abort();
}

static inline void early_gtk_display_init(int opengl)
{
    /* This must never be called if CONFIG_GTK is disabled */
    error_report("GTK support is disabled");
    abort();
}
#endif

/* egl-headless.c */
void egl_headless_init(void);

#endif
Commit	Line	Data
87ecb68b PB	1	#ifndef CONSOLE_H
	2	#define CONSOLE_H
	3
28ecbaee	4	#include "ui/qemu-pixman.h"
95be0669	5	#include "qom/object.h"
7b1b5d19	6	#include "qapi/qmp/qdict.h"
1de7afc9	7	#include "qemu/notify.h"
4133fa71	8	#include "qemu/typedefs.h"
1048c88f	9	#include "qapi-types.h"
f8c75b24 EH	10	#include "qemu/error-report.h"
f8c75b24 EH	11	#include "qapi/error.h"
87ecb68b	12
cd2bc889	13	#ifdef CONFIG_OPENGL
dcf30025	14	# include <epoxy/gl.h>
46e19e14	15	# include "ui/shader.h"
cd2bc889 GH	16	#endif
cd2bc889 GH	17
87ecb68b PB	18	/* keyboard/mouse support */
	19
	20	#define MOUSE_EVENT_LBUTTON 0x01
	21	#define MOUSE_EVENT_RBUTTON 0x02
	22	#define MOUSE_EVENT_MBUTTON 0x04
21bae11a GH	23	#define MOUSE_EVENT_WHEELUP 0x08
21bae11a GH	24	#define MOUSE_EVENT_WHEELDN 0x10
87ecb68b	25
03a23a85 GH	26	/* identical to the ps/2 keyboard bits */
	27	#define QEMU_SCROLL_LOCK_LED (1 << 0)
	28	#define QEMU_NUM_LOCK_LED (1 << 1)
	29	#define QEMU_CAPS_LOCK_LED (1 << 2)
	30
7ed9eba3	31	/* in ms */
0f7b2864 GH	32	#define GUI_REFRESH_INTERVAL_DEFAULT 30
0f7b2864 GH	33	#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3	34
4083733d OH	35	/* Color number is match to standard vga palette */
	36	enum qemu_color_names {
	37	QEMU_COLOR_BLACK = 0,
	38	QEMU_COLOR_BLUE = 1,
	39	QEMU_COLOR_GREEN = 2,
	40	QEMU_COLOR_CYAN = 3,
	41	QEMU_COLOR_RED = 4,
	42	QEMU_COLOR_MAGENTA = 5,
	43	QEMU_COLOR_YELLOW = 6,
	44	QEMU_COLOR_WHITE = 7
	45	};
	46	/* Convert to curses char attributes */
	47	#define ATTR2CHTYPE(c, fg, bg, bold) \
	48	((bold) << 21 \| (bg) << 11 \| (fg) << 8 \| (c))
	49
87ecb68b	50	typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85	51	typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b PB	52	typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
87ecb68b PB	53
72711efb	54	typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
5a37532d	55	typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
72711efb	56	typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
03a23a85	57
5a37532d GH	58	QEMUPutKbdEntry qemu_add_kbd_event_handler(QEMUPutKBDEvent func,
5a37532d GH	59	void *opaque);
87ecb68b PB	60	QEMUPutMouseEntry qemu_add_mouse_event_handler(QEMUPutMouseEvent func,
	61	void *opaque, int absolute,
	62	const char *name);
	63	void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee AL	64	void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee AL	65
03a23a85 GH	66	QEMUPutLEDEntry qemu_add_led_event_handler(QEMUPutLEDEvent func, void *opaque);
03a23a85 GH	67	void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b	68
03a23a85	69	void kbd_put_ledstate(int ledstate);
eb2e259d	70
bc24a225	71	struct MouseTransformInfo {
a5d7eb65 AZ	72	/* Touchscreen resolution */
	73	int x;
	74	int y;
	75	/* Calibration values as used/generated by tslib */
	76	int a[7];
	77	};
	78
3e5a50d6	79	void hmp_mouse_set(Monitor mon, const QDict qdict);
87ecb68b PB	80
	81	/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
	82	constants) */
	83	#define QEMU_KEY_ESC1(c) ((c) \| 0xe100)
	84	#define QEMU_KEY_BACKSPACE 0x007f
	85	#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
	86	#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
	87	#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
	88	#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
	89	#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
	90	#define QEMU_KEY_END QEMU_KEY_ESC1(4)
	91	#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
	92	#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
	93	#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
	94
	95	#define QEMU_KEY_CTRL_UP 0xe400
	96	#define QEMU_KEY_CTRL_DOWN 0xe401
	97	#define QEMU_KEY_CTRL_LEFT 0xe402
	98	#define QEMU_KEY_CTRL_RIGHT 0xe403
	99	#define QEMU_KEY_CTRL_HOME 0xe404
	100	#define QEMU_KEY_CTRL_END 0xe405
	101	#define QEMU_KEY_CTRL_PAGEUP 0xe406
	102	#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
	103
3f9a6e85	104	void kbd_put_keysym_console(QemuConsole *s, int keysym);
50ef4679	105	bool kbd_put_qcode_console(QemuConsole *s, int qcode);
bdef9724	106	void kbd_put_string_console(QemuConsole s, const char str, int len);
87ecb68b PB	107	void kbd_put_keysym(int keysym);
	108
	109	/* consoles */
	110
95be0669 GH	111	#define TYPE_QEMU_CONSOLE "qemu-console"
	112	#define QEMU_CONSOLE(obj) \
	113	OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
	114	#define QEMU_CONSOLE_GET_CLASS(obj) \
	115	OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
	116	#define QEMU_CONSOLE_CLASS(klass) \
	117	OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
	118
	119	typedef struct QemuConsoleClass QemuConsoleClass;
	120
	121	struct QemuConsoleClass {
	122	ObjectClass parent_class;
	123	};
	124
77bfcf28	125	#define QEMU_ALLOCATED_FLAG 0x01
7d957bd8 AL	126
	127	struct PixelFormat {
	128	uint8_t bits_per_pixel;
	129	uint8_t bytes_per_pixel;
	130	uint8_t depth; /* color depth in bits */
	131	uint32_t rmask, gmask, bmask, amask;
	132	uint8_t rshift, gshift, bshift, ashift;
	133	uint8_t rmax, gmax, bmax, amax;
90a1e3c0	134	uint8_t rbits, gbits, bbits, abits;
7d957bd8 AL	135	};
	136
	137	struct DisplaySurface {
69c77777 GH	138	pixman_format_code_t format;
69c77777 GH	139	pixman_image_t *image;
7d957bd8	140	uint8_t flags;
cd2bc889 GH	141	#ifdef CONFIG_OPENGL
	142	GLenum glformat;
	143	GLenum gltype;
	144	GLuint texture;
	145	#endif
7d957bd8 AL	146	};
7d957bd8 AL	147
6f90f3d7 GH	148	typedef struct QemuUIInfo {
	149	/* geometry */
	150	int xoff;
	151	int yoff;
	152	uint32_t width;
	153	uint32_t height;
	154	} QemuUIInfo;
	155
254e5950 GH	156	/* cursor data format is 32bit RGBA */
	157	typedef struct QEMUCursor {
	158	int width, height;
	159	int hot_x, hot_y;
	160	int refcount;
	161	uint32_t data[];
	162	} QEMUCursor;
	163
	164	QEMUCursor *cursor_alloc(int width, int height);
	165	void cursor_get(QEMUCursor *c);
	166	void cursor_put(QEMUCursor *c);
	167	QEMUCursor *cursor_builtin_hidden(void);
	168	QEMUCursor *cursor_builtin_left_ptr(void);
	169	void cursor_print_ascii_art(QEMUCursor c, const char prefix);
	170	int cursor_get_mono_bpl(QEMUCursor *c);
	171	void cursor_set_mono(QEMUCursor *c,
	172	uint32_t foreground, uint32_t background, uint8_t *image,
	173	int transparent, uint8_t *mask);
	174	void cursor_get_mono_image(QEMUCursor c, int foreground, uint8_t mask);
	175	void cursor_get_mono_mask(QEMUCursor c, int transparent, uint8_t mask);
	176
06020b95 GH	177	typedef void *QEMUGLContext;
	178	typedef struct QEMUGLParams QEMUGLParams;
	179
	180	struct QEMUGLParams {
	181	int major_ver;
	182	int minor_ver;
	183	};
	184
4133fa71 GH	185	struct QemuDmaBuf {
	186	int fd;
	187	uint32_t width;
	188	uint32_t height;
	189	uint32_t stride;
	190	uint32_t fourcc;
	191	uint32_t texture;
	192	};
	193
7c20b4a3 GH	194	typedef struct DisplayChangeListenerOps {
	195	const char *dpy_name;
	196
bc2ed970	197	void (dpy_refresh)(DisplayChangeListener dcl);
7c20b4a3 GH	198
7c20b4a3 GH	199	void (dpy_gfx_update)(DisplayChangeListener dcl,
7c20b4a3	200	int x, int y, int w, int h);
c12aeb86	201	void (dpy_gfx_switch)(DisplayChangeListener dcl,
c12aeb86	202	struct DisplaySurface *new_surface);
49743df3 BH	203	bool (dpy_gfx_check_format)(DisplayChangeListener dcl,
49743df3 BH	204	pixman_format_code_t format);
a93a4a22	205
7c20b4a3	206	void (dpy_text_cursor)(DisplayChangeListener dcl,
7c20b4a3 GH	207	int x, int y);
7c20b4a3 GH	208	void (dpy_text_resize)(DisplayChangeListener dcl,
7c20b4a3 GH	209	int w, int h);
7c20b4a3 GH	210	void (dpy_text_update)(DisplayChangeListener dcl,
7c20b4a3 GH	211	int x, int y, int w, int h);
	212
	213	void (dpy_mouse_set)(DisplayChangeListener dcl,
7c20b4a3 GH	214	int x, int y, int on);
7c20b4a3 GH	215	void (dpy_cursor_define)(DisplayChangeListener dcl,
7c20b4a3	216	QEMUCursor *cursor);
06020b95 GH	217
	218	QEMUGLContext (dpy_gl_ctx_create)(DisplayChangeListener dcl,
	219	QEMUGLParams *params);
	220	void (dpy_gl_ctx_destroy)(DisplayChangeListener dcl,
	221	QEMUGLContext ctx);
	222	int (dpy_gl_ctx_make_current)(DisplayChangeListener dcl,
	223	QEMUGLContext ctx);
	224	QEMUGLContext (dpy_gl_ctx_get_current)(DisplayChangeListener dcl);
	225
eaa92c76	226	void (dpy_gl_scanout_disable)(DisplayChangeListener dcl);
f4c36bda GH	227	void (dpy_gl_scanout_texture)(DisplayChangeListener dcl,
	228	uint32_t backing_id,
	229	bool backing_y_0_top,
	230	uint32_t backing_width,
	231	uint32_t backing_height,
	232	uint32_t x, uint32_t y,
	233	uint32_t w, uint32_t h);
4133fa71 GH	234	void (dpy_gl_scanout_dmabuf)(DisplayChangeListener dcl,
	235	QemuDmaBuf *dmabuf);
	236	void (dpy_gl_cursor_dmabuf)(DisplayChangeListener dcl,
	237	QemuDmaBuf *dmabuf,
	238	uint32_t pos_x, uint32_t pos_y);
	239	void (dpy_gl_release_dmabuf)(DisplayChangeListener dcl,
	240	QemuDmaBuf *dmabuf);
06020b95 GH	241	void (dpy_gl_update)(DisplayChangeListener dcl,
	242	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	243
7c20b4a3	244	} DisplayChangeListenerOps;
7d957bd8	245
7c20b4a3	246	struct DisplayChangeListener {
0f7b2864	247	uint64_t update_interval;
7c20b4a3 GH	248	const DisplayChangeListenerOps *ops;
7c20b4a3 GH	249	DisplayState *ds;
284d1c6b	250	QemuConsole *con;
bf2fde70	251
87e487a1	252	QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8 AL	253	};
7d957bd8 AL	254
64840c66	255	DisplayState *init_displaystate(void);
30f1e661 GH	256	DisplaySurface *qemu_create_displaysurface_from(int width, int height,
	257	pixman_format_code_t format,
	258	int linesize, uint8_t *data);
ca58b45f	259	DisplaySurface qemu_create_displaysurface_pixman(pixman_image_t image);
a77549b3 GH	260	DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
	261	pixman_format_code_t format,
	262	int linesize,
	263	uint64_t addr);
0da2ea1b	264	PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8	265
da229ef3 GH	266	DisplaySurface *qemu_create_displaysurface(int width, int height);
da229ef3 GH	267	void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da AL	268
	269	static inline int is_surface_bgr(DisplaySurface *surface)
	270	{
30f1e661 GH	271	if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
30f1e661 GH	272	PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
7b5d76da	273	return 1;
30f1e661	274	} else {
7b5d76da	275	return 0;
30f1e661	276	}
7b5d76da AL	277	}
7b5d76da AL	278
7d957bd8 AL	279	static inline int is_buffer_shared(DisplaySurface *surface)
7d957bd8 AL	280	{
187cd1d9	281	return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8 AL	282	}
7d957bd8 AL	283
5209089f	284	void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864 GH	285	void update_displaychangelistener(DisplayChangeListener *dcl,
0f7b2864 GH	286	uint64_t interval);
7c20b4a3 GH	287	void unregister_displaychangelistener(DisplayChangeListener *dcl);
7c20b4a3 GH	288
b7fb49f0	289	bool dpy_ui_info_supported(QemuConsole *con);
6f90f3d7 GH	290	int dpy_set_ui_info(QemuConsole con, QemuUIInfo info);
6f90f3d7 GH	291
c78f7137 GH	292	void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
c78f7137 GH	293	void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3	294	DisplaySurface *surface);
c78f7137 GH	295	void dpy_text_cursor(QemuConsole *con, int x, int y);
	296	void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
	297	void dpy_text_resize(QemuConsole *con, int w, int h);
	298	void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
	299	void dpy_cursor_define(QemuConsole con, QEMUCursor cursor);
	300	bool dpy_cursor_define_supported(QemuConsole *con);
49743df3 BH	301	bool dpy_gfx_check_format(QemuConsole *con,
49743df3 BH	302	pixman_format_code_t format);
bf2fde70	303
eaa92c76	304	void dpy_gl_scanout_disable(QemuConsole *con);
f4c36bda GH	305	void dpy_gl_scanout_texture(QemuConsole *con,
	306	uint32_t backing_id, bool backing_y_0_top,
	307	uint32_t backing_width, uint32_t backing_height,
	308	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
4133fa71 GH	309	void dpy_gl_scanout_dmabuf(QemuConsole *con,
	310	QemuDmaBuf *dmabuf);
	311	void dpy_gl_cursor_dmabuf(QemuConsole *con,
	312	QemuDmaBuf *dmabuf,
	313	uint32_t pos_x, uint32_t pos_y);
	314	void dpy_gl_release_dmabuf(QemuConsole *con,
	315	QemuDmaBuf *dmabuf);
06020b95 GH	316	void dpy_gl_update(QemuConsole *con,
	317	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	318
	319	QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
	320	QEMUGLParams *params);
	321	void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
	322	int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
	323	QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
	324
	325	bool console_has_gl(QemuConsole *con);
4133fa71	326	bool console_has_gl_dmabuf(QemuConsole *con);
06020b95	327
626e3b34 GH	328	static inline int surface_stride(DisplaySurface *s)
	329	{
	330	return pixman_image_get_stride(s->image);
	331	}
	332
	333	static inline void surface_data(DisplaySurface s)
	334	{
	335	return pixman_image_get_data(s->image);
	336	}
	337
	338	static inline int surface_width(DisplaySurface *s)
	339	{
	340	return pixman_image_get_width(s->image);
	341	}
	342
	343	static inline int surface_height(DisplaySurface *s)
	344	{
	345	return pixman_image_get_height(s->image);
	346	}
	347
	348	static inline int surface_bits_per_pixel(DisplaySurface *s)
	349	{
	350	int bits = PIXMAN_FORMAT_BPP(s->format);
	351	return bits;
	352	}
	353
	354	static inline int surface_bytes_per_pixel(DisplaySurface *s)
	355	{
	356	int bits = PIXMAN_FORMAT_BPP(s->format);
d1a0945f	357	return DIV_ROUND_UP(bits, 8);
626e3b34 GH	358	}
626e3b34 GH	359
e444ea34 HR	360	static inline pixman_format_code_t surface_format(DisplaySurface *s)
	361	{
	362	return s->format;
	363	}
	364
e2f82e92 GH	365	typedef uint32_t console_ch_t;
e2f82e92 GH	366
c227f099	367	static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e	368	{
9ae19b65	369	*dest = ch;
4d3b6f6e AZ	370	}
4d3b6f6e AZ	371
380cd056 GH	372	typedef struct GraphicHwOps {
	373	void (invalidate)(void opaque);
	374	void (gfx_update)(void opaque);
	375	void (text_update)(void opaque, console_ch_t *text);
dea1b0bd	376	void (update_interval)(void opaque, uint64_t interval);
6f90f3d7	377	int (ui_info)(void opaque, uint32_t head, QemuUIInfo *info);
bba19b88	378	void (gl_block)(void opaque, bool block);
380cd056	379	} GraphicHwOps;
87ecb68b	380
5643706a	381	QemuConsole graphic_console_init(DeviceState dev, uint32_t head,
aa2beaa1	382	const GraphicHwOps *ops,
c78f7137	383	void *opaque);
1c1f9498 GH	384	void graphic_console_set_hwops(QemuConsole *con,
	385	const GraphicHwOps *hw_ops,
	386	void *opaque);
3023f332	387
1dbfa005 GH	388	void graphic_hw_update(QemuConsole *con);
	389	void graphic_hw_invalidate(QemuConsole *con);
	390	void graphic_hw_text_update(QemuConsole con, console_ch_t chardata);
bba19b88	391	void graphic_hw_gl_block(QemuConsole *con, bool block);
87ecb68b	392
777357d7 MAL	393	void qemu_console_early_init(void);
777357d7 MAL	394
284d1c6b	395	QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a	396	QemuConsole qemu_console_lookup_by_device(DeviceState dev, uint32_t head);
f2c1d54c GH	397	QemuConsole qemu_console_lookup_by_device_name(const char device_id,
f2c1d54c GH	398	uint32_t head, Error **errp);
81c0d5a6 GH	399	bool qemu_console_is_visible(QemuConsole *con);
	400	bool qemu_console_is_graphic(QemuConsole *con);
	401	bool qemu_console_is_fixedsize(QemuConsole *con);
f607867c	402	bool qemu_console_is_gl_blocked(QemuConsole *con);
779ce88f	403	char qemu_console_get_label(QemuConsole con);
d4c85337	404	int qemu_console_get_index(QemuConsole *con);
5643706a	405	uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7	406	QemuUIInfo qemu_console_get_ui_info(QemuConsole con);
d4c85337 GH	407	int qemu_console_get_width(QemuConsole *con, int fallback);
d4c85337 GH	408	int qemu_console_get_height(QemuConsole *con, int fallback);
b3cb21b9 ST	409	/* Return the low-level window id for the console */
	410	int qemu_console_get_window_id(QemuConsole *con);
	411	/* Set the low-level window id for the console */
	412	void qemu_console_set_window_id(QemuConsole *con, int window_id);
81c0d5a6	413
87ecb68b	414	void console_select(unsigned int index);
c78f7137	415	void qemu_console_resize(QemuConsole *con, int width, int height);
c78f7137	416	DisplaySurface qemu_console_surface(QemuConsole con);
87ecb68b	417
cd2bc889	418	/* console-gl.c */
cd2bc889	419	#ifdef CONFIG_OPENGL
cd2bc889 GH	420	bool console_gl_check_format(DisplayChangeListener *dcl,
cd2bc889 GH	421	pixman_format_code_t format);
46e19e14	422	void surface_gl_create_texture(QemuGLShader *gls,
cd2bc889	423	DisplaySurface *surface);
46e19e14	424	void surface_gl_update_texture(QemuGLShader *gls,
cd2bc889 GH	425	DisplaySurface *surface,
cd2bc889 GH	426	int x, int y, int w, int h);
46e19e14	427	void surface_gl_render_texture(QemuGLShader *gls,
cd2bc889	428	DisplaySurface *surface);
46e19e14	429	void surface_gl_destroy_texture(QemuGLShader *gls,
cd2bc889	430	DisplaySurface *surface);
46e19e14	431	void surface_gl_setup_viewport(QemuGLShader *gls,
cd2bc889 GH	432	DisplaySurface *surface,
	433	int ww, int wh);
	434	#endif
	435
87ecb68b	436	/* sdl.c */
476db081	437	#ifdef CONFIG_SDL
0b71a5d5	438	void sdl_display_early_init(int opengl);
87ecb68b	439	void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
476db081 EH	440	#else
	441	static inline void sdl_display_early_init(int opengl)
	442	{
	443	/* This must never be called if CONFIG_SDL is disabled */
	444	error_report("SDL support is disabled");
	445	abort();
	446	}
	447	static inline void sdl_display_init(DisplayState *ds, int full_screen,
	448	int no_frame)
	449	{
	450	/* This must never be called if CONFIG_SDL is disabled */
	451	error_report("SDL support is disabled");
	452	abort();
	453	}
	454	#endif
87ecb68b PB	455
87ecb68b PB	456	/* cocoa.m */
e35ee7c1	457	#ifdef CONFIG_COCOA
87ecb68b	458	void cocoa_display_init(DisplayState *ds, int full_screen);
e35ee7c1 EH	459	#else
	460	static inline void cocoa_display_init(DisplayState *ds, int full_screen)
	461	{
	462	/* This must never be called if CONFIG_COCOA is disabled */
	463	error_report("Cocoa support is disabled");
	464	abort();
	465	}
	466	#endif
87ecb68b PB	467
87ecb68b PB	468	/* vnc.c */
14f7143e	469	void vnc_display_init(const char *id);
4db14629	470	void vnc_display_open(const char id, Error *errp);
14f7143e	471	void vnc_display_add_client(const char *id, int csock, bool skipauth);
821601ea	472	#ifdef CONFIG_VNC
14f7143e GH	473	int vnc_display_password(const char id, const char password);
14f7143e GH	474	int vnc_display_pw_expire(const char *id, time_t expires);
70b94331	475	QemuOpts vnc_parse(const char str, Error **errp);
28d0de7a	476	int vnc_init_func(void opaque, QemuOpts opts, Error **errp);
821601ea	477	#else
14f7143e	478	static inline int vnc_display_password(const char id, const char password)
821601ea	479	{
821601ea JS	480	return -ENODEV;
821601ea JS	481	}
14f7143e	482	static inline int vnc_display_pw_expire(const char *id, time_t expires)
821601ea	483	{
821601ea JS	484	return -ENODEV;
821601ea JS	485	};
f8c75b24 EH	486	static inline QemuOpts vnc_parse(const char str, Error **errp)
	487	{
	488	error_setg(errp, "VNC support is disabled");
	489	return NULL;
	490	}
	491	static inline int vnc_init_func(void opaque, QemuOpts opts, Error **errp)
	492	{
	493	error_setg(errp, "VNC support is disabled");
	494	return -1;
	495	}
821601ea	496	#endif
87ecb68b	497
4d3b6f6e	498	/* curses.c */
674ec686	499	#ifdef CONFIG_CURSES
4d3b6f6e	500	void curses_display_init(DisplayState *ds, int full_screen);
674ec686 EH	501	#else
	502	static inline void curses_display_init(DisplayState *ds, int full_screen)
	503	{
	504	/* This must never be called if CONFIG_CURSES is disabled */
	505	error_report("curses support is disabled");
	506	abort();
	507	}
	508	#endif
4d3b6f6e	509
1048c88f	510	/* input.c */
64ffbe04	511	int index_from_key(const char *key, size_t key_length);
1048c88f	512
a4ccabcf	513	/* gtk.c */
19a2c626	514	#ifdef CONFIG_GTK
97edf3bd	515	void early_gtk_display_init(int opengl);
881249c7	516	void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
19a2c626 EH	517	#else
	518	static inline void gtk_display_init(DisplayState *ds, bool full_screen,
	519	bool grab_on_hover)
	520	{
	521	/* This must never be called if CONFIG_GTK is disabled */
	522	error_report("GTK support is disabled");
	523	abort();
	524	}
	525
	526	static inline void early_gtk_display_init(int opengl)
	527	{
	528	/* This must never be called if CONFIG_GTK is disabled */
	529	error_report("GTK support is disabled");
	530	abort();
	531	}
	532	#endif
a4ccabcf	533
bb1599b6 GH	534	/* egl-headless.c */
	535	void egl_headless_init(void);
	536
87ecb68b	537	#endif