feat: add QOIZ image codec

Add a new QOIZ codec (UUID 229cc6dc-a860-4b52-b4d8-053a22b3892b) for
SetSurface command. The PDU data contains the same data as the QOI
codec, with zstd compression.

Some benchmarks showing interesting results (using ironrdp/perfenc)

QOI: 10s user CPU, 96.20% compression
QOIZ: 11s user CPU, 99.76% compression

Signed-off-by: Marc-André Lureau <[email protected]>

Author: elmarco

Cargo.lock

@@ -10,8 +10,9 @@ name = "perfenc"
 path = "src/perfenc.rs"
 
 [features]
-default = ["qoi"]
+default = ["qoi", "qoiz"]
 qoi = ["ironrdp/qoi"]
+qoiz = ["ironrdp/qoiz"]
 
 [dependencies]
 anyhow = "1.0.98"

benches/Cargo.toml

@@ -13,6 +13,7 @@ use ironrdp::server::{
 };
 use tokio::{fs::File, io::AsyncReadExt, time::sleep};
 
+#[allow(clippy::similar_names)]
 #[tokio::main(flavor = "current_thread")]
 async fn main() -> Result<(), anyhow::Error> {
     setup_logging()?;
@@ -27,7 +28,7 @@ async fn main() -> Result<(), anyhow::Error> {
         println!("  --width <WIDTH>      Width of the display (default: 3840)");
         println!("  --height <HEIGHT>    Height of the display (default: 2400)");
         println!("  --codec <CODEC>      Codec to use (default: remotefx)");
-        println!("                        Valid values: qoi, remotefx, bitmap, none");
+        println!("                        Valid values: qoi, qoiz, remotefx, bitmap, none");
         println!("  --fps <FPS>          Frames per second (default: none)");
         std::process::exit(0);
     }
@@ -53,6 +54,8 @@ async fn main() -> Result<(), anyhow::Error> {
         OptCodec::None => {}
         #[cfg(feature = "qoi")]
         OptCodec::Qoi => update_codecs.set_qoi(Some(0)),
+        #[cfg(feature = "qoiz")]
+        OptCodec::QoiZ => update_codecs.set_qoiz(Some(0)),
     };
 
     let mut encoder = UpdateEncoder::new(DesktopSize { width, height }, flags, update_codecs);
@@ -175,6 +178,8 @@ enum OptCodec {
     None,
     #[cfg(feature = "qoi")]
     Qoi,
+    #[cfg(feature = "qoiz")]
+    QoiZ,
 }
 
 impl Default for OptCodec {
@@ -193,6 +198,8 @@ impl core::str::FromStr for OptCodec {
             "none" => Ok(Self::None),
             #[cfg(feature = "qoi")]
             "qoi" => Ok(Self::Qoi),
+            #[cfg(feature = "qoiz")]
+            "qoiz" => Ok(Self::QoiZ),
             _ => Err(anyhow::anyhow!("unknown codec: {}", s)),
         }
     }

benches/src/perfenc.rs

@@ -28,6 +28,7 @@ default = ["rustls"]
 rustls = ["ironrdp-tls/rustls", "tokio-tungstenite/rustls-tls-native-roots"]
 native-tls = ["ironrdp-tls/native-tls", "tokio-tungstenite/native-tls"]
 qoi = ["ironrdp/qoi"]
+qoiz = ["ironrdp/qoiz"]
 
 [dependencies]
 # Protocols

crates/ironrdp-client/Cargo.toml

@@ -19,6 +19,7 @@ test = false
 default = []
 arbitrary = ["dep:arbitrary"]
 qoi = ["ironrdp-pdu/qoi"]
+qoiz = ["ironrdp-pdu/qoiz"]
 
 [dependencies]
 ironrdp-svc = { path = "../ironrdp-svc", version = "0.3" } # public

crates/ironrdp-connector/Cargo.toml

@@ -20,6 +20,7 @@ default = []
 std = ["alloc", "ironrdp-error/std", "ironrdp-core/std"]
 alloc = ["ironrdp-core/alloc", "ironrdp-error/alloc"]
 qoi = []
+qoiz = ["qoi"]
 
 [dependencies]
 bitflags = "2.4"

crates/ironrdp-pdu/Cargo.toml

@@ -34,7 +34,7 @@ pub use self::bitmap_cache::{
 pub use self::bitmap_codecs::{
     client_codecs_capabilities, server_codecs_capabilities, BitmapCodecs, CaptureFlags, Codec, CodecId, CodecProperty,
     EntropyBits, Guid, NsCodec, RemoteFxContainer, RfxCaps, RfxCapset, RfxClientCapsContainer, RfxICap, RfxICapFlags,
-    CODEC_ID_NONE, CODEC_ID_QOI, CODEC_ID_REMOTEFX,
+    CODEC_ID_NONE, CODEC_ID_QOI, CODEC_ID_QOIZ, CODEC_ID_REMOTEFX,
 };
 pub use self::brush::{Brush, SupportLevel};
 pub use self::frame_acknowledge::FrameAcknowledge;

crates/ironrdp-pdu/src/rdp/capability_sets.rs

@@ -43,6 +43,9 @@ const GUID_IGNORE: Guid = Guid(0x9c43_51a6, 0x3535, 0x42ae, 0x91, 0x0c, 0xcd, 0x
 #[rustfmt::skip]
 #[cfg(feature="qoi")]
 const GUID_QOI: Guid = Guid(0x4dae_9af8, 0xb399, 0x4df6, 0xb4, 0x3a, 0x66, 0x2f, 0xd9, 0xc0, 0xf5, 0xd6);
+#[rustfmt::skip]
+#[cfg(feature="qoiz")]
+const GUID_QOIZ: Guid = Guid(0x229c_c6dc, 0xa860, 0x4b52, 0xb4, 0xd8, 0x05, 0x3a, 0x22, 0xb3, 0x89, 0x2b);
 
 #[derive(Debug, PartialEq, Eq)]
 pub struct Guid(u32, u16, u16, u8, u8, u8, u8, u8, u8, u8, u8);
@@ -172,6 +175,8 @@ impl Encode for Codec {
             CodecProperty::Ignore => GUID_IGNORE,
             #[cfg(feature = "qoi")]
             CodecProperty::Qoi => GUID_QOI,
+            #[cfg(feature = "qoiz")]
+            CodecProperty::QoiZ => GUID_QOIZ,
             _ => return Err(other_err!("invalid codec")),
         };
         guid.encode(dst)?;
@@ -211,6 +216,8 @@ impl Encode for Codec {
             }
             #[cfg(feature = "qoi")]
             CodecProperty::Qoi => dst.write_u16(0),
+            #[cfg(feature = "qoiz")]
+            CodecProperty::QoiZ => dst.write_u16(0),
             CodecProperty::Ignore => dst.write_u16(0),
             CodecProperty::None => dst.write_u16(0),
         };
@@ -236,6 +243,8 @@ impl Encode for Codec {
                 },
                 #[cfg(feature = "qoi")]
                 CodecProperty::Qoi => 0,
+                #[cfg(feature = "qoiz")]
+                CodecProperty::QoiZ => 0,
                 CodecProperty::Ignore => 0,
                 CodecProperty::None => 0,
             }
@@ -280,6 +289,13 @@ impl<'de> Decode<'de> for Codec {
                 }
                 CodecProperty::Qoi
             }
+            #[cfg(feature = "qoiz")]
+            GUID_QOIZ => {
+                if !property_buffer.is_empty() {
+                    return Err(invalid_field_err!("qoi property", "must be empty"));
+                }
+                CodecProperty::QoiZ
+            }
             _ => CodecProperty::None,
         };
 
@@ -301,6 +317,8 @@ pub enum CodecProperty {
     Ignore,
     #[cfg(feature = "qoi")]
     Qoi,
+    #[cfg(feature = "qoiz")]
+    QoiZ,
     None,
 }
 
@@ -639,13 +657,15 @@ pub struct CodecId(u8);
 pub const CODEC_ID_NONE: CodecId = CodecId(0);
 pub const CODEC_ID_REMOTEFX: CodecId = CodecId(3);
 pub const CODEC_ID_QOI: CodecId = CodecId(0x0A);
+pub const CODEC_ID_QOIZ: CodecId = CodecId(0x0B);
 
 impl Debug for CodecId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let name = match self.0 {
             0 => "None",
             3 => "RemoteFx",
             0x0A => "QOI",
+            0x0B => "QOIZ",
             _ => "unknown",
         };
         write!(f, "CodecId({})", name)
@@ -658,6 +678,7 @@ impl CodecId {
             0 => Some(CODEC_ID_NONE),
             3 => Some(CODEC_ID_REMOTEFX),
             0x0A => Some(CODEC_ID_QOI),
+            0x0B => Some(CODEC_ID_QOIZ),
             _ => None,
         }
     }
@@ -700,6 +721,7 @@ fn parse_codecs_config<'a>(codecs: &'a [&'a str]) -> Result<HashMap<&'a str, boo
 ///
 /// * `remotefx` (on by default)
 /// * `qoi` (on by default, when feature "qoi")
+/// * `qoiz` (on by default, when feature "qoiz")
 ///
 /// # Returns
 ///
@@ -711,6 +733,7 @@ pub fn client_codecs_capabilities(config: &[&str]) -> Result<BitmapCodecs, Strin
 List of codecs:
 - `remotefx` (on by default)
 - `qoi` (on by default, when feature "qoi")
+- `qoiz` (on by default, when feature "qoiz")
 "#
         .to_owned());
     }
@@ -739,6 +762,14 @@ List of codecs:
         });
     }
 
+    #[cfg(feature = "qoiz")]
+    if config.remove("qoiz").unwrap_or(true) {
+        codecs.push(Codec {
+            id: CODEC_ID_QOIZ.0,
+            property: CodecProperty::QoiZ,
+        });
+    }
+
     let codec_names = config.keys().copied().collect::<Vec<_>>().join(", ");
     if !codec_names.is_empty() {
         return Err(format!("Unknown codecs: {}", codec_names));
@@ -761,6 +792,7 @@ List of codecs:
 ///
 /// * `remotefx` (on by default)
 /// * `qoi` (on by default, when feature "qoi")
+/// * `qoiz` (on by default, when feature "qoiz")
 ///
 /// # Returns
 ///
@@ -771,6 +803,7 @@ pub fn server_codecs_capabilities(config: &[&str]) -> Result<BitmapCodecs, Strin
 List of codecs:
 - `remotefx` (on by default)
 - `qoi` (on by default, when feature "qoi")
+- `qoiz` (on by default, when feature "qoiz")
 "#
         .to_owned());
     }
@@ -797,6 +830,14 @@ List of codecs:
         });
     }
 
+    #[cfg(feature = "qoiz")]
+    if config.remove("qoiz").unwrap_or(true) {
+        codecs.push(Codec {
+            id: 0,
+            property: CodecProperty::QoiZ,
+        });
+    }
+
     let codec_names = config.keys().copied().collect::<Vec<_>>().join(", ");
     if !codec_names.is_empty() {
         return Err(format!("Unknown codecs: {}", codec_names));

crates/ironrdp-pdu/src/rdp/capability_sets/bitmap_codecs.rs

@@ -16,10 +16,11 @@ doctest = true
 test = false
 
 [features]
-default = ["rayon", "qoi"]
+default = ["rayon", "qoi", "qoiz"]
 helper = ["dep:x509-cert", "dep:rustls-pemfile"]
 rayon = ["dep:rayon"]
 qoi = ["dep:qoi", "ironrdp-pdu/qoi"]
+qoiz = ["dep:zstd-safe", "qoi", "ironrdp-pdu/qoiz"]
 
 # Internal (PRIVATE!) features used to aid testing.
 # Don't rely on these whatsoever. They may disappear at any time.
@@ -49,6 +50,7 @@ rayon = { version = "1.10.0", optional = true }
 bytes = "1"
 visibility = { version = "0.1", optional = true }
 qoi = { version = "0.4", optional = true }
+zstd-safe = { version = "7.2", optional = true }
 
 [dev-dependencies]
 tokio = { version = "1", features = ["sync"] }