feat(sdk): Allow to set and check whether an image is animated

Using MSC4230.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

Author: zecakeh

bindings/matrix-sdk-ffi/src/ruma.rs

@@ -570,6 +570,7 @@ pub struct ImageInfo {
     pub thumbnail_info: Option<ThumbnailInfo>,
     pub thumbnail_source: Option<Arc<MediaSource>>,
     pub blurhash: Option<String>,
+    pub is_animated: Option<bool>,
 }
 
 impl From<ImageInfo> for RumaImageInfo {
@@ -582,6 +583,7 @@ impl From<ImageInfo> for RumaImageInfo {
             thumbnail_info: value.thumbnail_info.map(Into::into).map(Box::new),
             thumbnail_source: value.thumbnail_source.map(|source| (*source).clone().into()),
             blurhash: value.blurhash,
+            is_animated: value.is_animated,
         })
     }
 }
@@ -603,6 +605,7 @@ impl TryFrom<&ImageInfo> for BaseImageInfo {
             width: Some(width),
             size: Some(size),
             blurhash: Some(blurhash),
+            is_animated: value.is_animated,
         })
     }
 }
@@ -859,6 +862,7 @@ impl TryFrom<&matrix_sdk::ruma::events::room::ImageInfo> for ImageInfo {
                 .transpose()?
                 .map(Arc::new),
             blurhash: info.blurhash.clone(),
+            is_animated: info.is_animated,
         })
     }
 }

crates/matrix-sdk/CHANGELOG.md

@@ -6,6 +6,11 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased] - ReleaseDate
 
+### Features
+
+- Allow to set and check whether an image is animated via its `ImageInfo`.
+  ([#4503](https://github.com/matrix-org/matrix-rust-sdk/pull/4503))
+
 ### Refactor
 
 - [**breaking**] Move the optional `RequestConfig` argument of the

crates/matrix-sdk/Cargo.toml

@@ -96,7 +96,15 @@ mime2ext = "0.1.53"
 once_cell = { workspace = true }
 pin-project-lite = { workspace = true }
 rand = { workspace = true , optional = true }
-ruma = { workspace = true, features = ["rand", "unstable-msc2448", "unstable-msc2965", "unstable-msc3930", "unstable-msc3245-v1-compat", "unstable-msc2867"] }
+ruma = { workspace = true, features = [
+    "rand",
+    "unstable-msc2448",
+    "unstable-msc2965",
+    "unstable-msc3930",
+    "unstable-msc3245-v1-compat",
+    "unstable-msc2867",
+    "unstable-msc4230",
+] }
 serde = { workspace = true }
 serde_html_form = { workspace = true }
 serde_json = { workspace = true }

crates/matrix-sdk/src/attachment.rs

@@ -39,6 +39,8 @@ pub struct BaseImageInfo {
     pub size: Option<UInt>,
     /// The [BlurHash](https://blurha.sh/) for this image.
     pub blurhash: Option<String>,
+    /// Whether this image is animated.
+    pub is_animated: Option<bool>,
 }
 
 /// Base metadata about a video.
@@ -100,6 +102,7 @@ impl From<AttachmentInfo> for ImageInfo {
                 width: info.width,
                 size: info.size,
                 blurhash: info.blurhash,
+                is_animated: info.is_animated,
             }),
             _ => ImageInfo::new(),
         }

crates/matrix-sdk/tests/integration/room/attachment/mod.rs

@@ -89,6 +89,7 @@ async fn test_room_attachment_send_info() {
             width: Some(uint!(800)),
             size: None,
             blurhash: None,
+            is_animated: None,
         }))
         .caption(Some("image caption".to_owned()));
 
@@ -217,6 +218,7 @@ async fn test_room_attachment_send_info_thumbnail() {
             width: Some(uint!(800)),
             size: None,
             blurhash: None,
+            is_animated: None,
         }));
 
     let response = room
@@ -299,3 +301,51 @@ async fn test_room_attachment_send_mentions() {
 
     assert_eq!(expected_event_id, response.event_id);
 }
+
+#[async_test]
+async fn test_room_attachment_send_is_animated() {
+    let mock = MatrixMockServer::new().await;
+
+    let expected_event_id = event_id!("$h29iv0s8:example.com");
+    mock.mock_room_send()
+        .body_matches_partial_json(json!({
+            "info": {
+                "mimetype": "image/jpeg",
+                "h": 600,
+                "w": 800,
+                "org.matrix.msc4230.is_animated": false,
+            }
+        }))
+        .ok(expected_event_id)
+        .mock_once()
+        .mount()
+        .await;
+
+    mock.mock_upload()
+        .expect_mime_type("image/jpeg")
+        .ok(mxc_uri!("mxc://example.com/AQwafuaFswefuhsfAFAgsw"))
+        .mock_once()
+        .mount()
+        .await;
+
+    let client = mock.client_builder().build().await;
+    let room = mock.sync_joined_room(&client, &DEFAULT_TEST_ROOM_ID).await;
+    mock.mock_room_state_encryption().plain().mount().await;
+
+    let config = AttachmentConfig::new()
+        .info(AttachmentInfo::Image(BaseImageInfo {
+            height: Some(uint!(600)),
+            width: Some(uint!(800)),
+            size: None,
+            blurhash: None,
+            is_animated: Some(false),
+        }))
+        .caption(Some("image caption".to_owned()));
+
+    let response = room
+        .send_attachment("image.jpg", &mime::IMAGE_JPEG, b"Hello world".to_vec(), config)
+        .await
+        .unwrap();
+
+    assert_eq!(expected_event_id, response.event_id)
+}

crates/matrix-sdk/tests/integration/send_queue.rs

@@ -54,6 +54,7 @@ async fn queue_attachment_no_thumbnail(q: &RoomSendQueue) -> (SendHandle, &'stat
         width: Some(uint!(37)),
         size: Some(uint!(42)),
         blurhash: None,
+        is_animated: None,
     }));
     let handle = q
         .send_attachment(filename, content_type, data, config)
@@ -85,6 +86,7 @@ async fn queue_attachment_with_thumbnail(q: &RoomSendQueue) -> (SendHandle, &'st
             width: Some(uint!(37)),
             size: Some(uint!(42)),
             blurhash: None,
+            is_animated: None,
         },
     ));
 
@@ -1811,6 +1813,7 @@ async fn test_media_uploads() {
         width: Some(uint!(38)),
         size: Some(uint!(43)),
         blurhash: None,
+        is_animated: Some(false),
     });
 
     let transaction_id = TransactionId::new();
@@ -1871,6 +1874,7 @@ async fn test_media_uploads() {
     assert_eq!(info.size, Some(uint!(43)));
     assert_eq!(info.mimetype.as_deref(), Some("image/jpeg"));
     assert!(info.blurhash.is_none());
+    assert_eq!(info.is_animated, Some(false));
 
     // Check the data source: it should reference the send queue local storage.
     let local_source = img_content.source;