2 * Copyright © 2014 Red Hat, Inc.
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation for any purpose is hereby granted without fee, provided
6 * that the above copyright notice appear in all copies and that both that
7 * copyright notice and this permission notice appear in supporting
8 * documentation, and that the name of the copyright holders not be used in
9 * advertising or publicity pertaining to distribution of the software
10 * without specific, written prior permission. The copyright holders make
11 * no representations about the suitability of this software for any
12 * purpose. It is provided "as is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
15 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
17 * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
18 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
19 * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
29 #include "evdev-mt-touchpad.h"
31 #define DEFAULT_ACCEL_NUMERATOR 1200.0
32 #define DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR 700.0
35 tp_hysteresis(int in, int center, int margin)
37 int diff = in - center;
38 if (abs(diff) <= margin)
42 return center + diff - margin;
44 return center + diff + margin;
47 static inline struct tp_motion *
48 tp_motion_history_offset(struct tp_touch *t, int offset)
51 (t->history.index - offset + TOUCHPAD_HISTORY_LENGTH) %
52 TOUCHPAD_HISTORY_LENGTH;
54 return &t->history.samples[offset_index];
58 tp_filter_motion(struct tp_dispatch *tp,
59 double *dx, double *dy, uint64_t time)
61 struct motion_params motion;
63 motion.dx = *dx * tp->accel.x_scale_coeff;
64 motion.dy = *dy * tp->accel.y_scale_coeff;
66 filter_dispatch(tp->filter, &motion, tp, time);
73 tp_motion_history_push(struct tp_touch *t)
75 int motion_index = (t->history.index + 1) % TOUCHPAD_HISTORY_LENGTH;
77 if (t->history.count < TOUCHPAD_HISTORY_LENGTH)
80 t->history.samples[motion_index].x = t->x;
81 t->history.samples[motion_index].y = t->y;
82 t->history.index = motion_index;
86 tp_motion_hysteresis(struct tp_dispatch *tp,
92 if (t->history.count == 0) {
93 t->hysteresis.center_x = t->x;
94 t->hysteresis.center_y = t->y;
97 t->hysteresis.center_x,
98 tp->hysteresis.margin_x);
100 t->hysteresis.center_y,
101 tp->hysteresis.margin_y);
102 t->hysteresis.center_x = x;
103 t->hysteresis.center_y = y;
110 tp_motion_history_reset(struct tp_touch *t)
112 t->history.count = 0;
115 static inline struct tp_touch *
116 tp_current_touch(struct tp_dispatch *tp)
118 return &tp->touches[min(tp->slot, tp->ntouches - 1)];
121 static inline struct tp_touch *
122 tp_get_touch(struct tp_dispatch *tp, unsigned int slot)
124 assert(slot < tp->ntouches);
125 return &tp->touches[slot];
129 tp_begin_touch(struct tp_dispatch *tp, struct tp_touch *t)
131 if (t->state != TOUCH_UPDATE) {
132 tp_motion_history_reset(t);
134 t->state = TOUCH_BEGIN;
135 t->pinned.is_pinned = false;
137 assert(tp->nfingers_down >= 1);
138 tp->queued |= TOUCHPAD_EVENT_MOTION;
143 tp_end_touch(struct tp_dispatch *tp, struct tp_touch *t)
145 if (t->state == TOUCH_NONE)
149 t->is_pointer = false;
150 t->state = TOUCH_END;
151 t->pinned.is_pinned = false;
152 assert(tp->nfingers_down >= 1);
154 tp->queued |= TOUCHPAD_EVENT_MOTION;
158 tp_estimate_delta(int x0, int x1, int x2, int x3)
160 return (x0 + x1 - x2 - x3) / 4;
164 tp_get_delta(struct tp_touch *t, double *dx, double *dy)
166 if (t->history.count < 4) {
172 *dx = tp_estimate_delta(tp_motion_history_offset(t, 0)->x,
173 tp_motion_history_offset(t, 1)->x,
174 tp_motion_history_offset(t, 2)->x,
175 tp_motion_history_offset(t, 3)->x);
176 *dy = tp_estimate_delta(tp_motion_history_offset(t, 0)->y,
177 tp_motion_history_offset(t, 1)->y,
178 tp_motion_history_offset(t, 2)->y,
179 tp_motion_history_offset(t, 3)->y);
183 tp_process_absolute(struct tp_dispatch *tp,
184 const struct input_event *e,
187 struct tp_touch *t = tp_current_touch(tp);
190 case ABS_MT_POSITION_X:
194 tp->queued |= TOUCHPAD_EVENT_MOTION;
196 case ABS_MT_POSITION_Y:
200 tp->queued |= TOUCHPAD_EVENT_MOTION;
205 case ABS_MT_TRACKING_ID:
208 tp_begin_touch(tp, t);
215 tp_process_absolute_st(struct tp_dispatch *tp,
216 const struct input_event *e,
219 struct tp_touch *t = tp_current_touch(tp);
226 tp->queued |= TOUCHPAD_EVENT_MOTION;
232 tp->queued |= TOUCHPAD_EVENT_MOTION;
238 tp_process_fake_touch(struct tp_dispatch *tp,
239 const struct input_event *e,
243 unsigned int fake_touches;
244 unsigned int nfake_touches;
248 if (e->code != BTN_TOUCH &&
249 (e->code < BTN_TOOL_DOUBLETAP || e->code > BTN_TOOL_QUADTAP))
252 shift = e->code == BTN_TOUCH ? 0 : (e->code - BTN_TOOL_DOUBLETAP + 1);
255 tp->fake_touches |= 1 << shift;
257 tp->fake_touches &= ~(0x1 << shift);
259 fake_touches = tp->fake_touches;
261 while (fake_touches) {
266 for (i = 0; i < tp->ntouches; i++) {
267 t = tp_get_touch(tp, i);
268 if (i >= nfake_touches) {
269 if (t->state != TOUCH_NONE) {
273 } else if (t->state != TOUCH_UPDATE &&
274 t->state != TOUCH_BEGIN) {
275 t->state = TOUCH_NONE;
276 tp_begin_touch(tp, t);
282 assert(tp->nfingers_down == nfake_touches);
286 tp_process_key(struct tp_dispatch *tp,
287 const struct input_event *e,
294 tp_process_button(tp, e, time);
297 case BTN_TOOL_DOUBLETAP:
298 case BTN_TOOL_TRIPLETAP:
299 case BTN_TOOL_QUADTAP:
301 tp_process_fake_touch(tp, e, time);
307 tp_unpin_finger(struct tp_dispatch *tp, struct tp_touch *t)
309 unsigned int xdist, ydist;
311 if (!t->pinned.is_pinned)
314 xdist = abs(t->x - t->pinned.center_x);
315 ydist = abs(t->y - t->pinned.center_y);
317 if (xdist * xdist + ydist * ydist >=
318 tp->buttons.motion_dist * tp->buttons.motion_dist) {
319 t->pinned.is_pinned = false;
320 tp_set_pointer(tp, t);
325 tp_pin_fingers(struct tp_dispatch *tp)
329 tp_for_each_touch(tp, t) {
330 t->is_pointer = false;
331 t->pinned.is_pinned = true;
332 t->pinned.center_x = t->x;
333 t->pinned.center_y = t->y;
338 tp_touch_active(struct tp_dispatch *tp, struct tp_touch *t)
340 return (t->state == TOUCH_BEGIN || t->state == TOUCH_UPDATE) &&
341 !t->pinned.is_pinned && tp_button_touch_active(tp, t);
345 tp_set_pointer(struct tp_dispatch *tp, struct tp_touch *t)
347 struct tp_touch *tmp = NULL;
349 /* Only set the touch as pointer if we don't have one yet */
350 tp_for_each_touch(tp, tmp) {
355 if (tp_touch_active(tp, t))
356 t->is_pointer = true;
360 tp_process_state(struct tp_dispatch *tp, uint64_t time)
363 struct tp_touch *first = tp_get_touch(tp, 0);
365 tp_for_each_touch(tp, t) {
366 if (!tp->has_mt && t != first && first->fake) {
370 t->dirty = first->dirty;
371 } else if (!t->dirty)
374 tp_motion_hysteresis(tp, t);
375 tp_motion_history_push(t);
377 tp_unpin_finger(tp, t);
380 tp_button_handle_state(tp, time);
383 * We have a physical button down event on a clickpad. To avoid
384 * spurious pointer moves by the clicking finger we pin all fingers.
385 * We unpin fingers when they move more then a certain threshold to
386 * to allow drag and drop.
388 if ((tp->queued & TOUCHPAD_EVENT_BUTTON_PRESS) &&
389 tp->buttons.is_clickpad)
394 tp_post_process_state(struct tp_dispatch *tp, uint64_t time)
398 tp_for_each_touch(tp, t) {
402 if (t->state == TOUCH_END) {
403 t->state = TOUCH_NONE;
405 } else if (t->state == TOUCH_BEGIN)
406 t->state = TOUCH_UPDATE;
411 tp->buttons.old_state = tp->buttons.state;
413 tp->queued = TOUCHPAD_EVENT_NONE;
417 tp_post_twofinger_scroll(struct tp_dispatch *tp, uint64_t time)
421 double dx = 0, dy =0;
424 tp_for_each_touch(tp, t) {
425 if (tp_touch_active(tp, t) && t->dirty) {
427 tp_get_delta(t, &tmpx, &tmpy);
432 /* Stop spurious MOTION events at the end of scrolling */
433 t->is_pointer = false;
442 tp_filter_motion(tp, &dx, &dy, time);
444 /* Require at least five px scrolling to start */
445 if (dy <= -5.0 || dy >= 5.0)
446 tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL);
448 if (dx <= -5.0 || dx >= 5.0)
449 tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL);
452 (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL))) {
453 pointer_notify_axis(&tp->device->base,
455 LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
460 (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL))) {
461 pointer_notify_axis(&tp->device->base,
463 LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL,
469 tp_stop_scroll_events(struct tp_dispatch *tp, uint64_t time)
471 /* terminate scrolling with a zero scroll event */
472 if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL))
473 pointer_notify_axis(&tp->device->base,
475 LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
477 if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL))
478 pointer_notify_axis(&tp->device->base,
480 LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL,
483 tp->scroll.direction = 0;
487 tp_post_scroll_events(struct tp_dispatch *tp, uint64_t time)
490 int nfingers_down = 0;
492 /* Only count active touches for 2 finger scrolling */
493 tp_for_each_touch(tp, t) {
494 if (tp_touch_active(tp, t))
498 if (nfingers_down != 2) {
499 tp_stop_scroll_events(tp, time);
503 tp_post_twofinger_scroll(tp, time);
508 tp_post_events(struct tp_dispatch *tp, uint64_t time)
510 struct tp_touch *t = tp_current_touch(tp);
514 consumed |= tp_tap_handle_state(tp, time);
515 consumed |= tp_post_button_events(tp, time);
518 tp_stop_scroll_events(tp, time);
522 if (tp_post_scroll_events(tp, time) != 0)
525 if (t->history.count >= TOUCHPAD_MIN_SAMPLES) {
526 if (!t->is_pointer) {
527 tp_for_each_touch(tp, t) {
536 tp_get_delta(t, &dx, &dy);
537 tp_filter_motion(tp, &dx, &dy, time);
539 if (dx != 0.0 || dy != 0.0)
540 pointer_notify_motion(&tp->device->base, time, dx, dy);
545 tp_process(struct evdev_dispatch *dispatch,
546 struct evdev_device *device,
547 struct input_event *e,
550 struct tp_dispatch *tp =
551 (struct tp_dispatch *)dispatch;
556 tp_process_absolute(tp, e, time);
558 tp_process_absolute_st(tp, e, time);
561 tp_process_key(tp, e, time);
564 tp_process_state(tp, time);
565 tp_post_events(tp, time);
566 tp_post_process_state(tp, time);
572 tp_destroy(struct evdev_dispatch *dispatch)
574 struct tp_dispatch *tp =
575 (struct tp_dispatch*)dispatch;
578 tp_destroy_buttons(tp);
580 filter_destroy(tp->filter);
585 static struct evdev_dispatch_interface tp_interface = {
591 tp_init_touch(struct tp_dispatch *tp,
598 tp_init_slots(struct tp_dispatch *tp,
599 struct evdev_device *device)
602 const struct input_absinfo *absinfo;
604 absinfo = libevdev_get_abs_info(device->evdev, ABS_MT_SLOT);
606 tp->ntouches = absinfo->maximum + 1;
607 tp->slot = absinfo->value;
614 { BTN_TOOL_QUINTTAP, 5 },
615 { BTN_TOOL_QUADTAP, 4 },
616 { BTN_TOOL_TRIPLETAP, 3 },
617 { BTN_TOOL_DOUBLETAP, 2 },
625 ARRAY_FOR_EACH(max_touches, m) {
626 if (libevdev_has_event_code(device->evdev,
629 tp->ntouches = m->ntouches;
634 tp->touches = calloc(tp->ntouches,
635 sizeof(struct tp_touch));
639 for (i = 0; i < tp->ntouches; i++)
640 tp_init_touch(tp, &tp->touches[i]);
646 tp_init_accel(struct tp_dispatch *tp, double diagonal)
648 struct motion_filter *accel;
652 res_x = libevdev_get_abs_resolution(tp->device->evdev,
654 res_y = libevdev_get_abs_resolution(tp->device->evdev,
657 res_x = libevdev_get_abs_resolution(tp->device->evdev,
659 res_y = libevdev_get_abs_resolution(tp->device->evdev,
664 * Not all touchpads report the same amount of units/mm (resolution).
665 * Normalize motion events to a resolution of 10 units/mm as base
666 * (unaccelerated) speed. This also evens out any differences in x
667 * and y resolution, so that a circle on the touchpad does not turn
668 * into an elipse on the screen.
670 if (res_x > 1 && res_y > 1) {
671 tp->accel.x_scale_coeff = 10.0 / res_x;
672 tp->accel.y_scale_coeff = 10.0 / res_y;
675 * For touchpads where the driver does not provide resolution, fall
676 * back to scaling motion events based on the diagonal size in units.
678 tp->accel.x_scale_coeff = DEFAULT_ACCEL_NUMERATOR / diagonal;
679 tp->accel.y_scale_coeff = DEFAULT_ACCEL_NUMERATOR / diagonal;
682 accel = create_pointer_accelator_filter(
683 pointer_accel_profile_smooth_simple);
693 tp_init_scroll(struct tp_dispatch *tp)
695 tp->scroll.direction = 0;
701 tp_init(struct tp_dispatch *tp,
702 struct evdev_device *device)
707 tp->base.interface = &tp_interface;
710 if (tp_init_slots(tp, device) != 0)
713 width = abs(device->abs.absinfo_x->maximum -
714 device->abs.absinfo_x->minimum);
715 height = abs(device->abs.absinfo_y->maximum -
716 device->abs.absinfo_y->minimum);
717 diagonal = sqrt(width*width + height*height);
719 tp->hysteresis.margin_x =
720 diagonal / DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR;
721 tp->hysteresis.margin_y =
722 diagonal / DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR;
724 if (tp_init_scroll(tp) != 0)
727 if (tp_init_accel(tp, diagonal) != 0)
730 if (tp_init_tap(tp) != 0)
733 if (tp_init_buttons(tp, device) != 0)
739 struct evdev_dispatch *
740 evdev_mt_touchpad_create(struct evdev_device *device)
742 struct tp_dispatch *tp;
744 tp = zalloc(sizeof *tp);
748 if (tp_init(tp, device) != 0) {
749 tp_destroy(&tp->base);