Skip to content

Commit 08e4deb

Browse files
committed
fix(rtc): dynamically bind active event loop in AudioSource to avoid capture hang
# Conflicts: # livekit-rtc/livekit/rtc/audio_source.py
1 parent c97bbf9 commit 08e4deb

2 files changed

Lines changed: 60 additions & 21 deletions

File tree

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

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,12 @@ def __init__(
5353
"""
5454
self._sample_rate = sample_rate
5555
self._num_channels = num_channels
56-
57-
if loop is not None:
58-
self._loop = loop
59-
else:
56+
self._loop: asyncio.AbstractEventLoop | None = loop
57+
if self._loop is None:
6058
try:
6159
self._loop = asyncio.get_running_loop()
6260
except RuntimeError:
63-
try:
64-
self._loop = asyncio.get_event_loop()
65-
except RuntimeError:
66-
self._loop = asyncio.new_event_loop()
61+
self._loop = None
6762

6863
req = proto_ffi.FfiRequest()
6964
req.new_audio_source.type = proto_audio_frame.AudioSourceType.AUDIO_SOURCE_NATIVE
@@ -107,7 +102,12 @@ def clear_queue(self) -> None:
107102
req = proto_ffi.FfiRequest()
108103
req.clear_audio_buffer.source_handle = self._ffi_handle.handle
109104
_ = FfiClient.instance.request(req)
110-
self._release_waiter()
105+
self._release_waiter_threadsafe()
106+
107+
def _get_loop(self) -> asyncio.AbstractEventLoop:
108+
if self._loop is None or self._loop.is_closed():
109+
self._loop = asyncio.get_running_loop()
110+
return self._loop
111111

112112
async def capture_frame(self, frame: AudioFrame) -> None:
113113
"""
@@ -129,6 +129,8 @@ async def capture_frame(self, frame: AudioFrame) -> None:
129129
if frame.samples_per_channel == 0 or getattr(self._ffi_handle, "disposed", False):
130130
return
131131

132+
loop = self._get_loop()
133+
132134
now = time.monotonic()
133135
elapsed = 0.0 if self._last_capture == 0.0 else now - self._last_capture
134136
self._q_size += frame.samples_per_channel / self.sample_rate - elapsed
@@ -137,10 +139,14 @@ async def capture_frame(self, frame: AudioFrame) -> None:
137139
if self._join_handle:
138140
self._join_handle.cancel()
139141

140-
if self._join_fut is None:
141-
self._join_fut = self._loop.create_future()
142+
if (
143+
self._join_fut is None
144+
or self._join_fut.get_loop() is not loop
145+
or self._join_fut.get_loop().is_closed()
146+
):
147+
self._join_fut = loop.create_future()
142148

143-
self._join_handle = self._loop.call_later(self._q_size, self._release_waiter)
149+
self._join_handle = loop.call_later(self._q_size, self._release_waiter)
144150

145151
req = proto_ffi.FfiRequest()
146152
req.capture_audio_frame.source_handle = self._ffi_handle.handle
@@ -150,7 +156,7 @@ async def capture_frame(self, frame: AudioFrame) -> None:
150156
# callback is let through, and wait_for drops the ones of other captures.
151157
async_id: int | None = None
152158
queue = FfiClient.instance.queue.subscribe(
153-
loop=self._loop,
159+
loop=loop,
154160
filter_fn=lambda e: (
155161
e.WhichOneof("message") == "capture_audio_frame"
156162
and (async_id is None or e.capture_audio_frame.async_id == async_id)
@@ -197,23 +203,23 @@ def _release_waiter(self) -> None:
197203
self._q_size = 0.0
198204
self._join_fut = None
199205

200-
def close(self) -> None:
201-
"""Close the audio source.
202-
203-
This method cleans up resources associated with the audio source.
204-
"""
206+
def _release_waiter_threadsafe(self) -> None:
205207
try:
206208
running_loop = asyncio.get_running_loop()
207209
except RuntimeError:
208210
running_loop = None
209211

210-
if running_loop is self._loop:
211-
self._release_waiter()
212-
elif self._loop.is_running():
212+
if self._loop is not None and self._loop.is_running() and running_loop is not self._loop:
213213
self._loop.call_soon_threadsafe(self._release_waiter)
214214
else:
215215
self._release_waiter()
216216

217+
def close(self) -> None:
218+
"""Close the audio source.
219+
220+
This method cleans up resources associated with the audio source.
221+
"""
222+
self._release_waiter_threadsafe()
217223
self._ffi_handle.dispose()
218224

219225
async def aclose(self) -> None:

‎livekit-rtc/tests/test_source_stream_close.py‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,36 @@ async def test_video_source_aclose_and_capture_after_close() -> None:
106106

107107
# Repeated aclose is idempotent
108108
await asyncio.wait_for(source.aclose(), timeout=2.0)
109+
110+
111+
def test_audio_source_init_outside_loop_and_capture_in_asyncio_run() -> None:
112+
source = rtc.AudioSource(48000, 1)
113+
assert source._loop is None
114+
frame = rtc.AudioFrame.create(48000, 1, 480)
115+
116+
async def _capture() -> None:
117+
await asyncio.wait_for(source.capture_frame(frame), timeout=5.0)
118+
assert source._loop is not None
119+
assert source._loop.is_running()
120+
await asyncio.wait_for(source.aclose(), timeout=5.0)
121+
122+
asyncio.run(_capture())
123+
124+
125+
def test_audio_source_cross_thread_clear_queue() -> None:
126+
source = rtc.AudioSource(48000, 1)
127+
frame = rtc.AudioFrame.create(48000, 1, 48000)
128+
129+
async def _run() -> None:
130+
await source.capture_frame(frame)
131+
assert source._join_fut is not None
132+
133+
t = threading.Thread(target=source.clear_queue)
134+
t.start()
135+
t.join()
136+
137+
# Playout waiter should be released by cross-thread clear_queue
138+
await asyncio.wait_for(source.wait_for_playout(), timeout=2.0)
139+
await source.aclose()
140+
141+
asyncio.run(_run())

0 commit comments

Comments
 (0)