use std::collections::HashSet;
use std::str::FromStr;
use anyhow::{bail, ensure};
use clap::ValueEnum;
use moqros::ros::{ROS_COMPRESSED_IMAGE_TYPE, ROS_IMAGE_TYPE, StampSource};
use crate::args::Format;
type Spec<'a> = (&'a str, Vec<(&'a str, &'a str)>);
fn split_spec<'a>(spec: &'a str, keys: &[&str]) -> Result<Spec<'a>, String> {
let mut parts = spec.split(',');
let name = parts.next().unwrap_or_default().trim();
if name.is_empty() {
return Err(format!("{spec:?} doesn't start with a name"));
}
let mut options: Vec<(&str, &str)> = Vec::new();
for part in parts {
let (key, value) = part
.split_once('=')
.ok_or_else(|| format!("expected key=value, got {part:?}"))?;
let (key, value) = (key.trim(), value.trim());
if !keys.contains(&key) {
return Err(format!("unknown option {key:?} (expected one of: {})", keys.join(", ")));
}
if options.iter().any(|(k, _)| *k == key) {
return Err(format!("option {key:?} given twice"));
}
options.push((key, value));
}
Ok((name, options))
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TopicSpec {
pub topic: String,
pub format: Option<Format>,
pub ros_type: Option<String>,
pub mode: Option<moqros::DataMode>,
pub broadcast: Option<String>,
}
impl FromStr for TopicSpec {
type Err = String;
fn from_str(spec: &str) -> Result<Self, String> {
let (topic, options) = split_spec(spec, &["format", "type", "mode", "broadcast"])?;
let mut parsed = Self {
topic: topic.to_string(),
format: None,
ros_type: None,
mode: None,
broadcast: None,
};
for (key, value) in options {
match key {
"format" => parsed.format = Some(Format::from_str(value, true)?),
"type" => parsed.ros_type = Some(value.to_string()),
"mode" => parsed.mode = Some(value.parse().map_err(|err| format!("{err}"))?),
_ => parsed.broadcast = Some(value.to_string()),
}
}
Ok(parsed)
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PubTopic {
pub topic: String,
pub broadcast: String,
pub format: Format,
pub mode: moqros::DataMode,
pub ros_type: Option<String>,
}
pub fn pub_topics(
specs: Vec<TopicSpec>,
format: Format,
mode: moqros::DataMode,
ros_type: Option<String>,
broadcast: Option<String>,
) -> anyhow::Result<Vec<PubTopic>> {
ensure!(!specs.is_empty(), "no topic to publish");
ensure!(
specs.len() == 1 || (ros_type.is_none() && broadcast.is_none()),
"--type and --broadcast need a single --topic; give several topics `type=` and `broadcast=` options instead"
);
let mut broadcasts = HashSet::new();
specs
.into_iter()
.map(|spec| {
let topic = PubTopic {
broadcast: spec
.broadcast
.or(broadcast.clone())
.unwrap_or_else(|| moqros::broadcast_name_for_topic(&spec.topic)),
format: spec.format.unwrap_or(format),
mode: spec.mode.unwrap_or(mode),
ros_type: spec.ros_type.or(ros_type.clone()),
topic: spec.topic,
};
if topic.format == Format::Video
&& let Some(ros_type) = topic
.ros_type
.as_deref()
.filter(|t| ![ROS_IMAGE_TYPE, ROS_COMPRESSED_IMAGE_TYPE].contains(t))
{
bail!(
"{}: video needs {ROS_IMAGE_TYPE} or {ROS_COMPRESSED_IMAGE_TYPE} messages, not {ros_type}; use format=json or cdr",
topic.topic
);
}
ensure!(
broadcasts.insert(topic.broadcast.clone()),
"several topics publish the broadcast {:?}",
topic.broadcast
);
Ok(topic)
})
.collect()
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BroadcastSpec {
pub broadcast: String,
pub topic: Option<String>,
pub ros_type: Option<String>,
pub frame_id: Option<String>,
pub stamp: Option<StampSource>,
pub max_height: Option<u32>,
pub encoding: Option<moqros::PixelFormat>,
}
impl FromStr for BroadcastSpec {
type Err = String;
fn from_str(spec: &str) -> Result<Self, String> {
let (broadcast, options) = split_spec(spec, &["topic", "type", "frame_id", "stamp", "max_height", "encoding"])?;
let mut parsed = Self {
broadcast: broadcast.to_string(),
topic: None,
ros_type: None,
frame_id: None,
stamp: None,
max_height: None,
encoding: None,
};
for (key, value) in options {
match key {
"stamp" => parsed.stamp = Some(value.parse().map_err(|err| format!("{err}"))?),
"max_height" => {
parsed.max_height = Some(
value
.parse()
.map_err(|_| format!("max_height must be a number, not {value:?}"))?,
);
}
"encoding" => parsed.encoding = Some(parse_encoding(value)?),
"topic" => parsed.topic = Some(value.to_string()),
"type" => parsed.ros_type = Some(value.to_string()),
_ => parsed.frame_id = Some(value.to_string()),
}
}
Ok(parsed)
}
}
pub fn parse_encoding(value: &str) -> Result<moqros::PixelFormat, String> {
use moqros::PixelFormat::{Bgr8, Bgra8, Mono8, Rgb8, Rgba8};
match value.parse::<moqros::PixelFormat>() {
Ok(format @ (Rgb8 | Bgr8 | Rgba8 | Bgra8 | Mono8)) => Ok(format),
_ => Err(format!(
"unsupported encoding {value:?} (expected one of: rgb8, bgr8, rgba8, bgra8, mono8)"
)),
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SubBroadcast {
pub broadcast: String,
pub topic: String,
pub ros_type: Option<String>,
pub frame_id: Option<String>,
pub stamp: StampSource,
pub max_height: Option<u32>,
pub encoding: moqros::PixelFormat,
}
pub const DEFAULT_SUB_TOPIC: &str = "/moqros/image";
pub fn sub_broadcasts(
specs: Vec<BroadcastSpec>,
topic: Option<String>,
ros_type: Option<String>,
frame_id: Option<&str>,
stamp: StampSource,
max_height: Option<u32>,
encoding: moqros::PixelFormat,
) -> anyhow::Result<Vec<SubBroadcast>> {
ensure!(!specs.is_empty(), "no broadcast to subscribe to");
let single = specs.len() == 1;
ensure!(
single || (topic.is_none() && ros_type.is_none()),
"--topic and --type need a single --broadcast; give several broadcasts `topic=` and `type=` options instead"
);
let mut topics = HashSet::new();
specs
.into_iter()
.map(|spec| {
let broadcast = SubBroadcast {
topic: spec.topic.or(topic.clone()).unwrap_or_else(|| match single {
true => DEFAULT_SUB_TOPIC.to_string(),
false => format!("/moqros/{}", spec.broadcast.trim_matches('/')),
}),
ros_type: spec.ros_type.or(ros_type.clone()),
frame_id: spec.frame_id.or_else(|| frame_id.map(String::from)),
stamp: spec.stamp.unwrap_or(stamp),
max_height: spec.max_height.or(max_height),
encoding: spec.encoding.unwrap_or(encoding),
broadcast: spec.broadcast,
};
ensure!(
topics.insert(broadcast.topic.clone()),
"several broadcasts publish on {}",
broadcast.topic
);
Ok(broadcast)
})
.collect()
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Discovery {
pub prefixes: Vec<String>,
pub topic_template: String,
pub frame_id: Option<String>,
pub stamp: StampSource,
pub max_height: Option<u32>,
pub encoding: moqros::PixelFormat,
}
pub const DEFAULT_TOPIC_TEMPLATE: &str = "/moqros/{name}";
impl Discovery {
pub fn new(
prefixes: Vec<String>,
topic_template: String,
frame_id: Option<String>,
stamp: StampSource,
max_height: Option<u32>,
encoding: moqros::PixelFormat,
) -> anyhow::Result<Self> {
ensure!(
topic_template.contains("{name}"),
"--topic-template {topic_template:?} has no {{name}}"
);
let discovery = Self {
prefixes: prefixes.iter().map(|p| p.trim_matches('/').to_string()).collect(),
topic_template,
frame_id,
stamp,
max_height,
encoding,
};
if let Err(err) = discovery.broadcast("name") {
bail!("--topic-template {:?}: {err}", discovery.topic_template);
}
Ok(discovery)
}
pub fn covers(&self, name: &str) -> bool {
self.prefixes.iter().any(|prefix| is_under(name, prefix))
}
pub fn broadcast(&self, name: &str) -> Result<SubBroadcast, String> {
let topic = self.topic_template.replace("{name}", name.trim_matches('/'));
if !is_ros_topic(&topic) {
return Err(format!(
"{topic:?} isn't a topic name moqros republishes on (letters, digits, `_` and `/` only)"
));
}
Ok(SubBroadcast {
broadcast: name.to_string(),
topic,
ros_type: None,
frame_id: self.frame_id.clone(),
stamp: self.stamp,
max_height: self.max_height,
encoding: self.encoding,
})
}
}
fn is_under(name: &str, prefix: &str) -> bool {
let name = name.trim_matches('/');
prefix.is_empty() || name == prefix || name.strip_prefix(prefix).is_some_and(|rest| rest.starts_with('/'))
}
fn is_ros_topic(topic: &str) -> bool {
let Some(tokens) = topic.strip_prefix('/') else {
return false;
};
let is_token = |token: &str| {
let mut chars = token.chars();
chars.next().is_some_and(|c| c.is_ascii_alphabetic() || c == '_')
&& chars.all(|c| c.is_ascii_alphanumeric() || c == '_')
&& !token.contains("__")
};
!tokens.is_empty() && tokens.split('/').all(is_token)
}
pub fn check_no_loop(
topics: &[PubTopic],
broadcasts: &[SubBroadcast],
discovery: Option<&Discovery>,
) -> anyhow::Result<()> {
let name = |name: &str| name.trim_matches('/').to_string();
for topic in topics {
if let Some(discovery) = discovery {
ensure!(
!discovery.covers(&topic.broadcast),
"the broadcast {:?} is published (from {}) and under a --broadcast-prefix; that would loop",
topic.broadcast,
topic.topic
);
}
for broadcast in broadcasts {
ensure!(
name(&topic.broadcast) != name(&broadcast.broadcast),
"the broadcast {:?} is both published (from {}) and subscribed to; that would loop",
topic.broadcast,
topic.topic
);
ensure!(
name(&topic.topic) != name(&broadcast.topic),
"the topic {} is both published to the relay and republished from {:?}; that would loop",
topic.topic,
broadcast.broadcast
);
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parses_topic_specs() {
let spec: TopicSpec = "/scan, format=cdr ,type=sensor_msgs/msg/LaserScan,mode=stream,broadcast=lidar"
.parse()
.unwrap();
assert_eq!(
spec,
TopicSpec {
topic: "/scan".into(),
format: Some(Format::Cdr),
ros_type: Some("sensor_msgs/msg/LaserScan".into()),
mode: Some(moqros::DataMode::Stream),
broadcast: Some("lidar".into()),
}
);
assert_eq!("/image_raw".parse::<TopicSpec>().unwrap().format, None);
for bad in [
"",
",format=json",
"/a,json",
"/a,codec=vp8",
"/a,format=xml",
"/a,mode=x",
"/a,type=x,type=y",
] {
assert!(bad.parse::<TopicSpec>().is_err(), "{bad:?}");
}
let spec: BroadcastSpec = "camera/image_raw,topic=/out,frame_id=cam,type=sensor_msgs/msg/Image,stamp=receive"
.parse()
.unwrap();
assert_eq!(
(
spec.broadcast.as_str(),
spec.topic.as_deref(),
spec.frame_id.as_deref(),
spec.stamp
),
(
"camera/image_raw",
Some("/out"),
Some("cam"),
Some(StampSource::Receive)
)
);
assert!("camera,stamp=now".parse::<BroadcastSpec>().is_err());
assert!("chatter,format=json".parse::<BroadcastSpec>().is_err());
assert_eq!(
"cam,max_height=360".parse::<BroadcastSpec>().unwrap().max_height,
Some(360)
);
assert!("cam,max_height=tall".parse::<BroadcastSpec>().is_err());
assert_eq!(
"cam,encoding=mono8".parse::<BroadcastSpec>().unwrap().encoding,
Some(moqros::PixelFormat::Mono8)
);
assert!("cam,encoding=yuv422".parse::<BroadcastSpec>().is_err());
assert!("cam,encoding=16UC1".parse::<BroadcastSpec>().is_err());
}
#[test]
fn resolves_pub_topics() {
let specs = |specs: &[&str]| {
specs
.iter()
.map(|s| s.parse::<TopicSpec>().unwrap())
.collect::<Vec<_>>()
};
let snapshot = moqros::DataMode::Snapshot;
let topics = pub_topics(
specs(&[
"/camera/image_raw",
"/chatter,format=json",
"/log,mode=stream,broadcast=logs",
]),
Format::Video,
snapshot,
None,
None,
)
.unwrap();
let summary: Vec<_> = topics
.iter()
.map(|t| (t.broadcast.as_str(), t.format, t.mode))
.collect();
assert_eq!(
summary,
[
("camera/image_raw", Format::Video, snapshot),
("chatter", Format::Json, snapshot),
("logs", Format::Video, moqros::DataMode::Stream),
]
);
let one = pub_topics(
specs(&["/a"]),
Format::Cdr,
snapshot,
Some("t/msg/T".into()),
Some("b".into()),
)
.unwrap();
assert_eq!(
(one[0].broadcast.as_str(), one[0].ros_type.as_deref()),
("b", Some("t/msg/T"))
);
assert!(
pub_topics(
specs(&["/a", "/b"]),
Format::Json,
snapshot,
Some("t/msg/T".into()),
None
)
.is_err()
);
assert!(pub_topics(specs(&["/a", "/b"]), Format::Json, snapshot, None, Some("b".into())).is_err());
assert!(pub_topics(specs(&["/a", "a,format=json"]), Format::Video, snapshot, None, None).is_err());
assert!(
pub_topics(
specs(&["/a,type=std_msgs/msg/String"]),
Format::Video,
snapshot,
None,
None
)
.is_err()
);
assert!(
pub_topics(
specs(&["/a,type=sensor_msgs/msg/Image"]),
Format::Video,
snapshot,
None,
None
)
.is_ok()
);
assert!(pub_topics(Vec::new(), Format::Video, snapshot, None, None).is_err());
}
#[test]
fn refuses_loops() {
let topics = |specs: &[&str]| {
let specs = specs.iter().map(|s| s.parse::<TopicSpec>().unwrap()).collect();
pub_topics(specs, Format::Json, moqros::DataMode::default(), None, None).unwrap()
};
let broadcasts = |specs: &[&str]| {
let specs = specs.iter().map(|s| s.parse::<BroadcastSpec>().unwrap()).collect();
sub_broadcasts(
specs,
None,
None,
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8,
)
.unwrap()
};
let odom = topics(&["/odom,broadcast=robot/odom"]);
assert!(check_no_loop(&odom, &broadcasts(&["robot/cmd_vel,topic=/cmd_vel"]), None).is_ok());
assert!(check_no_loop(&odom, &broadcasts(&["/robot/odom/,topic=/other"]), None).is_err());
assert!(check_no_loop(&odom, &broadcasts(&["robot/cmd_vel,topic=/odom"]), None).is_err());
assert!(check_no_loop(&odom, &[], None).is_ok());
}
#[test]
fn resolves_sub_broadcasts() {
let specs = |specs: &[&str]| {
specs
.iter()
.map(|s| s.parse::<BroadcastSpec>().unwrap())
.collect::<Vec<_>>()
};
let topics = |broadcasts: Vec<SubBroadcast>| broadcasts.into_iter().map(|b| b.topic).collect::<Vec<_>>();
assert_eq!(
topics(
sub_broadcasts(
specs(&["image_raw"]),
None,
None,
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.unwrap()
),
[DEFAULT_SUB_TOPIC]
);
assert_eq!(
topics(
sub_broadcasts(
specs(&["image_raw"]),
Some("/x".into()),
None,
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.unwrap()
),
["/x"]
);
let broadcasts = sub_broadcasts(
specs(&[
"sample/image_raw,topic=/moqros/image",
"chatter",
"/front/imu/,frame_id=imu,stamp=receive",
]),
None,
None,
Some("camera"),
StampSource::Source,
Some(480),
moqros::PixelFormat::Bgr8,
)
.unwrap();
assert_eq!(broadcasts[0].frame_id.as_deref(), Some("camera"));
assert_eq!(broadcasts[0].stamp, StampSource::Source);
assert_eq!(broadcasts[2].frame_id.as_deref(), Some("imu"));
assert_eq!(broadcasts[2].stamp, StampSource::Receive);
assert_eq!(broadcasts[2].max_height, Some(480));
assert_eq!(broadcasts[2].encoding, moqros::PixelFormat::Bgr8);
assert_eq!(
sub_broadcasts(
specs(&["image_raw"]),
None,
None,
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.unwrap()[0]
.frame_id,
None
);
assert_eq!(
topics(broadcasts),
["/moqros/image", "/moqros/chatter", "/moqros/front/imu"]
);
assert!(
sub_broadcasts(
specs(&["a", "b"]),
Some("/x".into()),
None,
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.is_err()
);
assert!(
sub_broadcasts(
specs(&["a", "b"]),
None,
Some("t/msg/T".into()),
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.is_err()
);
assert!(
sub_broadcasts(
specs(&["a,topic=/x", "b,topic=/x"]),
None,
None,
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.is_err()
);
}
#[test]
fn discovers_broadcasts_under_prefixes() {
let discovery = Discovery::new(
vec!["robots/".into(), "/drones".into()],
DEFAULT_TOPIC_TEMPLATE.into(),
Some("camera".into()),
StampSource::Receive,
Some(480),
moqros::PixelFormat::Mono8,
)
.unwrap();
assert!(discovery.covers("robots/r1/camera"));
assert!(discovery.covers("drones"));
assert!(!discovery.covers("robots2/camera"));
assert!(!discovery.covers("cars/robots"));
let found = discovery.broadcast("robots/r1/camera").unwrap();
assert_eq!(found.topic, "/moqros/robots/r1/camera");
assert_eq!(found.max_height, Some(480));
assert_eq!(found.encoding, moqros::PixelFormat::Mono8);
assert_eq!(
(found.frame_id.as_deref(), found.stamp),
(Some("camera"), StampSource::Receive)
);
for bad in [
"robots/r-1/camera",
"robots/1/camera",
"robots//camera",
"robots/a b",
"robots/__x",
"robots/{x}",
] {
assert!(discovery.broadcast(bad).is_err(), "{bad}");
}
assert!(
Discovery::new(
vec![],
"/remote".into(),
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.is_err()
);
assert!(
Discovery::new(
vec![],
"remote/{name}".into(),
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8
)
.is_err()
);
let custom = Discovery::new(
vec![],
"/remote/{name}/image".into(),
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8,
)
.unwrap();
assert_eq!(custom.broadcast("r1").unwrap().topic, "/remote/r1/image");
}
#[test]
fn refuses_to_discover_its_own_broadcasts() {
let topics = pub_topics(
vec!["/robots/me/camera".parse().unwrap()],
Format::Video,
moqros::DataMode::Snapshot,
None,
None,
)
.unwrap();
let discovery = |prefix: &str| {
Discovery::new(
vec![prefix.into()],
DEFAULT_TOPIC_TEMPLATE.into(),
None,
StampSource::Source,
None,
moqros::PixelFormat::Rgb8,
)
.unwrap()
};
assert!(check_no_loop(&topics, &[], Some(&discovery("robots"))).is_err());
assert!(check_no_loop(&topics, &[], Some(&discovery("drones"))).is_ok());
}
}