sora-sdk 2025.2.0.dev1__tar.gz → 2025.2.0.dev3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of sora-sdk might be problematic. Click here for more details.
- sora_sdk-2025.2.0.dev3/PKG-INFO +237 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/README.md +1 -1
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/pyproject.toml +6 -6
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk/sora_sdk_ext.cpython-311-darwin.so +0 -0
- sora_sdk-2025.2.0.dev3/src/sora_sdk.egg-info/PKG-INFO +237 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk.egg-info/SOURCES.txt +1 -1
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_amd_amf.py +28 -27
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_apple_video_toolbox.py +53 -31
- sora_sdk-2025.2.0.dev3/tests/test_authz_simulcast.py +544 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_intel_vpl.py +39 -37
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_nvidia_video_codec_sdk.py +38 -29
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_openh264.py +0 -135
- sora_sdk-2025.2.0.dev3/tests/test_openh264_simulcast.py +434 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_simulcast.py +42 -43
- sora_sdk-2025.2.0.dev1/NOTICE.md +0 -580
- sora_sdk-2025.2.0.dev1/PKG-INFO +0 -415
- sora_sdk-2025.2.0.dev1/src/sora_sdk.egg-info/PKG-INFO +0 -415
- sora_sdk-2025.2.0.dev1/tests/test_authz_simulcast.py +0 -202
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/LICENSE +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/MANIFEST.in +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/buildbase.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/pypath.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/run.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/setup.cfg +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/setup.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk/__init__.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk/py.typed +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk/sora_sdk_ext.pyi +188 -188
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk.egg-info/dependency_links.txt +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk.egg-info/top_level.txt +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_authz.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_ca_cert.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_capability.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_degradation_preference.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_encoded_transform.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_messaging.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_messaging_header.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_opus.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_re_offer_re_answer_sdp.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_sendonly_recvonly.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_signaling.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_signaling_message.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_signaling_notify.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_sora_disconnect.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_type_disconnect.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_type_switched.py +0 -0
- {sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/tests/test_vad.py +0 -0
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sora_sdk
|
|
3
|
+
Version: 2025.2.0.dev3
|
|
4
|
+
Summary: WebRTC SFU Sora Python SDK
|
|
5
|
+
Home-page: https://github.com/shiguredo/sora-python-sdk
|
|
6
|
+
Author-email: "Shiguredo Inc." <contact+pypi@shiguredo.jp>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
Project-URL: Source, https://github.com/shiguredo/sora-python-sdk
|
|
9
|
+
Project-URL: Documentation, https://sora-python-sdk.shiguredo.jp
|
|
10
|
+
Project-URL: Discord, https://discord.gg/shiguredo
|
|
11
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
15
|
+
Requires-Python: >=3.11
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Dynamic: home-page
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# Sora Python SDK
|
|
22
|
+
|
|
23
|
+
[](https://pypi.org/project/sora-sdk/)
|
|
24
|
+
[](https://pypi.python.org/pypi/sora_sdk)
|
|
25
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
26
|
+
[](https://github.com/shiguredo/sora-python-sdk/actions)
|
|
27
|
+
|
|
28
|
+
Sora Python SDK は [WebRTC SFU Sora](https://sora.shiguredo.jp/) の Python クライアントアプリケーションを開発するためのライブラリです。[Sora C++ SDK](https://github.com/shiguredo/sora-cpp-sdk) をベースにしています。
|
|
29
|
+
|
|
30
|
+
## About Shiguredo's open source software
|
|
31
|
+
|
|
32
|
+
We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.
|
|
33
|
+
|
|
34
|
+
Please read <https://github.com/shiguredo/oss/blob/master/README.en.md> before use.
|
|
35
|
+
|
|
36
|
+
## 時雨堂のオープンソースソフトウェアについて
|
|
37
|
+
|
|
38
|
+
利用前に <https://github.com/shiguredo/oss> をお読みください。
|
|
39
|
+
|
|
40
|
+
## Sora Python SDK について
|
|
41
|
+
|
|
42
|
+
様々なプラットフォームに対応しすぐに使い始められる WebRTC SFU Sora 向けの Python SDK です。
|
|
43
|
+
|
|
44
|
+
音声や映像デバイスの処理を SDK から独立させているため、様々なライブラリを利用する事ができます。
|
|
45
|
+
|
|
46
|
+
## 特徴
|
|
47
|
+
|
|
48
|
+
- [Sora C++ SDK](https://github.com/shiguredo/sora-cpp-sdk) ベース
|
|
49
|
+
- WebRTC 部分の機能は [libwebrtc](https://webrtc.googlesource.com/src/) を採用
|
|
50
|
+
- Windows / macOS / Linux (Ubuntu) プラットフォームに対応
|
|
51
|
+
- [WebRTC 統計情報](https://www.w3.org/TR/webrtc-stats/) の取得が可能
|
|
52
|
+
- [WebRTC Encoded Transform](https://www.w3.org/TR/webrtc-encoded-transform/) に対応
|
|
53
|
+
- 回線が不安定になった際、解像度とフレームレートどちらを維持するかの設定をする [DegradationPreference](https://w3c.github.io/mst-content-hint/#degradation-preference-when-encoding) に対応
|
|
54
|
+
- MAINTAIN_FRAMERATE / MAINTAIN_RESOLUTION / BALANCED が指定できる
|
|
55
|
+
- Intel / Apple / NVIDIA のハードウェアデコーダー/エンコーダーに対応
|
|
56
|
+
- Apple Video Toolbox (H.264 / H.265)
|
|
57
|
+
- macOS arm64 で利用できる
|
|
58
|
+
- Intel VPL (AV1 / H.264 / H.265)
|
|
59
|
+
- Ubuntu x86_64 / Windows x86_64 で利用できる
|
|
60
|
+
- AMD AMF (VP9 /AV1 / H.264 / H.265)
|
|
61
|
+
- Ubuntu x86_64 / Windows x86_64 で利用できる
|
|
62
|
+
- AV1 エンコードは Windows x86_64 でのみ利用できる
|
|
63
|
+
- VP9 はデコードのみ利用できる
|
|
64
|
+
- NVIDIA Video Codec SDK (VP8 / VP9 / AV1 / H.264 / H.265)
|
|
65
|
+
- Ubuntu x86_64 / Windows x86_64 で利用できる
|
|
66
|
+
- VP8 と VP9 はデコードのみ利用できる
|
|
67
|
+
- NVIDIA Jetson JetPack SDK (AV1 / H.264 / H.265)
|
|
68
|
+
- [各プラットフォームで利用可能な HWA への対応](https://github.com/shiguredo/sora-cpp-sdk?tab=readme-ov-file#%E7%89%B9%E5%BE%B4)
|
|
69
|
+
- [OpenH264](https://github.com/cisco/openh264) を利用した H.264 のソフトウェアエンコーダー/デコーダーに対応
|
|
70
|
+
- Ubuntu x86_64 / Ubuntu arm64 / Windows x86_64 / macOS arm64 で利用できる
|
|
71
|
+
- 音声デバイス処理に [sounddevice](https://pypi.org/project/sounddevice/) などが利用できる
|
|
72
|
+
- 映像デバイス処理に [opencv-python](https://pypi.org/project/opencv-python/) などが利用できる
|
|
73
|
+
- 音声認識などの入力に受信した音声を利用できる
|
|
74
|
+
- 物体検出などの入力に受信した映像を利用できる
|
|
75
|
+
- `uv add sora_sdk` や `pip install sora_sdk` でインストール可能
|
|
76
|
+
- [NVIDIA Jetson JetPack SDK](https://developer.nvidia.com/embedded/jetpack) に対応
|
|
77
|
+
|
|
78
|
+
## 利用イメージ
|
|
79
|
+
|
|
80
|
+
- データチャンネルを利用して Python において映像、音声を解析した結果を Sora 経由で配信する
|
|
81
|
+
- Text to Speech の音声を Sora 経由で配信する
|
|
82
|
+
- 映像入力に対して Pillow などで加工した映像を Sora を経由で配信する
|
|
83
|
+
- A チャンネルの参加者からの映像と音声を B チャンネルに対して加工した上で Sora 経由で配信する
|
|
84
|
+
|
|
85
|
+
## ドキュメント
|
|
86
|
+
|
|
87
|
+
[Sora Python SDK](https://sora-python-sdk.shiguredo.jp/)
|
|
88
|
+
|
|
89
|
+
## サンプル集
|
|
90
|
+
|
|
91
|
+
[shiguredo/sora-python-sdk-examples](https://github.com/shiguredo/sora-python-sdk-examples)
|
|
92
|
+
|
|
93
|
+
## sora_sdk パッケージの追加
|
|
94
|
+
|
|
95
|
+
### uv
|
|
96
|
+
|
|
97
|
+
[uv](https://docs.astral.sh/uv/)
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
uv add sora_sdk
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### pip
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
pip install sora_sdk
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### NVIDIA Jetson 向けパッケージ
|
|
110
|
+
|
|
111
|
+
PyPI 経由ではインストールできません。
|
|
112
|
+
パッケージバイナリを配布しておりますので、そちらをご利用ください。
|
|
113
|
+
|
|
114
|
+
<https://github.com/shiguredo/sora-python-sdk/releases/tag/2024.3.0-jetson-jetpack-6.0.0.0>
|
|
115
|
+
|
|
116
|
+
## システム条件
|
|
117
|
+
|
|
118
|
+
- WebRTC SFU Sora 2024.1.0 以降
|
|
119
|
+
- Python 3.11 以上
|
|
120
|
+
|
|
121
|
+
## Python サポートポリシー
|
|
122
|
+
|
|
123
|
+
直近の 3 バージョンの Python をサポートします。
|
|
124
|
+
|
|
125
|
+
## 対応プラットフォーム
|
|
126
|
+
|
|
127
|
+
- Ubuntu 24.04 LTS x86_64
|
|
128
|
+
- Ubuntu 24.04 LTS arm64
|
|
129
|
+
- Ubuntu 22.04 LTS x86_64
|
|
130
|
+
- Ubuntu 22.04 LTS arm64 (NVIDIA Jetson JetPack SDK 6)
|
|
131
|
+
- PyPI からではなくパッケージファイルを利用してください
|
|
132
|
+
- macOS Sequoia 15 arm64
|
|
133
|
+
- macOS Ventura 14 arm64
|
|
134
|
+
- Windows 11 x86_64
|
|
135
|
+
- Windows Server 2022 x86_64
|
|
136
|
+
|
|
137
|
+
### macOS の対応バージョン
|
|
138
|
+
|
|
139
|
+
直近の 2 バージョンをサポートします。
|
|
140
|
+
|
|
141
|
+
### Ubuntu の対応バージョン
|
|
142
|
+
|
|
143
|
+
直近の LTS 2 バージョンをサポートします。
|
|
144
|
+
|
|
145
|
+
## 優先実装
|
|
146
|
+
|
|
147
|
+
優先実装とは Sora のライセンスを契約頂いているお客様向けに Sora Python SDK の実装予定機能を有償にて前倒しで実装することです。
|
|
148
|
+
|
|
149
|
+
**詳細は Discord やメールなどでお気軽にお問い合わせください**
|
|
150
|
+
|
|
151
|
+
- DataChannel 対応
|
|
152
|
+
- [アダワープジャパン株式会社](https://adawarp.com/) 様
|
|
153
|
+
- Intel VPL H.265 対応
|
|
154
|
+
- [アダワープジャパン株式会社](https://adawarp.com/) 様
|
|
155
|
+
|
|
156
|
+
### 優先実装が可能な機能一覧
|
|
157
|
+
|
|
158
|
+
- Windows 11 arm64
|
|
159
|
+
- Ubuntu 22.04 arm64
|
|
160
|
+
- Ubuntu 22.04 arm64 (NVIDIA Jetson JetPack SDK 6.1)
|
|
161
|
+
- Ubuntu 20.04 arm64 (NVIDIA Jetson JetPack SDK 5)
|
|
162
|
+
|
|
163
|
+
## サポートについて
|
|
164
|
+
|
|
165
|
+
### Discord
|
|
166
|
+
|
|
167
|
+
- **サポートしません**
|
|
168
|
+
- アドバイスします
|
|
169
|
+
- フィードバック歓迎します
|
|
170
|
+
|
|
171
|
+
最新の状況などは Discord で共有しています。質問や相談も Discord でのみ受け付けています。
|
|
172
|
+
|
|
173
|
+
<https://discord.gg/shiguredo>
|
|
174
|
+
|
|
175
|
+
### バグ報告
|
|
176
|
+
|
|
177
|
+
Discord へお願いします。
|
|
178
|
+
|
|
179
|
+
## ライセンス
|
|
180
|
+
|
|
181
|
+
Apache License 2.0
|
|
182
|
+
|
|
183
|
+
```text
|
|
184
|
+
Copyright 2023-2025, tnoho (Original Author)
|
|
185
|
+
Copyright 2023-2025, Wandbox LLC (Original Author)
|
|
186
|
+
Copyright 2023-2025, Shiguredo Inc.
|
|
187
|
+
|
|
188
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
189
|
+
you may not use this file except in compliance with the License.
|
|
190
|
+
You may obtain a copy of the License at
|
|
191
|
+
|
|
192
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
193
|
+
|
|
194
|
+
Unless required by applicable law or agreed to in writing, software
|
|
195
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
196
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
197
|
+
See the License for the specific language governing permissions and
|
|
198
|
+
limitations under the License.
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## OpenH264
|
|
202
|
+
|
|
203
|
+
<https://www.openh264.org/BINARY_LICENSE.txt>
|
|
204
|
+
|
|
205
|
+
```text
|
|
206
|
+
"OpenH264 Video Codec provided by Cisco Systems, Inc."
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## NVDIA Video Codec SDK
|
|
210
|
+
|
|
211
|
+
<https://docs.nvidia.com/video-technologies/video-codec-sdk/12.2/license/index.html>
|
|
212
|
+
|
|
213
|
+
```text
|
|
214
|
+
“This software contains source code provided by NVIDIA Corporation.”
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## H.264 (AVC) と H.265 (HEVC) のライセンスについて
|
|
218
|
+
|
|
219
|
+
**時雨堂が提供する libwebrtc のビルド済みバイナリには H.264 と H.265 のコーデックは含まれていません**
|
|
220
|
+
|
|
221
|
+
### H.264
|
|
222
|
+
|
|
223
|
+
H.264 対応は [Via LA Licensing](https://www.via-la.com/) (旧 MPEG-LA) に連絡を取り、ロイヤリティの対象にならないことを確認しています。
|
|
224
|
+
|
|
225
|
+
> 時雨堂がエンドユーザーの PC /デバイスに既に存在する AVC / H.264 エンコーダー/デコーダーに依存する製品を提供する場合は、
|
|
226
|
+
> ソフトウェア製品は AVC ライセンスの対象外となり、ロイヤリティの対象にもなりません。
|
|
227
|
+
|
|
228
|
+
### H.265
|
|
229
|
+
|
|
230
|
+
H.265 対応は以下の二つの団体に連絡を取り、H.265 ハードウェアアクセラレーターのみを利用し、
|
|
231
|
+
H.265 が利用可能なバイナリを配布する事は、ライセンスが不要であることを確認しています。
|
|
232
|
+
|
|
233
|
+
また、H.265 のハードウェアアクセラレーターのみを利用した H.265 対応の SDK を OSS で公開し、
|
|
234
|
+
ビルド済みバイナリを配布する事は、ライセンスが不要であることも確認しています。
|
|
235
|
+
|
|
236
|
+
- [Access Advance](https://accessadvance.com/ja/)
|
|
237
|
+
- [Via LA Licensing](https://www.via-la.com/)
|
|
@@ -188,7 +188,7 @@ limitations under the License.
|
|
|
188
188
|
|
|
189
189
|
## NVDIA Video Codec SDK
|
|
190
190
|
|
|
191
|
-
<https://docs.nvidia.com/video-technologies/video-codec-sdk/12.
|
|
191
|
+
<https://docs.nvidia.com/video-technologies/video-codec-sdk/12.2/license/index.html>
|
|
192
192
|
|
|
193
193
|
```text
|
|
194
194
|
“This software contains source code provided by NVIDIA Corporation.”
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "sora_sdk"
|
|
3
3
|
authors = [{ name = "Shiguredo Inc.", email = "contact+pypi@shiguredo.jp" }]
|
|
4
|
-
version = "2025.2.0.
|
|
4
|
+
version = "2025.2.0.dev3"
|
|
5
5
|
description = "WebRTC SFU Sora Python SDK"
|
|
6
6
|
readme = "README.md"
|
|
7
|
-
license =
|
|
7
|
+
license = "Apache-2.0"
|
|
8
|
+
license-files = ["LICENSE"]
|
|
8
9
|
classifiers = [
|
|
9
|
-
"License :: OSI Approved :: Apache Software License",
|
|
10
10
|
"Programming Language :: Python :: 3 :: Only",
|
|
11
11
|
"Programming Language :: Python :: 3.11",
|
|
12
12
|
"Programming Language :: Python :: 3.12",
|
|
@@ -20,14 +20,14 @@ Documentation = "https://sora-python-sdk.shiguredo.jp"
|
|
|
20
20
|
Discord = "https://discord.gg/shiguredo"
|
|
21
21
|
|
|
22
22
|
[build-system]
|
|
23
|
-
requires = ["setuptools==
|
|
23
|
+
requires = ["setuptools==80.0", "wheel==0.45.1"]
|
|
24
24
|
build-backend = "setuptools.build_meta"
|
|
25
25
|
|
|
26
26
|
[tool.uv]
|
|
27
27
|
python-preference = "only-managed"
|
|
28
28
|
dev-dependencies = [
|
|
29
|
-
"nanobind==2.
|
|
30
|
-
"setuptools==
|
|
29
|
+
"nanobind==2.7.0",
|
|
30
|
+
"setuptools==80.0",
|
|
31
31
|
"build==1.2.2.post1",
|
|
32
32
|
"wheel==0.45.1",
|
|
33
33
|
"typing-extensions",
|
{sora_sdk-2025.2.0.dev1 → sora_sdk-2025.2.0.dev3}/src/sora_sdk/sora_sdk_ext.cpython-311-darwin.so
RENAMED
|
Binary file
|
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sora_sdk
|
|
3
|
+
Version: 2025.2.0.dev3
|
|
4
|
+
Summary: WebRTC SFU Sora Python SDK
|
|
5
|
+
Home-page: https://github.com/shiguredo/sora-python-sdk
|
|
6
|
+
Author-email: "Shiguredo Inc." <contact+pypi@shiguredo.jp>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
Project-URL: Source, https://github.com/shiguredo/sora-python-sdk
|
|
9
|
+
Project-URL: Documentation, https://sora-python-sdk.shiguredo.jp
|
|
10
|
+
Project-URL: Discord, https://discord.gg/shiguredo
|
|
11
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
15
|
+
Requires-Python: >=3.11
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Dynamic: home-page
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# Sora Python SDK
|
|
22
|
+
|
|
23
|
+
[](https://pypi.org/project/sora-sdk/)
|
|
24
|
+
[](https://pypi.python.org/pypi/sora_sdk)
|
|
25
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
26
|
+
[](https://github.com/shiguredo/sora-python-sdk/actions)
|
|
27
|
+
|
|
28
|
+
Sora Python SDK は [WebRTC SFU Sora](https://sora.shiguredo.jp/) の Python クライアントアプリケーションを開発するためのライブラリです。[Sora C++ SDK](https://github.com/shiguredo/sora-cpp-sdk) をベースにしています。
|
|
29
|
+
|
|
30
|
+
## About Shiguredo's open source software
|
|
31
|
+
|
|
32
|
+
We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.
|
|
33
|
+
|
|
34
|
+
Please read <https://github.com/shiguredo/oss/blob/master/README.en.md> before use.
|
|
35
|
+
|
|
36
|
+
## 時雨堂のオープンソースソフトウェアについて
|
|
37
|
+
|
|
38
|
+
利用前に <https://github.com/shiguredo/oss> をお読みください。
|
|
39
|
+
|
|
40
|
+
## Sora Python SDK について
|
|
41
|
+
|
|
42
|
+
様々なプラットフォームに対応しすぐに使い始められる WebRTC SFU Sora 向けの Python SDK です。
|
|
43
|
+
|
|
44
|
+
音声や映像デバイスの処理を SDK から独立させているため、様々なライブラリを利用する事ができます。
|
|
45
|
+
|
|
46
|
+
## 特徴
|
|
47
|
+
|
|
48
|
+
- [Sora C++ SDK](https://github.com/shiguredo/sora-cpp-sdk) ベース
|
|
49
|
+
- WebRTC 部分の機能は [libwebrtc](https://webrtc.googlesource.com/src/) を採用
|
|
50
|
+
- Windows / macOS / Linux (Ubuntu) プラットフォームに対応
|
|
51
|
+
- [WebRTC 統計情報](https://www.w3.org/TR/webrtc-stats/) の取得が可能
|
|
52
|
+
- [WebRTC Encoded Transform](https://www.w3.org/TR/webrtc-encoded-transform/) に対応
|
|
53
|
+
- 回線が不安定になった際、解像度とフレームレートどちらを維持するかの設定をする [DegradationPreference](https://w3c.github.io/mst-content-hint/#degradation-preference-when-encoding) に対応
|
|
54
|
+
- MAINTAIN_FRAMERATE / MAINTAIN_RESOLUTION / BALANCED が指定できる
|
|
55
|
+
- Intel / Apple / NVIDIA のハードウェアデコーダー/エンコーダーに対応
|
|
56
|
+
- Apple Video Toolbox (H.264 / H.265)
|
|
57
|
+
- macOS arm64 で利用できる
|
|
58
|
+
- Intel VPL (AV1 / H.264 / H.265)
|
|
59
|
+
- Ubuntu x86_64 / Windows x86_64 で利用できる
|
|
60
|
+
- AMD AMF (VP9 /AV1 / H.264 / H.265)
|
|
61
|
+
- Ubuntu x86_64 / Windows x86_64 で利用できる
|
|
62
|
+
- AV1 エンコードは Windows x86_64 でのみ利用できる
|
|
63
|
+
- VP9 はデコードのみ利用できる
|
|
64
|
+
- NVIDIA Video Codec SDK (VP8 / VP9 / AV1 / H.264 / H.265)
|
|
65
|
+
- Ubuntu x86_64 / Windows x86_64 で利用できる
|
|
66
|
+
- VP8 と VP9 はデコードのみ利用できる
|
|
67
|
+
- NVIDIA Jetson JetPack SDK (AV1 / H.264 / H.265)
|
|
68
|
+
- [各プラットフォームで利用可能な HWA への対応](https://github.com/shiguredo/sora-cpp-sdk?tab=readme-ov-file#%E7%89%B9%E5%BE%B4)
|
|
69
|
+
- [OpenH264](https://github.com/cisco/openh264) を利用した H.264 のソフトウェアエンコーダー/デコーダーに対応
|
|
70
|
+
- Ubuntu x86_64 / Ubuntu arm64 / Windows x86_64 / macOS arm64 で利用できる
|
|
71
|
+
- 音声デバイス処理に [sounddevice](https://pypi.org/project/sounddevice/) などが利用できる
|
|
72
|
+
- 映像デバイス処理に [opencv-python](https://pypi.org/project/opencv-python/) などが利用できる
|
|
73
|
+
- 音声認識などの入力に受信した音声を利用できる
|
|
74
|
+
- 物体検出などの入力に受信した映像を利用できる
|
|
75
|
+
- `uv add sora_sdk` や `pip install sora_sdk` でインストール可能
|
|
76
|
+
- [NVIDIA Jetson JetPack SDK](https://developer.nvidia.com/embedded/jetpack) に対応
|
|
77
|
+
|
|
78
|
+
## 利用イメージ
|
|
79
|
+
|
|
80
|
+
- データチャンネルを利用して Python において映像、音声を解析した結果を Sora 経由で配信する
|
|
81
|
+
- Text to Speech の音声を Sora 経由で配信する
|
|
82
|
+
- 映像入力に対して Pillow などで加工した映像を Sora を経由で配信する
|
|
83
|
+
- A チャンネルの参加者からの映像と音声を B チャンネルに対して加工した上で Sora 経由で配信する
|
|
84
|
+
|
|
85
|
+
## ドキュメント
|
|
86
|
+
|
|
87
|
+
[Sora Python SDK](https://sora-python-sdk.shiguredo.jp/)
|
|
88
|
+
|
|
89
|
+
## サンプル集
|
|
90
|
+
|
|
91
|
+
[shiguredo/sora-python-sdk-examples](https://github.com/shiguredo/sora-python-sdk-examples)
|
|
92
|
+
|
|
93
|
+
## sora_sdk パッケージの追加
|
|
94
|
+
|
|
95
|
+
### uv
|
|
96
|
+
|
|
97
|
+
[uv](https://docs.astral.sh/uv/)
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
uv add sora_sdk
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### pip
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
pip install sora_sdk
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### NVIDIA Jetson 向けパッケージ
|
|
110
|
+
|
|
111
|
+
PyPI 経由ではインストールできません。
|
|
112
|
+
パッケージバイナリを配布しておりますので、そちらをご利用ください。
|
|
113
|
+
|
|
114
|
+
<https://github.com/shiguredo/sora-python-sdk/releases/tag/2024.3.0-jetson-jetpack-6.0.0.0>
|
|
115
|
+
|
|
116
|
+
## システム条件
|
|
117
|
+
|
|
118
|
+
- WebRTC SFU Sora 2024.1.0 以降
|
|
119
|
+
- Python 3.11 以上
|
|
120
|
+
|
|
121
|
+
## Python サポートポリシー
|
|
122
|
+
|
|
123
|
+
直近の 3 バージョンの Python をサポートします。
|
|
124
|
+
|
|
125
|
+
## 対応プラットフォーム
|
|
126
|
+
|
|
127
|
+
- Ubuntu 24.04 LTS x86_64
|
|
128
|
+
- Ubuntu 24.04 LTS arm64
|
|
129
|
+
- Ubuntu 22.04 LTS x86_64
|
|
130
|
+
- Ubuntu 22.04 LTS arm64 (NVIDIA Jetson JetPack SDK 6)
|
|
131
|
+
- PyPI からではなくパッケージファイルを利用してください
|
|
132
|
+
- macOS Sequoia 15 arm64
|
|
133
|
+
- macOS Ventura 14 arm64
|
|
134
|
+
- Windows 11 x86_64
|
|
135
|
+
- Windows Server 2022 x86_64
|
|
136
|
+
|
|
137
|
+
### macOS の対応バージョン
|
|
138
|
+
|
|
139
|
+
直近の 2 バージョンをサポートします。
|
|
140
|
+
|
|
141
|
+
### Ubuntu の対応バージョン
|
|
142
|
+
|
|
143
|
+
直近の LTS 2 バージョンをサポートします。
|
|
144
|
+
|
|
145
|
+
## 優先実装
|
|
146
|
+
|
|
147
|
+
優先実装とは Sora のライセンスを契約頂いているお客様向けに Sora Python SDK の実装予定機能を有償にて前倒しで実装することです。
|
|
148
|
+
|
|
149
|
+
**詳細は Discord やメールなどでお気軽にお問い合わせください**
|
|
150
|
+
|
|
151
|
+
- DataChannel 対応
|
|
152
|
+
- [アダワープジャパン株式会社](https://adawarp.com/) 様
|
|
153
|
+
- Intel VPL H.265 対応
|
|
154
|
+
- [アダワープジャパン株式会社](https://adawarp.com/) 様
|
|
155
|
+
|
|
156
|
+
### 優先実装が可能な機能一覧
|
|
157
|
+
|
|
158
|
+
- Windows 11 arm64
|
|
159
|
+
- Ubuntu 22.04 arm64
|
|
160
|
+
- Ubuntu 22.04 arm64 (NVIDIA Jetson JetPack SDK 6.1)
|
|
161
|
+
- Ubuntu 20.04 arm64 (NVIDIA Jetson JetPack SDK 5)
|
|
162
|
+
|
|
163
|
+
## サポートについて
|
|
164
|
+
|
|
165
|
+
### Discord
|
|
166
|
+
|
|
167
|
+
- **サポートしません**
|
|
168
|
+
- アドバイスします
|
|
169
|
+
- フィードバック歓迎します
|
|
170
|
+
|
|
171
|
+
最新の状況などは Discord で共有しています。質問や相談も Discord でのみ受け付けています。
|
|
172
|
+
|
|
173
|
+
<https://discord.gg/shiguredo>
|
|
174
|
+
|
|
175
|
+
### バグ報告
|
|
176
|
+
|
|
177
|
+
Discord へお願いします。
|
|
178
|
+
|
|
179
|
+
## ライセンス
|
|
180
|
+
|
|
181
|
+
Apache License 2.0
|
|
182
|
+
|
|
183
|
+
```text
|
|
184
|
+
Copyright 2023-2025, tnoho (Original Author)
|
|
185
|
+
Copyright 2023-2025, Wandbox LLC (Original Author)
|
|
186
|
+
Copyright 2023-2025, Shiguredo Inc.
|
|
187
|
+
|
|
188
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
189
|
+
you may not use this file except in compliance with the License.
|
|
190
|
+
You may obtain a copy of the License at
|
|
191
|
+
|
|
192
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
193
|
+
|
|
194
|
+
Unless required by applicable law or agreed to in writing, software
|
|
195
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
196
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
197
|
+
See the License for the specific language governing permissions and
|
|
198
|
+
limitations under the License.
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## OpenH264
|
|
202
|
+
|
|
203
|
+
<https://www.openh264.org/BINARY_LICENSE.txt>
|
|
204
|
+
|
|
205
|
+
```text
|
|
206
|
+
"OpenH264 Video Codec provided by Cisco Systems, Inc."
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## NVDIA Video Codec SDK
|
|
210
|
+
|
|
211
|
+
<https://docs.nvidia.com/video-technologies/video-codec-sdk/12.2/license/index.html>
|
|
212
|
+
|
|
213
|
+
```text
|
|
214
|
+
“This software contains source code provided by NVIDIA Corporation.”
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## H.264 (AVC) と H.265 (HEVC) のライセンスについて
|
|
218
|
+
|
|
219
|
+
**時雨堂が提供する libwebrtc のビルド済みバイナリには H.264 と H.265 のコーデックは含まれていません**
|
|
220
|
+
|
|
221
|
+
### H.264
|
|
222
|
+
|
|
223
|
+
H.264 対応は [Via LA Licensing](https://www.via-la.com/) (旧 MPEG-LA) に連絡を取り、ロイヤリティの対象にならないことを確認しています。
|
|
224
|
+
|
|
225
|
+
> 時雨堂がエンドユーザーの PC /デバイスに既に存在する AVC / H.264 エンコーダー/デコーダーに依存する製品を提供する場合は、
|
|
226
|
+
> ソフトウェア製品は AVC ライセンスの対象外となり、ロイヤリティの対象にもなりません。
|
|
227
|
+
|
|
228
|
+
### H.265
|
|
229
|
+
|
|
230
|
+
H.265 対応は以下の二つの団体に連絡を取り、H.265 ハードウェアアクセラレーターのみを利用し、
|
|
231
|
+
H.265 が利用可能なバイナリを配布する事は、ライセンスが不要であることを確認しています。
|
|
232
|
+
|
|
233
|
+
また、H.265 のハードウェアアクセラレーターのみを利用した H.265 対応の SDK を OSS で公開し、
|
|
234
|
+
ビルド済みバイナリを配布する事は、ライセンスが不要であることも確認しています。
|
|
235
|
+
|
|
236
|
+
- [Access Advance](https://accessadvance.com/ja/)
|
|
237
|
+
- [Via LA Licensing](https://www.via-la.com/)
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
LICENSE
|
|
2
2
|
MANIFEST.in
|
|
3
|
-
NOTICE.md
|
|
4
3
|
README.md
|
|
5
4
|
buildbase.py
|
|
6
5
|
pypath.py
|
|
@@ -28,6 +27,7 @@ tests/test_messaging.py
|
|
|
28
27
|
tests/test_messaging_header.py
|
|
29
28
|
tests/test_nvidia_video_codec_sdk.py
|
|
30
29
|
tests/test_openh264.py
|
|
30
|
+
tests/test_openh264_simulcast.py
|
|
31
31
|
tests/test_opus.py
|
|
32
32
|
tests/test_re_offer_re_answer_sdp.py
|
|
33
33
|
tests/test_sendonly_recvonly.py
|
|
@@ -10,6 +10,7 @@ from client import (
|
|
|
10
10
|
codec_type_string_to_codec_type,
|
|
11
11
|
is_codec_supported,
|
|
12
12
|
)
|
|
13
|
+
from simulcast import default_video_bit_rate, expect_target_bitrate
|
|
13
14
|
|
|
14
15
|
from sora_sdk import (
|
|
15
16
|
SoraVideoCodecImplementation,
|
|
@@ -160,7 +161,6 @@ def test_amd_amf_sendonly_recvonly(setup, video_codec_type):
|
|
|
160
161
|
(
|
|
161
162
|
"video_codec_type",
|
|
162
163
|
"expected_implementation",
|
|
163
|
-
"video_bit_rate",
|
|
164
164
|
"video_width",
|
|
165
165
|
"video_height",
|
|
166
166
|
"simulcast_count",
|
|
@@ -169,17 +169,17 @@ def test_amd_amf_sendonly_recvonly(setup, video_codec_type):
|
|
|
169
169
|
# FIXME: AV1 では、解像度が一定数より低くなる場合、エラーになるのでコメントアウトしている
|
|
170
170
|
[
|
|
171
171
|
# 1080p
|
|
172
|
-
("AV1", "AMF",
|
|
173
|
-
("H264", "AMF",
|
|
174
|
-
("H265", "AMF",
|
|
172
|
+
("AV1", "AMF", 1920, 1080, 3),
|
|
173
|
+
("H264", "AMF", 1920, 1080, 3),
|
|
174
|
+
("H265", "AMF", 1920, 1080, 3),
|
|
175
175
|
# 720p
|
|
176
|
-
("AV1", "AMF",
|
|
177
|
-
("H264", "AMF",
|
|
178
|
-
("H265", "AMF",
|
|
176
|
+
("AV1", "AMF", 1280, 720, 3),
|
|
177
|
+
("H264", "AMF", 1280, 720, 3),
|
|
178
|
+
("H265", "AMF", 1280, 720, 3),
|
|
179
179
|
# 540p
|
|
180
|
-
("AV1", "AMF",
|
|
181
|
-
("H264", "AMF",
|
|
182
|
-
("H265", "AMF",
|
|
180
|
+
("AV1", "AMF", 960, 540, 3),
|
|
181
|
+
("H264", "AMF", 960, 540, 3),
|
|
182
|
+
("H265", "AMF", 960, 540, 3),
|
|
183
183
|
# 360p
|
|
184
184
|
# ("AV1", "AMF", 700, 640, 360, 2),
|
|
185
185
|
# ("H264", "AMF", 700, 640, 360, 2),
|
|
@@ -200,7 +200,6 @@ def test_amd_amf_simulcast(
|
|
|
200
200
|
setup,
|
|
201
201
|
video_codec_type,
|
|
202
202
|
expected_implementation,
|
|
203
|
-
video_bit_rate,
|
|
204
203
|
video_width,
|
|
205
204
|
video_height,
|
|
206
205
|
simulcast_count,
|
|
@@ -214,6 +213,8 @@ def test_amd_amf_simulcast(
|
|
|
214
213
|
|
|
215
214
|
channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
|
|
216
215
|
|
|
216
|
+
video_bit_rate = default_video_bit_rate(video_codec_type, video_width, video_height)
|
|
217
|
+
|
|
217
218
|
sendonly = SoraClient(
|
|
218
219
|
signaling_urls,
|
|
219
220
|
SoraRole.SENDONLY,
|
|
@@ -237,7 +238,7 @@ def test_amd_amf_simulcast(
|
|
|
237
238
|
)
|
|
238
239
|
sendonly.connect(fake_video=True)
|
|
239
240
|
|
|
240
|
-
time.sleep(
|
|
241
|
+
time.sleep(10)
|
|
241
242
|
|
|
242
243
|
sendonly_stats = sendonly.get_stats()
|
|
243
244
|
|
|
@@ -264,38 +265,38 @@ def test_amd_amf_simulcast(
|
|
|
264
265
|
sorted_stats = sorted(outbound_rtp_stats, key=lambda x: x.get("rid", ""))
|
|
265
266
|
|
|
266
267
|
for i, s in enumerate(sorted_stats):
|
|
268
|
+
assert "qualityLimitationReason" in s
|
|
269
|
+
assert "qualityLimitationDurations" in s
|
|
270
|
+
|
|
271
|
+
# qualityLimitationReason が none で無い場合は安定したテストができない
|
|
272
|
+
if s["qualityLimitationReason"] != "none":
|
|
273
|
+
pytest.skip(f"qualityLimitationReason: {s['qualityLimitationReason']}")
|
|
274
|
+
|
|
267
275
|
assert s["rid"] == f"r{i}"
|
|
268
276
|
# simulcast_count が 2 の場合、rid r2 の bytesSent/packetsSent は 0 or 1 になる
|
|
269
277
|
# simulcast_count が 1 の場合、rid r2 と r1 の bytesSent/packetsSent は 0 or 1 になる
|
|
270
278
|
if i < simulcast_count:
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
# assert "SimulcastEncoderAdapter" in s["encoderImplementation"]
|
|
279
|
+
assert s["bytesSent"] > 1000
|
|
280
|
+
assert s["packetsSent"] > 5
|
|
274
281
|
|
|
275
|
-
|
|
276
|
-
|
|
282
|
+
assert s["targetBitrate"] >= expect_target_bitrate(
|
|
283
|
+
video_codec_type, s["frameWidth"], s["frameHeight"]
|
|
284
|
+
)
|
|
277
285
|
|
|
278
|
-
# パケットが一切送られてこない場合は frame_width/frame_height が含まれないので None になる
|
|
279
|
-
frame_width = s.get("frameWidth")
|
|
280
|
-
frame_height = s.get("frameHeight")
|
|
281
286
|
encoder_implementation = s.get("encoderImplementation")
|
|
282
287
|
|
|
283
288
|
print(
|
|
284
289
|
s["rid"],
|
|
285
290
|
video_codec_type,
|
|
286
|
-
|
|
291
|
+
video_bit_rate * 1000,
|
|
287
292
|
s["targetBitrate"],
|
|
288
293
|
expected_implementation,
|
|
289
294
|
encoder_implementation,
|
|
290
|
-
|
|
291
|
-
|
|
295
|
+
s["frameWidth"],
|
|
296
|
+
s["frameHeight"],
|
|
292
297
|
s["bytesSent"],
|
|
293
298
|
s["packetsSent"],
|
|
294
299
|
)
|
|
295
|
-
assert s["bytesSent"] > 1000
|
|
296
|
-
assert s["packetsSent"] > 5
|
|
297
|
-
# 期待値の 20% 以上、100% 以下に収まることを確認
|
|
298
|
-
assert expected_bitrate * 0.2 <= s["targetBitrate"] <= expected_bitrate
|
|
299
300
|
else:
|
|
300
301
|
# 本来は 0 なのだが、simulcast_count が 1 の場合、
|
|
301
302
|
# packetSent が 0 ではなく 1 や 2 になる場合がある
|