Skip to content

Commit 7ca3bac

Browse files
committed
fix(rtc): synchronize audio source queue metrics with thread lock on clear
1 parent ecd4205 commit 7ca3bac

2 files changed

Lines changed: 67 additions & 30 deletions

File tree

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

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@
1414

1515
from __future__ import annotations
1616

17-
import time
1817
import asyncio
18+
import threading
19+
import time
1920

2021
from ._ffi_client import FfiHandle, FfiClient
2122
from ._proto import audio_frame_pb2 as proto_audio_frame
@@ -73,6 +74,7 @@ def __init__(
7374
self._last_capture = 0.0
7475
self._q_size = 0.0
7576
self._capture_gen = 0
77+
self._lock = threading.Lock()
7678
self._join_handle: asyncio.TimerHandle | None = None
7779
self._join_fut: asyncio.Future[None] | None = None
7880

@@ -89,7 +91,8 @@ def num_channels(self) -> int:
8991
@property
9092
def queued_duration(self) -> float:
9193
"""The current duration (in seconds) of audio data queued for playback."""
92-
return max(self._q_size - time.monotonic() + self._last_capture, 0.0)
94+
with self._lock:
95+
return max(self._q_size - time.monotonic() + self._last_capture, 0.0)
9396

9497
def clear_queue(self) -> None:
9598
"""
@@ -103,7 +106,11 @@ def clear_queue(self) -> None:
103106
req = proto_ffi.FfiRequest()
104107
req.clear_audio_buffer.source_handle = self._ffi_handle.handle
105108
_ = FfiClient.instance.request(req)
106-
self._release_waiter_threadsafe(gen=self._capture_gen)
109+
with self._lock:
110+
self._last_capture = 0.0
111+
self._q_size = 0.0
112+
target_gen = self._capture_gen
113+
self._release_waiter_threadsafe(gen=target_gen)
107114

108115
def _get_loop(self) -> asyncio.AbstractEventLoop:
109116
if self._loop is None or self._loop.is_closed():
@@ -132,25 +139,27 @@ async def capture_frame(self, frame: AudioFrame) -> None:
132139

133140
loop = self._get_loop()
134141

135-
self._capture_gen += 1
136-
current_gen = self._capture_gen
142+
with self._lock:
143+
self._capture_gen += 1
144+
current_gen = self._capture_gen
137145

138-
now = time.monotonic()
139-
elapsed = 0.0 if self._last_capture == 0.0 else now - self._last_capture
140-
self._q_size += frame.samples_per_channel / self.sample_rate - elapsed
141-
self._last_capture = now
146+
now = time.monotonic()
147+
elapsed = 0.0 if self._last_capture == 0.0 else now - self._last_capture
148+
self._q_size += frame.samples_per_channel / self.sample_rate - elapsed
149+
self._last_capture = now
150+
q_size = self._q_size
142151

143-
if self._join_handle:
144-
self._join_handle.cancel()
152+
if self._join_handle:
153+
self._join_handle.cancel()
145154

146-
if (
147-
self._join_fut is None
148-
or self._join_fut.get_loop() is not loop
149-
or self._join_fut.get_loop().is_closed()
150-
):
151-
self._join_fut = loop.create_future()
155+
if (
156+
self._join_fut is None
157+
or self._join_fut.get_loop() is not loop
158+
or self._join_fut.get_loop().is_closed()
159+
):
160+
self._join_fut = loop.create_future()
152161

153-
self._join_handle = loop.call_later(self._q_size, self._release_waiter, current_gen)
162+
self._join_handle = loop.call_later(q_size, self._release_waiter, current_gen)
154163

155164
req = proto_ffi.FfiRequest()
156165
req.capture_audio_frame.source_handle = self._ffi_handle.handle
@@ -183,22 +192,23 @@ async def wait_for_playout(self) -> None:
183192
await asyncio.shield(self._join_fut)
184193

185194
def _release_waiter(self, gen: int | None = None) -> None:
186-
if gen is not None and gen != self._capture_gen:
187-
return
195+
with self._lock:
196+
if gen is not None and gen != self._capture_gen:
197+
return
188198

189-
if self._join_handle is not None:
190-
self._join_handle.cancel()
191-
self._join_handle = None
199+
if self._join_handle is not None:
200+
self._join_handle.cancel()
201+
self._join_handle = None
192202

193-
if self._join_fut is None:
194-
return # could be None when clear_queue is called
203+
if self._join_fut is None:
204+
return # could be None when clear_queue is called
195205

196-
if not self._join_fut.done():
197-
self._join_fut.set_result(None)
206+
if not self._join_fut.done():
207+
self._join_fut.set_result(None)
198208

199-
self._last_capture = 0.0
200-
self._q_size = 0.0
201-
self._join_fut = None
209+
self._last_capture = 0.0
210+
self._q_size = 0.0
211+
self._join_fut = None
202212

203213
def _release_waiter_threadsafe(self, gen: int | None = None) -> None:
204214
try:

‎livekit-rtc/tests/test_source_stream_close.py‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,30 @@ async def _run() -> None:
169169
await source.aclose()
170170

171171
asyncio.run(_run())
172+
173+
174+
def test_audio_source_cross_thread_clear_queue_resets_queued_duration() -> None:
175+
source = rtc.AudioSource(48000, 1, queue_size_ms=10000)
176+
frame1 = rtc.AudioFrame.create(48000, 1, 48000)
177+
frame2 = rtc.AudioFrame.create(48000, 1, 48000)
178+
179+
async def _run() -> None:
180+
await source.capture_frame(frame1)
181+
assert source.queued_duration > 0.8
182+
183+
t = threading.Thread(target=source.clear_queue)
184+
t.start()
185+
t.join()
186+
187+
# Queued duration should be reset immediately
188+
assert source.queued_duration == 0.0
189+
190+
# Capture a new frame immediately after cross-thread clear
191+
await source.capture_frame(frame2)
192+
193+
# Queued duration should reflect only the new frame (~1.0s), not ~2.0s
194+
assert 0.8 < source.queued_duration <= 1.05
195+
196+
await source.aclose()
197+
198+
asyncio.run(_run())

0 commit comments

Comments
 (0)