Merge branch 'release/2024.2.0'

.github/workflows/build.yml

@@ -109,7 +109,7 @@ jobs:
           path: "dist/"
 
   build_windows:
-    runs-on: windows-2022
+    runs-on: windows-2019
     timeout-minutes: 60
     strategy:
       fail-fast: false
@@ -250,7 +250,7 @@ jobs:
           echo "EOF" >> $GITHUB_OUTPUT
         id: env
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           files: ${{ steps.env.outputs.package_paths }}
           prerelease: ${{ contains(github.ref, 'dev') }}

.gitignore

@@ -12,12 +12,14 @@ build
 src/sora_sdk/*.so
 src/sora_sdk/*.dll
 src/sora_sdk/*.pyd
-src/sora_sdk/model_coeffs/*
-!src/sora_sdk/model_coeffs/.gitkeep
 
 # パッケージ
 /dist
 /wheelhouse
 
 # E2E テスト用
-.env
+.env
+
+
+# libopenh264
+libopenh264*

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["charliermarsh.ruff", "ms-python.mypy-type-checker"]
+}

.vscode/settings.json

@@ -1,15 +1,19 @@
 {
+  "python.analysis.typeCheckingMode": "basic",
+  "python.analysis.autoImportCompletions": true,
   "python.analysis.diagnosticSeverityOverrides": {
     "reportMissingImports": "none",
     "reportUnusedImport": "information"
   },
   "[python]": {
     "editor.formatOnSave": true,
     "editor.formatOnSaveMode": "file",
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.autoIndent": "full",
     "editor.codeActionsOnSave": {
-      "source.organizeImports": "explicit"
-    },
-    "editor.defaultFormatter": "charliermarsh.ruff"
+      "source.fixAll.ruff": "always",
+      "source.organizeImports.ruff": "explicit"
+    }
   },
   "[cpp]": {
     "editor.formatOnSave": true
@@ -119,7 +123,5 @@
   },
   "C_Cpp.errorSquiggles": "disabled",
   // nanobind 周りでエラーが消えないので全部消す
-  "editor.tabSize": 2,
-  "python.analysis.typeCheckingMode": "off",
-  "cSpell.words": ["dtype", "imshow", "samplerate", "sounddevice"]
+  "editor.tabSize": 2
 }

CHANGES.md

@@ -11,6 +11,41 @@
 
 ## develop
 
+## 2024.2.0
+
+**2024-04-09**
+
+- [ADD] Sora Python SDK Samples を `examples` に移動する
+  - @voluntas
+- [CHANGE] Lyra のサポートを廃止し、以下のオプションを削除する
+  - audio_codec_lyra_bitrate
+  - audio_codec_lyra_usedtx
+  - check_lyra_version
+  - @enm10k
+- [ADD] `on_switched` コールバックを追加する
+  - @enm10k
+- [UPDATE] nanobind を `1.9.2` に上げて固定する
+  - @voluntas
+- [UPDATE] ruff の最小を ``0.3.0` に上げる
+  - @voluntas
+- [UPDATE] Sora C++ SDK のバージョンを `2024.6.0` に上げる
+  - libwebrtc で `cricket::MediaEngineDependencies` が廃止された変更に追従する
+  - WEBRTC_BUILD_VERSION を `m122.6261.1.0` に上げる
+    - Ubuntu のビルドを通すために、 __assertion_handler というファイルをコピーする処理を追加した
+  - BOOST_VERSION を `1.84.0` に上げる
+  - @enm10k
+- [FIX] pyproject.toml の `[rye.tool]` virtual = true を削除する
+  - virtual = true は pip version 24 からはデフォルトが wheel が削除されるようになったための暫定対応だった
+  - そのために pyproject.toml の `build-system.requires` に wheel と setuptools を指定する
+  - @zztkm
+- [FIX] サンプルアプリで 1080p の映像を送信すると 2-3 FPS しか出ないのを修正
+  - ビデオキャプチャの設定に FOURCC と FPS を設定するようにする
+  - 初期値は "MJPG", 30 を設定し、`.env` の `SORA_VIDEO_FOURCC`, `SORA_VIDEO_FPS` で変更可能とする
+  - @melpon
+- [FIX] Ubuntu 20.04 arm64 NVIDIA Jetson 5.1.2 で AV1 が正常に配信されない問題を修正
+  - Sora C++ SDK のバージョンを `2024.6.0` に上げることで解消
+  - @enm10k
+
 ## 2024.1.0
 
 **2024-02-20**
@@ -72,6 +107,9 @@
 - [FIX] `pyproject.toml` の `[rye.tool]` に `virtual = true` を追加する
   - これで Windows ビルド失敗の原因である `--e file:.` が消える
   - @voluntas
+- [ADD]H.265 に対応
+  - Sora C++ SDK のバージョンアップに伴い macOS で H.265 が利用可能になる
+  - @voluntas @miosakuma
 
 ## 2023.3.1
 

CMakeLists.txt

@@ -55,7 +55,6 @@ if(TARGET_OS STREQUAL "windows")
 endif()
 
 find_package(Boost REQUIRED COMPONENTS json filesystem)
-find_package(Lyra REQUIRED)
 find_package(WebRTC REQUIRED)
 find_package(Sora REQUIRED)
 find_package(nanobind CONFIG REQUIRED)
@@ -133,10 +132,3 @@ endif()
 target_link_libraries(sora_sdk_ext PRIVATE Sora::sora)
 
 install(TARGETS sora_sdk_ext LIBRARY DESTINATION .)
-install(
-  FILES
-  ${LYRA_DIR}/share/model_coeffs/lyra_config.binarypb
-  ${LYRA_DIR}/share/model_coeffs/lyragan.tflite
-  ${LYRA_DIR}/share/model_coeffs/quantizer.tflite
-  ${LYRA_DIR}/share/model_coeffs/soundstream_encoder.tflite
-  DESTINATION model_coeffs)

NOTICE.md

@@ -551,9 +551,9 @@ shall be binding upon assignees.
 ###############################################################################
 ```
 
-## oneVPL
+## Intel VPL
 
-https://github.com/oneapi-src/oneVPL
+https://github.com/intel/libvpl
 
 ```
 MIT License
@@ -578,202 +578,3 @@ 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.
 ```
-
-# Lyra
-
-https://github.com/google/lyra
-
-```
-Copyright 2022 Google LLC
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-```
-
-```
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-```

README.md

@@ -46,7 +46,7 @@ Please read https://github.com/shiguredo/oss/blob/master/README.en.md before use
 
 ## サンプル集
 
-[Sora Python SDK サンプル集](https://github.com/shiguredo/sora-python-sdk-samples)
+[examples](examples)を参照してください。
 
 ## sora_sdk パッケージの追加
 
@@ -83,6 +83,7 @@ $ rye sync
 
 - Sora の機能へ追従
 - VP8 / VP9 / AV1 / H.264 / H.265 のハードウェアアクセラレーター (HWA) 対応
+  - [各プラットフォームで利用可能な HWA への対応](https://github.com/shiguredo/sora-cpp-sdk?tab=readme-ov-file#%E7%89%B9%E5%BE%B4)
 - OpenH264 を利用した H.264 のソフトウェアエンコーダー/デコーダーへの対応
 
 ## 優先実装

VERSION

@@ -1,6 +1,5 @@
-SORA_CPP_SDK_VERSION=2024.1.0
-WEBRTC_BUILD_VERSION=m120.6099.1.2
-BOOST_VERSION=1.83.0
-LYRA_VERSION=1.3.0
+SORA_CPP_SDK_VERSION=2024.6.0
+WEBRTC_BUILD_VERSION=m122.6261.1.0
+BOOST_VERSION=1.84.0
 CMAKE_VERSION=3.28.1
 OPENH264_VERSION=v2.4.1