[qemu.git] / ui / vnc.h

/*
 * QEMU VNC display driver
 *
 * Copyright (C) 2006 Anthony Liguori <[email protected]>
 * Copyright (C) 2006 Fabrice Bellard
 * Copyright (C) 2009 Red Hat, Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __QEMU_VNC_H
#define __QEMU_VNC_H

#include "qemu-common.h"
#include "qemu/queue.h"
#include "qemu/thread.h"
#include "ui/console.h"
#include "audio/audio.h"
#include "qemu/bitmap.h"
#include <zlib.h>
#include <stdbool.h>

#include "keymaps.h"
#include "vnc-palette.h"
#include "vnc-enc-zrle.h"
#include "qapi-types.h"

// #define _VNC_DEBUG 1

#ifdef _VNC_DEBUG
#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
#else
#define VNC_DEBUG(fmt, ...) do { } while (0)
#endif

/*****************************************************************************
 *
 * Core data structures
 *
 *****************************************************************************/

typedef struct Buffer
{
    size_t capacity;
    size_t offset;
    uint8_t *buffer;
} Buffer;

typedef struct VncState VncState;
typedef struct VncJob VncJob;
typedef struct VncRect VncRect;
typedef struct VncRectEntry VncRectEntry;

typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);

typedef void VncWritePixels(VncState *vs, void *data, int size);

typedef void VncSendHextileTile(VncState *vs,
                                int x, int y, int w, int h,
                                void *last_bg,
                                void *last_fg,
                                int *has_bg, int *has_fg);

/* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
 * by one bit in the dirty bitmap, should be a power of 2 */
#define VNC_DIRTY_PIXELS_PER_BIT 16

/* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */

#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
#define VNC_MAX_HEIGHT 2048

/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)

/* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
 * VNC_DIRTY_BITS due to alignment */
#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)

#define VNC_STAT_RECT  64
#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)

#define VNC_AUTH_CHALLENGE_SIZE 16

typedef struct VncDisplay VncDisplay;

#ifdef CONFIG_VNC_TLS
#include "vnc-tls.h"
#include "vnc-auth-vencrypt.h"
#endif
#ifdef CONFIG_VNC_SASL
#include "vnc-auth-sasl.h"
#endif
#ifdef CONFIG_VNC_WS
#include "vnc-ws.h"
#endif

struct VncRectStat
{
    /* time of last 10 updates, to find update frequency */
    struct timeval times[10];
    int idx;

    double freq;        /* Update frequency (in Hz) */
    bool updated;       /* Already updated during this refresh */
};

typedef struct VncRectStat VncRectStat;

struct VncSurface
{
    struct timeval last_freq_check;
    DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
                   VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
    VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
    pixman_image_t *fb;
    pixman_format_code_t format;
};

typedef enum VncShareMode {
    VNC_SHARE_MODE_CONNECTING = 1,
    VNC_SHARE_MODE_SHARED,
    VNC_SHARE_MODE_EXCLUSIVE,
    VNC_SHARE_MODE_DISCONNECTED,
} VncShareMode;

typedef enum VncSharePolicy {
    VNC_SHARE_POLICY_IGNORE = 1,
    VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
    VNC_SHARE_POLICY_FORCE_SHARED,
} VncSharePolicy;

struct VncDisplay
{
    QTAILQ_HEAD(, VncState) clients;
    int num_connecting;
    int num_shared;
    int num_exclusive;
    int connections_limit;
    VncSharePolicy share_policy;
    int lsock;
#ifdef CONFIG_VNC_WS
    int lwebsock;
    bool ws_enabled;
#endif
    DisplaySurface *ds;
    DisplayChangeListener dcl;
    kbd_layout_t *kbd_layout;
    int lock_key_sync;
    QemuMutex mutex;

    QEMUCursor *cursor;
    int cursor_msize;
    uint8_t *cursor_mask;

    struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
    pixman_image_t *server;    /* vnc server surface */

    const char *id;
    QTAILQ_ENTRY(VncDisplay) next;
    bool enabled;
    bool is_unix;
    char *password;
    time_t expires;
    int auth;
    int subauth; /* Used by VeNCrypt */
    int ws_auth; /* Used by websockets */
    bool ws_tls; /* Used by websockets */
    bool lossy;
    bool non_adaptive;
#ifdef CONFIG_VNC_TLS
    VncDisplayTLS tls;
#endif
#ifdef CONFIG_VNC_SASL
    VncDisplaySASL sasl;
#endif
};

typedef struct VncTight {
    int type;
    uint8_t quality;
    uint8_t compression;
    uint8_t pixel24;
    Buffer tight;
    Buffer tmp;
    Buffer zlib;
    Buffer gradient;
#ifdef CONFIG_VNC_JPEG
    Buffer jpeg;
#endif
#ifdef CONFIG_VNC_PNG
    Buffer png;
#endif
    int levels[4];
    z_stream stream[4];
} VncTight;

typedef struct VncHextile {
    VncSendHextileTile *send_tile;
} VncHextile;

typedef struct VncZlib {
    Buffer zlib;
    Buffer tmp;
    z_stream stream;
    int level;
} VncZlib;

typedef struct VncZrle {
    int type;
    Buffer fb;
    Buffer zrle;
    Buffer tmp;
    Buffer zlib;
    z_stream stream;
    VncPalette palette;
} VncZrle;

typedef struct VncZywrle {
    int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
} VncZywrle;

struct VncRect
{
    int x;
    int y;
    int w;
    int h;
};

struct VncRectEntry
{
    struct VncRect rect;
    QLIST_ENTRY(VncRectEntry) next;
};

struct VncJob
{
    VncState *vs;

    QLIST_HEAD(, VncRectEntry) rectangles;
    QTAILQ_ENTRY(VncJob) next;
};

struct VncState
{
    int csock;

    DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
    uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
                           * vnc-jobs-async.c */

    VncDisplay *vd;
    int need_update;
    int force_update;
    int has_dirty;
    uint32_t features;
    int absolute;
    int last_x;
    int last_y;
    uint32_t last_bmask;
    int client_width;
    int client_height;
    VncShareMode share_mode;

    uint32_t vnc_encoding;

    int major;
    int minor;

    int auth;
    int subauth; /* Used by VeNCrypt */
    char challenge[VNC_AUTH_CHALLENGE_SIZE];
#ifdef CONFIG_VNC_TLS
    VncStateTLS tls;
#endif
#ifdef CONFIG_VNC_SASL
    VncStateSASL sasl;
#endif
#ifdef CONFIG_VNC_WS
    bool encode_ws;
    bool websocket;
#endif /* CONFIG_VNC_WS */

    VncClientInfo *info;

    Buffer output;
    Buffer input;
#ifdef CONFIG_VNC_WS
    Buffer ws_input;
    Buffer ws_output;
    size_t ws_payload_remain;
    WsMask ws_payload_mask;
#endif
    /* current output mode information */
    VncWritePixels *write_pixels;
    PixelFormat client_pf;
    pixman_format_code_t client_format;
    bool client_be;

    CaptureVoiceOut *audio_cap;
    struct audsettings as;

    VncReadEvent *read_handler;
    size_t read_handler_expect;
    /* input */
    uint8_t modifiers_state[256];
    QEMUPutLEDEntry *led;

    bool abort;
    bool initialized;
    QemuMutex output_mutex;
    QEMUBH *bh;
    Buffer jobs_buffer;

    /* Encoding specific, if you add something here, don't forget to
     *  update vnc_async_encoding_start()
     */
    VncTight tight;
    VncZlib zlib;
    VncHextile hextile;
    VncZrle zrle;
    VncZywrle zywrle;

    Notifier mouse_mode_notifier;

    QTAILQ_ENTRY(VncState) next;
};


/*****************************************************************************
 *
 * Authentication modes
 *
 *****************************************************************************/

enum {
    VNC_AUTH_INVALID = 0,
    VNC_AUTH_NONE = 1,
    VNC_AUTH_VNC = 2,
    VNC_AUTH_RA2 = 5,
    VNC_AUTH_RA2NE = 6,
    VNC_AUTH_TIGHT = 16,
    VNC_AUTH_ULTRA = 17,
    VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
    VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
    VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
};

enum {
    VNC_AUTH_VENCRYPT_PLAIN = 256,
    VNC_AUTH_VENCRYPT_TLSNONE = 257,
    VNC_AUTH_VENCRYPT_TLSVNC = 258,
    VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
    VNC_AUTH_VENCRYPT_X509NONE = 260,
    VNC_AUTH_VENCRYPT_X509VNC = 261,
    VNC_AUTH_VENCRYPT_X509PLAIN = 262,
    VNC_AUTH_VENCRYPT_X509SASL = 263,
    VNC_AUTH_VENCRYPT_TLSSASL = 264,
};


/*****************************************************************************
 *
 * Encoding types
 *
 *****************************************************************************/

#define VNC_ENCODING_RAW                  0x00000000
#define VNC_ENCODING_COPYRECT             0x00000001
#define VNC_ENCODING_RRE                  0x00000002
#define VNC_ENCODING_CORRE                0x00000004
#define VNC_ENCODING_HEXTILE              0x00000005
#define VNC_ENCODING_ZLIB                 0x00000006
#define VNC_ENCODING_TIGHT                0x00000007
#define VNC_ENCODING_ZLIBHEX              0x00000008
#define VNC_ENCODING_TRLE                 0x0000000f
#define VNC_ENCODING_ZRLE                 0x00000010
#define VNC_ENCODING_ZYWRLE               0x00000011
#define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
#define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
#define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
#define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
#define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
#define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
#define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
#define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
#define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
#define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
#define VNC_ENCODING_TIGHT_PNG            0xFFFFFEFC /* -260 */
#define VNC_ENCODING_LED_STATE            0XFFFFFEFB /* -261 */
#define VNC_ENCODING_WMVi                 0x574D5669

/*****************************************************************************
 *
 * Other tight constants
 *
 *****************************************************************************/

/*
 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
 */

#define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
#define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
#define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
#define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
#define VNC_TIGHT_CCB_TYPE_PNG     (0x0A << 4)
#define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
#define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)

/*****************************************************************************
 *
 * Features
 *
 *****************************************************************************/

#define VNC_FEATURE_RESIZE                   0
#define VNC_FEATURE_HEXTILE                  1
#define VNC_FEATURE_POINTER_TYPE_CHANGE      2
#define VNC_FEATURE_WMVI                     3
#define VNC_FEATURE_TIGHT                    4
#define VNC_FEATURE_ZLIB                     5
#define VNC_FEATURE_COPYRECT                 6
#define VNC_FEATURE_RICH_CURSOR              7
#define VNC_FEATURE_TIGHT_PNG                8
#define VNC_FEATURE_ZRLE                     9
#define VNC_FEATURE_ZYWRLE                  10
#define VNC_FEATURE_LED_STATE               11

#define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
#define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
#define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
#define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
#define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
#define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
#define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)
#define VNC_FEATURE_TIGHT_PNG_MASK           (1 << VNC_FEATURE_TIGHT_PNG)
#define VNC_FEATURE_ZRLE_MASK                (1 << VNC_FEATURE_ZRLE)
#define VNC_FEATURE_ZYWRLE_MASK              (1 << VNC_FEATURE_ZYWRLE)
#define VNC_FEATURE_LED_STATE_MASK           (1 << VNC_FEATURE_LED_STATE)


/* Client -> Server message IDs */
#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
#define VNC_MSG_CLIENT_SET_ENCODINGS              2
#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
#define VNC_MSG_CLIENT_KEY_EVENT                  4
#define VNC_MSG_CLIENT_POINTER_EVENT              5
#define VNC_MSG_CLIENT_CUT_TEXT                   6
#define VNC_MSG_CLIENT_VMWARE_0                   127
#define VNC_MSG_CLIENT_CALL_CONTROL               249
#define VNC_MSG_CLIENT_XVP                        250
#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
#define VNC_MSG_CLIENT_TIGHT                      252
#define VNC_MSG_CLIENT_GII                        253
#define VNC_MSG_CLIENT_VMWARE_1                   254
#define VNC_MSG_CLIENT_QEMU                       255

/* Server -> Client message IDs */
#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
#define VNC_MSG_SERVER_BELL                       2
#define VNC_MSG_SERVER_CUT_TEXT                   3
#define VNC_MSG_SERVER_VMWARE_0                   127
#define VNC_MSG_SERVER_CALL_CONTROL               249
#define VNC_MSG_SERVER_XVP                        250
#define VNC_MSG_SERVER_TIGHT                      252
#define VNC_MSG_SERVER_GII                        253
#define VNC_MSG_SERVER_VMWARE_1                   254
#define VNC_MSG_SERVER_QEMU                       255


/* QEMU client -> server message IDs */
#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
#define VNC_MSG_CLIENT_QEMU_AUDIO                 1

/* QEMU server -> client message IDs */
#define VNC_MSG_SERVER_QEMU_AUDIO                 1


/* QEMU client -> server audio message IDs */
#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2

/* QEMU server -> client audio message IDs */
#define VNC_MSG_SERVER_QEMU_AUDIO_END             0
#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
#define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2


/*****************************************************************************
 *
 * Internal APIs
 *
 *****************************************************************************/

/* Event loop functions */
void vnc_client_read(void *opaque);
void vnc_client_write(void *opaque);

long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);

/* Protocol I/O functions */
void vnc_write(VncState *vs, const void *data, size_t len);
void vnc_write_u32(VncState *vs, uint32_t value);
void vnc_write_s32(VncState *vs, int32_t value);
void vnc_write_u16(VncState *vs, uint16_t value);
void vnc_write_u8(VncState *vs, uint8_t value);
void vnc_flush(VncState *vs);
void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
void vnc_disconnect_finish(VncState *vs);
void vnc_init_state(VncState *vs);


/* Buffer I/O functions */
uint32_t read_u32(uint8_t *data, size_t offset);

/* Protocol stage functions */
void vnc_client_error(VncState *vs);
int vnc_client_io_error(VncState *vs, int ret, int last_errno);

void start_client_init(VncState *vs);
void start_auth_vnc(VncState *vs);

/* Buffer management */
void buffer_reserve(Buffer *buffer, size_t len);
void buffer_reset(Buffer *buffer);
void buffer_free(Buffer *buffer);
void buffer_append(Buffer *buffer, const void *data, size_t len);
void buffer_advance(Buffer *buf, size_t len);
uint8_t *buffer_end(Buffer *buffer);


/* Misc helpers */

char *vnc_socket_local_addr(const char *format, int fd);
char *vnc_socket_remote_addr(const char *format, int fd);

static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
    return (vs->features & (1 << feature));
}

/* Framebuffer */
void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
                            int32_t encoding);

/* server fb is in PIXMAN_x8r8g8b8 */
#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
#define VNC_SERVER_FB_BITS   (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
#define VNC_SERVER_FB_BYTES  ((VNC_SERVER_FB_BITS+7)/8)

void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
int vnc_server_fb_stride(VncDisplay *vd);

void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);

/* Encodings */
int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);

int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);

int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
                                         int y, int w, int h);
void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);

void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
void vnc_zlib_zfree(void *x, void *addr);
int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
void vnc_zlib_clear(VncState *vs);

int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
                                          int w, int h);
void vnc_tight_clear(VncState *vs);

int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
void vnc_zrle_clear(VncState *vs);

#endif /* __QEMU_VNC_H */
Commit	Line	Data
19a490bf AL	1	/*
	2	* QEMU VNC display driver
	3	*
	4	* Copyright (C) 2006 Anthony Liguori <[email protected]>
	5	* Copyright (C) 2006 Fabrice Bellard
	6	* Copyright (C) 2009 Red Hat, Inc
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	21	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	24	* THE SOFTWARE.
	25	*/
	26
	27	#ifndef __QEMU_VNC_H
	28	#define __QEMU_VNC_H
	29
	30	#include "qemu-common.h"
1de7afc9 PB	31	#include "qemu/queue.h"
1de7afc9 PB	32	#include "qemu/thread.h"
28ecbaee	33	#include "ui/console.h"
19a490bf	34	#include "audio/audio.h"
1de7afc9	35	#include "qemu/bitmap.h"
19a490bf	36	#include <zlib.h>
6f9c78c1	37	#include <stdbool.h>
19a490bf	38
19a490bf	39	#include "keymaps.h"
148954fa CC	40	#include "vnc-palette.h"
148954fa CC	41	#include "vnc-enc-zrle.h"
fb6ba0d5	42	#include "qapi-types.h"
19a490bf	43
5fb6c7a8 AL	44	// #define _VNC_DEBUG 1
	45
	46	#ifdef _VNC_DEBUG
	47	#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
	48	#else
	49	#define VNC_DEBUG(fmt, ...) do { } while (0)
	50	#endif
	51
19a490bf AL	52	/*****************************************************************************
	53	*
	54	* Core data structures
	55	*
	56	*****************************************************************************/
	57
	58	typedef struct Buffer
	59	{
	60	size_t capacity;
	61	size_t offset;
	62	uint8_t *buffer;
	63	} Buffer;
	64
	65	typedef struct VncState VncState;
bd023f95 CC	66	typedef struct VncJob VncJob;
	67	typedef struct VncRect VncRect;
	68	typedef struct VncRectEntry VncRectEntry;
19a490bf AL	69
	70	typedef int VncReadEvent(VncState vs, uint8_t data, size_t len);
	71
9f64916d	72	typedef void VncWritePixels(VncState vs, void data, int size);
19a490bf AL	73
	74	typedef void VncSendHextileTile(VncState *vs,
	75	int x, int y, int w, int h,
	76	void *last_bg,
	77	void *last_fg,
	78	int has_bg, int has_fg);
	79
b4c85ddc	80	/* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
bea60dd7	81	* by one bit in the dirty bitmap, should be a power of 2 */
b4c85ddc PL	82	#define VNC_DIRTY_PIXELS_PER_BIT 16
b4c85ddc PL	83
bea60dd7 PL	84	/* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
	85
	86	#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
	87	#define VNC_MAX_HEIGHT 2048
	88
23bfe28f	89	/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
b4c85ddc	90	#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
19a490bf	91
12b316d4 PL	92	/* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
	93	* VNC_DIRTY_BITS due to alignment */
	94	#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
	95
999342a0 CC	96	#define VNC_STAT_RECT 64
	97	#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
	98	#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
	99
19a490bf AL	100	#define VNC_AUTH_CHALLENGE_SIZE 16
	101
	102	typedef struct VncDisplay VncDisplay;
	103
5fb6c7a8 AL	104	#ifdef CONFIG_VNC_TLS
	105	#include "vnc-tls.h"
	106	#include "vnc-auth-vencrypt.h"
	107	#endif
2f9606b3 AL	108	#ifdef CONFIG_VNC_SASL
	109	#include "vnc-auth-sasl.h"
	110	#endif
7536ee4b TH	111	#ifdef CONFIG_VNC_WS
	112	#include "vnc-ws.h"
	113	#endif
2f9606b3	114
999342a0 CC	115	struct VncRectStat
	116	{
	117	/* time of last 10 updates, to find update frequency */
	118	struct timeval times[10];
	119	int idx;
	120
	121	double freq; /* Update frequency (in Hz) */
	122	bool updated; /* Already updated during this refresh */
	123	};
	124
	125	typedef struct VncRectStat VncRectStat;
	126
1fc62412 SS	127	struct VncSurface
1fc62412 SS	128	{
999342a0	129	struct timeval last_freq_check;
bea60dd7 PL	130	DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
bea60dd7 PL	131	VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
999342a0	132	VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
9f64916d GH	133	pixman_image_t *fb;
9f64916d GH	134	pixman_format_code_t format;
1fc62412	135	};
5fb6c7a8	136
8cf36489 GH	137	typedef enum VncShareMode {
	138	VNC_SHARE_MODE_CONNECTING = 1,
	139	VNC_SHARE_MODE_SHARED,
	140	VNC_SHARE_MODE_EXCLUSIVE,
	141	VNC_SHARE_MODE_DISCONNECTED,
	142	} VncShareMode;
	143
	144	typedef enum VncSharePolicy {
	145	VNC_SHARE_POLICY_IGNORE = 1,
	146	VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
	147	VNC_SHARE_POLICY_FORCE_SHARED,
	148	} VncSharePolicy;
	149
19a490bf AL	150	struct VncDisplay
19a490bf AL	151	{
41b4bef6	152	QTAILQ_HEAD(, VncState) clients;
e5f34cdd GH	153	int num_connecting;
e5f34cdd GH	154	int num_shared;
8cf36489	155	int num_exclusive;
e5f34cdd	156	int connections_limit;
8cf36489	157	VncSharePolicy share_policy;
19a490bf	158	int lsock;
7536ee4b TH	159	#ifdef CONFIG_VNC_WS
7536ee4b TH	160	int lwebsock;
bf7aa45e	161	bool ws_enabled;
7536ee4b	162	#endif
d39fa6d8	163	DisplaySurface *ds;
21ef45d7	164	DisplayChangeListener dcl;
c227f099	165	kbd_layout_t *kbd_layout;
3a0558b5	166	int lock_key_sync;
bd023f95	167	QemuMutex mutex;
19a490bf	168
d467b679 GH	169	QEMUCursor *cursor;
	170	int cursor_msize;
	171	uint8_t *cursor_mask;
	172
1fc62412	173	struct VncSurface guest; /* guest visible surface (aka ds->surface) */
9f64916d	174	pixman_image_t server; / vnc server surface */
1fc62412	175
d616ccc5 GH	176	const char *id;
d616ccc5 GH	177	QTAILQ_ENTRY(VncDisplay) next;
bf7aa45e GH	178	bool enabled;
bf7aa45e GH	179	bool is_unix;
19a490bf	180	char *password;
3c9405a0	181	time_t expires;
19a490bf	182	int auth;
d169f04b	183	int subauth; /* Used by VeNCrypt */
f9148c8a DB	184	int ws_auth; /* Used by websockets */
f9148c8a DB	185	bool ws_tls; /* Used by websockets */
6f9c78c1	186	bool lossy;
80e0c8c3	187	bool non_adaptive;
19a490bf	188	#ifdef CONFIG_VNC_TLS
5fb6c7a8	189	VncDisplayTLS tls;
19a490bf	190	#endif
76655d6d AL	191	#ifdef CONFIG_VNC_SASL
	192	VncDisplaySASL sasl;
	193	#endif
19a490bf AL	194	};
19a490bf AL	195
d1af0e05 CC	196	typedef struct VncTight {
	197	int type;
	198	uint8_t quality;
	199	uint8_t compression;
	200	uint8_t pixel24;
	201	Buffer tight;
	202	Buffer tmp;
	203	Buffer zlib;
	204	Buffer gradient;
	205	#ifdef CONFIG_VNC_JPEG
	206	Buffer jpeg;
	207	#endif
	208	#ifdef CONFIG_VNC_PNG
	209	Buffer png;
	210	#endif
	211	int levels[4];
	212	z_stream stream[4];
	213	} VncTight;
	214
	215	typedef struct VncHextile {
	216	VncSendHextileTile *send_tile;
	217	} VncHextile;
	218
	219	typedef struct VncZlib {
	220	Buffer zlib;
	221	Buffer tmp;
	222	z_stream stream;
	223	int level;
	224	} VncZlib;
	225
148954fa CC	226	typedef struct VncZrle {
	227	int type;
	228	Buffer fb;
	229	Buffer zrle;
	230	Buffer tmp;
	231	Buffer zlib;
	232	z_stream stream;
	233	VncPalette palette;
	234	} VncZrle;
	235
	236	typedef struct VncZywrle {
	237	int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
	238	} VncZywrle;
	239
bd023f95 CC	240	struct VncRect
	241	{
	242	int x;
	243	int y;
	244	int w;
	245	int h;
	246	};
	247
	248	struct VncRectEntry
	249	{
	250	struct VncRect rect;
	251	QLIST_ENTRY(VncRectEntry) next;
	252	};
	253
	254	struct VncJob
	255	{
	256	VncState *vs;
	257
	258	QLIST_HEAD(, VncRectEntry) rectangles;
	259	QTAILQ_ENTRY(VncJob) next;
	260	};
bd023f95	261
19a490bf AL	262	struct VncState
19a490bf AL	263	{
19a490bf	264	int csock;
6baebed7	265
23bfe28f	266	DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
7d964c9d CC	267	uint8_t *lossy_rect; / Not an Array to avoid costly memcpy in
7d964c9d CC	268	* vnc-jobs-async.c */
6baebed7	269
19a490bf AL	270	VncDisplay *vd;
19a490bf AL	271	int need_update;
c522d0e2	272	int force_update;
63658280	273	int has_dirty;
19a490bf AL	274	uint32_t features;
	275	int absolute;
	276	int last_x;
	277	int last_y;
14768eba	278	uint32_t last_bmask;
5862d195 GH	279	int client_width;
5862d195 GH	280	int client_height;
8cf36489	281	VncShareMode share_mode;
19a490bf AL	282
19a490bf AL	283	uint32_t vnc_encoding;
19a490bf AL	284
	285	int major;
	286	int minor;
	287
7e7e2ebc	288	int auth;
d169f04b	289	int subauth; /* Used by VeNCrypt */
19a490bf	290	char challenge[VNC_AUTH_CHALLENGE_SIZE];
19a490bf	291	#ifdef CONFIG_VNC_TLS
5fb6c7a8	292	VncStateTLS tls;
19a490bf	293	#endif
2f9606b3 AL	294	#ifdef CONFIG_VNC_SASL
	295	VncStateSASL sasl;
	296	#endif
7536ee4b TH	297	#ifdef CONFIG_VNC_WS
	298	bool encode_ws;
	299	bool websocket;
0057a0d5	300	#endif /* CONFIG_VNC_WS */
19a490bf	301
fb6ba0d5	302	VncClientInfo *info;
4a80dba3	303
19a490bf AL	304	Buffer output;
19a490bf AL	305	Buffer input;
7536ee4b TH	306	#ifdef CONFIG_VNC_WS
	307	Buffer ws_input;
	308	Buffer ws_output;
a2bebfd6 DB	309	size_t ws_payload_remain;
a2bebfd6 DB	310	WsMask ws_payload_mask;
7536ee4b	311	#endif
19a490bf AL	312	/* current output mode information */
19a490bf AL	313	VncWritePixels *write_pixels;
9f64916d GH	314	PixelFormat client_pf;
	315	pixman_format_code_t client_format;
	316	bool client_be;
19a490bf AL	317
	318	CaptureVoiceOut *audio_cap;
	319	struct audsettings as;
	320
	321	VncReadEvent *read_handler;
	322	size_t read_handler_expect;
	323	/* input */
	324	uint8_t modifiers_state[256];
7ffb82ca	325	QEMUPutLEDEntry *led;
19a490bf	326
bd023f95	327	bool abort;
6fd8e79a	328	bool initialized;
bd023f95	329	QemuMutex output_mutex;
175b2a6e CC	330	QEMUBH *bh;
175b2a6e CC	331	Buffer jobs_buffer;
bd023f95 CC	332
	333	/* Encoding specific, if you add something here, don't forget to
	334	* update vnc_async_encoding_start()
	335	*/
d1af0e05 CC	336	VncTight tight;
	337	VncZlib zlib;
	338	VncHextile hextile;
148954fa CC	339	VncZrle zrle;
148954fa CC	340	VncZywrle zywrle;
19a490bf	341
37c34d9d AL	342	Notifier mouse_mode_notifier;
37c34d9d AL	343
41b4bef6	344	QTAILQ_ENTRY(VncState) next;
19a490bf AL	345	};
19a490bf AL	346
e06679fb AL	347
	348	/*****************************************************************************
	349	*
	350	* Authentication modes
	351	*
	352	*****************************************************************************/
	353
	354	enum {
	355	VNC_AUTH_INVALID = 0,
	356	VNC_AUTH_NONE = 1,
	357	VNC_AUTH_VNC = 2,
	358	VNC_AUTH_RA2 = 5,
	359	VNC_AUTH_RA2NE = 6,
	360	VNC_AUTH_TIGHT = 16,
	361	VNC_AUTH_ULTRA = 17,
2f9606b3 AL	362	VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
	363	VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
	364	VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
e06679fb AL	365	};
e06679fb AL	366
e06679fb AL	367	enum {
	368	VNC_AUTH_VENCRYPT_PLAIN = 256,
	369	VNC_AUTH_VENCRYPT_TLSNONE = 257,
	370	VNC_AUTH_VENCRYPT_TLSVNC = 258,
	371	VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
	372	VNC_AUTH_VENCRYPT_X509NONE = 260,
	373	VNC_AUTH_VENCRYPT_X509VNC = 261,
	374	VNC_AUTH_VENCRYPT_X509PLAIN = 262,
2f9606b3 AL	375	VNC_AUTH_VENCRYPT_X509SASL = 263,
2f9606b3 AL	376	VNC_AUTH_VENCRYPT_TLSSASL = 264,
e06679fb AL	377	};
e06679fb AL	378
e06679fb AL	379
	380	/*****************************************************************************
	381	*
	382	* Encoding types
	383	*
	384	*****************************************************************************/
	385
	386	#define VNC_ENCODING_RAW 0x00000000
	387	#define VNC_ENCODING_COPYRECT 0x00000001
	388	#define VNC_ENCODING_RRE 0x00000002
	389	#define VNC_ENCODING_CORRE 0x00000004
	390	#define VNC_ENCODING_HEXTILE 0x00000005
	391	#define VNC_ENCODING_ZLIB 0x00000006
	392	#define VNC_ENCODING_TIGHT 0x00000007
	393	#define VNC_ENCODING_ZLIBHEX 0x00000008
	394	#define VNC_ENCODING_TRLE 0x0000000f
	395	#define VNC_ENCODING_ZRLE 0x00000010
	396	#define VNC_ENCODING_ZYWRLE 0x00000011
	397	#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
	398	#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
	399	#define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
	400	#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
	401	#define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
	402	#define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
	403	#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
	404	#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
	405	#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
	406	#define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
efe556ad	407	#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
ab99e5c1	408	#define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
e06679fb AL	409	#define VNC_ENCODING_WMVi 0x574D5669
	410
	411	/*****************************************************************************
	412	*
	413	* Other tight constants
	414	*
	415	*****************************************************************************/
	416
	417	/*
	418	* Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
	419	*/
	420
	421	#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
	422	#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
	423	#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
	424	#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
efe556ad	425	#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
e06679fb AL	426	#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
	427	#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
	428	#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
	429
	430	/*****************************************************************************
	431	*
	432	* Features
	433	*
	434	*****************************************************************************/
	435
	436	#define VNC_FEATURE_RESIZE 0
	437	#define VNC_FEATURE_HEXTILE 1
	438	#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
	439	#define VNC_FEATURE_WMVI 3
	440	#define VNC_FEATURE_TIGHT 4
	441	#define VNC_FEATURE_ZLIB 5
753b4053	442	#define VNC_FEATURE_COPYRECT 6
d467b679	443	#define VNC_FEATURE_RICH_CURSOR 7
efe556ad	444	#define VNC_FEATURE_TIGHT_PNG 8
148954fa CC	445	#define VNC_FEATURE_ZRLE 9
148954fa CC	446	#define VNC_FEATURE_ZYWRLE 10
ab99e5c1	447	#define VNC_FEATURE_LED_STATE 11
e06679fb AL	448
	449	#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
	450	#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
	451	#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
	452	#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
	453	#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
	454	#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
753b4053	455	#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
d467b679	456	#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
efe556ad	457	#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
148954fa CC	458	#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
148954fa CC	459	#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
ab99e5c1	460	#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
e06679fb	461
5fb6c7a8	462
46a183da DB	463	/* Client -> Server message IDs */
	464	#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
	465	#define VNC_MSG_CLIENT_SET_ENCODINGS 2
	466	#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
	467	#define VNC_MSG_CLIENT_KEY_EVENT 4
	468	#define VNC_MSG_CLIENT_POINTER_EVENT 5
	469	#define VNC_MSG_CLIENT_CUT_TEXT 6
	470	#define VNC_MSG_CLIENT_VMWARE_0 127
	471	#define VNC_MSG_CLIENT_CALL_CONTROL 249
	472	#define VNC_MSG_CLIENT_XVP 250
	473	#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
	474	#define VNC_MSG_CLIENT_TIGHT 252
	475	#define VNC_MSG_CLIENT_GII 253
	476	#define VNC_MSG_CLIENT_VMWARE_1 254
	477	#define VNC_MSG_CLIENT_QEMU 255
	478
	479	/* Server -> Client message IDs */
	480	#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
	481	#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
	482	#define VNC_MSG_SERVER_BELL 2
	483	#define VNC_MSG_SERVER_CUT_TEXT 3
	484	#define VNC_MSG_SERVER_VMWARE_0 127
	485	#define VNC_MSG_SERVER_CALL_CONTROL 249
	486	#define VNC_MSG_SERVER_XVP 250
	487	#define VNC_MSG_SERVER_TIGHT 252
	488	#define VNC_MSG_SERVER_GII 253
	489	#define VNC_MSG_SERVER_VMWARE_1 254
	490	#define VNC_MSG_SERVER_QEMU 255
	491
	492
	493
	494	/* QEMU client -> server message IDs */
	495	#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
	496	#define VNC_MSG_CLIENT_QEMU_AUDIO 1
	497
	498	/* QEMU server -> client message IDs */
	499	#define VNC_MSG_SERVER_QEMU_AUDIO 1
	500
	501
	502
	503	/* QEMU client -> server audio message IDs */
	504	#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
	505	#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
	506	#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
	507
	508	/* QEMU server -> client audio message IDs */
	509	#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
	510	#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
	511	#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
	512
	513
5fb6c7a8 AL	514	/*****************************************************************************
	515	*
	516	* Internal APIs
	517	*
	518	*****************************************************************************/
	519
	520	/* Event loop functions */
	521	void vnc_client_read(void *opaque);
	522	void vnc_client_write(void *opaque);
	523
2f9606b3 AL	524	long vnc_client_read_buf(VncState vs, uint8_t data, size_t datalen);
2f9606b3 AL	525	long vnc_client_write_buf(VncState vs, const uint8_t data, size_t datalen);
5fb6c7a8 AL	526
	527	/* Protocol I/O functions */
	528	void vnc_write(VncState vs, const void data, size_t len);
	529	void vnc_write_u32(VncState *vs, uint32_t value);
	530	void vnc_write_s32(VncState *vs, int32_t value);
	531	void vnc_write_u16(VncState *vs, uint16_t value);
	532	void vnc_write_u8(VncState *vs, uint8_t value);
	533	void vnc_flush(VncState *vs);
	534	void vnc_read_when(VncState vs, VncReadEvent func, size_t expecting);
7536ee4b TH	535	void vnc_disconnect_finish(VncState *vs);
7536ee4b TH	536	void vnc_init_state(VncState *vs);
5fb6c7a8 AL	537
	538
	539	/* Buffer I/O functions */
5fb6c7a8 AL	540	uint32_t read_u32(uint8_t *data, size_t offset);
	541
	542	/* Protocol stage functions */
	543	void vnc_client_error(VncState *vs);
2f9606b3	544	int vnc_client_io_error(VncState *vs, int ret, int last_errno);
5fb6c7a8 AL	545
	546	void start_client_init(VncState *vs);
	547	void start_auth_vnc(VncState *vs);
	548
2f9606b3 AL	549	/* Buffer management */
2f9606b3 AL	550	void buffer_reserve(Buffer *buffer, size_t len);
2f9606b3	551	void buffer_reset(Buffer *buffer);
5d418e3b	552	void buffer_free(Buffer *buffer);
2f9606b3	553	void buffer_append(Buffer buffer, const void data, size_t len);
32ed2680	554	void buffer_advance(Buffer *buf, size_t len);
7536ee4b	555	uint8_t buffer_end(Buffer buffer);
2f9606b3 AL	556
	557
	558	/* Misc helpers */
	559
	560	char vnc_socket_local_addr(const char format, int fd);
	561	char vnc_socket_remote_addr(const char format, int fd);
	562
efe556ad CC	563	static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
	564	return (vs->features & (1 << feature));
	565	}
	566
70a4568f CC	567	/* Framebuffer */
	568	void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
	569	int32_t encoding);
	570
9f64916d GH	571	/* server fb is in PIXMAN_x8r8g8b8 */
	572	#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
	573	#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
	574	#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
	575
	576	void vnc_server_fb_ptr(VncDisplay vd, int x, int y);
	577	int vnc_server_fb_stride(VncDisplay *vd);
	578
70a4568f	579	void vnc_convert_pixel(VncState vs, uint8_t buf, uint32_t v);
999342a0	580	double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
7d964c9d	581	void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
70a4568f CC	582
70a4568f CC	583	/* Encodings */
bd023f95 CC	584	int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
bd023f95 CC	585
a885211e	586	int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
70a4568f	587
a885211e	588	int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
70a4568f CC	589	int y, int w, int h);
	590	void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
	591
380282b0 CC	592	void vnc_zlib_zalloc(void x, unsigned items, unsigned size);
380282b0 CC	593	void vnc_zlib_zfree(void x, void addr);
a885211e	594	int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
161c4f20	595	void vnc_zlib_clear(VncState *vs);
70a4568f	596
380282b0	597	int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
efe556ad CC	598	int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
efe556ad CC	599	int w, int h);
380282b0 CC	600	void vnc_tight_clear(VncState *vs);
380282b0 CC	601
148954fa CC	602	int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	603	int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	604	void vnc_zrle_clear(VncState *vs);
	605
19a490bf	606	#endif /* __QEMU_VNC_H */