diff libervia/backend/tools/common/utils.py @ 4231:e11b13418ba6

plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Implement XEP-0343: Signaling WebRTC Data Channels in Jingle. The current version of the XEP (0.3.1) has no implementation and contains some flaws. After discussing this on xsf@, Daniel (from Conversations) mentioned that they had a sprint with Larma (from Dino) to work on another version and provided me with this link: https://gist.github.com/iNPUTmice/6c56f3e948cca517c5fb129016d99e74 . I have used it for my implementation. This implementation reuses work done on Jingle A/V call (notably XEP-0176 and XEP-0167 plugins), with adaptations. When used, XEP-0234 will not handle the file itself as it normally does. This is because WebRTC has several implementations (browser for web interface, GStreamer for others), and file/data must be handled directly by the frontend. This is particularly important for web frontends, as the file is not sent from the backend but from the end-user's browser device. Among the changes, there are: - XEP-0343 implementation. - `file_send` bridge method now use serialised dict as output. - New `BaseTransportHandler.is_usable` method which get content data and returns a boolean (default to `True`) to tell if this transport can actually be used in this context (when we are initiator). Used in webRTC case to see if call data are available. - Support of `application` media type, and everything necessary to handle data channels. - Better confirmation message, with file name, size and description when available. - When file is accepted in preflight, it is specified in following `action_new` signal for actual file transfer. This way, frontend can avoid the display or 2 confirmation messages. - XEP-0166: when not specified, default `content` name is now its index number instead of a UUID. This follows the behaviour of browsers. - XEP-0353: better handling of events such as call taken by another device. - various other updates. rel 441
author Goffi <goffi@goffi.org>
date Sat, 06 Apr 2024 12:57:23 +0200
parents 4b842c1fb686
children 0d7bb4df2343
line wrap: on
line diff
--- a/libervia/backend/tools/common/utils.py	Sat Apr 06 12:21:04 2024 +0200
+++ b/libervia/backend/tools/common/utils.py	Sat Apr 06 12:57:23 2024 +0200
@@ -143,7 +143,7 @@
             raise ValueError(f"invalid size: {e}")
 
 
-def get_size_multiplier(size, suffix="o"):
+def get_size_multiplier(size: int|str, suffix="o"):
     """Get multiplier of a file size"""
     size = int(size)
     #  cf. https://stackoverflow.com/a/1094933 (thanks)
@@ -154,6 +154,7 @@
     return size, f"Yi{suffix}"
 
 
-def get_human_size(size, suffix="o", sep=" "):
+def get_human_size(size: int|str, suffix: str="o", sep: str=" ") -> str:
+    """Return data size in a human readable format."""
     size, symbol = get_size_multiplier(size, suffix)
     return f"{size:.2f}{sep}{symbol}"