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