You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

275 lines
9.2 KiB

2020 November 28 Breaking Changes Update (#11053) * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
3 years ago
2020 November 28 Breaking Changes Update (#11053) * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
3 years ago
  1. /* Copyright 2020 Rodolphe Belouin
  2. *
  3. * This program is free software: you can redistribute it and/or modify
  4. * it under the terms of the GNU General Public License as published by
  5. * the Free Software Foundation, either version 2 of the License, or
  6. * (at your option) any later version.
  7. *
  8. * This program is distributed in the hope that it will be useful,
  9. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. * GNU General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License
  14. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #include "sequencer.h"
  17. #ifdef MIDI_ENABLE
  18. # include "process_midi.h"
  19. #endif
  20. #ifdef MIDI_MOCKED
  21. # include "tests/midi_mock.h"
  22. #endif
  23. sequencer_config_t sequencer_config = {
  24. false, // enabled
  25. {false}, // steps
  26. {0}, // track notes
  27. 60, // tempo
  28. SQ_RES_4, // resolution
  29. };
  30. sequencer_state_t sequencer_internal_state = {0, 0, 0, 0, SEQUENCER_PHASE_ATTACK};
  31. bool is_sequencer_on(void) { return sequencer_config.enabled; }
  32. void sequencer_on(void) {
  33. dprintln("sequencer on");
  34. sequencer_config.enabled = true;
  35. sequencer_internal_state.current_track = 0;
  36. sequencer_internal_state.current_step = 0;
  37. sequencer_internal_state.timer = timer_read();
  38. sequencer_internal_state.phase = SEQUENCER_PHASE_ATTACK;
  39. }
  40. void sequencer_off(void) {
  41. dprintln("sequencer off");
  42. sequencer_config.enabled = false;
  43. sequencer_internal_state.current_step = 0;
  44. }
  45. void sequencer_toggle(void) {
  46. if (is_sequencer_on()) {
  47. sequencer_off();
  48. } else {
  49. sequencer_on();
  50. }
  51. }
  52. void sequencer_set_track_notes(const uint16_t track_notes[SEQUENCER_TRACKS]) {
  53. for (uint8_t i = 0; i < SEQUENCER_TRACKS; i++) {
  54. sequencer_config.track_notes[i] = track_notes[i];
  55. }
  56. }
  57. bool is_sequencer_track_active(uint8_t track) { return (sequencer_internal_state.active_tracks >> track) & true; }
  58. void sequencer_set_track_activation(uint8_t track, bool value) {
  59. if (value) {
  60. sequencer_internal_state.active_tracks |= (1 << track);
  61. } else {
  62. sequencer_internal_state.active_tracks &= ~(1 << track);
  63. }
  64. dprintf("sequencer: track %d is %s\n", track, value ? "active" : "inactive");
  65. }
  66. void sequencer_toggle_track_activation(uint8_t track) { sequencer_set_track_activation(track, !is_sequencer_track_active(track)); }
  67. void sequencer_toggle_single_active_track(uint8_t track) {
  68. if (is_sequencer_track_active(track)) {
  69. sequencer_internal_state.active_tracks = 0;
  70. } else {
  71. sequencer_internal_state.active_tracks = 1 << track;
  72. }
  73. }
  74. bool is_sequencer_step_on(uint8_t step) { return step < SEQUENCER_STEPS && (sequencer_config.steps[step] & sequencer_internal_state.active_tracks) > 0; }
  75. bool is_sequencer_step_on_for_track(uint8_t step, uint8_t track) { return step < SEQUENCER_STEPS && (sequencer_config.steps[step] >> track) & true; }
  76. void sequencer_set_step(uint8_t step, bool value) {
  77. if (step < SEQUENCER_STEPS) {
  78. if (value) {
  79. sequencer_config.steps[step] |= sequencer_internal_state.active_tracks;
  80. } else {
  81. sequencer_config.steps[step] &= ~sequencer_internal_state.active_tracks;
  82. }
  83. dprintf("sequencer: step %d is %s\n", step, value ? "on" : "off");
  84. } else {
  85. dprintf("sequencer: step %d is out of range\n", step);
  86. }
  87. }
  88. void sequencer_toggle_step(uint8_t step) {
  89. if (is_sequencer_step_on(step)) {
  90. sequencer_set_step_off(step);
  91. } else {
  92. sequencer_set_step_on(step);
  93. }
  94. }
  95. void sequencer_set_all_steps(bool value) {
  96. for (uint8_t step = 0; step < SEQUENCER_STEPS; step++) {
  97. if (value) {
  98. sequencer_config.steps[step] |= sequencer_internal_state.active_tracks;
  99. } else {
  100. sequencer_config.steps[step] &= ~sequencer_internal_state.active_tracks;
  101. }
  102. }
  103. dprintf("sequencer: all steps are %s\n", value ? "on" : "off");
  104. }
  105. uint8_t sequencer_get_tempo(void) { return sequencer_config.tempo; }
  106. void sequencer_set_tempo(uint8_t tempo) {
  107. if (tempo > 0) {
  108. sequencer_config.tempo = tempo;
  109. dprintf("sequencer: tempo set to %d bpm\n", tempo);
  110. } else {
  111. dprintln("sequencer: cannot set tempo to 0");
  112. }
  113. }
  114. void sequencer_increase_tempo(void) {
  115. // Handling potential uint8_t overflow
  116. if (sequencer_config.tempo < UINT8_MAX) {
  117. sequencer_set_tempo(sequencer_config.tempo + 1);
  118. } else {
  119. dprintf("sequencer: cannot set tempo above %d\n", UINT8_MAX);
  120. }
  121. }
  122. void sequencer_decrease_tempo(void) { sequencer_set_tempo(sequencer_config.tempo - 1); }
  123. sequencer_resolution_t sequencer_get_resolution(void) { return sequencer_config.resolution; }
  124. void sequencer_set_resolution(sequencer_resolution_t resolution) {
  125. if (resolution >= 0 && resolution < SEQUENCER_RESOLUTIONS) {
  126. sequencer_config.resolution = resolution;
  127. dprintf("sequencer: resolution set to %d\n", resolution);
  128. } else {
  129. dprintf("sequencer: resolution %d is out of range\n", resolution);
  130. }
  131. }
  132. void sequencer_increase_resolution(void) { sequencer_set_resolution(sequencer_config.resolution + 1); }
  133. void sequencer_decrease_resolution(void) { sequencer_set_resolution(sequencer_config.resolution - 1); }
  134. uint8_t sequencer_get_current_step(void) { return sequencer_internal_state.current_step; }
  135. void sequencer_phase_attack(void) {
  136. dprintf("sequencer: step %d\n", sequencer_internal_state.current_step);
  137. dprintf("sequencer: time %d\n", timer_read());
  138. if (sequencer_internal_state.current_track == 0) {
  139. sequencer_internal_state.timer = timer_read();
  140. }
  141. if (timer_elapsed(sequencer_internal_state.timer) < sequencer_internal_state.current_track * SEQUENCER_TRACK_THROTTLE) {
  142. return;
  143. }
  144. #if defined(MIDI_ENABLE) || defined(MIDI_MOCKED)
  145. if (is_sequencer_step_on_for_track(sequencer_internal_state.current_step, sequencer_internal_state.current_track)) {
  146. process_midi_basic_noteon(midi_compute_note(sequencer_config.track_notes[sequencer_internal_state.current_track]));
  147. }
  148. #endif
  149. if (sequencer_internal_state.current_track < SEQUENCER_TRACKS - 1) {
  150. sequencer_internal_state.current_track++;
  151. } else {
  152. sequencer_internal_state.phase = SEQUENCER_PHASE_RELEASE;
  153. }
  154. }
  155. void sequencer_phase_release(void) {
  156. if (timer_elapsed(sequencer_internal_state.timer) < SEQUENCER_PHASE_RELEASE_TIMEOUT + sequencer_internal_state.current_track * SEQUENCER_TRACK_THROTTLE) {
  157. return;
  158. }
  159. #if defined(MIDI_ENABLE) || defined(MIDI_MOCKED)
  160. if (is_sequencer_step_on_for_track(sequencer_internal_state.current_step, sequencer_internal_state.current_track)) {
  161. process_midi_basic_noteoff(midi_compute_note(sequencer_config.track_notes[sequencer_internal_state.current_track]));
  162. }
  163. #endif
  164. if (sequencer_internal_state.current_track > 0) {
  165. sequencer_internal_state.current_track--;
  166. } else {
  167. sequencer_internal_state.phase = SEQUENCER_PHASE_PAUSE;
  168. }
  169. }
  170. void sequencer_phase_pause(void) {
  171. if (timer_elapsed(sequencer_internal_state.timer) < sequencer_get_step_duration()) {
  172. return;
  173. }
  174. sequencer_internal_state.current_step = (sequencer_internal_state.current_step + 1) % SEQUENCER_STEPS;
  175. sequencer_internal_state.phase = SEQUENCER_PHASE_ATTACK;
  176. }
  177. void sequencer_task(void) {
  178. if (!sequencer_config.enabled) {
  179. return;
  180. }
  181. if (sequencer_internal_state.phase == SEQUENCER_PHASE_PAUSE) {
  182. sequencer_phase_pause();
  183. }
  184. if (sequencer_internal_state.phase == SEQUENCER_PHASE_RELEASE) {
  185. sequencer_phase_release();
  186. }
  187. if (sequencer_internal_state.phase == SEQUENCER_PHASE_ATTACK) {
  188. sequencer_phase_attack();
  189. }
  190. }
  191. uint16_t sequencer_get_beat_duration(void) { return get_beat_duration(sequencer_config.tempo); }
  192. uint16_t sequencer_get_step_duration(void) { return get_step_duration(sequencer_config.tempo, sequencer_config.resolution); }
  193. uint16_t get_beat_duration(uint8_t tempo) {
  194. // Don’t crash in the unlikely case where the given tempo is 0
  195. if (tempo == 0) {
  196. return get_beat_duration(60);
  197. }
  198. /**
  199. * Given
  200. * t = tempo and d = duration, both strictly greater than 0
  201. * When
  202. * t beats / minute = 1 beat / d ms
  203. * Then
  204. * t beats / 60000ms = 1 beat / d ms
  205. * d ms = 60000ms / t
  206. */
  207. return 60000 / tempo;
  208. }
  209. uint16_t get_step_duration(uint8_t tempo, sequencer_resolution_t resolution) {
  210. /**
  211. * Resolution cheatsheet:
  212. * 1/2 => 2 steps per 4 beats
  213. * 1/2T => 3 steps per 4 beats
  214. * 1/4 => 4 steps per 4 beats
  215. * 1/4T => 6 steps per 4 beats
  216. * 1/8 => 8 steps per 4 beats
  217. * 1/8T => 12 steps per 4 beats
  218. * 1/16 => 16 steps per 4 beats
  219. * 1/16T => 24 steps per 4 beats
  220. * 1/32 => 32 steps per 4 beats
  221. *
  222. * The number of steps for binary resolutions follows the powers of 2.
  223. * The ternary variants are simply 1.5x faster.
  224. */
  225. bool is_binary = resolution % 2 == 0;
  226. uint8_t binary_steps = 2 << (resolution / 2);
  227. uint16_t binary_step_duration = get_beat_duration(tempo) * 4 / binary_steps;
  228. return is_binary ? binary_step_duration : 2 * binary_step_duration / 3;
  229. }