feat(session): make client_codecs_capabilities() configurable

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

Author: elmarco

crates/ironrdp-client/src/config.rs

@@ -270,7 +270,7 @@ impl Config {
             Some(connector::BitmapConfig {
                 color_depth,
                 lossy_compression: true,
-                codecs: client_codecs_capabilities(),
+                codecs: client_codecs_capabilities(&[]).unwrap(),
             })
         } else {
             None

crates/ironrdp-connector/src/connection_activation.rs

@@ -360,7 +360,7 @@ fn create_client_confirm_active(
                 .bitmap
                 .as_ref()
                 .map(|b| b.codecs.clone())
-                .unwrap_or_else(client_codecs_capabilities),
+                .unwrap_or_else(|| client_codecs_capabilities(&[]).unwrap()),
         ),
         CapabilitySet::FrameAcknowledge(FrameAcknowledge {
             // FIXME(#447): Revert this to 2 per FreeRDP.

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

@@ -649,17 +649,77 @@ impl CodecId {
     }
 }
 
-pub fn client_codecs_capabilities() -> BitmapCodecs {
-    let codecs = vec![Codec {
-        id: CODEC_ID_REMOTEFX.0,
-        property: CodecProperty::RemoteFx(RemoteFxContainer::ClientContainer(RfxClientCapsContainer {
-            capture_flags: CaptureFlags::empty(),
-            caps_data: RfxCaps(RfxCapset(vec![RfxICap {
-                flags: RfxICapFlags::empty(),
-                entropy_bits: EntropyBits::Rlgr3,
-            }])),
-        })),
-    }];
-
-    BitmapCodecs(codecs)
+/// This function generates a list of client codec capabilities based on the
+/// provided configuration.
+///
+/// # Arguments
+///
+/// * `config` - A slice of string slices that specifies which codecs to include
+///   in the capabilities. Codecs can be explicitly turned on ("codec:on") or
+///   off ("codec:off").
+///
+/// # List of codecs
+///
+/// * `remotefx` (on by default)
+///
+/// # Returns
+///
+/// A vector of `Codec` structs representing the codec capabilities, or an error
+/// suitable for CLI.
+pub fn client_codecs_capabilities(config: &[&str]) -> Result<BitmapCodecs, String> {
+    use std::collections::HashMap;
+
+    fn parse_codecs_config<'a>(codecs: &'a [&'a str]) -> Result<HashMap<&'a str, bool>, String> {
+        let mut result = HashMap::new();
+
+        for &codec_str in codecs {
+            if let Some(colon_index) = codec_str.find(':') {
+                let codec_name = &codec_str[0..colon_index];
+                let state_str = &codec_str[colon_index + 1..];
+
+                let state = match state_str {
+                    "on" => true,
+                    "off" => false,
+                    _ => return Err(format!("Unhandled configuration: {}", state_str)),
+                };
+
+                result.insert(codec_name, state);
+            } else {
+                // No colon found, assume it's "on"
+                result.insert(codec_str, true);
+            }
+        }
+
+        Ok(result)
+    }
+
+    if config.contains(&"help") {
+        return Err(r#"
+List of codecs:
+- `remotefx` (on by default)
+"#
+        .to_owned());
+    }
+    let mut config = parse_codecs_config(config)?;
+    let mut codecs = vec![];
+
+    if config.remove("remotefx").unwrap_or(true) {
+        codecs.push(Codec {
+            id: CODEC_ID_REMOTEFX.0,
+            property: CodecProperty::RemoteFx(RemoteFxContainer::ClientContainer(RfxClientCapsContainer {
+                capture_flags: CaptureFlags::empty(),
+                caps_data: RfxCaps(RfxCapset(vec![RfxICap {
+                    flags: RfxICapFlags::empty(),
+                    entropy_bits: EntropyBits::Rlgr3,
+                }])),
+            })),
+        });
+    }
+
+    let codec_names = config.keys().copied().collect::<Vec<_>>().join(", ");
+    if !codec_names.is_empty() {
+        return Err(format!("Unknown codecs: {}", codec_names));
+    }
+
+    Ok(BitmapCodecs(codecs))
 }

crates/ironrdp-session/src/utils.rs

@@ -1 +1,24 @@
 mod rfx;
+
+#[cfg(test)]
+mod tests {
+    use ironrdp_pdu::rdp::capability_sets::{client_codecs_capabilities, CodecProperty};
+
+    #[test]
+    fn test_codecs_capabilities() {
+        let config = &[];
+        let _capabilities = client_codecs_capabilities(config).unwrap();
+
+        let config = &["badcodec"];
+        assert!(client_codecs_capabilities(config).is_err());
+
+        let config = &["remotefx:on"];
+        let capabilities = client_codecs_capabilities(config).unwrap();
+        assert_eq!(capabilities.0.len(), 1);
+        assert!(matches!(capabilities.0[0].property, CodecProperty::RemoteFx(_)));
+
+        let config = &["remotefx:off"];
+        let capabilities = client_codecs_capabilities(config).unwrap();
+        assert_eq!(capabilities.0.len(), 0);
+    }
+}

crates/ironrdp-testsuite-core/tests/session/mod.rs

@@ -856,7 +856,7 @@ fn build_config(
         bitmap: Some(connector::BitmapConfig {
             color_depth: 16,
             lossy_compression: true,
-            codecs: client_codecs_capabilities(),
+            codecs: client_codecs_capabilities(&[]).unwrap(),
         }),
         #[allow(clippy::arithmetic_side_effects)] // fine unless we end up with an insanely big version
         client_build: semver::Version::parse(env!("CARGO_PKG_VERSION"))