CRIWARE Unreal Engine 4 プラグインマニュアル

はじめに

「CRIWARE Unreal Engine 4 プラグイン」は、CRIのミドルウェア製品(「CRIWARE」)を Unreal Engine 4 プラットフォームで動作するようポーティング・カスタマイズした製品です。 本製品には Unreal Engine 4 向け「CRI ADX2」、「CRI Sofdec2」、「ファイルマジックPRO」が含まれています。

本製品の商用版と無償版の違いについて

無償版 CRIWARE Unreal Engine 4 プラグイン (LE) は、商用版プラグインとほぼ同等の機能を利用することができます。
本マニュアルの記述内容の大部分は、無償版プラグインの使用に際しても適用できます。ただし下記の点に注意してください。
  • 商用版プラグインで再生する ADX2 データは、 商用版オーサリングツール CRI Atom Craft でビルドする必要があります
  • 無償版プラグインには CRI ファイルマジックPRO および CRI Sofdec2 相当の機能は利用できません
  • 本マニュアルは無償版製品では使用できない機能の説明も含みます。

最近のトピックス

CRIWARE SDK for UE4 v1.29.00.00 をリリースしました

開発環境

Unreal Engine 4.26.2 に対応しました。

仕様変更

従来のシーケンサ関連の機能実装をまとめて、 CriWareCinematics プラグインとして分離しました。 シーケンサ関連機能を使用しないユーザは CriWareCinematics プラグインをインストールしないことを選べます。 CRIWARE UE4 Plugin の従来のインストール方法・使用方法に変化はありません。

機能追加

空間音響接続機能「3Dトランシーバー」に対応

CRI ADX2 の空間音響接続機能「3Dトランシーバー」を使用するためのインタフェースを追加しました。 3Dトランシーバ機能は3Dポジショニングの仮想空間上で音声をサブミックスし、一点から出力する機能です。
atom_transceiver_overview.png
本機能を利用することで、閉じられた空間内に存在する音を開口部からまとめて出力することが可能になります。 逆に、リスナーが閉じられた空間に侵入した場合には外の世界の音を入り口に集約して出力することができます。
また、3Dトランシーバーから出力される音声にエフェクトを掛けることも可能です。 例えば、屋内から漏れ聞こえる音にローパスフィルタを掛けることで、疑似的な音響遮蔽の表現が可能になります。
CRIWARE UE4 Plugin では本機能をプログラムレスで使用するためのブループリントクラス AtomTransceiverBox を提供しています。 このブループリントアセットをコンテンツブラウザからドラッグアンドドロップしてマップに配置するだけで、3Dトランシーバ機能を使用することができます。
atom_transceiver_visualize.png
詳細は 3Dトランシーバー を参照してください。

Sofdec2 ムービをシーケンサに対応

Sofdec2 ムービの再生制御をシーケンスエディタ上から行うためのインタフェースを追加しました。
criware_ue4_mana_sequencer7_L.jpg
詳細は シーケンサー上でのムービー再生 を参照してください。

シーケンサ上での音声再生制御機能を強化

  • AttenuationSettings を設定するためのインタフェースを追加しました
  • AtomTrack を Actor にアタッチするためのインタフェースを追加しました
  • Actor のサブトラックに AtomTrack をアタッチするためのインタフェースを追加しました
criware_ue4_030_sequencer_aisac_control.png

詳細は シーケンサーとの連携 を参照してください。

CRIWARE SDK for UE4 v1.28.01.01 をリリースしました

機能追加

SpawnAtomSound系ノード/関数

SpawnAtomSound系ノード/関数を追加しました。
AtomComponent(任意のパラメータ設定済み)を生成・再生できるようになりました。
例えばAtomComponent(特定のセレクタラベル設定済み)を生成・再生する…といったことが可能です。
詳細については「 Spawn系ノード/関数 」をご参照ください。

CRIWARE SDK for UE4 v1.28.01.00 をリリースしました

機能追加

コンテンツブラウザにおける CRI アセットの外観を改善

Atom キューアセットと ManaMovie アセットのサムネイル表示を改善しました。
Atom キューアセットでは、先頭波形がサムネイルにて表示されます。Cue Color プロパティにより表示色を変更可能です。

criware_ue4_030_content_browser_j.png


ManaMovie アセットでは、サムネイル上でムービの簡易プレビュー再生を行うことができます。

criware_ue4_mana_movie_asset_thumbnail.jpg

Atom CueSheet Import Dialog の機能強化

ACB ファイルのインポート時処理を選択できるインタフェース "Atom CueSheet Import Dialog" の外観と機能を更新しました。

criware_mana_ue4_acb_importer1_M.jpg
  • Atom CueSheet Import Dialog 上にリスト表示されたキューを選択して再生することができます
  • インポート元 ACB と同じパス上に同一名の AWB ファイルが存在する場合、UE4 プロジェクト内にコピーできます

詳細は Atom CueSheet Import Dialog の概要 を参照してください。

AtomComponent にキュー内埋め込みイベントコールバックのデリゲートを追加

AtomComponent に2つのデリゲート OnAtomSequenceCallback と OnAtomBeatSyncCallback を追加しました。 AtomCraft 上でキューに埋め込んだシーケンスマーカーやビート同期設定に合わせて、上記デリゲートが発火します。

  • OnAtomSequenceCallback:キュー内の任意のタイミングに埋め込んだシーケンスマーカーが検知されるたび、ユーザ定義の関数を実行できます
  • OnAtomBeatSyncCallback:キューのビートに合わせて任意の関数を実行することができます

これらデリゲートには Blueprint 上からもアクセス可能です。 詳細は キューのコールバックデリゲートの登録方法 を参照してください。 また、シーケンスマーカー、ビート同期設定の詳細については Atom Tools マニュアルを別途参照してください。

フォーカスポイント機能の新しい制御手段

フォーカスポイントを制御するための新たなインタフェースとして、フォーカスポイント情報とフォーカスポイント制御関数を追加しました。 従来のフォーカスポイントコンポーネントを使用せず、特定のリスナーに任意のアクタやシーンコンポーネントをフォーカスポイントとして設定することができます。 詳細は フォーカスポイント を参照してください。

リスニングポイントのデバッグ描画機能

フォーカスポイントに関連したデバッグ用可視化機能を追加しました。 詳細は リスニングポイントのデバッグ描画 を参照してください。

CRIWARE SDK for UE4 v1.28.00.06 をリリースしました

開発環境

Unreal Engine 4.26 に対応しました。

CRIWARE SDK for UE4 v1.28.00.02 をリリースしました

開発環境

Unreal Engine 4.25.1 に対応しました。

マニュアル

Atom CueSheet Import Dialog の説明を追加

CRIWARE UE4 Plugin v1.28.00.00 より追加した、 ACB ファイルのインポート時ウィンドウについての説明を追加しました。 正式名称は "Atom CueSheet Import Dialog" です。 詳細は Atom CueSheet Import Dialog の概要 をご確認ください。

Platform Sofdec2 Movie の説明を追加

CRIWARE UE4 Plugin v1.28.00.00 より追加した、 マルチプラットフォーム対応版 ManaMovie アセットについての説明を追加しました。 詳細は プラットフォームごとに異なるムービーの再生 をご確認ください。

CRIWARE SDK for UE4 v1.28.00.00 をリリースしました

開発環境

Unreal Engine 4.25.0 に対応しました。

機能追加

ACB ファイルの再インポートウィンドウを追加

ACB ファイルの再インポート時にキューアセットの更新方法を選択できるインタフェースを追加しました。 ACB ファイルを再インポートするとポップアップウィンドウが表示されます。

CRIWARE SDK for UE4 v1.27.11.00 をリリースしました

仕様変更

主要なクラスのリファイン

注意
本バージョンには複数の CRIWARE API に対するリネーム・置き換えなどの変更が含まれます。 旧バージョンの CRIWARE UE4 Plugin で開発したプロジェクトを本バージョンに更新する場合、 プロジェクト内の CRIWARE 関連アセットの一部情報が失われたり、 C++ コード、 Blueprint 等が コンパイルエラーとなる恐れがあります。
Ver.1.27.10.00 からの移行 を参照してください。
AtomComponent 、 SoundAtomCue 、 SoundAtomCueSheet といった、 CRIWARE UE4 Plugin の主要なサウンド関連クラスを大幅にリファインしました。 これに伴い、 下記のような変更が適用されています。

機能追加

Atom Audio Volume 機能を追加

UE4 サウンドの 3D 空間デザイン機能 AtomAudioVolume を追加しました。 リスナーの位置に応じて3D音源のパラメータを変化させる領域を、 3D 空間上に直接指定することができます。 変化の強さは AtomAudioVolume の境界面とリスナーの距離に対応します。 本機能は 実験的な機能 です。
atom_audio_volume_distance_to_apply.jpg

Area Sound Volume 機能を追加

3D 環境音 デザイン機能 AreaSoundVolume を追加しました。 湖なら水音、林なら鳥の声といった、広い範囲に渡って環境音が聞こえる領域を、 3D 空間上に直接指定することができます。 本機能は 実験的な機能 です。
area_sound_volume_sample_image.jpg

ManaMovie アセットのマルチプラットフォーム対応

PlatformManaMovie アセットを新規追加しました。 プラットフォーム別に異なる USM ファイルパスを設定可能な ManaMovie アセットです。

バージョニングルールの明示

本バージョンより、CRIWARE UE4 Plugin の新たなバージョニングルールを明示しました。 詳細は バージョニングルール をご確認ください。

CRIWARE SDK for UE4 v1.27.10.00 をリリースしました

機能追加

CRI ADX LipSyncによる口パターン解析機能を追加

CRI ADX LipSync を CRIWARE UE4 Plugin と連携して利用できるようになりました。
UAtomComponent と連携して再生音声をリアルタイム解析し、口形状情報を取得可能です。
キャラクターモデルのメッシュに設定されたモーフターゲットに対して、口形状情報を適用することでリップシンクを表現できます。
CRI ADX LipSync は、Expansion プラグイン "CRIWARE ADX LipSync Plugin" として本SDKに同梱されています。 詳しくは「 ADX LipSync Library 」を参照してください。
また本SDKには、音声データを解析してテキスト形式で口パクデータを出力する事前解析用コンソールツールも含まれています。 コンソールツールの利用方法については、専用のマニュアルをご確認ください。
cri/tools/ADXLipSync/manual/ja/ADX_LipSync_Tool_Manual_ja.html

仕様変更

カリング機能

カリング機能の設定方法として新しいワークフローが導入されました。
また、従来の設定方法は非推奨となりました。
詳細については「 距離に応じたサウンド再生処理のカリング 」をご参照ください。

PlaySoundAttached関数

下記のAPIは非推奨に設定されています。
  • UAtomStatics::PlaySoundAttached関数
    また、上記関数は将来的に廃止致します。
    廃止時期は弊社プラグイン(UE4.25対応版)リリース時を予定しております。
    上記関数の代わりに下記の関数をご利用頂きますようお願い申し上げます。
  • UAtomStatics::SpawnSoundAttached関数

FCriWareApiネームスペース

「FCriWareApi::」の省略方法として新しいアプローチが導入されました。
また、従来の方法は非推奨となりました。
詳細については「 CriWareApiクラスについて 」をご参照ください。

機能追加

  • UE4エディタ側でループ情報を上書きする機能を追加しました
  • 処理負荷を下げるための新機能を追加しました
    • 詳細については「 Economic-Tick 」をご参照ください

CRIWARE SDK for UE4 v1.27.00.05 をリリースしました

ツール更新

CRI Atom Craft V3 アップデート

CRIWARE SDK for UE4 に同梱される CRI Atom Craft が Ver.3.43.00 へアップデートされました。
CRI Atom Craft Ver.3.43.00 から、ライセンスの取得・認証をオンラインで行うよう変更しました。
この変更に伴い、ライセンスの取得を行うための CRI Authorization Tool を SDK パッケージに同梱するようにしました。
また、CRI Atom Craft で作成したデータを商用利用するための「プロジェクトキー」が必要になります。

これらの更新についての詳細は弊社テクニカルサポートサイトにログインの上、「 ライセンス認証システムの手引き 」を参照してください。
覚え書き
CRIWARE SDK for UE4 Ver.1.27.00.05 以降、旧版のツール(CRI Atom Craft V2)はパッケージに含まれなくなります。
必要な場合は別途、「CRI Atom Craft V2 単体パッケージ」をテクニカルサポートサイトからダウンロードしてください。

波形ファイルビューア「CRI Solv」を追加

波形ファイルをリスト形式でブラウジングするためのツール、CRI Solv の提供を開始しました。
CRI Solv は多くの波形ファイルの情報を一度に閲覧し、プレビューすることに特化しています。

cri_solv_overview.png

CRI Solv は以下のパスに配置されています。
  • //cri/tools/AudioUtility/CriSolv/CriSolv.exe

詳細については、「CRI Solvマニュアル」をご参照ください。
  • //cri/tools/AudioUtility/CriSolv/manual/jpn/index.html

「CRIWARE Unreal Engine 4 プラグイン」の学習にあたって

「CRIWARE Unreal Engine 4 プラグイン」を初めてご利用になる方には、「CRI ADX2(Unreal Engine4) チュートリアル」をご一読することをお勧めしています。
このチュートリアルに沿って学習を進めれば、本プラグインの使用方法を一通り習得することができます。
プラグインのインストール方法から解説していますので、マニュアルを一切読まずにチュートリアルを始めることができます。

本SDKに関連するドキュメント

  • CRIWARE_UE4_Plugin_Manual_j.html(本マニュアル)
    • CRIの音声ミドルウェアについて、さらに詳しい情報が知りたい場合はCRI ADX2マニュアルをご覧ください。
    • CRIの動画ライブラリについて、さらに詳しい情報が知りたい場合はCRI Sofdec2 マニュアルをご覧ください。
  • CRI Atom Craft のマニュアル
    • cri/tools/ADX2/ver.3/manual/jpn/contents/index.html に配置されています。CRI Atom Craft ツールについて詳しく記載されています。
    • オンライン版マニュアルも公開されています。