Skip to content

JavaScript API 参照

config 内の音楽用語

formkeyisMinorcharacterscaletargetBars は、API 値を音楽上の判断に対応させるフィールドです。プログラミング以外の用語はエンジニアのための音楽用語入門オプション関係を参照してください。

初期化

init(options?)

WASM モジュールをロードし初期化します。BachGenerator インスタンスを作成する前に必ず呼び出してください。

js
import { init } from '@libraz/midi-sketch-bach'

// Node.js(WASM パスは自動解決)
await init()

// ブラウザ(WASM パスを指定)
await init({ wasmPath: '/wasm/bach.wasm' })

パラメータ:

パラメータ説明
options.wasmPathstring.wasm ファイルへのパス。ブラウザ環境では必須。

戻り値: Promise<void>


BachGenerator

バッハ風の楽曲を生成するメインクラス。

コンストラクタ

js
const generator = new BachGenerator()

新しいジェネレータインスタンスを作成します。インスタンス作成前に init() を呼び出してください。

generate(config?)

指定された設定に基づいて楽曲を生成します。

js
generator.generate({
  form: 'fugue',
  key: 2,
  isMinor: true,
  character: 'severe',
  bpm: 80,
  seed: 42
})

パラメータ: 後述の BachConfig を参照。

戻り値: void

厳格な検証

無効な formcharacterinstrumentscale 文字列、および範囲外の bpm(0 または 40--200 以外)は、既定へ暗黙的に代替せずエラーを投げるようになりました。禁止された性格と形式の組み合わせ(オプション関係を参照)も例外を投げます。

getMidi()

生成された楽曲を標準 MIDI ファイルデータとして返します。

js
const midi = generator.getMidi()
// midiは有効な.midファイルを含むUint8Array

戻り値: Uint8Array

getEvents()

メタデータと個別のノートイベントを含む構造化イベントデータを返します。

js
const events = generator.getEvents()
console.log(events.form)        // "fugue"
console.log(events.key)         // "D minor"
console.log(events.bpm)         // 80
console.log(events.total_bars)  // 42
console.log(events.tracks)      // TrackDataの配列

ピッチは C で生成される

エンジンは内部的に C で作曲し、指定された key はMIDI ファイル書き出し時に適用されます。そのためイベント JSON のピッチは C のまま報告され、getMidi() が返す .mid ファイルは選択した調に移調されます。

戻り値: EventData

getInfo()

ジェネレータとその現在の状態に関する情報を返します。

js
const info = generator.getInfo()
console.log(info.seedUsed)    // 解決されたシード(seed: 0 を指定しても非ゼロ)
console.log(info.totalBars)   // 解決された小節数
console.log(info.bpm)         // 実際に使用されたBPM
console.log(info.trackCount)  // トラック数

seed: 0(ランダム)を渡すと、この実行で実際に選択されたシードが getInfo().seedUsed として報告されます。同じ出力を再現するにはその値を再利用してください。

戻り値: BachInfo

destroy()

このジェネレータが確保したWASM メモリを解放します。使用後は必ず呼び出してください。

js
generator.destroy()

WARNING

destroy() を呼び出した後、そのジェネレータインスタンスは再利用できません。別の楽曲を生成する場合は、新しい BachGenerator を作成してください。


BachConfig

generate() に渡す設定オブジェクト。すべてのフィールドはオプションです。

フィールド既定説明
formnumber | string"fugue"楽曲形式(0--9または名前)。楽曲形式プリセット一覧を参照。
keynumber0調(0--11のピッチクラス: 0=C, 1=C#, 2=D, ... 11=B)
isMinorbooleanfalsetrue で短調、false で長調
bpmnumber100テンポ(BPM)。0 は既定の100を使用。それ以外は 40--200 の範囲が必須(範囲外では例外)。
seednumber0ランダムシード。0 は非ゼロのランダムシードを選び、getInfo().seedUsed で報告。
characterstring | number"severe"主題の性格("severe""playful""noble""restless")。無効値では例外。
instrumentstring | number形式の既定楽器("organ""harpsichord""piano""violin""cello""guitar")。無効値では例外。
scalestring | number"short"形式の基準長に対する倍率: "short"(約1倍)、"medium"(約2倍)、"long"(約3倍)、"full"(約4倍)。無効値では例外。
targetBarsnumber--明示的な小節数。> 0 のとき scale を上書きし、形式の刻みにスナップして [最小, 128] に丸め込み。

numVoices は廃止されました

声部数は form によって決定されます(楽曲形式の表を参照)。後方互換のため num_voices/numVoices の指定は受理されますが無視されます。エラーにはならず、効果もありません。

楽曲形式の値

形式は番号または名前文字列で指定できます。

番号文字列
0"fugue"
1"prelude_and_fugue"
2"trio_sonata"
3"chorale_prelude"
4"toccata_and_fugue"
5"passacaglia"
6"fantasia_and_fugue"
7"cello_prelude"
8"chaconne"
9"goldberg_variations"

楽器の値

番号文字列
0"organ"
1"harpsichord"
2"piano"
3"violin"
4"cello"
5"guitar"

性格の値

番号文字列説明
0"severe"厳格で知的に緻密(既定)
1"playful"軽快で機敏、リズミカル
2"noble"荘重で広やか、威厳のある
3"restless"推進力があり半音階的で劇的

スケールの値

scale は形式の基準長を倍率で伸ばします(楽曲形式を参照)。targetBars がこれを上書きします。

番号文字列おおよその長さ
0"short"基準長の約1倍(既定)
1"medium"基準長の約2倍
2"long"基準長の約3倍
3"full"基準長の約4倍

レスポンス型

EventData

ts
interface EventData {
  form: string          // 形式名(例: "fugue")
  key: string           // 指定された調名(例: "D minor")
  bpm: number           // テンポ
  seed: number          // 生成に使用された解決済みシード
  total_ticks: number   // MIDIティック単位の総時間
  total_bars: number    // 総小節数
  description: string   // 人間が読める説明文
  tracks: TrackData[]   // トラックデータの配列
}

TrackData

ts
interface TrackData {
  name: string          // トラック名(例: "Soprano", "Bass")
  channel: number       // MIDI チャンネル(0-15)
  program: number       // General MIDI プログラム番号
  note_count: number    // このトラックのノート数
  notes: NoteEvent[]    // ノートイベントの配列
}

NoteEvent

ts
interface NoteEvent {
  pitch: number         // MIDI ノート番号(0-127)、C で生成
  velocity: number      // ノートベロシティ(0-127)
  start_tick: number    // MIDIティック単位の開始時間
  duration: number      // MIDIティック単位の長さ
  voice: number         // 声部インデックス
  source: string        // 由来: "material" | "compose" | "ornament"
}

ノートの由来(source

すべてのノートは生成方法を記録する source タグを持ちます。

  • "material" — 形式が割り当てた固定素材(主題、グラウンドバス、定旋律)。
  • "compose" — 和声プランに対して候補探索が選択したノート。
  • "ornament" — 装飾処理(トリル、モルデント、ナッハシュラーク)が追加したノート。

プリセット列挙関数

これらの関数は、利用可能なオプションを記述する PresetInfo オブジェクトの配列を返します。

getForms()

js
import { getForms } from '@libraz/midi-sketch-bach'

const forms = getForms()
// [{ id: 0, name: "fugue", display: "Fugue" }, ...]

getInstruments()

js
import { getInstruments } from '@libraz/midi-sketch-bach'

const instruments = getInstruments()
// [{ id: 0, name: "organ" }, ...]

getCharacters()

js
import { getCharacters } from '@libraz/midi-sketch-bach'

const characters = getCharacters()

getKeys()

js
import { getKeys } from '@libraz/midi-sketch-bach'

const keys = getKeys()
// [{ id: 0, name: "C" }, { id: 1, name: "C#" }, ...]

getScales()

js
import { getScales } from '@libraz/midi-sketch-bach'

const scales = getScales()
// [{ id: 0, name: "short" }, ...]

getVersion()

js
import { getVersion } from '@libraz/midi-sketch-bach'

const version = getVersion()
// 例: "0.1.0"

完全な使用例

フーガを生成して保存

js
import { init, BachGenerator } from '@libraz/midi-sketch-bach'
import { writeFileSync } from 'fs'

await init()

const generator = new BachGenerator()
generator.generate({
  form: 'fugue',
  key: 2,
  isMinor: true,
  character: 'severe',
  bpm: 76,
  seed: 12345
})

writeFileSync('fugue-d-minor.mid', generator.getMidi())

const events = generator.getEvents()
console.log(`生成完了: ${events.description}`)
console.log(`小節数: ${events.total_bars}, トラック数: ${events.tracks.length}`)

for (const track of events.tracks) {
  console.log(`  ${track.name}: ${track.note_count} ノート`)
}

generator.destroy()

すべての形式を生成

js
import { init, BachGenerator, getForms } from '@libraz/midi-sketch-bach'
import { writeFileSync } from 'fs'

await init()

const forms = getForms()
const generator = new BachGenerator()

for (const form of forms) {
  generator.generate({
    form: form.name,
    key: 2,
    isMinor: true,
    seed: 42
  })

  // form.name は最初から snake_case(例: "prelude_and_fugue")。表示用の名前には form.display を使う
  const filename = `bach-${form.name}.mid`
  writeFileSync(filename, generator.getMidi())
  console.log(`保存: ${filename}`)
}

generator.destroy()

ブラウザ: 生成してダウンロード

js
import { init, BachGenerator } from '@libraz/midi-sketch-bach'

await init({ wasmPath: '/wasm/bach.wasm' })

const generator = new BachGenerator()
generator.generate({
  form: 'fugue',
  key: 0,
  isMinor: false
})

const midi = generator.getMidi()
const blob = new Blob([midi], { type: 'audio/midi' })
const url = URL.createObjectURL(blob)

const a = document.createElement('a')
a.href = url
a.download = 'bach-fugue.mid'
a.click()

URL.revokeObjectURL(url)
generator.destroy()

Dual-licensed: AGPL-3.0 · commercial licensing available. Generated MIDI is yours to use freely.