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.md33
1 files changed, 21 insertions, 12 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index 039c62cdf..38861e8c1 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -61,10 +61,19 @@ It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif
61 61
62The available keycodes for audio are: 62The available keycodes for audio are:
63 63
64* `AU_ON` - Turn audio mode on 64* `AU_ON` - Turn Audio Feature on
65* `AU_OFF` - Turn audio mode off 65* `AU_OFF` - Turn Audio Feature off
66* `AU_TOG` - Toggle audio mode 66* `AU_TOG` - Toggle Audio Feature state
67 67
68!> These keycodes turn all of the audio functionality on and off. Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely.
69
70## ARM Audio Volume
71
72For ARM devices, you can adjust the DAC sample values. If your board is too loud for you or your coworkers, you can set the max using `DAC_SAMPLE_MAX` in your `config.h`:
73
74```c
75#define DAC_SAMPLE_MAX 65535U
76```
68 77
69## Music Mode 78## Music Mode
70 79
@@ -119,22 +128,22 @@ You can completely disable Music Mode as well. This is useful, if you're pressed
119 128
120 #define NO_MUSIC_MODE 129 #define NO_MUSIC_MODE
121 130
122## Faux Click 131## Audio Click
123 132
124This adds a click sound each time you hit a button, to simulate click sounds from the keyboard. And the sounds are slightly different for each keypress, so it doesn't sound like a single long note, if you type rapidly. 133This adds a click sound each time you hit a button, to simulate click sounds from the keyboard. And the sounds are slightly different for each keypress, so it doesn't sound like a single long note, if you type rapidly.
125 134
126* `CK_TOGG` - Toggles the status (will play sound if enabled) 135* `CK_TOGG` - Toggles the status (will play sound if enabled)
127* `CK_RST` - Resets the frequency to the default state 136* `CK_ON` - Turns on Audio Click (plays sound)
128* `CK_UP` - Increases the frequency of the clicks 137* `CK_OFF` - Turns off Audio Click (doesn't play sound)
129* `CK_DOWN` - Decreases the frequency of the clicks 138* `CK_RST` - Resets the frequency to the default state (plays sound at default frequency)
139* `CK_UP` - Increases the frequency of the clicks (plays sound at new frequency)
140* `CK_DOWN` - Decreases the frequency of the clicks (plays sound at new frequency)
141
130 142
131The feature is disabled by default, to save space. To enable it, add this to your `config.h`: 143The feature is disabled by default, to save space. To enable it, add this to your `config.h`:
132 144
133 #define AUDIO_CLICKY 145 #define AUDIO_CLICKY
134 146
135Additionally, even when enabled, the feature is not enabled by default, so you would need to turn it on first. And since we don't use EEPROM to store the setting (yet), you can default this to on by adding this to your `config.h`:
136
137 #define AUDIO_CLICKY_ON
138 147
139You can configure the default, min and max frequencies, the stepping and built in randomness by defining these values: 148You can configure the default, min and max frequencies, the stepping and built in randomness by defining these values:
140 149
@@ -144,14 +153,14 @@ You can configure the default, min and max frequencies, the stepping and built i
144| `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). | 153| `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). |
145| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. | 154| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. |
146| `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. | 155| `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. |
147| `AUDIO_CLICKY_FREQ_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical. | 156| `AUDIO_CLICKY_FREQ_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical, and `1.0f` will make this sound much like the 90's computer screen scrolling/typing effect. |
148 157
149 158
150 159
151 160
152## MIDI Functionality 161## MIDI Functionality
153 162
154This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile. 163This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile.
155 164
156 165
157## Audio Keycodes 166## Audio Keycodes