MoQROS

Stream ROS 2 topics over Media over QUIC (MoQ), in Rust: images as video, and any other message type as JSON or CDR data.
moqros converts each image to I420, encodes it (VP8 or H.264), and publishes it to a MoQ relay as a
hang broadcast. That's the WebCodecs-friendly format played by the official
@moq/watch web component. Topics of any other type go into a
hang data track instead (see Other message types). It can also go the other way:
subscribe to a broadcast, decode it, and republish it as a ROS topic.
ROS 2 topic ──► moqros-pub ──► moq-relay ──► browser (<moq-watch>, data viewer)
Image / any msg hang QUIC/WebTransport └──► moqros-sub ──► ROS 2 topic
Layout
| Path | What |
|---|---|
crates/moqros |
The library (crates.io, docs.rs). The core (conversion, codec, MoQ publish/subscribe) is ROS-independent; the ros feature adds r2r bridges. |
crates/moqros-cli |
Bridge nodes (crates.io): moqros-pub (ROS → MoQ) and moqros-sub (MoQ → ROS). Also a colcon (ament_cargo) package. |
examples/image_source |
Sample node that plays a video file (via ffmpeg) or a PNG/JPEG directory as an Image topic. |
examples/web |
Static browser viewer built on @moq/watch. |
docker/ |
Dockerfile (ROS 2 Jazzy + Rust, moq-relay) and the end-to-end compose.yml. |
End-to-end sample (Docker)
You only need Docker:
On first start, the one-shot samples service generates a test video (samples/sample.mp4) and a PNG
sequence (samples/frames/) with ffmpeg inside the container. Files that already exist are kept. To stream
your own footage, put a video file or a directory of PNG/JPEG frames in samples/ and pass SAMPLE=<name>.
Open http://localhost:8080 in a Chromium-based browser or Firefox. Both support WebTransport. The page
connects to http://localhost:4443/anon, plays the video broadcast sample/image_raw, and shows the latest
message of the data broadcast chatter below it. Pick other broadcasts in the form, or with the name
(video) and data (comma-separated) query parameters.
The compose file runs these services:
samples: creates the sample inputs if they're missing, then exits.relay:moq-relaywith a self-signed certificate. It allows anonymous access underanon/.source:image_sourcepublishes/sample/image_rawat 30 fps asbgr8(1280x720; setWIDTH=640to scale down).chatter:ros2 topic pubpublishes astd_msgs/msg/Headerstamped with the publish time on/chatterat 10 Hz. It logs every 100th message.moqros-pub: publishes/sample/image_rawas the video broadcastsample/image_raw, and/chatteras the JSON data broadcastchatter.moqros-sub: subscribes to both broadcasts. It republishes decodedrgb8images on/moqros/image, and the headers on/moqros/chatter.web: nginx servingexamples/web.
To play the PNG sequence instead of the video, run SAMPLE=frames docker compose -f docker/compose.yml up.
The ROS services share one network and IPC namespace, as processes on one robot would. This lets Fast DDS
use shared memory for the 2.7 MB frames. The source publishes with reliable QoS, and moqros-pub runs with
--reliable. With best-effort QoS, large images are split into many UDP fragments, and losing any one of them
drops the whole frame. In testing that cut 30 fps down to 10–20 fps. On a real robot, match the camera
driver's QoS. Both bridges log their message rate every 10 s (message rate).
To check the round trip on the ROS side:
If UDP port forwarding doesn't work in your Docker setup, run the relay on the host instead
(cargo install moq-relay && moq-relay docker/relay.toml).
Installing the bridge nodes
moqros-pub and moqros-sub need a ROS 2 environment, libvpx, pkg-config, and libclang at build time
(see Development).
With cargo, from crates.io:
IDL_PACKAGE_FILTER="std_msgs;sensor_msgs;geometry_msgs;nav_msgs;rosgraph_msgs"
As a ROS 2 package with colcon (crates/moqros-cli has an ament_cargo package.xml):
&&
ROS arguments and parameters
Both bridges accept the standard --ros-args: remap the node name (-r __node:=…) and namespace
(-r __ns:=…), and set ROS parameters with -p or --params-file. Each command-line flag can also be
set as a parameter of the same name in snake_case (--keyframe-interval-ms becomes keyframe_interval_ms).
A flag on the command line wins over a parameter, and a parameter wins over environment variables and
defaults. Bool flags also take a value (--reliable=false). Parameters are read once at startup, and
parameters that match no flag are ignored with a warning. In a parameter file, key a namespaced node by
its fully qualified name (/front/moqros_pub); the bare node name only matches in the root namespace.
A repeatable flag (--topic, --broadcast) takes a string array parameter, one element per occurrence
(-p "topic:=[/a, /b]"). If the flag is also on the command line, the command line replaces the whole
array.
The colcon package installs a launch file (moqros.launch.py) and a sample parameter file
(config/moqros.yaml):
The launch file uses $MOQROS_URL when url isn't given, and publishes the broadcast
<namespace>/image_raw (namespace:=/front gives front/image_raw).
Several topics
One moqros-pub can publish several topics, and one moqros-sub can republish several broadcasts. Repeat
--topic or --broadcast, and add options after the name, separated by commas:
| Bridge | Options | Defaults |
|---|---|---|
moqros-pub --topic TOPIC,… |
format, type, mode, broadcast |
--format and --mode for every topic. The broadcast name is the topic without its leading slash. |
moqros-sub --broadcast NAME,… |
topic, type, frame_id |
--frame-id for every broadcast. The topic is /moqros/<broadcast> (/moqros/image for a lone broadcast). |
Each topic becomes a broadcast of its own. --type and --broadcast of moqros-pub, and --topic and
--type of moqros-sub, name a single topic, so they only work with one --topic or --broadcast. Video
topics start at once. A data topic without a type starts when it appears in the ROS graph. moqros-sub
waits for all its broadcasts at once, and starts each one when it's announced. It skips a broadcast whose
topic it can't create (e.g. a message type this build has no bindings for), and goes on with the rest.
Otherwise, each bridge exits when any of its topics fails.
Other message types
moqros-pub --format json|cdr publishes a topic of any message type. The default, --format video, is for
sensor_msgs/msg/Image.
json: each message is one JSON document, in r2r's mapping of the message fields. Any hang consumer can read it, including a browser; theexamples/webviewer shows the latest message. Large arrays (point clouds, images) get big and slow as JSON, so usecdrfor those.cdr: each message is its ROS serialization, passed through untouched. It's compact and lossless, but only ROS-aware consumers can decode it. Images sent ascdrarrive uncompressed and bit-exact.--mode snapshot(default): each message is a MoQ group of its own, and subscribers skip to the newest one when they fall behind. Suits sensor data and state.--mode stream: all messages go into one group and are delivered in order, none skipped. Suits logs and commands. The group never closes, so the publisher and the relay keep its messages for as long as the broadcast runs, and a subscriber that joins late gets them all from the start. Avoid it for long-running, high-rate topics; usesnapshotthere.- Type: without
--type,moqros-pubwaits for the topic to appear and asks the ROS graph for its type. Relative topic names resolve against the node's namespace, but remappings aren't applied. The type goes into the catalog, somoqros-subrepublishes with the same type (--typeoverrides it). - Supported types: r2r generates message bindings at build time, and the data bridges only handle types
it generated. With
IDL_PACKAGE_FILTERset, list every package you need (the Docker image includesstd_msgs,sensor_msgs,geometry_msgs,nav_msgs, androsgraph_msgs).
moqros-sub handles both kinds of broadcast: it republishes video as rgb8 images, and data tracks as their
message type. It fails if a broadcast comes back carrying something different from before.
Library usage
The library is published on crates.io as moqros; API docs are on
docs.rs.
[]
= { = "0.1", = ["ros"] } # omit `ros` for the ROS-independent core
ROS → MoQ
use ;
let ctx = create?;
let mut node = create?;
let publisher = connect?;
let broadcast = publisher.create_image_broadcast?;
let bridge = spawn_ros_to_moq?;
spawn_blocking;
bridge.await??;
Any other message type goes through a data broadcast:
use ;
let settings = DataSettings ;
let broadcast = publisher.create_data_broadcast?;
let bridge = spawn_ros_to_moq_data?;
spawn_moq_to_ros goes the other way for both kinds of broadcast.
Without ROS
let publisher = connect?;
let mut camera = publisher.create_image_broadcast?;
camera.publish?;
let subscriber = connect?;
let mut images = subscriber.subscribe_images.await?;
while let Some = images.next_image.await?
Data broadcasts carry opaque payloads:
let mut status = publisher.create_data_broadcast?;
status.publish?;
let mut messages = subscriber.subscribe_data.await?;
while let Some = messages.next_message.await?
Subscriber::subscribe returns either kind, depending on what the broadcast's catalog offers.
Codecs
| Codec | Feature | Backend | Notes |
|---|---|---|---|
| VP8 | vp8 (default) |
system libvpx, real-time CBR | |
| H.264 | h264 |
Cisco's OpenH264 binary, loaded at runtime | Constrained Baseline, avc3. |
Pick the codec with EncoderSettings::codec (moqros-pub --codec vp8|h264). The subscriber picks the best
rendition in the catalog that this build can decode.
The h264 feature loads Cisco's prebuilt OpenH264 binary at runtime and checks its SHA-256 against known
Cisco releases:
# downloads from ciscobinary.openh264.org
You can also set the path in code with moqros::set_openh264_library.
Behavior
- Encodings:
rgb8,bgr8,rgba8,bgra8,mono8,yuv422(UYVY), andyuv422_yuy2(YUYV). An odd trailing row or column is cropped, because 4:2:0 video needs even dimensions. - Format on the wire: each frame goes in the hang "legacy" container (a timestamp plus the codec payload). The catalog
(
catalog.json) has one video track namedvideo. It's republished whenever the resolution changes. - Groups: each keyframe starts a new MoQ group. The keyframe interval (default 2 s) bounds how long a new viewer waits for the first picture.
- Latency: if the encoder falls behind, the bridge drops all but the newest pending image. The subscriber always jumps to the newest group.
- Timestamps:
header.stampbecomes a µs timeline that starts at 0 for each broadcast.moqros-substamps the republished images with the local receive time. - Reconnects: the relay connection redials automatically.
moqros-subresubscribes when the broadcast comes back. - QoS: both bridges default to the best-effort
sensor_dataprofile. Pass--reliableto match a reliable publisher, which is recommended for large uncompressed images. - Data broadcasts: the catalog lists one track named
data, in itsjsonsection (JSON) or itsbinarysection (CDR, MIME typeapplication/x-ros2-cdr), with the mode and the ROS type (rosType). Each MoQ frame is one message payload, without a container.
Development
The core library builds and tests natively on any OS. ROS isn't required for it, but the default vp8
feature needs libvpx, pkg-config, and libclang (bindgen generates the libvpx bindings):
# Debian/Ubuntu
# or macOS (libclang comes with the Xcode CLI tools)
# brew install libvpx pkgconf
# H.264 tests (skipped unless OPENH264_LIBRARY is set):
# OPENH264_LIBRARY=$(./scripts/fetch_openh264.sh) cargo test -p moqros --features h264
# Integration test through a real relay:
MOQROS_RELAY_BIN=
The ros feature, moqros-cli, and examples/image_source need a sourced ROS 2 environment and libclang,
because r2r generates its bindings at build time. Use the Docker build stage, or on a ROS machine:
IDL_PACKAGE_FILTER="std_msgs;sensor_msgs;geometry_msgs;rosgraph_msgs"
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Dependencies have their own licenses. libvpx is BSD-3-Clause, and the env-libvpx-sys bindings are MPL-2.0.
Cisco's OpenH264 binary is covered by Cisco's binary license.