ui/vnc.h

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