ironrdp-graphics

Version: 0.7.0
Docs.rs: ironrdp-graphics

Overview

The ironrdp-graphics crate provides image processing primitives and compression algorithms used in RDP graphics rendering:

Color space conversions (RGB ↔ YUV)
Image compression (RLE, RLGR)
Bulk compression (ZGFX)
RemoteFX encoding components (DWT, quantization)
Bitmap difference calculations

Key Modules

Color Conversion

use ironrdp_graphics::color_conversion::*;

Convert between RGB and YUV color spaces for video compression.

Compression Algorithms

RLE (Run-Length Encoding)

use ironrdp_graphics::rle::*;

pub mod rle {
    pub struct Code(u8);
    
    impl Code {
        pub const REGULAR_BG_RUN: Self = Self(0x00);
        pub const MEGA_MEGA_BG_RUN: Self = Self(0xF0);
        // ... other codes
    }
}

RLE compression for bitmap data.

RLGR (Run-Length Golomb-Rice)

use ironrdp_graphics::rlgr::*;
use ironrdp_pdu::codecs::rfx::EntropyAlgorithm;

pub fn encode(
    mode: EntropyAlgorithm,
    input: &[i16],
    output: &mut [u8]
) -> Result<usize, RlgrError>

Entropy encoding used in RemoteFX.

ZGFX (Bulk Compression)

use ironrdp_graphics::zgfx::*;

pub struct Decompressor { /* ... */ }

impl Decompressor {
    pub fn new() -> Self;
    pub fn decompress(&mut self, input: &[u8], output: &mut [u8]) -> Result<usize, ZgfxError>;
}

Bulk compression for large data transfers.

RemoteFX Components

DWT (Discrete Wavelet Transform)

use ironrdp_graphics::dwt::*;

pub fn encode(input: &mut [i16], temp: &mut [i16]);
pub fn decode(input: &mut [i16], temp: &mut [i16]);

Wavelet transform used in RemoteFX image encoding.

Quantization

use ironrdp_graphics::quantization::*;
use ironrdp_pdu::codecs::rfx::Quant;

pub fn encode(data: &mut [i16], quant: &Quant);
pub fn decode(data: &mut [i16], quant: &Quant);

Quantization for lossy compression in RemoteFX.

Subband Reconstruction

use ironrdp_graphics::subband_reconstruction::*;

pub fn encode(ll3: &mut [i16]);
pub fn decode(ll3: &mut [i16]);

Reconstruct image subbands after wavelet transform.

RDP 6 Compression

use ironrdp_graphics::rdp6::*;

RDP 6.0/6.1 specific compression algorithms.

Image Processing Utilities

use ironrdp_graphics::image_processing::*;

General image manipulation functions.

Rectangle Processing

use ironrdp_graphics::rectangle_processing::*;

Rectangle and region calculations.

Bitmap Difference

use ironrdp_graphics::diff::*;

Compute differences between bitmap frames.

Pointer (Cursor) Handling

use ironrdp_graphics::pointer::*;

Cursor image processing.

RemoteFX Encoding

The crate provides a high-level function for encoding RemoteFX components:

pub fn rfx_encode_component(
    input: &mut [i16],
    output: &mut [u8],
    quant: &ironrdp_pdu::codecs::rfx::Quant,
    mode: ironrdp_pdu::codecs::rfx::EntropyAlgorithm,
) -> Result<usize, rlgr::RlgrError>

Parameters:

&mut [i16]

Component data (must be 4096 elements = 64×64 pixels). Modified in-place during encoding.

&mut [u8]

Buffer to receive encoded data

&Quant

Quantization parameters from ironrdp_pdu::codecs::rfx::Quant

EntropyAlgorithm

Entropy algorithm (RLGR1 or RLGR3)

Panics: Panics if input.len() != 4096. Example:

use ironrdp_graphics::rfx_encode_component;
use ironrdp_pdu::codecs::rfx::{Quant, EntropyAlgorithm};

let mut input = vec![0i16; 64 * 64];
let mut output = vec![0u8; 8192];

let quant = Quant::default();
let encoded_size = rfx_encode_component(
    &mut input,
    &mut output,
    &quant,
    EntropyAlgorithm::Rlgr3,
)?;

The encoding pipeline:

DWT (Discrete Wavelet Transform)
Quantization
Subband reconstruction
RLGR entropy encoding

Dependencies

This crate depends on:

ironrdp-core - Core traits (public)
ironrdp-pdu - PDU structures for codec parameters (public)
yuv - YUV color conversion with RDP-specific features
bit_field, bitflags, bitvec - Bit manipulation

Usage Notes

Performance:
Many functions in this crate operate on large buffers in-place. Pre-allocate buffers and reuse them to avoid repeated allocations:

let mut temp = vec![0i16; 64 * 64];
for tile in tiles {
    ironrdp_graphics::dwt::encode(&mut tile, &mut temp);
}

Image Formats:
RemoteFX operates on 64×64 tiles in YUV color space. Convert from RGB before encoding:

use ironrdp_graphics::color_conversion::rgb_to_yuv;

// Convert RGB tile to YUV
let (y, u, v) = rgb_to_yuv(&rgb_data, width, height);

Core Tier

Virtual Channels

I/O & Integration

Client & Server

Specialized

ironrdp-graphics

Overview

Key Modules

Color Conversion

Compression Algorithms

RLE (Run-Length Encoding)

RLGR (Run-Length Golomb-Rice)

ZGFX (Bulk Compression)

RemoteFX Components

DWT (Discrete Wavelet Transform)

Quantization

Subband Reconstruction

RDP 6 Compression

Image Processing Utilities

Rectangle Processing

Bitmap Difference

Pointer (Cursor) Handling

RemoteFX Encoding

Dependencies

Usage Notes

See Also

​Overview

​Key Modules

​Color Conversion

​Compression Algorithms

​RLE (Run-Length Encoding)

​RLGR (Run-Length Golomb-Rice)

​ZGFX (Bulk Compression)

​RemoteFX Components

​DWT (Discrete Wavelet Transform)

​Quantization

​Subband Reconstruction

​RDP 6 Compression

​Image Processing Utilities

​Rectangle Processing

​Bitmap Difference

​Pointer (Cursor) Handling

​RemoteFX Encoding

​Dependencies

​Usage Notes

​See Also

Overview

Key Modules

Color Conversion

Compression Algorithms

RLE (Run-Length Encoding)

RLGR (Run-Length Golomb-Rice)

ZGFX (Bulk Compression)

RemoteFX Components

DWT (Discrete Wavelet Transform)

Quantization

Subband Reconstruction

RDP 6 Compression

Image Processing Utilities

Rectangle Processing

Bitmap Difference

Pointer (Cursor) Handling

RemoteFX Encoding

Dependencies

Usage Notes

See Also