touchpad: Filter motion in a certain number of tap states
[platform/upstream/libinput.git] / src / evdev-mt-touchpad.h
1 /*
2  * Copyright © 2014 Red Hat, Inc.
3  *
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.
13  *
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.
21  */
22
23
24 #ifndef EVDEV_MT_TOUCHPAD_H
25 #define EVDEV_MT_TOUCHPAD_H
26
27 #include <stdbool.h>
28
29 #include "evdev.h"
30 #include "filter.h"
31
32 #define TOUCHPAD_HISTORY_LENGTH 4
33 #define TOUCHPAD_MIN_SAMPLES 4
34
35 enum touchpad_event {
36         TOUCHPAD_EVENT_NONE             = 0,
37         TOUCHPAD_EVENT_MOTION           = (1 << 0),
38         TOUCHPAD_EVENT_BUTTON_PRESS     = (1 << 1),
39         TOUCHPAD_EVENT_BUTTON_RELEASE   = (1 << 2),
40 };
41
42 enum touch_state {
43         TOUCH_NONE = 0,
44         TOUCH_BEGIN,
45         TOUCH_UPDATE,
46         TOUCH_END
47 };
48
49 enum tp_tap_state {
50         TAP_STATE_IDLE = 4,
51         TAP_STATE_TOUCH,
52         TAP_STATE_HOLD,
53         TAP_STATE_TAPPED,
54         TAP_STATE_TOUCH_2,
55         TAP_STATE_TOUCH_2_HOLD,
56         TAP_STATE_TOUCH_3,
57         TAP_STATE_TOUCH_3_HOLD,
58         TAP_STATE_DRAGGING_OR_DOUBLETAP,
59         TAP_STATE_DRAGGING,
60         TAP_STATE_DRAGGING_WAIT,
61         TAP_STATE_DRAGGING_2,
62         TAP_STATE_DEAD, /**< finger count exceeded */
63 };
64
65 struct tp_motion {
66         int32_t x;
67         int32_t y;
68 };
69
70 struct tp_touch {
71         enum touch_state state;
72         bool dirty;
73         int32_t x;
74         int32_t y;
75         uint32_t millis;
76
77         struct {
78                 struct tp_motion samples[TOUCHPAD_HISTORY_LENGTH];
79                 unsigned int index;
80                 unsigned int count;
81         } history;
82
83         struct {
84                 int32_t center_x;
85                 int32_t center_y;
86         } hysteresis;
87 };
88
89 struct tp_dispatch {
90         struct evdev_dispatch base;
91         struct evdev_device *device;
92         unsigned int nfingers_down;             /* number of fingers down */
93         unsigned int slot;                      /* current slot */
94
95         unsigned int ntouches;                  /* number of slots */
96         struct tp_touch *touches;               /* len == ntouches */
97
98         struct {
99                 int32_t margin_x;
100                 int32_t margin_y;
101         } hysteresis;
102
103         struct motion_filter *filter;
104
105         struct {
106                 double constant_factor;
107                 double min_factor;
108                 double max_factor;
109         } accel;
110
111         struct {
112                 uint32_t state;
113                 uint32_t old_state;
114         } buttons;                              /* physical buttons */
115
116         enum touchpad_event queued;
117
118         struct {
119                 bool enabled;
120                 int timer_fd;
121                 struct libinput_source *source;
122                 unsigned int timeout;
123                 enum tp_tap_state state;
124         } tap;
125 };
126
127 #define tp_for_each_touch(_tp, _t) \
128         for (unsigned int _i = 0; _i < (_tp)->ntouches && (_t = &(_tp)->touches[_i]); _i++)
129
130 void
131 tp_get_delta(struct tp_touch *t, double *dx, double *dy);
132
133 int
134 tp_tap_handle_state(struct tp_dispatch *tp, uint32_t time);
135
136 unsigned int
137 tp_tap_handle_timeout(struct tp_dispatch *tp, uint32_t time);
138
139 int
140 tp_init_tap(struct tp_dispatch *tp);
141
142 #endif