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" 311de7afc9SPaolo Bonzini #include "qemu/queue.h" 321de7afc9SPaolo Bonzini #include "qemu/thread.h" 3328ecbaeeSPaolo Bonzini #include "ui/console.h" 3483c9089eSPaolo Bonzini #include "monitor/monitor.h" 353e230dd2SCorentin Chary #include "audio/audio.h" 361de7afc9SPaolo Bonzini #include "qemu/bitmap.h" 373e230dd2SCorentin Chary #include <zlib.h> 383e230dd2SCorentin Chary #include <stdbool.h> 393e230dd2SCorentin Chary 403e230dd2SCorentin Chary #include "keymaps.h" 41148954faSCorentin Chary #include "vnc-palette.h" 42148954faSCorentin Chary #include "vnc-enc-zrle.h" 433e230dd2SCorentin Chary 443e230dd2SCorentin Chary // #define _VNC_DEBUG 1 453e230dd2SCorentin Chary 463e230dd2SCorentin Chary #ifdef _VNC_DEBUG 473e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0) 483e230dd2SCorentin Chary #else 493e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { } while (0) 503e230dd2SCorentin Chary #endif 513e230dd2SCorentin Chary 523e230dd2SCorentin Chary /***************************************************************************** 533e230dd2SCorentin Chary * 543e230dd2SCorentin Chary * Core data structures 553e230dd2SCorentin Chary * 563e230dd2SCorentin Chary *****************************************************************************/ 573e230dd2SCorentin Chary 583e230dd2SCorentin Chary typedef struct Buffer 593e230dd2SCorentin Chary { 603e230dd2SCorentin Chary size_t capacity; 613e230dd2SCorentin Chary size_t offset; 623e230dd2SCorentin Chary uint8_t *buffer; 633e230dd2SCorentin Chary } Buffer; 643e230dd2SCorentin Chary 653e230dd2SCorentin Chary typedef struct VncState VncState; 66bd023f95SCorentin Chary typedef struct VncJob VncJob; 67bd023f95SCorentin Chary typedef struct VncRect VncRect; 68bd023f95SCorentin Chary typedef struct VncRectEntry VncRectEntry; 693e230dd2SCorentin Chary 703e230dd2SCorentin Chary typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len); 713e230dd2SCorentin Chary 729f64916dSGerd Hoffmann typedef void VncWritePixels(VncState *vs, void *data, int size); 733e230dd2SCorentin Chary 743e230dd2SCorentin Chary typedef void VncSendHextileTile(VncState *vs, 753e230dd2SCorentin Chary int x, int y, int w, int h, 763e230dd2SCorentin Chary void *last_bg, 773e230dd2SCorentin Chary void *last_fg, 783e230dd2SCorentin Chary int *has_bg, int *has_fg); 793e230dd2SCorentin Chary 8023bfe28fSStefan Weil /* VNC_MAX_WIDTH must be a multiple of 16. */ 813e230dd2SCorentin Chary #define VNC_MAX_WIDTH 2560 823e230dd2SCorentin Chary #define VNC_MAX_HEIGHT 2048 8323bfe28fSStefan Weil 84*b4c85ddcSPeter Lieven /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented 85*b4c85ddcSPeter Lieven * by one bit in the dirty bitmap */ 86*b4c85ddcSPeter Lieven #define VNC_DIRTY_PIXELS_PER_BIT 16 87*b4c85ddcSPeter Lieven 8823bfe28fSStefan Weil /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */ 89*b4c85ddcSPeter Lieven #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT) 903e230dd2SCorentin Chary 91999342a0SCorentin Chary #define VNC_STAT_RECT 64 92999342a0SCorentin Chary #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT) 93999342a0SCorentin Chary #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT) 94999342a0SCorentin Chary 953e230dd2SCorentin Chary #define VNC_AUTH_CHALLENGE_SIZE 16 963e230dd2SCorentin Chary 973e230dd2SCorentin Chary typedef struct VncDisplay VncDisplay; 983e230dd2SCorentin Chary 993e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 1003e230dd2SCorentin Chary #include "vnc-tls.h" 1013e230dd2SCorentin Chary #include "vnc-auth-vencrypt.h" 1023e230dd2SCorentin Chary #endif 1033e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1043e230dd2SCorentin Chary #include "vnc-auth-sasl.h" 1053e230dd2SCorentin Chary #endif 1067536ee4bSTim Hardeck #ifdef CONFIG_VNC_WS 1077536ee4bSTim Hardeck #include "vnc-ws.h" 1087536ee4bSTim Hardeck #endif 1093e230dd2SCorentin Chary 110999342a0SCorentin Chary struct VncRectStat 111999342a0SCorentin Chary { 112999342a0SCorentin Chary /* time of last 10 updates, to find update frequency */ 113999342a0SCorentin Chary struct timeval times[10]; 114999342a0SCorentin Chary int idx; 115999342a0SCorentin Chary 116999342a0SCorentin Chary double freq; /* Update frequency (in Hz) */ 117999342a0SCorentin Chary bool updated; /* Already updated during this refresh */ 118999342a0SCorentin Chary }; 119999342a0SCorentin Chary 120999342a0SCorentin Chary typedef struct VncRectStat VncRectStat; 121999342a0SCorentin Chary 1223e230dd2SCorentin Chary struct VncSurface 1233e230dd2SCorentin Chary { 124999342a0SCorentin Chary struct timeval last_freq_check; 12523bfe28fSStefan Weil DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_MAX_WIDTH / 16); 126999342a0SCorentin Chary VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS]; 1279f64916dSGerd Hoffmann pixman_image_t *fb; 1289f64916dSGerd Hoffmann pixman_format_code_t format; 1293e230dd2SCorentin Chary }; 1303e230dd2SCorentin Chary 1318cf36489SGerd Hoffmann typedef enum VncShareMode { 1328cf36489SGerd Hoffmann VNC_SHARE_MODE_CONNECTING = 1, 1338cf36489SGerd Hoffmann VNC_SHARE_MODE_SHARED, 1348cf36489SGerd Hoffmann VNC_SHARE_MODE_EXCLUSIVE, 1358cf36489SGerd Hoffmann VNC_SHARE_MODE_DISCONNECTED, 1368cf36489SGerd Hoffmann } VncShareMode; 1378cf36489SGerd Hoffmann 1388cf36489SGerd Hoffmann typedef enum VncSharePolicy { 1398cf36489SGerd Hoffmann VNC_SHARE_POLICY_IGNORE = 1, 1408cf36489SGerd Hoffmann VNC_SHARE_POLICY_ALLOW_EXCLUSIVE, 1418cf36489SGerd Hoffmann VNC_SHARE_POLICY_FORCE_SHARED, 1428cf36489SGerd Hoffmann } VncSharePolicy; 1438cf36489SGerd Hoffmann 1443e230dd2SCorentin Chary struct VncDisplay 1453e230dd2SCorentin Chary { 1463e230dd2SCorentin Chary QTAILQ_HEAD(, VncState) clients; 1478cf36489SGerd Hoffmann int num_exclusive; 1488cf36489SGerd Hoffmann VncSharePolicy share_policy; 1493e230dd2SCorentin Chary int lsock; 1507536ee4bSTim Hardeck #ifdef CONFIG_VNC_WS 1517536ee4bSTim Hardeck int lwebsock; 1527536ee4bSTim Hardeck bool websocket; 1537536ee4bSTim Hardeck char *ws_display; 1547536ee4bSTim Hardeck #endif 155d39fa6d8SGerd Hoffmann DisplaySurface *ds; 15621ef45d7SGerd Hoffmann DisplayChangeListener dcl; 1573e230dd2SCorentin Chary kbd_layout_t *kbd_layout; 1583e230dd2SCorentin Chary int lock_key_sync; 159bd023f95SCorentin Chary QemuMutex mutex; 1603e230dd2SCorentin Chary 1613e230dd2SCorentin Chary QEMUCursor *cursor; 1623e230dd2SCorentin Chary int cursor_msize; 1633e230dd2SCorentin Chary uint8_t *cursor_mask; 1643e230dd2SCorentin Chary 1653e230dd2SCorentin Chary struct VncSurface guest; /* guest visible surface (aka ds->surface) */ 1669f64916dSGerd Hoffmann pixman_image_t *server; /* vnc server surface */ 1673e230dd2SCorentin Chary 1683e230dd2SCorentin Chary char *display; 1693e230dd2SCorentin Chary char *password; 1703c9405a0SGerd Hoffmann time_t expires; 1713e230dd2SCorentin Chary int auth; 1723e230dd2SCorentin Chary bool lossy; 17380e0c8c3SCorentin Chary bool non_adaptive; 1743e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 1753e230dd2SCorentin Chary int subauth; /* Used by VeNCrypt */ 1763e230dd2SCorentin Chary VncDisplayTLS tls; 1773e230dd2SCorentin Chary #endif 1783e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1793e230dd2SCorentin Chary VncDisplaySASL sasl; 1803e230dd2SCorentin Chary #endif 1813e230dd2SCorentin Chary }; 1823e230dd2SCorentin Chary 183d1af0e05SCorentin Chary typedef struct VncTight { 184d1af0e05SCorentin Chary int type; 185d1af0e05SCorentin Chary uint8_t quality; 186d1af0e05SCorentin Chary uint8_t compression; 187d1af0e05SCorentin Chary uint8_t pixel24; 188d1af0e05SCorentin Chary Buffer tight; 189d1af0e05SCorentin Chary Buffer tmp; 190d1af0e05SCorentin Chary Buffer zlib; 191d1af0e05SCorentin Chary Buffer gradient; 192d1af0e05SCorentin Chary #ifdef CONFIG_VNC_JPEG 193d1af0e05SCorentin Chary Buffer jpeg; 194d1af0e05SCorentin Chary #endif 195d1af0e05SCorentin Chary #ifdef CONFIG_VNC_PNG 196d1af0e05SCorentin Chary Buffer png; 197d1af0e05SCorentin Chary #endif 198d1af0e05SCorentin Chary int levels[4]; 199d1af0e05SCorentin Chary z_stream stream[4]; 200d1af0e05SCorentin Chary } VncTight; 201d1af0e05SCorentin Chary 202d1af0e05SCorentin Chary typedef struct VncHextile { 203d1af0e05SCorentin Chary VncSendHextileTile *send_tile; 204d1af0e05SCorentin Chary } VncHextile; 205d1af0e05SCorentin Chary 206d1af0e05SCorentin Chary typedef struct VncZlib { 207d1af0e05SCorentin Chary Buffer zlib; 208d1af0e05SCorentin Chary Buffer tmp; 209d1af0e05SCorentin Chary z_stream stream; 210d1af0e05SCorentin Chary int level; 211d1af0e05SCorentin Chary } VncZlib; 212d1af0e05SCorentin Chary 213148954faSCorentin Chary typedef struct VncZrle { 214148954faSCorentin Chary int type; 215148954faSCorentin Chary Buffer fb; 216148954faSCorentin Chary Buffer zrle; 217148954faSCorentin Chary Buffer tmp; 218148954faSCorentin Chary Buffer zlib; 219148954faSCorentin Chary z_stream stream; 220148954faSCorentin Chary VncPalette palette; 221148954faSCorentin Chary } VncZrle; 222148954faSCorentin Chary 223148954faSCorentin Chary typedef struct VncZywrle { 224148954faSCorentin Chary int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT]; 225148954faSCorentin Chary } VncZywrle; 226148954faSCorentin Chary 227bd023f95SCorentin Chary struct VncRect 228bd023f95SCorentin Chary { 229bd023f95SCorentin Chary int x; 230bd023f95SCorentin Chary int y; 231bd023f95SCorentin Chary int w; 232bd023f95SCorentin Chary int h; 233bd023f95SCorentin Chary }; 234bd023f95SCorentin Chary 235bd023f95SCorentin Chary struct VncRectEntry 236bd023f95SCorentin Chary { 237bd023f95SCorentin Chary struct VncRect rect; 238bd023f95SCorentin Chary QLIST_ENTRY(VncRectEntry) next; 239bd023f95SCorentin Chary }; 240bd023f95SCorentin Chary 241bd023f95SCorentin Chary struct VncJob 242bd023f95SCorentin Chary { 243bd023f95SCorentin Chary VncState *vs; 244bd023f95SCorentin Chary 245bd023f95SCorentin Chary QLIST_HEAD(, VncRectEntry) rectangles; 246bd023f95SCorentin Chary QTAILQ_ENTRY(VncJob) next; 247bd023f95SCorentin Chary }; 248bd023f95SCorentin Chary 2493e230dd2SCorentin Chary struct VncState 2503e230dd2SCorentin Chary { 2513e230dd2SCorentin Chary int csock; 2523e230dd2SCorentin Chary 25323bfe28fSStefan Weil DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS); 2547d964c9dSCorentin Chary uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in 2557d964c9dSCorentin Chary * vnc-jobs-async.c */ 2563e230dd2SCorentin Chary 2573e230dd2SCorentin Chary VncDisplay *vd; 2583e230dd2SCorentin Chary int need_update; 2593e230dd2SCorentin Chary int force_update; 2603e230dd2SCorentin Chary uint32_t features; 2613e230dd2SCorentin Chary int absolute; 2623e230dd2SCorentin Chary int last_x; 2633e230dd2SCorentin Chary int last_y; 26414768ebaSGerd Hoffmann uint32_t last_bmask; 2653e230dd2SCorentin Chary int client_width; 2663e230dd2SCorentin Chary int client_height; 2678cf36489SGerd Hoffmann VncShareMode share_mode; 2683e230dd2SCorentin Chary 2693e230dd2SCorentin Chary uint32_t vnc_encoding; 2703e230dd2SCorentin Chary 2713e230dd2SCorentin Chary int major; 2723e230dd2SCorentin Chary int minor; 2733e230dd2SCorentin Chary 2747e7e2ebcSDaniel P. Berrange int auth; 2753e230dd2SCorentin Chary char challenge[VNC_AUTH_CHALLENGE_SIZE]; 2763e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 2777e7e2ebcSDaniel P. Berrange int subauth; /* Used by VeNCrypt */ 2783e230dd2SCorentin Chary VncStateTLS tls; 2793e230dd2SCorentin Chary #endif 2803e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 2813e230dd2SCorentin Chary VncStateSASL sasl; 2823e230dd2SCorentin Chary #endif 2837536ee4bSTim Hardeck #ifdef CONFIG_VNC_WS 2840057a0d5STim Hardeck #ifdef CONFIG_VNC_TLS 2850057a0d5STim Hardeck VncStateTLS ws_tls; 2860057a0d5STim Hardeck #endif /* CONFIG_VNC_TLS */ 2877536ee4bSTim Hardeck bool encode_ws; 2887536ee4bSTim Hardeck bool websocket; 2890057a0d5STim Hardeck #endif /* CONFIG_VNC_WS */ 2903e230dd2SCorentin Chary 2913e230dd2SCorentin Chary QObject *info; 2923e230dd2SCorentin Chary 2933e230dd2SCorentin Chary Buffer output; 2943e230dd2SCorentin Chary Buffer input; 2957536ee4bSTim Hardeck #ifdef CONFIG_VNC_WS 2967536ee4bSTim Hardeck Buffer ws_input; 2977536ee4bSTim Hardeck Buffer ws_output; 2987536ee4bSTim Hardeck #endif 2993e230dd2SCorentin Chary /* current output mode information */ 3003e230dd2SCorentin Chary VncWritePixels *write_pixels; 3019f64916dSGerd Hoffmann PixelFormat client_pf; 3029f64916dSGerd Hoffmann pixman_format_code_t client_format; 3039f64916dSGerd Hoffmann bool client_be; 3043e230dd2SCorentin Chary 3053e230dd2SCorentin Chary CaptureVoiceOut *audio_cap; 3063e230dd2SCorentin Chary struct audsettings as; 3073e230dd2SCorentin Chary 3083e230dd2SCorentin Chary VncReadEvent *read_handler; 3093e230dd2SCorentin Chary size_t read_handler_expect; 3103e230dd2SCorentin Chary /* input */ 3113e230dd2SCorentin Chary uint8_t modifiers_state[256]; 3123e230dd2SCorentin Chary QEMUPutLEDEntry *led; 3133e230dd2SCorentin Chary 314bd023f95SCorentin Chary bool abort; 3156fd8e79aSTim Hardeck bool initialized; 316bd023f95SCorentin Chary QemuMutex output_mutex; 317175b2a6eSCorentin Chary QEMUBH *bh; 318175b2a6eSCorentin Chary Buffer jobs_buffer; 319bd023f95SCorentin Chary 320bd023f95SCorentin Chary /* Encoding specific, if you add something here, don't forget to 321bd023f95SCorentin Chary * update vnc_async_encoding_start() 322bd023f95SCorentin Chary */ 323d1af0e05SCorentin Chary VncTight tight; 324d1af0e05SCorentin Chary VncZlib zlib; 325d1af0e05SCorentin Chary VncHextile hextile; 326148954faSCorentin Chary VncZrle zrle; 327148954faSCorentin Chary VncZywrle zywrle; 3283e230dd2SCorentin Chary 3293e230dd2SCorentin Chary Notifier mouse_mode_notifier; 3303e230dd2SCorentin Chary 3313e230dd2SCorentin Chary QTAILQ_ENTRY(VncState) next; 3323e230dd2SCorentin Chary }; 3333e230dd2SCorentin Chary 3343e230dd2SCorentin Chary 3353e230dd2SCorentin Chary /***************************************************************************** 3363e230dd2SCorentin Chary * 3373e230dd2SCorentin Chary * Authentication modes 3383e230dd2SCorentin Chary * 3393e230dd2SCorentin Chary *****************************************************************************/ 3403e230dd2SCorentin Chary 3413e230dd2SCorentin Chary enum { 3423e230dd2SCorentin Chary VNC_AUTH_INVALID = 0, 3433e230dd2SCorentin Chary VNC_AUTH_NONE = 1, 3443e230dd2SCorentin Chary VNC_AUTH_VNC = 2, 3453e230dd2SCorentin Chary VNC_AUTH_RA2 = 5, 3463e230dd2SCorentin Chary VNC_AUTH_RA2NE = 6, 3473e230dd2SCorentin Chary VNC_AUTH_TIGHT = 16, 3483e230dd2SCorentin Chary VNC_AUTH_ULTRA = 17, 3493e230dd2SCorentin Chary VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */ 3503e230dd2SCorentin Chary VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */ 3513e230dd2SCorentin Chary VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */ 3523e230dd2SCorentin Chary }; 3533e230dd2SCorentin Chary 3543e230dd2SCorentin Chary enum { 3553e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_PLAIN = 256, 3563e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSNONE = 257, 3573e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSVNC = 258, 3583e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSPLAIN = 259, 3593e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509NONE = 260, 3603e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509VNC = 261, 3613e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509PLAIN = 262, 3623e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509SASL = 263, 3633e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSSASL = 264, 3643e230dd2SCorentin Chary }; 3653e230dd2SCorentin Chary 3663e230dd2SCorentin Chary 3673e230dd2SCorentin Chary /***************************************************************************** 3683e230dd2SCorentin Chary * 3693e230dd2SCorentin Chary * Encoding types 3703e230dd2SCorentin Chary * 3713e230dd2SCorentin Chary *****************************************************************************/ 3723e230dd2SCorentin Chary 3733e230dd2SCorentin Chary #define VNC_ENCODING_RAW 0x00000000 3743e230dd2SCorentin Chary #define VNC_ENCODING_COPYRECT 0x00000001 3753e230dd2SCorentin Chary #define VNC_ENCODING_RRE 0x00000002 3763e230dd2SCorentin Chary #define VNC_ENCODING_CORRE 0x00000004 3773e230dd2SCorentin Chary #define VNC_ENCODING_HEXTILE 0x00000005 3783e230dd2SCorentin Chary #define VNC_ENCODING_ZLIB 0x00000006 3793e230dd2SCorentin Chary #define VNC_ENCODING_TIGHT 0x00000007 3803e230dd2SCorentin Chary #define VNC_ENCODING_ZLIBHEX 0x00000008 3813e230dd2SCorentin Chary #define VNC_ENCODING_TRLE 0x0000000f 3823e230dd2SCorentin Chary #define VNC_ENCODING_ZRLE 0x00000010 3833e230dd2SCorentin Chary #define VNC_ENCODING_ZYWRLE 0x00000011 3843e230dd2SCorentin Chary #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */ 3853e230dd2SCorentin Chary #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */ 3863e230dd2SCorentin Chary #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */ 3873e230dd2SCorentin Chary #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */ 3883e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */ 3893e230dd2SCorentin Chary #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */ 3903e230dd2SCorentin Chary #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */ 3913e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */ 3923e230dd2SCorentin Chary #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */ 3933e230dd2SCorentin Chary #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */ 394efe556adSCorentin Chary #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */ 395ab99e5c1SLei Li #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */ 3963e230dd2SCorentin Chary #define VNC_ENCODING_WMVi 0x574D5669 3973e230dd2SCorentin Chary 3983e230dd2SCorentin Chary /***************************************************************************** 3993e230dd2SCorentin Chary * 4003e230dd2SCorentin Chary * Other tight constants 4013e230dd2SCorentin Chary * 4023e230dd2SCorentin Chary *****************************************************************************/ 4033e230dd2SCorentin Chary 4043e230dd2SCorentin Chary /* 4053e230dd2SCorentin Chary * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC. 4063e230dd2SCorentin Chary */ 4073e230dd2SCorentin Chary 4083e230dd2SCorentin Chary #define VNC_TIGHT_CCB_RESET_MASK (0x0f) 4093e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4) 4103e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4) 4113e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4) 412efe556adSCorentin Chary #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4) 4133e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4) 4143e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4) 4153e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4) 4163e230dd2SCorentin Chary 4173e230dd2SCorentin Chary /***************************************************************************** 4183e230dd2SCorentin Chary * 4193e230dd2SCorentin Chary * Features 4203e230dd2SCorentin Chary * 4213e230dd2SCorentin Chary *****************************************************************************/ 4223e230dd2SCorentin Chary 4233e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE 0 4243e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE 1 4253e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE 2 4263e230dd2SCorentin Chary #define VNC_FEATURE_WMVI 3 4273e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT 4 4283e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB 5 4293e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT 6 4303e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR 7 431efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG 8 432148954faSCorentin Chary #define VNC_FEATURE_ZRLE 9 433148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE 10 434ab99e5c1SLei Li #define VNC_FEATURE_LED_STATE 11 4353e230dd2SCorentin Chary 4363e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE) 4373e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE) 4383e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE) 4393e230dd2SCorentin Chary #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI) 4403e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT) 4413e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB) 4423e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT) 4433e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR) 444efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG) 445148954faSCorentin Chary #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE) 446148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE) 447ab99e5c1SLei Li #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE) 4483e230dd2SCorentin Chary 4493e230dd2SCorentin Chary 4503e230dd2SCorentin Chary /* Client -> Server message IDs */ 4513e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0 4523e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_ENCODINGS 2 4533e230dd2SCorentin Chary #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3 4543e230dd2SCorentin Chary #define VNC_MSG_CLIENT_KEY_EVENT 4 4553e230dd2SCorentin Chary #define VNC_MSG_CLIENT_POINTER_EVENT 5 4563e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CUT_TEXT 6 4573e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_0 127 4583e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CALL_CONTROL 249 4593e230dd2SCorentin Chary #define VNC_MSG_CLIENT_XVP 250 4603e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251 4613e230dd2SCorentin Chary #define VNC_MSG_CLIENT_TIGHT 252 4623e230dd2SCorentin Chary #define VNC_MSG_CLIENT_GII 253 4633e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_1 254 4643e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU 255 4653e230dd2SCorentin Chary 4663e230dd2SCorentin Chary /* Server -> Client message IDs */ 4673e230dd2SCorentin Chary #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0 4683e230dd2SCorentin Chary #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1 4693e230dd2SCorentin Chary #define VNC_MSG_SERVER_BELL 2 4703e230dd2SCorentin Chary #define VNC_MSG_SERVER_CUT_TEXT 3 4713e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_0 127 4723e230dd2SCorentin Chary #define VNC_MSG_SERVER_CALL_CONTROL 249 4733e230dd2SCorentin Chary #define VNC_MSG_SERVER_XVP 250 4743e230dd2SCorentin Chary #define VNC_MSG_SERVER_TIGHT 252 4753e230dd2SCorentin Chary #define VNC_MSG_SERVER_GII 253 4763e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_1 254 4773e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU 255 4783e230dd2SCorentin Chary 4793e230dd2SCorentin Chary 4803e230dd2SCorentin Chary 4813e230dd2SCorentin Chary /* QEMU client -> server message IDs */ 4823e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0 4833e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO 1 4843e230dd2SCorentin Chary 4853e230dd2SCorentin Chary /* QEMU server -> client message IDs */ 4863e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO 1 4873e230dd2SCorentin Chary 4883e230dd2SCorentin Chary 4893e230dd2SCorentin Chary 4903e230dd2SCorentin Chary /* QEMU client -> server audio message IDs */ 4913e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0 4923e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1 4933e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2 4943e230dd2SCorentin Chary 4953e230dd2SCorentin Chary /* QEMU server -> client audio message IDs */ 4963e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_END 0 4973e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1 4983e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2 4993e230dd2SCorentin Chary 5003e230dd2SCorentin Chary 5013e230dd2SCorentin Chary /***************************************************************************** 5023e230dd2SCorentin Chary * 5033e230dd2SCorentin Chary * Internal APIs 5043e230dd2SCorentin Chary * 5053e230dd2SCorentin Chary *****************************************************************************/ 5063e230dd2SCorentin Chary 5073e230dd2SCorentin Chary /* Event loop functions */ 5083e230dd2SCorentin Chary void vnc_client_read(void *opaque); 5093e230dd2SCorentin Chary void vnc_client_write(void *opaque); 5103e230dd2SCorentin Chary 5113e230dd2SCorentin Chary long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen); 5123e230dd2SCorentin Chary long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen); 5133e230dd2SCorentin Chary 5143e230dd2SCorentin Chary /* Protocol I/O functions */ 5153e230dd2SCorentin Chary void vnc_write(VncState *vs, const void *data, size_t len); 5163e230dd2SCorentin Chary void vnc_write_u32(VncState *vs, uint32_t value); 5173e230dd2SCorentin Chary void vnc_write_s32(VncState *vs, int32_t value); 5183e230dd2SCorentin Chary void vnc_write_u16(VncState *vs, uint16_t value); 5193e230dd2SCorentin Chary void vnc_write_u8(VncState *vs, uint8_t value); 5203e230dd2SCorentin Chary void vnc_flush(VncState *vs); 5213e230dd2SCorentin Chary void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting); 5227536ee4bSTim Hardeck void vnc_disconnect_finish(VncState *vs); 5237536ee4bSTim Hardeck void vnc_init_state(VncState *vs); 5243e230dd2SCorentin Chary 5253e230dd2SCorentin Chary 5263e230dd2SCorentin Chary /* Buffer I/O functions */ 5273e230dd2SCorentin Chary uint32_t read_u32(uint8_t *data, size_t offset); 5283e230dd2SCorentin Chary 5293e230dd2SCorentin Chary /* Protocol stage functions */ 5303e230dd2SCorentin Chary void vnc_client_error(VncState *vs); 5313e230dd2SCorentin Chary int vnc_client_io_error(VncState *vs, int ret, int last_errno); 5323e230dd2SCorentin Chary 5333e230dd2SCorentin Chary void start_client_init(VncState *vs); 5343e230dd2SCorentin Chary void start_auth_vnc(VncState *vs); 5353e230dd2SCorentin Chary 5363e230dd2SCorentin Chary /* Buffer management */ 5373e230dd2SCorentin Chary void buffer_reserve(Buffer *buffer, size_t len); 5383e230dd2SCorentin Chary void buffer_reset(Buffer *buffer); 5393e230dd2SCorentin Chary void buffer_free(Buffer *buffer); 5403e230dd2SCorentin Chary void buffer_append(Buffer *buffer, const void *data, size_t len); 54132ed2680STim Hardeck void buffer_advance(Buffer *buf, size_t len); 5427536ee4bSTim Hardeck uint8_t *buffer_end(Buffer *buffer); 5433e230dd2SCorentin Chary 5443e230dd2SCorentin Chary 5453e230dd2SCorentin Chary /* Misc helpers */ 5463e230dd2SCorentin Chary 5473e230dd2SCorentin Chary char *vnc_socket_local_addr(const char *format, int fd); 5483e230dd2SCorentin Chary char *vnc_socket_remote_addr(const char *format, int fd); 5493e230dd2SCorentin Chary 550efe556adSCorentin Chary static inline uint32_t vnc_has_feature(VncState *vs, int feature) { 551efe556adSCorentin Chary return (vs->features & (1 << feature)); 552efe556adSCorentin Chary } 553efe556adSCorentin Chary 5543e230dd2SCorentin Chary /* Framebuffer */ 5553e230dd2SCorentin Chary void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h, 5563e230dd2SCorentin Chary int32_t encoding); 5573e230dd2SCorentin Chary 5589f64916dSGerd Hoffmann /* server fb is in PIXMAN_x8r8g8b8 */ 5599f64916dSGerd Hoffmann #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8) 5609f64916dSGerd Hoffmann #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT)) 5619f64916dSGerd Hoffmann #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8) 5629f64916dSGerd Hoffmann 5639f64916dSGerd Hoffmann void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y); 5649f64916dSGerd Hoffmann int vnc_server_fb_stride(VncDisplay *vd); 5659f64916dSGerd Hoffmann 5663e230dd2SCorentin Chary void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v); 567999342a0SCorentin Chary double vnc_update_freq(VncState *vs, int x, int y, int w, int h); 5687d964c9dSCorentin Chary void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h); 5693e230dd2SCorentin Chary 5703e230dd2SCorentin Chary /* Encodings */ 571bd023f95SCorentin Chary int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 572bd023f95SCorentin Chary 5733e230dd2SCorentin Chary int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 5743e230dd2SCorentin Chary 5753e230dd2SCorentin Chary int vnc_hextile_send_framebuffer_update(VncState *vs, int x, 5763e230dd2SCorentin Chary int y, int w, int h); 5773e230dd2SCorentin Chary void vnc_hextile_set_pixel_conversion(VncState *vs, int generic); 5783e230dd2SCorentin Chary 5793e230dd2SCorentin Chary void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size); 5803e230dd2SCorentin Chary void vnc_zlib_zfree(void *x, void *addr); 5813e230dd2SCorentin Chary int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 5823e230dd2SCorentin Chary void vnc_zlib_clear(VncState *vs); 5833e230dd2SCorentin Chary 5843e230dd2SCorentin Chary int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 585efe556adSCorentin Chary int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y, 586efe556adSCorentin Chary int w, int h); 5873e230dd2SCorentin Chary void vnc_tight_clear(VncState *vs); 5883e230dd2SCorentin Chary 589148954faSCorentin Chary int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 590148954faSCorentin Chary int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 591148954faSCorentin Chary void vnc_zrle_clear(VncState *vs); 592148954faSCorentin Chary 5933e230dd2SCorentin Chary #endif /* __QEMU_VNC_H */ 594