Skip to content

Commit cfc66b0

Browse files
committed
fix(rtc): do not evict buffered frames when enqueuing terminal sentinel in RingQueue
When an EOS sentinel (None) is enqueued to RingQueue, do not evict the oldest buffered frame when at capacity. This ensures that the final frame received before EOS is preserved and consumed by the awaiting iterator rather than discarded.
1 parent 2ceac5a commit cfc66b0

2 files changed

Lines changed: 42 additions & 2 deletions

File tree

‎livekit-rtc/livekit/rtc/_utils.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,9 @@ def __init__(self, capacity: int = 0) -> None:
8282
self._event = asyncio.Event()
8383

8484
def put(self, item: T) -> None:
85-
if self._capacity > 0 and len(self._queue) == self._capacity:
86-
self._queue.popleft()
85+
if item is not None and self._capacity > 0:
86+
while len(self._queue) >= self._capacity:
87+
self._queue.popleft()
8788
self._queue.append(item)
8889
self._event.set()
8990

‎livekit-rtc/tests/test_video_stream.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,42 @@ async def consume() -> list[rtc.VideoFrameEvent]:
6060
assert frames == []
6161

6262
await video_stream.aclose()
63+
64+
65+
async def test_video_stream_eos_does_not_evict_last_frame_at_capacity_one() -> None:
66+
track = MagicMock(spec=rtc.Track)
67+
stream_info = MagicMock()
68+
stream_info.handle.id = 54321
69+
stream_info.info = MagicMock()
70+
71+
with patch.object(rtc.VideoStream, "_create_owned_stream", return_value=stream_info):
72+
video_stream = rtc.VideoStream(track, capacity=1)
73+
video_stream._ffi_handle._disposed = True
74+
75+
mock_frame = MagicMock(spec=rtc.VideoFrame)
76+
with patch.object(rtc.VideoFrame, "_from_owned_info", return_value=mock_frame):
77+
# Enqueue frame and EOS before consumer reads
78+
frame_event = proto_ffi.FfiEvent()
79+
frame_event.video_stream_event.stream_handle = 54321
80+
frame_event.video_stream_event.frame_received.timestamp_us = 1000
81+
frame_event.video_stream_event.frame_received.rotation = (
82+
proto_video_frame.VideoRotation.VIDEO_ROTATION_0
83+
)
84+
FfiClient.instance.queue.put(frame_event)
85+
86+
eos_event = proto_ffi.FfiEvent()
87+
eos_event.video_stream_event.stream_handle = 54321
88+
eos_event.video_stream_event.eos.CopyFrom(proto_video_frame.VideoStreamEOS())
89+
FfiClient.instance.queue.put(eos_event)
90+
91+
# Consume stream
92+
frames: list[rtc.VideoFrameEvent] = []
93+
async for frame in video_stream:
94+
frames.append(frame)
95+
96+
# The final frame must not be evicted by EOS sentinel
97+
assert len(frames) == 1
98+
assert frames[0].frame is mock_frame
99+
assert frames[0].timestamp_us == 1000
100+
101+
await video_stream.aclose()

0 commit comments

Comments
 (0)