Raspberry PiでVSTプラグインを開発する話

本記事は [Raspberry Pi Advent Calendar 2017](https://qiita.com/advent-calendar/2017/raspberry-pi)  の12月18日向けに投稿した記事です。

## VSTプラグインとは？

<img src="https://qiita-image-store.s3.amazonaws.com/0/93566/3bdfe3a5-88ae-cd6c-2730-8037003396d3.jpeg" width=30%>

VST(Steinberg's Virtual Studio Technology)とは、ドイツのSteinberg（スタインバーグ）社が提供している仮想音響技術のことです。音源（シンセサイザー）として機能するものはVSTi(VST instrument)とも呼ばれます。C++のダイナミックライブラリで実装され、DAW(Digital Audio Workstation)等のホストアプリケーションに組み込むことができ、フィルタや仮想楽器をシミュレートすることができます。仕様そのものはクロスプラットフォームなC++ライブラリで提供されているため、プラットフォーム上でコンパイルしてしまえば、そのプラットフォーム上で楽器やエフェクターとして使用することが出来ます。

本記事では、そのVSTプラグインを実装するにあたり、より簡単かつGUI用のコンポーネントが充実しているJUCEフレームワークを利用します。

## JUCEとは？

<img src="https://qiita-image-store.s3.amazonaws.com/0/93566/0ab652b5-89d6-c8e2-fb6a-ce0cbc136423.png" width=30%>

JUCE (Jules' Utility Class Extensions)は、C++言語によるマルチメディア系アプリケーションの開発を支援するフレームワークです。クロスプラットフォーム設計のライブラリと、付属されているプロジェクトジェネレータ『Projucer』から各種IDE(VisualStudio, Xcode, Makefile)向けにプロジェクトファイルを出力することで、ワンソースからWindows, macOS, Linux, iOS, Android で動作するアプリケーションを作成することができます。
[公式サイト](https://juce.com/)

JUCEの最大の特徴として、オーディオプラグインを開発するためのテンプレートが充実していることが挙げられます。VST/AudioUnit/AAX/RTASプラグインといった、DTMユーザーにはお馴染みのプラグインフォーマットを開発するのに長けており、日本国内外で多くの採用事例があります。
JUCEについてより詳しく知りたい場合は、こちらの記事[JUCE ハンズオン 〜JUCEをはじめよう〜](https://qiita.com/COx2/items/12a48c4a30c49732dcc5)や、[JUCE Advent Calendar 2017](https://qiita.com/advent-calendar/2017/juce)をご覧いただければと思います。

## JUCEライブラリ と Projucer

JUCEフレームワークは、各種機能を提供する『JUCEライブラリ』と、各種プラットフォーム向けのプロジェクトを出力するジェネレータ『Projucer』によって構成されます。
『JUCEライブラリ』には機能別に『モジュール』という単位で構成が分かれており、『Projucer』はプロジェクトに必要なモジュールを取り込んで、IDE用のプロジェクトファイルやビルドスクリプトに紐付ける作業を担当します。

![JUCE_Projucer.png](https://qiita-image-store.s3.amazonaws.com/0/93566/5c54d93e-2345-7ac9-6041-6b82d4731fd9.png)


##  開発環境

◆ハードウェア
Raspberry Pi 3 Model B

◆OS
Raspbian Stretch (2017/11/29)

# ARM用のProjucerをビルドする

公式サイトから配布されたLinux用のProjucerはx86アーキテクチャをターゲットにしたものであるため、ARMアーキテクチャのRaspberry Pi上では動作しません。そこで、Raspberry Pi用のProjucerを自身の端末上でビルドします。


## レシピ
Linuxに手慣れている方はこちらのコマンドリストだけでも説明は十分かと思います。

```bash

// JUCEリポジトリをクローン
$ git clone https://github.com/WeAreROLI/JUCE.git

// 依存パッケージをインストール
$ sudo apt-get install clang freeglut3-dev g++ libasound2-dev libcurl4-openssl-dev libfreetype6-dev libjack-jackd2-dev libx11-dev libxcomposite-dev libxcursor-dev libxinerama-dev libxrandr-dev mesa-common-dev webkit2gtk-4.0 ladspa-sdk

// 作業ディレクトリに移動
$ cd JUCE/extras/Projucer/Builds/LinuxMakefile

// GCCでコンパイルする場合
$ make CXX=g++ -j4

// LLVM-Clangでコンパイルする場合
$ make CXX=clang++ "TARGET_ARCH=-march=armv7-a" -j4

```


## 1. 準備

まず、JUCEをダウンロードしましょう。[公式ダウンロードサイト](https://juce.com/get-juce)
Windows/macOS/Linuxから選択することができます。Linux向けを選択すれば良いです。
※Linux用のProjucerが同梱されていますがx86アーキテクチャをターゲットにしているため、ARMアーキテクチャのRaspberry Piでは起動することができません。

また別の方法として、GitHubリポジトリからDLすることもできます。ターミナルで次のコマンドを打ちましょう。

```bash

$ git clone https://github.com/WeAreROLI/JUCE.git

```

## 2. 依存パッケージのインストール

```bash

$ sudo apt-get install clang freeglut3-dev g++ libasound2-dev libcurl4-openssl-dev libfreetype6-dev libjack-jackd2-dev libx11-dev libxcomposite-dev libxcursor-dev libxinerama-dev libxrandr-dev mesa-common-dev webkit2gtk-4.0 ladspa-sdk

```

JUCEライブラリのビルドに必要な依存パッケージをインストールします。ついでにLLVM-Clangコンパイラをインストールします。ディストリビューションに付属のGCCでもコンパイルすることができます。


## 3. 作業ディレクトリへの移動

```bash

$ cd JUCE/extras/Projucer/Builds/LinuxMakefile

```

リポジトリ内に含まれるプロジェクトの中から、ProjucerプロジェクトのLinuxMakefileが置かれたディレクトリに移動します。
※ディレクトリは各自の環境に合わせて入力してください。
※サンプルプロジェクトの一部に”LinuxMakefile”用プロジェクトが同梱されています。

## 4. コンパイルしてProjucerをビルドする

### 4-1. GCCでコンパイルする場合

```bash

 $ make CXX=g++

```

LinuxMakefileからビルドを実行します。
ビルドモードは”Debug”がデフォルトです。
各種オプションについては以下の通りです。

・CXX=g++
… LinuxMakefileオプションです。C++コンパイラにg++を使用します



### 4-2. LLVM-Clangでコンパイルする場合

```bash

$ make CXX=clang++ "TARGET_ARCH=-march=armv7-a"

```

LinuxMakefileからビルドを実行します。
ビルドモードは”Debug”がデフォルトです。
各種オプションについては以下の通りです。

・CXX=clang++
… LinuxMakefileオプションです。C++コンパイラにclang++を使用します

・“TARGET_ARCH=-march=armv7-a”
… LinuxMakefileオプションです。ターゲットアーキテクチャを明示的に指定します

### 4-3. 補足：Releaseビルド時のコマンド

```bash

// GCCでコンパイルする場合
$ make CXX=g++ CONFIG=Release

// LLVM-Clangでコンパイルする場合
$ make CXX=clang++ "TARGET_ARCH=-march=armv7-a" CONFIG=Release

```

・CONFIG=Release
… LinuxMakefileオプションです。”Release”モードでビルドします。

## 5. Projucerを起動する

ビルドが完了したらProjucerを起動してみましょう。
初回起動時ではこちらの画面のように、サインイン画面が表示されます。
サインインにROLIアカウントが必要となるので、ROLIアカウントも登録しておきましょう。

![Screenshot_20171205_155647.png](https://qiita-image-store.s3.amazonaws.com/0/93566/7ac94aef-215f-cb70-904f-452e528168e7.png)

サインインが成功すると、以下の画面となりプロジェクト作成が可能になります。
※こちらの記事[“JUCE ハンズオン 〜JUCEをはじめよう〜”](https://qiita.com/COx2/items/12a48c4a30c49732dcc5)『補足：GPLライセンスで使う方法』に書かれた手順でGPLv3ライセンスで使用することで、ROLIアカウントの登録を免除することが出来ます。

![Screenshot_20171205_155614.png](https://qiita-image-store.s3.amazonaws.com/0/93566/07dfafc4-f5c8-21ef-a9b3-6c5f5af88540.png)




# VSTプラグインを作成する

JUCEフレームワークの開発環境が整ったので、実際にVSTプラグインを作ってみましょう。
本記事では、オーディオプログラミング界隈のHello World!こと、Hello Sine Waveを作成します。

## 1. 新規プロジェクトを作成

Projucerを起動したら、[File] → [New Project...]をクリックして、テンプレートを選択する画面を開きます。
今回は、"Audio Plug-In"テンプレートから新規プロジェクトを作成します。

![vst_template.png](https://qiita-image-store.s3.amazonaws.com/0/93566/ca1e66da-d849-a0be-609f-ab0b51e9a376.png)

新規作成メニューでは、[Target Platforms]の項目を確認します。ここを自身の開発環境に合わせてチェックを入れます。
Linuxでの開発なので、Linux Makefileにチェックを入れます。
※Linux MakefileはmacOSのmakeコマンドでもビルドできます。

![vst_pcreate.png](https://qiita-image-store.s3.amazonaws.com/0/93566/16b24f15-0ba0-61b2-6e82-49169bc6eeb0.png)

新規プロジェクトを作成すると、"PluginEditor.h/cpp"と"PluginProcessor.h/cpp"のソースファイルが自動的に作成されます。

![vst_created.png](https://qiita-image-store.s3.amazonaws.com/0/93566/70564beb-7d62-077b-2958-6af02555d3d3.png)


## 2. プロジェクト設定を確認する

プロジェクト設定ツールから、ビルドするプラグインフォーマット形式や、バイナリに付随するメタデータを編集することができます。
対応するプラグインフォーマットは、VST2, VST3, AudioUnit, AudioUnit v3, AAX, RTASに対応しています。（VST3, AAX, RTASは要SDK）

1. 歯車アイコンをクリックすると、プロジェクト設定画面が表示されます。
2. [Build VST]にチェックが付いていることを確認します。
3. [Build Standalone Plug-In]にチェックが付いていることを確認します。（必須ではありませんが、後々便利なので）


![project_setting.png](https://qiita-image-store.s3.amazonaws.com/0/93566/f959f83a-edb1-63a0-a2a2-55c58e1c0095.png)


## 3. モジュール設定：JUCEライブラリをローカルにコピーする


JUCEライブラリのソースファイルをプロジェクトディレクトリのローカルにコピーする処理を有効にしておきます。
この設定を有効にしておくことで、JUCEリポジトリのディレクトリのパーミッション設定が原因でライブラリを参照できないというトラブルを回避することができます。

1. Modules設定の歯車アイコンをクリック
2. [Set all modules to copy locally]をクリック
3. [Make Local Copy]の項目が"NO"→"YES"になったら有効

![module_localcopy.png](https://qiita-image-store.s3.amazonaws.com/0/93566/a62eb98a-1bfb-e698-a701-3d26f5f0a88e.png)


## 4. プロジェクトの保存とソースコードの編集

[File] → [Save Project]でプロジェクトを保存します。

![save_project.png](https://qiita-image-store.s3.amazonaws.com/0/93566/e7c9da09-150d-16e0-1790-19c1e6a4c8b1.png)

プロジェクトが保存されると、各種ソースコードやライブラリが追加されます。

![Screenshot_20171206_154019.png](https://qiita-image-store.s3.amazonaws.com/0/93566/156d046f-db0f-7aaf-9cbb-47a7e3caae3b.png)



## 5. サイン波を鳴らす処理を実装する

プロジェクトが保存されてることが確認できたら、サイン波を鳴らす処理を実装してみましょう。"PluginProcessor.cpp"の関数"processBlock"が、オーディオバッファの更新処理を実装することで実現できます。
関数"void HelloSineWaveAudioProcessor::processBlock (AudioSampleBuffer& buffer, MidiBuffer& midiMessages)"は予め記述されているので、以下のようにその内部実装を変更します。


```cpp

"PluginProcessor.cpp"

~~~中略~~~

void HelloSineWaveAudioProcessor::processBlock (AudioSampleBuffer& buffer, MidiBuffer& midiMessages)
{
    ScopedNoDenormals noDenormals;
    const int totalNumInputChannels  = getTotalNumInputChannels();
    const int totalNumOutputChannels = getTotalNumOutputChannels();

    for (int i = totalNumInputChannels; i < totalNumOutputChannels; ++i)
        buffer.clear (i, 0, buffer.getNumSamples());

    for (int channel = 0; channel < totalNumInputChannels; ++channel)
    {
        float* channelData = buffer.getWritePointer (channel);

#define M_PI 3.14159265358979323846
        const float level = 0.5f;
        for (int sample = 0; sample < buffer.getNumSamples(); ++sample)
        {
            channelData[sample] = sinf(M_PI * 2 * sample/ buffer.getNumSamples() * 2) * level;
        }
    }
}

~~~中略~~~

```


このソースコードを記述すると、オーディオバッファを更新する度に、オーディオバッファ全体でサイン波一周分（360°=2π）を書き込む処理が実行されます。

![スライド3.PNG](https://qiita-image-store.s3.amazonaws.com/0/93566/bba31b9b-fcf7-eba4-b37f-0b5c9821fd36.png)



## 6. ビルドの実行とスタンドアローン版での動作確認

上記のソースコードを記述したら、Makefileが置かれたディレクトリまで移動してmakeコマンドを実行します。

```bash 

// GCCでコンパイルする場合
~/HelloSineWave/Builds/LinuxMakefile$ make CXX=g++ CONFIG=Release

// LLVM-Clangでコンパイルする場合
~/HelloSineWave/Builds/LinuxMakefile$ make CXX=clang++ "TARGET_ARCH=-march=armv7-a" CONFIG=Release

```

ビルドが成功したらアプリケーションを起動してみましょう。
『2.プロジェクト設定項目』の通りに[Build Standalone Plug-In]にチェックが付いていれば、スタンドアローンの実行プログラムも一緒にビルドされます。
以下のコマンドから起動、若しくはファイラーからダブルクリックで実行プログラムを起動してみましょう。

```bash

~/HelloSineWave/Builds/LinuxMakefile$ ./build/HelloSineWave

```

<img src="https://qiita-image-store.s3.amazonaws.com/0/93566/c1e02b02-82ed-8a54-bdae-96c96942f7d5.png" width=80%>


アプリケーションが起動すると、ウインドウが表示されます。
オーディオデバイスとの接続が正常にできていれば、スピーカーからサイン波が鳴っていることを確認できます。

![standalone.png](https://qiita-image-store.s3.amazonaws.com/0/93566/4b6c09cc-43cc-a477-bd43-c049a00c231f.png)


# ホストアプリケーションでVSTプラグインを使用する

それでは、本記事で作成したVSTプラグインをホストアプリケーション（DAW）で実際に楽器として使用してみましょう。

## 1. ホストアプリケーションの紹介

今回は、Tracktion Waveformを動作確認に使用します。Waveformは公式でRaspberry Piに対応したDAWです。
DAWの中でも比較的低価格ですし、デモ版も用意されていますので、是非お試しください。
http://www.minet.jp/brand/tracktion/waveform/

![Screenshot_20171206_174647.png](https://qiita-image-store.s3.amazonaws.com/0/93566/5f32fd55-28e5-47b7-3a9d-bd3c1c75bf60.png)

## 2. VSTプラグインのファイル本体をスキャン対象ディレクトリに移動する

ビルドしたファイルのうち、拡張子が".so"のファイルがVSTプラグイン本体です。
<img src="https://qiita-image-store.s3.amazonaws.com/0/93566/89ef28ce-40d9-a577-322a-06a734d4ca5e.png" width=80%>

このファイルを、ホストアプリケーションがスキャン対象としているディレクトリに移動しておきます。
Tracktion Waveformでは、初期値として"/home/pi/.vst"が設定されているので、フォルダを作成しその中にVSTプラグインのファイル本体を移動しておきましょう。
![waveform.png](https://qiita-image-store.s3.amazonaws.com/0/93566/837b000d-2084-8c02-596a-bcfc1d178127.png)


## 3. ホストアプリケーションでVSTプラグインをスキャンする

Tracktion WaveformではVSTプラグインをスキャンする機能があります。
スキャンを実行すると、対象ディレクトリに置かれたVSTプラグインがリストに追加されます。

![Screenshot_20171206_174559.png](https://qiita-image-store.s3.amazonaws.com/0/93566/b55d11a4-33ef-3874-5c62-8ee4dfc31a77.png)


## 4. VSTプラグインをトラックにインサートする

VSTプラグインをリストから選択してトラックにインサートします。正常に動作するとサイン波がトラックに流れます。
また、プラグインのGUIを表示すると、先ほどスタンドアローン形式と同様のGUIが表示されます。

![Screenshot_20171206_174939.png](https://qiita-image-store.s3.amazonaws.com/0/93566/660e02cb-e742-4c8a-7422-179ae0d9fc25.png)

以上で、Raspbery PiでVSTプラグインを開発する環境が整いました。
VSTプラグインのAPIを理解することで様々な機能を持ったVSTプラグインを作ることができます。
ラズパイで動く楽器やエフェクターを自作してみたいという方には、JUCEフレームワークがお勧めです。Windows/macOSで開発したオーディオアプリケーションがそのままラズパイで動くので、開発効率も高いです。
JUCEに興味を持った方は、[JUCE Advent Calendar 2017](https://qiita.com/advent-calendar/2017/juce)にてシンセサイザーの作り方から、カラフルなGUIの実装など、様々なTipsをご覧いただき、お使いいただければと思います。