Genvid SDK 1.29.0

Genvid SDK 1.29.0 へようこそ。このリリースで、安定した状態で統合を行うことができ、ローカルでの開発や、限定したクラウドでのデプロイに使用することができます。プロダクションを完全にデプロイするための一部の機能はまだ実装されていませんが、他のソフトウェアによって提供可能です。プロダクションのデプロイを予定している場合は、support@genvidtech.com にお問い合わせください。

私たちは、快適な製品展開のためにすべての機能を完成させるまで、定期的にリリースを行うことをお約束します。私たちは常に、リリース間のスムーズなアップグレードを保証し、可能な限りの後方互換性サポートを提供するよう努力しています。既知の問題と回避策の完全なリストは、弊社の Forum に掲載されています。何か問題がありましたら、ご連絡ください。

現在ご利用になれる機能

現在の機能の概要を紹介します。本リリースの新機能一覧は以下の 主な修正と変更 を参照してください。

  • ビデオとゲームデータストリームの自動同期。
  • YouTube および Twitch へのライブ動画配信。
  • 埋め込み型 Web ページ用 Javascript SDK。
  • オーディオ/ビデオおよびデータの複数のソース。
  • 任意の追加ゲームイベントおよび通知のライブ配信。
  • スケーラブル イベント メッセージ システム。
  • Windows C++ API、C# ラッパー。
  • ビデオエンコード (H264 + AAC)。
  • Unity3D 統合 (ゲームと管理)。
  • Unreal Engine 統合 (ゲームと管理)。
  • D3D11 または未処理フレームのビデオキャプチャ。
  • WASAPI オーディオキャプチャ。
  • ローカル、リモートクラスタの管理用ツール、スクリプト。AWS および Azure 用サンプルスクリプト。
  • ライブ動画編集と基本コンポジション効果 (ベータ版)。
  • RTMP Ingest サーバー (ベータ版)。
  • サービス制御用 REST API (ベータ版)。
  • メトリクス フィード (ベータ版)。
  • 負荷テスト用ライブラリ。
  • 複数の統合サンプル。
  • 詳細な解説書。

主な修正と変更

ツールボックスの SSL サポート

ツールボックスに新しい genvid-sdk generate-ssl コマンドを追加し、SSL に対応しました。Vault を CA (Certificate Authority) として使用する証明書を作成することができます。 bastion 設定スクリプト (genvid-bastion install) が Vault を設定し、新しいコマンドを使って証明書を作成できるようにします。

何らかの理由で Vault の設定が bastion のデフォルト設定から除外されていた場合、 genvid-bastion setup-vault-engines コマンドを使って必要な設定を Vault に追加することができます。

詳細は 解説書 を参照してください。

Unity 2020.3 LTS 公式サポート

Genvid SDK が Unity LTS バージョン 2020.3 を公式サポートするようになりました。

その他変更点や修正点

  • [解説書] build.py C-Sharp ラッパーのコメントにカッコを追加。
  • [解説書] 「Nomad Configuration」 セクションの local-services フォルダの参照先を訂正。
  • [解説書] 「Game Integration」 セクションの「はじめに」に、必要な global-tools リストを追加。
  • [sdk] クラッシュや例外がログに表示されない問題を修正。
  • [sdk] ユーザーコールバックで bad_alloc の例外が発生した後、ソケットのクローズに失敗する問題を修正。
  • [ツールボックス] general-ssl に TLS 証明書を生成させるコマンド genvid-sdk を追加。
  • [ツールボックス] bastion のセットアップ中に JSON ファイルから PKI ロール情報を読み込むために、 genvid-bastion install コマンドに PKI ロールのセットアップを追加。
  • [ツールボックス] bastion を再インストールせずに Vault のシークレットエンジンを有効にしてロールを適用するためのコマンド setup-vault-enginesgenvid-bastion に追加。
  • [ツールボックス] load_config_template メソッドをベースクラス ConsulTemplateTool から利用できるようにして利用性を向上させました。
  • [ツールボックス] ベースクラス BaseTool から merge_dict メソッドを使用できるように改善しました。
  • [ツールボックス] 非推奨のクラス ClusterTool を廃止し、 BastionTool を改善。
  • [ツールボックス] メソッド ClusterAPI.load_project_definition を廃止。このメソッドに関連する API は動作しなくなります。
  • [ツールボックス] ローカル bastion の起動時に、他のサービスがすでに実行されているかどうかを検出してしまう問題を修正。
  • [ツールボックス] ローカル bastion のインストール時に、空の Vault キーで Vault を初期化しようとしたときのエラーメッセージを改善。
  • [ツールボックス] genvid-azure-image create-images コマンドを呼び出したときに、 「ContainerNotFound」 および 「Storage not found」 というエラーが発生する問題を修正。
  • [gvencode] ユーザーがコンポジションを有効にしたときに、オーディオとビデオの同期が解除される問題を修正。
  • [gvencode] 受信したオーディオ/ビデオストリームがズレている場合、 gvencode がオーディオフレームを破棄する問題を修正。
  • [gvencode] 受信したオーディオ/ビデオ配信が同期していない場合、 gvencode がオーディオフィードが損失する問題を修正。
  • [gvencode] ソース間で安定したフレームレートを確保することで、オーディオストリームの一貫性を向上。
  • [gvencode] ゲームを再起動したときに、ゲームストリームにオーディオ/ビデオの非同期が蓄積される問題を修正。
  • [gvencode] オーディオリフレーマーフィルターで、ビデオと同じ FPS を取得できない問題を修正。
  • [gvencode] RemoteGUI のメトリクスと情報に、Source Filter の入力と出力の周波数を表示する機能を追加。
  • [bastion-api] @ を含む Terraform モジュールのパスが機能しない問題を修正。
  • [studio] ユーザーが警告メッセージを発動させたときに、自動的に警告メッセージが消えない問題を修正。
  • [studio] 長時間使用すると Studio の Web ページがフリーズする問題を修正。
  • [studio] Genvid Studio サービスのシーンに関する非推奨情報の削除に関する解説書を更新。
  • [ingest] オーディオがビデオと同じレートで送信されない問題を修正。
  • [ue4-plugin] UE4 プラグインが、提供されたデータストリームのフレームレートを Genvid DLL に伝達しない問題を修正。
  • [nats] パッケージに期待したファイル名が含まれていない場合に、 Windows のインスタンス上のクラウドクラスタで nats-window ジョブが開始されない問題を修正。
  • [aws,azure] ゲームマシンの Python を 3.5.4 から 3.8.6 にアップグレード。
  • [aws,azure] ゲームマシンの PIP (ピクチャ・イン・ピクチャ) を 9.0.3 から 21.1.2 にアップグレード。
  • [bastion] bastion の初期設定を bastion-services/init に追加。これにより、 bastion ジョブの開始前に新しい設定変数を追加することができます。

既知の問題

プロキシを使用している場合に Compose ウィンドウが使用できない。

Bastion の将来のバージョンには、異なるマシンからのアクセスを許可するリモートサーバーが追加されます。現行バージョンではこの機能を限定的にサポートしており、Bastion ホストがクラスタファイアウォールに守られている場合に (Amazon EC2 マシンなど)、問題が発生することがあります。

回避方法としては、マシンのローカル IP がクライアントマシンからアクセスできるように、Bastion マシンへの VPN 接続を行うことです。

Firefox でのスタンドアロンプレイヤーが動作しない。

読み込み可能なストリームを Firefox で有効にする必要があります。about:config URL で、 dom.streams.enabledjavascript.options.streams のプリファレンスを有効にする必要があります。

オートカットのチェックボックス設定はローカルにのみ保存されます。

Studio では、Scene Widget 内の自動カットチェックボックスの設定はローカルストレージにのみ保存されます。ブラウザのキャッシュがクリアされるとユーザーからの入力もクリアされます。また、Studio セッション終了時に自動カットが 「on」 になっている場合は、Studio セッションを再び開始すると、デフォルトで 「off」 に戻ります。

オーディオがマイクの音声やループを無限にキャプチャする。

WASAPI のオーディオ自動キャプチャモードを使用した時に、マシンのデフォルトのオーディオ-デバイスを通過するサウンドがすべてキャプチャされてしまいます。これには、システムアラートやマイク入力だけでなく、Web ブラウザも含まれます。ゲームを実行しているのと同じローカルマシンを使用してゲームストリームをテスト視聴すると、ゲームは自分自身のオーディオストリームを~10秒の遅延でキャプチャします。これが次第に音質が劣化する (ストリーミングされる度に圧縮されるため) エコーを生み出します。

オーディオを無効にするには、次の 2 つの方法があります。

  • 設定で settings.encode.input.silenttrue にする。 (デフォルト設定をする。)
  • raw オーディオキャプチャを使用する (Unity のデフォルト設定)。

Nomad を使用して起動していない場合、Genvid SDK が統合されたアプリケーションは一度に 1 つしか実行できません。

Genvid SDK を使用したアプリケーションを Nomad を使用せずに起動した場合、デフォルトのセッション名が割り振られます。Unity エンジンや Unreal エンジンでアプリケーションをテストするときや、アプリケーションを手動で起動するときに便利です。

現在、環境変数 GENVID_SESSION_NAME をユニーク名に変更していない場合、Genvid SDK は、この方法で起動した複数のアプリケーションをサポートできません。Nomad を使用してアプリケーションを起動することで、この問題を回避することもできます。

この問題は、今後のリリースで修正予定です。

Twitch および YouTube の同期について

テストにおいて、Twitch と YouTube でのライブ配信時に同期の問題が発生することを確認しています。詳細と回避策については Twitch および YouTube を参照してください。

Azure のレポートでは、要求されたインスタンスサイズが利用できない。

Azure では、ゲームマシン用の計算インスタンスタイプ Standard_NV6 を使用しています。一部のアカウントでは、このインスタンスタイプのプロモバージョンしか利用できません (Standard_NV6_Promo)。

Azure モジュールで Terraform のセットアップを行うと、エラーが発生することがあります。

The requested size for resource 'XXXX-game-1' is currently not available in location 'XXXX'

回避策としては、Terraform の設定ページで instance_game_typeStandard_NV6_Promo に変更し、コマンドページで Plan apply -> Apply を再度行ってください。

Twitch における iPhone の問題

iOS デバイス上では Twitch API は getPlaybackStats() 呼び出しの属性の値を返さないため、同期のパフォーマンスが不正確であったり、一貫性がなかったりすることがあります。

スタンドアロンプレーヤーでの iOS デバイスへのストリーミングは現在、機能していません。

スタンドアロンプレーヤーでの iOS デバイス (iPhones と iPads) へのストリーミングは現在、機能していません。この問題は、今後のリリースで修正予定です。

インターネットの接続速度が遅いと、Ingest の実行中にゲームデータが非同期になることがあります。

Ingest で Studio を実行している場合、インターネット接続の速度が低下すると、ゲームデータがビデオストリームから非同期化されることがあります。スローダウンが解消すると、ゲームデータはビデオストリームに再同期されます。

Azure でアベイラビリティゾーンを変更する際には、リソースを破壊して再構築する必要があります。

Azure で AZ を変更する際に、パブリック IP が仮想マシンから切り離されていないため、パブリック IP の削除に失敗することがありました。これは、Terraform プロバイダのバグです。詳しくは、Hashicorp Github の issue をご覧ください。

回避策としては、問題のあるパブリック IP を Azure ポータルの仮想マシンから手動で切り離します。

ツールボックスは Python 3.9.x との完全な互換性はありません。

Genvid ツールボックスは、現時点では Python 3.9.x との完全な互換性はありません。ツールボックスを使用する際の問題を避けるため、Python をバージョン 3.8.x にダウングレードすることをお勧めします。

genvid-sdk upload-images-sdk コマンドが、Azure Cloud 上での Docker イメージのアップロードに失敗します。

一部の Docker イメージは、サイズが大きいため、 genvid-sdk upload-images-sdk コマンドを使用して Azure Cloud にアップロードできません。(SSL エラーと Max retries exceeded のメッセージが表示されます)。

回避策:

  1. Azure UI を開きます。
  2. イメージを手動でアップロードします。
  3. もう一度 genvid-sdk upload-images-sdk を起動します。

Chroma Key Filter 使用時のパフォーマンスの問題

Chroma Key Filter を使用する場合、エンコードマシンには c5.4xlarge 以上のものを使用することをお勧めします。性能の低いインスタンスでは、システムがいくつかのフレームをメモリに蓄積することになり、メモリ不足となる場合があります。

蓄積されるフレームの量は、エンコードパラメータ、ソースの FPS、ソース画像の内容の変化、内容の密度など、さまざまな要因に左右されます。 GVEncode のメモリー使用量の監視については、Hashicorp documentation を参照してください。

既存の AWS クラスタでサブドメインを更新する際に、サブドメイン NS レコードを手動で削除する必要があります。

basic_cluster_alb_ssl または minimal_cluster_alb_ssl を使用して AWS クラスタを作成する場合、ドメインとサブドメインが提供されます。既存クラスタのサブドメインを更新する場合、以前のサブドメインの route53 の NS レコードをメインドメインから手作業で削除する必要があります。これは Terraform 内での NS レコードの処理のためです。

AWS を使用しているクラスタ basic_cluster_alb_ssl のサブネットを削除できません。

basic_cluster_alb_sslsubnet_cidr_block_size を変更したり、AZ の数を減らしたり、既存の AZ を並べ替えたりすると、クラスタはサブネットを削除しようとして止まってしまいます。

設定を再適用しても、問題は解決しません。

回避策: クラスタを削除して作り直してください。

Bastion クラスタの設定ページのモーダルウィンドウが閉じない。

クラスタの Bastion 設定 ページで、クリックしても、カスタムタグの Properties モーダルウィンドウが閉じない。

回避策としては、もう一度 Properties をクリックしてモーダルウィンドウを閉じてください。

Terraform をアップグレードすると 『Error: Failed to query available provider packages』 が発生します。

既存のクラスタを Terraform 0.14 にアップグレードする場合、Error: Failed to query available provider packages が発生することがあります。Terraform のロックファイルを %USERPROFILE%.genvidterraformworkdir{cluster name}tf から削除してクラスタを初期化しなおすと解決することができます。

制限事項

誤った順序で設定をロードすると、値が上書きされることがあります。

クラウド上で SSL を使用している場合でも、ローカルクラスタで SSL を使用している場合でも、Web サンプルを読み込む前に youtube.sample.hcl を読み込むと、Web サンプルは web.hcl ファイルから embed_ssl に関連付けられた値を上書きします。

NTP の時間オフセットが大きいと、ストリームの再生ができなくなります。

大きな NTP 時間オフセットが発生した場合、ストリームの再生が停止する可能性があります。回避策としては、ゲーム機が自動的に時計を更新するように設定されていることを確認してください。ローカル設定では、AWS IP アドレスを pool.ntp.org に置き換えてください。

詳細については、 AWS 設定セクション を参照してください。

Studio は、複数のウィンドウから同じコントロールの入力を受け取ることはできません。

Studio が、複数のブラウザウィンドウで開かれていて、異なるソースから 1 つのコントロールに入力を受信した場合、最後の値は最新のものに更新されるのではなく、異なる入力間でバウンスされます。たとえば、Audio Mixer Widget でユーザーが Master Gain のスライダを 20 db に変更し、別のユーザーが 0 db に変更した場合、スライダハンドルは 0 db に設定される代わりに 20 db と 0 db の間でバウンスします。

この問題が解決されるまで、複数の Studio ウィンドウから 1 つのコントロールへ入力することはお勧めできません。

Windows がスリープ状態から復帰後、アプリケーションが正常に動作しない。

Nomad は、それ自体も含み、スリープ中のジョブで問題が発生する場合があります。Nomad 側で修正される可能性は低いものの、プロダクション環境では発生しません。最善の回避方法としては、サービス実行中は Windows がスリープ状態にならないようにするか、 genvid-bastion reinstall でサービスを開始しなおすことです (genvid-bastion restart だけでは不十分です)。

SDK はフレームレートを 1.0 以下に固定します。

問題を回避するためにストリームのフレームレートを 1.0 に下げました。フレームレートが 1.0 以下の場合は、SDK が 1.0 FPS に固定します。

Azure リソースグループ名のデフォルト値が長すぎる場合がある。

変数 resource_group_name に値が設定されていない場合、 {bastionid}-{clustername} の組み合わせで設定されます。そのため、Azure リソースグループ名が最大文字数である 64 文字よりも長くなってしまう場合があります。

この問題を避けるために、変数 resource_group_name には必ず 64 文字以下の値を指定してください。

Azure での命名についての詳細は Azure Github を参照してください。

AWS クラスタサブネットの競合エラー

AWS クラスタの subnet_cidr_block_size を減らして AZ 数を増やすことを同時に行うと、サブネットの競合エラーが発生します。

この問題が発生した場合、設定を適用しなおしてください。

クラスタの更新時に、Azure ディスクに新しいタグが追加されない。

新しいタグを Azure クラスタに適用する際、ディスクを所有する仮想マシンインスタンスが apply プロセス中に再作成されない限り、 disk にタグは適用されません。

回避策としては、クラスタを削除して再作成することで問題が解決します。

クラスタ名は 64 文字までです。

クラスタ名は、Windows のファイルシステムの制限により、64 文字に制限されています。ファイルディレクトリの最大文字数には、システムのユーザー名やクラスタ名などが影響します。

技術的には 64 文字以上にすることは可能ですが、結果は予測できないものになります。