docs/feature_audio.md

   1 # Audio
   2
   3 Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any AVR keyboard that allows access to certain PWM-capable pins, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
   4
   5 Up to two simultaneous audio voices are supported, one driven by timer 1 and another driven by timer 3.  The following pins can be defined as audio outputs in config.h:
   6
   7 Timer 1:
   8 `#define B5_AUDIO`
   9 `#define B6_AUDIO`
  10 `#define B7_AUDIO`
  11
  12 Timer 3:
  13 `#define C4_AUDIO`
  14 `#define C5_AUDIO`
  15 `#define C6_AUDIO`
  16
  17 If you add `AUDIO_ENABLE = yes` to your `rules.mk`, there's a couple different sounds that will automatically be enabled without any other configuration:
  18
  19 ```
  20 STARTUP_SONG // plays when the keyboard starts up (audio.c)
  21 GOODBYE_SONG // plays when you press the RESET key (quantum.c)
  22 AG_NORM_SONG // plays when you press AG_NORM (quantum.c)
  23 AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)
  24 MUSIC_ON_SONG // plays when music mode is activated (process_music.c)
  25 MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c)
  26 CHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c)
  27 GUITAR_SONG // plays when the guitar music mode is selected (process_music.c)
  28 VIOLIN_SONG // plays when the violin music mode is selected (process_music.c)
  29 MAJOR_SONG // plays when the major music mode is selected (process_music.c)
  30 ```
  31
  32 You can override the default songs by doing something like this in your `config.h`:
  33
  34 ```c
  35 #ifdef AUDIO_ENABLE
  36   #define STARTUP_SONG SONG(STARTUP_SOUND)
  37 #endif
  38 ```
  39
  40 A full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h).
  41
  42 To play a custom sound at a particular time, you can define a song like this (near the top of the file):
  43
  44 ```c
  45 float my_song[][2] = SONG(QWERTY_SOUND);
  46 ```
  47
  48 And then play your song like this:
  49
  50 ```c
  51 PLAY_SONG(my_song);
  52 ```
  53
  54 Alternatively, you can play it in a loop like this:
  55
  56 ```c
  57 PLAY_LOOP(my_song);
  58 ```
  59
  60 It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif` to avoid causing problems when audio isn't built into the keyboard.
  61
  62 The available keycodes for audio are:
  63
  64 * `AU_ON` - Turn Audio Feature on
  65 * `AU_OFF` - Turn Audio Feature off
  66 * `AU_TOG` - Toggle Audio Feature state
  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
  72 For 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 ```
  77
  78 ## Music Mode
  79
  80 The music mode maps your columns to a chromatic scale, and your rows to octaves. This works best with ortholinear keyboards, but can be made to work with others. All keycodes less than `0xFF` get blocked, so you won't type while playing notes - if you have special keys/mods, those will still work. A work-around for this is to jump to a different layer with KC_NOs before (or after) enabling music mode.
  81
  82 Recording is experimental due to some memory issues - if you experience some weird behavior, unplugging/replugging your keyboard will fix things.
  83
  84 Keycodes available:
  85
  86 * `MU_ON` - Turn music mode on
  87 * `MU_OFF` - Turn music mode off
  88 * `MU_TOG` - Toggle music mode
  89 * `MU_MOD` - Cycle through the music modes:
  90   * `CHROMATIC_MODE` - Chromatic scale, row changes the octave
  91   * `GUITAR_MODE` - Chromatic scale, but the row changes the string (+5 st)
  92   * `VIOLIN_MODE` - Chromatic scale, but the row changes the string (+7 st)
  93   * `MAJOR_MODE` - Major scale
  94
  95 In music mode, the following keycodes work differently, and don't pass through:
  96
  97 * `LCTL` - start a recording
  98 * `LALT` - stop recording/stop playing
  99 * `LGUI` - play recording
 100 * `KC_UP` - speed-up playback
 101 * `KC_DOWN` - slow-down playback
 102
 103 By default, `MUSIC_MASK` is set to `keycode < 0xFF` which means keycodes less than `0xFF` are turned into notes, and don't output anything. You can change this by defining this in your `config.h` like this:
 104
 105     #define MUSIC_MASK keycode != KC_NO
 106
 107 Which will capture all keycodes - be careful, this will get you stuck in music mode until you restart your keyboard!
 108
 109 For a more advanced way to control which keycodes should still be processed, you can use `music_mask_kb(keycode)` in `<keyboard>.c` and `music_mask_user(keycode)` in your `keymap.c`:
 110
 111     bool music_mask_user(uint16_t keycode) {
 112       switch (keycode) {
 113         case RAISE:
 114         case LOWER:
 115           return false;
 116         default:
 117           return true;
 118       }
 119     }
 120
 121 Things that return false are not part of the mask, and are always processed.
 122
 123 The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, add something like this to your `config.h`:
 124
 125     #define PITCH_STANDARD_A 432.0f
 126
 127 You can completely disable Music Mode as well. This is useful, if you're pressed for space on your controller.  To disable it, add this to your `config.h`:
 128
 129     #define NO_MUSIC_MODE
 130
 131 ## Audio Click
 132
 133 This 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.
 134
 135 * `CK_TOGG` - Toggles the status (will play sound if enabled)
 136 * `CK_ON` - Turns on Audio Click (plays sound)
 137 * `CK_OFF` - Turns off Audio Click (doesn't play sound)
 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
 142
 143 The feature is disabled by default, to save space.  To enable it, add this to your `config.h`:
 144
 145     #define AUDIO_CLICKY
 146
 147
 148 You can configure the default, min and max frequencies, the stepping and built in randomness by defining these values:
 149
 150 | Option | Default Value | Description |
 151 |--------|---------------|-------------|
 152 | `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. |
 153 | `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). |
 154 | `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. |
 155 | `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. |
 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. |
 157
 158
 159
 160
 161 ## MIDI Functionality
 162
 163 This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile.
 164
 165
 166 ## Audio Keycodes
 167
 168 |Key             |Aliases  |Description                       |
 169 |----------------|---------|----------------------------------|
 170 |`AU_ON`         |         |Audio mode on                     |
 171 |`AU_OFF`        |         |Audio mode off                    |
 172 |`AU_TOG`        |         |Toggles Audio mode                |
 173 |`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode         |
 174 |`CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks |
 175 |`CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks |
 176 |`CLICKY_RESET`  |`CK_RST` |Resets frequency to default       |
 177 |`MU_ON`         |         |Turns on Music Mode               |
 178 |`MU_OFF`        |         |Turns off Music Mode              |
 179 |`MU_TOG`        |         |Toggles Music Mode                |
 180 |`MU_MOD`        |         |Cycles through the music modes    |
 181
 182 <!-- FIXME: this formatting needs work
 183
 184 ## Audio
 185
 186 ```c
 187 #ifdef AUDIO_ENABLE
 188     AU_ON,
 189     AU_OFF,
 190     AU_TOG,
 191
 192     #ifdef FAUXCLICKY_ENABLE
 193         FC_ON,
 194         FC_OFF,
 195         FC_TOG,
 196     #endif
 197
 198     // Music mode on/off/toggle
 199     MU_ON,
 200     MU_OFF,
 201     MU_TOG,
 202
 203     // Music voice iterate
 204     MUV_IN,
 205     MUV_DE,
 206 #endif
 207 ```
 208
 209 ### Midi
 210
 211 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
 212     MI_ON,  // send midi notes when music mode is enabled
 213     MI_OFF, // don't send midi notes when music mode is enabled
 214 #endif
 215
 216 MIDI_TONE_MIN,
 217 MIDI_TONE_MAX
 218
 219 MI_C = MIDI_TONE_MIN,
 220 MI_Cs,
 221 MI_Db = MI_Cs,
 222 MI_D,
 223 MI_Ds,
 224 MI_Eb = MI_Ds,
 225 MI_E,
 226 MI_F,
 227 MI_Fs,
 228 MI_Gb = MI_Fs,
 229 MI_G,
 230 MI_Gs,
 231 MI_Ab = MI_Gs,
 232 MI_A,
 233 MI_As,
 234 MI_Bb = MI_As,
 235 MI_B,
 236
 237 MIDI_TONE_KEYCODE_OCTAVES > 1
 238
 239 where x = 1-5:
 240 MI_C_x,
 241 MI_Cs_x,
 242 MI_Db_x = MI_Cs_x,
 243 MI_D_x,
 244 MI_Ds_x,
 245 MI_Eb_x = MI_Ds_x,
 246 MI_E_x,
 247 MI_F_x,
 248 MI_Fs_x,
 249 MI_Gb_x = MI_Fs_x,
 250 MI_G_x,
 251 MI_Gs_x,
 252 MI_Ab_x = MI_Gs_x,
 253 MI_A_x,
 254 MI_As_x,
 255 MI_Bb_x = MI_As_x,
 256 MI_B_x,
 257
 258 MI_OCT_Nx 1-2
 259 MI_OCT_x 0-7
 260 MIDI_OCTAVE_MIN = MI_OCT_N2,
 261 MIDI_OCTAVE_MAX = MI_OCT_7,
 262 MI_OCTD, // octave down
 263 MI_OCTU, // octave up
 264
 265 MI_TRNS_Nx 1-6
 266 MI_TRNS_x 0-6
 267 MIDI_TRANSPOSE_MIN = MI_TRNS_N6,
 268 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
 269 MI_TRNSD, // transpose down
 270 MI_TRNSU, // transpose up
 271
 272 MI_VEL_x 1-10
 273 MIDI_VELOCITY_MIN = MI_VEL_1,
 274 MIDI_VELOCITY_MAX = MI_VEL_9,
 275 MI_VELD, // velocity down
 276 MI_VELU, // velocity up
 277
 278 MI_CHx 1-16
 279 MIDI_CHANNEL_MIN = MI_CH1
 280 MIDI_CHANNEL_MAX = MI_CH16,
 281 MI_CHD, // previous channel
 282 MI_CHU, // next channel
 283
 284 MI_ALLOFF, // all notes off
 285
 286 MI_SUS, // sustain
 287 MI_PORT, // portamento
 288 MI_SOST, // sostenuto
 289 MI_SOFT, // soft pedal
 290 MI_LEG,  // legato
 291
 292 MI_MOD, // modulation
 293 MI_MODSD, // decrease modulation speed
 294 MI_MODSU, // increase modulation speed
 295 #endif // MIDI_ADVANCED
 296
 297 -->