WebRTC Native Client Momo

About Shiguredo's open source software

We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.

Please read https://github.com/shiguredo/oss/blob/master/README.en.md before use.

時雨堂のオープンソースソフトウェアについて

利用前に https://github.com/shiguredo/oss をお読みください。

WebRTC Native Client Momo について

WebRTC Native Client Momo は libwebrtc を利用しブラウザなしで様々な環境で動作する WebRTC ネイティブクライアントです。

https://momo.shiguredo.jp/

ハードウェアエンコーダへの対応

• NVIDIA Jetson に搭載されている VP8 や VP9 や H.264 ハードウェアエンコーダー機能を利用することで [email protected] での配信が可能です
• Raspberry Pi の GPU に積まれている H.264 ハードウェアエンコーダー機能を利用することが可能です
• Apple macOS に搭載されている H.264 ハードウェアエンコーダー機能を VideoToolbox 経由で利用することが可能です
• NVIDIA グラフィックスカードに搭載されている H.264 ハードウェアエンコーダー機能を NVIDIA VIDEO CODEC SDK 経由で利用することが可能です

4K 30fps での配信

Momo はハードウェアエンコーダを利用することで WebRTC で 4K 30fps の配信を実現可能です

サイマルキャストへの対応

Momo は Sora モード利用時にサイマルキャスト（複数画質の同時配信）に対応しています。

データチャネル経由でのシリアルの読み書き

Momo はデータチャネルを利用しシリアルに直接読み書きが可能です。信頼性より低遅延を優先したい場合の利用を想定しています。

SDL を利用した音声や映像の受信

Momo を GUI 環境で利用した場合、Simple DirectMedia Layer を利用して音声や映像の受信を行うことができます。

AV1 への対応

Momo 同士で SDL 機能を利用して libwebrtc が対応している AV1 が利用可能です。

動画

WebRTC Native Client Momo と Jetson Nano で [email protected] 配信

OpenMomo プロジェクトについて

OpenMomo は WebRTC Native Client Momo をオープンソースとして公開し継続的に開発を行っていくプロジェクトです。 ブラウザやスマートフォン以外からの WebRTC をいろいろな用途で使ってもらえればと思っています。

詳細については下記をご確認ください。

OpenMomo プロジェクト

また Momo についてのつぶやきは以下にまとめてあります。

https://gist.github.com/voluntas/51c67d0d8ce7af9f24655cee4d7dd253#twitter

既知の問題について

既知の問題に対する解決方針

バイナリ提供について

以下からダウンロードが可能です。

https://github.com/shiguredo/momo/releases

動作環境

• Raspberry Pi OS (32bit) ARMv7
  • Raspberry Pi 4
  • Raspberry Pi 3
  • Raspberry Pi 2
• Raspberry Pi OS (32bit) ARMv6
  • Raspberry Pi Zero
  • Raspberry Pi 1
• Ubuntu 18.04 x86_64
• Ubuntu 20.04 x86_64
• Ubuntu 18.04 ARMv8 Jetson
  • NVIDIA Jetson Nano
  • NVIDIA Jetson Xavier NX
  • NVIDIA Jetson AGX Xavier
• macOS 11 x86_64 以降
  • 2021 年内に終了予定
• macOS 11 arm64 以降
• Windows 10.1809 x86_64 以降

以下はビルドが通ること以外は確認していません

• Raspberry Pi OS (64bit) ARMv8
  • Raspberry Pi 4
  • Raspberry Pi 3
  • Raspberry Pi 2

使ってみる

Momo を使ってみたい人は USE.md をお読みください。

ビルドする

• Linux 版 Momo のビルドしたい人は BUILD_LINUX.md をお読みください
• macOS 版 Momo のビルドしたい人は BUILD_MACOS.md をお読みください
• Windows 版 Momo のビルドしたい人は BUILD_WINDOWS.md をお読みください

パッケージを作成する

パッケージ作成したい人は PACKAGE.md をお読みください。

FAQ

FAQ.md をお読みください。

バージョン番号について

YYYY.RELEASE[.FIX]

• YYYY は年
• RELEASE はその年にリリースした回数
• FIX はオプションでバグフィックス対応のみのアップデートに利用

ライセンス

Apache License 2.0

Copyright 2015-2021, tnoho (Original Author)
Copyright 2018-2021, Shiguredo Inc.

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.

優先実装

優先実装とは Sora のライセンスを契約頂いているお客様限定で Momo の実装予定機能を有償にて前倒しで実装することです。

• Windows 版 OSS 化
  • スロースネットワークス株式会社 様
• WebRTC's Statistics 対応
  • 現時点では企業名非公開
• Windows 版 Momo NVIDIA VIDEO CODEC SDK 対応
  • スロースネットワークス株式会社 様
• Linux 版 Momo NVIDIA VIDEO CODEC SDK 対応
  • 株式会社オプティム 様
• Windows / Linux 版 スクリーンキャプチャ対応
  • スロースネットワークス株式会社 様

優先実装が可能な機能一覧

詳細は Discord やメールなどでお気軽にお問い合わせください

• Jetson AGX Xavier 対応
  • H.265 ハードウェアエンコーダ対応
  • H.265 ハードウェアデコーダ対応
• Jetson Xavier NX 対応
  • H.265 ハードウェアエンコーダ対応
  • H.265 ハードウェアデコーダ対応
• Jetson Nano
  • H.265 ハードウェアエンコーダ対応
  • H.265 ハードウェアデコーダ対応
• Raspberry Pi 4
  • H.265 ハードウェアデコーダ対応
• AV1 対応
  • Windows
• 統計機能
  • Ayame のシグナリング 経由での出力
• NVIDIA VIDEO CODEC SDK
  • VP8 / VP9 / H.264 ハードウェアデコーダ対応
    • Ubuntu 20.04
    • Ubuntu 18.04
    • Windows 10
  • MotionJPEG ハードウェアデコーダ対応
    • Ubuntu 20.04
    • Ubuntu 18.04
    • Windows 10
• Intel Media SDK 対応
  • VP8 / VP9 / H.264 / H.265 ハードウェアエンコーダ対応
• 録画対応
  • MP4 形式での出力
  • WebM 形式での出力
• 録画合成対応
• Sora モード利用時の E2EE 機能
• Windows / macOS 署名対応

Momo についての電子書籍

Momo の原作者である @tnoho が書いた Momo のノウハウが沢山詰まった本が販売されています。

WebRTCをブラウザ外で使ってブラウザでできることを増やしてみませんか?(電子版) - でんでんらぼ - BOOTH

サポートについて

Discord

• サポートしません
• アドバイスします
• フィードバック歓迎します

最新の状況などは Discord で共有しています。質問や相談も Discord でのみ受け付けています。

https://discord.gg/gmEuZye

バグ報告

Discord へお願いします。

有料でのテクニカルサポートについて

WebRTC Native Client に対する有料でのテクニカルサポート契約については WebRTC SFU Sora ライセンス契約をしているお客様が前提となります。

• Momo のテクニカルサポート
• OSS 公開前提での Momo への機能追加

H.264 のライセンス費用について

H.264 ハードウェアエンコーダ のみ を利用している Momo 単体の配布においてはライセンス費用は不要ですが、 ハードウェアとセットで配布する場合はライセンス費用を支払う必要があります。

ただし、 Raspberry Pi においては H.264 のライセンスがハードウェア費用に含まれているため、 配布時にライセンス費用を支払う必要はありません。

詳細については MPEG LA まで問い合わせる事をおすすめします。

• Raspberry Pi のハードウェアエンコーダのライセンス費用は Raspberry Pi の価格に含まれています
  • https://www.raspberrypi.org/forums/viewtopic.php?t=200855
• Apple のライセンス費用は個人利用および非商用利用目的に限るため、配布においては別途、団体との契約が必要
  • https://store.apple.com/Catalog/Japan/Images/EA0270_QTMPEG2.html
• AMD ビデオカードのハードウェアエンコーダのライセンス費用は別途、団体との契約が必要
  • https://github.com/GPUOpen-LibrariesAndSDKs/AMF/blob/master/amf/doc/AMF_API_Reference.pdf
• NVIDIA ビデオカードのハードウェアエンコーダのライセンス費用は別途、団体との契約が必要
  • https://developer.download.nvidia.com/designworks/DesignWorks_SDKs_Samples_Tools_License_distrib_use_rights_2017_06_13.pdf
• NVIDIA Jetson Nano のハードウェアエンコーダのライセンス費用は別途、団体との契約が必要
  • NVIDIA Jetson Nano 搭載の H.264/H.265 ハードウェアエンコーダのライセンスについて
• Intel Quick Sync Video のハードウェアエンコーダライセンス費用は別途、団体との契約が必要
  • QuickSync - H.264 patent licensing fees