Skip to content

ビルド方法

Jump to bottom
hotwatermorning edited this page Mar 19, 2020 · 7 revisions

システム要件

　Vst3SampleHost をビルドするには、以下のソフトウェアがビルドマシンにインストールされている必要があります。インストールされていない場合やバージョンが古い場合は正しくビルドできない可能性があるので、この先の解説に進む前にこれらをインストールしてください。

  • Java JRE (or JDK) version 8 or later （Gradleを使用するため）
  • Git 2.8.1 or later
  • CMake 3.14.1 or later
  • Xcode 10.1 or later （macOS環境のみ）
  • Visual Studio 2017 or later （Windows環境のみ）

プロジェクトをクローンする

まずプロジェクトのリポジトリを、 git clone コマンドでクローンします。

ここでは例として、ユーザーのホームディレクトリ直下に develop ディレクトリを作り、その中にプロジェクトをクローンします。このディレクトリパスは読者の環境に合わせて適宜読み替えてください。

また、クローン先のディレクトリやその上の階層のディレクトリ名に空白が含まれていると、この後のビルド処理が正しく完了しません。必ず空白を含まないディレクトリパスにクローンしてください。

Windows 環境では、コマンドプロンプト上で以下のコマンドを実行してプロジェクトをクローンします。develop ディレクトリが既に存在している場合は、途中の mkdir コマンドは実行せずに無視してかまいません。

cd "%HOMEDRIVE%%HOMEPATH%"
mkdir develop
cd develop
git clone https://github.com/hotwatermorning/Vst3SampleHost

macOS 環境では、ターミナル上で以下のコマンドを実行してプロジェクトをクローンします。こちらも Windows 環境と同様に、 develop ディレクトリが既に存在している場合は途中の mkdir コマンドは実行せずに無視してかまいません。

cd ~
mkdir develop
cd develop
git clone https://github.com/hotwatermorning/Vst3SampleHost

Windows／macOS それぞれでこのコマンドを実行すると、 <ユーザーのホームディレクトリ>/develop/Vst3SampleHost ディレクトリにVst3SampleHost プロジェクトのリポジトリがcloneされます。

Gradle を使用してプロジェクトをビルドする

プロジェクトのリポジトリをクローンできたら、次に Gradle を使用してプロジェクトをビルドします。

Gradle は、 Gradle Wrapper という機能を提供しています。 Gradle Wrapper を使用すると、ビルドマシン上に Gradle のシステム一式がインストールされていない場合でも、自動で特定のバージョンの Gradle をダウンロードし、そのプロジェクト上で Gradle を使用できるようにセットアップできます。このあとの解説で使用している gradlew コマンドは、この Gradle Wrapper を使用してビルドを行うためのコマンドです。

Windows 環境では、以下のコマンドを実行します。

cd Vst3SampleHost/gradle
gradlew build_all -Pconfig=Debug -Pmsvc_version="Visual Studio 16 2019" -Dfile.encoding=UTF-8

ここではビルド環境に Visual Studio 2019 がインストールされている環境向けのコマンドを記載しています。ビルド環境にインストールしているVisual Studioのバージョンが Visual Studio 2017 の場合は、以下の msvc_version プロパティに渡している値を、Visual Studio 15 2017 に読み替えて実行してください。

ここで使用している Visual Studio 15 2017 や Visual Studio 16 2019 のような名前は、CMakeのVisual Studio Generatorの値に対応しています。

macOS 環境では、以下のコマンドを実行します。

cd Vst3SampleHost/gradle
./gradlew build_all -Pconfig=Debug

このとき、 "No Java runtime present, requesting install." というエラーが出た場合は、 JRE or JDK がインストールされていないか、 Gradle が JAVA のインストールディレクトリを正しく検知できていない可能性があります。

特にもし JRE を入れたのにも関わらずこのエラーが表示された場合は、次の環境変数を設定して再度試してみてください。

export JAVA_HOME=/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/

Windows／macOS それぞれで上記のコマンドを実行すると、ビルドスクリプトはまず VST3 SDK やその他の依存ライブラリのビルドを行い、その後build_debug ディレクトリに IDE のプロジェクトファイルを作成し、 Vst3SampleHost をビルドします。

ビルドが成功すると、 build_debug/Debug/Vst3SampleHost ディレクトリが作成され、そこに Vst3SampleHost の実行ファイルが生成されます。

この実行ファイルは、Explorer／Finder からダブルクリックで起動したり、以下のコマンドで起動できます。

Windows 環境（コマンドプロンプト）

start ..\build_debug\Debug\Vst3SampleHost\Vst3SampleHost.exe

macOS 環境（ターミナル）

open ../build_debug/Debug/Vst3SampleHost/Vst3SampleHost.app

リリースビルドの方法

上記のビルドコマンドでは、 -Pconfig=Debug オプションによってデバッグビルド設定で Vst3SampleHost をビルドしています。これをリリースビルド設定でビルドするには、 -Pconfig=Debug オプションの代わりに -Pconfig=Release オプションを渡してください。

ビルドが成功すると、 build_release ディレクトリに、 IDE のプロジェクトファイルが作成され、さらにその中の Release ディレクトリに、リリースビルド設定でビルドされた Vst3SampleHost の実行ファイルが生成されます。

通常 Visual Studio や Xcode で新規プロジェクトを作成した場合は、一つのプロジェクト上でデバッグビルド／リリースビルド両方のビルド設定を自由に切り替えられるようになっていますが、Vst3SampleHostではその仕組みは採用せず、ビルド設定ごとに別々のディレクトリにプロジェクトファイルを生成するようにしています。これは、一つのプロジェクトファイル上でビルド設定を動的に切り替えられるようにすると、サブモジュールとして取り込んでいる依存ライブラリのビルド状態とプロジェクトのビルド設定の状態の整合性を取るのが面倒になることがあるためです。

Clone this wiki locally