streamlit-webrtc 0.62.0__py3-none-any.whl → 0.62.2__py3-none-any.whl

streamlit_webrtc/component.py

@@ -95,6 +95,8 @@ class WebRtcStreamerContext(Generic[VideoProcessorT, AudioProcessorT]):
     _component_value_snapshot: Union[ComponentValueSnapshot, None]
     _worker_creation_lock: threading.Lock
     _frontend_rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]]
+    _sdp_answer_json: Optional[str]
+    _is_sdp_answer_sent: bool
 
     def __init__(
         self,
@@ -106,6 +108,8 @@ class WebRtcStreamerContext(Generic[VideoProcessorT, AudioProcessorT]):
         self._component_value_snapshot = None
         self._worker_creation_lock = threading.Lock()
         self._frontend_rtc_configuration = None
+        self._sdp_answer_json = None
+        self._is_sdp_answer_sent = False
 
     def _set_worker(
         self, worker: Optional[WebRtcWorker[VideoProcessorT, AudioProcessorT]]
@@ -481,16 +485,9 @@ def webrtc_streamer(
         )
         context._frontend_rtc_configuration["iceServers"] = get_available_ice_servers()
 
-    webrtc_worker = context._get_worker()
-
-    sdp_answer_json = None
-    if webrtc_worker and webrtc_worker.pc.localDescription:
-        sdp_answer_json = json.dumps(
-            {
-                "sdp": webrtc_worker.pc.localDescription.sdp,
-                "type": webrtc_worker.pc.localDescription.type,
-            }
-        )
+    if context._sdp_answer_json:
+        # Set the flag not to trigger rerun() any more as `context._sdp_answer_json` is already set and will have been sent to the frontend in this run.
+        context._is_sdp_answer_sent = True
 
     frontend_key = generate_frontend_component_key(key)
 
@@ -515,7 +512,7 @@ def webrtc_streamer(
         }
     component_value_raw: Union[Dict, str, None] = _component_func(
         key=frontend_key,
-        sdp_answer_json=sdp_answer_json,
+        sdp_answer_json=context._sdp_answer_json,
         mode=mode.name,
         rtc_configuration=context._frontend_rtc_configuration,
         media_stream_constraints=media_stream_constraints,
@@ -566,6 +563,8 @@ def webrtc_streamer(
         sdp_offer = component_value.get("sdpOffer")
         ice_candidates = component_value.get("iceCandidates")
 
+    webrtc_worker = context._get_worker()
+
     if not context.state.playing and not context.state.signalling:
         LOGGER.debug(
             "Unset the worker and the internal states because the frontend state is "
@@ -578,8 +577,9 @@ def webrtc_streamer(
         if webrtc_worker:
             webrtc_worker.stop()
             context._set_worker(None)
+            context._is_sdp_answer_sent = False
+            context._sdp_answer_json = None
             webrtc_worker = None
-
             # Rerun to unset the SDP answer from the frontend args
             rerun()
 
@@ -597,11 +597,8 @@ def webrtc_streamer(
                 on_ended=on_audio_ended,
             )
 
-    worker_created_in_this_run = None
     with context._worker_creation_lock:  # This point can be reached in parallel so we need to use a lock to make the worker creation process atomic.
-        should_create_worker_in_this_run = not context._get_worker() and sdp_offer
-
-        if should_create_worker_in_this_run:
+        if not context._get_worker() and sdp_offer:
             LOGGER.debug(
                 "No worker exists though the offer SDP is set. "
                 'Create a new worker (key="%s").',
@@ -621,7 +618,7 @@ def webrtc_streamer(
                 ice_servers = get_available_ice_servers()  # NOTE: This may include a yield point where Streamlit's script runner interrupts the execution and may stop the current run.
                 aiortc_rtc_configuration.iceServers = compile_ice_servers(ice_servers)
 
-            worker_created_in_this_run = WebRtcWorker(
+            worker_created_in_this_run: WebRtcWorker = WebRtcWorker(
                 mode=mode,
                 rtc_configuration=aiortc_rtc_configuration,
                 player_factory=player_factory,
@@ -644,19 +641,37 @@ def webrtc_streamer(
                 sendback_audio=sendback_audio,
             )
 
+            worker_created_in_this_run.process_offer(
+                sdp_offer["sdp"],
+                sdp_offer["type"],
+                timeout=10,  # The timeout of aioice's method that is used in the internal of this method is 5: https://github.com/aiortc/aioice/blob/aaada959aa8de31b880822db36f1c0c0cef75c0e/src/aioice/ice.py#L973. We set a bit longer timeout here.
+            )
+
             # Set the worker here within the lock.
             context._set_worker(worker_created_in_this_run)
 
     webrtc_worker = context._get_worker()
-    if webrtc_worker and ice_candidates:
-        webrtc_worker.set_ice_candidates_from_offerer(ice_candidates)
 
-    if worker_created_in_this_run:
-        worker_created_in_this_run.process_offer(
-            sdp_offer["sdp"], sdp_offer["type"], timeout=None
+    if (
+        webrtc_worker
+        and webrtc_worker.pc.localDescription
+        and not context._is_sdp_answer_sent
+    ):
+        context._sdp_answer_json = json.dumps(
+            {
+                "sdp": webrtc_worker.pc.localDescription.sdp,
+                "type": webrtc_worker.pc.localDescription.type,
+            }
         )
 
-        # Rerun to send the SDP answer to frontend
+        LOGGER.debug("Rerun to send the SDP answer to frontend")
+        # NOTE: rerun() may not work if it's called in the lock when the `runner.fastReruns` config is enabled
+        # because the `ScriptRequests._state` is set to `ScriptRequestType.STOP` by the rerun request from the frontend sent during awaiting the lock,
+        # which makes the rerun request refused.
+        # So we call rerun() here. It can be called even in a different thread(run) from the one where the worker is created as long as the condition is met.
         rerun()
 
+    if webrtc_worker and ice_candidates:
+        webrtc_worker.set_ice_candidates_from_offerer(ice_candidates)
+
     return context

{streamlit_webrtc-0.62.0.dist-info → streamlit_webrtc-0.62.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamlit-webrtc
-Version: 0.62.0
+Version: 0.62.2
 Summary: Real-time video and audio processing on Streamlit
 Project-URL: Repository, https://github.com/whitphx/streamlit-webrtc
 Author-email: "Yuichiro Tachibana (Tsuchiya)" <t.yic.yt@gmail.com>

{streamlit_webrtc-0.62.0.dist-info → streamlit_webrtc-0.62.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 streamlit_webrtc/__init__.py,sha256=jMWwXoQ9hVyYXPD4Vrps7MyiR9goyC-n7LtkZNFBOxU,2273
 streamlit_webrtc/_compat.py,sha256=AVRcUGdgWDQcCE7-ufhGr6Hb5P6EHLgejUAA72ArJmg,4384
-streamlit_webrtc/component.py,sha256=Imoz2xuLRvgjy2Lxi9VVXgCMdvf-nUriTim2AjdFfC0,27155
+streamlit_webrtc/component.py,sha256=GYkD-UPZgLrxSUce81o9AakKYk2NOjDsna7mN9Pul7k,28291
 streamlit_webrtc/components_callbacks.py,sha256=tdrj2TlV8qcexFEdjm4PVkz8JwHffo4A8imoXOtjNHA,2401
 streamlit_webrtc/config.py,sha256=yKFIVjIoX2F62_G2qcDrNYm2Qe_qx1E9E0YqAnAibMo,5544
 streamlit_webrtc/credentials.py,sha256=fTs-DhUhScK8m7OEfkgTMw7pKXnS9QNpjtJAvR9oIzs,4619
@@ -19,7 +19,7 @@ streamlit_webrtc/source.py,sha256=haPqMZ50Xh8tg7Z1yN8Frfk8v7D3oOuKteaD59asbzs,22
 streamlit_webrtc/webrtc.py,sha256=WzgydYm3Xhoi5c1QHNLc_GiF_E0aGC5ynzmxeAbtJCw,29900
 streamlit_webrtc/frontend/dist/index.html,sha256=ZY_Iflaf7wRUHHNpw7JMlSMraE3ewM9T_tZA94NIPRs,527
 streamlit_webrtc/frontend/dist/assets/index-Cz1nSw2-.js,sha256=j126AA3NGo8BLgQSjjMyQR6QwpDRq_jILP9woihrncI,589799
-streamlit_webrtc-0.62.0.dist-info/METADATA,sha256=4ZRD7tidnmUHRkPHOGorF-MZrzDSnaAs7ZXPCPAmuvw,18288
-streamlit_webrtc-0.62.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-streamlit_webrtc-0.62.0.dist-info/licenses/LICENSE,sha256=pwccNHVA7r4rYofGlMU10aKEU90GLUlQr8uY80PR0NQ,1081
-streamlit_webrtc-0.62.0.dist-info/RECORD,,
+streamlit_webrtc-0.62.2.dist-info/METADATA,sha256=8RUIipCW6q8IVFviv2UVCakHZ2NG5CyoBL6Ru4uWbL4,18288
+streamlit_webrtc-0.62.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+streamlit_webrtc-0.62.2.dist-info/licenses/LICENSE,sha256=pwccNHVA7r4rYofGlMU10aKEU90GLUlQr8uY80PR0NQ,1081
+streamlit_webrtc-0.62.2.dist-info/RECORD,,