mousekey.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395
  1. /*
  2. Copyright 2011 Jun Wako <wakojun@gmail.com>
  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. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. #include <stdint.h>
  15. #include "keycode.h"
  16. #include "host.h"
  17. #include "timer.h"
  18. #include "print.h"
  19. #include "debug.h"
  20. #include "mousekey.h"
  21. inline int8_t times_inv_sqrt2(int8_t x) {
  22. // 181/256 is pretty close to 1/sqrt(2)
  23. // 0.70703125 0.707106781
  24. // 1 too small for x=99 and x=198
  25. // This ends up being a mult and discard lower 8 bits
  26. return (x * 181) >> 8;
  27. }
  28. static report_mouse_t mouse_report = {0};
  29. static void mousekey_debug(void);
  30. static uint8_t mousekey_accel = 0;
  31. static uint8_t mousekey_repeat = 0;
  32. static uint16_t last_timer = 0;
  33. #ifndef MK_3_SPEED
  34. static uint16_t last_timer_c = 0;
  35. static uint16_t last_timer_w = 0;
  36. /*
  37. * Mouse keys acceleration algorithm
  38. * http://en.wikipedia.org/wiki/Mouse_keys
  39. *
  40. * speed = delta * max_speed * (repeat / time_to_max)**((1000+curve)/1000)
  41. */
  42. /* milliseconds between the initial key press and first repeated motion event (0-2550) */
  43. uint8_t mk_delay = MOUSEKEY_DELAY / 10;
  44. /* milliseconds between repeated motion events (0-255) */
  45. uint8_t mk_interval = MOUSEKEY_INTERVAL;
  46. /* steady speed (in action_delta units) applied each event (0-255) */
  47. uint8_t mk_max_speed = MOUSEKEY_MAX_SPEED;
  48. /* number of events (count) accelerating to steady speed (0-255) */
  49. uint8_t mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
  50. /* ramp used to reach maximum pointer speed (NOT SUPPORTED) */
  51. // int8_t mk_curve = 0;
  52. /* wheel params */
  53. /* milliseconds between the initial key press and first repeated motion event (0-2550) */
  54. uint8_t mk_wheel_delay = MOUSEKEY_WHEEL_DELAY / 10;
  55. /* milliseconds between repeated motion events (0-255) */
  56. uint8_t mk_wheel_interval = MOUSEKEY_WHEEL_INTERVAL;
  57. uint8_t mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
  58. uint8_t mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
  59. static uint8_t move_unit(void) {
  60. uint16_t unit;
  61. if (mousekey_accel & (1 << 0)) {
  62. unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed) / 4;
  63. } else if (mousekey_accel & (1 << 1)) {
  64. unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed) / 2;
  65. } else if (mousekey_accel & (1 << 2)) {
  66. unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed);
  67. } else if (mousekey_repeat == 0) {
  68. unit = MOUSEKEY_MOVE_DELTA;
  69. } else if (mousekey_repeat >= mk_time_to_max) {
  70. unit = MOUSEKEY_MOVE_DELTA * mk_max_speed;
  71. } else {
  72. unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed * mousekey_repeat) / mk_time_to_max;
  73. }
  74. return (unit > MOUSEKEY_MOVE_MAX ? MOUSEKEY_MOVE_MAX : (unit == 0 ? 1 : unit));
  75. }
  76. static uint8_t wheel_unit(void) {
  77. uint16_t unit;
  78. if (mousekey_accel & (1 << 0)) {
  79. unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed) / 4;
  80. } else if (mousekey_accel & (1 << 1)) {
  81. unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed) / 2;
  82. } else if (mousekey_accel & (1 << 2)) {
  83. unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed);
  84. } else if (mousekey_repeat == 0) {
  85. unit = MOUSEKEY_WHEEL_DELTA;
  86. } else if (mousekey_repeat >= mk_wheel_time_to_max) {
  87. unit = MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed;
  88. } else {
  89. unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed * mousekey_repeat) / mk_wheel_time_to_max;
  90. }
  91. return (unit > MOUSEKEY_WHEEL_MAX ? MOUSEKEY_WHEEL_MAX : (unit == 0 ? 1 : unit));
  92. }
  93. void mousekey_task(void) {
  94. // report cursor and scroll movement independently
  95. report_mouse_t const tmpmr = mouse_report;
  96. if ((mouse_report.x || mouse_report.y) &&
  97. timer_elapsed(last_timer_c) > (mousekey_repeat ? mk_interval : mk_delay * 10)) {
  98. if (mousekey_repeat != UINT8_MAX) mousekey_repeat++;
  99. mouse_report.v = 0;
  100. mouse_report.h = 0;
  101. if (mouse_report.x > 0) mouse_report.x = move_unit();
  102. if (mouse_report.x < 0) mouse_report.x = move_unit() * -1;
  103. if (mouse_report.y > 0) mouse_report.y = move_unit();
  104. if (mouse_report.y < 0) mouse_report.y = move_unit() * -1;
  105. /* diagonal move [1/sqrt(2)] */
  106. if (mouse_report.x && mouse_report.y) {
  107. mouse_report.x = times_inv_sqrt2(mouse_report.x);
  108. if (mouse_report.x == 0) { mouse_report.x = 1; }
  109. mouse_report.y = times_inv_sqrt2(mouse_report.y);
  110. if (mouse_report.y == 0) { mouse_report.y = 1; }
  111. }
  112. mousekey_send();
  113. last_timer_c = last_timer;
  114. mouse_report = tmpmr;
  115. }
  116. if ((mouse_report.v || mouse_report.h) &&
  117. timer_elapsed(last_timer_w) > (mousekey_repeat ? mk_wheel_interval: mk_wheel_delay * 10)) {
  118. if (mousekey_repeat != UINT8_MAX) mousekey_repeat++;
  119. mouse_report.x = 0;
  120. mouse_report.y = 0;
  121. if (mouse_report.v > 0) mouse_report.v = wheel_unit();
  122. if (mouse_report.v < 0) mouse_report.v = wheel_unit() * -1;
  123. if (mouse_report.h > 0) mouse_report.h = wheel_unit();
  124. if (mouse_report.h < 0) mouse_report.h = wheel_unit() * -1;
  125. /* diagonal move [1/sqrt(2)] */
  126. if (mouse_report.v && mouse_report.h) {
  127. mouse_report.v = times_inv_sqrt2(mouse_report.v);
  128. if (mouse_report.v == 0) { mouse_report.v = 1; }
  129. mouse_report.h = times_inv_sqrt2(mouse_report.h);
  130. if (mouse_report.h == 0) { mouse_report.h = 1; }
  131. }
  132. mousekey_send();
  133. last_timer_w = last_timer;
  134. mouse_report = tmpmr;
  135. }
  136. }
  137. void mousekey_on(uint8_t code) {
  138. if (code == KC_MS_UP)
  139. mouse_report.y = move_unit() * -1;
  140. else if (code == KC_MS_DOWN)
  141. mouse_report.y = move_unit();
  142. else if (code == KC_MS_LEFT)
  143. mouse_report.x = move_unit() * -1;
  144. else if (code == KC_MS_RIGHT)
  145. mouse_report.x = move_unit();
  146. else if (code == KC_MS_WH_UP)
  147. mouse_report.v = wheel_unit();
  148. else if (code == KC_MS_WH_DOWN)
  149. mouse_report.v = wheel_unit() * -1;
  150. else if (code == KC_MS_WH_LEFT)
  151. mouse_report.h = wheel_unit() * -1;
  152. else if (code == KC_MS_WH_RIGHT)
  153. mouse_report.h = wheel_unit();
  154. else if (code == KC_MS_BTN1)
  155. mouse_report.buttons |= MOUSE_BTN1;
  156. else if (code == KC_MS_BTN2)
  157. mouse_report.buttons |= MOUSE_BTN2;
  158. else if (code == KC_MS_BTN3)
  159. mouse_report.buttons |= MOUSE_BTN3;
  160. else if (code == KC_MS_BTN4)
  161. mouse_report.buttons |= MOUSE_BTN4;
  162. else if (code == KC_MS_BTN5)
  163. mouse_report.buttons |= MOUSE_BTN5;
  164. else if (code == KC_MS_ACCEL0)
  165. mousekey_accel |= (1 << 0);
  166. else if (code == KC_MS_ACCEL1)
  167. mousekey_accel |= (1 << 1);
  168. else if (code == KC_MS_ACCEL2)
  169. mousekey_accel |= (1 << 2);
  170. }
  171. void mousekey_off(uint8_t code) {
  172. if (code == KC_MS_UP && mouse_report.y < 0)
  173. mouse_report.y = 0;
  174. else if (code == KC_MS_DOWN && mouse_report.y > 0)
  175. mouse_report.y = 0;
  176. else if (code == KC_MS_LEFT && mouse_report.x < 0)
  177. mouse_report.x = 0;
  178. else if (code == KC_MS_RIGHT && mouse_report.x > 0)
  179. mouse_report.x = 0;
  180. else if (code == KC_MS_WH_UP && mouse_report.v > 0)
  181. mouse_report.v = 0;
  182. else if (code == KC_MS_WH_DOWN && mouse_report.v < 0)
  183. mouse_report.v = 0;
  184. else if (code == KC_MS_WH_LEFT && mouse_report.h < 0)
  185. mouse_report.h = 0;
  186. else if (code == KC_MS_WH_RIGHT && mouse_report.h > 0)
  187. mouse_report.h = 0;
  188. else if (code == KC_MS_BTN1)
  189. mouse_report.buttons &= ~MOUSE_BTN1;
  190. else if (code == KC_MS_BTN2)
  191. mouse_report.buttons &= ~MOUSE_BTN2;
  192. else if (code == KC_MS_BTN3)
  193. mouse_report.buttons &= ~MOUSE_BTN3;
  194. else if (code == KC_MS_BTN4)
  195. mouse_report.buttons &= ~MOUSE_BTN4;
  196. else if (code == KC_MS_BTN5)
  197. mouse_report.buttons &= ~MOUSE_BTN5;
  198. else if (code == KC_MS_ACCEL0)
  199. mousekey_accel &= ~(1 << 0);
  200. else if (code == KC_MS_ACCEL1)
  201. mousekey_accel &= ~(1 << 1);
  202. else if (code == KC_MS_ACCEL2)
  203. mousekey_accel &= ~(1 << 2);
  204. if (mouse_report.x == 0 && mouse_report.y == 0 && mouse_report.v == 0 && mouse_report.h == 0) mousekey_repeat = 0;
  205. }
  206. #else /* #ifndef MK_3_SPEED */
  207. enum { mkspd_unmod, mkspd_0, mkspd_1, mkspd_2, mkspd_COUNT };
  208. # ifndef MK_MOMENTARY_ACCEL
  209. static uint8_t mk_speed = mkspd_1;
  210. # else
  211. static uint8_t mk_speed = mkspd_unmod;
  212. static uint8_t mkspd_DEFAULT = mkspd_unmod;
  213. # endif
  214. static uint16_t last_timer_c = 0;
  215. static uint16_t last_timer_w = 0;
  216. uint16_t c_offsets[mkspd_COUNT] = {MK_C_OFFSET_UNMOD, MK_C_OFFSET_0, MK_C_OFFSET_1, MK_C_OFFSET_2};
  217. uint16_t c_intervals[mkspd_COUNT] = {MK_C_INTERVAL_UNMOD, MK_C_INTERVAL_0, MK_C_INTERVAL_1, MK_C_INTERVAL_2};
  218. uint16_t w_offsets[mkspd_COUNT] = {MK_W_OFFSET_UNMOD, MK_W_OFFSET_0, MK_W_OFFSET_1, MK_W_OFFSET_2};
  219. uint16_t w_intervals[mkspd_COUNT] = {MK_W_INTERVAL_UNMOD, MK_W_INTERVAL_0, MK_W_INTERVAL_1, MK_W_INTERVAL_2};
  220. void mousekey_task(void) {
  221. // report cursor and scroll movement independently
  222. report_mouse_t const tmpmr = mouse_report;
  223. if ((mouse_report.x || mouse_report.y) && timer_elapsed(last_timer_c) > c_intervals[mk_speed]) {
  224. mouse_report.h = 0;
  225. mouse_report.v = 0;
  226. mousekey_send();
  227. last_timer_c = last_timer;
  228. mouse_report = tmpmr;
  229. }
  230. if ((mouse_report.h || mouse_report.v) && timer_elapsed(last_timer_w) > w_intervals[mk_speed]) {
  231. mouse_report.x = 0;
  232. mouse_report.y = 0;
  233. mousekey_send();
  234. last_timer_w = last_timer;
  235. mouse_report = tmpmr;
  236. }
  237. }
  238. void adjust_speed(void) {
  239. uint16_t const c_offset = c_offsets[mk_speed];
  240. uint16_t const w_offset = w_offsets[mk_speed];
  241. if (mouse_report.x > 0) mouse_report.x = c_offset;
  242. if (mouse_report.x < 0) mouse_report.x = c_offset * -1;
  243. if (mouse_report.y > 0) mouse_report.y = c_offset;
  244. if (mouse_report.y < 0) mouse_report.y = c_offset * -1;
  245. if (mouse_report.h > 0) mouse_report.h = w_offset;
  246. if (mouse_report.h < 0) mouse_report.h = w_offset * -1;
  247. if (mouse_report.v > 0) mouse_report.v = w_offset;
  248. if (mouse_report.v < 0) mouse_report.v = w_offset * -1;
  249. // adjust for diagonals
  250. if (mouse_report.x && mouse_report.y) {
  251. mouse_report.x = times_inv_sqrt2(mouse_report.x);
  252. if (mouse_report.x == 0) {
  253. mouse_report.x = 1;
  254. }
  255. mouse_report.y = times_inv_sqrt2(mouse_report.y);
  256. if (mouse_report.y == 0) {
  257. mouse_report.y = 1;
  258. }
  259. }
  260. if (mouse_report.h && mouse_report.v) {
  261. mouse_report.h = times_inv_sqrt2(mouse_report.h);
  262. mouse_report.v = times_inv_sqrt2(mouse_report.v);
  263. }
  264. }
  265. void mousekey_on(uint8_t code) {
  266. uint16_t const c_offset = c_offsets[mk_speed];
  267. uint16_t const w_offset = w_offsets[mk_speed];
  268. uint8_t const old_speed = mk_speed;
  269. if (code == KC_MS_UP)
  270. mouse_report.y = c_offset * -1;
  271. else if (code == KC_MS_DOWN)
  272. mouse_report.y = c_offset;
  273. else if (code == KC_MS_LEFT)
  274. mouse_report.x = c_offset * -1;
  275. else if (code == KC_MS_RIGHT)
  276. mouse_report.x = c_offset;
  277. else if (code == KC_MS_WH_UP)
  278. mouse_report.v = w_offset;
  279. else if (code == KC_MS_WH_DOWN)
  280. mouse_report.v = w_offset * -1;
  281. else if (code == KC_MS_WH_LEFT)
  282. mouse_report.h = w_offset * -1;
  283. else if (code == KC_MS_WH_RIGHT)
  284. mouse_report.h = w_offset;
  285. else if (code == KC_MS_BTN1)
  286. mouse_report.buttons |= MOUSE_BTN1;
  287. else if (code == KC_MS_BTN2)
  288. mouse_report.buttons |= MOUSE_BTN2;
  289. else if (code == KC_MS_BTN3)
  290. mouse_report.buttons |= MOUSE_BTN3;
  291. else if (code == KC_MS_BTN4)
  292. mouse_report.buttons |= MOUSE_BTN4;
  293. else if (code == KC_MS_BTN5)
  294. mouse_report.buttons |= MOUSE_BTN5;
  295. else if (code == KC_MS_ACCEL0)
  296. mk_speed = mkspd_0;
  297. else if (code == KC_MS_ACCEL1)
  298. mk_speed = mkspd_1;
  299. else if (code == KC_MS_ACCEL2)
  300. mk_speed = mkspd_2;
  301. if (mk_speed != old_speed) adjust_speed();
  302. }
  303. void mousekey_off(uint8_t code) {
  304. # ifdef MK_MOMENTARY_ACCEL
  305. uint8_t const old_speed = mk_speed;
  306. # endif
  307. if (code == KC_MS_UP && mouse_report.y < 0)
  308. mouse_report.y = 0;
  309. else if (code == KC_MS_DOWN && mouse_report.y > 0)
  310. mouse_report.y = 0;
  311. else if (code == KC_MS_LEFT && mouse_report.x < 0)
  312. mouse_report.x = 0;
  313. else if (code == KC_MS_RIGHT && mouse_report.x > 0)
  314. mouse_report.x = 0;
  315. else if (code == KC_MS_WH_UP && mouse_report.v > 0)
  316. mouse_report.v = 0;
  317. else if (code == KC_MS_WH_DOWN && mouse_report.v < 0)
  318. mouse_report.v = 0;
  319. else if (code == KC_MS_WH_LEFT && mouse_report.h < 0)
  320. mouse_report.h = 0;
  321. else if (code == KC_MS_WH_RIGHT && mouse_report.h > 0)
  322. mouse_report.h = 0;
  323. else if (code == KC_MS_BTN1)
  324. mouse_report.buttons &= ~MOUSE_BTN1;
  325. else if (code == KC_MS_BTN2)
  326. mouse_report.buttons &= ~MOUSE_BTN2;
  327. else if (code == KC_MS_BTN3)
  328. mouse_report.buttons &= ~MOUSE_BTN3;
  329. else if (code == KC_MS_BTN4)
  330. mouse_report.buttons &= ~MOUSE_BTN4;
  331. else if (code == KC_MS_BTN5)
  332. mouse_report.buttons &= ~MOUSE_BTN5;
  333. # ifdef MK_MOMENTARY_ACCEL
  334. else if (code == KC_MS_ACCEL0)
  335. mk_speed = mkspd_DEFAULT;
  336. else if (code == KC_MS_ACCEL1)
  337. mk_speed = mkspd_DEFAULT;
  338. else if (code == KC_MS_ACCEL2)
  339. mk_speed = mkspd_DEFAULT;
  340. if (mk_speed != old_speed) adjust_speed();
  341. # endif
  342. }
  343. #endif /* #ifndef MK_3_SPEED */
  344. void mousekey_send(void) {
  345. mousekey_debug();
  346. host_mouse_send(&mouse_report);
  347. last_timer = timer_read();
  348. }
  349. void mousekey_clear(void) {
  350. mouse_report = (report_mouse_t){};
  351. mousekey_repeat = 0;
  352. mousekey_accel = 0;
  353. }
  354. static void mousekey_debug(void) {
  355. if (!debug_mouse) return;
  356. print("mousekey [btn|x y v h](rep/acl): [");
  357. phex(mouse_report.buttons);
  358. print("|");
  359. print_decs(mouse_report.x);
  360. print(" ");
  361. print_decs(mouse_report.y);
  362. print(" ");
  363. print_decs(mouse_report.v);
  364. print(" ");
  365. print_decs(mouse_report.h);
  366. print("](");
  367. print_dec(mousekey_repeat);
  368. print("/");
  369. print_dec(mousekey_accel);
  370. print(")\n");
  371. }