summaryrefslogtreecommitdiff
path: root/doc/MML_BNF.md
blob: 60939111c4506c965b236b44cbc9c479914deea4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# MML 構文規則(BNF)

> 本ドキュメントは `mml-composemusic-mcp` がサポートする MML の構文を BNF(Backus-Naur Form)で定義する。
> 対象モード: `ppmck`(PPMCK インスパイア形式)と `pyxel`(Pyxel MML 準拠)。

---

## 1. 共通字句要素

```bnf
/* 基本文字 */
<digit>       ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
<number>      ::= <digit>+

/* 音符名(case-sensitive。受理後のASTでは小文字へ正規化) */
<ppmck_note_name> ::= "c" | "d" | "e" | "f" | "g" | "a" | "b"
<pyxel_note_name> ::= "C" | "D" | "E" | "F" | "G" | "A" | "B"

/* 変化記号 */
<sharp>       ::= "+" | "#"
<flat>        ::= "-"
<accidental>  ::= <sharp> | <flat>

/* 音長 */
<dot>         ::= "."
<length>      ::= <number> <dot>*
              | /* 省略時: デフォルト音長を使用 */

/* オクターブ */
<octave_up>   ::= ">"
<octave_down> ::= "<"

/* タイ・スラー */
<tie>         ::= "&"

/* リピート */
<repeat_start>::= "["
<repeat_end>  ::= "]" <number>?

/* 小節線 */
<bar>         ::= "|"

/* 改行・空白 */
<whitespace>  ::= " " | "\t" | "\r" | "\n"
```

`<whitespace>`は字句間の区切りであり、statementやASTノードではない。`#`はppmckの行頭ヘッダー開始、または両モードで音符名の直後に置くsharpとしてのみ有効である。

---

## 2. ppmck モード

### 2.1 全体構造

```bnf
<ppmck_mml>       ::= <ppmck_header>* <ppmck_global_definition>* <ppmck_track>*

<ppmck_header>    ::= "#" <header_key> <header_value>?
<header_key>      ::= "TITLE" | "COMPOSER" | "PROGRAMER" | "OCTAVE-REV"
                    | "INCLUDE" | "EX-DISKFM" | "EX-NAMCO106" | "BANK-CHANGE"
                    | "EFFECT-INCLUDE"
<header_value>    ::= "\"" <string> "\""

<ppmck_global_definition>
                  ::= <vol_envelope_def> | <duty_envelope_def> | <lfo_def>
                    | <pitch_env_def> | <note_env_def>

<ppmck_track>     ::= <audio_track> | <loop_track>
<audio_track>     ::= <audio_track_header> <ppmck_statement>*
<audio_track_header>
                  ::= "A" | "B" | "T" | "N"
<loop_track>      ::= "L" <loop_statement>*
<loop_statement>  ::= <length_cmd> | <ppmck_rest> | <loop_repeat> | <bar>
<loop_repeat_item>::= <length_cmd> | <ppmck_rest> | <loop_repeat>
<loop_repeat>     ::= "[" <loop_repeat_item>* ("|" <loop_repeat_item>*)? "]" <number>?
```

グローバル定義は全トラック共通である。既存入力との互換性のため、同じ定義を音声トラック内の`<ppmck_ext_cmd>`として置くこともできる。`L`は音声を生成しない制御トラックで、0回または1回だけ記述できる。

### 2.2 ステートメント

```bnf
<ppmck_statement> ::= <ppmck_simple_statement> | <ppmck_repeat> | <bar>

<ppmck_simple_statement>
                  ::= <ppmck_note>
                    | <ppmck_rest>
                    | <octave_cmd>
                    | <length_cmd>
                    | <volume_cmd>
                    | <duty_cmd>
                    | <quantize_cmd>
                    | <tempo_cmd>
                    | <tie_cmd>
                    | <slur_cmd>
                    | <ppmck_ext_cmd>
                    | <comment>

<ppmck_note>      ::= <ppmck_note_name> <accidental>? <length>
<ppmck_rest>      ::= "r" <length>

<octave_cmd>      ::= "o" <number>          /* o0 〜 o7 */
                    | <octave_up>
                    | <octave_down>

<length_cmd>      ::= "l" <number>          /* l1 〜 l192 */
<volume_cmd>      ::= "v" <number>          /* v0 〜 v15 */

<duty_cmd>        ::= "@" <number>          /* @0 〜 @3, Pulse系のみ */
<quantize_cmd>    ::= "q" <number>          /* q1 〜 q8 */
<tempo_cmd>       ::= "t" <number>          /* t1 〜 */

<tie_cmd>         ::= "^" (<ppmck_note> | <number>)
<slur_cmd>        ::= "&" (<ppmck_note> | <ppmck_rest> | <number>)

<comment>         ::= ";" <string_to_eol>

<ppmck_repeat_item>
                  ::= <ppmck_simple_statement> | <ppmck_repeat>
<ppmck_repeat>    ::= "[" <ppmck_repeat_item>* ("|" <ppmck_repeat_item>*)? "]" <number>?
```

`[本体]N`は本体をN回再生する。`[前半|後半]N`は`前半+後半`をN−1回、最後に前半だけを再生する。`N=1`では前半だけとなる。`|`は現在のリピート階層で高々1個で、ネストした`|`は内側に所属する。リピート外の`|`は小節線である。回数省略は無限を表し、IRプレビューでは`前半+後半`を2回展開して`repeat_count=0`を保持する。

### 2.3 合成拡張コマンド

```bnf
<ppmck_ext_cmd>  ::= <relative_volume_cmd>
                    | <detune_cmd>
                    | <sweep_cmd>
                    | <vol_envelope_def>
                    | <vol_envelope_use>
                    | <duty_envelope_def>
                    | <duty_envelope_use>
                    | <lfo_def>
                    | <lfo_use>
                    | <lfo_off>
                    | <pitch_env_def>
                    | <pitch_env_use>
                    | <pitch_env_off>
                    | <note_env_def>
                    | <note_env_use>
                    | <note_env_off>

<relative_volume_cmd>
                  ::= "v+" <number>?        /* 省略時1、1 〜 15 */
                    | "v-" <number>?        /* 省略時1、1 〜 15 */

<detune_cmd>      ::= "D" <signed_number>  /* -127 〜 126 */
<sweep_cmd>       ::= "s" <number> "," <signed_number>

<vol_envelope_def>::= "@v" <number> "=" "{" <number_list> ("|" <number_list>?)? "}"
<vol_envelope_use>::= "@v" <number>

<duty_envelope_def>::= "@" <number> "=" "{" <number_list> ("|" <number_list>?)? "}"
<duty_envelope_use>::= "@@" <number>

<lfo_def>        ::= "@MP" <number> "=" "{" <number> "," <number> "," <number> "," <number> "}"
<lfo_use>        ::= "MP" <number>
<lfo_off>        ::= "MPOF"

<pitch_env_def>   ::= "@EP" <number> "=" "{" <signed_number_list> ("|" <signed_number_list>?)? "}"
<pitch_env_use>   ::= "EP" <number>
<pitch_env_off>   ::= "EPOF"

<note_env_def>    ::= "@EN" <number> "=" "{" <signed_number_list> ("|" <signed_number_list>?)? "}"
<note_env_use>    ::= "EN" <number>
<note_env_off>   ::= "ENOF"

<signed_number>   ::= ("+" | "-")? <number>
<number_list>     ::= <number> (","? <number>)*
<signed_number_list> ::= <signed_number> (","? <signed_number>)*
```

### 2.4 将来予定コマンド(現在の受理文法には含めない)

以下は設計予約であり、現在は構文エラーになる。実装時に受理文法へ移す。

```bnf
<ppmck_stage2>    ::= <count_length>
                    | <transpose_cmd>
                    | <noise_mode_cmd>

<count_length>    ::= <ppmck_note_name> <accidental>? "%" <number>

<transpose_cmd>   ::= "K" <number>
<noise_mode_cmd>  ::= "m" <number>
```


---

## 3. pyxel モード

### 3.1 全体構造

```bnf
<pyxel_mml>       ::= <pyxel_track>*

<pyxel_track>     ::= <pyxel_track_header> <pyxel_statement>*
<pyxel_track_header>
                  ::= "0:" | "1:" | "2:" | "3:"
```

### 3.2 ステートメント

```bnf
<pyxel_statement> ::= <pyxel_note>
                    | <pyxel_rest>
                    | <octave_cmd>
                    | <length_cmd>
                    | <volume_cmd>
                    | <gate_cmd>
                    | <tone_cmd>
                    | <tempo_cmd>
                    | <transpose_cmd>
                    | <detune_cmd>
                    | <tie_cmd>
                    | <pyxel_repeat>
                    | <bar>
                    | <ext_cmd>

<pyxel_note>      ::= <pyxel_note_name> <accidental>? <length>
<pyxel_rest>      ::= "R" <length>

<octave_cmd>      ::= "O" <number>          /* O0 〜 O7 */
                    | <octave_up>
                    | <octave_down>

<length_cmd>      ::= "L" <number>          /* L1 〜 L192 */
<volume_cmd>      ::= "V" <number>          /* V0 〜 V127 */
<gate_cmd>        ::= "Q" <number>          /* Q0 〜 Q100 */
<tone_cmd>        ::= "@" <number>          /* @0 〜 @3, Pulse系のみ有効 */
<tempo_cmd>       ::= "T" <number>          /* T1 〜 */
<signed_number>   ::= ("+" | "-")? <number>
<transpose_cmd>   ::= "K" <signed_number>   /* 半音単位 */
<detune_cmd>      ::= "Y" <signed_number>   /* セント単位 */

<tie_cmd>         ::= <tie> (<pyxel_note> | <pyxel_rest> | <number>)
<pyxel_repeat>    ::= "[" <pyxel_statement>* "]" <number>?
```

Pyxelリピートはネストできる。指定回数は1以上で、回数省略は無限を表す。IRプレビューでは本体を2回展開し、`repeat_count=0`を保持する。Pyxelの`|`は常に小節線であり、終端分岐ではない。

### 3.3 合成拡張コマンド

```bnf
<ext_cmd>         ::= <env_cmd> | <vib_cmd> | <gli_cmd>

<env_cmd>         ::= "@ENV" <number> <env_def>?
<env_def>         ::= <number> <number> (<number> <number>)*

<vib_cmd>         ::= "@VIB" <number> <vib_def>?
<vib_def>         ::= <number> <number> <number>

<gli_cmd>         ::= "@GLI" <number> <gli_def>?
<gli_def>         ::= <number> <number>
```

slot 0は解除専用で、パラメータを指定できない。slot 1以上ではパラメータ付きの初出を定義、パラメータなしを既定義slotの選択として扱う。Pyxel公式の波括弧、カンマ、負数、`*`を使う拡張形式は本受理文法に含めない。

---

## 4. トラック・チャンネル対応

| ppmck | pyxel | チャンネル | 種別 |
|---|---|---|---|
| `A` | `0:` | Pulse1 | 矩形波 |
| `B` | `1:` | Pulse2 | 矩形波 |
| `T` | `2:` | Triangle | 三角波 |
| `N` | `3:` | Noise | ノイズ |
| `L` | — | Loop | 全体ループ(ppmck のみ) |

---

## 5. 値範囲

| コマンド | モード | 有効範囲 | デフォルト | 備考 |
|---|---|---|---|---|
| `o` / `O` | 両方 | 0 〜 7 | 4 | |
| `l` / `L` | 両方 | 1 〜 192 | 4 | |
| 音符・休符の明示音長 | 両方 | 1 〜 192 | 現在の`l`/`L` | |
| タイ対象の音長 | 両方 | 1 〜 192 | — | |
| `v` | ppmck | 0 〜 15 | 15 | |
| `V` | pyxel | 0 〜 127 | 100 | |
| `v+` / `v-` | ppmck | 1 〜 15 | 1 | 相対音量(0〜15へクランプ) |
| `@` | ppmck | 0 〜 3 | 2 | デューティ比(Pulse系のみ) |
| `@` | pyxel | 0 〜 3 | — | デューティ比(Pulse系のみ) |
| `q` | ppmck | 1 〜 8 | 8 | クオンタイズ(gate_time = value / 8) |
| `Q` | pyxel | 0 〜 100 | 80 | ゲートタイム(%) |
| `t` / `T` | 両方 | 1 〜 | 120 | |
| `D` | ppmck | -127 〜 126 | 0 | cent単位ディチューン |
| `s` | ppmck | speed 0〜7, depth ±1〜±7 | — | Pulseハードウェアスイープ |
| `@v` | ppmck | 0 〜 255 | — | 48 tick単位の音量エンベロープ |
| `@@` | ppmck | 0 〜 255 | — | 48 tick単位のデューティエンベロープ |
| `@MP` / `MP` / `MPOF` | ppmck | 0 〜 255 | — | 三角LFO |
| `@EP` / `EP` / `EPOF` | ppmck | 0 〜 255 | — | cent単位ピッチエンベロープ |
| `@EN` / `EN` / `ENOF` | ppmck | 0 〜 255 | — | 絶対半音オフセット列 |
| ppmck envelope slot | ppmck | 0 〜 255 | — | 全定義・参照共通 |
| volume envelope要素 | ppmck | 0 〜 15 | — | |
| duty envelope要素 | ppmck | 0 〜 3 | — | |
| pitch/note envelope要素 | ppmck | -127 〜 126 | — | |
| `@MP`要素 | ppmck | delay 0〜255, period 1〜255, depth 0〜255, 第4値0 | — | |
| `K` | pyxel | -127 〜 127 | 0 | トランスポーズ(半音) |
| `Y` | pyxel | -127 〜 127 | 0 | ディチューン(セント) |
| リピート回数 | 両方 | 1以上、または省略(無限) | 省略 | 展開後は各トラック100,000イベント以下 |

---

## 6. 備考

- 本 BNF は `mml-composemusic-mcp` の**サポート範囲**を定義するものであり、オリジナルの PPMCK や Pyxel の全機能を網羅するものではない。
- 第2段階予定コマンドは設計予約として記載するが、現在の受理文法には含めない。
- ppmck モード名は構文互換の識別子であり、拡張の挙動は本プロジェクト独自仕様である。PPMCK/mckc互換は保証しない。
- ppmck の列型エンベロープは1要素48 tickで、`|`以降を反復し、反復がなければ末尾値を保持する。`D`/`@EP`はcent、`@EN`は絶対半音、`@MP`は`delay,period,depth,0`である。
- pyxel の `@ENV` は`target,duration`組、`@VIB`は`delay,period,depth_cents`、`@GLI`は`initial_offset_cents,duration`である。slot 0は解除を表す。
- コマンド文字は ppmck では小文字、pyxel では大文字を使用する。音符・休符も同じ規則に従う。ただし ppmck の `D`(ディチューン)は大文字のみ受理する(小文字 `d` は音符)。
- `^` は ppmck モード専用のタイ、`&` は両モード共通のスラー(slur)として扱う。
- 詳細な実装アーキテクチャは [Design.md](Design.md) を参照。