]> git.proxmox.com Git - mirror_qemu.git/blame - ui/vnc.h
Merge tag 'pull-aspeed-20240201' of https://github.com/legoater/qemu into staging
[mirror_qemu.git] / ui / vnc.h
CommitLineData
19a490bf
AL
1/*
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
2a6a4076
MA
27#ifndef QEMU_VNC_H
28#define QEMU_VNC_H
19a490bf 29
1de7afc9
PB
30#include "qemu/queue.h"
31#include "qemu/thread.h"
0bf41cab 32#include "ui/clipboard.h"
28ecbaee 33#include "ui/console.h"
19a490bf 34#include "audio/audio.h"
1de7afc9 35#include "qemu/bitmap.h"
3e305e4a 36#include "crypto/tlssession.h"
88c5f205 37#include "qemu/buffer.h"
04d2529d 38#include "io/channel-socket.h"
2cc45228 39#include "io/channel-tls.h"
13e1d0e7 40#include "io/net-listener.h"
b76806d4 41#include "authz/base.h"
19a490bf
AL
42#include <zlib.h>
43
19a490bf 44#include "keymaps.h"
148954fa
CC
45#include "vnc-palette.h"
46#include "vnc-enc-zrle.h"
c2f2ba49 47#include "ui/kbd-state.h"
19a490bf 48
5fb6c7a8
AL
49// #define _VNC_DEBUG 1
50
51#ifdef _VNC_DEBUG
52#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
53#else
54#define VNC_DEBUG(fmt, ...) do { } while (0)
55#endif
56
19a490bf
AL
57/*****************************************************************************
58 *
59 * Core data structures
60 *
61 *****************************************************************************/
62
19a490bf 63typedef struct VncState VncState;
bd023f95
CC
64typedef struct VncJob VncJob;
65typedef struct VncRect VncRect;
66typedef struct VncRectEntry VncRectEntry;
19a490bf
AL
67
68typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
69
9f64916d 70typedef void VncWritePixels(VncState *vs, void *data, int size);
19a490bf
AL
71
72typedef void VncSendHextileTile(VncState *vs,
73 int x, int y, int w, int h,
74 void *last_bg,
75 void *last_fg,
76 int *has_bg, int *has_fg);
77
b4c85ddc 78/* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
bea60dd7 79 * by one bit in the dirty bitmap, should be a power of 2 */
b4c85ddc
PL
80#define VNC_DIRTY_PIXELS_PER_BIT 16
81
bea60dd7
PL
82/* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
83
84#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
85#define VNC_MAX_HEIGHT 2048
86
23bfe28f 87/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
b4c85ddc 88#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
19a490bf 89
12b316d4
PL
90/* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
91 * VNC_DIRTY_BITS due to alignment */
92#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
93
999342a0
CC
94#define VNC_STAT_RECT 64
95#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
96#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
97
19a490bf
AL
98#define VNC_AUTH_CHALLENGE_SIZE 16
99
100typedef struct VncDisplay VncDisplay;
101
5fb6c7a8 102#include "vnc-auth-vencrypt.h"
2f9606b3
AL
103#ifdef CONFIG_VNC_SASL
104#include "vnc-auth-sasl.h"
105#endif
7536ee4b 106#include "vnc-ws.h"
2f9606b3 107
999342a0
CC
108struct VncRectStat
109{
110 /* time of last 10 updates, to find update frequency */
111 struct timeval times[10];
112 int idx;
113
114 double freq; /* Update frequency (in Hz) */
115 bool updated; /* Already updated during this refresh */
116};
117
118typedef struct VncRectStat VncRectStat;
119
1fc62412
SS
120struct VncSurface
121{
999342a0 122 struct timeval last_freq_check;
bea60dd7
PL
123 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
124 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
999342a0 125 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
9f64916d
GH
126 pixman_image_t *fb;
127 pixman_format_code_t format;
1fc62412 128};
5fb6c7a8 129
8cf36489
GH
130typedef enum VncShareMode {
131 VNC_SHARE_MODE_CONNECTING = 1,
132 VNC_SHARE_MODE_SHARED,
133 VNC_SHARE_MODE_EXCLUSIVE,
134 VNC_SHARE_MODE_DISCONNECTED,
135} VncShareMode;
136
137typedef enum VncSharePolicy {
138 VNC_SHARE_POLICY_IGNORE = 1,
139 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
140 VNC_SHARE_POLICY_FORCE_SHARED,
141} VncSharePolicy;
142
19a490bf
AL
143struct VncDisplay
144{
41b4bef6 145 QTAILQ_HEAD(, VncState) clients;
e5f34cdd
GH
146 int num_connecting;
147 int num_shared;
8cf36489 148 int num_exclusive;
e5f34cdd 149 int connections_limit;
8cf36489 150 VncSharePolicy share_policy;
13e1d0e7
DB
151 QIONetListener *listener;
152 QIONetListener *wslistener;
d39fa6d8 153 DisplaySurface *ds;
21ef45d7 154 DisplayChangeListener dcl;
c227f099 155 kbd_layout_t *kbd_layout;
3a0558b5 156 int lock_key_sync;
a54f0d2b
PO
157 QEMUPutLEDEntry *led;
158 int ledstate;
c2f2ba49 159 QKbdState *kbd;
bd023f95 160 QemuMutex mutex;
19a490bf 161
d467b679
GH
162 int cursor_msize;
163 uint8_t *cursor_mask;
164
1fc62412 165 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
9f64916d 166 pixman_image_t *server; /* vnc server surface */
69cc8db4 167 int true_width; /* server surface width before rounding up */
1fc62412 168
d616ccc5
GH
169 const char *id;
170 QTAILQ_ENTRY(VncDisplay) next;
bf7aa45e 171 bool is_unix;
19a490bf 172 char *password;
3c9405a0 173 time_t expires;
19a490bf 174 int auth;
d169f04b 175 int subauth; /* Used by VeNCrypt */
f9148c8a 176 int ws_auth; /* Used by websockets */
eda24e18 177 int ws_subauth; /* Used by websockets */
6f9c78c1 178 bool lossy;
80e0c8c3 179 bool non_adaptive;
7b5fa0b5 180 bool power_control;
3e305e4a 181 QCryptoTLSCreds *tlscreds;
b76806d4
DB
182 QAuthZ *tlsauthz;
183 char *tlsauthzid;
76655d6d
AL
184#ifdef CONFIG_VNC_SASL
185 VncDisplaySASL sasl;
186#endif
f0b9f36d
KZ
187
188 AudioState *audio_state;
19a490bf
AL
189};
190
d1af0e05
CC
191typedef struct VncTight {
192 int type;
193 uint8_t quality;
194 uint8_t compression;
195 uint8_t pixel24;
196 Buffer tight;
197 Buffer tmp;
198 Buffer zlib;
199 Buffer gradient;
200#ifdef CONFIG_VNC_JPEG
201 Buffer jpeg;
202#endif
95f8510e 203#ifdef CONFIG_PNG
d1af0e05
CC
204 Buffer png;
205#endif
206 int levels[4];
207 z_stream stream[4];
208} VncTight;
209
210typedef struct VncHextile {
211 VncSendHextileTile *send_tile;
212} VncHextile;
213
214typedef struct VncZlib {
215 Buffer zlib;
216 Buffer tmp;
217 z_stream stream;
218 int level;
219} VncZlib;
220
148954fa
CC
221typedef struct VncZrle {
222 int type;
223 Buffer fb;
224 Buffer zrle;
225 Buffer tmp;
226 Buffer zlib;
227 z_stream stream;
228 VncPalette palette;
229} VncZrle;
230
231typedef struct VncZywrle {
232 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
233} VncZywrle;
234
bd023f95
CC
235struct VncRect
236{
237 int x;
238 int y;
239 int w;
240 int h;
241};
242
243struct VncRectEntry
244{
245 struct VncRect rect;
246 QLIST_ENTRY(VncRectEntry) next;
247};
248
249struct VncJob
250{
251 VncState *vs;
252
253 QLIST_HEAD(, VncRectEntry) rectangles;
254 QTAILQ_ENTRY(VncJob) next;
255};
bd023f95 256
fef1bbad
DB
257typedef enum {
258 VNC_STATE_UPDATE_NONE,
259 VNC_STATE_UPDATE_INCREMENTAL,
260 VNC_STATE_UPDATE_FORCE,
261} VncStateUpdate;
262
f31f9c10
GH
263#define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
264
19a490bf
AL
265struct VncState
266{
f31f9c10 267 uint64_t magic;
04d2529d
DB
268 QIOChannelSocket *sioc; /* The underlying socket */
269 QIOChannel *ioc; /* The channel currently used for I/O */
270 guint ioc_tag;
271 gboolean disconnecting;
6baebed7 272
23bfe28f 273 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
7d964c9d
CC
274 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
275 * vnc-jobs-async.c */
6baebed7 276
19a490bf 277 VncDisplay *vd;
fef1bbad 278 VncStateUpdate update; /* Most recent pending request from client */
ada8d2e4 279 VncStateUpdate job_update; /* Currently processed by job thread */
63658280 280 int has_dirty;
19a490bf
AL
281 uint32_t features;
282 int absolute;
283 int last_x;
284 int last_y;
14768eba 285 uint32_t last_bmask;
4c956bd8
DB
286 size_t client_width; /* limited to u16 by RFB proto */
287 size_t client_height; /* limited to u16 by RFB proto */
8cf36489 288 VncShareMode share_mode;
19a490bf
AL
289
290 uint32_t vnc_encoding;
19a490bf
AL
291
292 int major;
293 int minor;
294
7e7e2ebc 295 int auth;
d169f04b 296 int subauth; /* Used by VeNCrypt */
19a490bf 297 char challenge[VNC_AUTH_CHALLENGE_SIZE];
2cc45228 298 QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */
2f9606b3
AL
299#ifdef CONFIG_VNC_SASL
300 VncStateSASL sasl;
301#endif
7536ee4b
TH
302 bool encode_ws;
303 bool websocket;
19a490bf 304
05eb4a25 305#ifdef CONFIG_VNC
fb6ba0d5 306 VncClientInfo *info;
05eb4a25 307#endif
4a80dba3 308
ada8d2e4
DB
309 /* Job thread bottom half has put data for a forced update
310 * into the output buffer. This offset points to the end of
311 * the update data in the output buffer. This lets us determine
312 * when a force update is fully sent to the client, allowing
313 * us to process further forced updates. */
314 size_t force_update_offset;
e2b72cb6
DB
315 /* We allow multiple incremental updates or audio capture
316 * samples to be queued in output buffer, provided the
317 * buffer size doesn't exceed this threshold. The value
318 * is calculating dynamically based on framebuffer size
319 * and audio sample settings in vnc_update_throttle_offset() */
320 size_t throttle_output_offset;
19a490bf
AL
321 Buffer output;
322 Buffer input;
323 /* current output mode information */
324 VncWritePixels *write_pixels;
9f64916d
GH
325 PixelFormat client_pf;
326 pixman_format_code_t client_format;
327 bool client_be;
19a490bf
AL
328
329 CaptureVoiceOut *audio_cap;
330 struct audsettings as;
331
332 VncReadEvent *read_handler;
333 size_t read_handler_expect;
19a490bf 334
bd023f95 335 bool abort;
bd023f95 336 QemuMutex output_mutex;
175b2a6e
CC
337 QEMUBH *bh;
338 Buffer jobs_buffer;
bd023f95
CC
339
340 /* Encoding specific, if you add something here, don't forget to
341 * update vnc_async_encoding_start()
342 */
6bf21f3d 343 VncTight *tight;
d1af0e05
CC
344 VncZlib zlib;
345 VncHextile hextile;
6bf21f3d 346 VncZrle *zrle;
148954fa 347 VncZywrle zywrle;
19a490bf 348
37c34d9d
AL
349 Notifier mouse_mode_notifier;
350
0bf41cab
GH
351 QemuClipboardPeer cbpeer;
352 QemuClipboardInfo *cbinfo;
353 uint32_t cbpending;
354
41b4bef6 355 QTAILQ_ENTRY(VncState) next;
19a490bf
AL
356};
357
e06679fb
AL
358
359/*****************************************************************************
360 *
361 * Authentication modes
362 *
363 *****************************************************************************/
364
365enum {
366 VNC_AUTH_INVALID = 0,
367 VNC_AUTH_NONE = 1,
368 VNC_AUTH_VNC = 2,
369 VNC_AUTH_RA2 = 5,
370 VNC_AUTH_RA2NE = 6,
371 VNC_AUTH_TIGHT = 16,
372 VNC_AUTH_ULTRA = 17,
2f9606b3
AL
373 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
374 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
375 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
e06679fb
AL
376};
377
e06679fb
AL
378enum {
379 VNC_AUTH_VENCRYPT_PLAIN = 256,
380 VNC_AUTH_VENCRYPT_TLSNONE = 257,
381 VNC_AUTH_VENCRYPT_TLSVNC = 258,
382 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
383 VNC_AUTH_VENCRYPT_X509NONE = 260,
384 VNC_AUTH_VENCRYPT_X509VNC = 261,
385 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
2f9606b3
AL
386 VNC_AUTH_VENCRYPT_X509SASL = 263,
387 VNC_AUTH_VENCRYPT_TLSSASL = 264,
e06679fb
AL
388};
389
e06679fb
AL
390
391/*****************************************************************************
392 *
393 * Encoding types
394 *
395 *****************************************************************************/
396
397#define VNC_ENCODING_RAW 0x00000000
398#define VNC_ENCODING_COPYRECT 0x00000001
399#define VNC_ENCODING_RRE 0x00000002
400#define VNC_ENCODING_CORRE 0x00000004
401#define VNC_ENCODING_HEXTILE 0x00000005
402#define VNC_ENCODING_ZLIB 0x00000006
403#define VNC_ENCODING_TIGHT 0x00000007
404#define VNC_ENCODING_ZLIBHEX 0x00000008
405#define VNC_ENCODING_TRLE 0x0000000f
406#define VNC_ENCODING_ZRLE 0x00000010
407#define VNC_ENCODING_ZYWRLE 0x00000011
408#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
409#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
410#define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
411#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
412#define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
413#define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
414#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
415#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
416#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
417#define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
efe556ad 418#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
ab99e5c1 419#define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
a7d83e43 420#define VNC_ENCODING_DESKTOP_RESIZE_EXT 0XFFFFFECC /* -308 */
7b5fa0b5 421#define VNC_ENCODING_XVP 0XFFFFFECB /* -309 */
a7d83e43 422#define VNC_ENCODING_ALPHA_CURSOR 0XFFFFFEC6 /* -314 */
e06679fb 423#define VNC_ENCODING_WMVi 0x574D5669
0bf41cab 424#define VNC_ENCODING_CLIPBOARD_EXT 0xc0a1e5ce
e06679fb
AL
425
426/*****************************************************************************
427 *
428 * Other tight constants
429 *
430 *****************************************************************************/
431
432/*
433 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
434 */
435
436#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
437#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
438#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
439#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
efe556ad 440#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
e06679fb
AL
441#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
442#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
443#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
444
445/*****************************************************************************
446 *
447 * Features
448 *
449 *****************************************************************************/
450
b0c693fa
GH
451enum VncFeatures {
452 VNC_FEATURE_RESIZE,
763deea7 453 VNC_FEATURE_RESIZE_EXT,
b0c693fa
GH
454 VNC_FEATURE_HEXTILE,
455 VNC_FEATURE_POINTER_TYPE_CHANGE,
456 VNC_FEATURE_WMVI,
457 VNC_FEATURE_TIGHT,
458 VNC_FEATURE_ZLIB,
b0c693fa 459 VNC_FEATURE_RICH_CURSOR,
074a86d0 460 VNC_FEATURE_ALPHA_CURSOR,
b0c693fa
GH
461 VNC_FEATURE_TIGHT_PNG,
462 VNC_FEATURE_ZRLE,
463 VNC_FEATURE_ZYWRLE,
464 VNC_FEATURE_LED_STATE,
7b5fa0b5 465 VNC_FEATURE_XVP,
0bf41cab 466 VNC_FEATURE_CLIPBOARD_EXT,
9e58d7a7 467 VNC_FEATURE_AUDIO,
b0c693fa 468};
e06679fb
AL
469
470#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
763deea7 471#define VNC_FEATURE_RESIZE_EXT_MASK (1 << VNC_FEATURE_RESIZE_EXT)
e06679fb
AL
472#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
473#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
474#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
475#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
476#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
d467b679 477#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
074a86d0 478#define VNC_FEATURE_ALPHA_CURSOR_MASK (1 << VNC_FEATURE_ALPHA_CURSOR)
efe556ad 479#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
148954fa
CC
480#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
481#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
ab99e5c1 482#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
7b5fa0b5 483#define VNC_FEATURE_XVP_MASK (1 << VNC_FEATURE_XVP)
0bf41cab 484#define VNC_FEATURE_CLIPBOARD_EXT_MASK (1 << VNC_FEATURE_CLIPBOARD_EXT)
9e58d7a7 485#define VNC_FEATURE_AUDIO_MASK (1 << VNC_FEATURE_AUDIO)
e06679fb 486
5fb6c7a8 487
46a183da
DB
488/* Client -> Server message IDs */
489#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
490#define VNC_MSG_CLIENT_SET_ENCODINGS 2
491#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
492#define VNC_MSG_CLIENT_KEY_EVENT 4
493#define VNC_MSG_CLIENT_POINTER_EVENT 5
494#define VNC_MSG_CLIENT_CUT_TEXT 6
495#define VNC_MSG_CLIENT_VMWARE_0 127
496#define VNC_MSG_CLIENT_CALL_CONTROL 249
497#define VNC_MSG_CLIENT_XVP 250
498#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
499#define VNC_MSG_CLIENT_TIGHT 252
500#define VNC_MSG_CLIENT_GII 253
501#define VNC_MSG_CLIENT_VMWARE_1 254
502#define VNC_MSG_CLIENT_QEMU 255
503
504/* Server -> Client message IDs */
505#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
506#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
507#define VNC_MSG_SERVER_BELL 2
508#define VNC_MSG_SERVER_CUT_TEXT 3
509#define VNC_MSG_SERVER_VMWARE_0 127
510#define VNC_MSG_SERVER_CALL_CONTROL 249
511#define VNC_MSG_SERVER_XVP 250
512#define VNC_MSG_SERVER_TIGHT 252
513#define VNC_MSG_SERVER_GII 253
514#define VNC_MSG_SERVER_VMWARE_1 254
515#define VNC_MSG_SERVER_QEMU 255
516
517
518
519/* QEMU client -> server message IDs */
520#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
521#define VNC_MSG_CLIENT_QEMU_AUDIO 1
522
523/* QEMU server -> client message IDs */
524#define VNC_MSG_SERVER_QEMU_AUDIO 1
525
526
527
528/* QEMU client -> server audio message IDs */
529#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
530#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
531#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
532
533/* QEMU server -> client audio message IDs */
534#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
535#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
536#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
537
7b5fa0b5
DB
538/* XVP server -> client status code */
539#define VNC_XVP_CODE_FAIL 0
540#define VNC_XVP_CODE_INIT 1
541
542/* XVP client -> server action request */
543#define VNC_XVP_ACTION_SHUTDOWN 2
544#define VNC_XVP_ACTION_REBOOT 3
545#define VNC_XVP_ACTION_RESET 4
546
0bf41cab
GH
547/* extended clipboard flags */
548#define VNC_CLIPBOARD_TEXT (1 << 0)
549#define VNC_CLIPBOARD_RTF (1 << 1)
550#define VNC_CLIPBOARD_HTML (1 << 2)
551#define VNC_CLIPBOARD_DIB (1 << 3)
552#define VNC_CLIPBOARD_FILES (1 << 4)
553#define VNC_CLIPBOARD_CAPS (1 << 24)
554#define VNC_CLIPBOARD_REQUEST (1 << 25)
555#define VNC_CLIPBOARD_PEEK (1 << 26)
556#define VNC_CLIPBOARD_NOTIFY (1 << 27)
557#define VNC_CLIPBOARD_PROVIDE (1 << 28)
46a183da 558
5fb6c7a8
AL
559/*****************************************************************************
560 *
561 * Internal APIs
562 *
563 *****************************************************************************/
564
565/* Event loop functions */
04d2529d
DB
566gboolean vnc_client_io(QIOChannel *ioc,
567 GIOCondition condition,
568 void *opaque);
5fb6c7a8 569
30b80fd5
DB
570size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
571size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
5fb6c7a8
AL
572
573/* Protocol I/O functions */
574void vnc_write(VncState *vs, const void *data, size_t len);
575void vnc_write_u32(VncState *vs, uint32_t value);
576void vnc_write_s32(VncState *vs, int32_t value);
577void vnc_write_u16(VncState *vs, uint16_t value);
578void vnc_write_u8(VncState *vs, uint8_t value);
579void vnc_flush(VncState *vs);
580void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
7536ee4b 581void vnc_disconnect_finish(VncState *vs);
dbee9897 582void vnc_start_protocol(VncState *vs);
5fb6c7a8
AL
583
584
585/* Buffer I/O functions */
5fb6c7a8
AL
586uint32_t read_u32(uint8_t *data, size_t offset);
587
588/* Protocol stage functions */
589void vnc_client_error(VncState *vs);
34ab29c2 590size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error *err);
5fb6c7a8
AL
591
592void start_client_init(VncState *vs);
593void start_auth_vnc(VncState *vs);
594
2f9606b3
AL
595
596/* Misc helpers */
597
efe556ad
CC
598static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
599 return (vs->features & (1 << feature));
600}
601
70a4568f
CC
602/* Framebuffer */
603void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
604 int32_t encoding);
605
9f64916d
GH
606/* server fb is in PIXMAN_x8r8g8b8 */
607#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
608#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
609#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
610
611void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
612int vnc_server_fb_stride(VncDisplay *vd);
613
70a4568f 614void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
999342a0 615double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
7d964c9d 616void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
70a4568f
CC
617
618/* Encodings */
bd023f95
CC
619int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
620
a885211e 621int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
70a4568f 622
a885211e 623int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
70a4568f
CC
624 int y, int w, int h);
625void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
626
380282b0
CC
627void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
628void vnc_zlib_zfree(void *x, void *addr);
a885211e 629int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
161c4f20 630void vnc_zlib_clear(VncState *vs);
70a4568f 631
380282b0 632int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
efe556ad
CC
633int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
634 int w, int h);
380282b0
CC
635void vnc_tight_clear(VncState *vs);
636
148954fa
CC
637int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
638int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
639void vnc_zrle_clear(VncState *vs);
640
0bf41cab
GH
641/* vnc-clipboard.c */
642void vnc_server_cut_text_caps(VncState *vs);
643void vnc_client_cut_text(VncState *vs, size_t len, uint8_t *text);
644void vnc_client_cut_text_ext(VncState *vs, int32_t len, uint32_t flags, uint8_t *data);
645
2a6a4076 646#endif /* QEMU_VNC_H */