sora-sdk 2025.1.0.dev1__tar.gz → 2025.1.0.dev3__tar.gz

{sora_sdk-2025.1.0.dev1/src/sora_sdk.egg-info → sora_sdk-2025.1.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: sora_sdk
-Version: 2025.1.0.dev1
+Version: 2025.1.0.dev3
 Summary: WebRTC SFU Sora Python SDK
 Home-page: https://github.com/shiguredo/sora-python-sdk
 Author-email: "Shiguredo Inc." <contact+pypi@shiguredo.jp>
@@ -195,6 +195,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE.md
+Dynamic: home-page
 
 # Sora Python SDK
 
@@ -228,6 +229,8 @@ Please read <https://github.com/shiguredo/oss/blob/master/README.en.md> before u
 - Windows / macOS / Linux (Ubuntu) プラットフォームに対応
 - [WebRTC 統計情報](https://www.w3.org/TR/webrtc-stats/) の取得が可能
 - [WebRTC Encoded Transform](https://www.w3.org/TR/webrtc-encoded-transform/) に対応
+- 回線が不安定になった際、解像度とフレームレートどちらを維持するかの設定をする DegradationPreference に対応
+  - MAINTAIN_FRAMERATE / MAINTAIN_RESOLUTION / BALANCED が指定できる
 - Intel / Apple / NVIDIA のハードウェアデコーダー/エンコーダーに対応
   - Intel VPL (AV1 / H.264 / H.265)
   - Apple Video Toolbox (H.264 / H.265)
@@ -282,7 +285,7 @@ PyPI 経由ではインストールできません。
 
 ## システム条件
 
-- WebRTC SFU Sora 2023.2.0 以降
+- WebRTC SFU Sora 2024.1.0 以降
 - Python 3.10 以上
 
 ## 対応プラットフォーム
@@ -347,9 +350,9 @@ Discord へお願いします。
 Apache License 2.0
 
 ```text
-Copyright 2023-2024, tnoho (Original Author)
-Copyright 2023-2024, Wandbox LLC (Original Author)
-Copyright 2023-2024, Shiguredo Inc.
+Copyright 2023-2025, tnoho (Original Author)
+Copyright 2023-2025, Wandbox LLC (Original Author)
+Copyright 2023-2025, Shiguredo Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

{sora_sdk-2025.1.0.dev1 → sora_sdk-2025.1.0.dev3}/README.md

@@ -30,6 +30,8 @@ Please read <https://github.com/shiguredo/oss/blob/master/README.en.md> before u
 - Windows / macOS / Linux (Ubuntu) プラットフォームに対応
 - [WebRTC 統計情報](https://www.w3.org/TR/webrtc-stats/) の取得が可能
 - [WebRTC Encoded Transform](https://www.w3.org/TR/webrtc-encoded-transform/) に対応
+- 回線が不安定になった際、解像度とフレームレートどちらを維持するかの設定をする DegradationPreference に対応
+  - MAINTAIN_FRAMERATE / MAINTAIN_RESOLUTION / BALANCED が指定できる
 - Intel / Apple / NVIDIA のハードウェアデコーダー/エンコーダーに対応
   - Intel VPL (AV1 / H.264 / H.265)
   - Apple Video Toolbox (H.264 / H.265)
@@ -84,7 +86,7 @@ PyPI 経由ではインストールできません。
 
 ## システム条件
 
-- WebRTC SFU Sora 2023.2.0 以降
+- WebRTC SFU Sora 2024.1.0 以降
 - Python 3.10 以上
 
 ## 対応プラットフォーム
@@ -149,9 +151,9 @@ Discord へお願いします。
 Apache License 2.0
 
 ```text
-Copyright 2023-2024, tnoho (Original Author)
-Copyright 2023-2024, Wandbox LLC (Original Author)
-Copyright 2023-2024, Shiguredo Inc.
+Copyright 2023-2025, tnoho (Original Author)
+Copyright 2023-2025, Wandbox LLC (Original Author)
+Copyright 2023-2025, Shiguredo Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

{sora_sdk-2025.1.0.dev1 → sora_sdk-2025.1.0.dev3}/buildbase.py

@@ -691,7 +691,7 @@ def build_and_install_boost(
 ):
     version_underscore = version.replace(".", "_")
     archive = download(
-        f"https://boostorg.jfrog.io/artifactory/main/release/{version}/source/boost_{version_underscore}.tar.gz",
+        f"https://archives.boost.io/release/{version}/source/boost_{version_underscore}.tar.gz",
         source_dir,
     )
     extract(archive, output_dir=build_dir, output_dirname="boost")

{sora_sdk-2025.1.0.dev1 → sora_sdk-2025.1.0.dev3}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "sora_sdk"
 authors = [{ name = "Shiguredo Inc.", email = "contact+pypi@shiguredo.jp" }]
-version = "2025.1.0.dev1"
+version = "2025.1.0.dev3"
 description = "WebRTC SFU Sora Python SDK"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -51,23 +51,24 @@ Discord = "https://discord.gg/shiguredo"
 # - https://setuptools.pypa.io/en/latest/build_meta.html
 #   - setuptools の build-system サポートについて解説されていて参考になる
 [build-system]
-requires = ["setuptools>=75.6", "wheel~=0.45.1"]
+requires = ["setuptools~=75.7", "wheel~=0.45.1"]
 build-backend = "setuptools.build_meta"
 
 [tool.uv]
 python-preference = "only-managed"
 dev-dependencies = [
     "nanobind~=2.4.0",
-    "setuptools>=75.6",
+    "setuptools~=75.7",
     "build~=1.2.2.post1",
     "wheel~=0.45.1",
     "typing-extensions",
     "python-dotenv",
-    "numpy>=2.2",
+    "numpy",
     "httpx",
     "pytest",
     "ruff",
     "mypy",
+    "pyjwt",
 ]
 
 [tool.ruff]

{sora_sdk-2025.1.0.dev1 → sora_sdk-2025.1.0.dev3}/src/sora_sdk/sora_sdk_ext.pyi

@@ -8,7 +8,7 @@ from numpy.typing import ArrayLike
 class Sora:
     def __init__(self, use_hardware_encoder: bool | None = None, openh264: str | None = None) -> None: ...
 
-    def create_connection(self, signaling_urls: list[str], role: str, channel_id: str, client_id: Optional[str] = None, bundle_id: Optional[str] = None, metadata: Optional[dict] = None, signaling_notify_metadata: Optional[dict] = None, audio_source: Optional[SoraTrackInterface] = None, video_source: Optional[SoraTrackInterface] = None, audio_frame_transformer: Optional[SoraAudioFrameTransformer] = None, video_frame_transformer: Optional[SoraVideoFrameTransformer] = None, audio: Optional[bool] = None, video: Optional[bool] = None, audio_codec_type: Optional[str] = None, video_codec_type: Optional[str] = None, video_bit_rate: Optional[int] = None, audio_bit_rate: Optional[int] = None, video_vp9_params: Optional[dict] = None, video_av1_params: Optional[dict] = None, video_h264_params: Optional[dict] = None, audio_opus_params: Optional[dict] = None, simulcast: Optional[bool] = None, spotlight: Optional[bool] = None, spotlight_number: Optional[int] = None, simulcast_rid: Optional[str] = None, spotlight_focus_rid: Optional[str] = None, spotlight_unfocus_rid: Optional[str] = None, forwarding_filter: Optional[dict] = None, forwarding_filters: Optional[list[dict]] = None, data_channels: Optional[list[dict]] = None, data_channel_signaling: Optional[bool] = None, ignore_disconnect_websocket: Optional[bool] = None, data_channel_signaling_timeout: Optional[int] = None, disconnect_wait_timeout: Optional[int] = None, websocket_close_timeout: Optional[int] = None, websocket_connection_timeout: Optional[int] = None, audio_streaming_language_code: Optional[str] = None, insecure: Optional[bool] = None, client_cert: Optional[bytes] = None, client_key: Optional[bytes] = None, ca_cert: Optional[bytes] = None, proxy_url: Optional[str] = None, proxy_username: Optional[str] = None, proxy_password: Optional[str] = None, proxy_agent: Optional[str] = None) -> SoraConnection: ...
+    def create_connection(self, signaling_urls: list[str], role: str, channel_id: str, client_id: Optional[str] = None, bundle_id: Optional[str] = None, metadata: Optional[dict] = None, signaling_notify_metadata: Optional[dict] = None, audio_source: Optional[SoraTrackInterface] = None, video_source: Optional[SoraTrackInterface] = None, audio_frame_transformer: Optional[SoraAudioFrameTransformer] = None, video_frame_transformer: Optional[SoraVideoFrameTransformer] = None, audio: Optional[bool] = None, video: Optional[bool] = None, audio_codec_type: Optional[str] = None, video_codec_type: Optional[str] = None, video_bit_rate: Optional[int] = None, audio_bit_rate: Optional[int] = None, video_vp9_params: Optional[dict] = None, video_av1_params: Optional[dict] = None, video_h264_params: Optional[dict] = None, audio_opus_params: Optional[dict] = None, simulcast: Optional[bool] = None, spotlight: Optional[bool] = None, spotlight_number: Optional[int] = None, simulcast_rid: Optional[str] = None, spotlight_focus_rid: Optional[str] = None, spotlight_unfocus_rid: Optional[str] = None, forwarding_filter: Optional[dict] = None, forwarding_filters: Optional[list[dict]] = None, data_channels: Optional[list[dict]] = None, data_channel_signaling: Optional[bool] = None, ignore_disconnect_websocket: Optional[bool] = None, data_channel_signaling_timeout: Optional[int] = None, disconnect_wait_timeout: Optional[int] = None, websocket_close_timeout: Optional[int] = None, websocket_connection_timeout: Optional[int] = None, audio_streaming_language_code: Optional[str] = None, insecure: Optional[bool] = None, client_cert: Optional[bytes] = None, client_key: Optional[bytes] = None, ca_cert: Optional[bytes] = None, proxy_url: Optional[str] = None, proxy_username: Optional[str] = None, proxy_password: Optional[str] = None, proxy_agent: Optional[str] = None, degradation_preference: Optional[SoraDegradationPreference] = None) -> SoraConnection: ...
 
     def create_audio_source(self, channels: int, sample_rate: int) -> SoraAudioSource: ...
 
@@ -156,6 +156,15 @@ class SoraConnection:
     @on_data_channel.setter
     def on_data_channel(self, arg: Callable[[str], None], /) -> None: ...
 
+class SoraDegradationPreference(enum.IntEnum):
+    DISABLED = 0
+
+    BALANCED = 3
+
+    MAINTAIN_FRAMERATE = 1
+
+    MAINTAIN_RESOLUTION = 2
+
 class SoraFrameTransformer:
     def enqueue(self, arg: SoraTransformableFrame, /) -> None: ...
 

{sora_sdk-2025.1.0.dev1 → sora_sdk-2025.1.0.dev3/src/sora_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: sora_sdk
-Version: 2025.1.0.dev1
+Version: 2025.1.0.dev3
 Summary: WebRTC SFU Sora Python SDK
 Home-page: https://github.com/shiguredo/sora-python-sdk
 Author-email: "Shiguredo Inc." <contact+pypi@shiguredo.jp>
@@ -195,6 +195,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE.md
+Dynamic: home-page
 
 # Sora Python SDK
 
@@ -228,6 +229,8 @@ Please read <https://github.com/shiguredo/oss/blob/master/README.en.md> before u
 - Windows / macOS / Linux (Ubuntu) プラットフォームに対応
 - [WebRTC 統計情報](https://www.w3.org/TR/webrtc-stats/) の取得が可能
 - [WebRTC Encoded Transform](https://www.w3.org/TR/webrtc-encoded-transform/) に対応
+- 回線が不安定になった際、解像度とフレームレートどちらを維持するかの設定をする DegradationPreference に対応
+  - MAINTAIN_FRAMERATE / MAINTAIN_RESOLUTION / BALANCED が指定できる
 - Intel / Apple / NVIDIA のハードウェアデコーダー/エンコーダーに対応
   - Intel VPL (AV1 / H.264 / H.265)
   - Apple Video Toolbox (H.264 / H.265)
@@ -282,7 +285,7 @@ PyPI 経由ではインストールできません。
 
 ## システム条件
 
-- WebRTC SFU Sora 2023.2.0 以降
+- WebRTC SFU Sora 2024.1.0 以降
 - Python 3.10 以上
 
 ## 対応プラットフォーム
@@ -347,9 +350,9 @@ Discord へお願いします。
 Apache License 2.0
 
 ```text
-Copyright 2023-2024, tnoho (Original Author)
-Copyright 2023-2024, Wandbox LLC (Original Author)
-Copyright 2023-2024, Shiguredo Inc.
+Copyright 2023-2025, tnoho (Original Author)
+Copyright 2023-2025, Wandbox LLC (Original Author)
+Copyright 2023-2025, Shiguredo Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

{sora_sdk-2025.1.0.dev1 → sora_sdk-2025.1.0.dev3}/src/sora_sdk.egg-info/SOURCES.txt

@@ -15,7 +15,10 @@ src/sora_sdk.egg-info/PKG-INFO
 src/sora_sdk.egg-info/SOURCES.txt
 src/sora_sdk.egg-info/dependency_links.txt
 src/sora_sdk.egg-info/top_level.txt
+tests/test_authz.py
+tests/test_authz_simulcast.py
 tests/test_ca_cert.py
+tests/test_degradation_preference.py
 tests/test_encoded_transform.py
 tests/test_macos.py
 tests/test_messaging.py

sora_sdk-2025.1.0.dev3/tests/test_authz.py

@@ -0,0 +1,125 @@
+import sys
+import time
+import uuid
+
+import jwt
+import pytest
+from client import SoraClient, SoraRole
+
+
+@pytest.mark.skipif(reason="Sora C++ SDK 側の対応が必要")
+def test_sendonly_authz_video_true(setup):
+    """
+    - type: connect で audio: true / video: false で繫ぐ
+    - 認証成功時の払い出しで audio: false / video: true を払い出す
+    """
+    signaling_urls = setup.get("signaling_urls")
+    channel_id_prefix = setup.get("channel_id_prefix")
+    secret = setup.get("secret")
+
+    channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
+
+    access_token = jwt.encode(
+        {
+            "channel_id": channel_id,
+            "audio": False,
+            "video": True,
+            # 現在時刻 + 300 秒 (5分)
+            "exp": int(time.time()) + 300,
+        },
+        secret,
+        algorithm="HS256",
+    )
+
+    sendonly = SoraClient(
+        signaling_urls,
+        SoraRole.SENDONLY,
+        channel_id,
+        audio=True,
+        video=False,
+        metadata={"access_token": access_token},
+    )
+    sendonly.connect(fake_video=False, fake_audio=True)
+
+    time.sleep(5)
+
+    assert sendonly.offer_message is not None
+    assert sendonly.offer_message["sdp"] is not None
+    assert "VP9" in sendonly.offer_message["sdp"]
+
+    sendonly_stats = sendonly.get_stats()
+
+    sendonly.disconnect()
+
+    # codec が無かったら StopIteration 例外が上がる
+    # 統計で video が見つからないので謎挙動になってる
+    sendonly_codec_stats = next(s for s in sendonly_stats if s.get("type") == "codec")
+    assert sendonly_codec_stats["mimeType"] == "video/VP9"
+
+    # outbound-rtp が無かったら StopIteration 例外が上がる
+    outbound_rtp_stats = next(s for s in sendonly_stats if s.get("type") == "outbound-rtp")
+    assert outbound_rtp_stats["encoderImplementation"] == "libvpx"
+    assert outbound_rtp_stats["bytesSent"] > 0
+    assert outbound_rtp_stats["packetsSent"] > 0
+
+
+@pytest.mark.parametrize(
+    "video_codec_params",
+    [
+        # video_codec, encoder_implementation, decoder_implementation
+        ("VP8", "libvpx"),
+        ("VP9", "libvpx"),
+        ("AV1", "libaom"),
+    ],
+)
+def test_sendonly_authz_video_codec_type(setup, video_codec_params):
+    video_codec_type, encoder_implementation = video_codec_params
+
+    signaling_urls = setup.get("signaling_urls")
+    channel_id_prefix = setup.get("channel_id_prefix")
+    secret = setup.get("secret")
+
+    channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
+
+    access_token = jwt.encode(
+        {
+            "channel_id": channel_id,
+            "video": True,
+            "video_codec_type": video_codec_type,
+            # 現在時刻 + 300 秒 (5分)
+            "exp": int(time.time()) + 300,
+        },
+        secret,
+        algorithm="HS256",
+    )
+
+    sendonly = SoraClient(
+        signaling_urls,
+        SoraRole.SENDONLY,
+        channel_id,
+        audio=False,
+        video=True,
+        metadata={"access_token": access_token},
+    )
+    sendonly.connect(fake_video=True)
+
+    time.sleep(5)
+
+    assert sendonly.offer_message is not None
+    assert sendonly.offer_message["sdp"] is not None
+    assert video_codec_type in sendonly.offer_message["sdp"]
+
+    sendonly_stats = sendonly.get_stats()
+
+    sendonly.disconnect()
+
+    # codec が無かったら StopIteration 例外が上がる
+    # 統計で video が見つからないので謎挙動になってる
+    sendonly_codec_stats = next(s for s in sendonly_stats if s.get("type") == "codec")
+    assert sendonly_codec_stats["mimeType"] == f"video/{video_codec_type}"
+
+    # outbound-rtp が無かったら StopIteration 例外が上がる
+    outbound_rtp_stats = next(s for s in sendonly_stats if s.get("type") == "outbound-rtp")
+    assert outbound_rtp_stats["encoderImplementation"] == encoder_implementation
+    assert outbound_rtp_stats["bytesSent"] > 0
+    assert outbound_rtp_stats["packetsSent"] > 0

sora_sdk-2025.1.0.dev3/tests/test_authz_simulcast.py

@@ -0,0 +1,151 @@
+import sys
+import time
+import uuid
+
+import jwt
+import pytest
+from client import SoraClient, SoraRole
+
+
+@pytest.mark.parametrize(
+    (
+        "video_codec_type",
+        "encoder_implementation",
+        "video_bit_rate",
+        "video_width",
+        "video_height",
+    ),
+    [
+        # どうやら scaleResolutionDownTo を指定すると規定されたテーブルのビットレートでは足りない模様
+        ("VP8", "libvpx", 2500, 960, 540),
+        ("VP9", "libvpx", 2000, 960, 540),
+    ],
+)
+def test_simulcast_authz_scale_resolution_to(
+    setup,
+    video_codec_type,
+    encoder_implementation,
+    video_bit_rate,
+    video_width,
+    video_height,
+):
+    signaling_urls = setup.get("signaling_urls")
+    channel_id_prefix = setup.get("channel_id_prefix")
+    secret = setup.get("secret")
+
+    channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
+
+    simulcast_encodings = [
+        {
+            "rid": "r0",
+            "active": True,
+            "scaleResolutionDownTo": {"maxWidth": 640, "maxHeight": 360},
+            "scalabilityMode": "L1T1",
+        },
+        {
+            "rid": "r1",
+            "active": True,
+            "scaleResolutionDownTo": {"maxWidth": 640, "maxHeight": 360},
+            "scalabilityMode": "L1T1",
+        },
+        {
+            "rid": "r2",
+            "active": True,
+            "scaleResolutionDownTo": {"maxWidth": 640, "maxHeight": 360},
+            "scalabilityMode": "L1T1",
+        },
+    ]
+
+    access_token = jwt.encode(
+        {
+            "channel_id": channel_id,
+            "video": True,
+            "video_codec_type": video_codec_type,
+            "video_bit_rate": video_bit_rate,
+            "simulcast": True,
+            "simulcast_encodings": simulcast_encodings,
+            # 現在時刻 + 300 秒 (5分)
+            "exp": int(time.time()) + 300,
+        },
+        secret,
+        algorithm="HS256",
+    )
+
+    sendonly = SoraClient(
+        signaling_urls,
+        SoraRole.SENDONLY,
+        channel_id,
+        audio=False,
+        video=True,
+        metadata={"access_token": access_token},
+        video_width=video_width,
+        video_height=video_height,
+    )
+    sendonly.connect(fake_video=True)
+
+    time.sleep(5)
+
+    # "type": "offer" の SDP で Simulcast があるかどうか
+    assert sendonly.offer_message is not None
+    assert sendonly.offer_message["sdp"] is not None
+    assert video_codec_type in sendonly.offer_message["sdp"]
+    assert "a=simulcast:recv r0;r1;r2" in sendonly.offer_message["sdp"]
+    sendonly_stats = sendonly.get_stats()
+
+    sendonly.disconnect()
+
+    # "type": "answer" の SDP で Simulcast があるかどうか
+    assert sendonly.answer_message is not None
+    assert "sdp" in sendonly.answer_message
+    assert "a=simulcast:send r0;r1;r2" in sendonly.answer_message["sdp"]
+
+    # codec が無かったら StopIteration 例外が上がる
+    sendonly_codec_stats = next(s for s in sendonly_stats if s.get("type") == "codec")
+    assert sendonly_codec_stats["mimeType"] == f"video/{video_codec_type}"
+
+    # 複数の outbound-rtp 統計情報を取得
+    outbound_rtp_stats = [
+        s for s in sendonly_stats if s.get("type") == "outbound-rtp" and s.get("kind") == "video"
+    ]
+    # simulcast_count に関係なく統計情報はかならず 3 本出力される
+    # これは SDP で rid で ~r0 とかやる減るはず
+    assert len(outbound_rtp_stats) == 3
+
+    # rid でソート
+    sorted_stats = sorted(outbound_rtp_stats, key=lambda x: x.get("rid", ""))
+
+    for i, s in enumerate(sorted_stats):
+        assert s["rid"] == f"r{i}"
+        assert s["kind"] == "video"
+
+        # VP8 の場合は scaleResolutionDownTo を指定すると SimulcastEncoderAdapter が無くなる
+        # TODO: 念のため他の挙動も確認すること
+        if video_codec_type == "VP9":
+            assert "SimulcastEncoderAdapter" in s["encoderImplementation"]
+        assert encoder_implementation in s["encoderImplementation"]
+
+        assert s["keyFramesEncoded"] > 0
+        assert s["bytesSent"] > 1000
+        assert s["packetsSent"] > 20
+
+        assert s["frameWidth"] == 640
+        assert s["frameHeight"] == 352
+
+        # FIXME:これは libwebrtc 側の挙動を制御できず L1T2 になってしまう
+        assert s["scalabilityMode"] == "L1T2"
+
+        # targetBitrate が指定したビットレートの 90% 以上、100% 以下に収まることを確認
+        expected_bitrate = video_bit_rate * 1000
+        print(
+            s["rid"],
+            video_codec_type,
+            s["encoderImplementation"],
+            expected_bitrate,
+            s["targetBitrate"],
+            s["frameWidth"],
+            s["frameHeight"],
+            s["bytesSent"],
+            s["packetsSent"],
+        )
+        # 期待値の 20% 以上、100% 以下に収まることを確認
+        assert expected_bitrate * 0.2 <= s["targetBitrate"] <= expected_bitrate