blob: 3f7c6a9bc6344a310cdbe22d721e71d540061f9f [file] [log] [blame]
aliguori19a490b2009-03-06 20:27:13 +00001/*
2 * QEMU VNC display driver
3 *
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
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"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010031#include "qemu/queue.h"
32#include "qemu/thread.h"
Paolo Bonzini28ecbae2012-11-28 12:06:30 +010033#include "ui/console.h"
aliguori19a490b2009-03-06 20:27:13 +000034#include "audio/audio.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010035#include "qemu/bitmap.h"
aliguori19a490b2009-03-06 20:27:13 +000036#include <zlib.h>
Corentin Chary6f9c78c2010-07-07 20:57:51 +020037#include <stdbool.h>
aliguori19a490b2009-03-06 20:27:13 +000038
aliguori19a490b2009-03-06 20:27:13 +000039#include "keymaps.h"
Corentin Chary148954f2011-02-04 09:06:01 +010040#include "vnc-palette.h"
41#include "vnc-enc-zrle.h"
Wenchao Xiafb6ba0d2014-06-18 08:43:49 +020042#include "qapi-types.h"
aliguori19a490b2009-03-06 20:27:13 +000043
aliguori5fb6c7a2009-03-06 20:27:23 +000044// #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
aliguori19a490b2009-03-06 20:27:13 +000052/*****************************************************************************
53 *
54 * Core data structures
55 *
56 *****************************************************************************/
57
58typedef struct Buffer
59{
60 size_t capacity;
61 size_t offset;
62 uint8_t *buffer;
63} Buffer;
64
65typedef struct VncState VncState;
Corentin Charybd023f92010-07-07 20:58:02 +020066typedef struct VncJob VncJob;
67typedef struct VncRect VncRect;
68typedef struct VncRectEntry VncRectEntry;
aliguori19a490b2009-03-06 20:27:13 +000069
70typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
71
Gerd Hoffmann9f649162012-10-10 13:29:43 +020072typedef void VncWritePixels(VncState *vs, void *data, int size);
aliguori19a490b2009-03-06 20:27:13 +000073
74typedef 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
Peter Lievenb4c85dd2014-01-08 10:08:33 +010080/* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
Peter Lievenbea60dd2014-06-30 10:57:51 +020081 * by one bit in the dirty bitmap, should be a power of 2 */
Peter Lievenb4c85dd2014-01-08 10:08:33 +010082#define VNC_DIRTY_PIXELS_PER_BIT 16
83
Peter Lievenbea60dd2014-06-30 10:57:51 +020084/* 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
Stefan Weil23bfe282011-03-03 21:37:55 +010089/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
Peter Lievenb4c85dd2014-01-08 10:08:33 +010090#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
aliguori19a490b2009-03-06 20:27:13 +000091
Peter Lieven12b316d2014-01-08 10:08:35 +010092/* 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
Corentin Chary999342a2011-02-04 09:05:55 +010096#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
aliguori19a490b2009-03-06 20:27:13 +0000100#define VNC_AUTH_CHALLENGE_SIZE 16
101
102typedef struct VncDisplay VncDisplay;
103
aliguori5fb6c7a2009-03-06 20:27:23 +0000104#ifdef CONFIG_VNC_TLS
105#include "vnc-tls.h"
106#include "vnc-auth-vencrypt.h"
107#endif
aliguori2f9606b2009-03-06 20:27:28 +0000108#ifdef CONFIG_VNC_SASL
109#include "vnc-auth-sasl.h"
110#endif
Tim Hardeck7536ee42013-01-21 11:04:44 +0100111#ifdef CONFIG_VNC_WS
112#include "vnc-ws.h"
113#endif
aliguori2f9606b2009-03-06 20:27:28 +0000114
Corentin Chary999342a2011-02-04 09:05:55 +0100115struct 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
125typedef struct VncRectStat VncRectStat;
126
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100127struct VncSurface
128{
Corentin Chary999342a2011-02-04 09:05:55 +0100129 struct timeval last_freq_check;
Peter Lievenbea60dd2014-06-30 10:57:51 +0200130 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
131 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
Corentin Chary999342a2011-02-04 09:05:55 +0100132 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200133 pixman_image_t *fb;
134 pixman_format_code_t format;
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100135};
aliguori5fb6c7a2009-03-06 20:27:23 +0000136
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100137typedef 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
144typedef enum VncSharePolicy {
145 VNC_SHARE_POLICY_IGNORE = 1,
146 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
147 VNC_SHARE_POLICY_FORCE_SHARED,
148} VncSharePolicy;
149
aliguori19a490b2009-03-06 20:27:13 +0000150struct VncDisplay
151{
Amit Shah41b4bef2010-02-05 16:34:05 +0530152 QTAILQ_HEAD(, VncState) clients;
Gerd Hoffmanne5f34cd2014-10-02 12:09:34 +0200153 int num_connecting;
154 int num_shared;
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100155 int num_exclusive;
Gerd Hoffmanne5f34cd2014-10-02 12:09:34 +0200156 int connections_limit;
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100157 VncSharePolicy share_policy;
aliguori19a490b2009-03-06 20:27:13 +0000158 int lsock;
Tim Hardeck7536ee42013-01-21 11:04:44 +0100159#ifdef CONFIG_VNC_WS
160 int lwebsock;
Gerd Hoffmannbf7aa452015-02-19 10:46:49 +0100161 bool ws_enabled;
Tim Hardeck7536ee42013-01-21 11:04:44 +0100162#endif
Gerd Hoffmannd39fa6d2013-02-28 17:16:48 +0100163 DisplaySurface *ds;
Gerd Hoffmann21ef45d2013-02-28 11:34:31 +0100164 DisplayChangeListener dcl;
Anthony Liguoric227f092009-10-01 16:12:16 -0500165 kbd_layout_t *kbd_layout;
Gerd Hoffmann3a0558b2010-03-10 17:12:02 +0100166 int lock_key_sync;
Corentin Charybd023f92010-07-07 20:58:02 +0200167 QemuMutex mutex;
aliguori19a490b2009-03-06 20:27:13 +0000168
Gerd Hoffmannd467b672010-05-21 11:54:34 +0200169 QEMUCursor *cursor;
170 int cursor_msize;
171 uint8_t *cursor_mask;
172
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100173 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200174 pixman_image_t *server; /* vnc server surface */
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100175
Gerd Hoffmannd616ccc2014-07-29 12:14:08 +0200176 const char *id;
177 QTAILQ_ENTRY(VncDisplay) next;
Gerd Hoffmannbf7aa452015-02-19 10:46:49 +0100178 bool enabled;
179 bool is_unix;
aliguori19a490b2009-03-06 20:27:13 +0000180 char *password;
Gerd Hoffmann3c9405a2010-10-07 11:50:45 +0200181 time_t expires;
aliguori19a490b2009-03-06 20:27:13 +0000182 int auth;
Daniel P. Berranged169f042015-03-17 13:42:55 +0000183 int subauth; /* Used by VeNCrypt */
Daniel P. Berrangef9148c82015-03-17 13:42:57 +0000184 int ws_auth; /* Used by websockets */
185 bool ws_tls; /* Used by websockets */
Corentin Chary6f9c78c2010-07-07 20:57:51 +0200186 bool lossy;
Corentin Chary80e0c8c2011-02-04 09:06:08 +0100187 bool non_adaptive;
aliguori19a490b2009-03-06 20:27:13 +0000188#ifdef CONFIG_VNC_TLS
aliguori5fb6c7a2009-03-06 20:27:23 +0000189 VncDisplayTLS tls;
aliguori19a490b2009-03-06 20:27:13 +0000190#endif
aliguori76655d62009-03-06 20:27:37 +0000191#ifdef CONFIG_VNC_SASL
192 VncDisplaySASL sasl;
193#endif
aliguori19a490b2009-03-06 20:27:13 +0000194};
195
Corentin Charyd1af0e02010-07-07 20:57:59 +0200196typedef 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
215typedef struct VncHextile {
216 VncSendHextileTile *send_tile;
217} VncHextile;
218
219typedef struct VncZlib {
220 Buffer zlib;
221 Buffer tmp;
222 z_stream stream;
223 int level;
224} VncZlib;
225
Corentin Chary148954f2011-02-04 09:06:01 +0100226typedef 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
236typedef struct VncZywrle {
237 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
238} VncZywrle;
239
Corentin Charybd023f92010-07-07 20:58:02 +0200240struct VncRect
241{
242 int x;
243 int y;
244 int w;
245 int h;
246};
247
248struct VncRectEntry
249{
250 struct VncRect rect;
251 QLIST_ENTRY(VncRectEntry) next;
252};
253
254struct VncJob
255{
256 VncState *vs;
257
258 QLIST_HEAD(, VncRectEntry) rectangles;
259 QTAILQ_ENTRY(VncJob) next;
260};
Corentin Charybd023f92010-07-07 20:58:02 +0200261
aliguori19a490b2009-03-06 20:27:13 +0000262struct VncState
263{
aliguori19a490b2009-03-06 20:27:13 +0000264 int csock;
aliguori6baebed2009-03-20 15:59:14 +0000265
Stefan Weil23bfe282011-03-03 21:37:55 +0100266 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
Corentin Chary7d964c92011-02-04 09:05:56 +0100267 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
268 * vnc-jobs-async.c */
aliguori6baebed2009-03-20 15:59:14 +0000269
aliguori19a490b2009-03-06 20:27:13 +0000270 VncDisplay *vd;
271 int need_update;
aliguoric522d0e2009-03-20 15:59:24 +0000272 int force_update;
Gerd Hoffmann63658282014-07-23 11:52:02 +0200273 int has_dirty;
aliguori19a490b2009-03-06 20:27:13 +0000274 uint32_t features;
275 int absolute;
276 int last_x;
277 int last_y;
Gerd Hoffmann14768eb2013-12-02 15:17:45 +0100278 uint32_t last_bmask;
Gerd Hoffmann5862d192010-05-25 18:25:18 +0200279 int client_width;
280 int client_height;
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100281 VncShareMode share_mode;
aliguori19a490b2009-03-06 20:27:13 +0000282
283 uint32_t vnc_encoding;
aliguori19a490b2009-03-06 20:27:13 +0000284
285 int major;
286 int minor;
287
Daniel P. Berrange7e7e2eb2011-06-23 13:31:41 +0100288 int auth;
Daniel P. Berranged169f042015-03-17 13:42:55 +0000289 int subauth; /* Used by VeNCrypt */
aliguori19a490b2009-03-06 20:27:13 +0000290 char challenge[VNC_AUTH_CHALLENGE_SIZE];
aliguori19a490b2009-03-06 20:27:13 +0000291#ifdef CONFIG_VNC_TLS
aliguori5fb6c7a2009-03-06 20:27:23 +0000292 VncStateTLS tls;
aliguori19a490b2009-03-06 20:27:13 +0000293#endif
aliguori2f9606b2009-03-06 20:27:28 +0000294#ifdef CONFIG_VNC_SASL
295 VncStateSASL sasl;
296#endif
Tim Hardeck7536ee42013-01-21 11:04:44 +0100297#ifdef CONFIG_VNC_WS
298 bool encode_ws;
299 bool websocket;
Tim Hardeck0057a0d2013-04-23 16:33:01 +0200300#endif /* CONFIG_VNC_WS */
aliguori19a490b2009-03-06 20:27:13 +0000301
Wenchao Xiafb6ba0d2014-06-18 08:43:49 +0200302 VncClientInfo *info;
Luiz Capitulino4a80dba2010-01-14 14:50:56 -0200303
aliguori19a490b2009-03-06 20:27:13 +0000304 Buffer output;
305 Buffer input;
Tim Hardeck7536ee42013-01-21 11:04:44 +0100306#ifdef CONFIG_VNC_WS
307 Buffer ws_input;
308 Buffer ws_output;
Daniel P. Berrangea2bebfd2015-03-23 22:58:21 +0000309 size_t ws_payload_remain;
310 WsMask ws_payload_mask;
Tim Hardeck7536ee42013-01-21 11:04:44 +0100311#endif
aliguori19a490b2009-03-06 20:27:13 +0000312 /* current output mode information */
313 VncWritePixels *write_pixels;
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200314 PixelFormat client_pf;
315 pixman_format_code_t client_format;
316 bool client_be;
aliguori19a490b2009-03-06 20:27:13 +0000317
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];
Gerd Hoffmann7ffb82c2010-02-26 17:17:39 +0100325 QEMUPutLEDEntry *led;
aliguori19a490b2009-03-06 20:27:13 +0000326
Corentin Charybd023f92010-07-07 20:58:02 +0200327 bool abort;
Tim Hardeck6fd8e792013-01-21 11:04:45 +0100328 bool initialized;
Corentin Charybd023f92010-07-07 20:58:02 +0200329 QemuMutex output_mutex;
Corentin Chary175b2a62012-03-14 07:58:47 +0100330 QEMUBH *bh;
331 Buffer jobs_buffer;
Corentin Charybd023f92010-07-07 20:58:02 +0200332
333 /* Encoding specific, if you add something here, don't forget to
334 * update vnc_async_encoding_start()
335 */
Corentin Charyd1af0e02010-07-07 20:57:59 +0200336 VncTight tight;
337 VncZlib zlib;
338 VncHextile hextile;
Corentin Chary148954f2011-02-04 09:06:01 +0100339 VncZrle zrle;
340 VncZywrle zywrle;
aliguori19a490b2009-03-06 20:27:13 +0000341
Anthony Liguori37c34d92010-03-10 09:38:29 -0600342 Notifier mouse_mode_notifier;
343
Amit Shah41b4bef2010-02-05 16:34:05 +0530344 QTAILQ_ENTRY(VncState) next;
aliguori19a490b2009-03-06 20:27:13 +0000345};
346
aliguorie06679f2009-02-02 15:58:25 +0000347
348/*****************************************************************************
349 *
350 * Authentication modes
351 *
352 *****************************************************************************/
353
354enum {
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,
aliguori2f9606b2009-03-06 20:27:28 +0000362 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 */
aliguorie06679f2009-02-02 15:58:25 +0000365};
366
aliguorie06679f2009-02-02 15:58:25 +0000367enum {
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,
aliguori2f9606b2009-03-06 20:27:28 +0000375 VNC_AUTH_VENCRYPT_X509SASL = 263,
376 VNC_AUTH_VENCRYPT_TLSSASL = 264,
aliguorie06679f2009-02-02 15:58:25 +0000377};
378
aliguorie06679f2009-02-02 15:58:25 +0000379
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 */
Corentin Charyefe556a2010-07-07 20:57:56 +0200407#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
Lei Liab99e5c2013-04-25 13:29:10 +0800408#define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
aliguorie06679f2009-02-02 15:58:25 +0000409#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)
Corentin Charyefe556a2010-07-07 20:57:56 +0200425#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
aliguorie06679f2009-02-02 15:58:25 +0000426#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
aliguori753b4052009-02-16 14:59:30 +0000442#define VNC_FEATURE_COPYRECT 6
Gerd Hoffmannd467b672010-05-21 11:54:34 +0200443#define VNC_FEATURE_RICH_CURSOR 7
Corentin Charyefe556a2010-07-07 20:57:56 +0200444#define VNC_FEATURE_TIGHT_PNG 8
Corentin Chary148954f2011-02-04 09:06:01 +0100445#define VNC_FEATURE_ZRLE 9
446#define VNC_FEATURE_ZYWRLE 10
Lei Liab99e5c2013-04-25 13:29:10 +0800447#define VNC_FEATURE_LED_STATE 11
aliguorie06679f2009-02-02 15:58:25 +0000448
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)
aliguori753b4052009-02-16 14:59:30 +0000455#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
Gerd Hoffmannd467b672010-05-21 11:54:34 +0200456#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
Corentin Charyefe556a2010-07-07 20:57:56 +0200457#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
Corentin Chary148954f2011-02-04 09:06:01 +0100458#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
459#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
Lei Liab99e5c2013-04-25 13:29:10 +0800460#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
aliguorie06679f2009-02-02 15:58:25 +0000461
aliguori5fb6c7a2009-03-06 20:27:23 +0000462
Daniel P. Berrange46a183d2010-03-31 18:20:43 +0100463/* 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
aliguori5fb6c7a2009-03-06 20:27:23 +0000514/*****************************************************************************
515 *
516 * Internal APIs
517 *
518 *****************************************************************************/
519
520/* Event loop functions */
521void vnc_client_read(void *opaque);
522void vnc_client_write(void *opaque);
523
aliguori2f9606b2009-03-06 20:27:28 +0000524long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
525long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
aliguori5fb6c7a2009-03-06 20:27:23 +0000526
527/* Protocol I/O functions */
528void vnc_write(VncState *vs, const void *data, size_t len);
529void vnc_write_u32(VncState *vs, uint32_t value);
530void vnc_write_s32(VncState *vs, int32_t value);
531void vnc_write_u16(VncState *vs, uint16_t value);
532void vnc_write_u8(VncState *vs, uint8_t value);
533void vnc_flush(VncState *vs);
534void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
Tim Hardeck7536ee42013-01-21 11:04:44 +0100535void vnc_disconnect_finish(VncState *vs);
536void vnc_init_state(VncState *vs);
aliguori5fb6c7a2009-03-06 20:27:23 +0000537
538
539/* Buffer I/O functions */
aliguori5fb6c7a2009-03-06 20:27:23 +0000540uint32_t read_u32(uint8_t *data, size_t offset);
541
542/* Protocol stage functions */
543void vnc_client_error(VncState *vs);
aliguori2f9606b2009-03-06 20:27:28 +0000544int vnc_client_io_error(VncState *vs, int ret, int last_errno);
aliguori5fb6c7a2009-03-06 20:27:23 +0000545
546void start_client_init(VncState *vs);
547void start_auth_vnc(VncState *vs);
548
aliguori2f9606b2009-03-06 20:27:28 +0000549/* Buffer management */
550void buffer_reserve(Buffer *buffer, size_t len);
aliguori2f9606b2009-03-06 20:27:28 +0000551void buffer_reset(Buffer *buffer);
Corentin Chary5d418e32010-05-19 09:24:07 +0200552void buffer_free(Buffer *buffer);
aliguori2f9606b2009-03-06 20:27:28 +0000553void buffer_append(Buffer *buffer, const void *data, size_t len);
Tim Hardeck32ed2682013-01-21 11:04:43 +0100554void buffer_advance(Buffer *buf, size_t len);
Tim Hardeck7536ee42013-01-21 11:04:44 +0100555uint8_t *buffer_end(Buffer *buffer);
aliguori2f9606b2009-03-06 20:27:28 +0000556
557
558/* Misc helpers */
559
560char *vnc_socket_local_addr(const char *format, int fd);
561char *vnc_socket_remote_addr(const char *format, int fd);
562
Corentin Charyefe556a2010-07-07 20:57:56 +0200563static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
564 return (vs->features & (1 << feature));
565}
566
Corentin Chary70a45682010-05-03 14:31:34 +0200567/* Framebuffer */
568void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
569 int32_t encoding);
570
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200571/* 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
576void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
577int vnc_server_fb_stride(VncDisplay *vd);
578
Corentin Chary70a45682010-05-03 14:31:34 +0200579void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
Corentin Chary999342a2011-02-04 09:05:55 +0100580double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
Corentin Chary7d964c92011-02-04 09:05:56 +0100581void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
Corentin Chary70a45682010-05-03 14:31:34 +0200582
583/* Encodings */
Corentin Charybd023f92010-07-07 20:58:02 +0200584int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
585
Corentin Charya8852112010-05-19 09:24:09 +0200586int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
Corentin Chary70a45682010-05-03 14:31:34 +0200587
Corentin Charya8852112010-05-19 09:24:09 +0200588int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
Corentin Chary70a45682010-05-03 14:31:34 +0200589 int y, int w, int h);
590void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
591
Corentin Chary380282b2010-05-19 09:24:10 +0200592void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
593void vnc_zlib_zfree(void *x, void *addr);
Corentin Charya8852112010-05-19 09:24:09 +0200594int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
Corentin Chary161c4f22010-05-19 09:24:08 +0200595void vnc_zlib_clear(VncState *vs);
Corentin Chary70a45682010-05-03 14:31:34 +0200596
Corentin Chary380282b2010-05-19 09:24:10 +0200597int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
Corentin Charyefe556a2010-07-07 20:57:56 +0200598int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
599 int w, int h);
Corentin Chary380282b2010-05-19 09:24:10 +0200600void vnc_tight_clear(VncState *vs);
601
Corentin Chary148954f2011-02-04 09:06:01 +0100602int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
603int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
604void vnc_zrle_clear(VncState *vs);
605
aliguori19a490b2009-03-06 20:27:13 +0000606#endif /* __QEMU_VNC_H */