13e230dd2SCorentin Chary /* 23e230dd2SCorentin Chary * QEMU VNC display driver 33e230dd2SCorentin Chary * 43e230dd2SCorentin Chary * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws> 53e230dd2SCorentin Chary * Copyright (C) 2006 Fabrice Bellard 63e230dd2SCorentin Chary * Copyright (C) 2009 Red Hat, Inc 73e230dd2SCorentin Chary * 83e230dd2SCorentin Chary * Permission is hereby granted, free of charge, to any person obtaining a copy 93e230dd2SCorentin Chary * of this software and associated documentation files (the "Software"), to deal 103e230dd2SCorentin Chary * in the Software without restriction, including without limitation the rights 113e230dd2SCorentin Chary * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 123e230dd2SCorentin Chary * copies of the Software, and to permit persons to whom the Software is 133e230dd2SCorentin Chary * furnished to do so, subject to the following conditions: 143e230dd2SCorentin Chary * 153e230dd2SCorentin Chary * The above copyright notice and this permission notice shall be included in 163e230dd2SCorentin Chary * all copies or substantial portions of the Software. 173e230dd2SCorentin Chary * 183e230dd2SCorentin Chary * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 193e230dd2SCorentin Chary * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 203e230dd2SCorentin Chary * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 213e230dd2SCorentin Chary * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 223e230dd2SCorentin Chary * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 233e230dd2SCorentin Chary * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 243e230dd2SCorentin Chary * THE SOFTWARE. 253e230dd2SCorentin Chary */ 263e230dd2SCorentin Chary 273e230dd2SCorentin Chary #ifndef __QEMU_VNC_H 283e230dd2SCorentin Chary #define __QEMU_VNC_H 293e230dd2SCorentin Chary 303e230dd2SCorentin Chary #include "qemu-common.h" 313e230dd2SCorentin Chary #include "qemu-queue.h" 32bd023f95SCorentin Chary #ifdef CONFIG_VNC_THREAD 33bd023f95SCorentin Chary #include "qemu-thread.h" 34bd023f95SCorentin Chary #endif 353e230dd2SCorentin Chary #include "console.h" 363e230dd2SCorentin Chary #include "monitor.h" 373e230dd2SCorentin Chary #include "audio/audio.h" 38bc2429b9SCorentin Chary #include "bitmap.h" 393e230dd2SCorentin Chary #include <zlib.h> 403e230dd2SCorentin Chary #include <stdbool.h> 413e230dd2SCorentin Chary 423e230dd2SCorentin Chary #include "keymaps.h" 43148954faSCorentin Chary #include "vnc-palette.h" 44148954faSCorentin Chary #include "vnc-enc-zrle.h" 453e230dd2SCorentin Chary 463e230dd2SCorentin Chary // #define _VNC_DEBUG 1 473e230dd2SCorentin Chary 483e230dd2SCorentin Chary #ifdef _VNC_DEBUG 493e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0) 503e230dd2SCorentin Chary #else 513e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { } while (0) 523e230dd2SCorentin Chary #endif 533e230dd2SCorentin Chary 543e230dd2SCorentin Chary /***************************************************************************** 553e230dd2SCorentin Chary * 563e230dd2SCorentin Chary * Core data structures 573e230dd2SCorentin Chary * 583e230dd2SCorentin Chary *****************************************************************************/ 593e230dd2SCorentin Chary 603e230dd2SCorentin Chary typedef struct Buffer 613e230dd2SCorentin Chary { 623e230dd2SCorentin Chary size_t capacity; 633e230dd2SCorentin Chary size_t offset; 643e230dd2SCorentin Chary uint8_t *buffer; 653e230dd2SCorentin Chary } Buffer; 663e230dd2SCorentin Chary 673e230dd2SCorentin Chary typedef struct VncState VncState; 68bd023f95SCorentin Chary typedef struct VncJob VncJob; 69bd023f95SCorentin Chary typedef struct VncRect VncRect; 70bd023f95SCorentin Chary typedef struct VncRectEntry VncRectEntry; 713e230dd2SCorentin Chary 723e230dd2SCorentin Chary typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len); 733e230dd2SCorentin Chary 743e230dd2SCorentin Chary typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size); 753e230dd2SCorentin Chary 763e230dd2SCorentin Chary typedef void VncSendHextileTile(VncState *vs, 773e230dd2SCorentin Chary int x, int y, int w, int h, 783e230dd2SCorentin Chary void *last_bg, 793e230dd2SCorentin Chary void *last_fg, 803e230dd2SCorentin Chary int *has_bg, int *has_fg); 813e230dd2SCorentin Chary 8223bfe28fSStefan Weil /* VNC_MAX_WIDTH must be a multiple of 16. */ 833e230dd2SCorentin Chary #define VNC_MAX_WIDTH 2560 843e230dd2SCorentin Chary #define VNC_MAX_HEIGHT 2048 8523bfe28fSStefan Weil 8623bfe28fSStefan Weil /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */ 8723bfe28fSStefan Weil #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / 16) 883e230dd2SCorentin Chary 89999342a0SCorentin Chary #define VNC_STAT_RECT 64 90999342a0SCorentin Chary #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT) 91999342a0SCorentin Chary #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT) 92999342a0SCorentin Chary 933e230dd2SCorentin Chary #define VNC_AUTH_CHALLENGE_SIZE 16 943e230dd2SCorentin Chary 953e230dd2SCorentin Chary typedef struct VncDisplay VncDisplay; 963e230dd2SCorentin Chary 973e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 983e230dd2SCorentin Chary #include "vnc-tls.h" 993e230dd2SCorentin Chary #include "vnc-auth-vencrypt.h" 1003e230dd2SCorentin Chary #endif 1013e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1023e230dd2SCorentin Chary #include "vnc-auth-sasl.h" 1033e230dd2SCorentin Chary #endif 1043e230dd2SCorentin Chary 105999342a0SCorentin Chary struct VncRectStat 106999342a0SCorentin Chary { 107999342a0SCorentin Chary /* time of last 10 updates, to find update frequency */ 108999342a0SCorentin Chary struct timeval times[10]; 109999342a0SCorentin Chary int idx; 110999342a0SCorentin Chary 111999342a0SCorentin Chary double freq; /* Update frequency (in Hz) */ 112999342a0SCorentin Chary bool updated; /* Already updated during this refresh */ 113999342a0SCorentin Chary }; 114999342a0SCorentin Chary 115999342a0SCorentin Chary typedef struct VncRectStat VncRectStat; 116999342a0SCorentin Chary 1173e230dd2SCorentin Chary struct VncSurface 1183e230dd2SCorentin Chary { 119999342a0SCorentin Chary struct timeval last_freq_check; 12023bfe28fSStefan Weil DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_MAX_WIDTH / 16); 121999342a0SCorentin Chary VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS]; 1223e230dd2SCorentin Chary DisplaySurface *ds; 1233e230dd2SCorentin Chary }; 1243e230dd2SCorentin Chary 125*8cf36489SGerd Hoffmann typedef enum VncShareMode { 126*8cf36489SGerd Hoffmann VNC_SHARE_MODE_CONNECTING = 1, 127*8cf36489SGerd Hoffmann VNC_SHARE_MODE_SHARED, 128*8cf36489SGerd Hoffmann VNC_SHARE_MODE_EXCLUSIVE, 129*8cf36489SGerd Hoffmann VNC_SHARE_MODE_DISCONNECTED, 130*8cf36489SGerd Hoffmann } VncShareMode; 131*8cf36489SGerd Hoffmann 132*8cf36489SGerd Hoffmann typedef enum VncSharePolicy { 133*8cf36489SGerd Hoffmann VNC_SHARE_POLICY_IGNORE = 1, 134*8cf36489SGerd Hoffmann VNC_SHARE_POLICY_ALLOW_EXCLUSIVE, 135*8cf36489SGerd Hoffmann VNC_SHARE_POLICY_FORCE_SHARED, 136*8cf36489SGerd Hoffmann } VncSharePolicy; 137*8cf36489SGerd Hoffmann 1383e230dd2SCorentin Chary struct VncDisplay 1393e230dd2SCorentin Chary { 1403e230dd2SCorentin Chary QTAILQ_HEAD(, VncState) clients; 141*8cf36489SGerd Hoffmann int num_exclusive; 142*8cf36489SGerd Hoffmann VncSharePolicy share_policy; 1433e230dd2SCorentin Chary QEMUTimer *timer; 1443e230dd2SCorentin Chary int timer_interval; 1453e230dd2SCorentin Chary int lsock; 1463e230dd2SCorentin Chary DisplayState *ds; 1473e230dd2SCorentin Chary kbd_layout_t *kbd_layout; 1483e230dd2SCorentin Chary int lock_key_sync; 149bd023f95SCorentin Chary #ifdef CONFIG_VNC_THREAD 150bd023f95SCorentin Chary QemuMutex mutex; 151bd023f95SCorentin Chary #endif 1523e230dd2SCorentin Chary 1533e230dd2SCorentin Chary QEMUCursor *cursor; 1543e230dd2SCorentin Chary int cursor_msize; 1553e230dd2SCorentin Chary uint8_t *cursor_mask; 1563e230dd2SCorentin Chary 1573e230dd2SCorentin Chary struct VncSurface guest; /* guest visible surface (aka ds->surface) */ 1583e230dd2SCorentin Chary DisplaySurface *server; /* vnc server surface */ 1593e230dd2SCorentin Chary 1603e230dd2SCorentin Chary char *display; 1613e230dd2SCorentin Chary char *password; 1623c9405a0SGerd Hoffmann time_t expires; 1633e230dd2SCorentin Chary int auth; 1643e230dd2SCorentin Chary bool lossy; 16580e0c8c3SCorentin Chary bool non_adaptive; 1663e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 1673e230dd2SCorentin Chary int subauth; /* Used by VeNCrypt */ 1683e230dd2SCorentin Chary VncDisplayTLS tls; 1693e230dd2SCorentin Chary #endif 1703e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1713e230dd2SCorentin Chary VncDisplaySASL sasl; 1723e230dd2SCorentin Chary #endif 1733e230dd2SCorentin Chary }; 1743e230dd2SCorentin Chary 175d1af0e05SCorentin Chary typedef struct VncTight { 176d1af0e05SCorentin Chary int type; 177d1af0e05SCorentin Chary uint8_t quality; 178d1af0e05SCorentin Chary uint8_t compression; 179d1af0e05SCorentin Chary uint8_t pixel24; 180d1af0e05SCorentin Chary Buffer tight; 181d1af0e05SCorentin Chary Buffer tmp; 182d1af0e05SCorentin Chary Buffer zlib; 183d1af0e05SCorentin Chary Buffer gradient; 184d1af0e05SCorentin Chary #ifdef CONFIG_VNC_JPEG 185d1af0e05SCorentin Chary Buffer jpeg; 186d1af0e05SCorentin Chary #endif 187d1af0e05SCorentin Chary #ifdef CONFIG_VNC_PNG 188d1af0e05SCorentin Chary Buffer png; 189d1af0e05SCorentin Chary #endif 190d1af0e05SCorentin Chary int levels[4]; 191d1af0e05SCorentin Chary z_stream stream[4]; 192d1af0e05SCorentin Chary } VncTight; 193d1af0e05SCorentin Chary 194d1af0e05SCorentin Chary typedef struct VncHextile { 195d1af0e05SCorentin Chary VncSendHextileTile *send_tile; 196d1af0e05SCorentin Chary } VncHextile; 197d1af0e05SCorentin Chary 198d1af0e05SCorentin Chary typedef struct VncZlib { 199d1af0e05SCorentin Chary Buffer zlib; 200d1af0e05SCorentin Chary Buffer tmp; 201d1af0e05SCorentin Chary z_stream stream; 202d1af0e05SCorentin Chary int level; 203d1af0e05SCorentin Chary } VncZlib; 204d1af0e05SCorentin Chary 205148954faSCorentin Chary typedef struct VncZrle { 206148954faSCorentin Chary int type; 207148954faSCorentin Chary Buffer fb; 208148954faSCorentin Chary Buffer zrle; 209148954faSCorentin Chary Buffer tmp; 210148954faSCorentin Chary Buffer zlib; 211148954faSCorentin Chary z_stream stream; 212148954faSCorentin Chary VncPalette palette; 213148954faSCorentin Chary } VncZrle; 214148954faSCorentin Chary 215148954faSCorentin Chary typedef struct VncZywrle { 216148954faSCorentin Chary int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT]; 217148954faSCorentin Chary } VncZywrle; 218148954faSCorentin Chary 219bd023f95SCorentin Chary #ifdef CONFIG_VNC_THREAD 220bd023f95SCorentin Chary struct VncRect 221bd023f95SCorentin Chary { 222bd023f95SCorentin Chary int x; 223bd023f95SCorentin Chary int y; 224bd023f95SCorentin Chary int w; 225bd023f95SCorentin Chary int h; 226bd023f95SCorentin Chary }; 227bd023f95SCorentin Chary 228bd023f95SCorentin Chary struct VncRectEntry 229bd023f95SCorentin Chary { 230bd023f95SCorentin Chary struct VncRect rect; 231bd023f95SCorentin Chary QLIST_ENTRY(VncRectEntry) next; 232bd023f95SCorentin Chary }; 233bd023f95SCorentin Chary 234bd023f95SCorentin Chary struct VncJob 235bd023f95SCorentin Chary { 236bd023f95SCorentin Chary VncState *vs; 237bd023f95SCorentin Chary 238bd023f95SCorentin Chary QLIST_HEAD(, VncRectEntry) rectangles; 239bd023f95SCorentin Chary QTAILQ_ENTRY(VncJob) next; 240bd023f95SCorentin Chary }; 241bd023f95SCorentin Chary #else 242bd023f95SCorentin Chary struct VncJob 243bd023f95SCorentin Chary { 244bd023f95SCorentin Chary VncState *vs; 245bd023f95SCorentin Chary int rectangles; 246bd023f95SCorentin Chary size_t saved_offset; 247bd023f95SCorentin Chary }; 248bd023f95SCorentin Chary #endif 249bd023f95SCorentin Chary 2503e230dd2SCorentin Chary struct VncState 2513e230dd2SCorentin Chary { 2523e230dd2SCorentin Chary int csock; 2533e230dd2SCorentin Chary 2543e230dd2SCorentin Chary DisplayState *ds; 25523bfe28fSStefan Weil DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS); 2567d964c9dSCorentin Chary uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in 2577d964c9dSCorentin Chary * vnc-jobs-async.c */ 2583e230dd2SCorentin Chary 2593e230dd2SCorentin Chary VncDisplay *vd; 2603e230dd2SCorentin Chary int need_update; 2613e230dd2SCorentin Chary int force_update; 2623e230dd2SCorentin Chary uint32_t features; 2633e230dd2SCorentin Chary int absolute; 2643e230dd2SCorentin Chary int last_x; 2653e230dd2SCorentin Chary int last_y; 2663e230dd2SCorentin Chary int client_width; 2673e230dd2SCorentin Chary int client_height; 268*8cf36489SGerd Hoffmann VncShareMode share_mode; 2693e230dd2SCorentin Chary 2703e230dd2SCorentin Chary uint32_t vnc_encoding; 2713e230dd2SCorentin Chary 2723e230dd2SCorentin Chary int major; 2733e230dd2SCorentin Chary int minor; 2743e230dd2SCorentin Chary 2757e7e2ebcSDaniel P. Berrange int auth; 2763e230dd2SCorentin Chary char challenge[VNC_AUTH_CHALLENGE_SIZE]; 2773e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 2787e7e2ebcSDaniel P. Berrange int subauth; /* Used by VeNCrypt */ 2793e230dd2SCorentin Chary VncStateTLS tls; 2803e230dd2SCorentin Chary #endif 2813e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 2823e230dd2SCorentin Chary VncStateSASL sasl; 2833e230dd2SCorentin Chary #endif 2843e230dd2SCorentin Chary 2853e230dd2SCorentin Chary QObject *info; 2863e230dd2SCorentin Chary 2873e230dd2SCorentin Chary Buffer output; 2883e230dd2SCorentin Chary Buffer input; 2893e230dd2SCorentin Chary /* current output mode information */ 2903e230dd2SCorentin Chary VncWritePixels *write_pixels; 2913e230dd2SCorentin Chary DisplaySurface clientds; 2923e230dd2SCorentin Chary 2933e230dd2SCorentin Chary CaptureVoiceOut *audio_cap; 2943e230dd2SCorentin Chary struct audsettings as; 2953e230dd2SCorentin Chary 2963e230dd2SCorentin Chary VncReadEvent *read_handler; 2973e230dd2SCorentin Chary size_t read_handler_expect; 2983e230dd2SCorentin Chary /* input */ 2993e230dd2SCorentin Chary uint8_t modifiers_state[256]; 3003e230dd2SCorentin Chary QEMUPutLEDEntry *led; 3013e230dd2SCorentin Chary 302bd023f95SCorentin Chary bool abort; 303bd023f95SCorentin Chary #ifndef CONFIG_VNC_THREAD 304bd023f95SCorentin Chary VncJob job; 305bd023f95SCorentin Chary #else 306bd023f95SCorentin Chary QemuMutex output_mutex; 307bd023f95SCorentin Chary #endif 308bd023f95SCorentin Chary 309bd023f95SCorentin Chary /* Encoding specific, if you add something here, don't forget to 310bd023f95SCorentin Chary * update vnc_async_encoding_start() 311bd023f95SCorentin Chary */ 312d1af0e05SCorentin Chary VncTight tight; 313d1af0e05SCorentin Chary VncZlib zlib; 314d1af0e05SCorentin Chary VncHextile hextile; 315148954faSCorentin Chary VncZrle zrle; 316148954faSCorentin Chary VncZywrle zywrle; 3173e230dd2SCorentin Chary 3183e230dd2SCorentin Chary Notifier mouse_mode_notifier; 3193e230dd2SCorentin Chary 3203e230dd2SCorentin Chary QTAILQ_ENTRY(VncState) next; 3213e230dd2SCorentin Chary }; 3223e230dd2SCorentin Chary 3233e230dd2SCorentin Chary 3243e230dd2SCorentin Chary /***************************************************************************** 3253e230dd2SCorentin Chary * 3263e230dd2SCorentin Chary * Authentication modes 3273e230dd2SCorentin Chary * 3283e230dd2SCorentin Chary *****************************************************************************/ 3293e230dd2SCorentin Chary 3303e230dd2SCorentin Chary enum { 3313e230dd2SCorentin Chary VNC_AUTH_INVALID = 0, 3323e230dd2SCorentin Chary VNC_AUTH_NONE = 1, 3333e230dd2SCorentin Chary VNC_AUTH_VNC = 2, 3343e230dd2SCorentin Chary VNC_AUTH_RA2 = 5, 3353e230dd2SCorentin Chary VNC_AUTH_RA2NE = 6, 3363e230dd2SCorentin Chary VNC_AUTH_TIGHT = 16, 3373e230dd2SCorentin Chary VNC_AUTH_ULTRA = 17, 3383e230dd2SCorentin Chary VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */ 3393e230dd2SCorentin Chary VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */ 3403e230dd2SCorentin Chary VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */ 3413e230dd2SCorentin Chary }; 3423e230dd2SCorentin Chary 3433e230dd2SCorentin Chary enum { 3443e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_PLAIN = 256, 3453e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSNONE = 257, 3463e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSVNC = 258, 3473e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSPLAIN = 259, 3483e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509NONE = 260, 3493e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509VNC = 261, 3503e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509PLAIN = 262, 3513e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509SASL = 263, 3523e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSSASL = 264, 3533e230dd2SCorentin Chary }; 3543e230dd2SCorentin Chary 3553e230dd2SCorentin Chary 3563e230dd2SCorentin Chary /***************************************************************************** 3573e230dd2SCorentin Chary * 3583e230dd2SCorentin Chary * Encoding types 3593e230dd2SCorentin Chary * 3603e230dd2SCorentin Chary *****************************************************************************/ 3613e230dd2SCorentin Chary 3623e230dd2SCorentin Chary #define VNC_ENCODING_RAW 0x00000000 3633e230dd2SCorentin Chary #define VNC_ENCODING_COPYRECT 0x00000001 3643e230dd2SCorentin Chary #define VNC_ENCODING_RRE 0x00000002 3653e230dd2SCorentin Chary #define VNC_ENCODING_CORRE 0x00000004 3663e230dd2SCorentin Chary #define VNC_ENCODING_HEXTILE 0x00000005 3673e230dd2SCorentin Chary #define VNC_ENCODING_ZLIB 0x00000006 3683e230dd2SCorentin Chary #define VNC_ENCODING_TIGHT 0x00000007 3693e230dd2SCorentin Chary #define VNC_ENCODING_ZLIBHEX 0x00000008 3703e230dd2SCorentin Chary #define VNC_ENCODING_TRLE 0x0000000f 3713e230dd2SCorentin Chary #define VNC_ENCODING_ZRLE 0x00000010 3723e230dd2SCorentin Chary #define VNC_ENCODING_ZYWRLE 0x00000011 3733e230dd2SCorentin Chary #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */ 3743e230dd2SCorentin Chary #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */ 3753e230dd2SCorentin Chary #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */ 3763e230dd2SCorentin Chary #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */ 3773e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */ 3783e230dd2SCorentin Chary #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */ 3793e230dd2SCorentin Chary #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */ 3803e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */ 3813e230dd2SCorentin Chary #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */ 3823e230dd2SCorentin Chary #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */ 383efe556adSCorentin Chary #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */ 3843e230dd2SCorentin Chary #define VNC_ENCODING_WMVi 0x574D5669 3853e230dd2SCorentin Chary 3863e230dd2SCorentin Chary /***************************************************************************** 3873e230dd2SCorentin Chary * 3883e230dd2SCorentin Chary * Other tight constants 3893e230dd2SCorentin Chary * 3903e230dd2SCorentin Chary *****************************************************************************/ 3913e230dd2SCorentin Chary 3923e230dd2SCorentin Chary /* 3933e230dd2SCorentin Chary * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC. 3943e230dd2SCorentin Chary */ 3953e230dd2SCorentin Chary 3963e230dd2SCorentin Chary #define VNC_TIGHT_CCB_RESET_MASK (0x0f) 3973e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4) 3983e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4) 3993e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4) 400efe556adSCorentin Chary #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4) 4013e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4) 4023e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4) 4033e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4) 4043e230dd2SCorentin Chary 4053e230dd2SCorentin Chary /***************************************************************************** 4063e230dd2SCorentin Chary * 4073e230dd2SCorentin Chary * Features 4083e230dd2SCorentin Chary * 4093e230dd2SCorentin Chary *****************************************************************************/ 4103e230dd2SCorentin Chary 4113e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE 0 4123e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE 1 4133e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE 2 4143e230dd2SCorentin Chary #define VNC_FEATURE_WMVI 3 4153e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT 4 4163e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB 5 4173e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT 6 4183e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR 7 419efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG 8 420148954faSCorentin Chary #define VNC_FEATURE_ZRLE 9 421148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE 10 4223e230dd2SCorentin Chary 4233e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE) 4243e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE) 4253e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE) 4263e230dd2SCorentin Chary #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI) 4273e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT) 4283e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB) 4293e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT) 4303e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR) 431efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG) 432148954faSCorentin Chary #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE) 433148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE) 4343e230dd2SCorentin Chary 4353e230dd2SCorentin Chary 4363e230dd2SCorentin Chary /* Client -> Server message IDs */ 4373e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0 4383e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_ENCODINGS 2 4393e230dd2SCorentin Chary #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3 4403e230dd2SCorentin Chary #define VNC_MSG_CLIENT_KEY_EVENT 4 4413e230dd2SCorentin Chary #define VNC_MSG_CLIENT_POINTER_EVENT 5 4423e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CUT_TEXT 6 4433e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_0 127 4443e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CALL_CONTROL 249 4453e230dd2SCorentin Chary #define VNC_MSG_CLIENT_XVP 250 4463e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251 4473e230dd2SCorentin Chary #define VNC_MSG_CLIENT_TIGHT 252 4483e230dd2SCorentin Chary #define VNC_MSG_CLIENT_GII 253 4493e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_1 254 4503e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU 255 4513e230dd2SCorentin Chary 4523e230dd2SCorentin Chary /* Server -> Client message IDs */ 4533e230dd2SCorentin Chary #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0 4543e230dd2SCorentin Chary #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1 4553e230dd2SCorentin Chary #define VNC_MSG_SERVER_BELL 2 4563e230dd2SCorentin Chary #define VNC_MSG_SERVER_CUT_TEXT 3 4573e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_0 127 4583e230dd2SCorentin Chary #define VNC_MSG_SERVER_CALL_CONTROL 249 4593e230dd2SCorentin Chary #define VNC_MSG_SERVER_XVP 250 4603e230dd2SCorentin Chary #define VNC_MSG_SERVER_TIGHT 252 4613e230dd2SCorentin Chary #define VNC_MSG_SERVER_GII 253 4623e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_1 254 4633e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU 255 4643e230dd2SCorentin Chary 4653e230dd2SCorentin Chary 4663e230dd2SCorentin Chary 4673e230dd2SCorentin Chary /* QEMU client -> server message IDs */ 4683e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0 4693e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO 1 4703e230dd2SCorentin Chary 4713e230dd2SCorentin Chary /* QEMU server -> client message IDs */ 4723e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO 1 4733e230dd2SCorentin Chary 4743e230dd2SCorentin Chary 4753e230dd2SCorentin Chary 4763e230dd2SCorentin Chary /* QEMU client -> server audio message IDs */ 4773e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0 4783e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1 4793e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2 4803e230dd2SCorentin Chary 4813e230dd2SCorentin Chary /* QEMU server -> client audio message IDs */ 4823e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_END 0 4833e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1 4843e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2 4853e230dd2SCorentin Chary 4863e230dd2SCorentin Chary 4873e230dd2SCorentin Chary /***************************************************************************** 4883e230dd2SCorentin Chary * 4893e230dd2SCorentin Chary * Internal APIs 4903e230dd2SCorentin Chary * 4913e230dd2SCorentin Chary *****************************************************************************/ 4923e230dd2SCorentin Chary 4933e230dd2SCorentin Chary /* Event loop functions */ 4943e230dd2SCorentin Chary void vnc_client_read(void *opaque); 4953e230dd2SCorentin Chary void vnc_client_write(void *opaque); 4963e230dd2SCorentin Chary 4973e230dd2SCorentin Chary long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen); 4983e230dd2SCorentin Chary long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen); 4993e230dd2SCorentin Chary 5003e230dd2SCorentin Chary /* Protocol I/O functions */ 5013e230dd2SCorentin Chary void vnc_write(VncState *vs, const void *data, size_t len); 5023e230dd2SCorentin Chary void vnc_write_u32(VncState *vs, uint32_t value); 5033e230dd2SCorentin Chary void vnc_write_s32(VncState *vs, int32_t value); 5043e230dd2SCorentin Chary void vnc_write_u16(VncState *vs, uint16_t value); 5053e230dd2SCorentin Chary void vnc_write_u8(VncState *vs, uint8_t value); 5063e230dd2SCorentin Chary void vnc_flush(VncState *vs); 5073e230dd2SCorentin Chary void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting); 5083e230dd2SCorentin Chary 5093e230dd2SCorentin Chary 5103e230dd2SCorentin Chary /* Buffer I/O functions */ 5113e230dd2SCorentin Chary uint8_t read_u8(uint8_t *data, size_t offset); 5123e230dd2SCorentin Chary uint16_t read_u16(uint8_t *data, size_t offset); 5133e230dd2SCorentin Chary int32_t read_s32(uint8_t *data, size_t offset); 5143e230dd2SCorentin Chary uint32_t read_u32(uint8_t *data, size_t offset); 5153e230dd2SCorentin Chary 5163e230dd2SCorentin Chary /* Protocol stage functions */ 5173e230dd2SCorentin Chary void vnc_client_error(VncState *vs); 5183e230dd2SCorentin Chary int vnc_client_io_error(VncState *vs, int ret, int last_errno); 5193e230dd2SCorentin Chary 5203e230dd2SCorentin Chary void start_client_init(VncState *vs); 5213e230dd2SCorentin Chary void start_auth_vnc(VncState *vs); 5223e230dd2SCorentin Chary 5233e230dd2SCorentin Chary /* Buffer management */ 5243e230dd2SCorentin Chary void buffer_reserve(Buffer *buffer, size_t len); 5253e230dd2SCorentin Chary int buffer_empty(Buffer *buffer); 5263e230dd2SCorentin Chary uint8_t *buffer_end(Buffer *buffer); 5273e230dd2SCorentin Chary void buffer_reset(Buffer *buffer); 5283e230dd2SCorentin Chary void buffer_free(Buffer *buffer); 5293e230dd2SCorentin Chary void buffer_append(Buffer *buffer, const void *data, size_t len); 5303e230dd2SCorentin Chary 5313e230dd2SCorentin Chary 5323e230dd2SCorentin Chary /* Misc helpers */ 5333e230dd2SCorentin Chary 5343e230dd2SCorentin Chary char *vnc_socket_local_addr(const char *format, int fd); 5353e230dd2SCorentin Chary char *vnc_socket_remote_addr(const char *format, int fd); 5363e230dd2SCorentin Chary 537efe556adSCorentin Chary static inline uint32_t vnc_has_feature(VncState *vs, int feature) { 538efe556adSCorentin Chary return (vs->features & (1 << feature)); 539efe556adSCorentin Chary } 540efe556adSCorentin Chary 5413e230dd2SCorentin Chary /* Framebuffer */ 5423e230dd2SCorentin Chary void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h, 5433e230dd2SCorentin Chary int32_t encoding); 5443e230dd2SCorentin Chary 5453e230dd2SCorentin Chary void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v); 546999342a0SCorentin Chary double vnc_update_freq(VncState *vs, int x, int y, int w, int h); 5477d964c9dSCorentin Chary void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h); 5483e230dd2SCorentin Chary 5493e230dd2SCorentin Chary /* Encodings */ 550bd023f95SCorentin Chary int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 551bd023f95SCorentin Chary 5523e230dd2SCorentin Chary int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 5533e230dd2SCorentin Chary 5543e230dd2SCorentin Chary int vnc_hextile_send_framebuffer_update(VncState *vs, int x, 5553e230dd2SCorentin Chary int y, int w, int h); 5563e230dd2SCorentin Chary void vnc_hextile_set_pixel_conversion(VncState *vs, int generic); 5573e230dd2SCorentin Chary 5583e230dd2SCorentin Chary void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size); 5593e230dd2SCorentin Chary void vnc_zlib_zfree(void *x, void *addr); 5603e230dd2SCorentin Chary int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 5613e230dd2SCorentin Chary void vnc_zlib_clear(VncState *vs); 5623e230dd2SCorentin Chary 5633e230dd2SCorentin Chary int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 564efe556adSCorentin Chary int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y, 565efe556adSCorentin Chary int w, int h); 5663e230dd2SCorentin Chary void vnc_tight_clear(VncState *vs); 5673e230dd2SCorentin Chary 568148954faSCorentin Chary int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 569148954faSCorentin Chary int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 570148954faSCorentin Chary void vnc_zrle_clear(VncState *vs); 571148954faSCorentin Chary 5723e230dd2SCorentin Chary #endif /* __QEMU_VNC_H */ 573