Type

すべてのオブジェクト型の基底となる型です。派生したすべての型のオブジェクトには、次のアクセサーが定義されています。

Scalars

単一の値を保持する基本型です。

これらの型のスカラーオブジェクトには、次のアクセサーが定義されています。

Vector

型安全で、サイズが動的に変わり、インデックスが0から始まる、ランダムアクセス可能なコンテナです。

vector オブジェクトには、次のアクセサーが定義されています。

Struct

名前付きフィールドを持つ型安全なレコードです。

struct オブジェクトには、次のアクセサーが定義されています。

アルゴリズム

次に挙げるのは、任意の Type に対して動作するフリー関数です。

ファイルシステム

Luaのバインディングは、C++のライブラリである boost filesystem をベースにしています。元のC++の設計とは異なり、Luaのバインディングは path の抽象化を定義していません。その代わり、path は常にLuaの文字列を指します。

以下の章では、前述のライブラリの関数と、それぞれが返すデータ型を一覧します。各関数の詳しい説明については、リファレンスドキュメントを参照してください。

例

for _,p in filesystem.directory(path) do
    print(p)
end

ディレクトリ内のパスを一覧します。

for _,p in filesystem.directoryRecursive(path) do
    print(p)
end

ディレクトリとすべてのサブディレクトリ内のパスを一覧します。

関数

すべての関数はグローバルの filesystem に属していることに注意してください。

利便性のため、fs = filesystem と宣言して、すべての filesystem の関数を fs という接頭辞で呼び出すこともできます。次の例のとおりです。

fs = filesystem
iterator fs.directory(path)
iterator fs.directoryRecursive(path)

PosixTime

日付と時刻に関するユーティリティ関数です。

例

print(posixTime.toString(filesystem.lastWriteTime(...)))

filesystem の lastWriteTime を文字列に変換します。

MIR関数

Music Information Retrieval（MIR）は、音楽から情報を取り出す学問分野です。とりわけ、サンプルのピッチやベロシティといった、意味のある特徴をオーディオファイルから抽出することができます。Creator Tools には、インストゥルメント制作の工程の一部を補助または自動化するための MIR関数が一式用意されています。

単体の関数は単一のファイルから情報を取得し、引数として絶対ファイル名（サンプルファイルへのフルパス）を取ります。バッチ処理の関数はフォルダーから情報を取得し、引数として絶対フォルダー名（サンプルフォルダーへのフルパス）を取ります。

ピッチ検出

ピッチ検出は、モノフォニックまたは単音のサンプルの基本周波数を検出しようとします。これはMIDIスケール（69 = 440 Hz）に対応し、半音15（約20Hz）から半音120（約8.4 kHz）までの範囲を扱います。

例

pitchVal = mir.detectPitch('fullPathToSample')

'fullPathToSample' のファイルパスにあるサンプルのピッチを pitchVal に設定します。

pitchBatchData = mir.detectPitchBatch('fullPathToFolder')
pitchValue = pitchBatchData['fullPathToSample']

'fullPathToFolder' ディレクトリ内のサンプルのピッチを検出し、Luaのテーブル pitchBatchData に格納します。続いてキー 'fullPathToSample' を使って pitchBatchData にアクセスし、得られた値を pitchValue に格納します

ピーク、RMS、ラウドネスの検出

Loudness、Peak、RMS の各関数は、最大値を0dBとするdB単位の値を返します。

RMS と Loudness の関数は、オーディオの小さなブロック単位で計算されます。それらのブロックの長さは frame size と呼ばれ、秒単位で表されます。この処理は hop size（こちらも秒単位で表されます）と同じ間隔で、サンプルの終端に達するまで繰り返されます。これらの関数は、それぞれのブロックの中で最も大きい、あるいは最も高い値を全体の結果として返します。

frame size と hop size を指定しなかった場合は、それぞれデフォルト値の0.4（frame size、秒単位）と0.1（hop size、秒単位）が適用されます。

Loudness、Peak、RMS の検出が失敗した場合は、定数 kDetectLoudnessInvalid、kDetectPeakInvalid、kDetectRMSInvalid が返され、これらはいずれも 1000000.0f として解決されます。Peak、RMS、Loudness の値をログに出力する際、無効な検出結果は数値の形でログに記録されます。

例

peakVal = mir.detectPeak('fullPathToSample')

'fullPathToSample' の絶対ファイルパスにあるオーディオサンプルを解析し、得られたPeak値を peakVal に格納します。

rmsBatchData = mir.detectRMSBatch(‘fullPathToFolder', 0.02, 0.01)

'fullPathToFolder' ディレクトリ内のすべてのオーディオサンプルを解析し、得られたRMS値をLuaのテーブル rmsBatchData に格納します。この計算では、Frame size と Hop size をそれぞれ0.02と0.01に指定しています。

タイプ検出

タイプ検出は、あるオーディオサンプルがどのカテゴリーに属するかを判定する手段です。現在 Creator Tools は、Sample Type、Drum Type、Instrument Type という3つの異なるタイプの検出に対応しています。Sample Type は、サンプルがドラムなのかインストゥルメントなのかを判定するために使われます。Drum Type と Instrument Type はどちらも、サンプルがどのドラムまたはインストゥルメントのカテゴリーに属するかを判定します。それぞれのタイプには、デフォルトの初期化に使う補助として INVALID カテゴリーが定義されています。

さらに、Sample Type、Drum Type、Instrument Type の検出が失敗した場合は、それぞれの INVALID タイプが返され、これらはいずれも -1 として解決されます。Sample Type、Drum Type、Instrument Type の値をログに出力する際、無効な検出結果は数値の形でログに記録されます。ただし、数値が変わらないことは保証されていないため、スクリプト内ではそれぞれの <type.INVALID> 定数と比較することをおすすめします。

例

sampleType = mir.detectSampleType('fullPathToSample')

'fullPathToSample' の絶対ファイルパスにあるオーディオサンプルを解析し、得られたサンプルタイプのカテゴリーを sampleType に格納します。

drumType = mir.detectDrumType('fullPathToSample')

'fullPathToSample' の絶対ファイルパスにあるオーディオサンプルを解析し、得られたドラムタイプのカテゴリーを drumType に格納します。

instType = mir.detectInstrumentType('fullPathToSample')

'fullPathToSample' の絶対ファイルパスにあるオーディオサンプルを解析し、得られたインストゥルメントタイプのカテゴリーを instType に格納します。

sampleTypeBatchData = mir.detectSampleTypeBatch(‘fullPathToFolder’)

'fullPathToFolder' ディレクトリ内のオーディオサンプルを解析し、得られたサンプルタイプをLuaのテーブル sampleTypeBatchData に格納します。

ループ検出

新しい findLoop() というMIR関数は、サンプルのループポイントを解析して提案します。この関数はループ開始とループ終了の2つの変数を返し、それらを使って対象の zone のループポイントを設定できます。

この関数の完全な構文は findLoop(filePath, minStart, maxEnd, minLength) です。パス以外の引数はすべて省略可能です。パスだけを指定した場合、残りの引数はアルゴリズムによって算出されます。

例

local loop_start, loop_end = mir.findLoop(file)
local loop_length = loop_end - loop_start
z.loops[0].start = loop_start
z.loops[0].length = loop_length

参照元情報：Binding Reference
https://docs.native-instruments.com/online-guides/creator-tools-manual/en/binding-reference