qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-09-25 19:38:56 +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/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