WIP: Add QOI codec

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

Author: elmarco

Cargo.lock

@@ -1,24 +1,23 @@
 [workspace]
-members = [
-  "crates/*",
-  "xtask",
-  "ffi",
-]
+members = ["crates/*", "xtask", "ffi"]
 resolver = "2"
 
 # FIXME: fix compilation
 exclude = [
-  "crates/ironrdp-client-glutin",
-  "crates/ironrdp-glutin-renderer",
-  "crates/ironrdp-replay-client",
+    "crates/ironrdp-client-glutin",
+    "crates/ironrdp-glutin-renderer",
+    "crates/ironrdp-replay-client",
 ]
 
 [workspace.package]
 edition = "2021"
 license = "MIT OR Apache-2.0"
 homepage = "https://github.com/Devolutions/IronRDP"
 repository = "https://github.com/Devolutions/IronRDP"
-authors = ["Devolutions Inc. <[email protected]>", "Teleport <goteleport.com>"]
+authors = [
+    "Devolutions Inc. <[email protected]>",
+    "Teleport <goteleport.com>",
+]
 keywords = ["rdp", "remote-desktop", "network", "client", "protocol"]
 categories = ["network-programming"]
 
@@ -61,6 +60,7 @@ bitflags = "2.4"
 expect-test = "1"
 png = "0.17"
 proptest = "1.4"
+qoi = "0.4"
 rstest = "0.18"
 sspi = "0.15"
 tracing = { version = "0.1", features = ["log"] }
@@ -82,7 +82,7 @@ unsafe_op_in_unsafe_fn = "warn"
 invalid_reference_casting = "warn"
 
 # == Style, readability == #
-elided_lifetimes_in_paths = "warn" # https://quinedot.github.io/rust-learning/dont-hide.html
+elided_lifetimes_in_paths = "warn"              # https://quinedot.github.io/rust-learning/dont-hide.html
 absolute_paths_not_starting_with_crate = "warn"
 single_use_lifetimes = "warn"
 unreachable_pub = "warn"
@@ -118,14 +118,14 @@ as_underscore = "warn"
 large_stack_frames = "warn"
 
 # == Style, readability == #
-semicolon_outside_block = "warn" # With semicolon-outside-block-ignore-multiline = true
+semicolon_outside_block = "warn"     # With semicolon-outside-block-ignore-multiline = true
 clone_on_ref_ptr = "warn"
 cloned_instead_of_copied = "warn"
 trait_duplication_in_bounds = "warn"
 type_repetition_in_bounds = "warn"
 checked_conversions = "warn"
 get_unwrap = "warn"
-similar_names = "warn" # Reduce risk of confusing similar names together, and protects against typos when variable shadowing was intended.
+similar_names = "warn"               # Reduce risk of confusing similar names together, and protects against typos when variable shadowing was intended.
 str_to_string = "warn"
 string_to_string = "warn"
 std_instead_of_core = "warn"

Cargo.toml

@@ -27,6 +27,7 @@ test = false
 default = ["rustls"]
 rustls = ["ironrdp-tls/rustls"]
 native-tls = ["ironrdp-tls/native-tls"]
+qoi = ["ironrdp/qoi"]
 
 [dependencies]
 
@@ -41,7 +42,7 @@ ironrdp = { workspace = true, features = [
     "rdpsnd",
     "cliprdr",
     "displaycontrol",
-    "connector"
+    "connector",
 ] }
 ironrdp-cliprdr-native.workspace = true
 ironrdp-rdpsnd-native.workspace = true
@@ -78,7 +79,7 @@ reqwest = "0.12"
 url = "2.5"
 raw-window-handle = "0.6.2"
 ironrdp-core = { workspace = true, features = ["alloc"] }
-uuid = { version = "1.12.1"}
+uuid = { version = "1.12.1" }
 
 [target.'cfg(windows)'.dependencies]
 windows = { workspace = true, features = ["Win32_Foundation"] }

crates/ironrdp-client/Cargo.toml

@@ -263,6 +263,8 @@ impl Config {
             Some(connector::BitmapConfig {
                 color_depth,
                 lossy_compression: true,
+                #[cfg(feature = "qoi")]
+                with_qoi: true,
             })
         } else {
             None

crates/ironrdp-client/src/config.rs

@@ -17,6 +17,7 @@ test = false
 
 [features]
 arbitrary = ["dep:arbitrary"]
+qoi = ["ironrdp-pdu/qoi"]
 
 [dependencies]
 arbitrary = { version = "1", features = ["derive"], optional = true }

crates/ironrdp-connector/Cargo.toml

@@ -279,6 +279,24 @@ fn create_client_confirm_active(
         BitmapDrawingFlags::ALLOW_SKIP_ALPHA
     };
 
+    #[allow(unused_mut)]
+    let mut bitmap_codecs = vec![Codec {
+        id: 0x03, // RemoteFX
+        property: CodecProperty::RemoteFx(RemoteFxContainer::ClientContainer(RfxClientCapsContainer {
+            capture_flags: CaptureFlags::empty(),
+            caps_data: RfxCaps(RfxCapset(vec![RfxICap {
+                flags: RfxICapFlags::empty(),
+                entropy_bits: EntropyBits::Rlgr3,
+            }])),
+        })),
+    }];
+
+    #[cfg(feature = "qoi")]
+    bitmap_codecs.push(Codec {
+        id: 0x0A, // QOI
+        property: CodecProperty::QOI,
+    });
+
     server_capability_sets.extend_from_slice(&[
         CapabilitySet::General(General {
             major_platform_type: config.platform,
@@ -355,16 +373,7 @@ fn create_client_confirm_active(
         CapabilitySet::SurfaceCommands(SurfaceCommands {
             flags: CmdFlags::SET_SURFACE_BITS | CmdFlags::STREAM_SURFACE_BITS | CmdFlags::FRAME_MARKER,
         }),
-        CapabilitySet::BitmapCodecs(BitmapCodecs(vec![Codec {
-            id: 0x03, // RemoteFX
-            property: CodecProperty::RemoteFx(RemoteFxContainer::ClientContainer(RfxClientCapsContainer {
-                capture_flags: CaptureFlags::empty(),
-                caps_data: RfxCaps(RfxCapset(vec![RfxICap {
-                    flags: RfxICapFlags::empty(),
-                    entropy_bits: EntropyBits::Rlgr3,
-                }])),
-            })),
-        }])),
+        CapabilitySet::BitmapCodecs(BitmapCodecs(bitmap_codecs)),
         CapabilitySet::FrameAcknowledge(FrameAcknowledge {
             // FIXME(#447): Revert this to 2 per FreeRDP.
             // This is a temporary hack to fix a resize bug, see:

crates/ironrdp-connector/src/connection_activation.rs

@@ -46,6 +46,8 @@ pub struct DesktopSize {
 pub struct BitmapConfig {
     pub lossy_compression: bool,
     pub color_depth: u32,
+    #[cfg(feature = "qoi")]
+    pub with_qoi: bool,
 }
 
 #[derive(Debug, Clone)]

crates/ironrdp-connector/src/lib.rs

@@ -19,6 +19,7 @@ doctest = false
 default = []
 std = ["alloc", "ironrdp-error/std", "ironrdp-core/std"]
 alloc = ["ironrdp-core/alloc", "ironrdp-error/alloc"]
+qoi = []
 
 [dependencies]
 bitflags.workspace = true

crates/ironrdp-pdu/Cargo.toml

@@ -37,6 +37,9 @@ const GUID_REMOTEFX: Guid = Guid(0x7677_2f12, 0xbd72, 0x4463, 0xaf, 0xb3, 0xb7,
 const GUID_IMAGE_REMOTEFX: Guid = Guid(0x2744_ccd4, 0x9d8a, 0x4e74, 0x80, 0x3c, 0x0e, 0xcb, 0xee, 0xa1, 0x9c, 0x54);
 #[rustfmt::skip]
 const GUID_IGNORE: Guid = Guid(0x9c43_51a6, 0x3535, 0x42ae, 0x91, 0x0c, 0xcd, 0xfc, 0xe5, 0x76, 0x0b, 0x58);
+#[rustfmt::skip]
+#[cfg(feature="qoi")]
+const GUID_QOI: Guid = Guid(0x4dae9af8, 0xb399, 0x4df6, 0xb4, 0x3a, 0x66, 0x2f, 0xd9, 0xc0, 0xf5, 0xd6);
 
 #[derive(Debug, PartialEq, Eq)]
 pub struct Guid(u32, u16, u16, u8, u8, u8, u8, u8, u8, u8, u8);
@@ -164,6 +167,8 @@ impl Encode for Codec {
             CodecProperty::RemoteFx(_) => GUID_REMOTEFX,
             CodecProperty::ImageRemoteFx(_) => GUID_IMAGE_REMOTEFX,
             CodecProperty::Ignore => GUID_IGNORE,
+            #[cfg(feature = "qoi")]
+            CodecProperty::QOI => GUID_QOI,
             _ => return Err(other_err!("invalid codec")),
         };
         guid.encode(dst)?;
@@ -201,6 +206,8 @@ impl Encode for Codec {
                     }
                 };
             }
+            #[cfg(feature = "qoi")]
+            CodecProperty::QOI => dst.write_u16(0),
             CodecProperty::Ignore => dst.write_u16(0),
             CodecProperty::None => dst.write_u16(0),
         };
@@ -224,6 +231,8 @@ impl Encode for Codec {
                     RemoteFxContainer::ClientContainer(container) => container.size(),
                     RemoteFxContainer::ServerContainer(size) => *size,
                 },
+                #[cfg(feature = "qoi")]
+                CodecProperty::QOI => 0,
                 CodecProperty::Ignore => 0,
                 CodecProperty::None => 0,
             }
@@ -258,6 +267,8 @@ impl<'de> Decode<'de> for Codec {
                         _ => unreachable!(),
                     }
                 }
+                #[cfg(feature = "qoi")]
+                GUID_QOI => CodecProperty::QOI,
                 GUID_IGNORE => CodecProperty::Ignore,
                 _ => CodecProperty::None,
             }
@@ -269,6 +280,8 @@ impl<'de> Decode<'de> for Codec {
                         "invalid codec property length"
                     ));
                 }
+                #[cfg(feature = "qoi")]
+                GUID_QOI => CodecProperty::QOI,
                 GUID_IGNORE => CodecProperty::Ignore,
                 _ => CodecProperty::None,
             }
@@ -290,6 +303,8 @@ pub enum CodecProperty {
     RemoteFx(RemoteFxContainer),
     ImageRemoteFx(RemoteFxContainer),
     Ignore,
+    #[cfg(feature = "qoi")]
+    QOI,
     None,
 }
 

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

@@ -19,6 +19,7 @@ test = false
 default = ["rayon"]
 helper = ["dep:x509-cert", "dep:rustls-pemfile"]
 rayon = ["dep:rayon"]
+qoi = ["dep:qoi", "ironrdp-pdu/qoi"]
 
 # Internal (PRIVATE!) features used to aid testing.
 # Don't rely on these whatsoever. They may disappear at any time.
@@ -45,6 +46,7 @@ tracing.workspace = true
 x509-cert = { version = "0.2.5", optional = true }
 rustls-pemfile = { version = "2.2.0", optional = true }
 rayon = { version = "1.10.0", optional = true }
+qoi = { workspace = true, optional = true }
 
 [dev-dependencies]
 tokio = { version = "1", features = ["sync"] }

crates/ironrdp-server/Cargo.toml

@@ -30,6 +30,8 @@ pub struct BuilderDone {
     display: Box<dyn RdpServerDisplay>,
     cliprdr_factory: Option<Box<dyn CliprdrServerFactory>>,
     sound_factory: Option<Box<dyn SoundServerFactory>>,
+    #[cfg(feature = "qoi")]
+    with_qoi: bool,
 }
 
 pub struct RdpServerBuilder<State> {
@@ -125,6 +127,8 @@ impl RdpServerBuilder<WantsDisplay> {
                 sound_factory: None,
                 cliprdr_factory: None,
                 with_remote_fx: true,
+                #[cfg(feature = "qoi")]
+                with_qoi: true,
             },
         }
     }
@@ -139,6 +143,8 @@ impl RdpServerBuilder<WantsDisplay> {
                 sound_factory: None,
                 cliprdr_factory: None,
                 with_remote_fx: true,
+                #[cfg(feature = "qoi")]
+                with_qoi: true,
             },
         }
     }
@@ -160,12 +166,20 @@ impl RdpServerBuilder<BuilderDone> {
         self
     }
 
+    #[cfg(feature = "qoi")]
+    pub fn with_qoi(mut self, enabled: bool) -> Self {
+        self.state.with_qoi = enabled;
+        self
+    }
+
     pub fn build(self) -> RdpServer {
         RdpServer::new(
             RdpServerOptions {
                 addr: self.state.addr,
                 security: self.state.security,
                 with_remote_fx: self.state.with_remote_fx,
+                #[cfg(feature = "qoi")]
+                with_qoi: self.state.with_qoi,
             },
             self.state.handler,
             self.state.display,