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