summaryrefslogtreecommitdiff
path: root/doc/MML_BNF.md
blob: 3657ecdc294ba0e33b40b2c59535f91dba20cbe6 (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
# 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>+

/* 音符名(Lexer で正規化: ppmck は小文字、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"
```

---

## 2. ppmck モード

### 2.1 全体構造

```bnf
<ppmck_mml>       ::= <ppmck_header>* <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_track>     ::= <track_header> <ppmck_statement>*
<track_header>    ::= "A" | "B" | "T" | "N" | "L"
                    | /* 第2段階: 複合ヘッダー "ACE" 等 */
```

### 2.2 ステートメント

```bnf
<ppmck_statement> ::= <note>
                    | <rest>
                    | <octave_cmd>
                    | <length_cmd>
                    | <volume_cmd>
                    | <duty_cmd>
                    | <tempo_cmd>
                    | <tie_cmd>
                    | <repeat_start>
                    | <repeat_end>
                    | <bar>
                    | <comment>
                    | <newline>

<note>            ::= <note_name> <accidental>? <length>
<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>        ::= "q" <number>          /* q0 〜 q3, Pulse系のみ */
<tempo_cmd>       ::= "t" <number>          /* t1 〜 */

<tie_cmd>         ::= <tie> (<note> | <rest> | <number>)

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

### 2.3 第2段階予定コマンド(未実装、BNF に含める)

```bnf
<ppmck_stage2>    ::= <count_length>
                    | <envelope_def>
                    | <envelope_use>
                    | <duty_envelope_def>
                    | <sweep_cmd>
                    | <section_repeat>
                    | <transpose_cmd>
                    | <noise_mode_cmd>

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

<envelope_def>    ::= "@v" <number> "=" "{" <number_list> "|" <number_list>? "}"
<envelope_use>    ::= "@v" <number>

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

<sweep_cmd>       ::= "s" <number> "," <number>

<section_repeat>  ::= "[" <ppmck_statement>+ "]" <number>?

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

<number_list>     ::= <number> (","? <number>)*
```

---

## 3. pyxel モード

### 3.1 全体構造

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

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

### 3.2 ステートメント

```bnf
<pyxel_statement> ::= <note>
                    | <rest>
                    | <octave_cmd>
                    | <length_cmd>
                    | <volume_cmd>
                    | <gate_cmd>
                    | <tone_cmd>
                    | <tempo_cmd>
                    | <transpose_cmd>
                    | <detune_cmd>
                    | <tie_cmd>
                    | <repeat_start>
                    | <repeat_end>
                    | <bar>
                    | <ext_cmd>
                    | <newline>

<note>            ::= <note_name> <accidental>? <length>
<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 〜 */
<transpose_cmd>   ::= "K" <number>          /* 半音単位 */
<detune_cmd>      ::= "Y" <number>          /* セント単位 */

<tie_cmd>         ::= <tie> (<note> | <rest> | <number>)
```

### 3.3 拡張コマンド(第1段階: IR 保持のみ、合成無視)

```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> "}"
                    | <number>+

<gli_cmd>         ::= "@GLI" <number> <gli_def>?
<gli_def>         ::= "{" <number> "," <number> "}"
                    | <number>+
```

---

## 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 |
| `v` (ppmck) | 0 〜 15 | 15 |
| `V` (pyxel) | 0 〜 127 | 100 |
| `q` (ppmck) | 0 〜 3 | 2 |
| `@` (pyxel) | 0 〜 3 | — |
| `Q` (pyxel) | 0 〜 100 | 80 |
| `t` / `T` | 1 〜 | 120 |

---

## 6. 備考

- 本 BNF は `mml-composemusic-mcp` の**サポート範囲**を定義するものであり、オリジナルの PPMCK や Pyxel の全機能を網羅するものではない。
- 第2段階予定コマンドは BNF に含めるが、第1段階実装では `SEMANTIC_UNSUPPORTED_FEATURE` として警告を返す。
- 詳細な実装アーキテクチャは [Design.md](Design.md) を参照。