Skip to main content

moq_video/encode/
producer.rs

1//! Publish encoded video frames as a moq video track, with optional capture.
2//!
3//! Encoding is strictly on demand: the track and its catalog rendition are
4//! advertised immediately (the rendition is probed from the encoder, since
5//! nothing has been encoded yet), and the encoder itself only runs while a
6//! subscriber is watching. Capture opens its camera once at startup to learn
7//! the mode it negotiates, then keeps it closed between viewers. This mirrors
8//! `moq-boy`, which pauses its emulator on `track::Producer::used()` /
9//! `unused()`.
10
11#[cfg(feature = "capture")]
12use std::time::Instant;
13
14use moq_mux::catalog::hang::CatalogExt;
15#[cfg(any(feature = "capture", test))]
16use moq_net::Timestamp;
17
18use crate::Error;
19#[cfg(any(feature = "capture", test))]
20use crate::Frame;
21#[cfg(feature = "capture")]
22use crate::capture;
23
24use super::Encoded;
25#[cfg(feature = "capture")]
26use super::Sink;
27#[cfg(any(feature = "capture", test))]
28use super::encoder;
29#[cfg(feature = "capture")]
30use super::encoder::Codec;
31#[cfg(feature = "capture")]
32use super::rate::{Control, Policy};
33
34/// Last-resort framerate when neither the caller nor the camera reports one.
35#[cfg(feature = "capture")]
36const DEFAULT_FRAMERATE: u32 = 30;
37
38/// The rendition as the importer wants it: what to publish now, and what to keep filling in on
39/// every config it later resolves from the bitstream.
40///
41/// A probed rendition is what the first keyframe carries, so the importer's own config matches it
42/// field for field and the catalog is published once rather than corrected. The fields the
43/// bitstream can't reveal (bitrate always, framerate outside an optional VUI) are the ones this
44/// overlay keeps supplying.
45fn rendition_hint(rendition: hang::catalog::VideoConfig) -> moq_mux::catalog::VideoHint {
46	let mut hint = moq_mux::catalog::VideoHint::default();
47	hint.codec = Some(rendition.codec);
48	hint.coded_width = rendition.coded_width;
49	hint.coded_height = rendition.coded_height;
50	hint.display_aspect_width = rendition.display_aspect_width;
51	hint.display_aspect_height = rendition.display_aspect_height;
52	hint.framerate = rendition.framerate;
53	hint.bitrate = rendition.bitrate;
54	hint.optimize_for_latency = rendition.optimize_for_latency;
55	hint
56}
57
58/// Per-codec splitter + importer pair. Each codec frames its packets and resolves
59/// its catalog rendition differently, so the producer holds one of these.
60enum Codecs<E: CatalogExt> {
61	H264 {
62		split: moq_mux::codec::h264::Split,
63		import: moq_mux::codec::h264::Import<E>,
64	},
65	H265 {
66		split: moq_mux::codec::h265::Split,
67		import: moq_mux::codec::h265::Import<E>,
68	},
69}
70
71/// Publishes encoded video frames as a moq track (avc3 / hev1 depending on the
72/// codec).
73///
74/// Built on the async side so the track is advertised (and the catalog
75/// registered) before the camera opens; this is what lets a subscriber
76/// trigger capture on demand. The `moq_mux::codec` importer for the codec
77/// handles catalog registration and framing.
78/// `E` is the catalog's application extension, defaulting to none. A host
79/// carrying its own catalog sections (the FFI bindings use `hang::Extra`)
80/// publishes into a catalog of the same shape.
81pub struct Producer<E: CatalogExt = ()> {
82	codecs: Codecs<E>,
83}
84
85impl<E: CatalogExt> Producer<E> {
86	/// Publish a track carrying `rendition` into `broadcast`, registering it in
87	/// `catalog`. The frames fed to [`publish`](Self::publish) must be in that
88	/// codec's framing, which is what the [`Encoder`](super::Encoder) the
89	/// rendition was probed from emits.
90	///
91	/// `rendition` comes from [`Config::probe`](super::Config::probe), so it is
92	/// what the encoder will actually emit rather than a guess. It is published
93	/// immediately, before anything is encoded, which is what lets a subscriber
94	/// discover a track an on-demand encoder has not run for yet; because it
95	/// already says what the first keyframe says, that keyframe confirms the
96	/// catalog instead of correcting it.
97	pub fn new(
98		mut broadcast: moq_net::broadcast::Producer,
99		catalog: moq_mux::catalog::Producer<E>,
100		rendition: hang::catalog::VideoConfig,
101	) -> Result<Self, Error> {
102		let codecs = match &rendition.codec {
103			hang::catalog::VideoCodec::H264(_) => {
104				let track = broadcast.unique_track(".avc3", catalog.track_info())?;
105				Codecs::H264 {
106					split: moq_mux::codec::h264::Split::new(),
107					import: moq_mux::codec::h264::Import::new(track, catalog.reserve(), rendition_hint(rendition))?,
108				}
109			}
110			hang::catalog::VideoCodec::H265(_) => {
111				let track = broadcast.unique_track(".hev1", catalog.track_info())?;
112				Codecs::H265 {
113					split: moq_mux::codec::h265::Split::new(),
114					import: moq_mux::codec::h265::Import::new(track, catalog.reserve(), rendition_hint(rendition))?,
115				}
116			}
117			// Unreachable via `Config::probe`, which only encodes what `Codec` covers.
118			other => {
119				return Err(Error::Codec(anyhow::anyhow!(
120					"{other} is not a codec this producer can publish"
121				)));
122			}
123		};
124		Ok(Self { codecs })
125	}
126
127	/// A watch-only handle to the track's subscriber demand, created eagerly so
128	/// subscription state is observable before any frames arrive. Watch it via
129	/// [`used`](moq_net::track::Demand::used) / [`unused`](moq_net::track::Demand::unused).
130	pub fn demand(&self) -> moq_net::track::Demand {
131		match &self.codecs {
132			Codecs::H264 { import, .. } => import.demand(),
133			Codecs::H265 { import, .. } => import.demand(),
134		}
135	}
136
137	/// Publish already-encoded frames, each at its own timestamp. Each frame is one
138	/// whole access unit in the producer's codec framing.
139	pub fn publish(&mut self, encoded: &[Encoded]) -> Result<(), Error> {
140		for frame in encoded {
141			let timestamp = Some(frame.timestamp);
142			// The encoder emits one whole access unit per frame, so flush to emit it.
143			match &mut self.codecs {
144				Codecs::H264 { split, import } => {
145					let mut frames = split.decode(&frame.payload, timestamp)?;
146					frames.extend(split.flush(timestamp)?);
147					import.decode(frames)?;
148				}
149				Codecs::H265 { split, import } => {
150					let mut frames = split.decode(&frame.payload, timestamp)?;
151					frames.extend(split.flush(timestamp)?);
152					import.decode(frames)?;
153				}
154			}
155		}
156		Ok(())
157	}
158
159	/// Mark a break in the published timeline: whatever is published next does not continue
160	/// what came before.
161	///
162	/// Call this when the encoder stops rather than merely pausing between frames -- a
163	/// capture that goes idle, a source switch, anything that will resume on a re-anchored
164	/// clock. See [`Producer::discontinuity`](moq_mux::container::Producer::discontinuity)
165	/// for what the marker buys a consumer.
166	pub fn discontinuity(&mut self) -> Result<(), Error> {
167		match &mut self.codecs {
168			Codecs::H264 { import, .. } => import.discontinuity()?,
169			Codecs::H265 { import, .. } => import.discontinuity()?,
170		}
171		Ok(())
172	}
173
174	/// Finalize the track.
175	///
176	/// Consumes the producer: nothing can be published after the track ends, so
177	/// this is the last call rather than one leaving a dead producer in your hands.
178	pub fn finish(mut self) -> Result<(), Error> {
179		match &mut self.codecs {
180			Codecs::H264 { import, .. } => import.finish()?,
181			Codecs::H265 { import, .. } => import.finish()?,
182		}
183		Ok(())
184	}
185
186	/// Abort the track with `err` instead of finishing it cleanly, so subscribers
187	/// see the real cause rather than [`moq_net::Error::Dropped`].
188	///
189	/// Consumes the producer, like [`finish`](Self::finish).
190	pub fn abort(self, err: moq_net::Error) {
191		match self.codecs {
192			Codecs::H264 { import, .. } => import.abort(err),
193			Codecs::H265 { import, .. } => import.abort(err),
194		}
195	}
196}
197
198/// Source-agnostic encode knobs for [`publish_capture`], where the geometry
199/// (width / height / framerate) comes from the capture source, not the caller.
200/// For the bring-your-own-frames [`Encoder`](super::Encoder) path, where you
201/// must specify geometry, use [`Config`](super::Config) instead.
202///
203/// `#[non_exhaustive]`: construct via [`Options::default`] and set fields, so
204/// new knobs can be added without breaking callers.
205#[derive(Clone, Default)]
206#[non_exhaustive]
207#[cfg(feature = "capture")]
208pub struct Options {
209	/// Target bitrate in bits per second; `None` derives from resolution.
210	///
211	/// This is a ceiling, not a fixed rate: with [`bandwidth`](Self::bandwidth)
212	/// set, the encoder backs off below it while the uplink is congested and
213	/// climbs back afterwards, but never exceeds it.
214	pub bitrate: Option<u64>,
215	/// Output codec. Defaults to [`Codec::H264`].
216	pub codec: Codec,
217	/// Encoder implementation preference.
218	pub kind: encoder::Kind,
219	/// The connection's send-bandwidth estimate, from
220	/// [`Session::send_bandwidth`](moq_net::Session::send_bandwidth) (or
221	/// `moq_native::Reconnect::send_bandwidth`, which survives reconnects).
222	///
223	/// Set it and the encoder tracks the estimate per the default
224	/// [`rate::Policy`](super::rate::Policy), so a closing uplink gets a softer
225	/// picture instead of a stalled one. Leave it `None` and the
226	/// encoder holds [`bitrate`](Self::bitrate) regardless of congestion, which
227	/// is what you want when the estimate isn't meaningful (a local file, a test
228	/// harness) or unavailable (a publisher that only accepts inbound sessions).
229	pub bandwidth: Option<moq_net::bandwidth::Consumer>,
230}
231
232// Hand-written: `bandwidth::Consumer` isn't `Debug`, but its presence is the
233// only part worth printing anyway.
234#[cfg(feature = "capture")]
235impl std::fmt::Debug for Options {
236	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
237		f.debug_struct("Options")
238			.field("bitrate", &self.bitrate)
239			.field("codec", &self.codec)
240			.field("kind", &self.kind)
241			.field("bandwidth", &self.bandwidth.is_some())
242			.finish()
243	}
244}
245
246/// Capture a webcam and publish it as an on-demand video track.
247///
248/// Returns when the broadcast is dropped (the track stops being announced)
249/// or the capture loop fails. Frames are stamped from `clock`, so passing the
250/// same [`Clock`](moq_mux::Clock) to a concurrent audio publish keeps the two
251/// tracks aligned.
252///
253/// The camera is opened once at startup to probe the mode it negotiates, then released until a
254/// subscriber arrives and reopened for as long as one is watching. That one open is what lets the
255/// catalog rendition be exact before a single frame is published, so a consumer can size itself
256/// against it (and discover the track at all) without waiting for an encoder that may never run.
257#[cfg(feature = "capture")]
258pub async fn publish_capture<E: CatalogExt>(
259	broadcast: moq_net::broadcast::Producer,
260	catalog: moq_mux::catalog::Producer<E>,
261	capture: capture::Config,
262	encode: Options,
263	clock: moq_mux::Clock,
264) -> Result<(), Error> {
265	// A caller asking for exactly zero is an error; omitting it (None) is
266	// fine and resolves to the camera's reported rate once it's open.
267	if capture.framerate == Some(0) {
268		return Err(Error::InvalidFramerate(0));
269	}
270
271	// Open the camera once to find out what it actually negotiated, since a requested size is only a
272	// hint (macOS ignores it outright) and the encoder is built from the mode, not the request. It
273	// closes again immediately: this costs one camera open at startup and buys a rendition that says
274	// exactly what the stream will carry, rather than one every consumer has to treat as provisional.
275	let rendition = {
276		let camera = capture::open(&capture).await?;
277		let mut probe_config = encoder::Config::new(
278			camera.width(),
279			camera.height(),
280			capture
281				.framerate
282				.or_else(|| camera.framerate())
283				.unwrap_or(DEFAULT_FRAMERATE),
284		);
285		probe_config.bitrate = encode.bitrate;
286		probe_config.codec = encode.codec;
287		probe_config.kind = encode.kind.clone();
288		probe_config.color = camera.color();
289		probe_config.probe().await?
290	};
291
292	let mut producer = Producer::new(broadcast, catalog, rendition)?;
293	let demand = producer.demand();
294
295	let result = capture_loop(&mut producer, &demand, &capture, &encode, &clock).await;
296
297	// This runs only when the loop ends on its own (the track is usually already
298	// going away by then); a Ctrl+C cancels the future before this point, since
299	// async `Drop` can't finalize the track.
300	match &result {
301		// Clean end (the track was dropped): best-effort finish.
302		Ok(()) => {
303			if let Err(err) = producer.finish() {
304				tracing::debug!(error = %err, "video track finish after capture ended");
305			}
306		}
307		// The capture loop failed: abort with the real cause so subscribers see it.
308		Err(err) => producer.abort(moq_net::Error::Transport(err.to_string())),
309	}
310	result
311}
312
313/// Off macOS, [`publish_capture`]'s future must stay `Send` so a server can
314/// `tokio::spawn` it: the encoder runs on its own thread and the capture guard
315/// is `Send` there. This is never called; it exists only to fail compilation if
316/// the future ever regains a `!Send` component. macOS is exempt (the objc
317/// capture session is `!Send`).
318#[cfg(all(feature = "capture", not(target_os = "macos")))]
319#[allow(dead_code)]
320fn assert_publish_capture_send(
321	broadcast: moq_net::broadcast::Producer,
322	catalog: moq_mux::catalog::Producer,
323	capture: capture::Config,
324	encode: Options,
325	clock: moq_mux::Clock,
326) {
327	fn is_send<T: Send>(_: &T) {}
328	is_send(&publish_capture(broadcast, catalog, capture, encode, clock));
329}
330
331/// The live rate control state: the estimate source paired with the policy
332/// tracking it. `None` once there's nothing left to track, which is what stops
333/// the `select!` arm from spinning on a channel that is permanently ready.
334#[cfg(feature = "capture")]
335type Rate = Option<(moq_net::bandwidth::Consumer, Control)>;
336
337/// Wait for the next bandwidth estimate, or forever when rate control is off or
338/// finished. Cancel-safe: [`Consumer::changed`](moq_net::bandwidth::Consumer::changed)
339/// only reads shared state, so losing this race to a frame drops no estimate,
340/// it just re-reads the latest one next time round.
341#[cfg(feature = "capture")]
342async fn next_estimate(rate: &mut Rate) -> Option<Option<u64>> {
343	match rate {
344		Some((bandwidth, _)) => bandwidth.changed().await.ok(),
345		// No estimate source: park this arm forever so `select!` ignores it.
346		None => std::future::pending().await,
347	}
348}
349
350/// Feed an estimate through the policy and retune the encoder if it moved.
351///
352/// `None` means the producer is gone (the session ended for good), so rate
353/// control retires; a `Some(None)` estimate means the value is merely
354/// unavailable right now, which the policy holds through.
355#[cfg(feature = "capture")]
356async fn apply_estimate(encoder: &mut Sink, rate: &mut Rate, estimate: Option<Option<u64>>) {
357	let Some((_, control)) = rate.as_mut() else { return };
358
359	let Some(estimate) = estimate else {
360		tracing::debug!("bandwidth estimate ended; holding the current encoder bitrate");
361		*rate = None;
362		return;
363	};
364
365	let Some(bitrate) = control.update(estimate, Instant::now()) else {
366		return;
367	};
368
369	match encoder.set_bitrate(bitrate).await {
370		Ok(()) => tracing::debug!(bitrate, estimate, "adjusted encoder bitrate"),
371		// The encoder can't retune, so keep encoding at the rate it opened with
372		// and stop asking. Dropping the source also stops the estimate arm, which
373		// would otherwise wake this loop for nothing on every change.
374		Err(Error::BitrateUnsupported(name)) => {
375			tracing::warn!(encoder = name, "encoder cannot follow the bandwidth estimate");
376			*rate = None;
377		}
378		// A transient failure: keep the policy running so the next change retries.
379		// The policy already moved its target, so a persistent failure just means
380		// the encoder trails it; that's better than giving up on the first blip.
381		Err(err) => tracing::warn!(error = %err, bitrate, "failed to adjust encoder bitrate"),
382	}
383}
384
385/// A dropped or closed track is the normal end of a publish; any other cause is
386/// a real abort (e.g. a transport reset) worth surfacing rather than treating as
387/// a clean exit.
388#[cfg(feature = "capture")]
389fn log_track_ended(err: moq_net::Error) {
390	if matches!(err, moq_net::Error::Dropped | moq_net::Error::Closed) {
391		tracing::debug!("video track no longer announced; stopping capture");
392	} else {
393		tracing::warn!(error = %err, "video track aborted; stopping capture");
394	}
395}
396
397/// Async capture/encode loop. Opens the camera while at least one viewer is
398/// watching and releases it when the last one leaves.
399///
400/// Cancel safety: every wait here is a real `.await` (a frame read, a demand
401/// transition, or an encode), so dropping this future (e.g. on Ctrl+C) drops
402/// `camera` and `encoder`, which release the device (LED off) and join the
403/// encode thread. Both the capture and encode threads sit idle between frames,
404/// so their joins return promptly unless the underlying device or encoder is
405/// itself wedged.
406#[cfg(feature = "capture")]
407async fn capture_loop<E: CatalogExt>(
408	producer: &mut Producer<E>,
409	demand: &moq_net::track::Demand,
410	capture: &capture::Config,
411	encode: &Options,
412	clock: &moq_mux::Clock,
413) -> Result<(), Error> {
414	loop {
415		// Idle until a viewer subscribes; the track ending is a clean exit. The
416		// catalog rendition was published when the track was created, so a
417		// subscriber can get here without a frame ever having been encoded.
418		if let Err(err) = demand.used().await {
419			log_track_ended(err);
420			return Ok(());
421		}
422
423		// Open the camera and an encoder sized to its negotiated mode.
424		let mut camera = capture::open(capture).await?;
425		// Prefer an explicit --fps, otherwise the camera's reported rate, falling
426		// back only if the backend doesn't expose one.
427		let framerate = capture
428			.framerate
429			.or_else(|| camera.framerate())
430			.unwrap_or(DEFAULT_FRAMERATE);
431		let mut encoder_config = encoder::Config::new(camera.width(), camera.height(), framerate);
432		encoder_config.bitrate = encode.bitrate;
433		encoder_config.codec = encode.codec;
434		encoder_config.kind = encode.kind.clone();
435		encoder_config.color = camera.color();
436		// Off macOS this opens the encoder on a dedicated thread; see `sink`.
437		let mut encoder = Sink::open(&encoder_config).await?;
438		// Force an IDR on the first frame of each (re)open so a viewer subscribing
439		// after an idle gap can start decoding immediately.
440		let mut force_keyframe = true;
441		tracing::info!(encoder = encoder.name(), device = camera.device(), "capturing");
442
443		// Rate control is per encoder: this one opened at the configured bitrate,
444		// so the policy's ceiling is that rate and the target starts there. A
445		// reopened camera starts optimistic again rather than inheriting the
446		// backed-off rate from whatever the link was doing last time.
447		let mut rate = encode
448			.bandwidth
449			.clone()
450			.map(|bandwidth| (bandwidth, Control::new(Policy::new(encoder_config.resolved_bitrate()))));
451
452		loop {
453			// Race the next frame against the last viewer leaving so we release the
454			// camera promptly when demand drops. `biased` checks demand first so an
455			// unwatched track stops before reading another frame.
456			let frame = tokio::select! {
457				biased;
458				res = demand.unused() => {
459					if let Err(err) = res {
460						log_track_ended(err);
461						return Ok(());
462					}
463					break; // no viewers: release the camera, then wait for one
464				}
465				// Retune between frames rather than mid-encode, and only when
466				// the policy says the target actually moved.
467				estimate = next_estimate(&mut rate) => {
468					apply_estimate(&mut encoder, &mut rate, estimate).await;
469					continue;
470				}
471				frame = camera.read() => frame,
472			};
473
474			let Some(surface) = frame else { break }; // device stopped producing frames
475
476			// Stamp at capture, so a backend that buffers still publishes each
477			// access unit at the time the picture was grabbed.
478			let frame = Frame::new(surface, Timestamp::from_micros(clock.micros())?);
479			if force_keyframe {
480				encoder.keyframe();
481				force_keyframe = false;
482			}
483			producer.publish(&encoder.encode(frame).await?)?;
484		}
485
486		// Drop the camera (LED off) and encoder before waiting for the next viewer.
487		drop(camera);
488		tracing::info!("no viewers: released camera");
489	}
490}
491
492#[cfg(test)]
493mod tests {
494	use moq_mux::catalog::Stream as _;
495
496	use super::*;
497	use crate::encode::{Config, Encoder};
498
499	/// Encode a handful of synthetic frames for `codec` and publish them through a real
500	/// [`Producer`], returning the catalog rendition's track name and config.
501	///
502	/// Asserts the property the whole design rests on: the rendition published before anything is
503	/// encoded is the one the first keyframe resolves. A guessed codec string would be corrected
504	/// here; a probed one is confirmed, so the catalog is written once.
505	///
506	/// `kind` is explicit so the test picks a deterministic encoder rather than `Auto`, which on
507	/// Linux CI would try the NVENC backend and panic in cudarc on a GPU-less runner.
508	async fn roundtrip_rendition(codec: Codec, kind: encoder::Kind) -> (String, hang::catalog::VideoConfig) {
509		let mut broadcast = moq_net::broadcast::Info::new().produce();
510		let catalog = moq_mux::catalog::Producer::new(&mut broadcast).unwrap();
511
512		let mut config = Config::new(320, 240, 30);
513		config.codec = codec;
514		config.kind = kind;
515
516		let mut producer = Producer::new(broadcast, catalog.clone(), config.probe().await.unwrap()).unwrap();
517		let advertised = rendition(&catalog).expect("the rendition publishes before any frame").1;
518
519		let mut encoder = Encoder::new(&config).unwrap();
520		assert_eq!(encoder.codec(), codec);
521
522		let rgba = vec![0x80u8; 320 * 240 * 4];
523		for i in 0..10u64 {
524			let surface = crate::Surface::rgba(&rgba, crate::Size::new(320, 240)).unwrap();
525			let frame = Frame::new(surface, Timestamp::from_micros(i * 33_333).unwrap());
526			producer.publish(&encoder.encode(&frame).unwrap()).unwrap();
527		}
528		producer.publish(&encoder.finish().unwrap()).unwrap();
529
530		let (name, resolved) = rendition(&catalog).expect("the importer should have registered a video rendition");
531		// Jitter aside, which is measured from the frames rather than declared by either.
532		let (mut before, mut after) = (advertised, resolved.clone());
533		before.jitter = None;
534		after.jitter = None;
535		assert_eq!(
536			before, after,
537			"the first keyframe should confirm the advertised rendition, not correct it"
538		);
539		(name, resolved)
540	}
541
542	/// The catalog's single video rendition, if it has one yet.
543	fn rendition(catalog: &moq_mux::catalog::Producer) -> Option<(String, hang::catalog::VideoConfig)> {
544		let snapshot = catalog.snapshot();
545		let (name, config) = snapshot.video.renditions.iter().next()?;
546		Some((name.clone(), config.clone()))
547	}
548
549	/// Regression: the rendition has to reach the wire before anything is encoded.
550	///
551	/// A catalog reservation is held until the rendition resolves, and an unresolved one withholds
552	/// the whole catalog from the broadcast. An encoder that runs only while watched then closes a
553	/// cycle: the catalog waits on a keyframe, the keyframe waits on a subscriber, and the
554	/// subscriber waits on the catalog. Nothing errors on either side; the publisher simply serves
555	/// nothing, forever.
556	#[tokio::test]
557	async fn the_rendition_reaches_the_wire_before_the_first_frame() {
558		let mut broadcast = moq_net::broadcast::Info::new().produce();
559		let consumer = broadcast.consume();
560		let catalog = moq_mux::catalog::Producer::new(&mut broadcast).unwrap();
561
562		let mut config = Config::new(1920, 1080, 30);
563		config.bitrate = Some(6_000_000);
564		// Software (openh264) so the test is deterministic and never touches a hardware backend.
565		config.kind = encoder::Kind::Software;
566		let _producer = Producer::new(broadcast, catalog, config.probe().await.unwrap()).unwrap();
567
568		// Published, not merely staged: this reads the catalog track a subscriber would.
569		let mut stream = moq_mux::catalog::Consumer::<()>::new(&consumer, moq_mux::catalog::CatalogFormat::Hang)
570			.await
571			.unwrap();
572		let snapshot = stream.next().await.unwrap().expect("a catalog before any frame");
573
574		let (name, rendition) = snapshot
575			.video
576			.renditions
577			.iter()
578			.next()
579			.expect("the track must be discoverable before it has encoded anything");
580		assert!(name.ends_with(".avc3"));
581
582		// Read out of the encoder rather than guessed: the avc3 shape (parameter sets in band) and
583		// the geometry it was opened at, which is what its first keyframe will carry.
584		let hang::catalog::VideoCodec::H264(h264) = &rendition.codec else {
585			panic!("expected H.264, got {}", rendition.codec)
586		};
587		assert!(h264.inline, "an avc3 track carries its parameter sets in band");
588		assert_eq!(rendition.coded_width, Some(1920));
589		assert_eq!(rendition.coded_height, Some(1080));
590		// Neither is in the bitstream, so both come from the config that was probed.
591		assert_eq!(rendition.framerate, Some(30.0));
592		assert_eq!(rendition.bitrate, Some(6_000_000));
593	}
594
595	#[tokio::test]
596	async fn h264_roundtrip_publishes_avc3() {
597		// Software (openh264) so the test is deterministic and never touches a
598		// hardware backend.
599		let (name, config) = roundtrip_rendition(Codec::H264, encoder::Kind::Software).await;
600		assert!(name.ends_with(".avc3"));
601		assert_eq!(config.coded_width, Some(320));
602		assert_eq!(config.coded_height, Some(240));
603	}
604
605	/// H.265 has no software encoder, so this only runs where a hardware one
606	/// exists (VideoToolbox on macOS, the only hardware backend on this target).
607	#[cfg(target_os = "macos")]
608	#[tokio::test]
609	async fn h265_roundtrip_publishes_hev1() {
610		let (name, config) = roundtrip_rendition(Codec::H265, encoder::Kind::Hardware).await;
611		assert!(name.ends_with(".hev1"));
612		assert_eq!(config.coded_width, Some(320));
613		assert_eq!(config.coded_height, Some(240));
614	}
615}