Ploopy drag scroll changes

Created Diff never expires
3 removals
Lines
Total
Removed
Words
Total
Removed
To continue using this feature, upgrade to
Diffchecker logo
Diffchecker Pro
247 lines
19 additions
Lines
Total
Added
Words
Total
Added
To continue using this feature, upgrade to
Diffchecker logo
Diffchecker Pro
262 lines
/* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <drashna@live.com>
/* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <drashna@live.com>
* Copyright 2019 Sunjun Kim
* Copyright 2019 Sunjun Kim
* Copyright 2020 Ploopy Corporation
* Copyright 2020 Ploopy Corporation
*
*
* This program is free software: you can redistribute it and/or modify
* 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
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
* (at your option) any later version.
*
*
* This program is distributed in the hope that it will be useful,
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* GNU General Public License for more details.
*
*
* You should have received a copy of the GNU General Public License
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
*/


#include "trackball.h"
#include "trackball.h"


#ifndef OPT_DEBOUNCE
#ifndef OPT_DEBOUNCE
# define OPT_DEBOUNCE 5 // (ms) Time between scroll events
# define OPT_DEBOUNCE 5 // (ms) Time between scroll events
#endif
#endif
#ifndef SCROLL_BUTT_DEBOUNCE
#ifndef SCROLL_BUTT_DEBOUNCE
# define SCROLL_BUTT_DEBOUNCE 100 // (ms) Time between scroll events
# define SCROLL_BUTT_DEBOUNCE 100 // (ms) Time between scroll events
#endif
#endif
#ifndef OPT_THRES
#ifndef OPT_THRES
# define OPT_THRES 150 // (0-1024) Threshold for actication
# define OPT_THRES 150 // (0-1024) Threshold for actication
#endif
#endif
#ifndef OPT_SCALE
#ifndef OPT_SCALE
# define OPT_SCALE 1 // Multiplier for wheel
# define OPT_SCALE 1 // Multiplier for wheel
#endif
#endif
#ifndef PLOOPY_DPI_OPTIONS
#ifndef PLOOPY_DPI_OPTIONS
# define PLOOPY_DPI_OPTIONS \
# define PLOOPY_DPI_OPTIONS \
{ 1200, 1600, 2400 }
{ 1200, 1600, 2400 }
# ifndef PLOOPY_DPI_DEFAULT
# ifndef PLOOPY_DPI_DEFAULT
# define PLOOPY_DPI_DEFAULT 1
# define PLOOPY_DPI_DEFAULT 1
# endif
# endif
#endif
#endif
#ifndef PLOOPY_DPI_DEFAULT
#ifndef PLOOPY_DPI_DEFAULT
# define PLOOPY_DPI_DEFAULT 0
# define PLOOPY_DPI_DEFAULT 0
#endif
#endif
#ifndef PLOOPY_DRAGSCROLL_DPI
#ifndef PLOOPY_DRAGSCROLL_DPI
# define PLOOPY_DRAGSCROLL_DPI 100 // Fixed-DPI Drag Scroll
# define PLOOPY_DRAGSCROLL_DPI 100 // Fixed-DPI Drag Scroll
#endif
#endif
#ifndef PLOOPY_DRAGSCROLL_MULTIPLIER
#ifndef PLOOPY_DRAGSCROLL_MULTIPLIER
# define PLOOPY_DRAGSCROLL_MULTIPLIER 0.75 // Variable-DPI Drag Scroll
# define PLOOPY_DRAGSCROLL_MULTIPLIER 0.75 // Variable-DPI Drag Scroll
#endif
#endif


#define PLOOPY_DRAGSCROLL_DENOMINATOR 10

static int _dragscroll_accumulator_x = 0;
static int _dragscroll_accumulator_y = 0;

keyboard_config_t keyboard_config;
keyboard_config_t keyboard_config;
uint16_t dpi_array[] = PLOOPY_DPI_OPTIONS;
uint16_t dpi_array[] = PLOOPY_DPI_OPTIONS;
#define DPI_OPTION_SIZE (sizeof(dpi_array) / sizeof(uint16_t))
#define DPI_OPTION_SIZE (sizeof(dpi_array) / sizeof(uint16_t))


// TODO: Implement libinput profiles
// TODO: Implement libinput profiles
// https://wayland.freedesktop.org/libinput/doc/latest/pointer-acceleration.html
// https://wayland.freedesktop.org/libinput/doc/latest/pointer-acceleration.html
// Compile time accel selection
// Compile time accel selection
// Valid options are ACC_NONE, ACC_LINEAR, ACC_CUSTOM, ACC_QUADRATIC
// Valid options are ACC_NONE, ACC_LINEAR, ACC_CUSTOM, ACC_QUADRATIC


// Trackball State
// Trackball State
bool is_scroll_clicked = false;
bool is_scroll_clicked = false;
bool BurstState = false; // init burst state for Trackball module
bool BurstState = false; // init burst state for Trackball module
uint16_t MotionStart = 0; // Timer for accel, 0 is resting state
uint16_t MotionStart = 0; // Timer for accel, 0 is resting state
uint16_t lastScroll = 0; // Previous confirmed wheel event
uint16_t lastScroll = 0; // Previous confirmed wheel event
uint16_t lastMidClick = 0; // Stops scrollwheel from being read if it was pressed
uint16_t lastMidClick = 0; // Stops scrollwheel from being read if it was pressed
uint8_t OptLowPin = OPT_ENC1;
uint8_t OptLowPin = OPT_ENC1;
bool debug_encoder = false;
bool debug_encoder = false;
bool is_drag_scroll = false;
bool is_drag_scroll = false;


__attribute__((weak)) bool encoder_update_user(uint8_t index, bool clockwise) { return true; }
__attribute__((weak)) bool encoder_update_user(uint8_t index, bool clockwise) { return true; }


bool encoder_update_kb(uint8_t index, bool clockwise) {
bool encoder_update_kb(uint8_t index, bool clockwise) {
if (!encoder_update_user(index, clockwise)) {
if (!encoder_update_user(index, clockwise)) {
return false;
return false;
}
}
#ifdef MOUSEKEY_ENABLE
#ifdef MOUSEKEY_ENABLE
tap_code(clockwise ? KC_WH_U : KC_WH_D);
tap_code(clockwise ? KC_WH_U : KC_WH_D);
#else
#else
mouse_report_t mouse_report = pointing_device_get_report();
mouse_report_t mouse_report = pointing_device_get_report();
mouse_report.v = clockwise ? 1 : -1;
mouse_report.v = clockwise ? 1 : -1;
pointing_device_set_report(mouse_report);
pointing_device_set_report(mouse_report);
pointing_device_send();
pointing_device_send();
#endif
#endif
return true;
return true;
}
}


void process_wheel(void) {
void process_wheel(void) {
// TODO: Replace this with interrupt driven code, polling is S L O W
// TODO: Replace this with interrupt driven code, polling is S L O W
// Lovingly ripped from the Ploopy Source
// Lovingly ripped from the Ploopy Source


// If the mouse wheel was just released, do not scroll.
// If the mouse wheel was just released, do not scroll.
if (timer_elapsed(lastMidClick) < SCROLL_BUTT_DEBOUNCE) {
if (timer_elapsed(lastMidClick) < SCROLL_BUTT_DEBOUNCE) {
return;
return;
}
}


// Limit the number of scrolls per unit time.
// Limit the number of scrolls per unit time.
if (timer_elapsed(lastScroll) < OPT_DEBOUNCE) {
if (timer_elapsed(lastScroll) < OPT_DEBOUNCE) {
return;
return;
}
}


// Don't scroll if the middle button is depressed.
// Don't scroll if the middle button is depressed.
if (is_scroll_clicked) {
if (is_scroll_clicked) {
#ifndef IGNORE_SCROLL_CLICK
#ifndef IGNORE_SCROLL_CLICK
return;
return;
#endif
#endif
}
}


lastScroll = timer_read();
lastScroll = timer_read();
uint16_t p1 = adc_read(OPT_ENC1_MUX);
uint16_t p1 = adc_read(OPT_ENC1_MUX);
uint16_t p2 = adc_read(OPT_ENC2_MUX);
uint16_t p2 = adc_read(OPT_ENC2_MUX);
if (debug_encoder) dprintf("OPT1: %d, OPT2: %d\n", p1, p2);
if (debug_encoder) dprintf("OPT1: %d, OPT2: %d\n", p1, p2);


int dir = opt_encoder_handler(p1, p2);
int dir = opt_encoder_handler(p1, p2);


if (dir == 0) return;
if (dir == 0) return;
encoder_update_kb(0, dir == 1);
encoder_update_kb(0, dir == 1);
}
}


report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
process_wheel();
process_wheel();


if (is_drag_scroll) {
if (is_drag_scroll) {
mouse_report.h = mouse_report.x;
_dragscroll_accumulator_x += mouse_report.x;
#ifdef PLOOPY_DRAGSCROLL_INVERT
#ifdef PLOOPY_DRAGSCROLL_INVERT
// Invert vertical scroll direction
// Invert vertical scroll direction
mouse_report.v = -mouse_report.y;
_dragscroll_accumulator_y += -mouse_report.y;
#else
#else
mouse_report.v = mouse_report.y;
_dragscroll_accumulator_y += mouse_report.y;
#endif
#endif
int div_x = _dragscroll_accumulator_x / PLOOPY_DRAGSCROLL_DENOMINATOR;
int div_y = _dragscroll_accumulator_y / PLOOPY_DRAGSCROLL_DENOMINATOR;
if (div_x != 0) {
mouse_report.h += div_x;
_dragscroll_accumulator_x -= div_x * PLOOPY_DRAGSCROLL_DENOMINATOR;
}
if (div_y != 0) {
mouse_report.v += div_y;
_dragscroll_accumulator_y -= div_y * PLOOPY_DRAGSCROLL_DENOMINATOR;
}
mouse_report.x = 0;
mouse_report.x = 0;
mouse_report.y = 0;
mouse_report.y = 0;
}
}


return pointing_device_task_user(mouse_report);
return pointing_device_task_user(mouse_report);
}
}


bool process_record_kb(uint16_t keycode, keyrecord_t* record) {
bool process_record_kb(uint16_t keycode, keyrecord_t* record) {
if (true) {
if (true) {
xprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
xprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
}
}


// Update Timer to prevent accidental scrolls
// Update Timer to prevent accidental scrolls
if ((record->event.key.col == 1) && (record->event.key.row == 0)) {
if ((record->event.key.col == 1) && (record->event.key.row == 0)) {
lastMidClick = timer_read();
lastMidClick = timer_read();
is_scroll_clicked = record->event.pressed;
is_scroll_clicked = record->event.pressed;
}
}


if (!process_record_user(keycode, record)) {
if (!process_record_user(keycode, record)) {
return false;
return false;
}
}


if (keycode == DPI_CONFIG && record->event.pressed) {
if (keycode == DPI_CONFIG && record->event.pressed) {
keyboard_config.dpi_config = (keyboard_config.dpi_config + 1) % DPI_OPTION_SIZE;
keyboard_config.dpi_config = (keyboard_config.dpi_config + 1) % DPI_OPTION_SIZE;
eeconfig_update_kb(keyboard_config.raw);
eeconfig_update_kb(keyboard_config.raw);
pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
}
}


if (keycode == DRAG_SCROLL) {
if (keycode == DRAG_SCROLL) {
#ifndef PLOOPY_DRAGSCROLL_MOMENTARY
#ifndef PLOOPY_DRAGSCROLL_MOMENTARY
if (record->event.pressed)
if (record->event.pressed)
#endif
#endif
{
{
is_drag_scroll ^= 1;
is_drag_scroll ^= 1;
}
}
#ifdef PLOOPY_DRAGSCROLL_FIXED
#ifdef PLOOPY_DRAGSCROLL_FIXED
pointing_device_set_cpi(is_drag_scroll ? PLOOPY_DRAGSCROLL_DPI : dpi_array[keyboard_config.dpi_config]);
pointing_device_set_cpi(is_drag_scroll ? PLOOPY_DRAGSCROLL_DPI : dpi_array[keyboard_config.dpi_config]);
#else
#else
pointing_device_set_cpi(is_drag_scroll ? (dpi_array[keyboard_config.dpi_config] * PLOOPY_DRAGSCROLL_MULTIPLIER) : dpi_array[keyboard_config.dpi_config]);
pointing_device_set_cpi(is_drag_scroll ? (dpi_array[keyboard_config.dpi_config] * PLOOPY_DRAGSCROLL_MULTIPLIER) : dpi_array[keyboard_config.dpi_config]);
#endif
#endif
}
}


/* If Mousekeys is disabled, then use handle the mouse button
/* If Mousekeys is disabled, then use handle the mouse button
* keycodes. This makes things simpler, and allows usage of
* keycodes. This makes things simpler, and allows usage of
* the keycodes in a consistent manner. But only do this if
* the keycodes in a consistent manner. But only do this if
* Mousekeys is not enable, so it's not handled twice.
* Mousekeys is not enable, so it's not handled twice.
*/
*/
#ifndef MOUSEKEY_ENABLE
#ifndef MOUSEKEY_ENABLE
if (IS_MOUSEKEY_BUTTON(keycode)) {
if (IS_MOUSEKEY_BUTTON(keycode)) {
report_mouse_t currentReport = pointing_device_get_report();
report_mouse_t currentReport = pointing_device_get_report();
currentReport.buttons = pointing_device_handle_buttons(currentReport.buttons, record->event.pressed, keycode - KC_MS_BTN1);
currentReport.buttons = pointing_device_handle_buttons(currentReport.buttons, record->event.pressed, keycode - KC_MS_BTN1);
pointing_device_set_report(currentReport);
pointing_device_set_report(currentReport);
pointing_device_send();
pointing_device_send();
}
}
#endif
#endif


return true;
return true;
}
}


// Hardware Setup
// Hardware Setup
void keyboard_pre_init_kb(void) {
void keyboard_pre_init_kb(void) {
// debug_enable = true;
// debug_enable = true;
// debug_matrix = true;
// debug_matrix = true;
// debug_mouse = true;
// debug_mouse = true;
// debug_encoder = true;
// debug_encoder = true;


setPinInput(OPT_ENC1);
setPinInput(OPT_ENC1);
setPinInput(OPT_ENC2);
setPinInput(OPT_ENC2);


/* Ground all output pins connected to ground. This provides additional
/* Ground all output pins connected to ground. This provides additional
* pathways to ground. If you're messing with this, know this: driving ANY
* pathways to ground. If you're messing with this, know this: driving ANY
* of these pins high will cause a short. On the MCU. Ka-blooey.
* of these pins high will cause a short. On the MCU. Ka-blooey.
*/
*/
#ifdef UNUSED_PINS
#ifdef UNUSED_PINS
const pin_t unused_pins[] = UNUSED_PINS;
const pin_t unused_pins[] = UNUSED_PINS;


for (uint8_t i = 0; i < (sizeof(unused_pins) / sizeof(pin_t)); i++) {
for (uint8_t i = 0; i < (sizeof(unused_pins) / sizeof(pin_t)); i++) {
setPinOutput(unused_pins[i]);
setPinOutput(unused_pins[i]);
writePinLow(unused_pins[i]);
writePinLow(unused_pins[i]);
}
}
#endif
#endif


// This is the debug LED.
// This is the debug LED.
#if defined(DEBUG_LED_PIN)
#if defined(DEBUG_LED_PIN)
setPinOutput(DEBUG_LED_PIN);
setPinOutput(DEBUG_LED_PIN);
writePin(DEBUG_LED_PIN, debug_enable);
writePin(DEBUG_LED_PIN, debug_enable);
#endif
#endif


keyboard_pre_init_user();
keyboard_pre_init_user();
}
}


void pointing_device_init_kb(void) {
void pointing_device_init_kb(void) {
pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
// initialize the scroll wheel's optical encoder
// initialize the scroll wheel's optical encoder
opt_encoder_init();
opt_encoder_init();
}
}


void eeconfig_init_kb(void) {
void eeconfig_init_kb(void) {
keyboard_config.dpi_config = PLOOPY_DPI_DEFAULT;
keyboard_config.dpi_config = PLOOPY_DPI_DEFAULT;
eeconfig_update_kb(keyboard_config.raw);
eeconfig_update_kb(keyboard_config.raw);
eeconfig_init_user();
eeconfig_init_user();
}
}


void matrix_init_kb(void) {
void matrix_init_kb(void) {
// is safe to just read DPI setting since matrix init
// is safe to just read DPI setting since matrix init
// comes before pointing device init.
// comes before pointing device init.
keyboard_config.raw = eeconfig_read_kb();
keyboard_config.raw = eeconfig_read_kb();
if (keyboard_config.dpi_config > DPI_OPTION_SIZE) {
if (keyboard_config.dpi_config > DPI_OPTION_SIZE) {
eeconfig_init_kb();
eeconfig_init_kb();
}
}
matrix_init_user();
matrix_init_user();
}
}


void keyboard_post_init_kb(void) {
void keyboard_post_init_kb(void) {
pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);


keyboard_post_init_user();
keyboard_post_init_user();
}
}