Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions quest/m2/outcome-enums/ordered-gaps.md

This file was deleted.

9 changes: 3 additions & 6 deletions quest/m2/unused-api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
`track::Subscriber::next_in_range`, `is_skipped`, and `poll_start` are
crate-private, and so is `Subscriber::with_range` if its last production
caller can leave. Their one consumer is moq-mux's container reader, which
orders groups itself; `track::Ordered` reports a `Gap`, so the reader can
orders groups itself; `track::Ordered::next_item` reports a `Gap`, so the reader can
move onto it.

## Plan
Expand Down Expand Up @@ -71,15 +71,12 @@ Steps:
- `origin::Consumer::covering` stays `pub`: moq.pro and moq-net's own
`benches/origin.rs` call it.

The reader reads gaps through `Ordered::next_item` once
[ordered-gaps](/quest/m2/outcome-enums/ordered-gaps.md) lands, since
`next_group` then yields groups alone (decided 2026-11-18, maintainer,
/quest-plan); whichever lands second makes the switch.
The reader reads gaps through `Ordered::next_item`, since `next_group`
yields groups alone (decided 2026-11-18, maintainer, /quest-plan).

Public API: breaking, removals only unless step 1 adds `Ordered` inputs.
Wire: none.

## Related

- [Ordered gaps](/quest/m2/outcome-enums/ordered-gaps.md) - splits `Ordered` into `next_group` and the `next_item` this reader uses
- [Browser audio holes](/quest/m2/audio-playout/browser-audio-hole-skip.md) - grading the browser counterpart, which already reads `Gap`s
13 changes: 5 additions & 8 deletions rs/libmoq/src/consume.rs
Original file line number Diff line number Diff line change
Expand Up @@ -899,14 +899,11 @@ impl Consume {
if Pin::new(&mut close).poll(&mut waiter.context()).is_ready() {
return Poll::Ready(Ok(RawStep::Stop));
}
loop {
match ready!(track.poll_next_group(waiter))? {
Some(moq_net::track::Item::Group(group)) => return Poll::Ready(Ok(RawStep::Item(group))),
// The C API reports no gaps.
Some(moq_net::track::Item::Gap { .. }) => continue,
None => return Poll::Ready(Ok(RawStep::End)),
}
}
// The C API reports no gaps.
Poll::Ready(Ok(match ready!(track.poll_next_group(waiter))? {
Some(group) => RawStep::Item(group),
None => RawStep::End,
}))
})
.await?
{
Expand Down
29 changes: 11 additions & 18 deletions rs/moq-archive/src/consumer/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,10 @@ fn from(start: u64) -> track::Range {

/// The next group, past the gaps the read reports for what the archive never held.
async fn group(reader: &mut track::Ordered) -> Option<moq_net::group::Consumer> {
loop {
let item = timeout(Duration::from_secs(10), reader.next_group())
.await
.expect("a group arrives")
.unwrap()?;
if let track::Item::Group(group) = item {
return Some(group);
}
}
timeout(Duration::from_secs(10), reader.next_group())
.await
.expect("a group arrives")
.unwrap()
}

/// The next group's start, without waiting for it to end.
Expand Down Expand Up @@ -244,7 +239,7 @@ async fn a_recording_round_trips() {

let mut reader = subscribe(&broadcast, "video").await;
for sequence in 0..6 {
let mut group = reader.next_group().await.unwrap().unwrap().group().unwrap();
let mut group = reader.next_group().await.unwrap().unwrap();
assert_eq!(group.start, sequence);
for index in 0..3 {
let frame = group.read_frame().await.unwrap().unwrap();
Expand Down Expand Up @@ -468,7 +463,7 @@ async fn an_archive_without_markers_stays_open() {
let (broadcast, _run) = serve(&archive.store).await;
let mut reader = subscribe(&broadcast, "video").await;
assert_eq!(next(&mut reader).await.unwrap(), (0, expected(true, 0, 0..1)));
let mut group = reader.next_group().await.unwrap().unwrap().group().unwrap();
let mut group = reader.next_group().await.unwrap().unwrap();
assert!(group.read_frame().await.unwrap().is_some());
let pending = timeout(30 * REFRESH, group.read_frame()).await;
assert!(pending.is_err(), "the newest group stays open");
Expand All @@ -484,7 +479,7 @@ async fn closing_the_broadcast_cancels_the_live_tracks() {

let (broadcast, run) = serve(&archive.store).await;
let mut reader = subscribe(&broadcast, "video").await;
let mut group = reader.next_group().await.unwrap().unwrap().group().unwrap();
let mut group = reader.next_group().await.unwrap().unwrap();
assert!(group.read_frame().await.unwrap().is_some());

broadcast.close();
Expand All @@ -503,7 +498,7 @@ async fn a_gapped_continuation_aborts_the_open_group() {

let (broadcast, run) = serve(&archive.store).await;
let mut reader = subscribe(&broadcast, "video").await;
let mut group = reader.next_group().await.unwrap().unwrap().group().unwrap();
let mut group = reader.next_group().await.unwrap().unwrap();
assert!(group.read_frame().await.unwrap().is_some());

// Frame 1 of group 0 is missing.
Expand All @@ -526,7 +521,7 @@ async fn a_store_failure_aborts_the_served_tracks() {

let (broadcast, run) = serve(&archive.store).await;
let mut reader = subscribe(&broadcast, "video").await;
let mut group = reader.next_group().await.unwrap().unwrap().group().unwrap();
let mut group = reader.next_group().await.unwrap().unwrap();
assert!(group.read_frame().await.unwrap().is_some());

archive.store.inner().fail_lists();
Expand Down Expand Up @@ -582,7 +577,7 @@ async fn a_completed_archive_ends_as_recorded() {
let end = timeout(Duration::from_secs(10), reader.next_group())
.await
.expect("the track ends");
let end = end.map(|item| item.map(|item| item.group().expect("a group").start));
let end = end.map(|group| group.map(|group| group.start));
assert!(
matches!(end, Err(moq_net::Error::Stream(moq_net::StreamError::App(7)))),
"{end:?}"
Expand Down Expand Up @@ -735,9 +730,7 @@ async fn read_range(broadcast: &broadcast::Producer, track: &str, range: track::
let mut read = Vec::new();
while let Ok(group) = timeout(5 * REFRESH, reader.next_group()).await {
match group.unwrap() {
Some(track::Item::Group(group)) => read.push(group.start),
// Nothing is stored below the first group, which the read reports as a gap.
Some(track::Item::Gap { .. }) => {}
Some(group) => read.push(group.start),
None => break,
}
}
Expand Down
9 changes: 3 additions & 6 deletions rs/moq-archive/src/producer/track.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use std::time::Duration;

use bytes::Bytes;
use kio::clock::Instant;
use moq_net::track::{Anchor, Delay, Item, Order, Position, Range, Subscription};
use moq_net::track::{Anchor, Delay, Order, Position, Range, Subscription};
use moq_net::{StreamError, Timescale, group};
use object_store::path::Path;
use object_store::{ObjectStore, ObjectStoreExt, PutMode, PutPayload};
Expand Down Expand Up @@ -219,11 +219,8 @@ impl<S: ObjectStore> Track<S> {
}
None => {
// A group the track gave up on is stored as the hole it leaves.
while let Poll::Ready(next) = ordered.poll_next_group(waiter) {
match next {
Ok(Some(Item::Gap { .. })) => continue,
next => return Poll::Ready(Event::Next(next.map(|item| item.and_then(Item::group)))),
}
if let Poll::Ready(next) = ordered.poll_next_group(waiter) {
return Poll::Ready(Event::Next(next));
}
}
}
Expand Down
28 changes: 4 additions & 24 deletions rs/moq-bench/src/connection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -894,12 +894,7 @@ mod tests {
.await
.unwrap()
.ordered();
let mut group = sub
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a group");
let mut group = sub.next_group().await.unwrap().expect("a group");

let keyframe = group.read_frame().await.unwrap().expect("keyframe");
let header: serde_json::Value = serde_json::from_slice(&keyframe.payload).unwrap();
Expand Down Expand Up @@ -946,12 +941,7 @@ mod tests {
.await
.unwrap()
.ordered();
let mut group = sub
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a group");
let mut group = sub.next_group().await.unwrap().expect("a group");

// Just the keyframe, then the group ends.
assert!(group.read_frame().await.unwrap().is_some(), "keyframe");
Expand Down Expand Up @@ -983,12 +973,7 @@ mod tests {
tokio::time::advance(Duration::from_millis(250)).await;

let mut sub = consumer.track(TRACK).unwrap().subscribe(None).await.unwrap().ordered();
let mut group = sub
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a group");
let mut group = sub.next_group().await.unwrap().expect("a group");
let keyframe = group.read_frame().await.unwrap().expect("keyframe").payload;

assert_eq!(keyframe.len(), 300, "keyframe padded to the rolled frame size");
Expand Down Expand Up @@ -1021,12 +1006,7 @@ mod tests {
tokio::time::advance(Duration::from_millis(250)).await;

let mut sub = consumer.track(TRACK).unwrap().subscribe(None).await.unwrap().ordered();
let mut group = sub
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a group");
let mut group = sub.next_group().await.unwrap().expect("a group");
let keyframe = group.read_frame().await.unwrap().expect("keyframe").payload;

assert!(keyframe.len() > 50, "header is the floor; no truncation to fit");
Expand Down
2 changes: 1 addition & 1 deletion rs/moq-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1421,7 +1421,7 @@ mod tests {
.await
.unwrap()
.ordered();
let mut group = track.next_group().await.unwrap().unwrap().group().unwrap();
let mut group = track.next_group().await.unwrap().unwrap();
group.read_frame().await.unwrap().unwrap().payload
})
.await
Expand Down
20 changes: 3 additions & 17 deletions rs/moq-ffi/src/consumer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,8 @@ impl TrackInner {
waiter.waker().wake_by_ref();
return Poll::Ready(Ok(Some(group)));
}
poll_group(&mut ordered.track, waiter).map(|r| r.map_err(Into::into))
// The bindings report no gaps, so a group the track gave up on is passed over.
ordered.track.poll_next_group(waiter).map_err(Into::into)
}
Err(e) => Poll::Ready(Err(e)),
}
Expand All @@ -515,7 +516,7 @@ impl TrackInner {
loop {
let group = match &mut ordered.pending {
Some(group) => group,
None => match ready!(poll_group(&mut ordered.track, waiter)) {
None => match ready!(ordered.track.poll_next_group(waiter)) {
Ok(Some(group)) => ordered.pending.insert(group),
Ok(None) => return Poll::Ready(Ok(None)),
Err(err) => return Poll::Ready(Err(err.into())),
Expand Down Expand Up @@ -732,18 +733,3 @@ impl MoqGroupConsumer {
self.reads.cancel();
}
}

/// The next group of an ordered read. The bindings report no gaps, so a group the track
/// gave up on is passed over.
fn poll_group(
track: &mut moq_net::track::Ordered,
waiter: &kio::Waiter,
) -> Poll<Result<Option<moq_net::group::Consumer>, moq_net::Error>> {
loop {
match ready!(track.poll_next_group(waiter))? {
Some(moq_net::track::Item::Group(group)) => return Poll::Ready(Ok(Some(group))),
Some(moq_net::track::Item::Gap { .. }) => continue,
None => return Poll::Ready(Ok(None)),
}
}
}
6 changes: 1 addition & 5 deletions rs/moq-ffi/src/media.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2231,11 +2231,7 @@ mod timebase_tests {
.await
.unwrap()
.ordered();
let mut group = loop {
if let Some(group) = catalogs.next_group().await.unwrap().unwrap().group() {
break group;
}
};
let mut group = catalogs.next_group().await.unwrap().unwrap();
let stamp = group.read_frame().await.unwrap().unwrap().timestamp;
// Catalogs published in the same millisecond, such as a rendition and its first estimate,
// start a unit apart, since each starts its own group.
Expand Down
1 change: 0 additions & 1 deletion rs/moq-gst/src/sink/imp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2076,7 +2076,6 @@ mod tests {
.now_or_never()
.expect("a group is ready")
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("the resumed keyframe opens a group");
let frame = group
.read_frame()
Expand Down
21 changes: 3 additions & 18 deletions rs/moq-gst/src/sink/pad.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2074,12 +2074,7 @@ mod tests {
.expect("subscribe to the opaque track")
.ordered();

let mut group = subscriber
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a first group");
let mut group = subscriber.next_group().await.unwrap().expect("a first group");
let frame = group.read_frame().await.unwrap().expect("a frame in the first group");
assert_eq!(
frame.payload.as_ref(),
Expand All @@ -2096,12 +2091,7 @@ mod tests {
"one buffer produces one group with one frame"
);

let mut group = subscriber
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a second group");
let mut group = subscriber.next_group().await.unwrap().expect("a second group");
let frame = group.read_frame().await.unwrap().expect("a frame in the second group");
assert_eq!(frame.payload.as_ref(), b"second");
assert_eq!(
Expand Down Expand Up @@ -2207,12 +2197,7 @@ mod tests {
.await
.expect("subscribe to the opaque track")
.ordered();
let mut group = subscriber
.next_group()
.await
.unwrap()
.and_then(moq_net::track::Item::group)
.expect("a group");
let mut group = subscriber.next_group().await.unwrap().expect("a group");
let frame = group.read_frame().await.unwrap().expect("a frame");
assert_eq!(frame.payload.as_ref(), b"no pts", "the unstamped buffer was published");
assert_eq!(
Expand Down
5 changes: 2 additions & 3 deletions rs/moq-hls/src/export/rendition.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2415,10 +2415,9 @@ impl WatchMedia {
}
}
let groups = self.groups.as_mut().expect("subscribed above");
// A segment is listed from the groups that arrive, so one given up on is read past.
match ready!(groups.poll_next_group(waiter))? {
Some(moq_net::track::Item::Group(group)) => self.step = Step::First(group),
// A segment is listed from the groups that arrive, so one given up on is read past.
Some(moq_net::track::Item::Gap { .. }) => {}
Some(group) => self.step = Step::First(group),
None => match follow.latest.take() {
Some((group, _, reach)) => self.step = Step::End(group, Some(reach)),
None => {
Expand Down
3 changes: 1 addition & 2 deletions rs/moq-hls/src/import.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2420,8 +2420,7 @@ mod tests {
let mut out = Vec::new();
loop {
let mut group = match subscriber.poll_next_group(&kio::Waiter::noop()) {
Poll::Ready(Ok(Some(moq_net::track::Item::Group(group)))) => group,
Poll::Ready(Ok(Some(moq_net::track::Item::Gap { .. }))) => continue,
Poll::Ready(Ok(Some(group))) => group,
Poll::Pending | Poll::Ready(Ok(None)) => break,
Poll::Ready(Err(error)) => return (out, Some(error)),
};
Expand Down
3 changes: 1 addition & 2 deletions rs/moq-hls/tests/integration/import.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ fn groups(track: &mut moq_net::track::Ordered) -> Vec<u64> {
let mut out = Vec::new();
loop {
let mut group = match track.poll_next_group(&kio::Waiter::noop()) {
Poll::Ready(Ok(Some(moq_net::track::Item::Group(group)))) => group,
Poll::Ready(Ok(Some(moq_net::track::Item::Gap { .. }))) => continue,
Poll::Ready(Ok(Some(group))) => group,
Poll::Pending | Poll::Ready(Ok(None)) => return out,
Poll::Ready(Err(err)) => panic!("the imported track failed: {err}"),
};
Expand Down
Loading