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" 32*bd023f95SCorentin Chary #ifdef CONFIG_VNC_THREAD 33*bd023f95SCorentin Chary #include "qemu-thread.h" 34*bd023f95SCorentin Chary #endif 353e230dd2SCorentin Chary #include "console.h" 363e230dd2SCorentin Chary #include "monitor.h" 373e230dd2SCorentin Chary #include "audio/audio.h" 383e230dd2SCorentin Chary #include <zlib.h> 393e230dd2SCorentin Chary #include <stdbool.h> 403e230dd2SCorentin Chary 413e230dd2SCorentin Chary #include "keymaps.h" 423e230dd2SCorentin Chary 433e230dd2SCorentin Chary // #define _VNC_DEBUG 1 443e230dd2SCorentin Chary 453e230dd2SCorentin Chary #ifdef _VNC_DEBUG 463e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0) 473e230dd2SCorentin Chary #else 483e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { } while (0) 493e230dd2SCorentin Chary #endif 503e230dd2SCorentin Chary 513e230dd2SCorentin Chary /***************************************************************************** 523e230dd2SCorentin Chary * 533e230dd2SCorentin Chary * Core data structures 543e230dd2SCorentin Chary * 553e230dd2SCorentin Chary *****************************************************************************/ 563e230dd2SCorentin Chary 573e230dd2SCorentin Chary typedef struct Buffer 583e230dd2SCorentin Chary { 593e230dd2SCorentin Chary size_t capacity; 603e230dd2SCorentin Chary size_t offset; 613e230dd2SCorentin Chary uint8_t *buffer; 623e230dd2SCorentin Chary } Buffer; 633e230dd2SCorentin Chary 643e230dd2SCorentin Chary typedef struct VncState VncState; 65*bd023f95SCorentin Chary typedef struct VncJob VncJob; 66*bd023f95SCorentin Chary typedef struct VncRect VncRect; 67*bd023f95SCorentin Chary typedef struct VncRectEntry VncRectEntry; 683e230dd2SCorentin Chary 693e230dd2SCorentin Chary typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len); 703e230dd2SCorentin Chary 713e230dd2SCorentin Chary typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size); 723e230dd2SCorentin Chary 733e230dd2SCorentin Chary typedef void VncSendHextileTile(VncState *vs, 743e230dd2SCorentin Chary int x, int y, int w, int h, 753e230dd2SCorentin Chary void *last_bg, 763e230dd2SCorentin Chary void *last_fg, 773e230dd2SCorentin Chary int *has_bg, int *has_fg); 783e230dd2SCorentin Chary 793e230dd2SCorentin Chary #define VNC_MAX_WIDTH 2560 803e230dd2SCorentin Chary #define VNC_MAX_HEIGHT 2048 813e230dd2SCorentin Chary #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32)) 823e230dd2SCorentin Chary 833e230dd2SCorentin Chary #define VNC_AUTH_CHALLENGE_SIZE 16 843e230dd2SCorentin Chary 853e230dd2SCorentin Chary typedef struct VncDisplay VncDisplay; 863e230dd2SCorentin Chary 873e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 883e230dd2SCorentin Chary #include "vnc-tls.h" 893e230dd2SCorentin Chary #include "vnc-auth-vencrypt.h" 903e230dd2SCorentin Chary #endif 913e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 923e230dd2SCorentin Chary #include "vnc-auth-sasl.h" 933e230dd2SCorentin Chary #endif 943e230dd2SCorentin Chary 953e230dd2SCorentin Chary struct VncSurface 963e230dd2SCorentin Chary { 973e230dd2SCorentin Chary uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS]; 983e230dd2SCorentin Chary DisplaySurface *ds; 993e230dd2SCorentin Chary }; 1003e230dd2SCorentin Chary 1013e230dd2SCorentin Chary struct VncDisplay 1023e230dd2SCorentin Chary { 1033e230dd2SCorentin Chary QTAILQ_HEAD(, VncState) clients; 1043e230dd2SCorentin Chary QEMUTimer *timer; 1053e230dd2SCorentin Chary int timer_interval; 1063e230dd2SCorentin Chary int lsock; 1073e230dd2SCorentin Chary DisplayState *ds; 1083e230dd2SCorentin Chary kbd_layout_t *kbd_layout; 1093e230dd2SCorentin Chary int lock_key_sync; 110*bd023f95SCorentin Chary #ifdef CONFIG_VNC_THREAD 111*bd023f95SCorentin Chary QemuMutex mutex; 112*bd023f95SCorentin Chary #endif 1133e230dd2SCorentin Chary 1143e230dd2SCorentin Chary QEMUCursor *cursor; 1153e230dd2SCorentin Chary int cursor_msize; 1163e230dd2SCorentin Chary uint8_t *cursor_mask; 1173e230dd2SCorentin Chary 1183e230dd2SCorentin Chary struct VncSurface guest; /* guest visible surface (aka ds->surface) */ 1193e230dd2SCorentin Chary DisplaySurface *server; /* vnc server surface */ 1203e230dd2SCorentin Chary 1213e230dd2SCorentin Chary char *display; 1223e230dd2SCorentin Chary char *password; 1233e230dd2SCorentin Chary int auth; 1243e230dd2SCorentin Chary bool lossy; 1253e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 1263e230dd2SCorentin Chary int subauth; /* Used by VeNCrypt */ 1273e230dd2SCorentin Chary VncDisplayTLS tls; 1283e230dd2SCorentin Chary #endif 1293e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1303e230dd2SCorentin Chary VncDisplaySASL sasl; 1313e230dd2SCorentin Chary #endif 1323e230dd2SCorentin Chary }; 1333e230dd2SCorentin Chary 134d1af0e05SCorentin Chary typedef struct VncTight { 135d1af0e05SCorentin Chary int type; 136d1af0e05SCorentin Chary uint8_t quality; 137d1af0e05SCorentin Chary uint8_t compression; 138d1af0e05SCorentin Chary uint8_t pixel24; 139d1af0e05SCorentin Chary Buffer tight; 140d1af0e05SCorentin Chary Buffer tmp; 141d1af0e05SCorentin Chary Buffer zlib; 142d1af0e05SCorentin Chary Buffer gradient; 143d1af0e05SCorentin Chary #ifdef CONFIG_VNC_JPEG 144d1af0e05SCorentin Chary Buffer jpeg; 145d1af0e05SCorentin Chary #endif 146d1af0e05SCorentin Chary #ifdef CONFIG_VNC_PNG 147d1af0e05SCorentin Chary Buffer png; 148d1af0e05SCorentin Chary #endif 149d1af0e05SCorentin Chary int levels[4]; 150d1af0e05SCorentin Chary z_stream stream[4]; 151d1af0e05SCorentin Chary } VncTight; 152d1af0e05SCorentin Chary 153d1af0e05SCorentin Chary typedef struct VncHextile { 154d1af0e05SCorentin Chary VncSendHextileTile *send_tile; 155d1af0e05SCorentin Chary } VncHextile; 156d1af0e05SCorentin Chary 157d1af0e05SCorentin Chary typedef struct VncZlib { 158d1af0e05SCorentin Chary Buffer zlib; 159d1af0e05SCorentin Chary Buffer tmp; 160d1af0e05SCorentin Chary z_stream stream; 161d1af0e05SCorentin Chary int level; 162d1af0e05SCorentin Chary } VncZlib; 163d1af0e05SCorentin Chary 164*bd023f95SCorentin Chary #ifdef CONFIG_VNC_THREAD 165*bd023f95SCorentin Chary struct VncRect 166*bd023f95SCorentin Chary { 167*bd023f95SCorentin Chary int x; 168*bd023f95SCorentin Chary int y; 169*bd023f95SCorentin Chary int w; 170*bd023f95SCorentin Chary int h; 171*bd023f95SCorentin Chary }; 172*bd023f95SCorentin Chary 173*bd023f95SCorentin Chary struct VncRectEntry 174*bd023f95SCorentin Chary { 175*bd023f95SCorentin Chary struct VncRect rect; 176*bd023f95SCorentin Chary QLIST_ENTRY(VncRectEntry) next; 177*bd023f95SCorentin Chary }; 178*bd023f95SCorentin Chary 179*bd023f95SCorentin Chary struct VncJob 180*bd023f95SCorentin Chary { 181*bd023f95SCorentin Chary VncState *vs; 182*bd023f95SCorentin Chary 183*bd023f95SCorentin Chary QLIST_HEAD(, VncRectEntry) rectangles; 184*bd023f95SCorentin Chary QTAILQ_ENTRY(VncJob) next; 185*bd023f95SCorentin Chary }; 186*bd023f95SCorentin Chary #else 187*bd023f95SCorentin Chary struct VncJob 188*bd023f95SCorentin Chary { 189*bd023f95SCorentin Chary VncState *vs; 190*bd023f95SCorentin Chary int rectangles; 191*bd023f95SCorentin Chary size_t saved_offset; 192*bd023f95SCorentin Chary }; 193*bd023f95SCorentin Chary #endif 194*bd023f95SCorentin Chary 1953e230dd2SCorentin Chary struct VncState 1963e230dd2SCorentin Chary { 1973e230dd2SCorentin Chary int csock; 1983e230dd2SCorentin Chary 1993e230dd2SCorentin Chary DisplayState *ds; 2003e230dd2SCorentin Chary uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS]; 2013e230dd2SCorentin Chary 2023e230dd2SCorentin Chary VncDisplay *vd; 2033e230dd2SCorentin Chary int need_update; 2043e230dd2SCorentin Chary int force_update; 2053e230dd2SCorentin Chary uint32_t features; 2063e230dd2SCorentin Chary int absolute; 2073e230dd2SCorentin Chary int last_x; 2083e230dd2SCorentin Chary int last_y; 2093e230dd2SCorentin Chary int client_width; 2103e230dd2SCorentin Chary int client_height; 2113e230dd2SCorentin Chary 2123e230dd2SCorentin Chary uint32_t vnc_encoding; 2133e230dd2SCorentin Chary 2143e230dd2SCorentin Chary int major; 2153e230dd2SCorentin Chary int minor; 2163e230dd2SCorentin Chary 2173e230dd2SCorentin Chary char challenge[VNC_AUTH_CHALLENGE_SIZE]; 2183e230dd2SCorentin Chary #ifdef CONFIG_VNC_TLS 2193e230dd2SCorentin Chary VncStateTLS tls; 2203e230dd2SCorentin Chary #endif 2213e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 2223e230dd2SCorentin Chary VncStateSASL sasl; 2233e230dd2SCorentin Chary #endif 2243e230dd2SCorentin Chary 2253e230dd2SCorentin Chary QObject *info; 2263e230dd2SCorentin Chary 2273e230dd2SCorentin Chary Buffer output; 2283e230dd2SCorentin Chary Buffer input; 2293e230dd2SCorentin Chary /* current output mode information */ 2303e230dd2SCorentin Chary VncWritePixels *write_pixels; 2313e230dd2SCorentin Chary DisplaySurface clientds; 2323e230dd2SCorentin Chary 2333e230dd2SCorentin Chary CaptureVoiceOut *audio_cap; 2343e230dd2SCorentin Chary struct audsettings as; 2353e230dd2SCorentin Chary 2363e230dd2SCorentin Chary VncReadEvent *read_handler; 2373e230dd2SCorentin Chary size_t read_handler_expect; 2383e230dd2SCorentin Chary /* input */ 2393e230dd2SCorentin Chary uint8_t modifiers_state[256]; 2403e230dd2SCorentin Chary QEMUPutLEDEntry *led; 2413e230dd2SCorentin Chary 242*bd023f95SCorentin Chary bool abort; 243*bd023f95SCorentin Chary #ifndef CONFIG_VNC_THREAD 244*bd023f95SCorentin Chary VncJob job; 245*bd023f95SCorentin Chary #else 246*bd023f95SCorentin Chary QemuMutex output_mutex; 247*bd023f95SCorentin Chary #endif 248*bd023f95SCorentin Chary 249*bd023f95SCorentin Chary /* Encoding specific, if you add something here, don't forget to 250*bd023f95SCorentin Chary * update vnc_async_encoding_start() 251*bd023f95SCorentin Chary */ 252d1af0e05SCorentin Chary VncTight tight; 253d1af0e05SCorentin Chary VncZlib zlib; 254d1af0e05SCorentin Chary VncHextile hextile; 2553e230dd2SCorentin Chary 2563e230dd2SCorentin Chary 2573e230dd2SCorentin Chary Notifier mouse_mode_notifier; 2583e230dd2SCorentin Chary 2593e230dd2SCorentin Chary QTAILQ_ENTRY(VncState) next; 2603e230dd2SCorentin Chary }; 2613e230dd2SCorentin Chary 2623e230dd2SCorentin Chary 2633e230dd2SCorentin Chary /***************************************************************************** 2643e230dd2SCorentin Chary * 2653e230dd2SCorentin Chary * Authentication modes 2663e230dd2SCorentin Chary * 2673e230dd2SCorentin Chary *****************************************************************************/ 2683e230dd2SCorentin Chary 2693e230dd2SCorentin Chary enum { 2703e230dd2SCorentin Chary VNC_AUTH_INVALID = 0, 2713e230dd2SCorentin Chary VNC_AUTH_NONE = 1, 2723e230dd2SCorentin Chary VNC_AUTH_VNC = 2, 2733e230dd2SCorentin Chary VNC_AUTH_RA2 = 5, 2743e230dd2SCorentin Chary VNC_AUTH_RA2NE = 6, 2753e230dd2SCorentin Chary VNC_AUTH_TIGHT = 16, 2763e230dd2SCorentin Chary VNC_AUTH_ULTRA = 17, 2773e230dd2SCorentin Chary VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */ 2783e230dd2SCorentin Chary VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */ 2793e230dd2SCorentin Chary VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */ 2803e230dd2SCorentin Chary }; 2813e230dd2SCorentin Chary 2823e230dd2SCorentin Chary enum { 2833e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_PLAIN = 256, 2843e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSNONE = 257, 2853e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSVNC = 258, 2863e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSPLAIN = 259, 2873e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509NONE = 260, 2883e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509VNC = 261, 2893e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509PLAIN = 262, 2903e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509SASL = 263, 2913e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSSASL = 264, 2923e230dd2SCorentin Chary }; 2933e230dd2SCorentin Chary 2943e230dd2SCorentin Chary 2953e230dd2SCorentin Chary /***************************************************************************** 2963e230dd2SCorentin Chary * 2973e230dd2SCorentin Chary * Encoding types 2983e230dd2SCorentin Chary * 2993e230dd2SCorentin Chary *****************************************************************************/ 3003e230dd2SCorentin Chary 3013e230dd2SCorentin Chary #define VNC_ENCODING_RAW 0x00000000 3023e230dd2SCorentin Chary #define VNC_ENCODING_COPYRECT 0x00000001 3033e230dd2SCorentin Chary #define VNC_ENCODING_RRE 0x00000002 3043e230dd2SCorentin Chary #define VNC_ENCODING_CORRE 0x00000004 3053e230dd2SCorentin Chary #define VNC_ENCODING_HEXTILE 0x00000005 3063e230dd2SCorentin Chary #define VNC_ENCODING_ZLIB 0x00000006 3073e230dd2SCorentin Chary #define VNC_ENCODING_TIGHT 0x00000007 3083e230dd2SCorentin Chary #define VNC_ENCODING_ZLIBHEX 0x00000008 3093e230dd2SCorentin Chary #define VNC_ENCODING_TRLE 0x0000000f 3103e230dd2SCorentin Chary #define VNC_ENCODING_ZRLE 0x00000010 3113e230dd2SCorentin Chary #define VNC_ENCODING_ZYWRLE 0x00000011 3123e230dd2SCorentin Chary #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */ 3133e230dd2SCorentin Chary #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */ 3143e230dd2SCorentin Chary #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */ 3153e230dd2SCorentin Chary #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */ 3163e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */ 3173e230dd2SCorentin Chary #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */ 3183e230dd2SCorentin Chary #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */ 3193e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */ 3203e230dd2SCorentin Chary #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */ 3213e230dd2SCorentin Chary #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */ 322efe556adSCorentin Chary #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */ 3233e230dd2SCorentin Chary #define VNC_ENCODING_WMVi 0x574D5669 3243e230dd2SCorentin Chary 3253e230dd2SCorentin Chary /***************************************************************************** 3263e230dd2SCorentin Chary * 3273e230dd2SCorentin Chary * Other tight constants 3283e230dd2SCorentin Chary * 3293e230dd2SCorentin Chary *****************************************************************************/ 3303e230dd2SCorentin Chary 3313e230dd2SCorentin Chary /* 3323e230dd2SCorentin Chary * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC. 3333e230dd2SCorentin Chary */ 3343e230dd2SCorentin Chary 3353e230dd2SCorentin Chary #define VNC_TIGHT_CCB_RESET_MASK (0x0f) 3363e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4) 3373e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4) 3383e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4) 339efe556adSCorentin Chary #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4) 3403e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4) 3413e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4) 3423e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4) 3433e230dd2SCorentin Chary 3443e230dd2SCorentin Chary /***************************************************************************** 3453e230dd2SCorentin Chary * 3463e230dd2SCorentin Chary * Features 3473e230dd2SCorentin Chary * 3483e230dd2SCorentin Chary *****************************************************************************/ 3493e230dd2SCorentin Chary 3503e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE 0 3513e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE 1 3523e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE 2 3533e230dd2SCorentin Chary #define VNC_FEATURE_WMVI 3 3543e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT 4 3553e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB 5 3563e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT 6 3573e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR 7 358efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG 8 3593e230dd2SCorentin Chary 3603e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE) 3613e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE) 3623e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE) 3633e230dd2SCorentin Chary #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI) 3643e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT) 3653e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB) 3663e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT) 3673e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR) 368efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG) 3693e230dd2SCorentin Chary 3703e230dd2SCorentin Chary 3713e230dd2SCorentin Chary /* Client -> Server message IDs */ 3723e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0 3733e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_ENCODINGS 2 3743e230dd2SCorentin Chary #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3 3753e230dd2SCorentin Chary #define VNC_MSG_CLIENT_KEY_EVENT 4 3763e230dd2SCorentin Chary #define VNC_MSG_CLIENT_POINTER_EVENT 5 3773e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CUT_TEXT 6 3783e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_0 127 3793e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CALL_CONTROL 249 3803e230dd2SCorentin Chary #define VNC_MSG_CLIENT_XVP 250 3813e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251 3823e230dd2SCorentin Chary #define VNC_MSG_CLIENT_TIGHT 252 3833e230dd2SCorentin Chary #define VNC_MSG_CLIENT_GII 253 3843e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_1 254 3853e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU 255 3863e230dd2SCorentin Chary 3873e230dd2SCorentin Chary /* Server -> Client message IDs */ 3883e230dd2SCorentin Chary #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0 3893e230dd2SCorentin Chary #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1 3903e230dd2SCorentin Chary #define VNC_MSG_SERVER_BELL 2 3913e230dd2SCorentin Chary #define VNC_MSG_SERVER_CUT_TEXT 3 3923e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_0 127 3933e230dd2SCorentin Chary #define VNC_MSG_SERVER_CALL_CONTROL 249 3943e230dd2SCorentin Chary #define VNC_MSG_SERVER_XVP 250 3953e230dd2SCorentin Chary #define VNC_MSG_SERVER_TIGHT 252 3963e230dd2SCorentin Chary #define VNC_MSG_SERVER_GII 253 3973e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_1 254 3983e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU 255 3993e230dd2SCorentin Chary 4003e230dd2SCorentin Chary 4013e230dd2SCorentin Chary 4023e230dd2SCorentin Chary /* QEMU client -> server message IDs */ 4033e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0 4043e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO 1 4053e230dd2SCorentin Chary 4063e230dd2SCorentin Chary /* QEMU server -> client message IDs */ 4073e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO 1 4083e230dd2SCorentin Chary 4093e230dd2SCorentin Chary 4103e230dd2SCorentin Chary 4113e230dd2SCorentin Chary /* QEMU client -> server audio message IDs */ 4123e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0 4133e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1 4143e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2 4153e230dd2SCorentin Chary 4163e230dd2SCorentin Chary /* QEMU server -> client audio message IDs */ 4173e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_END 0 4183e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1 4193e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2 4203e230dd2SCorentin Chary 4213e230dd2SCorentin Chary 4223e230dd2SCorentin Chary /***************************************************************************** 4233e230dd2SCorentin Chary * 4243e230dd2SCorentin Chary * Internal APIs 4253e230dd2SCorentin Chary * 4263e230dd2SCorentin Chary *****************************************************************************/ 4273e230dd2SCorentin Chary 4283e230dd2SCorentin Chary /* Event loop functions */ 4293e230dd2SCorentin Chary void vnc_client_read(void *opaque); 4303e230dd2SCorentin Chary void vnc_client_write(void *opaque); 4313e230dd2SCorentin Chary 4323e230dd2SCorentin Chary long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen); 4333e230dd2SCorentin Chary long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen); 4343e230dd2SCorentin Chary 4353e230dd2SCorentin Chary /* Protocol I/O functions */ 4363e230dd2SCorentin Chary void vnc_write(VncState *vs, const void *data, size_t len); 4373e230dd2SCorentin Chary void vnc_write_u32(VncState *vs, uint32_t value); 4383e230dd2SCorentin Chary void vnc_write_s32(VncState *vs, int32_t value); 4393e230dd2SCorentin Chary void vnc_write_u16(VncState *vs, uint16_t value); 4403e230dd2SCorentin Chary void vnc_write_u8(VncState *vs, uint8_t value); 4413e230dd2SCorentin Chary void vnc_flush(VncState *vs); 4423e230dd2SCorentin Chary void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting); 4433e230dd2SCorentin Chary 4443e230dd2SCorentin Chary 4453e230dd2SCorentin Chary /* Buffer I/O functions */ 4463e230dd2SCorentin Chary uint8_t read_u8(uint8_t *data, size_t offset); 4473e230dd2SCorentin Chary uint16_t read_u16(uint8_t *data, size_t offset); 4483e230dd2SCorentin Chary int32_t read_s32(uint8_t *data, size_t offset); 4493e230dd2SCorentin Chary uint32_t read_u32(uint8_t *data, size_t offset); 4503e230dd2SCorentin Chary 4513e230dd2SCorentin Chary /* Protocol stage functions */ 4523e230dd2SCorentin Chary void vnc_client_error(VncState *vs); 4533e230dd2SCorentin Chary int vnc_client_io_error(VncState *vs, int ret, int last_errno); 4543e230dd2SCorentin Chary 4553e230dd2SCorentin Chary void start_client_init(VncState *vs); 4563e230dd2SCorentin Chary void start_auth_vnc(VncState *vs); 4573e230dd2SCorentin Chary 4583e230dd2SCorentin Chary /* Buffer management */ 4593e230dd2SCorentin Chary void buffer_reserve(Buffer *buffer, size_t len); 4603e230dd2SCorentin Chary int buffer_empty(Buffer *buffer); 4613e230dd2SCorentin Chary uint8_t *buffer_end(Buffer *buffer); 4623e230dd2SCorentin Chary void buffer_reset(Buffer *buffer); 4633e230dd2SCorentin Chary void buffer_free(Buffer *buffer); 4643e230dd2SCorentin Chary void buffer_append(Buffer *buffer, const void *data, size_t len); 4653e230dd2SCorentin Chary 4663e230dd2SCorentin Chary 4673e230dd2SCorentin Chary /* Misc helpers */ 4683e230dd2SCorentin Chary 4693e230dd2SCorentin Chary char *vnc_socket_local_addr(const char *format, int fd); 4703e230dd2SCorentin Chary char *vnc_socket_remote_addr(const char *format, int fd); 4713e230dd2SCorentin Chary 472efe556adSCorentin Chary static inline uint32_t vnc_has_feature(VncState *vs, int feature) { 473efe556adSCorentin Chary return (vs->features & (1 << feature)); 474efe556adSCorentin Chary } 475efe556adSCorentin Chary 4763e230dd2SCorentin Chary /* Framebuffer */ 4773e230dd2SCorentin Chary void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h, 4783e230dd2SCorentin Chary int32_t encoding); 4793e230dd2SCorentin Chary 4803e230dd2SCorentin Chary void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v); 4813e230dd2SCorentin Chary 4823e230dd2SCorentin Chary /* Encodings */ 483*bd023f95SCorentin Chary int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 484*bd023f95SCorentin Chary 4853e230dd2SCorentin Chary int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 4863e230dd2SCorentin Chary 4873e230dd2SCorentin Chary int vnc_hextile_send_framebuffer_update(VncState *vs, int x, 4883e230dd2SCorentin Chary int y, int w, int h); 4893e230dd2SCorentin Chary void vnc_hextile_set_pixel_conversion(VncState *vs, int generic); 4903e230dd2SCorentin Chary 4913e230dd2SCorentin Chary void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size); 4923e230dd2SCorentin Chary void vnc_zlib_zfree(void *x, void *addr); 4933e230dd2SCorentin Chary int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 4943e230dd2SCorentin Chary void vnc_zlib_clear(VncState *vs); 4953e230dd2SCorentin Chary 4963e230dd2SCorentin Chary int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 497efe556adSCorentin Chary int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y, 498efe556adSCorentin Chary int w, int h); 4993e230dd2SCorentin Chary void vnc_tight_clear(VncState *vs); 5003e230dd2SCorentin Chary 5013e230dd2SCorentin Chary #endif /* __QEMU_VNC_H */ 502