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