rfb-encodings

RFB (Remote Framebuffer) protocol encoding implementations for VNC.

Support this project:

Bitcoin (BTC)

3QVD3H1ryqyxhuf8hNTTuBXSbczNuAKaM8

Ethereum (ETH)

0xaFE28A1Dd57660610Ef46C05EfAA363356e98DC7

Solana (SOL)

6uWx4wuHERBpNxyWjeQKrMLBVte91aBzkHaJb8rhw4rn

Monero (XMR)

8C5aCs7Api3WE67GMw54AhQKnJsCg6CVffCuPxUcaKoiMrnaicyvDch8M2CXTm1DJqhpHKxtLvum9Thw4yHn8zeu7sj8qmC

This crate provides encoding implementations for the VNC/RFB protocol, including all standard encodings defined in RFC 6143. It can be used to build VNC servers, clients, proxies, or recorders.

Supported Encodings

*Untested encodings: ZlibHex, CoRRE, and ZYWRLE are fully implemented and RFC 6143 compliant but cannot be tested with noVNC (most common VNC client) because noVNC doesn't support them. All three have been code-reviewed and verified against the RFC 6143 specification. Use the widely-supported alternatives: Zlib (instead of ZlibHex), Hextile (instead of CoRRE), and ZRLE (instead of ZYWRLE).

Features

• Pure Rust - Memory-safe implementation with no unsafe code
• RFC 6143 Compliant - Follows the official RFB protocol specification
• Persistent Streams - Maintains zlib compression state for better compression ratios
• Pixel Format Translation - Supports all VNC pixel formats (8/16/24/32-bit)
• Optional TurboJPEG - Hardware-accelerated JPEG compression via feature flag

Usage

Add this to your Cargo.toml:

[dependencies]
rfb-encodings = "0.1"

Basic Example

use rfb_encodings::{Encoding, TightEncoding, PixelFormat};

// Create encoder
let encoder = TightEncoding;

// Encode RGBA pixel data
let rgba_data: Vec<u8> = vec![/* your pixel data */];
let width = 1920;
let height = 1080;
let quality = 9;  // 0-9, higher is better quality
let compression = 6;  // 0-9, higher is more compression

let encoded = encoder.encode(&rgba_data, width, height, quality, compression);

Advanced Usage with Persistent Streams

For better compression with Tight encoding:

use rfb_encodings::{
    encode_tight_rects, SimpleTightCompressor, PixelFormat
};

let mut compressor = SimpleTightCompressor::new(6);
let client_format = PixelFormat::rgba32();

let rectangles = encode_tight_rects(
    &rgba_data,
    width,
    height,
    9,  // quality
    6,  // compression
    &client_format,
    &mut compressor
);

// Returns Vec<(x, y, width, height, encoded_data)>
for (x, y, w, h, data) in rectangles {
    // Send rectangle to VNC client
}

Features

• turbojpeg - Enable TurboJPEG for hardware-accelerated JPEG compression in Tight encoding
• debug-logging - Enable verbose debug logging for troubleshooting

Enable features in your Cargo.toml:

[dependencies]
rfb-encodings = { version = "0.1", features = ["turbojpeg", "debug-logging"] }

TurboJPEG Installation

The turbojpeg feature requires libjpeg-turbo to be installed on your system:

Ubuntu/Debian:

sudo apt-get install libturbojpeg0-dev

macOS:

brew install jpeg-turbo

Windows: Download from libjpeg-turbo.org

Architecture

This crate is designed to be reusable across different VNC implementations:

• encoding modules - Individual encoder implementations
• PixelFormat - VNC pixel format definition and utilities
• translate - Pixel format translation between different color depths
• TightStreamCompressor trait - Interface for persistent zlib streams

Third-Party Dependencies

Optional: libjpeg-turbo (TurboJPEG)

When using the turbojpeg feature, this crate provides FFI bindings to libjpeg-turbo, which must be installed separately on your system. libjpeg-turbo is licensed under a BSD-style license (BSD-3-Clause, IJG, and zlib components).

License Information:

• libjpeg-turbo: BSD-3-Clause, IJG License, zlib License
• Note: You are responsible for ensuring compliance with libjpeg-turbo's license terms when using the turbojpeg feature.

License

This crate is licensed under the Apache License, Version 2.0. See LICENSE for details.

The turbojpeg feature provides optional bindings to libjpeg-turbo, which is licensed separately. See above for details.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.