qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-09-07 10:53:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Initial rework of steno feature (#26273)

Browse Source
This commit is contained in:
Joel Challis
2026-08-25 17:15:01 +01:00
committed by GitHub
parent 4b2c8b31b1
commit 4dfef5c638
21 changed files with 1554 additions and 403 deletions
Download Patch File Download Diff File Expand all files Collapse all files
quantum/eeconfig.c
+2 -1
View File
@@ -120,7 +120,8 @@ void eeconfig_init_quantum(void) {
#endif // UNICODE_COMMON_ENABLE
#ifdef STENO_ENABLE
eeconfig_update_steno_mode(0);
extern void eeconfig_update_steno_default(void);
eeconfig_update_steno_default();
#endif // STENO_ENABLE
#ifdef RGB_MATRIX_ENABLE
quantum/keyboard.c
+2 -2
View File
@@ -76,7 +76,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
# include "process_tap_dance.h"
#endif
#ifdef STENO_ENABLE
# include "process_steno.h"
# include "steno.h"
#endif
#ifdef KEY_OVERRIDE_ENABLE
# include "process_key_override.h"
@@ -512,7 +512,7 @@ void keyboard_init(void) {
#ifdef RGBLIGHT_ENABLE
rgblight_init();
#endif
#ifdef STENO_ENABLE_ALL
#ifdef STENO_ENABLE
steno_init();
#endif
#ifdef DIP_SWITCH_ENABLE
quantum/keycodes.h
+174 -7
View File
@@ -79,7 +79,7 @@ enum qk_keycode_ranges {
QK_AUDIO = 0x7480,
QK_AUDIO_MAX = 0x74BF,
QK_STENO = 0x74C0,
QK_STENO_MAX = 0x74FF,
QK_STENO_MAX = 0x751F,
QK_MACRO = 0x7700,
QK_MACRO_MAX = 0x777F,
QK_CONNECTION = 0x7780,
@@ -662,10 +662,89 @@ enum qk_keycode_defines {
QK_MUSIC_MODE_NEXT = 0x7493,
QK_AUDIO_VOICE_NEXT = 0x7494,
QK_AUDIO_VOICE_PREVIOUS = 0x7495,
QK_STENO_BOLT = 0x74F0,
QK_STENO_GEMINI = 0x74F1,
QK_STENO_COMB = 0x74F2,
QK_STENO_COMB_MAX = 0x74FC,
QK_STENO_FUNCTION = 0x74C0,
QK_STENO_N1 = 0x74C1,
QK_STENO_N2 = 0x74C2,
QK_STENO_N3 = 0x74C3,
QK_STENO_N4 = 0x74C4,
QK_STENO_N5 = 0x74C5,
QK_STENO_N6 = 0x74C6,
QK_STENO_S1 = 0x74C7,
QK_STENO_S2 = 0x74C8,
QK_STENO_TL = 0x74C9,
QK_STENO_KL = 0x74CA,
QK_STENO_PL = 0x74CB,
QK_STENO_WL = 0x74CC,
QK_STENO_HL = 0x74CD,
QK_STENO_RL = 0x74CE,
QK_STENO_A = 0x74CF,
QK_STENO_O = 0x74D0,
QK_STENO_ST1 = 0x74D1,
QK_STENO_ST2 = 0x74D2,
QK_STENO_RESET1 = 0x74D3,
QK_STENO_RESET2 = 0x74D4,
QK_STENO_POWER = 0x74D5,
QK_STENO_ST3 = 0x74D6,
QK_STENO_ST4 = 0x74D7,
QK_STENO_E = 0x74D8,
QK_STENO_U = 0x74D9,
QK_STENO_FR = 0x74DA,
QK_STENO_RR = 0x74DB,
QK_STENO_PR = 0x74DC,
QK_STENO_BR = 0x74DD,
QK_STENO_LR = 0x74DE,
QK_STENO_GR = 0x74DF,
QK_STENO_TR = 0x74E0,
QK_STENO_SR = 0x74E1,
QK_STENO_DR = 0x74E2,
QK_STENO_N7 = 0x74E3,
QK_STENO_N8 = 0x74E4,
QK_STENO_N9 = 0x74E5,
QK_STENO_NA = 0x74E6,
QK_STENO_NB = 0x74E7,
QK_STENO_NC = 0x74E8,
QK_STENO_ZR = 0x74E9,
QK_STENO_X1 = 0x74EA,
QK_STENO_X2 = 0x74EB,
QK_STENO_X3 = 0x74EC,
QK_STENO_X4 = 0x74ED,
QK_STENO_X5 = 0x74EE,
QK_STENO_X6 = 0x74EF,
QK_STENO_X7 = 0x74F0,
QK_STENO_X8 = 0x74F1,
QK_STENO_X9 = 0x74F2,
QK_STENO_X10 = 0x74F3,
QK_STENO_X11 = 0x74F4,
QK_STENO_X12 = 0x74F5,
QK_STENO_X13 = 0x74F6,
QK_STENO_X14 = 0x74F7,
QK_STENO_X15 = 0x74F8,
QK_STENO_X16 = 0x74F9,
QK_STENO_X17 = 0x74FA,
QK_STENO_X18 = 0x74FB,
QK_STENO_X19 = 0x74FC,
QK_STENO_X20 = 0x74FD,
QK_STENO_X21 = 0x74FE,
QK_STENO_X22 = 0x74FF,
QK_STENO_X23 = 0x7500,
QK_STENO_X24 = 0x7501,
QK_STENO_X25 = 0x7502,
QK_STENO_X26 = 0x7503,
QK_STENO_S3 = 0x750B,
QK_STENO_TKL = 0x750C,
QK_STENO_PWL = 0x750D,
QK_STENO_HRL = 0x750E,
QK_STENO_FRR = 0x750F,
QK_STENO_PBR = 0x7510,
QK_STENO_LGR = 0x7511,
QK_STENO_TSR = 0x7512,
QK_STENO_DZR = 0x7513,
QK_STENO_AO = 0x7514,
QK_STENO_EU = 0x7515,
QK_STENO_MODE_BOLT = 0x751C,
QK_STENO_MODE_GEMINI = 0x751D,
QK_STENO_MODE_NEXT = 0x751E,
QK_STENO_MODE_PREVIOUS = 0x751F,
QK_MACRO_0 = 0x7700,
QK_MACRO_1 = 0x7701,
QK_MACRO_2 = 0x7702,
@@ -1359,6 +1438,94 @@ enum qk_keycode_defines {
MU_NEXT = QK_MUSIC_MODE_NEXT,
AU_NEXT = QK_AUDIO_VOICE_NEXT,
AU_PREV = QK_AUDIO_VOICE_PREVIOUS,
ST_FN = QK_STENO_FUNCTION,
ST_N1 = QK_STENO_N1,
ST_NUM = QK_STENO_N1,
ST_N2 = QK_STENO_N2,
ST_N3 = QK_STENO_N3,
ST_N4 = QK_STENO_N4,
ST_N5 = QK_STENO_N5,
ST_N6 = QK_STENO_N6,
ST_S1 = QK_STENO_S1,
ST_SL = QK_STENO_S1,
ST_S2 = QK_STENO_S2,
ST_TL = QK_STENO_TL,
ST_KL = QK_STENO_KL,
ST_PL = QK_STENO_PL,
ST_WL = QK_STENO_WL,
ST_HL = QK_STENO_HL,
ST_RL = QK_STENO_RL,
ST_A = QK_STENO_A,
ST_O = QK_STENO_O,
ST_ST1 = QK_STENO_ST1,
ST_STR = QK_STENO_ST1,
ST_ST2 = QK_STENO_ST2,
ST_RE1 = QK_STENO_RESET1,
ST_RES1 = QK_STENO_RESET1,
ST_RE2 = QK_STENO_RESET2,
ST_RES2 = QK_STENO_RESET2,
ST_PWR = QK_STENO_POWER,
ST_ST3 = QK_STENO_ST3,
ST_ST4 = QK_STENO_ST4,
ST_E = QK_STENO_E,
ST_U = QK_STENO_U,
ST_FR = QK_STENO_FR,
ST_RR = QK_STENO_RR,
ST_PR = QK_STENO_PR,
ST_BR = QK_STENO_BR,
ST_LR = QK_STENO_LR,
ST_GR = QK_STENO_GR,
ST_TR = QK_STENO_TR,
ST_SR = QK_STENO_SR,
ST_DR = QK_STENO_DR,
ST_N7 = QK_STENO_N7,
ST_N8 = QK_STENO_N8,
ST_N9 = QK_STENO_N9,
ST_NA = QK_STENO_NA,
ST_NB = QK_STENO_NB,
ST_NC = QK_STENO_NC,
ST_ZR = QK_STENO_ZR,
ST_X1 = QK_STENO_X1,
ST_X2 = QK_STENO_X2,
ST_X3 = QK_STENO_X3,
ST_X4 = QK_STENO_X4,
ST_X5 = QK_STENO_X5,
ST_X6 = QK_STENO_X6,
ST_X7 = QK_STENO_X7,
ST_X8 = QK_STENO_X8,
ST_X9 = QK_STENO_X9,
ST_X10 = QK_STENO_X10,
ST_X11 = QK_STENO_X11,
ST_X12 = QK_STENO_X12,
ST_X13 = QK_STENO_X13,
ST_X14 = QK_STENO_X14,
ST_X15 = QK_STENO_X15,
ST_X16 = QK_STENO_X16,
ST_X17 = QK_STENO_X17,
ST_X18 = QK_STENO_X18,
ST_X19 = QK_STENO_X19,
ST_X20 = QK_STENO_X20,
ST_X21 = QK_STENO_X21,
ST_X22 = QK_STENO_X22,
ST_X23 = QK_STENO_X23,
ST_X24 = QK_STENO_X24,
ST_X25 = QK_STENO_X25,
ST_X26 = QK_STENO_X26,
ST_S3 = QK_STENO_S3,
ST_TKL = QK_STENO_TKL,
ST_PWL = QK_STENO_PWL,
ST_HRL = QK_STENO_HRL,
ST_FRR = QK_STENO_FRR,
ST_PBR = QK_STENO_PBR,
ST_LGR = QK_STENO_LGR,
ST_TSR = QK_STENO_TSR,
ST_DZR = QK_STENO_DZR,
ST_AO = QK_STENO_AO,
ST_EU = QK_STENO_EU,
ST_BOLT = QK_STENO_MODE_BOLT,
ST_GEMI = QK_STENO_MODE_GEMINI,
ST_NEXT = QK_STENO_MODE_NEXT,
ST_PREV = QK_STENO_MODE_PREVIOUS,
MC_0 = QK_MACRO_0,
MC_1 = QK_MACRO_1,
MC_2 = QK_MACRO_2,
@@ -1583,7 +1750,7 @@ enum qk_keycode_defines {
#define IS_JOYSTICK_KEYCODE(code) ((code) >= QK_JOYSTICK_BUTTON_0 && (code) <= QK_JOYSTICK_BUTTON_31)
#define IS_PROGRAMMABLE_BUTTON_KEYCODE(code) ((code) >= QK_PROGRAMMABLE_BUTTON_1 && (code) <= QK_PROGRAMMABLE_BUTTON_32)
#define IS_AUDIO_KEYCODE(code) ((code) >= QK_AUDIO_ON && (code) <= QK_AUDIO_VOICE_PREVIOUS)
#define IS_STENO_KEYCODE(code) ((code) >= QK_STENO_BOLT && (code) <= QK_STENO_COMB_MAX)
#define IS_STENO_KEYCODE(code) ((code) >= QK_STENO_FUNCTION && (code) <= QK_STENO_MODE_PREVIOUS)
#define IS_MACRO_KEYCODE(code) ((code) >= QK_MACRO_0 && (code) <= QK_MACRO_31)
#define IS_CONNECTION_KEYCODE(code) ((code) >= QK_OUTPUT_AUTO && (code) <= QK_BLUETOOTH_PROFILE5)
#define IS_BACKLIGHT_KEYCODE(code) ((code) >= QK_BACKLIGHT_ON && (code) <= QK_BACKLIGHT_TOGGLE_BREATHING)
@@ -1610,7 +1777,7 @@ enum qk_keycode_defines {
#define JOYSTICK_KEYCODE_RANGE QK_JOYSTICK_BUTTON_0 ... QK_JOYSTICK_BUTTON_31
#define PROGRAMMABLE_BUTTON_KEYCODE_RANGE QK_PROGRAMMABLE_BUTTON_1 ... QK_PROGRAMMABLE_BUTTON_32
#define AUDIO_KEYCODE_RANGE QK_AUDIO_ON ... QK_AUDIO_VOICE_PREVIOUS
#define STENO_KEYCODE_RANGE QK_STENO_BOLT ... QK_STENO_COMB_MAX
#define STENO_KEYCODE_RANGE QK_STENO_FUNCTION ... QK_STENO_MODE_PREVIOUS
#define MACRO_KEYCODE_RANGE QK_MACRO_0 ... QK_MACRO_31
#define CONNECTION_KEYCODE_RANGE QK_OUTPUT_AUTO ... QK_BLUETOOTH_PROFILE5
#define BACKLIGHT_KEYCODE_RANGE QK_BACKLIGHT_ON ... QK_BACKLIGHT_TOGGLE_BREATHING
quantum/process_keycode/process_steno.c
+99 -170
View File
@@ -1,29 +1,24 @@
/* Copyright 2017, 2022 Joseph Wasson, Vladislav Kucheriavykh
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// Copyright 2017, 2022 Joseph Wasson, Vladislav Kucheriavykh
// SPDX-License-Identifier: GPL-2.0-or-later
#include "process_steno.h"
#include "quantum_keycodes.h"
#include "eeconfig.h"
#include <string.h>
#ifdef VIRTSER_ENABLE
# include "virtser.h"
#include "steno.h"
#include "progmem.h"
#ifdef STENO_ENABLE_BOLT
void steno_add_key_to_chord_bolt(uint8_t chord[MAX_STROKE_SIZE], uint8_t key);
void steno_send_chord_bolt(uint8_t chord[MAX_STROKE_SIZE]);
#endif
#ifdef STENO_ENABLE_GEMINI
void steno_add_key_to_chord_gemini(uint8_t chord[MAX_STROKE_SIZE], uint8_t key);
void steno_send_chord_gemini(uint8_t chord[MAX_STROKE_SIZE]);
#endif
// All steno keys that have been pressed to form this chord,
// stored in MAX_STROKE_SIZE groups of 8-bit arrays.
static uint8_t chord[MAX_STROKE_SIZE] = {0};
extern uint8_t steno_current_chord[MAX_STROKE_SIZE];
// The number of physical keys actually being held down.
// This is not always equal to the number of 1 bits in `chord` because it is possible to
// simultaneously press down four keys, then release three of those four keys and then press yet
@@ -32,109 +27,21 @@ static uint8_t chord[MAX_STROKE_SIZE] = {0};
// `n_pressed_keys` would be set to 2 because there are only two keys currently being pressed down.
static int8_t n_pressed_keys = 0;
#ifdef STENO_ENABLE_ALL
static steno_mode_t mode;
#elif defined(STENO_ENABLE_GEMINI)
static const steno_mode_t mode = STENO_MODE_GEMINI;
#elif defined(STENO_ENABLE_BOLT)
static const steno_mode_t mode = STENO_MODE_BOLT;
#endif
static inline void steno_clear_chord(void) {
memset(chord, 0, sizeof(chord));
}
#ifdef STENO_ENABLE_GEMINI
# ifdef VIRTSER_ENABLE
void send_steno_chord_gemini(void) {
// Set MSB to 1 to indicate the start of packet
chord[0] |= 0x80;
for (uint8_t i = 0; i < GEMINI_STROKE_SIZE; ++i) {
virtser_send(chord[i]);
}
}
# else
# pragma message "VIRTSER_ENABLE = yes is required for Gemini PR to work properly out of the box!"
# endif // VIRTSER_ENABLE
/**
* @precondition: `key` is pressed
*/
bool add_gemini_key_to_chord(uint8_t key) {
// Although each group of the packet is 8 bits long, the MSB is reserved
// to indicate whether that byte is the first byte of the packet (MSB=1)
// or one of the remaining five bytes of the packet (MSB=0).
// As a consequence, only 7 out of the 8 bits are left to be used as a bit array
// for the steno keys of that group.
const int group_idx = key / 7;
const int intra_group_idx = key - group_idx * 7;
// The 0th steno key of the group has bit=0b01000000, the 1st has bit=0b00100000, etc.
const uint8_t bit = 1 << (6 - intra_group_idx);
chord[group_idx] |= bit;
return false;
}
#endif // STENO_ENABLE_GEMINI
#ifdef STENO_ENABLE_BOLT
# define TXB_GRP0 0b00000000
# define TXB_GRP1 0b01000000
# define TXB_GRP2 0b10000000
# define TXB_GRP3 0b11000000
# define TXB_GRPMASK 0b11000000
# define TXB_GET_GROUP(code) ((code & TXB_GRPMASK) >> 6)
static const uint8_t boltmap[64] PROGMEM = {TXB_NUL, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_S_L, TXB_S_L, TXB_T_L, TXB_K_L, TXB_P_L, TXB_W_L, TXB_H_L, TXB_R_L, TXB_A_L, TXB_O_L, TXB_STR, TXB_STR, TXB_NUL, TXB_NUL, TXB_NUL, TXB_STR, TXB_STR, TXB_E_R, TXB_U_R, TXB_F_R, TXB_R_R, TXB_P_R, TXB_B_R, TXB_L_R, TXB_G_R, TXB_T_R, TXB_S_R, TXB_D_R, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_Z_R};
# ifdef VIRTSER_ENABLE
static void send_steno_chord_bolt(void) {
for (uint8_t i = 0; i < BOLT_STROKE_SIZE; ++i) {
// TX Bolt uses variable length packets where each byte corresponds to a bit array of certain keys.
// If a user chorded the keys of the first group with keys of the last group, for example, there
// would be bytes of 0x00 in `chord` for the middle groups which we mustn't send.
if (chord[i]) {
virtser_send(chord[i]);
}
}
// Sending a null packet is not always necessary, but it is simpler and more reliable
// to unconditionally send it every time instead of keeping track of more states and
// creating more branches in the execution of the program.
virtser_send(0);
}
# else
# pragma message "VIRTSER_ENABLE = yes is required for TX Bolt to work properly out of the box!"
# endif // VIRTSER_ENABLE
/**
* @precondition: `key` is pressed
*/
static bool add_bolt_key_to_chord(uint8_t key) {
uint8_t boltcode = pgm_read_byte(boltmap + key);
chord[TXB_GET_GROUP(boltcode)] |= boltcode;
return false;
}
#endif // STENO_ENABLE_BOLT
#ifdef STENO_COMBINEDMAP
/* Used to look up when pressing the middle row key to combine two consonant or vowel keys */
static const uint16_t combinedmap_first[] PROGMEM = {STN_S1, STN_TL, STN_PL, STN_HL, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR, STN_A, STN_E};
static const uint16_t combinedmap_second[] PROGMEM = {STN_S2, STN_KL, STN_WL, STN_RL, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR, STN_O, STN_U};
// Used to look up when pressing the middle row key to combine two consonant or vowel keys
static const uint16_t combinedmap_first[] PROGMEM = {QK_STENO_S1, QK_STENO_TL, QK_STENO_PL, QK_STENO_HL, QK_STENO_FR, QK_STENO_PR, QK_STENO_LR, QK_STENO_TR, QK_STENO_DR, QK_STENO_A, QK_STENO_E};
static const uint16_t combinedmap_second[] PROGMEM = {QK_STENO_S2, QK_STENO_KL, QK_STENO_WL, QK_STENO_RL, QK_STENO_RR, QK_STENO_BR, QK_STENO_GR, QK_STENO_SR, QK_STENO_ZR, QK_STENO_O, QK_STENO_U};
static bool process_steno_combinedmap(uint16_t keycode, keyrecord_t *record) {
uint16_t first_keycode = pgm_read_word(&combinedmap_first[keycode - QK_STENO_S3]);
uint16_t second_keycode = pgm_read_word(&combinedmap_second[keycode - QK_STENO_S3]);
bool first_result = process_steno(first_keycode, record);
bool second_result = process_steno(second_keycode, record);
return first_result && second_result;
}
#endif
#ifdef STENO_ENABLE_ALL
void steno_init(void) {
mode = eeconfig_read_steno_mode();
}
void steno_set_mode(steno_mode_t new_mode) {
steno_clear_chord();
mode = new_mode;
eeconfig_update_steno_mode(mode);
}
#endif // STENO_ENABLE_ALL
/* override to intercept chords right before they get sent.
* return zero to suppress normal sending behavior.
*/
@@ -150,65 +57,97 @@ __attribute__((weak)) bool process_steno_user(uint16_t keycode, keyrecord_t *rec
return true;
}
bool process_steno(uint16_t keycode, keyrecord_t *record) {
if (keycode < QK_STENO || keycode > QK_STENO_MAX) {
return true; // Not a steno key, pass it further along the chain
/*
* Clearing or sending the chord state is not necessary as we intentionally ignore whatever
* normal keyboard keys the user may have tapped while chording steno keys.
*/
static void steno_add_keycode_to_chord(uint16_t keycode) {
switch (steno_get_mode()) {
#ifdef STENO_ENABLE_BOLT
case STENO_MODE_BOLT:
steno_add_key_to_chord_bolt(steno_current_chord, keycode - QK_STENO_FUNCTION);
break;
#endif
#ifdef STENO_ENABLE_GEMINI
case STENO_MODE_GEMINI:
steno_add_key_to_chord_gemini(steno_current_chord, keycode - QK_STENO_FUNCTION);
break;
#endif
default:
break;
}
}
static void steno_send_chord(void) {
switch (steno_get_mode()) {
#ifdef STENO_ENABLE_BOLT
case STENO_MODE_BOLT:
steno_send_chord_bolt(steno_current_chord);
break;
#endif
#ifdef STENO_ENABLE_GEMINI
case STENO_MODE_GEMINI:
steno_send_chord_gemini(steno_current_chord);
break;
#endif
default:
break;
}
}
bool process_steno(uint16_t keycode, keyrecord_t *record) {
if (!IS_STENO_KEYCODE(keycode)) {
// Clearing or sending the chord state is not necessary as we intentionally ignore whatever
// normal keyboard keys the user may have tapped while chording steno keys.
return true; // pass keycode further along the chain
}
if (IS_NOEVENT(record->event)) {
return true;
}
if (!process_steno_user(keycode, record)) {
return false; // User fully processed the steno key themselves
}
switch (keycode) {
#ifdef STENO_ENABLE_ALL
case QK_STENO_BOLT:
#if NUM_STENO_PROTOCOLS > 1
case QK_STENO_MODE_NEXT:
if (record->event.pressed) {
steno_mode_next();
}
return false;
case QK_STENO_MODE_PREVIOUS:
if (record->event.pressed) {
steno_mode_previous();
}
return false;
case QK_STENO_MODE_BOLT:
if (record->event.pressed) {
steno_set_mode(STENO_MODE_BOLT);
}
return false;
case QK_STENO_GEMINI:
case QK_STENO_MODE_GEMINI:
if (record->event.pressed) {
steno_set_mode(STENO_MODE_GEMINI);
}
return false;
#endif // STENO_ENABLE_ALL
#endif
#ifdef STENO_COMBINEDMAP
case QK_STENO_COMB ... QK_STENO_COMB_MAX: {
bool first_result = process_steno(combinedmap_first[keycode - QK_STENO_COMB], record);
bool second_result = process_steno(combinedmap_second[keycode - QK_STENO_COMB], record);
return first_result && second_result;
}
#endif // STENO_COMBINEDMAP
case STN__MIN ... STN__MAX:
case QK_STENO_S3 ... QK_STENO_EU:
return process_steno_combinedmap(keycode, record);
#endif
case QK_STENO_FUNCTION ... QK_STENO_ZR:
if (record->event.pressed) {
n_pressed_keys++;
switch (mode) {
#ifdef STENO_ENABLE_BOLT
case STENO_MODE_BOLT:
add_bolt_key_to_chord(keycode - QK_STENO);
break;
#endif // STENO_ENABLE_BOLT
#ifdef STENO_ENABLE_GEMINI
case STENO_MODE_GEMINI:
add_gemini_key_to_chord(keycode - QK_STENO);
break;
#endif // STENO_ENABLE_GEMINI
default:
return false;
}
if (!post_process_steno_user(keycode, record, mode, chord, n_pressed_keys)) {
steno_add_keycode_to_chord(keycode);
if (!post_process_steno_user(keycode, record, steno_get_mode(), steno_current_chord, n_pressed_keys)) {
return false;
}
} else { // is released
n_pressed_keys--;
if (!post_process_steno_user(keycode, record, mode, chord, n_pressed_keys)) {
if (!post_process_steno_user(keycode, record, steno_get_mode(), steno_current_chord, n_pressed_keys)) {
return false;
}
if (n_pressed_keys > 0) {
@@ -217,27 +156,17 @@ bool process_steno(uint16_t keycode, keyrecord_t *record) {
return false;
}
n_pressed_keys = 0;
if (!send_steno_chord_user(mode, chord)) {
if (!send_steno_chord_user(steno_get_mode(), steno_current_chord)) {
steno_clear_chord();
return false;
}
switch (mode) {
#if defined(STENO_ENABLE_BOLT) && defined(VIRTSER_ENABLE)
case STENO_MODE_BOLT:
send_steno_chord_bolt();
break;
#endif // STENO_ENABLE_BOLT && VIRTSER_ENABLE
#if defined(STENO_ENABLE_GEMINI) && defined(VIRTSER_ENABLE)
case STENO_MODE_GEMINI:
send_steno_chord_gemini();
break;
#endif // STENO_ENABLE_GEMINI && VIRTSER_ENABLE
default:
break;
}
steno_send_chord();
steno_clear_chord();
}
return false;
default:
break;
}
return false;
}
quantum/process_keycode/process_steno.h
+2 -34
View File
@@ -1,42 +1,10 @@
/* Copyright 2017 Joseph Wasson
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// Copyright 2017 Joseph Wasson
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include "action.h"
#include "steno_keycodes.h"
#define BOLT_STROKE_SIZE 4
#define GEMINI_STROKE_SIZE 6
#ifdef STENO_ENABLE_GEMINI
# define MAX_STROKE_SIZE GEMINI_STROKE_SIZE
#else
# define MAX_STROKE_SIZE BOLT_STROKE_SIZE
#endif
typedef enum {
STENO_MODE_GEMINI,
STENO_MODE_BOLT,
} steno_mode_t;
bool process_steno(uint16_t keycode, keyrecord_t *record);
#ifdef STENO_ENABLE_ALL
void steno_init(void);
void steno_set_mode(steno_mode_t mode);
#endif // STENO_ENABLE_ALL
quantum/quantum.h
+1
View File
@@ -100,6 +100,7 @@ extern layer_state_t layer_state;
#endif
#ifdef STENO_ENABLE
# include "steno.h"
# include "process_steno.h"
#endif
quantum/steno/steno.c
+126
View File
@@ -0,0 +1,126 @@
// Copyright 2026 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include <stdbool.h>
#include <stdint.h>
#include <string.h>
#include "steno.h"
#include "eeconfig.h"
#include "util.h"
#include "compiler_support.h"
#ifndef STENO_DEFAULT_MODE
# if defined(STENO_ENABLE_GEMINI)
# define STENO_DEFAULT_MODE STENO_MODE_GEMINI
# elif defined(STENO_ENABLE_BOLT)
# define STENO_DEFAULT_MODE STENO_MODE_BOLT
# endif
#endif
#if !defined(STENO_ENABLE_GEMINI)
STATIC_ASSERT(STENO_DEFAULT_MODE != STENO_MODE_GEMINI, "STENO_DEFAULT_MODE is set to STENO_MODE_GEMINI, but is not available. Enable the geminipr protocol or change STENO_DEFAULT_MODE to a valid mode.");
#endif
#if !defined(STENO_ENABLE_BOLT)
STATIC_ASSERT(STENO_DEFAULT_MODE != STENO_MODE_BOLT, "STENO_DEFAULT_MODE is set to STENO_MODE_BOLT, but is not available. Enable the txbolt protocol or change STENO_DEFAULT_MODE to a valid mode.");
#endif
static steno_mode_t mode = STENO_DEFAULT_MODE;
uint8_t steno_current_chord[MAX_STROKE_SIZE] = {0};
void steno_clear_chord(void) {
memset(steno_current_chord, 0, sizeof(steno_current_chord));
}
steno_mode_t steno_get_mode(void) {
return mode;
}
#if NUM_STENO_PROTOCOLS > 1
static const steno_mode_t mode_candidates[] = {
# if defined(STENO_ENABLE_GEMINI)
STENO_MODE_GEMINI,
# endif
# if defined(STENO_ENABLE_BOLT)
STENO_MODE_BOLT,
# endif
};
# define MODE_CANDIDATES_COUNT ARRAY_SIZE(mode_candidates)
static inline bool is_valid_mode(steno_mode_t mode) {
for (uint8_t i = 0; i < MODE_CANDIDATES_COUNT; i++) {
if (mode == mode_candidates[i]) {
return true;
}
}
return false;
}
void steno_set_mode_noeeprom(steno_mode_t new_mode) {
if (!is_valid_mode(new_mode)) {
return;
}
steno_clear_chord();
mode = new_mode;
}
void steno_set_mode(steno_mode_t new_mode) {
steno_set_mode_noeeprom(new_mode);
eeconfig_update_steno_mode(mode);
}
void steno_mode_next_noeeprom(void) {
uint8_t next = 0;
for (uint8_t i = 0; i < MODE_CANDIDATES_COUNT; i++) {
if (mode_candidates[i] == mode) {
next = (i == MODE_CANDIDATES_COUNT - 1) ? 0 : (i + 1);
break;
}
}
steno_set_mode_noeeprom(mode_candidates[next]);
}
void steno_mode_next(void) {
steno_mode_next_noeeprom();
eeconfig_update_steno_mode(mode);
}
void steno_mode_previous_noeeprom(void) {
uint8_t next = 0;
for (uint8_t i = 0; i < MODE_CANDIDATES_COUNT; i++) {
if (mode_candidates[i] == mode) {
next = (i == 0) ? (MODE_CANDIDATES_COUNT - 1) : (i - 1);
break;
}
}
steno_set_mode_noeeprom(mode_candidates[next]);
}
void steno_mode_previous(void) {
steno_mode_previous_noeeprom();
eeconfig_update_steno_mode(mode);
}
#endif
void eeconfig_update_steno_default(void) {
eeconfig_update_steno_mode(STENO_DEFAULT_MODE);
}
void steno_init(void) {
#if NUM_STENO_PROTOCOLS > 1
steno_mode_t loaded = eeconfig_read_steno_mode();
if (is_valid_mode(loaded)) {
mode = loaded;
}
#endif
}
quantum/steno/steno.h
+94
View File
@@ -0,0 +1,94 @@
// Copyright 2026 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <stdint.h>
#include "steno_keycodes.h"
#define BOLT_STROKE_SIZE 4
#define GEMINI_STROKE_SIZE 6
#if defined(STENO_ENABLE_GEMINI)
# define MAX_STROKE_SIZE GEMINI_STROKE_SIZE
#else
# define MAX_STROKE_SIZE BOLT_STROKE_SIZE
#endif
/**
* \enum steno_mode_t
*
* An enumeration of the possible modes.
*/
typedef enum {
STENO_MODE_GEMINI,
STENO_MODE_BOLT,
} steno_mode_t;
/**
* \brief Initialize the subsystem.
*
* This function must be called only once, before any of the below functions can be called.
*/
void steno_init(void);
/**
* \brief Reset configuration to defaults.
*
*/
void eeconfig_update_steno_default(void);
/**
* \brief Clear any currently pressed chords.
*
*/
void steno_clear_chord(void);
/**
* \brief Get currently configured mode.
*
* \return 'steno_mode_t' of the configured mode.
*/
steno_mode_t steno_get_mode(void);
#if NUM_STENO_PROTOCOLS > 1
/**
* \brief Set current mode. New state is not written to EEPROM.
*
* \param mode The mode to configure.
*/
void steno_set_mode_noeeprom(steno_mode_t mode);
/**
* \brief Set current mode.
*
* \param mode The mode to configure.
*/
void steno_set_mode(steno_mode_t mode);
/**
* \brief Move to the next potential mode. New state is not written to EEPROM.
*
*/
void steno_mode_next_noeeprom(void);
/**
* \brief Move to the next potential mode.
*
*/
void steno_mode_next(void);
/**
* \brief Move to the previous potential mode. New state is not written to EEPROM.
*
*/
void steno_mode_previous_noeeprom(void);
/**
* \brief Move to the previous potential mode.
*
*/
void steno_mode_previous(void);
#endif
quantum/steno/steno_bolt.c
+113
View File
@@ -0,0 +1,113 @@
// Copyright 2017, 2022 Joseph Wasson, Vladislav Kucheriavykh
// SPDX-License-Identifier: GPL-2.0-or-later
#include "steno.h"
#include "progmem.h"
#ifdef VIRTSER_ENABLE
# include "virtser.h"
#endif
#define TXB_NUL 0
#define TXB_S_L 0b00000001
#define TXB_T_L 0b00000010
#define TXB_K_L 0b00000100
#define TXB_P_L 0b00001000
#define TXB_W_L 0b00010000
#define TXB_H_L 0b00100000
#define TXB_R_L 0b01000001
#define TXB_A_L 0b01000010
#define TXB_O_L 0b01000100
#define TXB_STR 0b01001000
#define TXB_E_R 0b01010000
#define TXB_U_R 0b01100000
#define TXB_F_R 0b10000001
#define TXB_R_R 0b10000010
#define TXB_P_R 0b10000100
#define TXB_B_R 0b10001000
#define TXB_L_R 0b10010000
#define TXB_G_R 0b10100000
#define TXB_T_R 0b11000001
#define TXB_S_R 0b11000010
#define TXB_D_R 0b11000100
#define TXB_Z_R 0b11001000
#define TXB_NUM 0b11010000
#define TXB_GRP0 0b00000000
#define TXB_GRP1 0b01000000
#define TXB_GRP2 0b10000000
#define TXB_GRP3 0b11000000
#define TXB_GRPMASK 0b11000000
#define TXB_GET_GROUP(code) ((code & TXB_GRPMASK) >> 6)
// clang-format off
static const uint8_t boltmap[64] PROGMEM = {
TXB_NUL,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_S_L,
TXB_S_L,
TXB_T_L,
TXB_K_L,
TXB_P_L,
TXB_W_L,
TXB_H_L,
TXB_R_L,
TXB_A_L,
TXB_O_L,
TXB_STR,
TXB_STR,
TXB_NUL,
TXB_NUL,
TXB_NUL,
TXB_STR,
TXB_STR,
TXB_E_R,
TXB_U_R,
TXB_F_R,
TXB_R_R,
TXB_P_R,
TXB_B_R,
TXB_L_R,
TXB_G_R,
TXB_T_R,
TXB_S_R,
TXB_D_R,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_NUM,
TXB_Z_R,
};
// clang-format on
void steno_add_key_to_chord_bolt(uint8_t chord[MAX_STROKE_SIZE], uint8_t key) {
uint8_t boltcode = pgm_read_byte(boltmap + key);
chord[TXB_GET_GROUP(boltcode)] |= boltcode;
}
void steno_send_chord_bolt(uint8_t chord[MAX_STROKE_SIZE]) {
#ifdef VIRTSER_ENABLE
for (uint8_t i = 0; i < BOLT_STROKE_SIZE; ++i) {
// TX Bolt uses variable length packets where each byte corresponds to a bit array of certain keys.
// If a user chorded the keys of the first group with keys of the last group, for example, there
// would be bytes of 0x00 in `chord` for the middle groups which we mustn't send.
if (chord[i]) {
virtser_send(chord[i]);
}
}
// Sending a null packet is not always necessary, but it is simpler and more reliable
// to unconditionally send it every time instead of keeping track of more states and
// creating more branches in the execution of the program.
virtser_send(0);
#else
# pragma message "VIRTSER_ENABLE = yes is required for TX Bolt to work properly out of the box!"
#endif // VIRTSER_ENABLE
}
quantum/steno/steno_gemini.c
+32
View File
@@ -0,0 +1,32 @@
// Copyright 2017, 2022 Joseph Wasson, Vladislav Kucheriavykh
// SPDX-License-Identifier: GPL-2.0-or-later
#include "steno.h"
#ifdef VIRTSER_ENABLE
# include "virtser.h"
#endif
void steno_add_key_to_chord_gemini(uint8_t chord[MAX_STROKE_SIZE], uint8_t key) {
// Although each group of the packet is 8 bits long, the MSB is reserved
// to indicate whether that byte is the first byte of the packet (MSB=1)
// or one of the remaining five bytes of the packet (MSB=0).
// As a consequence, only 7 out of the 8 bits are left to be used as a bit array
// for the steno keys of that group.
const int group_idx = key / 7;
const int intra_group_idx = key - group_idx * 7;
// The 0th steno key of the group has bit=0b01000000, the 1st has bit=0b00100000, etc.
const uint8_t bit = 1 << (6 - intra_group_idx);
chord[group_idx] |= bit;
}
void steno_send_chord_gemini(uint8_t chord[MAX_STROKE_SIZE]) {
#ifdef VIRTSER_ENABLE
// Set MSB to 1 to indicate the start of packet
chord[0] |= 0x80;
for (uint8_t i = 0; i < GEMINI_STROKE_SIZE; ++i) {
virtser_send(chord[i]);
}
#else
# pragma message "VIRTSER_ENABLE = yes is required for Gemini PR to work properly out of the box!"
#endif // VIRTSER_ENABLE
}
quantum/steno_keycodes.h
+64 -112
View File
@@ -1,119 +1,71 @@
/* Copyright 2017 Joseph Wasson
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// Copyright 2026 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "keycodes.h"
// List of keycodes for the steno keyboard. To prevent
// errors, this must be <= 42 total entries in order to
// support the GeminiPR protocol.
enum steno_keycodes {
STN__MIN = QK_STENO,
STN_FN = STN__MIN,
STN_NUM,
STN_N1 = STN_NUM,
STN_N2,
STN_N3,
STN_N4,
STN_N5,
STN_N6,
STN_SL,
STN_S1 = STN_SL,
STN_S2,
STN_TL,
STN_KL,
STN_PL,
STN_WL,
STN_HL,
STN_RL,
STN_A,
STN_O,
STN_STR,
STN_ST1 = STN_STR,
STN_ST2,
STN_RES1,
STN_RE1 = STN_RES1,
STN_RES2,
STN_RE2 = STN_RES2,
STN_PWR,
STN_ST3,
STN_ST4,
STN_E,
STN_U,
STN_FR,
STN_RR,
STN_PR,
STN_BR,
STN_LR,
STN_GR,
STN_TR,
STN_SR,
STN_DR,
STN_N7,
STN_N8,
STN_N9,
STN_NA,
STN_NB,
STN_NC,
STN_ZR,
STN__MAX = STN_ZR, // must be less than QK_STENO_BOLT
};
// Deprecated steno keycodes
#define STN_FN QK_STENO_FUNCTION
#define STN_N1 QK_STENO_N1
#define STN_N2 QK_STENO_N2
#define STN_N3 QK_STENO_N3
#define STN_N4 QK_STENO_N4
#define STN_N5 QK_STENO_N5
#define STN_N6 QK_STENO_N6
#define STN_S1 QK_STENO_S1
#define STN_S2 QK_STENO_S2
#define STN_TL QK_STENO_TL
#define STN_KL QK_STENO_KL
#define STN_PL QK_STENO_PL
#define STN_WL QK_STENO_WL
#define STN_HL QK_STENO_HL
#define STN_RL QK_STENO_RL
#define STN_A QK_STENO_A
#define STN_O QK_STENO_O
#define STN_ST1 QK_STENO_ST1
#define STN_ST2 QK_STENO_ST2
#define STN_RE1 QK_STENO_RESET1
#define STN_RE2 QK_STENO_RESET2
#define STN_PWR QK_STENO_POWER
#define STN_ST3 QK_STENO_ST3
#define STN_ST4 QK_STENO_ST4
#define STN_E QK_STENO_E
#define STN_U QK_STENO_U
#define STN_FR QK_STENO_FR
#define STN_RR QK_STENO_RR
#define STN_PR QK_STENO_PR
#define STN_BR QK_STENO_BR
#define STN_LR QK_STENO_LR
#define STN_GR QK_STENO_GR
#define STN_TR QK_STENO_TR
#define STN_SR QK_STENO_SR
#define STN_DR QK_STENO_DR
#define STN_N7 QK_STENO_N7
#define STN_N8 QK_STENO_N8
#define STN_N9 QK_STENO_N9
#define STN_NA QK_STENO_NA
#define STN_NB QK_STENO_NB
#define STN_NC QK_STENO_NC
#define STN_ZR QK_STENO_ZR
#ifdef STENO_COMBINEDMAP
enum steno_combined_keycodes {
STN_S3 = QK_STENO_COMB,
STN_TKL,
STN_PWL,
STN_HRL,
STN_FRR,
STN_PBR,
STN_LGR,
STN_TSR,
STN_DZR,
STN_AO,
STN_EU,
STN_COMB_MAX = STN_EU,
};
#endif
#define STN_NUM QK_STENO_N1
#define STN_SL QK_STENO_S1
#define STN_STR QK_STENO_ST1
#define STN_RES1 QK_STENO_RESET1
#define STN_RES2 QK_STENO_RESET2
#ifdef STENO_ENABLE_BOLT
// TxBolt Codes
# define TXB_NUL 0
# define TXB_S_L 0b00000001
# define TXB_T_L 0b00000010
# define TXB_K_L 0b00000100
# define TXB_P_L 0b00001000
# define TXB_W_L 0b00010000
# define TXB_H_L 0b00100000
# define TXB_R_L 0b01000001
# define TXB_A_L 0b01000010
# define TXB_O_L 0b01000100
# define TXB_STR 0b01001000
# define TXB_E_R 0b01010000
# define TXB_U_R 0b01100000
# define TXB_F_R 0b10000001
# define TXB_R_R 0b10000010
# define TXB_P_R 0b10000100
# define TXB_B_R 0b10001000
# define TXB_L_R 0b10010000
# define TXB_G_R 0b10100000
# define TXB_T_R 0b11000001
# define TXB_S_R 0b11000010
# define TXB_D_R 0b11000100
# define TXB_Z_R 0b11001000
# define TXB_NUM 0b11010000
#endif // STENO_ENABLE_BOLT
#define STN_S3 QK_STENO_S3
#define STN_TKL QK_STENO_TKL
#define STN_PWL QK_STENO_PWL
#define STN_HRL QK_STENO_HRL
#define STN_FRR QK_STENO_FRR
#define STN_PBR QK_STENO_PBR
#define STN_LGR QK_STENO_LGR
#define STN_TSR QK_STENO_TSR
#define STN_DZR QK_STENO_DZR
#define STN_AO QK_STENO_AO
#define STN_EU QK_STENO_EU
#define QK_STENO_BOLT QK_STENO_MODE_BOLT
#define QK_STENO_GEMINI QK_STENO_MODE_GEMINI