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_CONSTANT_ACCEL_NUMERATOR 50
32 #define DEFAULT_MIN_ACCEL_FACTOR 0.16
33 #define DEFAULT_MAX_ACCEL_FACTOR 1.0
34 #define DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR 700.0
37 tp_hysteresis(int in, int center, int margin)
39 int diff = in - center;
40 if (abs(diff) <= margin)
44 return center + diff - margin;
45 else if (diff < -margin)
46 return center + diff + margin;
51 tp_accel_profile(struct motion_filter *filter,
56 struct tp_dispatch *tp =
57 (struct tp_dispatch *) data;
61 accel_factor = velocity * tp->accel.constant_factor;
63 if (accel_factor > tp->accel.max_factor)
64 accel_factor = tp->accel.max_factor;
65 else if (accel_factor < tp->accel.min_factor)
66 accel_factor = tp->accel.min_factor;
71 static inline struct tp_motion *
72 tp_motion_history_offset(struct tp_touch *t, int offset)
75 (t->history.index - offset + TOUCHPAD_HISTORY_LENGTH) %
76 TOUCHPAD_HISTORY_LENGTH;
78 return &t->history.samples[offset_index];
82 tp_filter_motion(struct tp_dispatch *tp,
83 double *dx, double *dy, uint32_t time)
85 struct motion_params motion;
90 filter_dispatch(tp->filter, &motion, tp, time);
97 tp_motion_history_push(struct tp_touch *t)
99 int motion_index = (t->history.index + 1) % TOUCHPAD_HISTORY_LENGTH;
101 if (t->history.count < TOUCHPAD_HISTORY_LENGTH)
104 t->history.samples[motion_index].x = t->x;
105 t->history.samples[motion_index].y = t->y;
106 t->history.index = motion_index;
110 tp_motion_hysteresis(struct tp_dispatch *tp,
116 if (t->history.count == 0) {
117 t->hysteresis.center_x = t->x;
118 t->hysteresis.center_y = t->y;
121 t->hysteresis.center_x,
122 tp->hysteresis.margin_x);
124 t->hysteresis.center_y,
125 tp->hysteresis.margin_y);
126 t->hysteresis.center_x = x;
127 t->hysteresis.center_y = y;
134 tp_motion_history_reset(struct tp_touch *t)
136 t->history.count = 0;
139 static inline struct tp_touch *
140 tp_current_touch(struct tp_dispatch *tp)
142 return &tp->touches[min(tp->slot, tp->ntouches)];
145 static inline struct tp_touch *
146 tp_get_touch(struct tp_dispatch *tp, unsigned int slot)
148 assert(slot < tp->ntouches);
149 return &tp->touches[slot];
153 tp_begin_touch(struct tp_dispatch *tp, struct tp_touch *t)
155 if (t->state != TOUCH_UPDATE) {
156 tp_motion_history_reset(t);
158 t->state = TOUCH_BEGIN;
160 assert(tp->nfingers_down >= 1);
161 tp->queued |= TOUCHPAD_EVENT_MOTION;
163 if (tp->nfingers_down == 1)
164 t->is_pointer = true;
169 tp_end_touch(struct tp_dispatch *tp, struct tp_touch *t)
171 if (t->state == TOUCH_NONE)
175 t->is_pointer = false;
176 t->state = TOUCH_END;
177 assert(tp->nfingers_down >= 1);
179 tp->queued |= TOUCHPAD_EVENT_MOTION;
183 tp_estimate_delta(int x0, int x1, int x2, int x3)
185 return (x0 + x1 - x2 - x3) / 4;
189 tp_get_delta(struct tp_touch *t, double *dx, double *dy)
191 if (t->history.count < 4) {
197 *dx = tp_estimate_delta(tp_motion_history_offset(t, 0)->x,
198 tp_motion_history_offset(t, 1)->x,
199 tp_motion_history_offset(t, 2)->x,
200 tp_motion_history_offset(t, 3)->x);
201 *dy = tp_estimate_delta(tp_motion_history_offset(t, 0)->y,
202 tp_motion_history_offset(t, 1)->y,
203 tp_motion_history_offset(t, 2)->y,
204 tp_motion_history_offset(t, 3)->y);
208 tp_process_absolute(struct tp_dispatch *tp,
209 const struct input_event *e,
212 struct tp_touch *t = tp_current_touch(tp);
215 case ABS_MT_POSITION_X:
219 tp->queued |= TOUCHPAD_EVENT_MOTION;
221 case ABS_MT_POSITION_Y:
225 tp->queued |= TOUCHPAD_EVENT_MOTION;
230 case ABS_MT_TRACKING_ID:
233 tp_begin_touch(tp, t);
240 tp_process_absolute_st(struct tp_dispatch *tp,
241 const struct input_event *e,
244 struct tp_touch *t = tp_current_touch(tp);
256 tp->queued |= TOUCHPAD_EVENT_MOTION;
262 tp_process_fake_touch(struct tp_dispatch *tp,
263 const struct input_event *e,
267 unsigned int fake_touches;
268 unsigned int nfake_touches;
272 if (e->code != BTN_TOUCH &&
273 (e->code < BTN_TOOL_DOUBLETAP || e->code > BTN_TOOL_QUADTAP))
276 shift = e->code == BTN_TOUCH ? 0 : (e->code - BTN_TOOL_DOUBLETAP + 1);
279 tp->fake_touches |= 1 << shift;
281 tp->fake_touches &= ~(0x1 << shift);
283 fake_touches = tp->fake_touches;
285 while (fake_touches) {
290 for (i = 0; i < tp->ntouches; i++) {
291 t = tp_get_touch(tp, i);
292 if (i >= nfake_touches) {
293 if (t->state != TOUCH_NONE) {
297 } else if (t->state != TOUCH_UPDATE &&
298 t->state != TOUCH_BEGIN) {
299 t->state = TOUCH_NONE;
300 tp_begin_touch(tp, t);
306 assert(tp->nfingers_down == nfake_touches);
310 tp_process_key(struct tp_dispatch *tp,
311 const struct input_event *e,
320 mask = 1 << (e->code - BTN_LEFT);
322 tp->buttons.state |= mask;
323 tp->queued |= TOUCHPAD_EVENT_BUTTON_PRESS;
325 tp->buttons.state &= ~mask;
326 tp->queued |= TOUCHPAD_EVENT_BUTTON_RELEASE;
330 case BTN_TOOL_DOUBLETAP:
331 case BTN_TOOL_TRIPLETAP:
332 case BTN_TOOL_QUADTAP:
334 tp_process_fake_touch(tp, e, time);
340 tp_process_state(struct tp_dispatch *tp, uint32_t time)
343 struct tp_touch *first = tp_get_touch(tp, 0);
345 tp_for_each_touch(tp, t) {
346 if (!tp->has_mt && t != first && first->fake) {
350 t->dirty = first->dirty;
351 } else if (!t->dirty)
354 tp_motion_hysteresis(tp, t);
355 tp_motion_history_push(t);
360 tp_post_process_state(struct tp_dispatch *tp, uint32_t time)
364 tp_for_each_touch(tp, t) {
368 if (t->state == TOUCH_END) {
369 t->state = TOUCH_NONE;
371 } else if (t->state == TOUCH_BEGIN)
372 t->state = TOUCH_UPDATE;
377 tp->buttons.old_state = tp->buttons.state;
379 tp->queued = TOUCHPAD_EVENT_NONE;
383 tp_post_twofinger_scroll(struct tp_dispatch *tp, uint32_t time)
387 double dx = 0, dy =0;
390 tp_for_each_touch(tp, t) {
393 tp_get_delta(t, &tmpx, &tmpy);
406 tp_filter_motion(tp, &dx, &dy, time);
408 if (tp->scroll.state == SCROLL_STATE_NONE) {
409 /* Require at least one px scrolling to start */
410 if (dx <= -1.0 || dx >= 1.0) {
411 tp->scroll.state = SCROLL_STATE_SCROLLING;
412 tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL);
415 if (dy <= -1.0 || dy >= 1.0) {
416 tp->scroll.state = SCROLL_STATE_SCROLLING;
417 tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL);
420 if (tp->scroll.state == SCROLL_STATE_NONE)
425 (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL))) {
426 pointer_notify_axis(&tp->device->base,
428 LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL,
429 li_fixed_from_double(dy));
433 (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL))) {
434 pointer_notify_axis(&tp->device->base,
436 LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL,
437 li_fixed_from_double(dx));
442 tp_post_scroll_events(struct tp_dispatch *tp, uint32_t time)
444 if (tp->nfingers_down != 2) {
445 /* terminate scrolling with a zero scroll event to notify
446 * caller that it really ended now */
447 if (tp->scroll.state != SCROLL_STATE_NONE) {
448 tp->scroll.state = SCROLL_STATE_NONE;
449 tp->scroll.direction = 0;
450 if (tp->scroll.direction & LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL)
451 pointer_notify_axis(&tp->device->base,
453 LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL,
455 if (tp->scroll.direction & LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL)
456 pointer_notify_axis(&tp->device->base,
458 LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL,
462 tp_post_twofinger_scroll(tp, time);
469 tp_post_clickfinger_buttons(struct tp_dispatch *tp, uint32_t time)
471 uint32_t current, old, button;
472 enum libinput_pointer_button_state state;
474 current = tp->buttons.state;
475 old = tp->buttons.old_state;
480 switch (tp->nfingers_down) {
481 case 1: button = BTN_LEFT; break;
482 case 2: button = BTN_RIGHT; break;
483 case 3: button = BTN_MIDDLE; break;
489 state = LIBINPUT_POINTER_BUTTON_STATE_PRESSED;
491 state = LIBINPUT_POINTER_BUTTON_STATE_RELEASED;
493 pointer_notify_button(&tp->device->base,
501 tp_post_physical_buttons(struct tp_dispatch *tp, uint32_t time)
503 uint32_t current, old, button;
505 current = tp->buttons.state;
506 old = tp->buttons.old_state;
509 while (current || old) {
510 enum libinput_pointer_button_state state;
512 if ((current & 0x1) ^ (old & 0x1)) {
513 if (!!(current & 0x1))
514 state = LIBINPUT_POINTER_BUTTON_STATE_PRESSED;
516 state = LIBINPUT_POINTER_BUTTON_STATE_RELEASED;
518 pointer_notify_button(&tp->device->base,
533 tp_post_button_events(struct tp_dispatch *tp, uint32_t time)
538 (TOUCHPAD_EVENT_BUTTON_PRESS|TOUCHPAD_EVENT_BUTTON_RELEASE)) == 0)
541 if (tp->buttons.has_buttons)
542 rc = tp_post_physical_buttons(tp, time);
544 rc = tp_post_clickfinger_buttons(tp, time);
550 tp_post_events(struct tp_dispatch *tp, uint32_t time)
552 struct tp_touch *t = tp_current_touch(tp);
555 if (tp_post_button_events(tp, time) != 0)
558 if (tp_tap_handle_state(tp, time) != 0)
561 if (tp_post_scroll_events(tp, time) != 0)
564 if (t->history.count >= TOUCHPAD_MIN_SAMPLES &&
565 tp->nfingers_down == 1) {
566 tp_get_delta(t, &dx, &dy);
567 tp_filter_motion(tp, &dx, &dy, time);
569 if (dx != 0 || dy != 0)
570 pointer_notify_motion(
573 li_fixed_from_double(dx),
574 li_fixed_from_double(dy));
579 tp_process(struct evdev_dispatch *dispatch,
580 struct evdev_device *device,
581 struct input_event *e,
584 struct tp_dispatch *tp =
585 (struct tp_dispatch *)dispatch;
590 tp_process_absolute(tp, e, time);
592 tp_process_absolute_st(tp, e, time);
595 tp_process_key(tp, e, time);
598 tp_process_state(tp, time);
599 tp_post_events(tp, time);
600 tp_post_process_state(tp, time);
606 tp_destroy(struct evdev_dispatch *dispatch)
608 struct tp_dispatch *tp =
609 (struct tp_dispatch*)dispatch;
612 tp->filter->interface->destroy(tp->filter);
617 static struct evdev_dispatch_interface tp_interface = {
623 tp_init_slots(struct tp_dispatch *tp,
624 struct evdev_device *device)
626 const struct input_absinfo *absinfo;
628 absinfo = libevdev_get_abs_info(device->evdev, ABS_MT_SLOT);
630 tp->ntouches = absinfo->maximum + 1;
631 tp->slot = absinfo->value;
634 tp->ntouches = 5; /* FIXME: based on DOUBLETAP, etc. */
638 tp->touches = calloc(tp->ntouches,
639 sizeof(struct tp_touch));
645 tp_init_accel(struct tp_dispatch *touchpad, double diagonal)
647 struct motion_filter *accel;
649 touchpad->accel.constant_factor =
650 DEFAULT_CONSTANT_ACCEL_NUMERATOR / diagonal;
651 touchpad->accel.min_factor = DEFAULT_MIN_ACCEL_FACTOR;
652 touchpad->accel.max_factor = DEFAULT_MAX_ACCEL_FACTOR;
654 accel = create_pointer_accelator_filter(tp_accel_profile);
658 touchpad->filter = accel;
664 tp_init_scroll(struct tp_dispatch *tp)
666 tp->scroll.direction = 0;
667 tp->scroll.state = SCROLL_STATE_NONE;
673 tp_init(struct tp_dispatch *tp,
674 struct evdev_device *device)
679 tp->base.interface = &tp_interface;
682 if (tp_init_slots(tp, device) != 0)
685 width = abs(device->abs.max_x - device->abs.min_x);
686 height = abs(device->abs.max_y - device->abs.min_y);
687 diagonal = sqrt(width*width + height*height);
689 tp->hysteresis.margin_x =
690 diagonal / DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR;
691 tp->hysteresis.margin_y =
692 diagonal / DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR;
694 if (libevdev_has_event_code(device->evdev, EV_KEY, BTN_RIGHT) ||
695 libevdev_has_event_code(device->evdev, EV_KEY, BTN_RIGHT))
696 tp->buttons.has_buttons = true;
698 if (tp_init_scroll(tp) != 0)
701 if (tp_init_accel(tp, diagonal) != 0)
704 if (tp_init_tap(tp) != 0)
710 struct evdev_dispatch *
711 evdev_mt_touchpad_create(struct evdev_device *device)
713 struct tp_dispatch *tp;
715 tp = zalloc(sizeof *tp);
719 if (tp_init(tp, device) != 0) {
720 tp_destroy(&tp->base);