[Unity] BGM や効果音をいい感じに鳴らすライブラリを作る [ゲーム開発ログ 2020-12-19]

2020-12-19

俺による俺のためのイイ感じの AudioPlayer

Unity にはゲーム開発に必要な道具が大体揃っている。オーディオ再生もそのひとつだ。が、道具を取り出しやすいところに置いたり、自分に使いやすい状態に並べたりするのは個々のプログラマの仕事だ。

実際、ちょっとしたモックを作るときは Unity の用意した API を呼ぶだけで事足りるが、細かい制御をしたくなったりすると、自分でちょっとライブラリレイヤーを仕立てる必要が出てくる。

例えば

音量のフェードイン・フェードアウトを楽に書きたい
シーン遷移中にも音を鳴らし続けたい
- （※ Main Camera に Audio Listener をつける作りだと、遷移処理中のカメラが無い期間に音が途切れる）
ピッチを変えつつ 3D サウンドを鳴らしたい

といったことをやりたくなった場合、Unity 標準の API を単に呼ぶだけでは実現できない。

ということで、自前の AudioPlayer ライブラリを実装した。

自分の実装

ゲームプログラマであれば、こういう AudioPlayer 的なコードを実装したことのある人は多いと思うが、細かい内部仕様やインタフェース設計なんかは人によって差が出るものだ。

自分の実装はこんな感じになった：

インタフェースと実装
- IAudioPlayer.cs
- AudioPlayer.cs
内部で使用：
- AudioSourcePool.cs
- AudioSourceState.cs

（※ 自前のフレームワークに依存したコードで、フレームワークごと持ってこないと動かないので注意）

こんな感じで書けるようになっている：

// 普通に再生。アセットアドレスを渡す方法と AudioClip を直接渡す方法がある
Alto.bgm.Play(AssetAddress.BGM_Stage_1);
Alto.bgm.Play(audioClip);

// BGM と効果音は Alto.bgm と Alto.se で再生プールやデフォルト設定を分けている。機能は同じ
Alto.bgm.Play(AssetAddress.BGM_Stage_1);
Alto.se.Play(AssetAddress.SE_Click);

// 引数でピッチとか、すでに鳴っていても再生し直すかなど色々指定できる
Alto.bgm.Play(AssetAddress.BGM_Stage_1, pitch: 0.89089f, replay: true);

// 止める。音源を指定すると指定した音源だけを止める
Alto.bgm.Stop();
Alto.bgm.Stop(AssetAddress.BGM_Stage_1);

// 中断と再開。これも音源指定が可能
Alto.bgm.Pause();
Alto.bgm.Resume();

// フェードイン / フェードアウト / クロスフェード
Alto.bgm.FadeIn(AssetAddress.BGM_Title, 4.0f);
Alto.bgm.FadeOut(4.0f);
Alto.bgm.CrossFade(AssetAddress.BGM_Stage_1, 4.0f, 0f, 4.0f)

// ジングルを鳴らす時など、一定時間 BGM の音量を絞る
Alto.bgm.Ducking(audioClip.length);

// マスターボリューム設定はシステムとユーザの 2 つをかけ合わせる
Alto.bgm.systemMasterVolume = 0.8f;
Alto.bgm.userMasterVolume = 0.8f;