moqros 0.5.0

Stream ROS 2 topics (images as video, any message as data) over Media over QUIC
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
//! Arbitrary (non-image) messages carried as hang JSON or binary data tracks.
//!
//! A data broadcast has a single track, [`DATA_TRACK`], described by the catalog's `json` section
//! ([`DataFormat::Json`]) or its `binary` section ([`DataFormat::Cdr`]). Each MoQ frame is one
//! message payload, as is; the catalog entry also names the ROS message type (`rosType`) so a
//! subscriber can republish it without being told.

use std::fmt;
use std::str::FromStr;
use std::time::Duration;

use bytes::Bytes;
use hang::catalog::{BinaryConfig, Catalog, JsonConfig, Mode, PRIORITY};
use hang::moq_net;

use crate::publisher::GroupBudget;
use crate::subscriber::GroupReader;
use crate::{Error, Result};

/// Name of the single data track inside every moqros data broadcast.
pub const DATA_TRACK: &str = "data";

/// Media type of [`DataFormat::Cdr`] payloads in the catalog's `binary` section.
pub const CDR_MIME: &str = "application/x-ros2-cdr";

/// Catalog field naming the ROS message type of a data track.
const ROS_TYPE_KEY: &str = "rosType";

/// How each message is serialized on the wire.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum DataFormat {
	/// One UTF-8 JSON value per message, readable by any hang consumer (e.g. a browser).
	Json,
	/// The message's ROS serialization (CDR), as received from the middleware.
	Cdr,
}

impl fmt::Display for DataFormat {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		f.write_str(match self {
			Self::Json => "json",
			Self::Cdr => "cdr",
		})
	}
}

impl FromStr for DataFormat {
	type Err = Error;

	fn from_str(s: &str) -> Result<Self> {
		match s.to_ascii_lowercase().as_str() {
			"json" => Ok(Self::Json),
			"cdr" => Ok(Self::Cdr),
			other => Err(Error::InvalidSettings(format!("unknown data format {other:?}"))),
		}
	}
}

/// How messages map onto MoQ groups.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash)]
pub enum DataMode {
	/// Latest value: every message is a group of its own, and a subscriber that falls behind
	/// skips to the newest one. Suits sensor data and state.
	#[default]
	Snapshot,
	/// Lossless log: messages go into one group and are delivered in order. A group that
	/// reaches moq-net's limits (8192 messages or 32 MB) is closed and the next one continues.
	Stream,
}

impl DataMode {
	fn to_catalog(self) -> Mode {
		match self {
			Self::Snapshot => Mode::Snapshot,
			Self::Stream => Mode::Stream,
		}
	}

	fn from_catalog(mode: &Mode) -> Option<Self> {
		match mode {
			Mode::Snapshot => Some(Self::Snapshot),
			Mode::Stream => Some(Self::Stream),
			_ => None,
		}
	}
}

impl fmt::Display for DataMode {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		f.write_str(match self {
			Self::Snapshot => "snapshot",
			Self::Stream => "stream",
		})
	}
}

impl FromStr for DataMode {
	type Err = Error;

	fn from_str(s: &str) -> Result<Self> {
		match s.to_ascii_lowercase().as_str() {
			"snapshot" => Ok(Self::Snapshot),
			"stream" => Ok(Self::Stream),
			other => Err(Error::InvalidSettings(format!("unknown data mode {other:?}"))),
		}
	}
}

/// Describes a data track: given to [`Publisher::create_data_broadcast`](crate::Publisher::create_data_broadcast),
/// and read back from the catalog by [`DataSubscriber::settings`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DataSettings {
	pub format: DataFormat,
	pub mode: DataMode,
	/// ROS message type, e.g. `sensor_msgs/msg/Imu`.
	pub ros_type: Option<String>,
}

impl DataSettings {
	pub fn new(format: DataFormat) -> Self {
		Self {
			format,
			mode: DataMode::default(),
			ros_type: None,
		}
	}

	/// Add the [`DATA_TRACK`] entry to `catalog`.
	pub(crate) fn insert_into(&self, catalog: &mut Catalog) -> Result<()> {
		let mut extra = serde_json::Map::new();
		if let Some(ros_type) = &self.ros_type {
			extra.insert(ROS_TYPE_KEY.into(), ros_type.clone().into());
		}
		let mode = self.mode.to_catalog();
		match self.format {
			DataFormat::Json => {
				let mut config = JsonConfig::new(mode);
				config.schema = self.ros_type.as_ref().map(|ros_type| format!("ros2:{ros_type}"));
				config.extra = extra;
				catalog.json.insert(DATA_TRACK, config)?;
			}
			DataFormat::Cdr => {
				let mut config = BinaryConfig::new(mode);
				config.mime = Some(CDR_MIME.into());
				config.extra = extra;
				catalog.binary.insert(DATA_TRACK, config)?;
			}
		}
		Ok(())
	}

	/// The first data track of `catalog` moqros can read, JSON before CDR.
	pub(crate) fn from_catalog(catalog: &Catalog) -> Option<(String, Self)> {
		let settings = |format, mode: &Mode, extra: &serde_json::Map<String, serde_json::Value>| {
			Some(Self {
				format,
				// A consumer must ignore a track whose mode it doesn't know.
				mode: DataMode::from_catalog(mode)?,
				ros_type: extra.get(ROS_TYPE_KEY).and_then(|t| t.as_str()).map(String::from),
			})
		};
		let json = catalog.json.tracks.iter().filter_map(|(track, config)| {
			Some((track.clone(), settings(DataFormat::Json, &config.mode, &config.extra)?))
		});
		let cdr = catalog
			.binary
			.tracks
			.iter()
			.filter(|(_, config)| config.mime.as_deref() == Some(CDR_MIME))
			.filter_map(|(track, config)| {
				Some((track.clone(), settings(DataFormat::Cdr, &config.mode, &config.extra)?))
			});
		json.chain(cdr).next()
	}
}

/// Writes messages into one MoQ data broadcast.
pub struct DataPublisher {
	name: String,
	settings: DataSettings,
	broadcast: moq_net::broadcast::Producer,
	_catalog: moq_net::track::Producer,
	track: moq_net::track::Producer,
	/// The open group of a [`DataMode::Stream`] track.
	group: Option<moq_net::group::Producer>,
	/// What [`Self::group`] has used of moq-net's per-group limits.
	budget: GroupBudget,
}

impl DataPublisher {
	pub(crate) fn new(origin: &moq_net::origin::Producer, name: &str, settings: DataSettings) -> Result<Self> {
		let mut catalog = Catalog::<()>::default();
		settings.insert_into(&mut catalog)?;

		let broadcast = origin.create_broadcast(name)?;
		broadcast.announce(Default::default())?;
		let catalog_track = broadcast.create_track(Catalog::DEFAULT_NAME, Catalog::default_track_info())?;
		let track = broadcast.create_track(DATA_TRACK, moq_net::track::Info::default().with_priority(PRIORITY.text))?;

		let mut group = catalog_track.append_group()?;
		group.write_frame(moq_net::Timestamp::now(), catalog.to_json()?)?;
		group.finish()?;
		tracing::info!(
			broadcast = name,
			format = %settings.format,
			mode = %settings.mode,
			ros_type = settings.ros_type.as_deref().unwrap_or_default(),
			"announced data broadcast"
		);

		Ok(Self {
			name: name.to_string(),
			settings,
			broadcast,
			_catalog: catalog_track,
			track,
			group: None,
			budget: GroupBudget::default(),
		})
	}

	/// Broadcast name, relative to the relay URL.
	pub fn name(&self) -> &str {
		&self.name
	}

	pub fn settings(&self) -> &DataSettings {
		&self.settings
	}

	/// Send one message payload, serialized as [`DataSettings::format`] says.
	pub fn publish(&mut self, payload: impl Into<Bytes>) -> Result<()> {
		let payload = payload.into();
		let timestamp = moq_net::Timestamp::now();
		match self.settings.mode {
			DataMode::Snapshot => {
				let mut group = self.track.append_group()?;
				group.write_frame(timestamp, payload)?;
				group.finish()?;
			}
			DataMode::Stream => {
				let size = payload.len();
				if !self.budget.fits(size)
					&& let Some(group) = self.group.take()
				{
					group.finish()?;
				}
				let group = match &mut self.group {
					Some(group) => group,
					None => {
						self.budget = GroupBudget::default();
						self.group.insert(self.track.append_group()?)
					}
				};
				group.write_frame(timestamp, payload)?;
				self.budget.add(size);
			}
		}
		Ok(())
	}
}

impl Drop for DataPublisher {
	fn drop(&mut self) {
		if let Some(group) = self.group.take() {
			let _ = group.finish();
		}
		self.broadcast.close();
	}
}

/// One message received from a data broadcast.
#[derive(Debug, Clone)]
pub struct DataMessage {
	/// Send time on the publisher's monotonic clock; only differences are meaningful.
	pub timestamp: Duration,
	pub payload: Bytes,
}

/// Reads the messages of one data track.
///
/// For [`DataMode::Snapshot`] tracks it always jumps to the newest message, so a slow
/// reader stays at the live edge; [`DataMode::Stream`] tracks are read in order.
pub struct DataSubscriber {
	_broadcast: moq_net::broadcast::Consumer,
	reader: GroupReader,
	settings: DataSettings,
}

impl DataSubscriber {
	pub(crate) fn new(broadcast: moq_net::broadcast::Consumer, reader: GroupReader, settings: DataSettings) -> Self {
		Self {
			_broadcast: broadcast,
			reader,
			settings,
		}
	}

	/// Format, mode and ROS type announced in the catalog.
	pub fn settings(&self) -> &DataSettings {
		&self.settings
	}

	/// Next message, or `None` once the broadcast ends.
	pub async fn next_message(&mut self) -> Result<Option<DataMessage>> {
		Ok(self.reader.next_frame().await?.map(|frame| DataMessage {
			timestamp: frame.timestamp.into(),
			payload: frame.payload,
		}))
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn names_round_trip() {
		for format in [DataFormat::Json, DataFormat::Cdr] {
			assert_eq!(format.to_string().parse::<DataFormat>().unwrap(), format);
		}
		for mode in [DataMode::Snapshot, DataMode::Stream] {
			assert_eq!(mode.to_string().parse::<DataMode>().unwrap(), mode);
		}
		assert_eq!("JSON".parse::<DataFormat>().unwrap(), DataFormat::Json);
		assert!(matches!("xml".parse::<DataFormat>(), Err(Error::InvalidSettings(_))));
		assert!(matches!("log".parse::<DataMode>(), Err(Error::InvalidSettings(_))));
	}

	fn settings(format: DataFormat, mode: DataMode, ros_type: Option<&str>) -> DataSettings {
		DataSettings {
			format,
			mode,
			ros_type: ros_type.map(String::from),
		}
	}

	#[test]
	fn catalog_round_trip() {
		for settings in [
			settings(DataFormat::Json, DataMode::Snapshot, Some("sensor_msgs/msg/Imu")),
			settings(DataFormat::Cdr, DataMode::Stream, Some("std_msgs/msg/String")),
			settings(DataFormat::Json, DataMode::Stream, None),
		] {
			let mut catalog = Catalog::default();
			settings.insert_into(&mut catalog).unwrap();
			let catalog: Catalog = serde_json::from_str(&catalog.to_json().unwrap()).unwrap();
			assert_eq!(
				DataSettings::from_catalog(&catalog),
				Some((DATA_TRACK.to_string(), settings.clone()))
			);
		}
	}

	#[test]
	fn catalog_entries() {
		let mut catalog = Catalog::default();
		settings(DataFormat::Json, DataMode::Snapshot, Some("std_msgs/msg/String"))
			.insert_into(&mut catalog)
			.unwrap();
		let json: serde_json::Value = serde_json::from_str(&catalog.to_json().unwrap()).unwrap();
		assert_eq!(
			json["json"]["tracks"][DATA_TRACK],
			serde_json::json!({
				"mode": "snapshot",
				"schema": "ros2:std_msgs/msg/String",
				"rosType": "std_msgs/msg/String",
			})
		);

		let mut catalog = Catalog::default();
		settings(DataFormat::Cdr, DataMode::Stream, Some("std_msgs/msg/String"))
			.insert_into(&mut catalog)
			.unwrap();
		let json: serde_json::Value = serde_json::from_str(&catalog.to_json().unwrap()).unwrap();
		assert_eq!(
			json["binary"]["tracks"][DATA_TRACK],
			serde_json::json!({
				"mode": "stream",
				"mime": CDR_MIME,
				"rosType": "std_msgs/msg/String",
			})
		);
	}

	/// A stream track outgrowing moq-net's group limits continues in a new group.
	#[tokio::test]
	async fn stream_continues_past_a_full_group() {
		let origin = moq_tokio::origin::spawn();
		let mut publisher =
			DataPublisher::new(&origin, "log", settings(DataFormat::Json, DataMode::Stream, None)).unwrap();
		let broadcast = origin.consume().request_broadcast("log").await.unwrap();
		let mut track = broadcast
			.track(DATA_TRACK)
			.unwrap()
			.subscribe(moq_net::track::Subscription::default())
			.await
			.unwrap()
			.ordered();

		// Hold the first group before the second exists, as a subscriber that keeps up does.
		publisher.publish("0").unwrap();
		let mut group = track.next_group().await.unwrap().unwrap();
		let count = moq_net::group::MAX_GROUP_FRAMES + 100;
		for i in 1..count {
			publisher.publish(i.to_string()).unwrap();
		}
		drop(publisher);

		let mut groups = 1;
		let mut received = 0;
		loop {
			while let Some(frame) = group.read_frame().await.unwrap() {
				assert_eq!(frame.payload, received.to_string().as_bytes());
				received += 1;
			}
			// Dropping the publisher ends the track with an error.
			let Ok(Some(next)) = track.next_group().await else {
				break;
			};
			group = next;
			groups += 1;
		}
		assert_eq!((groups, received), (2, count));
	}

	#[test]
	fn ignores_unreadable_tracks() {
		let catalog: Catalog = serde_json::from_value(serde_json::json!({
			"json": { "tracks": { "future": { "mode": "window" } } },
			"binary": { "tracks": {
				"thumbs": { "mode": "snapshot", "mime": "image/jpeg" },
				"raw": { "mode": "stream", "mime": CDR_MIME },
			} },
		}))
		.unwrap();
		assert_eq!(
			DataSettings::from_catalog(&catalog),
			Some(("raw".to_string(), settings(DataFormat::Cdr, DataMode::Stream, None)))
		);
		assert_eq!(DataSettings::from_catalog(&Catalog::default()), None);
	}
}