Peter's keyboard firmware (QMK) https://qmk.fm/
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.

process_steno.c 5.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. /* Copyright 2017 Joseph Wasson
  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 "process_steno.h"
  17. #include "quantum_keycodes.h"
  18. #include "eeprom.h"
  19. #include "keymap_steno.h"
  20. #include "virtser.h"
  21. #include <string.h>
  22. // TxBolt Codes
  23. #define TXB_NUL 0
  24. #define TXB_S_L 0b00000001
  25. #define TXB_T_L 0b00000010
  26. #define TXB_K_L 0b00000100
  27. #define TXB_P_L 0b00001000
  28. #define TXB_W_L 0b00010000
  29. #define TXB_H_L 0b00100000
  30. #define TXB_R_L 0b01000001
  31. #define TXB_A_L 0b01000010
  32. #define TXB_O_L 0b01000100
  33. #define TXB_STR 0b01001000
  34. #define TXB_E_R 0b01010000
  35. #define TXB_U_R 0b01100000
  36. #define TXB_F_R 0b10000001
  37. #define TXB_R_R 0b10000010
  38. #define TXB_P_R 0b10000100
  39. #define TXB_B_R 0b10001000
  40. #define TXB_L_R 0b10010000
  41. #define TXB_G_R 0b10100000
  42. #define TXB_T_R 0b11000001
  43. #define TXB_S_R 0b11000010
  44. #define TXB_D_R 0b11000100
  45. #define TXB_Z_R 0b11001000
  46. #define TXB_NUM 0b11010000
  47. #define TXB_GRP0 0b00000000
  48. #define TXB_GRP1 0b01000000
  49. #define TXB_GRP2 0b10000000
  50. #define TXB_GRP3 0b11000000
  51. #define TXB_GRPMASK 0b11000000
  52. #define TXB_GET_GROUP(code) ((code & TXB_GRPMASK) >> 6)
  53. #define BOLT_STATE_SIZE 4
  54. #define GEMINI_STATE_SIZE 6
  55. #define MAX_STATE_SIZE GEMINI_STATE_SIZE
  56. static uint8_t state[MAX_STATE_SIZE] = {0};
  57. static uint8_t chord[MAX_STATE_SIZE] = {0};
  58. static int8_t pressed = 0;
  59. static steno_mode_t mode;
  60. static const uint8_t boltmap[64] PROGMEM = {
  61. TXB_NUL, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM,
  62. TXB_S_L, TXB_S_L, TXB_T_L, TXB_K_L, TXB_P_L, TXB_W_L, TXB_H_L,
  63. TXB_R_L, TXB_A_L, TXB_O_L, TXB_STR, TXB_STR, TXB_NUL, TXB_NUL,
  64. TXB_NUL, TXB_STR, TXB_STR, TXB_E_R, TXB_U_R, TXB_F_R, TXB_R_R,
  65. TXB_P_R, TXB_B_R, TXB_L_R, TXB_G_R, TXB_T_R, TXB_S_R, TXB_D_R,
  66. TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_Z_R
  67. };
  68. static void steno_clear_state(void) {
  69. memset(state, 0, sizeof(state));
  70. memset(chord, 0, sizeof(chord));
  71. }
  72. static void send_steno_state(uint8_t size, bool send_empty) {
  73. for (uint8_t i = 0; i < size; ++i) {
  74. if (chord[i] || send_empty) {
  75. virtser_send(chord[i]);
  76. }
  77. }
  78. }
  79. void steno_init() {
  80. if (!eeconfig_is_enabled()) {
  81. eeconfig_init();
  82. }
  83. mode = eeprom_read_byte(EECONFIG_STENOMODE);
  84. }
  85. void steno_set_mode(steno_mode_t new_mode) {
  86. steno_clear_state();
  87. mode = new_mode;
  88. eeprom_update_byte(EECONFIG_STENOMODE, mode);
  89. }
  90. /* override to intercept chords right before they get sent.
  91. * return zero to suppress normal sending behavior.
  92. */
  93. __attribute__ ((weak))
  94. bool send_steno_chord_user(steno_mode_t mode, uint8_t chord[6]) { return true; }
  95. __attribute__ ((weak))
  96. bool postprocess_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t mode, uint8_t chord[6], int8_t pressed) { return true; }
  97. __attribute__ ((weak))
  98. bool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; }
  99. static void send_steno_chord(void) {
  100. if (send_steno_chord_user(mode, chord)) {
  101. switch(mode) {
  102. case STENO_MODE_BOLT:
  103. send_steno_state(BOLT_STATE_SIZE, false);
  104. virtser_send(0); // terminating byte
  105. break;
  106. case STENO_MODE_GEMINI:
  107. chord[0] |= 0x80; // Indicate start of packet
  108. send_steno_state(GEMINI_STATE_SIZE, true);
  109. break;
  110. }
  111. }
  112. steno_clear_state();
  113. }
  114. uint8_t *steno_get_state(void) {
  115. return &state[0];
  116. }
  117. uint8_t *steno_get_chord(void) {
  118. return &chord[0];
  119. }
  120. static bool update_state_bolt(uint8_t key, bool press) {
  121. uint8_t boltcode = pgm_read_byte(boltmap + key);
  122. if (press) {
  123. state[TXB_GET_GROUP(boltcode)] |= boltcode;
  124. chord[TXB_GET_GROUP(boltcode)] |= boltcode;
  125. } else {
  126. state[TXB_GET_GROUP(boltcode)] &= ~boltcode;
  127. }
  128. return false;
  129. }
  130. static bool update_state_gemini(uint8_t key, bool press) {
  131. int idx = key / 7;
  132. uint8_t bit = 1 << (6 - (key % 7));
  133. if (press) {
  134. state[idx] |= bit;
  135. chord[idx] |= bit;
  136. } else {
  137. state[idx] &= ~bit;
  138. }
  139. return false;
  140. }
  141. bool process_steno(uint16_t keycode, keyrecord_t *record) {
  142. switch (keycode) {
  143. case QK_STENO_BOLT:
  144. if (!process_steno_user(keycode, record)) {
  145. return false;
  146. }
  147. if (IS_PRESSED(record->event)) {
  148. steno_set_mode(STENO_MODE_BOLT);
  149. }
  150. return false;
  151. case QK_STENO_GEMINI:
  152. if (!process_steno_user(keycode, record)) {
  153. return false;
  154. }
  155. if (IS_PRESSED(record->event)) {
  156. steno_set_mode(STENO_MODE_GEMINI);
  157. }
  158. return false;
  159. case STN__MIN...STN__MAX:
  160. if (!process_steno_user(keycode, record)) {
  161. return false;
  162. }
  163. switch(mode) {
  164. case STENO_MODE_BOLT:
  165. update_state_bolt(keycode - QK_STENO, IS_PRESSED(record->event));
  166. case STENO_MODE_GEMINI:
  167. update_state_gemini(keycode - QK_STENO, IS_PRESSED(record->event));
  168. }
  169. // allow postprocessing hooks
  170. if (postprocess_steno_user(keycode, record, mode, chord, pressed)) {
  171. if (IS_PRESSED(record->event)) {
  172. ++pressed;
  173. } else {
  174. --pressed;
  175. if (pressed <= 0) {
  176. pressed = 0;
  177. send_steno_chord();
  178. }
  179. }
  180. }
  181. return false;
  182. }
  183. return true;
  184. }