aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_audio.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_audio.md')
-rw-r--r--docs/feature_audio.md118
1 files changed, 118 insertions, 0 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
new file mode 100644
index 000000000..6b476880d
--- /dev/null
+++ b/docs/feature_audio.md
@@ -0,0 +1,118 @@
1# Audio
2
3<!-- FIXME: this formatting needs work
4
5## Audio
6
7```c
8#ifdef AUDIO_ENABLE
9 AU_ON,
10 AU_OFF,
11 AU_TOG,
12
13 #ifdef FAUXCLICKY_ENABLE
14 FC_ON,
15 FC_OFF,
16 FC_TOG,
17 #endif
18
19 // Music mode on/off/toggle
20 MU_ON,
21 MU_OFF,
22 MU_TOG,
23
24 // Music voice iterate
25 MUV_IN,
26 MUV_DE,
27#endif
28```
29
30### Midi
31
32#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
33 MI_ON, // send midi notes when music mode is enabled
34 MI_OFF, // don't send midi notes when music mode is enabled
35#endif
36
37MIDI_TONE_MIN,
38MIDI_TONE_MAX
39
40MI_C = MIDI_TONE_MIN,
41MI_Cs,
42MI_Db = MI_Cs,
43MI_D,
44MI_Ds,
45MI_Eb = MI_Ds,
46MI_E,
47MI_F,
48MI_Fs,
49MI_Gb = MI_Fs,
50MI_G,
51MI_Gs,
52MI_Ab = MI_Gs,
53MI_A,
54MI_As,
55MI_Bb = MI_As,
56MI_B,
57
58MIDI_TONE_KEYCODE_OCTAVES > 1
59
60where x = 1-5:
61MI_C_x,
62MI_Cs_x,
63MI_Db_x = MI_Cs_x,
64MI_D_x,
65MI_Ds_x,
66MI_Eb_x = MI_Ds_x,
67MI_E_x,
68MI_F_x,
69MI_Fs_x,
70MI_Gb_x = MI_Fs_x,
71MI_G_x,
72MI_Gs_x,
73MI_Ab_x = MI_Gs_x,
74MI_A_x,
75MI_As_x,
76MI_Bb_x = MI_As_x,
77MI_B_x,
78
79MI_OCT_Nx 1-2
80MI_OCT_x 0-7
81MIDI_OCTAVE_MIN = MI_OCT_N2,
82MIDI_OCTAVE_MAX = MI_OCT_7,
83MI_OCTD, // octave down
84MI_OCTU, // octave up
85
86MI_TRNS_Nx 1-6
87MI_TRNS_x 0-6
88MIDI_TRANSPOSE_MIN = MI_TRNS_N6,
89MIDI_TRANSPOSE_MAX = MI_TRNS_6,
90MI_TRNSD, // transpose down
91MI_TRNSU, // transpose up
92
93MI_VEL_x 1-10
94MIDI_VELOCITY_MIN = MI_VEL_1,
95MIDI_VELOCITY_MAX = MI_VEL_9,
96MI_VELD, // velocity down
97MI_VELU, // velocity up
98
99MI_CHx 1-16
100MIDI_CHANNEL_MIN = MI_CH1
101MIDI_CHANNEL_MAX = MI_CH16,
102MI_CHD, // previous channel
103MI_CHU, // next channel
104
105MI_ALLOFF, // all notes off
106
107MI_SUS, // sustain
108MI_PORT, // portamento
109MI_SOST, // sostenuto
110MI_SOFT, // soft pedal
111MI_LEG, // legato
112
113MI_MOD, // modulation
114MI_MODSD, // decrease modulation speed
115MI_MODSU, // increase modulation speed
116#endif // MIDI_ADVANCED
117
118-->