1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
#![feature(map_first_last)] #![feature(half_open_range_patterns)] /*! * This library serves as an event interpretation library. * To use, you will need to take the raw events you recieve * on your platform and adapt it to a compatible input * interface. You are expected to call get_pan() once on every frame. * It expects an estimation of the next frametime as well as how * long until the current frame will be rendered. This allows overshoot * calculation to take place. */ extern crate num; use std::f64; use app_dirs::*; #[macro_use] extern crate lazy_static; mod circular_backqueue; mod interpolate; mod ranged_map; use std::ops; use interpolate::Interpolator; type Timestamp = u64; use std::fs::File; use std::io::prelude::*; use std::sync::RwLock; use tini::Ini; const APP_INFO: AppInfo = AppInfo { name: "libscroll", author: "Sawyer Bergeron" }; #[allow(non_snake_case)] pub struct Config { pub EVENT_EXPIRY_COUNT: usize, pub SAMPLE_EXPIRY_COUNT: usize, pub TICKS_TO_COAST: f64, pub TIMESTEP: f64, pub MIN_VELOCITY_TO_IDLE: f64, pub POST_ACCEL_SCALE_VELOCITY: f64, pub PRE_ACCEL_SCALE_VELOCITY: f64, pub SHIFT_WINDOW_MS: f64, pub OVERSCROLL_ELASTICITY_COEFFICIENT: f64, pub CONTENT_MASS_VALUE: f64, pub OVERSCROLL_SPRING_CONSTANT: f64, pub BOUNCE_DAMP_FACTOR: f64, pub MAX_MS_WITHOUT_ZERO_INJECTION: f64, pub MULTIPLY_FIRST_EVENT: f64, pub FLIPS_TO_IDLE: u64, } impl Default for Config { fn default() -> Self { Config { TIMESTEP: 0.1, MIN_VELOCITY_TO_IDLE: 0.002, EVENT_EXPIRY_COUNT: 20, SAMPLE_EXPIRY_COUNT: 20, TICKS_TO_COAST: 1.6, FLIPS_TO_IDLE: 20, POST_ACCEL_SCALE_VELOCITY: 19.0, PRE_ACCEL_SCALE_VELOCITY: 10.0, SHIFT_WINDOW_MS: 0.0, OVERSCROLL_ELASTICITY_COEFFICIENT: 1.0, CONTENT_MASS_VALUE: 6000.0, OVERSCROLL_SPRING_CONSTANT: 0.4, BOUNCE_DAMP_FACTOR: 0.9974, MAX_MS_WITHOUT_ZERO_INJECTION: 150.0, MULTIPLY_FIRST_EVENT: 500.0, } } } //thread_local!(static CONFIG: RefCell<Config> = RefCell::new(Config::default())); lazy_static! { static ref CONFIG: RwLock<Config> = RwLock::new(Config::default()); } //#[macro_use] //extern crate smart_default; // configs //// Determines how much "smoothing" happens, at a direct cost to responsiveness to an action //// A large number means more past events will be counted in the current velocity, //// which avoids skipping over or being "hitched" by anomalies, but also means //// that changes to velocity after the initial touch are responded to slower //const MAX_EVENTS_CONSIDERED: u32 = 5; //// Determines whether the prior config (MAX_EVENTS_CONSIDERED) is used. //// If false, no smoothing occurs and the velocity is simply the most recent event //// Equivalent to setting MAX_EVENTS_CONSIDERED to 1, but allows a performance shortcut //const ENABLE_VELOCITY_SMOOTHING: bool = true; //const FLING_FRICTION_FACTOR: f64 = 0.998; //const PAN_ACCELERATION_FACTOR_TOUCHPAD: f64 = 1.34; //// Used to specify over what window (in number of frames) the ratio of input events to frames //// should be derived. The ratio is then used to interpolate/extrapolate input events const SAMPLE_OVER_X_FRAMES: usize = 10; const DEBUG: bool = false; const VALUE_MULTIPLIER: f64 = 6.0; //// The granularity through which displacement is integrated from the velocity function (sampled //// with velocity_at(f64)) //const INTEGRATION_DX: f64 = 0.07; //// Degree of polynomial used to interpolate velocity //const VELOCITY_POLYNOMIAL_DEGREE: usize = 4; //type Millis = f64; /// Represents a single scrollview and tracks all state related to it. //#[derive(Default)] pub struct Scrollview { content_height: f64, content_width: f64, viewport_height: f64, viewport_width: f64, current_source: Source, dbg_amt_x: f64, dbg_amt_y: f64, //frametime: Millis, //time_to_pageflip: Millis, //current_timestamp: u64, //interpolation_ratio: f64, input_per_frame_log: circular_backqueue::ForgetfulLogQueue<u32>, x: Interpolator, y: Interpolator, } /// Describes a vector in terms of its 2 2d axis magnitudes, /// used often to describe transforms and offsets #[derive(Copy)] #[derive(Clone)] #[derive(Default)] pub struct AxisVector<T> where T: num::Num, T: PartialOrd, T: Copy { pub x: T, pub y: T, x_threshold: T, y_threshold: T, decaying: bool, } impl<T> AxisVector<T> where T: num::Num, T: PartialOrd, T: Copy { /*fn difference(self, other: AxisVector<T>) -> AxisVector<T> { AxisVector { x: self.x - other.x, y: self.y - other.y, ..self } } fn replace(&mut self, axis: Axis, magnitude: T) { match axis { Axis::Horizontal => self.x = magnitude, Axis::Vertical => self.y = magnitude, } } fn get_at(&self, axis: Axis) -> T { match axis { Axis::Horizontal => self.x, Axis::Vertical => self.y } } fn update(&mut self, axis: Axis, magnitude: T) { match axis { Axis::Horizontal => self.x = magnitude + self.x, Axis::Vertical => self.y = magnitude + self.y, } }*/ } impl AxisVector<f64> { pub fn scale(&self, scalar: f64) -> AxisVector<f64> { AxisVector { x: self.x * scalar, y: self.y * scalar, ..self.clone() } } } // TODO: consider naming, doing pythagorean add on + may make more sense, with alternative op to // simply add elems impl<T> ops::Add<AxisVector<T>> for AxisVector<T> where T: num::Num, T: PartialOrd, T: Copy { type Output = AxisVector<T>; fn add(self, rhs: AxisVector<T>) -> AxisVector<T> { AxisVector { x: self.x + rhs.x, y: self.y + rhs.y, ..self } } } impl<T> std::fmt::Display for AxisVector<T> where T: std::fmt::Display, T: num::Num, T: PartialOrd, T: Copy { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "({}, {})", self.x, self.y) } } #[derive(Clone, Copy, Debug)] pub enum Axis { Horizontal, Vertical, } /// Pass along with any events to indicate what kind of device the event came from #[derive(Copy, Clone, Debug)] //#[derive(Clone)] pub enum Source { /// Device type is unknown, assume nothing (very suboptimal to actually use this, should only /// be used when device type can not be feasibly deduced, and even then may not be the best /// choice) Undefined, /// Device is a touchscreen, hint to avoid acceleration, but perform tracking prediction Touchscreen, /// Device is a touchpad, hint to accelerate input, and perform tracking prediction Touchpad, /// Device is a mousewheel that reports deltas of around 15 degrees (coarse) and requires /// smoothing and mid-delta animation Mousewheel, /// Device is a mousewheel that reports deltas of less than 15 degrees (usually much less, /// indicating that very little/no smoothing needs to be applied) PreciseMousewheel, /// Do no manual smoothing or acceleration, assume driver already does this or input method /// would be strange to use with either Passthrough, /// Same as passthrough, but input fling events should trigger a kinetic fling animation KineticPassthrough, /// The device type last used Previous, } impl Source { fn overscrolls(&self) -> bool { let r = match self { Self::Touchscreen => true, Self::Touchpad => true, _ => false, }; //println!("Overscroll returns {}", r); r } fn kinetic(&self) -> bool { match self { Self::Touchpad | Self::Touchscreen | Self::KineticPassthrough => true, _ => false, } } fn accelerates(&self) -> bool { match self { Self::Touchpad => true, _ => false, } } } impl Default for Source { fn default() -> Self { Source::Undefined } } // pub interface impl Scrollview { /// Gives the current best estimate for the position of the content relative to /// the viewport in device pixels pub fn sample(&mut self, timestamp: Timestamp) -> AxisVector<f64> { if !DEBUG { AxisVector { //x: self.x.sample(timestamp as f64) * VALUE_MULTIPLIER, x: 0.0, y: self.y.sample(timestamp as f64), ..Default::default() } } else { AxisVector { x: self.dbg_amt_x, y: self.dbg_amt_y, ..Default::default() } } } /// Create a new scrollview with default settings /// /// Warning: these settings are unlikely to be /// particularly useful, so set_geometry(), set_avg_frametime(), and any /// other relevant initialization functions still need to be used pub fn new() -> Scrollview { eprintln!("Updating config..."); Self::update_config(); Scrollview { input_per_frame_log: circular_backqueue::ForgetfulLogQueue::new(SAMPLE_OVER_X_FRAMES), content_height: 0.0, content_width: 0.0, viewport_height: 0.0, viewport_width: 0.0, current_source: Source::Undefined, dbg_amt_y: 0.0, dbg_amt_x: 0.0, //frametime: 0.0, //time_to_pageflip: 0.0, //current_timestamp: 0, //interpolation_ratio: 0.0, x: Interpolator::new(false, (0.0, 0.0), 0.0), y: Interpolator::new(false, (0.0, 0.0), 0.0), } } /// Deletes/deinitializes the current scrollview /// /// Primarily intended for ffi use, Scrollview implements Drop /// where deinitialization is required, so this is only useful /// for ffi use /// /// NOTE: likely will be removed, not sure why I put this in here to begin with pub fn del(_: Scrollview) {} /// Set the geometry for the given scrollview /// /// Can be used both on scrollview initialization and on scrollview resize pub fn set_geometry( &mut self, content_height: f64, content_width: f64, viewport_height: f64, viewport_width: f64, ) { self.content_height = content_height; self.content_width = content_width; self.viewport_height = viewport_height; self.viewport_width = viewport_width; self.x.set_geometry(0.0, (content_width - viewport_width) as f64); self.y.set_geometry(0.0, (content_height - viewport_height) as f64); } /// True if scrollview should continue to be polled /// even in absence of events (fling or other /// animation in progress) pub fn animating(&self) -> bool { //println!("Animating called to check in"); /*let mut file = File::open("/home/sawyer/ctl1.txt").unwrap(); let mut contents = String::new(); file.read_to_string(&mut contents).unwrap();*/ //println!("contents are {}", contents); //let b: f64 = contents.parse().unwrap(); //println!("interprets {}", b); //return b != 0.0; //return contents.len() > 0; // //self.current_velocity.decay_active() self.x.animating() || self.y.animating() //true } /// Enqueue a pan event for the referenced scrollview pub fn push_pan(&mut self, axis: Axis, amount: f64, timestamp: Option<u64>) { //println!("push_pan with {:?}, {}, {}", axis, amount, timestamp.unwrap()); if !DEBUG { match axis { Axis::Horizontal => self.x.signal_pan(timestamp.unwrap() as f64, amount), Axis::Vertical => self.y.signal_pan(timestamp.unwrap() as f64, amount), } } else { match axis { Axis::Horizontal => self.dbg_amt_x += amount, Axis::Vertical => self.dbg_amt_y += amount, } } } /// Enqueue a fling (finger lift at any velocity) for the referenced scrollview pub fn push_fling(&mut self, timestamp: Option<u64>) { eprintln!("Updating config..."); Self::update_config(); println!("push_fling with {}", timestamp.unwrap()); //self.current_velocity.decay_start(); self.x.signal_fling(timestamp.unwrap() as f64); self.y.signal_fling(timestamp.unwrap() as f64); } /// Enqueue a scroll interrupt (finger down at any time, gesture start) for the referenced /// scrollview pub fn push_interrupt(&mut self, timestamp: Option<u64>) { //self.pan_log_x.clear(); //self.pan_log_y.clear(); //self.current_velocity = AxisVector { x: 0.0, y: 0.0, ..self.current_velocity }; self.x.signal_interrupt(timestamp.unwrap() as f64); self.y.signal_interrupt(timestamp.unwrap() as f64); } /// Set what device type is going to be providing any events that follow until the next source /// is declared pub fn set_source(&mut self, source: Source) { self.current_source = source; self.x.set_source(source); self.y.set_source(source); } fn update_config() { let mut config_struct = CONFIG.write().expect("Couldn't lock config struct"); let mut config_dir: std::path::PathBuf = app_root(AppDataType::UserConfig, &APP_INFO).unwrap(); // TODO: gracefully handle let config_file = std::path::PathBuf::from("config.ini"); config_dir.push(config_file); let _ = Ini::from_file(&config_dir).map(|config| { println!("Found config file, applying..."); config.get("config", "event_expiry_count").map(|v: usize| { config_struct.EVENT_EXPIRY_COUNT = v}); config.get("config", "sample_expiry_count").map(|v: usize| { config_struct.SAMPLE_EXPIRY_COUNT = v}); config.get("config", "ticks_to_coast").map(|v: f64| { config_struct.TICKS_TO_COAST = v}); config.get("config", "timestep").map(|v: f64| { config_struct.TIMESTEP = v}); config.get("config", "min_velocity_to_idle").map(|v: f64| { config_struct.MIN_VELOCITY_TO_IDLE = v}); config.get("config", "post_acceleration_scale_velocity").map(|v: f64| { config_struct.POST_ACCEL_SCALE_VELOCITY = v}); config.get("config", "pre_acceleration_scale_velocity").map(|v: f64| { config_struct.PRE_ACCEL_SCALE_VELOCITY = v}); config.get("config", "shift_window_ms").map(|v: f64| { config_struct.SHIFT_WINDOW_MS = v}); config.get("config", "overscroll_elasticity_coefficient").map(|v: f64| { config_struct.OVERSCROLL_ELASTICITY_COEFFICIENT = v}); config.get("config", "content_mass_value").map(|v: f64| { config_struct.CONTENT_MASS_VALUE = v}); config.get("config", "overscroll_spring_constant").map(|v: f64| { config_struct.OVERSCROLL_SPRING_CONSTANT = v}); config.get("config", "bounce_damping_factor").map(|v: f64| { config_struct.BOUNCE_DAMP_FACTOR = v}); config.get("config", "zero_delta_injection_wait_ms").map(|v: f64| { config_struct.MAX_MS_WITHOUT_ZERO_INJECTION = v}); config.get("config", "first_event_multiplier").map(|v: f64| { config_struct.MULTIPLY_FIRST_EVENT = v}); config.get("config", "flips_until_idle").map(|v: u64| { config_struct.FLIPS_TO_IDLE = v}); }).map_err(|_| { println!("Couldn't find config file"); // maybe add message if can't be found? }); } }