[fractal/fractal-next] message-row: Deduplicate code for media messages
- From: Julian Sparber <jsparber src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [fractal/fractal-next] message-row: Deduplicate code for media messages
- Date: Mon, 13 Dec 2021 17:10:11 +0000 (UTC)
commit 33c0c034e40a1b23d1a521bd966c0bec2c9ce212
Author: Kévin Commaille <zecakeh tedomum fr>
Date: Mon Dec 13 16:44:40 2021 +0100
message-row: Deduplicate code for media messages
Most of the code was shared between image and video.
data/resources/ui/components-video-player.ui | 10 +-
po/POTFILES.in | 3 +-
src/meson.build | 3 +-
.../content/room_history/message_row/image.rs | 320 ------------------
.../content/room_history/message_row/media.rs | 373 +++++++++++++++++++++
.../content/room_history/message_row/mod.rs | 11 +-
.../content/room_history/message_row/video.rs | 233 -------------
7 files changed, 383 insertions(+), 570 deletions(-)
---
diff --git a/data/resources/ui/components-video-player.ui b/data/resources/ui/components-video-player.ui
index 85dfc25d..08fe5ca4 100644
--- a/data/resources/ui/components-video-player.ui
+++ b/data/resources/ui/components-video-player.ui
@@ -1,10 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<interface>
<template class="ComponentsVideoPlayer" parent="AdwBin">
- <style>
- <class name="thumbnail"/>
- </style>
- <property name="overflow">hidden</property>
<child>
<object class="GtkOverlay">
<child>
@@ -16,13 +12,13 @@
<class name="osd"/>
<class name="timestamp"/>
</style>
- <property name="halign">1</property>
- <property name="valign">1</property>
+ <property name="halign">GTK_ALIGN_START</property>
+ <property name="valign">GTK_ALIGN_START</property>
<property name="margin-start">5</property>
<property name="margin-top">5</property>
<property name="label">00:00</property>
<layout>
- <property name="measure">1</property>
+ <property name="measure">true</property>
</layout>
</object>
</child>
diff --git a/po/POTFILES.in b/po/POTFILES.in
index 33fb20a3..ada3f705 100644
--- a/po/POTFILES.in
+++ b/po/POTFILES.in
@@ -89,10 +89,9 @@ src/session/content/room_details/mod.rs
src/session/content/room_history/divider_row.rs
src/session/content/room_history/item_row.rs
src/session/content/room_history/message_row/file.rs
-src/session/content/room_history/message_row/image.rs
+src/session/content/room_history/message_row/media.rs
src/session/content/room_history/message_row/mod.rs
src/session/content/room_history/message_row/text.rs
-src/session/content/room_history/message_row/video.rs
src/session/content/room_history/mod.rs
src/session/content/room_history/state_row.rs
src/session/content/room_history/state_row/mod.rs
diff --git a/src/meson.build b/src/meson.build
index 704cb34b..aa389a35 100644
--- a/src/meson.build
+++ b/src/meson.build
@@ -64,10 +64,9 @@ sources = files(
'session/content/room_history/divider_row.rs',
'session/content/room_history/item_row.rs',
'session/content/room_history/message_row/file.rs',
- 'session/content/room_history/message_row/image.rs',
+ 'session/content/room_history/message_row/media.rs',
'session/content/room_history/message_row/mod.rs',
'session/content/room_history/message_row/text.rs',
- 'session/content/room_history/message_row/video.rs',
'session/content/room_history/mod.rs',
'session/content/room_history/state_row/creation.rs',
'session/content/room_history/state_row/mod.rs',
diff --git a/src/session/content/room_history/message_row/media.rs
b/src/session/content/room_history/message_row/media.rs
new file mode 100644
index 00000000..fd245f0d
--- /dev/null
+++ b/src/session/content/room_history/message_row/media.rs
@@ -0,0 +1,373 @@
+use adw::{prelude::*, subclass::prelude::*};
+use gettextrs::gettext;
+use gtk::{
+ gdk,
+ gdk_pixbuf::Pixbuf,
+ gio,
+ glib::{self, clone},
+ subclass::prelude::*,
+};
+use log::warn;
+use matrix_sdk::{
+ media::{MediaEventContent, MediaThumbnailSize},
+ ruma::{
+ api::client::r0::media::get_content_thumbnail::Method,
+ events::{
+ room::message::{ImageMessageEventContent, VideoMessageEventContent},
+ sticker::StickerEventContent,
+ },
+ uint,
+ },
+};
+
+use crate::{
+ components::VideoPlayer,
+ session::Session,
+ spawn, spawn_tokio,
+ utils::{cache_dir, uint_to_i32},
+};
+
+const MAX_THUMBNAIL_WIDTH: i32 = 320;
+const MAX_THUMBNAIL_HEIGHT: i32 = 240;
+
+#[derive(Debug, Hash, Eq, PartialEq, Clone, Copy, glib::GEnum)]
+#[repr(u32)]
+#[genum(type_name = "MediaType")]
+pub enum MediaType {
+ Image = 0,
+ Sticker = 1,
+ Video = 2,
+}
+
+impl Default for MediaType {
+ fn default() -> Self {
+ Self::Image
+ }
+}
+
+mod imp {
+ use std::cell::{Cell, RefCell};
+
+ use once_cell::sync::Lazy;
+
+ use super::*;
+
+ #[derive(Debug, Default)]
+ pub struct MessageMedia {
+ /// The type of media previewed with this image.
+ pub media_type: Cell<MediaType>,
+ /// The intended display width of the full image.
+ pub width: Cell<i32>,
+ /// The intended display height of the full image.
+ pub height: Cell<i32>,
+ /// The "body" of the image to show as a tooltip. Only used for stickers.
+ pub body: RefCell<Option<String>>,
+ }
+
+ #[glib::object_subclass]
+ impl ObjectSubclass for MessageMedia {
+ const NAME: &'static str = "ContentMessageMedia";
+ type Type = super::MessageMedia;
+ type ParentType = adw::Bin;
+ }
+
+ impl ObjectImpl for MessageMedia {
+ fn properties() -> &'static [glib::ParamSpec] {
+ static PROPERTIES: Lazy<Vec<glib::ParamSpec>> = Lazy::new(|| {
+ vec![
+ glib::ParamSpec::new_enum(
+ "media-type",
+ "Media Type",
+ "The type of media previewed",
+ MediaType::static_type(),
+ MediaType::default() as i32,
+ glib::ParamFlags::READWRITE,
+ ),
+ glib::ParamSpec::new_int(
+ "width",
+ "Width",
+ "The intended display width of the media",
+ -1,
+ i32::MAX,
+ -1,
+ glib::ParamFlags::READWRITE,
+ ),
+ glib::ParamSpec::new_int(
+ "height",
+ "Height",
+ "The intended display height of the media",
+ -1,
+ i32::MAX,
+ -1,
+ glib::ParamFlags::READWRITE,
+ ),
+ glib::ParamSpec::new_string(
+ "body",
+ "Body",
+ "The 'body' of the media to show as a tooltip",
+ None,
+ glib::ParamFlags::READWRITE,
+ ),
+ ]
+ });
+
+ PROPERTIES.as_ref()
+ }
+
+ fn set_property(
+ &self,
+ _obj: &Self::Type,
+ _id: usize,
+ value: &glib::Value,
+ pspec: &glib::ParamSpec,
+ ) {
+ match pspec.name() {
+ "media-type" => {
+ self.media_type.set(value.get().unwrap());
+ }
+ "width" => {
+ self.width.set(value.get().unwrap());
+ }
+ "height" => {
+ self.height.set(value.get().unwrap());
+ }
+ "body" => {
+ self.body.replace(value.get().unwrap());
+ }
+ _ => unimplemented!(),
+ }
+ }
+
+ fn property(&self, obj: &Self::Type, _id: usize, pspec: &glib::ParamSpec) -> glib::Value {
+ match pspec.name() {
+ "media-type" => obj.media_type().to_value(),
+ "width" => self.width.get().to_value(),
+ "height" => self.height.get().to_value(),
+ "body" => obj.body().to_value(),
+ _ => unimplemented!(),
+ }
+ }
+
+ fn constructed(&self, obj: &Self::Type) {
+ self.parent_constructed(obj);
+
+ // We need to control the value returned by `measure`.
+ obj.set_layout_manager(gtk::NONE_LAYOUT_MANAGER);
+ }
+ }
+
+ impl WidgetImpl for MessageMedia {
+ fn measure(
+ &self,
+ obj: &Self::Type,
+ orientation: gtk::Orientation,
+ for_size: i32,
+ ) -> (i32, i32, i32, i32) {
+ let original_width = self.width.get();
+ let original_height = self.height.get();
+
+ let (original, max, original_other, max_other) =
+ if orientation == gtk::Orientation::Vertical {
+ (
+ original_height,
+ MAX_THUMBNAIL_HEIGHT,
+ original_width,
+ MAX_THUMBNAIL_WIDTH,
+ )
+ } else {
+ (
+ original_width,
+ MAX_THUMBNAIL_WIDTH,
+ original_height,
+ MAX_THUMBNAIL_HEIGHT,
+ )
+ };
+
+ // Limit other side to max size.
+ let other = for_size.min(max_other);
+
+ let nat = if original > 0 && original > 0 {
+ // We don't want the paintable to be upscaled.
+ let other = other.min(original_other);
+ other * original / original_other
+ } else if let Some(child) = obj.child() {
+ // Get the natural size of the data.
+ child.measure(orientation, other).1
+ } else {
+ max
+ };
+
+ // Limit this size to 400 pixels.
+ let size = nat.min(max);
+ (0, size, -1, -1)
+ }
+
+ fn request_mode(&self, _obj: &Self::Type) -> gtk::SizeRequestMode {
+ gtk::SizeRequestMode::HeightForWidth
+ }
+
+ fn size_allocate(&self, obj: &Self::Type, _width: i32, height: i32, baseline: i32) {
+ if let Some(child) = obj.child() {
+ // We need to allocate just enough width to the child so it doesn't expand.
+ let original_width = self.width.get();
+ let original_height = self.height.get();
+ let width = if original_height > 0 && original_width > 0 {
+ height * original_width / original_height
+ } else {
+ // Get the natural width of the image data.
+ child.measure(gtk::Orientation::Horizontal, height).1
+ };
+
+ child.allocate(width, height, baseline, None);
+ }
+ }
+ }
+
+ impl BinImpl for MessageMedia {}
+}
+
+glib::wrapper! {
+ /// A widget displaying a media message in the timeline.
+ pub struct MessageMedia(ObjectSubclass<imp::MessageMedia>)
+ @extends gtk::Widget, adw::Bin, @implements gtk::Accessible;
+}
+
+impl MessageMedia {
+ pub fn image(image: ImageMessageEventContent, session: &Session) -> Self {
+ let info = image.info.as_deref();
+ let width = uint_to_i32(info.and_then(|info| info.width));
+ let height = uint_to_i32(info.and_then(|info| info.height));
+
+ let self_: Self = glib::Object::new(&[("width", &width), ("height", &height)])
+ .expect("Failed to create MessageMedia");
+ self_.build(image, session);
+ self_
+ }
+
+ pub fn sticker(sticker: StickerEventContent, session: &Session) -> Self {
+ let info = &sticker.info;
+ let width = uint_to_i32(info.width);
+ let height = uint_to_i32(info.height);
+
+ let self_: Self = glib::Object::new(&[
+ ("media-type", &MediaType::Sticker),
+ ("width", &width),
+ ("height", &height),
+ ("body", &sticker.body),
+ ])
+ .expect("Failed to create MessageMedia");
+ self_.build(sticker, session);
+ self_
+ }
+
+ pub fn video(video: VideoMessageEventContent, session: &Session) -> Self {
+ let info = &video.info.as_deref();
+ let width = uint_to_i32(info.and_then(|info| info.width));
+ let height = uint_to_i32(info.and_then(|info| info.height));
+
+ let self_: Self = glib::Object::new(&[
+ ("media-type", &MediaType::Video),
+ ("width", &width),
+ ("height", &height),
+ ("body", &video.body),
+ ])
+ .expect("Failed to create MessageMedia");
+ self_.build(video, session);
+ self_
+ }
+
+ pub fn media_type(&self) -> MediaType {
+ let priv_ = imp::MessageMedia::from_instance(self);
+ priv_.media_type.get()
+ }
+
+ pub fn body(&self) -> Option<String> {
+ let priv_ = imp::MessageMedia::from_instance(self);
+ priv_.body.borrow().clone()
+ }
+
+ fn build<C>(&self, content: C, session: &Session)
+ where
+ C: MediaEventContent + Send + Sync + 'static,
+ {
+ let media_type = self.media_type();
+ let client = session.client();
+ let handle = if media_type != MediaType::Video && content.thumbnail().is_some() {
+ spawn_tokio!(async move {
+ client
+ .get_thumbnail(
+ content,
+ MediaThumbnailSize {
+ method: Method::Scale,
+ width: uint!(320),
+ height: uint!(240),
+ },
+ true,
+ )
+ .await
+ })
+ } else {
+ spawn_tokio!(async move { client.get_file(content, true,).await })
+ };
+
+ spawn!(
+ glib::PRIORITY_LOW,
+ clone!(@weak self as obj => async move {
+ match handle.await.unwrap() {
+ Ok(Some(data)) => {
+ let child: gtk::Widget = match media_type {
+ MediaType::Image | MediaType::Sticker => {
+ let stream = gio::MemoryInputStream::from_bytes(&glib::Bytes::from(&data));
+ let texture = Pixbuf::from_stream(&stream, gio::NONE_CANCELLABLE)
+ .ok()
+ .map(|pixbuf| gdk::Texture::for_pixbuf(&pixbuf));
+ let child = gtk::Picture::for_paintable(texture.as_ref());
+
+ if media_type == MediaType::Sticker {
+ child.set_tooltip_text(obj.body().as_deref());
+ } else {
+ child.add_css_class("thumbnail");
+ child.set_overflow(gtk::Overflow::Hidden);
+ }
+ child.upcast()
+ }
+ MediaType::Video => {
+ // The GStreamer backend of GtkVideo doesn't work with input streams so
+ // we need to store the file.
+ // See: https://gitlab.gnome.org/GNOME/gtk/-/issues/4062
+ let mut path = cache_dir();
+ path.push(obj.body().unwrap());
+ let file = gio::File::for_path(path);
+ file.replace_contents(
+ &data,
+ None,
+ false,
+ gio::FileCreateFlags::REPLACE_DESTINATION,
+ gio::NONE_CANCELLABLE,
+ )
+ .unwrap();
+ let media_file = gtk::MediaFile::for_file(&file);
+ media_file.set_muted(true);
+ media_file.connect_prepared_notify(|media_file| media_file.play());
+
+ VideoPlayer::new(&media_file).upcast()
+ }
+ };
+
+ obj.set_child(Some(&child));
+ }
+ Ok(None) => {
+ warn!("Could not retrieve invalid image file");
+ let child = gtk::Label::new(Some(&gettext("Could not retrieve image")));
+ obj.set_child(Some(&child));
+ }
+ Err(error) => {
+ warn!("Could not retrieve image file: {}", error);
+ let child = gtk::Label::new(Some(&gettext("Could not retrieve image")));
+ obj.set_child(Some(&child));
+ }
+ }
+ })
+ );
+ }
+}
diff --git a/src/session/content/room_history/message_row/mod.rs
b/src/session/content/room_history/message_row/mod.rs
index d39e9b63..ad7a4a91 100644
--- a/src/session/content/room_history/message_row/mod.rs
+++ b/src/session/content/room_history/message_row/mod.rs
@@ -1,7 +1,6 @@
mod file;
-mod image;
+mod media;
mod text;
-mod video;
use crate::components::Avatar;
use adw::{prelude::*, subclass::prelude::*};
@@ -16,7 +15,7 @@ use matrix_sdk::ruma::events::{
AnyMessageEventContent, AnySyncMessageEvent, AnySyncRoomEvent,
};
-use self::{file::MessageFile, image::MessageImage, text::MessageText, video::MessageVideo};
+use self::{file::MessageFile, media::MessageMedia, text::MessageText};
use crate::prelude::*;
use crate::session::room::Event;
@@ -270,7 +269,7 @@ impl MessageRow {
priv_.content.set_child(Some(&child));
}
MessageType::Image(message) => {
- let child = MessageImage::image(message, &event.room().session());
+ let child = MessageMedia::image(message, &event.room().session());
priv_.content.set_child(Some(&child));
}
MessageType::Location(_message) => {}
@@ -287,7 +286,7 @@ impl MessageRow {
priv_.content.set_child(Some(&child));
}
MessageType::Video(message) => {
- let child = MessageVideo::new(message, &event.room().session());
+ let child = MessageMedia::video(message, &event.room().session());
priv_.content.set_child(Some(&child));
}
MessageType::VerificationRequest(_message) => {}
@@ -297,7 +296,7 @@ impl MessageRow {
}
}
Some(AnyMessageEventContent::Sticker(content)) => {
- let child = MessageImage::sticker(content, &event.room().session());
+ let child = MessageMedia::sticker(content, &event.room().session());
priv_.content.set_child(Some(&child));
}
Some(AnyMessageEventContent::RoomEncrypted(content)) => {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
