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 the C6 or B5 port (`#define C6_AUDIO` and/or `#define B5_AUDIO`), 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 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:
   6
   7 ```
   8 STARTUP_SONG // plays when the keyboard starts up (audio.c)
   9 GOODBYE_SONG // plays when you press the RESET key (quantum.c)
  10 AG_NORM_SONG // plays when you press AG_NORM (quantum.c)
  11 AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)
  12 MUSIC_ON_SONG // plays when music mode is activated (process_music.c)
  13 MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c)
  14 CHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c)
  15 GUITAR_SONG // plays when the guitar music mode is selected (process_music.c)
  16 VIOLIN_SONG // plays when the violin music mode is selected (process_music.c)
  17 MAJOR_SONG // plays when the major music mode is selected (process_music.c)
  18 ```
  19
  20 You can override the default songs by doing something like this in your `config.h`:
  21
  22 ```c
  23 #ifdef AUDIO_ENABLE
  24   #define STARTUP_SONG SONG(STARTUP_SOUND)
  25 #endif
  26 ```
  27
  28 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).
  29
  30 To play a custom sound at a particular time, you can define a song like this (near the top of the file):
  31
  32 ```c
  33 float my_song[][2] = SONG(QWERTY_SOUND);
  34 ```
  35
  36 And then play your song like this:
  37
  38 ```c
  39 PLAY_SONG(my_song);
  40 ```
  41
  42 Alternatively, you can play it in a loop like this:
  43
  44 ```c
  45 PLAY_LOOP(my_song);
  46 ```
  47
  48 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.
  49
  50 ## Music mode
  51
  52 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.
  53
  54 Recording is experimental due to some memory issues - if you experience some weird behavior, unplugging/replugging your keyboard will fix things.
  55
  56 Keycodes available:
  57
  58 * `MU_ON` - Turn music mode on
  59 * `MU_OFF` - Turn music mode off
  60 * `MU_TOG` - Toggle music mode
  61 * `MU_MOD` - Cycle through the music modes:
  62   * `CHROMATIC_MODE` - Chromatic scale, row changes the octave
  63   * `GUITAR_MODE` - Chromatic scale, but the row changes the string (+5 st)
  64   * `VIOLIN_MODE` - Chromatic scale, but the row changes the string (+7 st)
  65   * `MAJOR_MODE` - Major scale
  66
  67 In music mode, the following keycodes work differently, and don't pass through:
  68
  69 * `LCTL` - start a recording
  70 * `LALT` - stop recording/stop playing
  71 * `LGUI` - play recording
  72 * `KC_UP` - speed-up playback
  73 * `KC_DOWN` - slow-down playback
  74
  75 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:
  76
  77     #define MUSIC_MASK keycode != KC_NO
  78
  79 Which will capture all keycodes - be careful, this will get you stuck in music mode until you restart your keyboard!
  80
  81 The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, add something like this to your `config.h`:
  82
  83     #define PITCH_STANDARD_A 432.0f
  84
  85 ## MIDI functionalty
  86
  87 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
  88
  89 <!-- FIXME: this formatting needs work
  90
  91 ## Audio
  92
  93 ```c
  94 #ifdef AUDIO_ENABLE
  95     AU_ON,
  96     AU_OFF,
  97     AU_TOG,
  98
  99     #ifdef FAUXCLICKY_ENABLE
 100         FC_ON,
 101         FC_OFF,
 102         FC_TOG,
 103     #endif
 104
 105     // Music mode on/off/toggle
 106     MU_ON,
 107     MU_OFF,
 108     MU_TOG,
 109
 110     // Music voice iterate
 111     MUV_IN,
 112     MUV_DE,
 113 #endif
 114 ```
 115
 116 ### Midi
 117
 118 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
 119     MI_ON,  // send midi notes when music mode is enabled
 120     MI_OFF, // don't send midi notes when music mode is enabled
 121 #endif
 122
 123 MIDI_TONE_MIN,
 124 MIDI_TONE_MAX
 125
 126 MI_C = MIDI_TONE_MIN,
 127 MI_Cs,
 128 MI_Db = MI_Cs,
 129 MI_D,
 130 MI_Ds,
 131 MI_Eb = MI_Ds,
 132 MI_E,
 133 MI_F,
 134 MI_Fs,
 135 MI_Gb = MI_Fs,
 136 MI_G,
 137 MI_Gs,
 138 MI_Ab = MI_Gs,
 139 MI_A,
 140 MI_As,
 141 MI_Bb = MI_As,
 142 MI_B,
 143
 144 MIDI_TONE_KEYCODE_OCTAVES > 1
 145
 146 where x = 1-5:
 147 MI_C_x,
 148 MI_Cs_x,
 149 MI_Db_x = MI_Cs_x,
 150 MI_D_x,
 151 MI_Ds_x,
 152 MI_Eb_x = MI_Ds_x,
 153 MI_E_x,
 154 MI_F_x,
 155 MI_Fs_x,
 156 MI_Gb_x = MI_Fs_x,
 157 MI_G_x,
 158 MI_Gs_x,
 159 MI_Ab_x = MI_Gs_x,
 160 MI_A_x,
 161 MI_As_x,
 162 MI_Bb_x = MI_As_x,
 163 MI_B_x,
 164
 165 MI_OCT_Nx 1-2
 166 MI_OCT_x 0-7
 167 MIDI_OCTAVE_MIN = MI_OCT_N2,
 168 MIDI_OCTAVE_MAX = MI_OCT_7,
 169 MI_OCTD, // octave down
 170 MI_OCTU, // octave up
 171
 172 MI_TRNS_Nx 1-6
 173 MI_TRNS_x 0-6
 174 MIDI_TRANSPOSE_MIN = MI_TRNS_N6,
 175 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
 176 MI_TRNSD, // transpose down
 177 MI_TRNSU, // transpose up
 178
 179 MI_VEL_x 1-10
 180 MIDI_VELOCITY_MIN = MI_VEL_1,
 181 MIDI_VELOCITY_MAX = MI_VEL_9,
 182 MI_VELD, // velocity down
 183 MI_VELU, // velocity up
 184
 185 MI_CHx 1-16
 186 MIDI_CHANNEL_MIN = MI_CH1
 187 MIDI_CHANNEL_MAX = MI_CH16,
 188 MI_CHD, // previous channel
 189 MI_CHU, // next channel
 190
 191 MI_ALLOFF, // all notes off
 192
 193 MI_SUS, // sustain
 194 MI_PORT, // portamento
 195 MI_SOST, // sostenuto
 196 MI_SOFT, // soft pedal
 197 MI_LEG,  // legato
 198
 199 MI_MOD, // modulation
 200 MI_MODSD, // decrease modulation speed
 201 MI_MODSU, // increase modulation speed
 202 #endif // MIDI_ADVANCED
 203
 204 -->