Skip to content

Commit ecd4205

Browse files
committed
fix(rtc): track capture generation in AudioSource to isolate clear_queue
1 parent a861f73 commit ecd4205

2 files changed

Lines changed: 43 additions & 6 deletions

File tree

‎livekit-rtc/livekit/rtc/audio_source.py‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ def __init__(
7272

7373
self._last_capture = 0.0
7474
self._q_size = 0.0
75+
self._capture_gen = 0
7576
self._join_handle: asyncio.TimerHandle | None = None
7677
self._join_fut: asyncio.Future[None] | None = None
7778

@@ -102,7 +103,7 @@ def clear_queue(self) -> None:
102103
req = proto_ffi.FfiRequest()
103104
req.clear_audio_buffer.source_handle = self._ffi_handle.handle
104105
_ = FfiClient.instance.request(req)
105-
self._release_waiter_threadsafe()
106+
self._release_waiter_threadsafe(gen=self._capture_gen)
106107

107108
def _get_loop(self) -> asyncio.AbstractEventLoop:
108109
if self._loop is None or self._loop.is_closed():
@@ -131,6 +132,9 @@ async def capture_frame(self, frame: AudioFrame) -> None:
131132

132133
loop = self._get_loop()
133134

135+
self._capture_gen += 1
136+
current_gen = self._capture_gen
137+
134138
now = time.monotonic()
135139
elapsed = 0.0 if self._last_capture == 0.0 else now - self._last_capture
136140
self._q_size += frame.samples_per_channel / self.sample_rate - elapsed
@@ -146,7 +150,7 @@ async def capture_frame(self, frame: AudioFrame) -> None:
146150
):
147151
self._join_fut = loop.create_future()
148152

149-
self._join_handle = loop.call_later(self._q_size, self._release_waiter)
153+
self._join_handle = loop.call_later(self._q_size, self._release_waiter, current_gen)
150154

151155
req = proto_ffi.FfiRequest()
152156
req.capture_audio_frame.source_handle = self._ffi_handle.handle
@@ -178,7 +182,10 @@ async def wait_for_playout(self) -> None:
178182

179183
await asyncio.shield(self._join_fut)
180184

181-
def _release_waiter(self) -> None:
185+
def _release_waiter(self, gen: int | None = None) -> None:
186+
if gen is not None and gen != self._capture_gen:
187+
return
188+
182189
if self._join_handle is not None:
183190
self._join_handle.cancel()
184191
self._join_handle = None
@@ -193,16 +200,16 @@ def _release_waiter(self) -> None:
193200
self._q_size = 0.0
194201
self._join_fut = None
195202

196-
def _release_waiter_threadsafe(self) -> None:
203+
def _release_waiter_threadsafe(self, gen: int | None = None) -> None:
197204
try:
198205
running_loop = asyncio.get_running_loop()
199206
except RuntimeError:
200207
running_loop = None
201208

202209
if self._loop is not None and self._loop.is_running() and running_loop is not self._loop:
203-
self._loop.call_soon_threadsafe(self._release_waiter)
210+
self._loop.call_soon_threadsafe(self._release_waiter, gen)
204211
else:
205-
self._release_waiter()
212+
self._release_waiter(gen)
206213

207214
def close(self) -> None:
208215
"""Close the audio source.

‎livekit-rtc/tests/test_source_stream_close.py‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,33 @@ async def _run() -> None:
139139
await source.aclose()
140140

141141
asyncio.run(_run())
142+
143+
144+
def test_audio_source_clear_queue_does_not_cancel_subsequent_capture() -> None:
145+
source = rtc.AudioSource(48000, 1, queue_size_ms=10000)
146+
frame1 = rtc.AudioFrame.create(48000, 1, 48000)
147+
frame2 = rtc.AudioFrame.create(48000, 1, 48000)
148+
149+
async def _run() -> None:
150+
await source.capture_frame(frame1)
151+
gen1 = source._capture_gen
152+
153+
# Simulate clear_queue scheduled from another thread
154+
loop = asyncio.get_running_loop()
155+
loop.call_soon(source._release_waiter, gen1)
156+
157+
# Capture a subsequent frame before yielding
158+
await source.capture_frame(frame2)
159+
assert source._capture_gen > gen1
160+
assert source._join_fut is not None
161+
162+
# Allow queued clear callback to execute
163+
await asyncio.sleep(0.01)
164+
165+
# The subsequent frame's playout future and timer must not be cleared
166+
assert source._join_fut is not None
167+
assert not source._join_fut.done()
168+
169+
await source.aclose()
170+
171+
asyncio.run(_run())

0 commit comments

Comments
 (0)