03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Copyright © 2006-2011 Simon Thum simon dot thum at gmx dot de
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Permission is hereby granted, free of charge, to any person obtaining a
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * copy of this software and associated documentation files (the "Software"),
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * to deal in the Software without restriction, including without limitation
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * the rights to use, copy, modify, merge, publish, distribute, sublicense,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * and/or sell copies of the Software, and to permit persons to whom the
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Software is furnished to do so, subject to the following conditions:
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * The above copyright notice and this permission notice (including the next
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * paragraph) shall be included in all copies or substantial portions of the
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Software.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * DEALINGS IN THE SOFTWARE.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#ifndef POINTERVELOCITY_H
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define POINTERVELOCITY_H
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include <input.h>
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/* constants for acceleration profiles */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileNone -1
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileClassic 0
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileDeviceSpecific 1
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfilePolynomial 2
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileSmoothLinear 3
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileSimple 4
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfilePower 5
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileLinear 6
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileSmoothLimited 7
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define AccelProfileLAST AccelProfileSmoothLimited
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/* fwd */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstruct _DeviceVelocityRec;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/**
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * profile
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * returns actual acceleration depending on velocity, acceleration control,...
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef double (*PointerAccelerationProfileFunc)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync (DeviceIntPtr dev, struct _DeviceVelocityRec * vel,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double velocity, double threshold, double accelCoeff);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/**
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * a motion history, with just enough information to
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * calc mean velocity and decide which motion was along
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * a more or less straight line
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _MotionTracker {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double dx, dy; /* accumulated delta for each axis */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int time; /* time of creation */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int dir; /* initial direction bitfield */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} MotionTracker, *MotionTrackerPtr;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/**
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Contains all data needed to implement mouse ballistics
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _DeviceVelocityRec {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync MotionTrackerPtr tracker;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int num_tracker;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int cur_tracker; /* current index */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double velocity; /* velocity as guessed by algorithm */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double last_velocity; /* previous velocity estimate */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double last_dx; /* last time-difference */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double last_dy; /* phase of last/current estimate */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double corr_mul; /* config: multiply this into velocity */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double const_acceleration; /* config: (recipr.) const deceleration */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double min_acceleration; /* config: minimum acceleration */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync short reset_time; /* config: reset non-visible state after # ms */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync short use_softening; /* config: use softening of mouse values */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double max_rel_diff; /* config: max. relative difference */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double max_diff; /* config: max. difference */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int initial_range; /* config: max. offset used as initial velocity */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync Bool average_accel; /* config: average acceleration over velocity */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PointerAccelerationProfileFunc Profile;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PointerAccelerationProfileFunc deviceSpecificProfile;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync void *profile_private; /* extended data, see SetAccelerationProfile() */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync struct { /* to be able to query this information */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int profile_number;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync } statistics;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} DeviceVelocityRec, *DeviceVelocityPtr;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/**
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * contains the run-time data for the predictable scheme, that is, a
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * DeviceVelocityPtr and the property handlers.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _PredictableAccelSchemeRec {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DeviceVelocityPtr vel;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync long *prop_handlers;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int num_prop_handlers;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} PredictableAccelSchemeRec, *PredictableAccelSchemePtr;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncInitVelocityData(DeviceVelocityPtr vel);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncInitTrackers(DeviceVelocityPtr vel, int ntracker);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT BOOL
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncProcessVelocityData2D(DeviceVelocityPtr vel, double dx, double dy, int time);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT double
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncBasicComputeAcceleration(DeviceIntPtr dev, DeviceVelocityPtr vel,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync double velocity, double threshold, double acc);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncFreeVelocityData(DeviceVelocityPtr vel);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT int
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncSetAccelerationProfile(DeviceVelocityPtr vel, int profile_num);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT DeviceVelocityPtr
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncGetDevicePredictableAccelData(DeviceIntPtr dev);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncSetDeviceSpecificAccelerationProfile(DeviceVelocityPtr vel,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PointerAccelerationProfileFunc profile);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_INTERNAL void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncAccelerationDefaultCleanup(DeviceIntPtr dev);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_INTERNAL Bool
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncInitPredictableAccelerationScheme(DeviceIntPtr dev,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync struct _ValuatorAccelerationRec *protoScheme);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_INTERNAL void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncacceleratePointerPredictable(DeviceIntPtr dev, ValuatorMask *val,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync CARD32 evtime);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_INTERNAL void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncacceleratePointerLightweight(DeviceIntPtr dev, ValuatorMask *val,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync CARD32 evtime);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#endif /* POINTERVELOCITY_H */