diff options
| author | wxyangf <2058629+wxyangf@users.noreply.github.com> | 2021-06-07 02:53:20 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-06 23:53:20 -0700 |
| commit | b10728edc1ce897939833ccca447640804888854 (patch) | |
| tree | 81775c467ec8b59bd59415fa85659537e5edae15 /docs/feature_audio.md | |
| parent | 94e80912a4cda3a92f6865cf0b5a199fd97ae95b (diff) | |
| download | qmk_firmware-b10728edc1ce897939833ccca447640804888854.tar.gz qmk_firmware-b10728edc1ce897939833ccca447640804888854.zip | |
[Docs] added basic midi documention of common features (#13113)
Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'docs/feature_audio.md')
| -rw-r--r-- | docs/feature_audio.md | 114 |
1 files changed, 1 insertions, 113 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md index 2c440c951..b7b572974 100644 --- a/docs/feature_audio.md +++ b/docs/feature_audio.md | |||
| @@ -301,8 +301,7 @@ You can configure the default, min and max frequencies, the stepping and built i | |||
| 301 | 301 | ||
| 302 | ## MIDI Functionality | 302 | ## MIDI Functionality |
| 303 | 303 | ||
| 304 | This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile. | 304 | See [MIDI](feature_midi.md) |
| 305 | |||
| 306 | 305 | ||
| 307 | ## Audio Keycodes | 306 | ## Audio Keycodes |
| 308 | 307 | ||
| @@ -319,114 +318,3 @@ This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to s | |||
| 319 | |`MU_OFF` | |Turns off Music Mode | | 318 | |`MU_OFF` | |Turns off Music Mode | |
| 320 | |`MU_TOG` | |Toggles Music Mode | | 319 | |`MU_TOG` | |Toggles Music Mode | |
| 321 | |`MU_MOD` | |Cycles through the music modes | | 320 | |`MU_MOD` | |Cycles through the music modes | |
| 322 | |||
| 323 | <!-- FIXME: this formatting needs work | ||
| 324 | |||
| 325 | ## Audio | ||
| 326 | |||
| 327 | ```c | ||
| 328 | #ifdef AUDIO_ENABLE | ||
| 329 | AU_ON, | ||
| 330 | AU_OFF, | ||
| 331 | AU_TOG, | ||
| 332 | |||
| 333 | // Music mode on/off/toggle | ||
| 334 | MU_ON, | ||
| 335 | MU_OFF, | ||
| 336 | MU_TOG, | ||
| 337 | |||
| 338 | // Music voice iterate | ||
| 339 | MUV_IN, | ||
| 340 | MUV_DE, | ||
| 341 | #endif | ||
| 342 | ``` | ||
| 343 | |||
| 344 | ### Midi | ||
| 345 | |||
| 346 | #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC)) | ||
| 347 | MI_ON, // send midi notes when music mode is enabled | ||
| 348 | MI_OFF, // don't send midi notes when music mode is enabled | ||
| 349 | #endif | ||
| 350 | |||
| 351 | MIDI_TONE_MIN, | ||
| 352 | MIDI_TONE_MAX | ||
| 353 | |||
| 354 | MI_C = MIDI_TONE_MIN, | ||
| 355 | MI_Cs, | ||
| 356 | MI_Db = MI_Cs, | ||
| 357 | MI_D, | ||
| 358 | MI_Ds, | ||
| 359 | MI_Eb = MI_Ds, | ||
| 360 | MI_E, | ||
| 361 | MI_F, | ||
| 362 | MI_Fs, | ||
| 363 | MI_Gb = MI_Fs, | ||
| 364 | MI_G, | ||
| 365 | MI_Gs, | ||
| 366 | MI_Ab = MI_Gs, | ||
| 367 | MI_A, | ||
| 368 | MI_As, | ||
| 369 | MI_Bb = MI_As, | ||
| 370 | MI_B, | ||
| 371 | |||
| 372 | MIDI_TONE_KEYCODE_OCTAVES > 1 | ||
| 373 | |||
| 374 | where x = 1-5: | ||
| 375 | MI_C_x, | ||
| 376 | MI_Cs_x, | ||
| 377 | MI_Db_x = MI_Cs_x, | ||
| 378 | MI_D_x, | ||
| 379 | MI_Ds_x, | ||
| 380 | MI_Eb_x = MI_Ds_x, | ||
| 381 | MI_E_x, | ||
| 382 | MI_F_x, | ||
| 383 | MI_Fs_x, | ||
| 384 | MI_Gb_x = MI_Fs_x, | ||
| 385 | MI_G_x, | ||
| 386 | MI_Gs_x, | ||
| 387 | MI_Ab_x = MI_Gs_x, | ||
| 388 | MI_A_x, | ||
| 389 | MI_As_x, | ||
| 390 | MI_Bb_x = MI_As_x, | ||
| 391 | MI_B_x, | ||
| 392 | |||
| 393 | MI_OCT_Nx 1-2 | ||
| 394 | MI_OCT_x 0-7 | ||
| 395 | MIDI_OCTAVE_MIN = MI_OCT_N2, | ||
| 396 | MIDI_OCTAVE_MAX = MI_OCT_7, | ||
| 397 | MI_OCTD, // octave down | ||
| 398 | MI_OCTU, // octave up | ||
| 399 | |||
| 400 | MI_TRNS_Nx 1-6 | ||
| 401 | MI_TRNS_x 0-6 | ||
| 402 | MIDI_TRANSPOSE_MIN = MI_TRNS_N6, | ||
| 403 | MIDI_TRANSPOSE_MAX = MI_TRNS_6, | ||
| 404 | MI_TRNSD, // transpose down | ||
| 405 | MI_TRNSU, // transpose up | ||
| 406 | |||
| 407 | MI_VEL_x 1-10 | ||
| 408 | MIDI_VELOCITY_MIN = MI_VEL_1, | ||
| 409 | MIDI_VELOCITY_MAX = MI_VEL_9, | ||
| 410 | MI_VELD, // velocity down | ||
| 411 | MI_VELU, // velocity up | ||
| 412 | |||
| 413 | MI_CHx 1-16 | ||
| 414 | MIDI_CHANNEL_MIN = MI_CH1 | ||
| 415 | MIDI_CHANNEL_MAX = MI_CH16, | ||
| 416 | MI_CHD, // previous channel | ||
| 417 | MI_CHU, // next channel | ||
| 418 | |||
| 419 | MI_ALLOFF, // all notes off | ||
| 420 | |||
| 421 | MI_SUS, // sustain | ||
| 422 | MI_PORT, // portamento | ||
| 423 | MI_SOST, // sostenuto | ||
| 424 | MI_SOFT, // soft pedal | ||
| 425 | MI_LEG, // legato | ||
| 426 | |||
| 427 | MI_MOD, // modulation | ||
| 428 | MI_MODSD, // decrease modulation speed | ||
| 429 | MI_MODSU, // increase modulation speed | ||
| 430 | #endif // MIDI_ADVANCED | ||
| 431 | |||
| 432 | --> | ||
