「初音ミク冒険記 サウンドツール」 2014/12/30版公開

「初音ミク冒険記　サウンドツール」の
2014/12/30版を公開します。

このツールは、初音ミク冒険記で使う
Visual C++のサウンド系ソースファイルを生成ツールです。

初音ミク冒険記のソースを自動的に編集するツールなので
かげさん以外だと初音ミク冒険記のソースを改造して
新たなゲームを作る人くらいしか使うことはないと思います。

試しに使ってみたい人は、
初音ミク冒険記のソースを別のフォルダにバックアップしてから実行して、
DFなどの「フォルダの比較」で変更された箇所を確認すると良いでしょう。

主目的がソースファイル生成のプログラムなので、
サウンドツールという名前にも関わらず
現在、このツールでは、登録したBGMやSE（効果音）を再生できません。
再生できた方が良い気もするんだけどね・・・

サウンドツールを使うには以下のものが必要になります。

• 初音ミク冒険記　ソース一式（最新バージョンのもの）
• 初音ミク冒険記　サウンドツール（このツール）
• common.settingファイル

ソース一式をダウンロードしていない人は、
コチラから事前にダウンロードしておいて下さい。

今回紹介のツールも上記のリンクからダウンロードできます。
ダウンロードサイトのHTMLがしょぼくて、かげさんも気になっているのですが
これもそのうち何とかしたいと思います。

さて、common.settingファイルですが、こちらは
「初音ミク冒険記の開発ツールを使う準備」の
記事を参考に準備して下さい。

肝心の「サウンドツール」ですが
データファイル、ソースとツールを同時に配布しているので以下のようなフォルダ構成になっています。

HatsuneMikuBoukenki

└DOC

ToolCom

BoukenkiSoundTool

└BoukenkiSoundTool

　├bin

　│├Debug

　│└Release

　├obj

　│　このフォルダの下にもフォルダがありますが使わないので省略

　└Properties

HatsuneMikuBoukenkiフォルダは、
初音ミク冒険記のソース一式が格納されているフォルダに上書きします。
実は、HatsuneMikuBoukenki\DOCフォルダにサウンドツールで使う
BGMリスト（BGM.csv）、SEリスト（SE.csv）のデータが格納されてます。

ToolComフォルダは、初音ミク冒険記の開発ツールが共通で参照するフォルダです。
具体的には、共通クラスが格納されています。
実行時には使っていません。

BoukenkiSoundToolフォルダには、このツールの
ソリューションファイル等が格納されています。
なお、ソリューションファイルは、
Visual Studio 2008 Visual C#のものです。
2010や2012、2013でも使えると思います。

BoukenkiSoundTool\BoukenkiSoundToolフォルダには
「サウンドツール」のC#のソースなどが格納されています。

実際のツール「BoukenkiSoundTool.exe」があるのは
BoukenkiSoundTool\BoukenkiSoundTool\bin\Debugフォルダです。
このフォルダに前述のcommon.settingファイルをコピーします。

ツールの起動は「BoukenkiSoundTool.exe」を
エクスプローラからダブルクリックするだけです。

起動しない場合、.NET Framework 3.5 SP1がインストールされていない可能性があります。
基本的にWindows 7以降には、標準でインストールされていたはずです。
Vistaもサービスパック2が適用されていれば、インストールされていたはずですが
起動しない場合、こちらからダウンロードして下さい。
http://www.microsoft.com/ja-jp/net/netfx35/download.aspx

起動すると以下の様な画面が表示されます。
BGMの設定画面

ＳＥ（効果音）の設定画面

起動した段階で現在のBGMリスト（BGM.csv）、SEリスト（SE.csv）のデータの内容を読み込み
画面上部の一覧に表示します。

２つあるタブでBGMの設定なのか、SEの設定なのかを切り替えます。

どちらのタブもmp3とwavのファイルをドラッグ＆ドロップで指定可能。

必要事項（青字の項目）を入力して「最後に追加」ボタンを押すか
「後ろに追加」ボタンを押すと画面上部のリストに入力内容が追加されます。

「最後に追加」ボタン：画面上部のリストの最終行に追加
「後ろに追加」ボタン：画面上部のリストの選択行の次の行に追加

画面上部のリストは、「BGMリスト保存」ボタンや「SEリスト保存」ボタンで保存します。

画面下部に「○○を生成」というボタンがありますが、
基本的に右下の「サウンド関連ソース一括生成」ボタンしか使いません。
「サウンド関連ソース一括生成」ボタンを押すのと
タブにある「○○を生成」ボタンを全部押すのは同じ意味なので
（もともと「○○を生成」ボタンで、個別でソース生成を確認してただけなので）

「サウンド関連ソース一括生成」ボタンを押下すると
ＢＧＭリストやＳＥリストの内容に従い、
初音ミク冒険記のサウンド関連のVC++ソース一式を自動生成します。

イメージとしては、以下みたいな感じ。
サウンドリストの元ネタ

• 登録対象サウンドファイル　：*.mp3、*.wav

自動生成されるヘッダやソースのインプットデータ

• サウンドリスト　　　　　　：BGMリスト（BGM.csv）、SEリスト（SE.csv）
• 自動生成ソーステンプレート：mySoundSETemplate.cpp、myLuaSoundTemplate.cpp

自動生成されるファイル

• 自動生成されるヘッダ　　　：mySoundBGM.h、mySoundSE.h
• 自動生成されるソース　　　：mySoundSE.cpp、myLuaSound.cpp

自動生成では、以下のソース修正をやってます。

• ヘッダファイル（mySoundBGM.h、mySoundSE.h）へのBGMやSEの定数の追加
• ヘッダファイル（mySoundBGM.h、mySoundSE.h）へのSEハンドル変数の追加
• SEのソース（mySoundSE.cpp）へのSEのロード処理の追加
• SEのソース（mySoundSE.cpp）へのSEのボリューム変更処理の追加
• Luaサウンドソース（myLuaSound.cpp）へのLuaスクリプトで使うBGMやSEの定数公開処理を追加

なお、画面項目の全部を入力しておくとソースのコメントが綺麗に入るようになってます。

ソース生成後に初音ミク冒険記本体側をビルドすれば
Luaスクリプトからも、BGMリストやSEリストにある
BGM定数名やSE定数名が使えるようになります。

このツールで、かげさんとしては、いろいろと楽になるんですが、
一番ポイントが高いのは、SEのボリューム変更処理のソースを自動で埋め込んでくれることです。

他は、必要に迫られて追加するので忘れないんですが、
SEのボリューム変更は、しょっちゅう忘れるんですよ。
このツールを使う限り、忘れることはないんで、
今後、SEのボリューム変更し忘れのバグはでないはず！

BGMリストやSEリストのところに空行がありますが、
これはソース自動生成の時にある程度まとまったグループで空行があると
ソースが見やすいためです。

また、コメントアウトのチェックを付けると、
ソース上でコメントアウトされたり、ロジックが生成されなかったりします。

これは、主に効果音でのことなんですが、いくつかの効果音の候補があった時に
対象効果音だけを聴いて使うかの判断をするのではなく、
試しに初音ミク冒険記本体で使ってみて、その印象を確認するといったときに
同じ効果音の定数名で登録しておき、聴き比べるといったことをしていた頃の名残です。

以前は、こんなことをしてたのですが、Luaスクリプトに定数公開を自動で行えるなら
正直、定数名を別々で登録しておき、Luaスクリプトで切り替えるって方が
Visual C++ソースのリコンパイルがなく、初音ミク冒険記を起動したままで切り替えれる分、
開発効率がアップするはず！

このツールの作成に関連する記事
サウンド系ソースを自動生成するツール サウンド系ソースを自動生成するツール２ サウンド系ソースを自動生成するツール３

ということで開発ツールの公開第２弾
「初音ミク冒険記　サウンドツール」の説明でした。