ペロリーパー | PeloREAPER

今回からREAPER上で動作させられるスクリプトやその動作環境などについて解説していきます。少しでもReaScript入門のハードルを下げていければと思っていますが、どうなることやら。

• ReaScriptイントロダクション
• ReaScriptとは
• ReaScript自作の必要性
• ReaScript作成に使用できるプログラミング言語
• （おまけ）REAPER Extensionについて
• ReaScriptを作成してみる
• ReaScript作成～実行方法
• Hello World：テキストを表示するプログラムの作成
• 作成したスクリプトを後から修正したい場合
• 作成したスクリプトを削除したい場合
• 既に作っておいたScriptを読み込んでActionにしたい場合

ReaScriptイントロダクション

ReaScriptとは

ReaScriptとはREAPER上で動かせるスクリプト（もしくはその実行環境のこと）を指します。厳密な解説は下記リンクの公式サイトに譲るとして、ひとまず「スクリプトを追加することでREAPERのActionを追加できる」のだと理解していれば十分かと思います。

ReaScriptからはREAPER本体やExtensionから提供されるAPIを呼び出したり、他の既存のActionを実行したりといったことが出来ます。APIはActionを作るためのプログラムの部品のようなもので、例えばTrackの個数を返してくれる関数など様々なものがあります。

では「これで何を実現できるか」というのは多岐にわたるのですが、例えば以下のようなものでしょうか。

• 手間がかかる定型作業を1つのAction（スクリプト）で実行させるような自動化（Item編集やMIDI編集、FXのパラメータ設定等様々な作業に応用可能）
• 既存のActionの動作では満足いかなかった場合に、自分専用にカスタムした動きのActionを作って作業オペレーションを最適化
• カスタムGUIを作成して自分用のツールを作る

また、REAPER上で動作するスクリプトという意味では、オーディオFXやMIDI FXを作れるJSFX、動画などの画像処理を行うVideo Processorスクリプトなどもありますが、この記事の系列では扱いません。Video Processorについてはこの辺りで過去にいろいろ記事を書きましたので、そちらを見てもらうと良いかと思います。

ReaScript自作の必要性

ではどういった時にReaScriptを自作する必要があるのでしょうか？

REAPERを使い始めた初心者の方は、いきなりReaScriptを書く必要はありません。既に便利なActionやスクリプトが沢山ありますので、それを使って自分の作業環境を良くしていければ十分じゃないかと思います。

ReaScript自作に手を出す前に、試しに使ってみて把握しておくと良さそうなところをいくつかリストアップしておきますので参考にしてみて下さい（下に行くほど高度・面倒）。

• デフォルトでREAPERに実装されている様々なActionを使ってみる。
• SWSもインストールして、これに含まれるActionも使ってみる。
• REAPER標準のCustom Action（複数のActionを並べて順番に実行できる、一般的なツールだとマクロ機能のようなもの）でActionを組み合わせて実行してみる。
• ReaPackで有志の方が作成したスクリプトをダウンロードしていろいろ試してみる。
• おまけとしてSWSのCycle Actionを試すのもアリですが、もうこのあたりからプログラミング色が強くなってきます（プログラミングに慣れてくればReaScriptで書いた方が楽かも）。

こういった既存の機能をいろいろと使っていくと、それらでは細かいところに手が届かないように感じたりする場面が出てきたりします。そう感じて更に自分に最適なActionが欲しくなってきたら、いよいよReaScriptを書く必要性が高まってきたと言えるでしょう。

とはいえReaScript自体に興味があるなら、もろもろすっ飛ばしていきなりスクリプトを作り始めてもいいと思います。上記の内容はあくまで参考までにということで。

ReaScript作成に使用できるプログラミング言語

ReaScriptを作成するのに使用できる言語はReaScript公式ページに記載されていますが、EEL2、Lua、Pythonから選ぶことが出来ます。Pythonはセットアップが必要なので、デフォルトの状態で使えるのはEEL2とLuaになります。

いろいろ書いてしまいましたが、ザックリまとめると

• 一般的にはLuaがオススメ
• 多少手間はあるけど複雑な事をサクッとやりたいならPythonも使う

※今後の記事ではLuaを使用することを前提として解説を進めていきます。また、Lua言語自体の書き方や言語仕様等の説明も出来るだけ割愛させて頂くことにして、ReaScript固有の部分に的を絞って解説しますのでご了承下さい。

（おまけ）REAPER Extensionについて

REAPERのAPIは上記で紹介したスクリプト言語からだけでなく、C言語から呼び出す方法も用意されています。C言語で作成されたREAPERのプラグインは特別にREAPER Extensionと呼ばれています。こちらはLua等のテキストファイルを追加すればサクッとActionを追加出来るというような代物ではなく、作成のハードルは非常に高くなっています。

過去に当ブログでもREAPER Extensionの作り方についてこの辺りの記事で解説していますが、ゴリゴリのエンジニア向けの内容となります。本記事の読者向けには「まぁそんなものもあるのね」くらいに知っておいてもらえればOKです。

ReaScriptを作成してみる

ReaScript作成～実行方法

それでは簡単なReaScriptを作成して、実行してみましょう。

1. REAPERメインメニューから [Actions ＞ Show action list...] でAction Listを表示します。
2. Action List下部にある [New action...] ボタンをクリックして [New ReaScript...] を選ぶと、スクリプトの保存場所を聞かれます。
   
3. ファイルの種類は [Lua files (*.lua)] で、ファイル名は任意に指定します（ファイル名はそのままAction名になるのと、利便性の都合上日本語は用いずに半角英数のみのファイル名にしておくのがオススメです）。
   ここでは HelloReaperWorld.lua という名前にして保存します。
   
4. 保存するとスクリプトを編集するテキストエディタが表示されますが、実はもうこの時点でスクリプト自体の作成（とそれに対応するActionの追加）は完了していて、Action Listに「Script: HelloReaperWorld.lua」というActionが並んでいると思います。もちろん、実行も可能です（スクリプトが空なので何も起きませんが）。
   
   

Hello World：テキストを表示するプログラムの作成

では作成したスクリプトにエディタ上で以下のコードを追加して、Ctrl+Sで保存してみましょう。保存すると、同時にActionも実行されます。

reaper.ShowConsoleMsg("Hello REAPER World!!")

REAPERのコンソールウィンドウが開いて、「Hello REAPER World!!」と表示されたのではないでしょうか。

これでLuaによる初めての自作ReaScriptの完成です！　あとはいつでもAction Listから呼び出すことが可能です。

プログラムの簡単な解説

• REAPERのAPIは、Luaだと「reaper.API名(パラメータ)」のような形で呼び出せます。
• 「ShowConsoleMsg」はREAPERのコンソールウィンドウにメッセージを表示するAPIで、パラメータとして "Hello REAPER World!!" という文字列をセットしています。

作成したスクリプトを後から修正したい場合

また、後からこのスクリプトを修正したい場合は、追加したスクリプトのActionをAction Listで選択して [Edit action...] ボタンで編集出来ます。

作成したスクリプトを削除したい場合

既に作成してあるスクリプトのActionを選択して、Action Listの [Delete] ボタンで削除できます。

既に作っておいたScriptを読み込んでActionにしたい場合

最初にスクリプトを作成する時と似ていますが、Action Listのボタンで [New action... ＞ Load ReaScript...] からスクリプトのファイルをロードすればOKです。

今回はここまで。前置きが長かった割に、スクリプトを作り始めたらあっという間だったのではないでしょうか。Actionをこんなにも簡単に追加出来ると分かると、夢が広がりますよね。

LuaモジュールDLLの作成

#include "lua.hpp"

extern "C" {

// exportする関数
static int MyCalc_Impl(lua_State *L)
{
	// 最初のスタックから値を読みだす
	double d = lua_tonumber( L, 1 );

	// 戻り値をスタックに積む
	lua_pushnumber( L, d / 2.0 );
	lua_pushnumber( L, d * 2.0 );

	return 2; // 戻り値の個数
}

// テーブル登録用
static luaL_Reg moduleFuncs[] =
{
	{ "MyCalc", MyCalc_Impl },
	{ nullptr, nullptr } // end of table
};
static const int numOfFuncs = (sizeof(moduleFuncs) / sizeof(moduleFuncs[0])) - 1;

// EntryPoint
__declspec(dllexport) int luaopen_MyLuaModule(lua_State *L)
{
	// 以下luaL_register()の替わり
	lua_newtable( L );
	luaL_setfuncs( L, moduleFuncs, 0 );
	lua_pushvalue( L, -1 );
	lua_setglobal( L, "MyLuaModule" );

	return 1;
}

} // extern "C"

ReaScriptでモジュールを使用

require("MyLuaModule")
local num1, num2 = MyLuaModule.MyCalc( 1.5 )
reaper.ShowConsoleMsg( "Result:" .. num1 .. "," .. num2 .. "\n" )