ADX2 for Unityで楽曲がリアルタイムに変化するBGMを再生（インタラクティブミュージック）

# はじめに

こちらは @SigRem とのコラボ記事です。「[ADX2 for UE4で変化するループBGMを再生する（UE4編）](https://qiita.com/SigRem/items/0a15d9a0adc90662d2a4)」の内容をUnityに移植したものです。

デモは次の通り。

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">Unity + <a href="https://twitter.com/hashtag/ADX2?src=hash&amp;ref_src=twsrc%5Etfw">#ADX2</a> で、トラックのミックスをシームレスに変化させる縦の遷移（Vertical Remixing）と、ループ楽曲を良いタイミングで切り替える横の遷移（Horizontal Resequencing）の組合わせ。明日記事公開します。楽曲は <a href="https://twitter.com/sleepyslowsheep?ref_src=twsrc%5Etfw">@sleepyslowsheep</a><a href="https://twitter.com/hashtag/%E3%82%B2%E3%83%BC%E3%83%A0%E9%96%8B%E7%99%BA?src=hash&amp;ref_src=twsrc%5Etfw">#ゲーム開発</a> <a href="https://twitter.com/hashtag/%E3%82%B2%E3%83%BC%E3%83%A0%E3%82%B5%E3%82%A6%E3%83%B3%E3%83%89?src=hash&amp;ref_src=twsrc%5Etfw">#ゲームサウンド</a> <a href="https://twitter.com/hashtag/%E3%82%A4%E3%83%B3%E3%82%BF%E3%83%A9%E3%82%AF%E3%83%86%E3%82%A3%E3%83%96%E3%83%9F%E3%83%A5%E3%83%BC%E3%82%B8%E3%83%83%E3%82%AF?src=hash&amp;ref_src=twsrc%5Etfw">#インタラクティブミュージック</a> <a href="https://t.co/tqJq2LYktT">pic.twitter.com/tqJq2LYktT</a></p>&mdash; ichijo (@Takaaki_Ichijo) <a href="https://twitter.com/Takaaki_Ichijo/status/1313512268663943168?ref_src=twsrc%5Etfw">October 6, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

![demo.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/19010/c3787cbe-f939-a146-ba80-0766d4d3b0a3.png)

キャラクターを操作して部屋を移動すると、BGMが変わっていきます。

## インタラクティブミュージックをゲームに導入しよう
ゲームのBGMは、単一の楽曲データがループするシンプルな表現にとどまらず、ゲーム内の状況に合わせてシームレスに変化する「インタラクティブミュージック」の導入が進んでいます。

「魔族の領域に入った」「戦闘状態になった」などのゲームのステージの変化によって曲が変わったり、「キャラクターが瀕死になった」「必殺技のためのエネルギーがチャージされた」といったキャラのステータスに連動して変化する、といった演出が見られます。

ざっくりといえば、異なるループ曲をクロスフェードして切り替えるのではなく、変化がシームレスに、かつつながった曲に聞こえるように処理してゲームを盛り上げる、それがインタラクティブミュージックです。

インタラクティブミュージックの実装方式は２通りあり、まずは「各楽器の音を別に出力して同期ループ再生させておき、ボリュームをリアルタイムに変化させる」というものです。
これはDAW上で縦に並んだ楽器ごとの音（トラック）に対して処理を行うため、「縦の遷移（Vertical Remixing）」とも呼ばれ、楽曲自体は一緒ですが、楽器が加わったり減ったり、それぞれの音量バランスが変わることで曲が変化していくことを表現します。

もうひとつは別のループ曲に切り替えるが、シームレスにつながるタイミングで切り替えを行ってつながった曲のように聞かせるものです。こちらはDAW上では横方向に別々のループを展開して作っていくため、「横の遷移（Horizontal Resequencing）」とも呼ばれています。

今回はこれら２つのインタラクティブミュージックの手法を両方取り入れたものを、ゲーム向けサウンドミドルウェアである「CRI ADX2」を使って実現します。

## CRI ADX2とは
ゲーム向けの統合型サウンドミドルウェアです。プロ用の有償製品と、同人・インディーゲームクリエイター向けの無償版「CRI ADX2 LE」があります。基本的な機能は両バージョンで同一です。

**CRI ADX2 LE**
https://game.criware.jp/products/adx2-le/

導入することで、大量のサウンドデータをさばいたり、複雑な音の演出をツールで組んでいくことができます。
Unityにおいてはモバイルゲームで多く利用されており、処理負荷を抑えた音声コーデックや、特にAndroid機器上での音の遅延を低減させる機能が支持されています。

そして、ADX2は前述した「インタラクティブミュージック」のための機能を持っています。ゲーム側からパラメータを受けとってトラックのミックスを変化させたり、別のループ音へ拍を合わせてジャンプする、といった難易度の高い処理を実装済みです。

今回はこの「インタラクティブミュージック」について、ゲーム内の状態に応じてループ楽曲の「曲調」と「テンション」を変化させていく見せ方をします。

CRI ADX2を全く触ったことが無い、という場合は下記のチュートリアル記事を先にご覧ください。

**Unityのサウンド機能をADX2で強化する**
https://qiita.com/Takaaki_Ichijo/items/16e6501fc07f5b3b3377

## ツール設定については別記事参照
本記事はUE4向けにかかれた実装紹介をUnityに移植したものです。CRI ADX2のツールである「Atom Craft」はUnityでもUE4でも使い方は同じであるため、Atom Craft側の設定については下記の記事の手順をそのまま行ってください。

**ADX2 for UE4で変化するループBGMを再生する（AtomCraft編）**
https://qiita.com/SigRem/items/a6ccd57a2881e8a43905

最後にキューシートをビルドする際、「Unity Assets出力」にチェックを入れてビルドします。

## 今回の楽曲構成
縦の遷移で変化させる各トラックのミックスバランスは、このデモに限り「テンション」と定義します。テンションは「ロー」「ミドル」「ハイ」の３段階を用意し、ゲームからそのパラメータを受け取れるようにします。

「ロー」は一部の楽器のみ、「ミドル」でパッド、ベース、ドラムが追加、「ハイ」でリード、さらにドラムが追加になります。これらの操作はADX2のAISAC機能を用いて操作します。

横の遷移で変化するループの種類については「フレーズ」と呼びます。デモでは４種類を用意しています。フレーズは４種類用意され、それぞれ0から3までの番号が振ってあります。これらの操作はADX2のブロック再生機能を用いて操作します。

これらの３種類のトラック組み合わせ x ４種類のループ音で、１２通りの変化をするインタラクティブミュージックを作っていきます。

# Unity側の設定
まずは、新しいプロジェクトを作成し、ADX2のプラグインを導入するところまで進めます。
プラグインパッケージ一式をインポートし、シーンにCriWareLibraryInitializer、CriWareErrorHandlerを配置します。

先ほどビルドしたデータをAtom Window経由でインポートし、内容をチェックします。

![CRI Atom 2020-10-07 00.48.57.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/19010/04480273-1e31-ab93-fbc7-13e87d03064f.png)

## Audio Managerスクリプトの作成
BGMを再生したり、ADX2にパラメータを渡して曲を変化させるためのマネージャースクリプトを作成します。

![AudioManager.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/19010/a90dae73-615d-4abd-2b72-66dc658dd661.png)

まずは必要なフィールド、プロパティを作っていきます。

```AudioManager.cs
[RequireComponent(typeof(CriAtomSource))]
public class AudioManager : MonoBehaviour
{
    public CriAtomSource atomSource;
    
    [Range(0f, 1f)]
    public float currentAisac00 = 0f;
    [Range(0f, 1f)]
    public float currentAisac01 = 0f;

    [Range(0,3)]
    public int currentPhrase = 0;

    private int currentTension = 0;
    

    private readonly List<Tuple<float, float>> aisacControllPresetts = new List<Tuple<float, float>>()
    {
        { new Tuple<float, float> (0f,0f)}, //low
        { new Tuple<float, float> (0f,1f)}, //middle パッド、ベース、ドラムBが追加
        { new Tuple<float, float> (1f,1f)} //high リード、ドラムCが追加
    };
    
    private CriAtomExPlayback criAtomExPlayback;

    public Text currentParameterText;

/略/
```

このスクリプトを張り付けるコンポーネントには、BGMを再生するためのAtomSourceを配置します。その参照をインスペクター経由で取得します。

Rangeアトリビュートを使って、aisac値を0から1、ブロックを0から3に制限して定義します。これは、ゲームの実行中にインスペクタ経由から直接操作して変化を試すためです。

ゲームからのパラメータは「テンション」「フレーズ」の２値で来ます。フレーズは0から3までで、これはそのまま当該楽曲のブロック番号とイコールのため、そのままADX2へ渡します。

テンションについては、0,1,2の３つの値を「ロー」「ミドル」「ハイ」と定義してゲーム内で扱います。楽曲に反映するためには。はAISACパラメーター２種類の操作に割り当てています。aisacControlPresettsリストは、この３値において２つのAISACコントロール値がいくつになるのかを定義したテーブルです。

次に定義されたCriAtomExPlaybackメンバーは、キューが再生されたときに取得できるパラメータ操作用です。ブロック再生のブロック指定に使用します。

最後に、現在のテンションとフレーズを表示するテキスト要素を定義します。

次に、２つメソッドを書きます。今回は簡易的に、おなじみStartとUpdateに書いてしまいます。

```AudioManager.cs
/略/

    void Start()
    {
        criAtomExPlayback = atomSource.Play();
    }

    private void Update()
    {
        atomSource.SetAisacControl("AisacControl_00", currentAisac00);
        atomSource.SetAisacControl("AisacControl_01", currentAisac01);

        criAtomExPlayback.SetNextBlockIndex(currentPhrase);

        currentParameterText.text = "current tension " + currentTension + "\ncurrent phrase " + criAtomExPlayback.GetCurrentBlockIndex();
    }
}

```
まずStartでatomSourceコンポーネントに設定されているキューシート・キューのデータを再生し、戻り値としてCriAtomExPlaybackを受けとります。

Updateでは、atomSourceへ現在のaisac値を二種類渡します。また、criAtomExPlaybackへ現在のフレーズをそのまま次のブロックの番号として渡します。

また、現在のパラメータを表示するテキストエリアに現在のテンションの値、現在のブロックの値を取得して表示します。

## AudioManagerのテスト
ここまでできたら、ヒエラルキーにオブジェクトを作ってスクリプトをアタッチします。
自動的にCri Atom Sourceコンポーネントも付きますので、CueSheetとCueNameにそれぞれ再生対象を記入します。

![AudioManager2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/19010/f9f6b397-dd6b-603c-e67d-b65ae50044e8.png)

AudioManagerスクリプトのAtom Sourceフィールドに同コンポーネントのCri Atom Sourceの参照を入れます。

また、現在のパラメータを表示するテキストエリアを作ります。ヒエラルキーにuGUI Textを用意し、その参照をCurrent Parameter Textフィールドに参照を入れます。

この段階で一回ゲームを再生してみましょう。楽曲が流れ始めますので、Audio Managerコンポーネントのパラメータを色々変えてみましょう。
曲が変化するはずです。

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">インタラクティブミュージックの経過報告。いそぎUnity Editorのインスペクター側でミックスの変更、ループのシームレス切り替えはできるようになった。 (曲データ by <a href="https://twitter.com/sleepyslowsheep?ref_src=twsrc%5Etfw">@sleepyslowsheep</a> 、サウンドエンジンはADX2 ) <a href="https://t.co/XuzLrtq2fS">pic.twitter.com/XuzLrtq2fS</a></p>&mdash; ichijo (@Takaaki_Ichijo) <a href="https://twitter.com/Takaaki_Ichijo/status/1313403899861061632?ref_src=twsrc%5Etfw">October 6, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

## AudioManagerの修正

次に、ゲーム内のオブジェクトにキャラクターが入ったらパラメータが変化する、という仕組みのためにスクリプトを書きます。

現在のAudioManagerはインスペクターからのブロック指定を実現するため、Updateでブロックを指定していますが、これは「フレーズが指定されたとき」に１回指定すればいいだけなので、次の一行を消します。

```AudioManager_Updateメソッド内.cs
        criAtomExPlayback.SetNextBlockIndex(currentPhrase);
```

代わりにSetParametersメソッドを作ります。これは外部から呼び出されるメソッドです。

```AudioManager.cs
    public void SetParameters(int tension, int phrase)
    {
        criAtomExPlayback.SetNextBlockIndex(phrase);
        
        currentAisac00 = aisacControllPresetts[tension].Item1;
        currentAisac01 = aisacControllPresetts[tension].Item2;

        currentTension = tension;
    }

```
criAtomExPlaybackに次のブロック番号としてフレーズをそのまま渡します。
テンションについては、最初に作ったaisacControllPrisettsテーブルを使って、テンションの番号と対応する実際のAISACの値を取得。指定します。
テンションの値はテキストで表示しているため、currentTensionメンバに保存します。

この実装ではSetParametersが呼ばれると楽曲のミックスがいきなり変わってしまいますので、aisacの値の変化をTweenライブラリを使ってなだらかにすると良いです。
DOTweenを使った場合は次の書き方になります。

```AudioManager.cs

    public void SetParameters(int tension, int phrase)
    {
        criAtomExPlayback.SetNextBlockIndex(phrase);

        DOTween.To(
            () => currentAisac00,
            num => currentAisac00 = num,
            aisacControllPresetts[tension].Item1,
            2.0f
        );
        
        DOTween.To(
            () => currentAisac01,
            num => currentAisac01 = num,
            aisacControllPresetts[tension].Item2,
            2.0f
        );
        
        currentTension = tension;
    }

```

## PhraseChangerインスタンスの作成
プレイヤーが入ってきたらAudioManagerへパラメータを送信するトリガーオブジェクトを作ります。名前を「フレーズチェンジャー」とします。
実装はシンプルで、さきほどのAudioManagerへの参照と、テンション・フレーズのパラメータ保持、OnTriggerEnter経由でパラメータのAudioManagerへの受け渡しのみです。

```PhraseChanger.cs

[RequireComponent(typeof(BoxCollider))]
public class PhraseChanger : MonoBehaviour
{
    public AudioManager audioManager;

    [Range(0,2)]
    public int tension = 0;
    [Range(0,3)]
    public int phrase = 0;
    
    private void OnTriggerEnter(Collider other)
    {
        audioManager.SetParameters(tension,phrase);
    }
}

```

以上で楽曲変化に必要なスクリプトがそろいました。PhraseChangerスクリプトを適当なオブジェクトにアタッチし、tension、phraseの値をインスペクターで変えます。

CharacterControllerなどでプレイヤーキャラクターを作り、ridgidBodyを使ってOnTriggerEnterが走るようにし、配置します。

元となった @SigRem のサンプルに従って、3x4の格子状にPhraseChangerを配置し、それぞれのパラメーターの組み合わせを別にしておきます。

![SceneView.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/19010/c6b4700a-1dfb-1187-d6eb-196260b5c824.png)

（プレイヤーキャラのキー入力による操作、PhraseChangerに設定された値を取得してuGUI Textで重ねて表示させる処理については省略します。RectTransformUtilityを使ったごく一般的な実装です。）

ゲームを実行してみましょう。プレイヤーをフレーズチェンジャー内にキャラクターが入ると、楽曲が変化します。

![demo.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/19010/c3787cbe-f939-a146-ba80-0766d4d3b0a3.png)

AISACパラメータにTween処理を加えている場合、その時間かけてミックスが変化します。ブロックについては、ループが終わって次のループに入るタイミングで別のブロックに遷移します。

なお、今回のデモではブロックは毎回１ループしますが、特定の拍タイミングでブロックの移動を可能にする設定もできます。ループごとにしかジャンプできないわけではありません。

# まとめ
インタラクティブミュージックは、楽曲の遷移タイミング管理や同期再生、パラメータの複雑な変化などがあり、素のUnityに実装するにはハードルが高いです。
もとよりインタラクティブミュージックの機能を内包するCRI ADX2を導入することにより、その機能開発をスキップして曲や演出の作り込み側を始めることができます。

インタラクティブミュージックは作曲部分から特有の難しさがありますが、これがゲームと気持ちよくハマることで、体験のクオリティが非常に上がります。

ぜひ、チャレンジしてみてもらえればと思います。