filter: Ignore non-suitable trackers when calculating initial velocity
[platform/upstream/libinput.git] / src / filter.h
1 /*
2  * Copyright © 2012 Jonas Ådahl
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 #ifndef FILTER_H
24 #define FILTER_H
25
26 #include "config.h"
27
28 struct motion_params {
29         double dx, dy;
30 };
31
32 struct motion_filter;
33
34 void
35 filter_dispatch(struct motion_filter *filter,
36                 struct motion_params *motion,
37                 void *data, uint64_t time);
38
39
40 struct motion_filter_interface {
41         void (*filter)(struct motion_filter *filter,
42                        struct motion_params *motion,
43                        void *data, uint64_t time);
44         void (*destroy)(struct motion_filter *filter);
45 };
46
47 struct motion_filter {
48         struct motion_filter_interface *interface;
49 };
50
51 struct motion_filter *
52 create_linear_acceleration_filter(double speed);
53
54 typedef double (*accel_profile_func_t)(struct motion_filter *filter,
55                                        void *data,
56                                        double velocity,
57                                        uint64_t time);
58
59 struct motion_filter *
60 create_pointer_accelator_filter(accel_profile_func_t filter);
61
62 void
63 motion_filter_destroy(struct motion_filter *filter);
64
65 /*
66  * Pointer acceleration profiles.
67  */
68
69 /*
70  * Profile similar which is similar to nonaccelerated but with a smooth
71  * transition between accelerated and non-accelerated.
72  */
73 double
74 pointer_accel_profile_smooth_simple(struct motion_filter *filter,
75                                     void *data,
76                                     double velocity,
77                                     uint64_t time);
78
79 #endif /* FILTER_H */