streamlit-webrtc 0.50.1__tar.gz → 0.51.0__tar.gz

{streamlit_webrtc-0.50.1 → streamlit_webrtc-0.51.0}/.gitignore

@@ -139,6 +139,9 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# Streamlit secrets
+.streamlit/secrets.toml
+
 # Demo data
 models/
 data/

{streamlit_webrtc-0.50.1 → streamlit_webrtc-0.51.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamlit-webrtc
-Version: 0.50.1
+Version: 0.51.0
 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.50.1 → streamlit_webrtc-0.51.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "streamlit-webrtc"
-version = "0.50.1"
+version = "0.51.0"
 description = "Real-time video and audio processing on Streamlit"
 authors = [{ name = "Yuichiro Tachibana (Tsuchiya)", email = "t.yic.yt@gmail.com" }]
 requires-python = ">=3.9,!=3.9.7"  # 3.9.7 is excluded due to https://github.com/streamlit/streamlit/pull/5168
@@ -51,7 +51,7 @@ build-backend = "hatchling.build"
 extend-select = ["I"]
 
 [tool.bumpversion]
-version = "0.50.1"
+version = "0.51.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{streamlit_webrtc-0.50.1 → streamlit_webrtc-0.51.0}/streamlit_webrtc/__init__.py

@@ -22,6 +22,10 @@ from .config import (
     Translations,
     VideoHTMLAttributes,
 )
+from .credentials import (
+    get_hf_ice_servers,
+    get_twilio_ice_servers,
+)
 from .factory import create_mix_track, create_process_track, create_video_source_track
 from .mix import MediaStreamMixTrack, MixerCallback
 from .source import VideoSourceCallback, VideoSourceTrack
@@ -83,4 +87,6 @@ __all__ = [
     "DEFAULT_AUDIO_HTML_ATTRS",
     "DEFAULT_MEDIA_STREAM_CONSTRAINTS",
     "DEFAULT_VIDEO_HTML_ATTRS",
+    "get_hf_ice_servers",
+    "get_twilio_ice_servers",
 ]

{streamlit_webrtc-0.50.1 → streamlit_webrtc-0.51.0}/streamlit_webrtc/component.py

@@ -1,3 +1,4 @@
+import copy
 import json
 import logging
 import os
@@ -40,6 +41,7 @@ from .config import (
     Translations,
     VideoHTMLAttributes,
 )
+from .credentials import get_hf_ice_servers, get_twilio_ice_servers
 from .session_info import get_script_run_count, get_this_session_info
 from .webrtc import (
     AudioProcessorFactory,
@@ -91,6 +93,7 @@ class WebRtcStreamerContext(Generic[VideoProcessorT, AudioProcessorT]):
     _worker_ref: "Optional[weakref.ReferenceType[WebRtcWorker[VideoProcessorT, AudioProcessorT]]]"  # noqa
 
     _component_value_snapshot: Union[ComponentValueSnapshot, None]
+    _rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]]
 
     def __init__(
         self,
@@ -100,6 +103,7 @@ class WebRtcStreamerContext(Generic[VideoProcessorT, AudioProcessorT]):
         self._set_worker(worker)
         self._set_state(state)
         self._component_value_snapshot = None
+        self._rtc_configuration = None
 
     def _set_worker(
         self, worker: Optional[WebRtcWorker[VideoProcessorT, AudioProcessorT]]
@@ -216,7 +220,7 @@ def compile_state(component_value) -> WebRtcStreamerState:
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
-    rtc_configuration: Optional[Union[Dict, RTCConfiguration]] = None,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     media_stream_constraints: Optional[Union[Dict, MediaStreamConstraints]] = None,
     desired_playing_state: Optional[bool] = None,
     player_factory: Optional[MediaPlayerFactory] = None,
@@ -257,7 +261,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
-    rtc_configuration: Optional[Union[Dict, RTCConfiguration]] = None,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     media_stream_constraints: Optional[Union[Dict, MediaStreamConstraints]] = None,
     desired_playing_state: Optional[bool] = None,
     player_factory: Optional[MediaPlayerFactory] = None,
@@ -294,7 +298,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
-    rtc_configuration: Optional[Union[Dict, RTCConfiguration]] = None,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     media_stream_constraints: Optional[Union[Dict, MediaStreamConstraints]] = None,
     desired_playing_state: Optional[bool] = None,
     player_factory: Optional[MediaPlayerFactory] = None,
@@ -331,7 +335,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
-    rtc_configuration: Optional[Union[Dict, RTCConfiguration]] = None,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     media_stream_constraints: Optional[Union[Dict, MediaStreamConstraints]] = None,
     desired_playing_state: Optional[bool] = None,
     player_factory: Optional[MediaPlayerFactory] = None,
@@ -367,7 +371,7 @@ def webrtc_streamer(
 def webrtc_streamer(
     key: str,
     mode: WebRtcMode = WebRtcMode.SENDRECV,
-    rtc_configuration: Optional[Union[Dict, RTCConfiguration]] = None,
+    rtc_configuration: Optional[Union[Dict[str, Any], RTCConfiguration]] = None,
     media_stream_constraints: Optional[Union[Dict, MediaStreamConstraints]] = None,
     desired_playing_state: Optional[bool] = None,
     player_factory: Optional[MediaPlayerFactory] = None,
@@ -456,6 +460,49 @@ def webrtc_streamer(
         )
         st.session_state[key] = context
 
+    if context._rtc_configuration is None:
+        context._rtc_configuration = copy.deepcopy(rtc_configuration)
+    if context._rtc_configuration is None or (
+        isinstance(context._rtc_configuration, dict)
+        and context._rtc_configuration.get("iceServers") is None
+    ):
+        LOGGER.info(
+            "rtc_configuration.iceServers is not set. Try to set it automatically."
+        )
+        if hf_token := os.getenv("HF_TOKEN"):
+            LOGGER.info("Try to use TURN server from Hugging Face.")
+            try:
+                ice_servers = get_hf_ice_servers(hf_token)
+                if context._rtc_configuration is None:
+                    context._rtc_configuration = {}
+                LOGGER.info("Successfully got TURN credentials from Hugging Face.")
+                context._rtc_configuration["iceServers"] = ice_servers
+            except Exception as e:
+                LOGGER.error("Failed to get TURN credentials from Hugging Face: %s", e)
+        elif os.getenv("TWILIO_ACCOUNT_SID") and os.getenv("TWILIO_AUTH_TOKEN"):
+            LOGGER.info("Try to use TURN server from Twilio.")
+            twilio_sid = os.getenv("TWILIO_ACCOUNT_SID")
+            twilio_token = os.getenv("TWILIO_AUTH_TOKEN")
+            try:
+                ice_servers = get_twilio_ice_servers(twilio_sid, twilio_token)
+                if context._rtc_configuration is None:
+                    context._rtc_configuration = {}
+                LOGGER.info("Successfully got TURN credentials from Twilio.")
+                context._rtc_configuration["iceServers"] = ice_servers
+            except Exception as e:
+                LOGGER.error("Failed to get TURN credentials from Twilio: %s", e)
+        else:
+            LOGGER.info("Use STUN server from Google.")
+            # TODO: Check network reachability and unset ice_servers if failed
+            ice_servers = [{"urls": "stun:stun.l.google.com:19302"}]
+            if ice_servers:
+                if context._rtc_configuration is None:
+                    context._rtc_configuration = {}
+                LOGGER.info("Successfully got STUN server from Google.")
+                context._rtc_configuration["iceServers"] = [
+                    {"urls": "stun:stun.l.google.com:19302"}
+                ]
+
     webrtc_worker = context._get_worker()
 
     sdp_answer_json = None
@@ -493,7 +540,7 @@ def webrtc_streamer(
         sdp_answer_json=sdp_answer_json,
         mode=mode.name,
         settings=client_settings,
-        rtc_configuration=rtc_configuration,
+        rtc_configuration=context._rtc_configuration,
         media_stream_constraints=media_stream_constraints,
         video_html_attrs=video_html_attrs,
         audio_html_attrs=audio_html_attrs,
@@ -549,6 +596,9 @@ def webrtc_streamer(
         webrtc_worker.stop()
         context._set_worker(None)
         webrtc_worker = None
+
+        context._rtc_configuration = None
+
         # Rerun to unset the SDP answer from the frontend args
         rerun()
 

streamlit_webrtc-0.51.0/streamlit_webrtc/credentials.py

@@ -0,0 +1,75 @@
+"""
+MIT License
+
+Copyright (c) 2024 Freddy Boulton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+# Original: https://github.com/freddyaboulton/fastrtc/blob/66f0a81b76684c5d58761464fb67642891066f93/LICENSE
+
+import json
+import os
+import urllib.error
+import urllib.request
+from typing import Optional
+
+
+def get_hf_ice_servers(token: Optional[str] = None):
+    if token is None:
+        token = os.getenv("HF_TOKEN")
+
+    if token is None:
+        raise ValueError("HF_TOKEN is not set")
+
+    req = urllib.request.Request(
+        "https://fastrtc-turn-server-login.hf.space/credentials",
+        headers={"X-HF-Access-Token": token},
+    )
+    try:
+        with urllib.request.urlopen(req) as response:
+            if response.status != 200:
+                raise ValueError("Failed to get credentials from HF turn server")
+            credentials = json.loads(response.read())
+            [
+                {
+                    "urls": "turn:gradio-turn.com:80",
+                    **credentials,
+                },
+            ]
+    except urllib.error.URLError:
+        raise ValueError("Failed to get credentials from HF turn server")
+
+
+def get_twilio_ice_servers(
+    twilio_sid: Optional[str] = None, twilio_token: Optional[str] = None
+):
+    try:
+        from twilio.rest import Client
+    except ImportError:
+        raise ImportError("Please install twilio with `pip install twilio`")
+
+    if not twilio_sid and not twilio_token:
+        twilio_sid = os.environ.get("TWILIO_ACCOUNT_SID")
+        twilio_token = os.environ.get("TWILIO_AUTH_TOKEN")
+
+    client = Client(twilio_sid, twilio_token)
+
+    token = client.tokens.create()
+
+    return token.ice_servers