├── loader
├── .gitignore
├── src
│ └── main.rs
└── Cargo.toml
├── mouseplay
├── .gitignore
├── src
│ ├── controller
│ │ ├── mod.rs
│ │ └── ds4.rs
│ ├── input
│ │ ├── mod.rs
│ │ └── raw_input.rs
│ ├── lib.rs
│ ├── console.rs
│ ├── mapper.rs
│ └── hooks.rs
└── Cargo.toml
├── .cargo
└── config
├── .gitignore
├── mouseplay.logo.png
├── Cargo.toml
├── mappings
└── overwatch.json
├── README.md
└── LICENSE
/loader/.gitignore:
--------------------------------------------------------------------------------
1 | /target
2 |
--------------------------------------------------------------------------------
/mouseplay/.gitignore:
--------------------------------------------------------------------------------
1 | /target
2 | Cargo.lock
3 |
--------------------------------------------------------------------------------
/mouseplay/src/controller/mod.rs:
--------------------------------------------------------------------------------
1 | pub mod ds4;
2 |
--------------------------------------------------------------------------------
/mouseplay/src/input/mod.rs:
--------------------------------------------------------------------------------
1 | pub mod raw_input;
2 |
--------------------------------------------------------------------------------
/.cargo/config:
--------------------------------------------------------------------------------
1 | [build]
2 | target = "stable-i686-pc-windows-msvc"
3 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /target
2 | **/*.rs.bk
3 | *.swp
4 | .vscode
5 | Cargo.lock
--------------------------------------------------------------------------------
/loader/src/main.rs:
--------------------------------------------------------------------------------
1 | fn main() {
2 | println!("Hello, world!");
3 | }
4 |
--------------------------------------------------------------------------------
/mouseplay.logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ko1N/mouseplay/HEAD/mouseplay.logo.png
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [workspace]
2 | members = [
3 | "loader",
4 | "mouseplay",
5 | ]
6 | default-members = [
7 | "loader",
8 | "mouseplay",
9 | ]
10 |
--------------------------------------------------------------------------------
/loader/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "loader"
3 | version = "0.1.0"
4 | authors = ["John Smith"]
5 | edition = "2018"
6 |
7 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
8 |
9 | [dependencies]
10 |
--------------------------------------------------------------------------------
/mouseplay/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "mouseplay"
3 | version = "0.1.0"
4 | authors = ["John Smith"]
5 | edition = "2018"
6 |
7 | [lib]
8 | crate-type = ["cdylib"]
9 |
10 | [dependencies]
11 | winapi = { version = "0.3.9", features = ["windef", "winuser", "winbase", "winnt", "windowsx", "consoleapi", "wincon", "processenv", "libloaderapi", "memoryapi", "libloaderapi", "impl-default"] }
12 | log = "0.4.8"
13 | simple_logger = "1.0"
14 | libc = "0.2"
15 | paste = "0.1"
16 | lazy_static = "1.4"
17 | serde = { version = "1.0", features = ["derive"] }
18 | serde_json = "1.0"
19 |
--------------------------------------------------------------------------------
/mouseplay/src/lib.rs:
--------------------------------------------------------------------------------
1 | mod console;
2 | mod controller;
3 | mod hooks;
4 | mod input;
5 | mod mapper;
6 |
7 | use winapi::um::winnt::{DLL_PROCESS_ATTACH, DLL_PROCESS_DETACH};
8 |
9 | #[no_mangle]
10 | extern "system" fn DllMain(_hinst: *const u8, reason: u32, _reserved: *const u8) -> u32 {
11 | match reason {
12 | DLL_PROCESS_ATTACH => {
13 | std::thread::spawn(|| {
14 | console::init();
15 | hooks::setup();
16 | mapper::load("mappings.json").unwrap();
17 | });
18 | }
19 | DLL_PROCESS_DETACH => {
20 | // ...
21 | }
22 | _ => {}
23 | }
24 | 1
25 | }
26 |
--------------------------------------------------------------------------------
/mappings/overwatch.json:
--------------------------------------------------------------------------------
1 | [
2 | { "type": "Button", "input": "f1", "output": "share" },
3 | { "type": "Button", "input": "f2", "output": "options" },
4 | { "type": "Button", "input": "f3", "output": "ps" },
5 |
6 | { "type": "Axis", "input": "w", "output": "ly", "value": -1 },
7 | { "type": "Axis", "input": "a", "output": "lx", "value": -1 },
8 | { "type": "Axis", "input": "s", "output": "ly", "value": 1 },
9 | { "type": "Axis", "input": "d", "output": "lx", "value": 1 },
10 |
11 | { "type": "Button", "input": "mouse1", "output": "r2" },
12 | { "type": "Axis", "input": "mouse1", "output": "r2", "value": 1 },
13 | { "type": "Button", "input": "mouse2", "output": "l2" },
14 | { "type": "Axis", "input": "mouse2", "output": "l2", "value": 1 },
15 |
16 | { "type": "Button", "input": "space", "output": "cross" },
17 | { "type": "Button", "input": "ctrl", "output": "circle" },
18 |
19 | { "type": "Button", "input": "q", "output": "triangle" },
20 | { "type": "Button", "input": "r", "output": "square" },
21 | { "type": "Button", "input": "shift", "output": "l1" },
22 | { "type": "Button", "input": "e", "output": "r1" },
23 |
24 | { "type": "Button", "input": "f", "output": "l3" },
25 | { "type": "Button", "input": "v", "output": "r3" },
26 |
27 | { "type": "Button", "input": "tab", "output": "touch" },
28 | { "type": "Button", "input": "escape", "output": "options" },
29 |
30 | {
31 | "type": "Mouse",
32 |
33 | "output_x": "rx",
34 | "multiplier_x": 0.3,
35 | "dead_zone_x": 13,
36 |
37 | "output_y": "ry",
38 | "multiplier_y": 0.3,
39 | "dead_zone_y": 13,
40 |
41 | "sensitivity": 3,
42 | "exponent": 1,
43 |
44 | "shape": "circle"
45 | }
46 | ]
47 |
--------------------------------------------------------------------------------
/mouseplay/src/console.rs:
--------------------------------------------------------------------------------
1 | use std::ffi::CString;
2 | use std::fs::OpenOptions;
3 | use std::os::windows::io::AsRawHandle;
4 |
5 | use log::{info, Level};
6 |
7 | use winapi::um::consoleapi::AllocConsole;
8 | use winapi::um::processenv::SetStdHandle;
9 | use winapi::um::winbase::{STD_ERROR_HANDLE, STD_OUTPUT_HANDLE};
10 | use winapi::um::wincon::SetConsoleTitleA;
11 |
12 | pub fn init() {
13 | if unsafe { AllocConsole() } != 0 {
14 | // console title
15 | let console_title = CString::new("mouseplay").unwrap();
16 | unsafe { SetConsoleTitleA(console_title.as_ptr()) };
17 |
18 | // output redirection
19 | let file = OpenOptions::new()
20 | .write(true)
21 | .read(true)
22 | .open("CONOUT$")
23 | .unwrap();
24 | unsafe {
25 | SetStdHandle(
26 | STD_OUTPUT_HANDLE,
27 | file.as_raw_handle() as *mut winapi::ctypes::c_void,
28 | );
29 | SetStdHandle(
30 | STD_ERROR_HANDLE,
31 | file.as_raw_handle() as *mut winapi::ctypes::c_void,
32 | );
33 | }
34 | std::mem::forget(file);
35 |
36 | // setup logging
37 | simple_logger::SimpleLogger::new()
38 | .with_level(Level::Debug.to_level_filter())
39 | .init()
40 | .unwrap();
41 |
42 | // print header
43 | println!(
44 | " __
45 | ____ ___ ____ __ __________ ____ / /___ ___ __
46 | / __ `__ \\/ __ \\/ / / / ___/ _ \\/ __ \\/ / __ `/ / / /
47 | / / / / / / /_/ / /_/ (__ ) __/ /_/ / / /_/ / /_/ /
48 | /_/ /_/ /_/\\____/\\__,_/____/\\___/ .___/_/\\__,_/\\__, /
49 | /_/ /____/"
50 | );
51 | println!("");
52 | info!("console initialized");
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
5 | # mouseplay
6 | [](LICENSE)
7 | [](https://discord.gg/afsEtMR)
8 |
9 | mouseplay enables you to use a regular mouse & keyboard with the PS Remote Play Tool. The mouse and keyboard buttons are being translated to controller inputs.
10 |
11 | ## This project is still work-in-progress and does not yet have a release version.
12 |
13 | ### Mapping files
14 |
15 | Mapping files are simple plain JSon files. You can find example mappings in the `mappings` subfolder.
16 |
17 | ### Building it yourself
18 | Make sure to install rust (preferably via https://rustup.rs) and the Microsoft Compiler (via Visual Studio).
19 |
20 | It is important to compile the project for a 32bit target (as PS Remote Play in itself is also just a 32bit program). To do this with rustup just run:
21 | ```
22 | rustup target add i686-pc-windows-msvc
23 | ```
24 |
25 | To compile the project you can just run
26 | ```
27 | cargo build --target=i686-pc-windows-msvc --release
28 | ```
29 | or execute the provided `build.bat` file.
30 |
31 | ### Known limitations
32 |
33 | - Controller spoofing is not yet implemented so you have to connect a PlayStation controller to the PC.
34 | - Mouse cursor and toolbar is not hidden when mouse lock is active
35 | - Not all cases of window transitions (windows opening and closing) are handled well yet
36 |
37 | ### Demo
38 |
39 | [](http://www.youtube.com/watch?v=0QhSsvRO_Y8 "mouseplay demo")
40 |
41 | ## License
42 |
43 | Licensed under GPL-3.0 License, see [LICENSE](LICENSE).
44 |
45 | ### Contribution
46 |
47 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.
48 |
--------------------------------------------------------------------------------
/mouseplay/src/controller/ds4.rs:
--------------------------------------------------------------------------------
1 | macro_rules! input_axis {
2 | ($name:ident, $byte:expr) => {
3 | paste::item! {
4 | pub fn [](&self) -> u8 {
5 | self.buffer[$byte]
6 | }
7 |
8 | pub fn [](&mut self, value: u8) {
9 | self.buffer[$byte] = value;
10 | }
11 | }
12 | };
13 | }
14 |
15 | macro_rules! input_button {
16 | ($name:ident, $byte:expr, $bit:expr) => {
17 | paste::item! {
18 | pub fn [](&self) -> bool {
19 | (self.buffer[$byte] & $bit) != 0
20 | }
21 |
22 | pub fn [](&mut self, down: bool) {
23 | if down {
24 | self.buffer[$byte] |= $bit;
25 | } else {
26 | self.buffer[$byte] &= !$bit;
27 | }
28 | }
29 | }
30 | };
31 | }
32 |
33 | const TRIANGLE: u8 = 1 << 7;
34 | const CIRCLE: u8 = 1 << 6;
35 | const CROSS: u8 = 1 << 5;
36 | const SQUARE: u8 = 1 << 4;
37 |
38 | const L1: u8 = 1 << 0;
39 | const R1: u8 = 1 << 1;
40 |
41 | const L2: u8 = 1 << 2;
42 | const R2: u8 = 1 << 3;
43 |
44 | const L3: u8 = 1 << 6;
45 | const R3: u8 = 1 << 7;
46 |
47 | const SHARE: u8 = 1 << 4;
48 | const OPTIONS: u8 = 1 << 5;
49 | const PSBUTTON: u8 = 1 << 0;
50 | const TOUCHBUTTON: u8 = 1 << 2 - 1;
51 |
52 | pub struct DS4 {
53 | buffer: Vec,
54 | }
55 |
56 | #[allow(unused)]
57 | impl DS4 {
58 | pub fn new(buffer: &[u8]) -> Result {
59 | // report _should_ be 64 bytes long
60 | if buffer.len() == 64 {
61 | Ok(Self {
62 | buffer: buffer.to_vec(),
63 | })
64 | } else {
65 | Err("not a hid response")
66 | }
67 | }
68 |
69 | pub fn to_raw(&self) -> Vec {
70 | self.buffer.clone()
71 | }
72 |
73 | input_axis!(lx, 1);
74 | input_axis!(ly, 2);
75 | input_axis!(rx, 3);
76 | input_axis!(ry, 4);
77 |
78 | input_button!(triangle, 5, TRIANGLE);
79 | input_button!(circle, 5, CIRCLE);
80 | input_button!(cross, 5, CROSS);
81 | input_button!(square, 5, SQUARE);
82 |
83 | // dpad is in hat format, 0x8 is released state
84 |
85 | input_button!(l1, 6, L1);
86 | input_button!(r1, 6, R1);
87 |
88 | input_axis!(l2, 8);
89 | input_axis!(r2, 9);
90 | input_button!(l2, 6, L2);
91 | input_button!(r2, 6, R2);
92 |
93 | input_button!(l3, 6, L3);
94 | input_button!(r3, 6, R3);
95 |
96 | input_button!(share, 6, SHARE);
97 | input_button!(options, 6, OPTIONS);
98 | input_button!(ps, 7, PSBUTTON);
99 | input_button!(touch, 7, TOUCHBUTTON);
100 |
101 | pub fn set_btn(&mut self, button: &str, down: bool) {
102 | match button {
103 | "triangle" => self.set_btn_triangle(down),
104 | "circle" => self.set_btn_circle(down),
105 | "cross" => self.set_btn_cross(down),
106 | "square" => self.set_btn_square(down),
107 |
108 | "l1" => self.set_btn_l1(down),
109 | "r1" => self.set_btn_r1(down),
110 |
111 | "l2" => self.set_btn_l2(down),
112 | "r2" => self.set_btn_r2(down),
113 |
114 | "l3" => self.set_btn_l3(down),
115 | "r3" => self.set_btn_r3(down),
116 |
117 | "share" => self.set_btn_share(down),
118 | "options" => self.set_btn_options(down),
119 | "ps" => self.set_btn_ps(down),
120 | "touch" => self.set_btn_touch(down),
121 |
122 | _ => (),
123 | }
124 | }
125 |
126 | pub fn set_axis(&mut self, axis: &str, value: u8) {
127 | match axis {
128 | "lx" => self.set_axis_lx(value),
129 | "ly" => self.set_axis_ly(value),
130 | "rx" => self.set_axis_rx(value),
131 | "ry" => self.set_axis_ry(value),
132 |
133 | "l2" => self.set_axis_l2(value),
134 | "r2" => self.set_axis_r2(value),
135 |
136 | _ => (),
137 | }
138 | }
139 |
140 | pub fn frame_count(&self) -> u8 {
141 | self.buffer[7] >> 2
142 | }
143 |
144 | pub fn battery(&self) -> u8 {
145 | (self.buffer[30] & 0xF) * 10
146 | }
147 |
148 | pub fn is_charging(&self) -> bool {
149 | (self.buffer[30] & 0x10) != 0
150 | }
151 | }
152 |
--------------------------------------------------------------------------------
/mouseplay/src/mapper.rs:
--------------------------------------------------------------------------------
1 | use std::ffi::CStr;
2 | use std::path::{Path, PathBuf};
3 | use std::sync::RwLock;
4 |
5 | use log::info;
6 |
7 | use lazy_static::lazy_static;
8 | use serde::{Deserialize, Serialize};
9 | use winapi::{
10 | shared::minwindef::MAX_PATH,
11 | um::{libloaderapi::GetModuleFileNameA, winnt::IMAGE_DOS_HEADER},
12 | };
13 |
14 | use crate::{controller::ds4::DS4, input::raw_input::RawInput};
15 |
16 | extern "C" {
17 | pub static __ImageBase: u8;
18 | }
19 |
20 | lazy_static! {
21 | // thread safe storage for the global Mapper
22 | pub static ref MAPPER: RwLock> = RwLock::new(None);
23 | }
24 |
25 | pub fn load(file_name: &str) -> Result<(), &'static str> {
26 | let library_dir = get_library_dir()?;
27 | let mut lock = MAPPER.write().map_err(|_| "unable to lock mapper")?;
28 | *lock = Some(Mapper::load(library_dir.join(file_name))?);
29 | Ok(())
30 | }
31 |
32 | fn get_library_dir() -> Result {
33 | let mut buffer = vec![0u8; MAX_PATH];
34 | unsafe {
35 | GetModuleFileNameA(
36 | &__ImageBase as *const _ as _,
37 | buffer.as_mut_ptr() as _,
38 | MAX_PATH as u32,
39 | )
40 | };
41 | if let Some((n, _)) = buffer.iter().enumerate().find(|(_, c)| **c == 0_u8) {
42 | buffer.truncate(n);
43 | }
44 | let file_name = PathBuf::from(String::from_utf8_lossy(&buffer).to_string());
45 | let file_path = file_name
46 | .parent()
47 | .ok_or("unable to get library parent directory")?;
48 | info!("library dir: {:?}", file_path);
49 | Ok(file_path.to_path_buf())
50 | }
51 |
52 | #[derive(Debug, Serialize, Deserialize)]
53 | pub struct ButtonMapping {
54 | input: String,
55 | output: String,
56 | }
57 |
58 | impl ButtonMapping {
59 | fn map_controller(&mut self, raw_input: &RawInput, ds4: &mut DS4) {
60 | let down = raw_input.key(&self.input);
61 | if down {
62 | ds4.set_btn(&self.output, down);
63 | }
64 | }
65 | }
66 |
67 | #[derive(Debug, Serialize, Deserialize)]
68 | pub struct AxisMapping {
69 | input: String,
70 | output: String,
71 | value: f32,
72 | }
73 |
74 | impl AxisMapping {
75 | fn map_controller(&mut self, raw_input: &RawInput, ds4: &mut DS4) {
76 | let down = raw_input.key(&self.input);
77 | if down {
78 | let value = (0.5f32 + (self.value.max(-1f32).min(1f32) / 2f32)) * 255f32;
79 | //trace!("axis={}, value={}", self.output, value);
80 | ds4.set_axis(&self.output, value as u8);
81 | }
82 | }
83 | }
84 |
85 | const FREQUENCY_SCALE: f64 = 2.8125;
86 |
87 | #[derive(Debug, Serialize, Deserialize)]
88 | pub struct MouseMapping {
89 | output_x: String,
90 | output_y: String,
91 | multiplier_x: f64,
92 | multiplier_y: f64,
93 | dead_zone_x: i32,
94 | dead_zone_y: i32,
95 |
96 | sensitivity: f64,
97 | exponent: f64,
98 | shape: String,
99 |
100 | // internal state
101 | #[serde(skip)]
102 | remainder: [i32; 2],
103 | #[serde(skip)]
104 | residue: [f64; 2],
105 | #[serde(skip)]
106 | axis_hist: [Vec; 2],
107 | }
108 |
109 | impl MouseMapping {
110 | fn map_controller(&mut self, raw_input: &RawInput, ds4: &mut DS4) {
111 | // this is roughly a copy of the implementation of gimx
112 | let mut mouse = [
113 | raw_input.mouse_x() as f64 * self.sensitivity,
114 | raw_input.mouse_y() as f64 * self.sensitivity,
115 | ];
116 |
117 | if mouse[0] != 0f64 || mouse[1] != 0f64 {
118 | mouse[0] += self.remainder[0] as f64;
119 | mouse[1] += self.remainder[1] as f64;
120 | } else {
121 | self.residue[0] = 0f64;
122 | self.residue[1] = 0f64;
123 | return;
124 | }
125 |
126 | let mut axis = [0i32; 2];
127 |
128 | let max_axis = 128;
129 | let min_axis = -128;
130 |
131 | let axis_scale = 1f64;
132 |
133 | let multiplier = [
134 | self.multiplier_x * axis_scale,
135 | self.multiplier_y * axis_scale,
136 | ];
137 |
138 | let exponent = self.exponent;
139 |
140 | let mut dead_zone = [
141 | f64::copysign(
142 | self.dead_zone_x as f64 * axis_scale,
143 | self.multiplier_x * mouse[0],
144 | ),
145 | f64::copysign(
146 | self.dead_zone_y as f64 * axis_scale,
147 | self.multiplier_y * mouse[1],
148 | ),
149 | ];
150 |
151 | let hypotenuse = f64::hypot(mouse[0], mouse[1]);
152 | let angle_cos = mouse[0].abs() / hypotenuse;
153 | let angle_sin = mouse[1].abs() / hypotenuse;
154 |
155 | if mouse[0] != 0f64 && mouse[1] != 0f64 && self.shape == "circle" {
156 | dead_zone[0] *= angle_cos;
157 | dead_zone[1] *= angle_sin;
158 | }
159 |
160 | let norm = hypotenuse * FREQUENCY_SCALE;
161 |
162 | let z = norm.powf(exponent);
163 |
164 | let z_x = multiplier[0] * f64::copysign(z * angle_cos, mouse[0]);
165 | let z_y = multiplier[0] * f64::copysign(z * angle_sin, mouse[1]);
166 |
167 | let raw_output = [
168 | Self::update_axis(&mut axis[0], dead_zone[0], z_x, max_axis, min_axis),
169 | Self::update_axis(&mut axis[1], dead_zone[1], z_y, max_axis, min_axis),
170 | ];
171 |
172 | self.remainder[0] = Self::update_controller_axis(
173 | ds4,
174 | &self.output_x,
175 | &mut axis[0],
176 | &mut self.axis_hist[0],
177 | min_axis,
178 | );
179 | self.remainder[1] = Self::update_controller_axis(
180 | ds4,
181 | &self.output_y,
182 | &mut axis[1],
183 | &mut self.axis_hist[1],
184 | min_axis,
185 | );
186 |
187 | self.update_residue(mouse, axis, axis_scale, multiplier, raw_output);
188 | }
189 |
190 | fn update_axis(axis: &mut i32, dead_zone: f64, z: f64, max_axis: i32, min_axis: i32) -> f64 {
191 | let mut raw = z;
192 |
193 | if z.abs() >= 1f64 {
194 | raw = z + dead_zone;
195 | }
196 |
197 | *axis = raw as i32;
198 |
199 | if *axis < min_axis || *axis > max_axis {
200 | raw = *axis as f64;
201 | }
202 |
203 | raw
204 | }
205 |
206 | fn update_controller_axis(
207 | ds4: &mut DS4,
208 | output: &str,
209 | axis: &mut i32,
210 | axis_hist: &mut Vec,
211 | min_axis: i32,
212 | ) -> i32 {
213 | let mut remainder = 0;
214 |
215 | *axis -= min_axis;
216 | if *axis > 255 {
217 | remainder = *axis - 255;
218 | *axis = 255;
219 | } else if *axis < 0 {
220 | remainder = *axis;
221 | *axis = 0;
222 | }
223 |
224 | // update controller state
225 | let _axis = *axis;
226 | ds4.set_axis(output, _axis as u8);
227 |
228 | axis_hist.push(_axis);
229 | if axis_hist.len() > 256 {
230 | axis_hist.remove(0);
231 | }
232 |
233 | return remainder;
234 | }
235 |
236 | fn update_residue(
237 | &mut self,
238 | mouse: [f64; 2],
239 | axis: [i32; 2],
240 | axis_scale: f64,
241 | multiplier: [f64; 2],
242 | output_raw: [f64; 2],
243 | ) {
244 | let mut input_trunk = [0f64; 2];
245 |
246 | if axis[0] != 0 || axis[1] != 0 {
247 | let zx = axis[0].abs() as f64;
248 | let mut zy = axis[1].abs() as f64;
249 |
250 | let mut dead_zone = [
251 | self.dead_zone_x as f64 * axis_scale,
252 | self.dead_zone_y as f64 * axis_scale,
253 | ];
254 |
255 | if zx == 0f64 {
256 | zy -= dead_zone[1];
257 | zy = zy.max(0f64);
258 | input_trunk[1] = f64::copysign(
259 | (zy / (multiplier[1].abs() * FREQUENCY_SCALE.powf(self.exponent)))
260 | .powf(1f64 / self.exponent),
261 | multiplier[1] * output_raw[1],
262 | );
263 | } else if zy == 0f64 {
264 | /*
265 | * approximate the residue vector angle:
266 | *
267 | * theta = gamma * alpha / beta
268 | *
269 | * with:
270 | *
271 | * alpha: input motion angle
272 | * beta: desired output motion angle
273 | * gamma: truncated output motion angle
274 | * theta: truncated input motion angle
275 | */
276 | let angle = (zy / zx).atan() * (mouse[1].abs() / mouse[0].abs()).atan()
277 | / (output_raw[1].abs() / output_raw[0].abs()).atan();
278 | let angle_cos = angle.cos();
279 | let angle_sin = angle.sin();
280 |
281 | if self.shape == "circle" {
282 | dead_zone[0] *= angle_cos;
283 | dead_zone[1] *= angle_sin;
284 | }
285 |
286 | let normx = ((zx - dead_zone[0])
287 | / (multiplier[0].abs() * FREQUENCY_SCALE.powf(self.exponent) * angle_cos))
288 | .powf(1.0 / self.exponent);
289 | let normy = ((zy - dead_zone[1])
290 | / (multiplier[1].abs() * FREQUENCY_SCALE.powf(self.exponent) * angle_sin))
291 | .powf(1.0 / self.exponent);
292 | input_trunk[0] = f64::copysign(angle_cos * normx, multiplier[0] * output_raw[0]);
293 | input_trunk[1] = f64::copysign(angle_sin * normy, multiplier[1] * output_raw[1]);
294 | }
295 | }
296 |
297 | self.residue[0] = if input_trunk[0] != 0f64 {
298 | mouse[0] - input_trunk[0]
299 | } else {
300 | 0f64
301 | };
302 | self.residue[1] = if input_trunk[1] != 0f64 {
303 | mouse[1] - input_trunk[1]
304 | } else {
305 | 0f64
306 | };
307 | }
308 | }
309 |
310 | #[derive(Debug, Serialize, Deserialize)]
311 | #[serde(tag = "type")]
312 | pub enum Mapping {
313 | Button(ButtonMapping),
314 | Axis(AxisMapping),
315 | Mouse(MouseMapping),
316 | }
317 |
318 | pub struct Mapper {
319 | mappings: Vec,
320 | }
321 |
322 | impl Mapper {
323 | pub fn load>(path: P) -> Result {
324 | let contents = std::fs::read_to_string(path).map_err(|_| "unable to open mappings file")?;
325 | let mappings: Vec =
326 | serde_json::from_str(&contents).map_err(|_| "unable to parse mappings file")?;
327 | Ok(Self { mappings })
328 | }
329 |
330 | pub fn map_controller(&mut self, raw_input: &RawInput, ds4: &mut DS4) {
331 | for mapping in self.mappings.iter_mut() {
332 | match mapping {
333 | Mapping::Button(mapping) => {
334 | mapping.map_controller(raw_input, ds4);
335 | }
336 | Mapping::Axis(mapping) => {
337 | mapping.map_controller(raw_input, ds4);
338 | }
339 | Mapping::Mouse(mapping) => {
340 | mapping.map_controller(raw_input, ds4);
341 | }
342 | }
343 | }
344 | }
345 | }
346 |
--------------------------------------------------------------------------------
/mouseplay/src/hooks.rs:
--------------------------------------------------------------------------------
1 | use crate::controller::ds4::DS4;
2 |
3 | use std::ffi::OsString;
4 | use std::ffi::{c_void, CStr, CString};
5 | use std::mem::size_of;
6 |
7 | use log::info;
8 |
9 | use libc::strcmp;
10 | use winapi::{
11 | shared::minwindef::LPCVOID,
12 | um::{
13 | handleapi::INVALID_HANDLE_VALUE,
14 | libloaderapi::GetModuleHandleA,
15 | memoryapi::VirtualProtect,
16 | minwinbase::LPSECURITY_ATTRIBUTES,
17 | winnt::{
18 | LPCWSTR, PAGE_EXECUTE_READWRITE, PIMAGE_DOS_HEADER, PIMAGE_IMPORT_BY_NAME,
19 | PIMAGE_IMPORT_DESCRIPTOR, PIMAGE_NT_HEADERS, PIMAGE_THUNK_DATA,
20 | },
21 | },
22 | };
23 | use winapi::{
24 | shared::{
25 | minwindef::{BOOL, DWORD, LPDWORD, LPVOID},
26 | ntdef::HANDLE,
27 | },
28 | um::minwinbase::LPOVERLAPPED,
29 | };
30 |
31 | unsafe fn hook_import(
32 | target_module: &str,
33 | import_module: &str,
34 | import_name: &str,
35 | hook_func: *mut c_void,
36 | ) -> Result<*mut c_void, &'static str> {
37 | let target_module_cstr =
38 | CString::new(target_module).map_err(|_| "unable to convert target_module to CString")?;
39 | let target_module_base = GetModuleHandleA(target_module_cstr.as_ptr()) as u32;
40 | if target_module_base == 0 {
41 | return Err("unable to find target module");
42 | }
43 |
44 | let p_dos_header = target_module_base as PIMAGE_DOS_HEADER;
45 | if (*p_dos_header).e_magic != 0x5A4D
46 | /* 'MZ' */
47 | {
48 | return Err("invalid dos header e_magic value");
49 | }
50 |
51 | let p_nt_headers = (target_module_base + (*p_dos_header).e_lfanew as u32) as PIMAGE_NT_HEADERS;
52 | if (*p_nt_headers).Signature != 0x00004550
53 | /* 'PE00' */
54 | {
55 | return Err("invalid nt header signature");
56 | }
57 |
58 | let import_module_cstr =
59 | CString::new(import_module).map_err(|_| "unable to convert import_module to CString")?;
60 | let mut p_import_descriptor = (target_module_base
61 | + (*p_nt_headers).OptionalHeader.DataDirectory[1].VirtualAddress as u32)
62 | as PIMAGE_IMPORT_DESCRIPTOR; // PEIMAGE_DIRECTORY_ENTRY_IMPORT
63 | while *(*p_import_descriptor).u.OriginalFirstThunk() != 0 {
64 | if strcmp(
65 | import_module_cstr.as_ptr(),
66 | (target_module_base + (*p_import_descriptor).Name as u32) as *const i8,
67 | ) == 0
68 | {
69 | // iterate funcs
70 | let mut p_thunk = (target_module_base + (*p_import_descriptor).FirstThunk as u32)
71 | as PIMAGE_THUNK_DATA;
72 | let mut p_orig_thunk = (target_module_base
73 | + *(*p_import_descriptor).u.OriginalFirstThunk() as u32)
74 | as PIMAGE_THUNK_DATA;
75 | while *(*p_thunk).u1.AddressOfData() != 0 {
76 | // check func name
77 | let thunk_import = (target_module_base + *(*p_orig_thunk).u1.AddressOfData() as u32)
78 | as PIMAGE_IMPORT_BY_NAME;
79 | if let Ok(thunk_import_name_str) =
80 | CStr::from_ptr((*thunk_import).Name.as_ptr() as *const i8).to_str()
81 | {
82 | if thunk_import_name_str.to_lowercase() == import_name.to_lowercase() {
83 | // hook
84 | info!(
85 | "hooking function {}!{} at 0x{:x}",
86 | import_module,
87 | import_name,
88 | *(*p_thunk).u1.AddressOfData()
89 | );
90 |
91 | let mut old_prot = 0u32;
92 | VirtualProtect(
93 | p_thunk as _,
94 | size_of::(),
95 | PAGE_EXECUTE_READWRITE,
96 | &mut old_prot as _,
97 | );
98 | let orig_func = *(p_thunk as *const u32);
99 | *(p_thunk as *mut u32) = hook_func as u32;
100 | VirtualProtect(
101 | p_thunk as _,
102 | size_of::(),
103 | old_prot,
104 | &mut old_prot as _,
105 | );
106 | return Ok(orig_func as *mut c_void);
107 | }
108 | }
109 |
110 | p_thunk = p_thunk.offset(1);
111 | p_orig_thunk = p_orig_thunk.offset(1);
112 | }
113 |
114 | return Err("import not found");
115 | }
116 |
117 | p_import_descriptor = p_import_descriptor.offset(1);
118 | }
119 |
120 | Err("import module not found")
121 | }
122 |
123 | static mut ORIG_IS_DEBUGGER_PRESENT: *const c_void = std::ptr::null_mut();
124 | unsafe extern "stdcall" fn hook_is_debugger_present() -> BOOL {
125 | 0
126 | }
127 |
128 | unsafe fn u16_ptr_to_string(ptr: *const u16) -> OsString {
129 | use std::os::windows::prelude::*;
130 |
131 | let len = (0..).take_while(|&i| *ptr.offset(i) != 0).count();
132 | let slice = std::slice::from_raw_parts(ptr, len);
133 | OsString::from_wide(slice)
134 | }
135 |
136 | static mut ORIG_CREATE_FILE: *const c_void = std::ptr::null_mut();
137 | unsafe extern "stdcall" fn hook_create_file(
138 | lp_file_name: LPCWSTR,
139 | dw_desired_access: DWORD,
140 | dw_share_mode: DWORD,
141 | lp_security_attributes: LPSECURITY_ATTRIBUTES,
142 | dw_creation_disposition: DWORD,
143 | dw_flags_and_attributes: DWORD,
144 | h_template_file: HANDLE,
145 | ) -> HANDLE {
146 | //info!("hook_create_file(): lp_file_name={:?}, dw_desired_access={:?}, dw_share_mode={:?}, lp_security_attributes={:?}, dw_creation_disposition={:?}, dw_flags_and_attributes={:?}, h_template_file={:?}",
147 | // lp_file_name, dw_desired_access, dw_share_mode, lp_security_attributes, dw_creation_disposition, dw_flags_and_attributes, h_template_file);
148 |
149 | let orig_func: extern "stdcall" fn(
150 | _: LPCWSTR,
151 | _: DWORD,
152 | _: DWORD,
153 | _: LPSECURITY_ATTRIBUTES,
154 | _: DWORD,
155 | _: DWORD,
156 | _: HANDLE,
157 | ) -> HANDLE = std::mem::transmute(ORIG_CREATE_FILE);
158 | let result = orig_func(
159 | lp_file_name,
160 | dw_desired_access,
161 | dw_share_mode,
162 | lp_security_attributes,
163 | dw_creation_disposition,
164 | dw_flags_and_attributes,
165 | h_template_file,
166 | );
167 |
168 | let lp_file_name_str = u16_ptr_to_string(lp_file_name);
169 |
170 | result
171 | }
172 |
173 | static mut ORIG_READ_FILE: *const c_void = std::ptr::null_mut();
174 | unsafe extern "stdcall" fn hook_read_file(
175 | h_file: HANDLE,
176 | lp_buffer: LPVOID,
177 | n_number_of_bytes_to_read: DWORD,
178 | lp_number_of_bytes_read: LPDWORD,
179 | lp_overlapped: LPOVERLAPPED,
180 | ) -> BOOL {
181 | //trace!("hook_read_file(): h_file={:?}, lp_bufer={:?}, n_number_of_bytes_to_read={:?}, lp_number_of_bytes_read={:?}, lp_overlapped={:?}",
182 | // h_file, lp_buffer, n_number_of_bytes_to_read, lp_number_of_bytes_read, lp_overlapped);
183 |
184 | let mut bytes_read = 0;
185 |
186 | // only call original func if we are not spoofing a controller presence
187 | let orig_func: extern "stdcall" fn(
188 | _: HANDLE,
189 | _: LPVOID,
190 | _: DWORD,
191 | _: LPDWORD,
192 | _: LPOVERLAPPED,
193 | ) -> BOOL = std::mem::transmute(ORIG_READ_FILE);
194 | let result = orig_func(
195 | h_file,
196 | lp_buffer,
197 | n_number_of_bytes_to_read,
198 | &mut bytes_read as _,
199 | lp_overlapped,
200 | );
201 |
202 | if !lp_number_of_bytes_read.is_null() {
203 | *lp_number_of_bytes_read = bytes_read;
204 | }
205 |
206 | // hijack wndproc
207 | crate::input::raw_input::hijack_wndproc().unwrap();
208 |
209 | // TODO: figure out if we are in ds4 or ds5 mode
210 |
211 | // try to find a request with 64 bytes to determine the controller handle
212 | let buffer = std::slice::from_raw_parts_mut(lp_buffer as *mut u8, bytes_read as usize);
213 | if bytes_read >= 64 && bytes_read % 64 == 0 {
214 | // sometimes a request can contain multiple reports
215 | for buffer_part in buffer.chunks_exact_mut(64) {
216 | if let Ok(mut ds4) = DS4::new(buffer_part) {
217 | if let Ok(mut raw_input) = crate::input::raw_input::RAW_INPUT.write() {
218 | if let Ok(mut mapper) = crate::mapper::MAPPER.write() {
219 | if let Some(mapper) = mapper.as_mut() {
220 | raw_input.accumulate();
221 | mapper.map_controller(&raw_input, &mut ds4);
222 | buffer_part.copy_from_slice(ds4.to_raw().as_slice());
223 | }
224 | }
225 | }
226 | }
227 | }
228 | }
229 |
230 | result
231 | }
232 |
233 | static mut ORIG_WRITE_FILE: *const c_void = std::ptr::null_mut();
234 | unsafe extern "stdcall" fn hook_write_file(
235 | h_file: HANDLE,
236 | lp_buffer: LPCVOID,
237 | n_number_of_bytes_to_write: DWORD,
238 | lp_number_of_bytes_written: LPDWORD,
239 | lp_overlapped: LPOVERLAPPED,
240 | ) -> BOOL {
241 | //info!("hook_write_file(): h_file={:?}, lp_bufer={:?}, n_number_of_bytes_to_write={:?}, lp_number_of_bytes_written={:?}, lp_overlapped={:?}",
242 | // h_file, lp_buffer, n_number_of_bytes_to_write, lp_number_of_bytes_written, lp_overlapped);
243 |
244 | /*
245 | if n_number_of_bytes_to_write == 32 {
246 | let slice = std::slice::from_raw_parts_mut(
247 | lp_buffer as *mut u8,
248 | n_number_of_bytes_to_write as usize,
249 | );
250 | //slice[1] = 5;
251 | slice[4] = 100; // rumble
252 | //slice[8] = 5; // rumble time?
253 | }
254 | */
255 |
256 | let mut bytes_written = 0;
257 | let orig_func: extern "stdcall" fn(
258 | _: HANDLE,
259 | _: LPCVOID,
260 | _: DWORD,
261 | _: LPDWORD,
262 | _: LPOVERLAPPED,
263 | ) -> BOOL = std::mem::transmute(ORIG_WRITE_FILE);
264 | let result = orig_func(
265 | h_file,
266 | lp_buffer,
267 | n_number_of_bytes_to_write,
268 | &mut bytes_written as _,
269 | lp_overlapped,
270 | );
271 | if !lp_number_of_bytes_written.is_null() {
272 | *lp_number_of_bytes_written = bytes_written;
273 | }
274 |
275 | if bytes_written == 32 {
276 | let slice = std::slice::from_raw_parts(lp_buffer as *mut u8, bytes_written as usize);
277 | //info!("written: {:?}", slice);
278 | }
279 |
280 | result
281 | }
282 |
283 | pub fn setup() {
284 | // hook:
285 | // RpCtrlWrapper.dll", "KERNEL32.dll", "IsDebuggerPresent"
286 | // RpCtrlWrapper.dll", "KERNEL32.dll", "CreateFileW"
287 | // RpCtrlWrapper.dll", "KERNEL32.dll", "ReadFile"
288 | // RpCtrlWrapper.dll", "KERNEL32.dll", "WriteFile"
289 |
290 | unsafe {
291 | ORIG_IS_DEBUGGER_PRESENT = hook_import(
292 | "RpCtrlWrapper.dll",
293 | "KERNEL32.dll",
294 | "IsDebuggerPresent",
295 | hook_is_debugger_present as _,
296 | )
297 | .unwrap();
298 |
299 | ORIG_CREATE_FILE = hook_import(
300 | "RpCtrlWrapper.dll",
301 | "KERNEL32.dll",
302 | "CreateFileW",
303 | hook_create_file as _,
304 | )
305 | .unwrap();
306 |
307 | ORIG_READ_FILE = hook_import(
308 | "RpCtrlWrapper.dll",
309 | "KERNEL32.dll",
310 | "ReadFile",
311 | hook_read_file as _,
312 | )
313 | .unwrap();
314 | }
315 |
316 | info!("hooking kernel32.dll!WriteFile");
317 | unsafe {
318 | ORIG_WRITE_FILE = hook_import(
319 | "RpCtrlWrapper.dll",
320 | "KERNEL32.dll",
321 | "WriteFile",
322 | hook_write_file as _,
323 | )
324 | .unwrap();
325 | }
326 | }
327 |
--------------------------------------------------------------------------------
/mouseplay/src/input/raw_input.rs:
--------------------------------------------------------------------------------
1 | use std::collections::HashMap;
2 | use std::ffi::{c_void, CString};
3 | use std::mem::size_of;
4 | use std::sync::RwLock;
5 |
6 | use log::{info, trace, warn};
7 |
8 | use lazy_static::lazy_static;
9 | use winapi::{
10 | shared::{
11 | minwindef::{LOWORD, LPARAM, LRESULT, UINT, WPARAM},
12 | windef::{HWND, RECT},
13 | windowsx::GET_Y_LPARAM,
14 | },
15 | um::winuser::*,
16 | };
17 |
18 | lazy_static! {
19 | // thread safe storage for all known wndprocs
20 | static ref ORIG_WNDPROCS: RwLock> = RwLock::new(HashMap::new());
21 |
22 | // thread safe storage for the global RawInput handler
23 | pub static ref RAW_INPUT: RwLock = RwLock::new(RawInput::new().unwrap());
24 | }
25 |
26 | pub fn hijack_wndproc() -> Result<(), &'static str> {
27 | let window_name =
28 | CString::new("PS Remote Play").map_err(|_| "unable to convert window_name")?;
29 | let h_wnd = unsafe { FindWindowA(std::ptr::null(), window_name.as_ptr()) };
30 | if h_wnd.is_null() {
31 | return Err("window not found");
32 | }
33 |
34 | let orig_wndproc = unsafe { GetWindowLongPtrA(h_wnd, GWL_WNDPROC) } as *const c_void;
35 | if orig_wndproc == (hook_wndproc as _) {
36 | // already hijacked, skip
37 | return Ok(());
38 | }
39 |
40 | // hijack wndproc
41 | if let Ok(mut wndprocs) = ORIG_WNDPROCS.write() {
42 | info!(
43 | "hijacking wndproc for h_wnd=0x{:x}, orig_wndproc=0x{:x}, hook_wndproc=0x{:x}",
44 | h_wnd as u64, orig_wndproc as u64, hook_wndproc as *const c_void as u64
45 | );
46 | wndprocs.insert(h_wnd as u64, orig_wndproc as u64);
47 | unsafe { SetWindowLongPtrA(h_wnd, GWL_WNDPROC, hook_wndproc as _) };
48 | };
49 |
50 | Ok(())
51 | }
52 |
53 | unsafe extern "system" fn hook_wndproc(
54 | h_wnd: HWND,
55 | u_msg: UINT,
56 | w_param: WPARAM,
57 | l_param: LPARAM,
58 | ) -> LRESULT {
59 | //info!("hook_wndproc(): h_wnd=0x{:x} u_msg={:x} w_param={:x} l_param={:x}", h_wnd as u64, u_msg, w_param, l_param);
60 |
61 | // TODO: re-center mouse + prevent inputs from being fed into the original window
62 | let call_wndproc = if let Ok(mut raw_input) = RAW_INPUT.write() {
63 | raw_input.parse(h_wnd, u_msg, w_param, l_param).unwrap()
64 | } else {
65 | true
66 | };
67 |
68 | if call_wndproc {
69 | if let Ok(lock) = ORIG_WNDPROCS.read() {
70 | if let Some(wndproc) = lock.get(&(h_wnd as u64)) {
71 | if *wndproc != 0 {
72 | let orig_func: WNDPROC = Some(std::mem::transmute(*wndproc as *const c_void));
73 | return CallWindowProcW(orig_func, h_wnd, u_msg, w_param, l_param);
74 | }
75 | } else {
76 | warn!("wndproc for h_wnd=0x{:x} not found", h_wnd as u64);
77 | }
78 | }
79 | }
80 |
81 | 0
82 | }
83 |
84 | const LBUTTONDOWN: u16 = 1 << 0;
85 | const LBUTTONUP: u16 = 1 << 1;
86 | const RBUTTONDOWN: u16 = 1 << 2;
87 | const RBUTTONUP: u16 = 1 << 3;
88 | const MBUTTONDOWN: u16 = 1 << 4;
89 | const MBUTTONUP: u16 = 1 << 5;
90 | const XBUTTON1DOWN: u16 = 1 << 6;
91 | const XBUTTON1UP: u16 = 1 << 7;
92 | const XBUTTON2DOWN: u16 = 1 << 8;
93 | const XBUTTON2UP: u16 = 1 << 9;
94 | pub struct RawInput {
95 | capture: Option,
96 | mouse_lock: bool,
97 | keys: [bool; 256],
98 | mouse: [i32; 2],
99 | mouse_accumulator: [i32; 2],
100 | }
101 |
102 | impl RawInput {
103 | pub fn new() -> Result {
104 | let rid = [
105 | RAWINPUTDEVICE {
106 | usUsagePage: 0x01,
107 | usUsage: 0x02,
108 | dwFlags: 0,
109 | hwndTarget: std::ptr::null_mut(),
110 | },
111 | RAWINPUTDEVICE {
112 | usUsagePage: 0x01,
113 | usUsage: 0x06,
114 | dwFlags: 0,
115 | hwndTarget: std::ptr::null_mut(),
116 | },
117 | ];
118 |
119 | info!("registering raw input devices");
120 | if unsafe { RegisterRawInputDevices(rid.as_ptr(), 2, size_of::() as u32) }
121 | != 0
122 | {
123 | Ok(Self {
124 | capture: None,
125 | mouse_lock: false,
126 | keys: [false; 256],
127 | mouse: [0; 2],
128 | mouse_accumulator: [0; 2],
129 | })
130 | } else {
131 | Err("unable to register raw input devices")
132 | }
133 | }
134 |
135 | pub fn key(&self, button: &str) -> bool {
136 | match str_to_vk(button) {
137 | Ok(vk) => self.keys[vk as usize],
138 | Err(_) => false,
139 | }
140 | }
141 |
142 | // TODO:
143 | pub fn mouse_x(&self) -> i32 {
144 | self.mouse[0]
145 | }
146 |
147 | pub fn mouse_y(&self) -> i32 {
148 | self.mouse[1]
149 | }
150 |
151 | pub fn parse(
152 | &mut self,
153 | h_wnd: HWND,
154 | u_msg: UINT,
155 | w_param: WPARAM,
156 | l_param: LPARAM,
157 | ) -> Result {
158 | // validate existence of capture wnd
159 | if let Some(h_wnd) = self.capture {
160 | if unsafe { IsWindow(h_wnd as _) } == 0 {
161 | self.capture = None;
162 | }
163 | }
164 |
165 | match u_msg {
166 | WM_INPUT => {
167 | // we do not always get WM_INPUT messages so we wait until the connection is established
168 | self.capture = Some(h_wnd as u64);
169 | self.parse_raw_input(l_param)?;
170 | if self.mouse_lock {
171 | return Ok(false);
172 | }
173 | }
174 | WM_PARENTNOTIFY if w_param == 513 => {
175 | if self.capture.is_some() && !self.mouse_lock {
176 | let mut rect = RECT::default();
177 | // TODO: check return value for error
178 | unsafe { GetWindowRect(h_wnd, &mut rect as _) };
179 | let y = GET_Y_LPARAM(l_param);
180 | if y <= (rect.bottom - rect.top) - 130 {
181 | info!("locking mouse");
182 | self.mouse_lock = true;
183 | return Ok(false);
184 | }
185 | }
186 | }
187 | WM_SETCURSOR => {
188 | if self.capture.is_some() {
189 | if self.mouse_lock {
190 | // TODO: remove cursor?
191 | /*if LOWORD(l_param as _) as isize == HTCLIENT {
192 | unsafe { SetCursor(std::ptr::null_mut()) };
193 | }*/
194 | return Ok(false);
195 | } else {
196 | }
197 | }
198 | }
199 | WM_LBUTTONDOWN | WM_LBUTTONDBLCLK | WM_LBUTTONUP | WM_RBUTTONDOWN
200 | | WM_RBUTTONDBLCLK | WM_RBUTTONUP | WM_MBUTTONDOWN | WM_MBUTTONDBLCLK
201 | | WM_MBUTTONUP | WM_KEYDOWN | WM_SYSKEYDOWN | WM_KEYUP | WM_SYSKEYUP => {
202 | if self.capture.is_some() && self.mouse_lock {
203 | return Ok(false);
204 | }
205 | }
206 |
207 | _ => {}
208 | }
209 | Ok(true)
210 | }
211 |
212 | fn parse_raw_input(&mut self, l_param: LPARAM) -> Result<(), &'static str> {
213 | // figure out correct raw_input size
214 | let mut rid_size = 0u32;
215 | unsafe {
216 | GetRawInputData(
217 | l_param as _,
218 | RID_INPUT,
219 | std::ptr::null_mut(),
220 | &mut rid_size as _,
221 | size_of::() as u32,
222 | )
223 | };
224 |
225 | let mut data = vec![0u8; rid_size as usize];
226 | unsafe {
227 | GetRawInputData(
228 | l_param as _,
229 | RID_INPUT,
230 | data.as_mut_ptr() as _,
231 | &mut rid_size as _,
232 | size_of::() as u32,
233 | )
234 | };
235 | // TODO: check return value size
236 |
237 | let rid = data.as_ptr() as *mut RAWINPUT;
238 | match unsafe { (*rid).header.dwType } {
239 | RIM_TYPEMOUSE => {
240 | let mouse = unsafe { (*rid).data.mouse() };
241 | self.parse_mouse(mouse);
242 | }
243 | RIM_TYPEKEYBOARD => {
244 | let kbd = unsafe { (*rid).data.keyboard() };
245 | self.parse_keyboard(kbd);
246 | }
247 | _ => {}
248 | };
249 |
250 | Ok(())
251 | }
252 |
253 | fn parse_mouse(&mut self, mouse: &RAWMOUSE) {
254 | self.mouse_accumulator[0] += mouse.lLastX;
255 | self.mouse_accumulator[1] += mouse.lLastY;
256 |
257 | if mouse.usButtonFlags & LBUTTONDOWN != 0 {
258 | self.keys[VK_LBUTTON as usize] = true;
259 | }
260 | if mouse.usButtonFlags & LBUTTONUP != 0 {
261 | self.keys[VK_LBUTTON as usize] = false;
262 | }
263 | if mouse.usButtonFlags & RBUTTONDOWN != 0 {
264 | self.keys[VK_RBUTTON as usize] = true;
265 | }
266 | if mouse.usButtonFlags & RBUTTONUP != 0 {
267 | self.keys[VK_RBUTTON as usize] = false;
268 | }
269 | if mouse.usButtonFlags & MBUTTONDOWN != 0 {
270 | self.keys[VK_MBUTTON as usize] = true;
271 | }
272 | if mouse.usButtonFlags & MBUTTONUP != 0 {
273 | self.keys[VK_MBUTTON as usize] = false;
274 | }
275 | if mouse.usButtonFlags & XBUTTON1DOWN != 0 {
276 | self.keys[VK_XBUTTON1 as usize] = true;
277 | }
278 | if mouse.usButtonFlags & XBUTTON1UP != 0 {
279 | self.keys[VK_XBUTTON1 as usize] = false;
280 | }
281 | if mouse.usButtonFlags & XBUTTON2DOWN != 0 {
282 | self.keys[VK_XBUTTON2 as usize] = true;
283 | }
284 | if mouse.usButtonFlags & XBUTTON2UP != 0 {
285 | self.keys[VK_XBUTTON2 as usize] = false;
286 | }
287 | }
288 |
289 | fn parse_keyboard(&mut self, kbd: &RAWKEYBOARD) {
290 | if kbd.Flags == 0 {
291 | trace!("key up: {}", kbd.VKey);
292 | self.keys[kbd.VKey as usize] = true;
293 | } else {
294 | trace!("key up: {}", kbd.VKey);
295 | self.keys[kbd.VKey as usize] = false;
296 | }
297 |
298 | // check unlock key combination shift+escape
299 | if self.keys[VK_SHIFT as usize] && self.keys[VK_ESCAPE as usize] {
300 | info!("unlocking mouse");
301 | self.mouse_lock = false;
302 | }
303 | }
304 |
305 | pub fn accumulate(&mut self) {
306 | if let Some(h_wnd) = self.capture {
307 | // TODO: handle self.mouse_lock == false
308 |
309 | // unlock mouse
310 | if self.mouse_lock && unsafe { IsWindow(h_wnd as _) } == 0 {
311 | self.mouse_lock = false;
312 | }
313 |
314 | if self.mouse_lock {
315 | self.mouse[0] = self.mouse_accumulator[0];
316 | self.mouse[1] = self.mouse_accumulator[1];
317 | self.center_mouse(h_wnd as HWND);
318 | } else {
319 | self.mouse[0] = 0;
320 | self.mouse[1] = 0;
321 | }
322 | }
323 |
324 | // reset mouse
325 | self.mouse_accumulator[0] = 0;
326 | self.mouse_accumulator[1] = 0;
327 | }
328 |
329 | fn center_mouse(&self, h_wnd: HWND) {
330 | let mut rect = RECT::default();
331 | // TODO: check return value for error
332 | unsafe {
333 | GetWindowRect(h_wnd, &mut rect as _);
334 | SetCursorPos(
335 | ((rect.right + rect.left) as f32 / 2.0) as i32,
336 | ((rect.bottom + rect.top) as f32 / 2.0) as i32,
337 | );
338 | }
339 | }
340 | }
341 |
342 | fn str_to_vk(key: &str) -> Result {
343 | match key {
344 | "mouse1" => Ok(VK_LBUTTON),
345 | "mouse2" => Ok(VK_RBUTTON),
346 | "mouse3" => Ok(VK_MBUTTON),
347 | "mouse4" => Ok(VK_XBUTTON1),
348 | "mouse5" => Ok(VK_XBUTTON2),
349 | "shift" => Ok(VK_SHIFT),
350 | "lshift" => Ok(VK_LSHIFT),
351 | "rshift" => Ok(VK_RSHIFT),
352 | "alt" => Ok(VK_MENU),
353 | "lalt" => Ok(VK_LMENU),
354 | "ralt" => Ok(VK_RMENU),
355 | "ctrl" => Ok(VK_CONTROL),
356 | "lctrl" => Ok(VK_LCONTROL),
357 | "rctrl" => Ok(VK_RCONTROL),
358 | "tab" => Ok(VK_TAB),
359 | "up" => Ok(VK_UP),
360 | "down" => Ok(VK_DOWN),
361 | "left" => Ok(VK_LEFT),
362 | "right" => Ok(VK_RIGHT),
363 | "insert" => Ok(VK_INSERT),
364 | "delete" => Ok(VK_DELETE),
365 | "home" => Ok(VK_HOME),
366 | "end" => Ok(VK_END),
367 | "pgup" => Ok(VK_PRIOR),
368 | "pgdn" => Ok(VK_NEXT),
369 | "backspace" => Ok(VK_BACK),
370 | "enter" => Ok(VK_RETURN),
371 | "pause" => Ok(VK_PAUSE),
372 | "numlock" => Ok(VK_NUMLOCK),
373 | "space" => Ok(VK_SPACE),
374 | "kp_0" => Ok(VK_NUMPAD0),
375 | "kp_1" => Ok(VK_NUMPAD1),
376 | "kp_2" => Ok(VK_NUMPAD2),
377 | "kp_3" => Ok(VK_NUMPAD3),
378 | "kp_4" => Ok(VK_NUMPAD4),
379 | "kp_5" => Ok(VK_NUMPAD5),
380 | "kp_6" => Ok(VK_NUMPAD6),
381 | "kp_7" => Ok(VK_NUMPAD7),
382 | "kp_8" => Ok(VK_NUMPAD8),
383 | "kp_9" => Ok(VK_NUMPAD9),
384 | "esc" => Ok(VK_ESCAPE),
385 | "escape" => Ok(VK_ESCAPE),
386 | "f1" => Ok(VK_F1),
387 | "f2" => Ok(VK_F2),
388 | "f3" => Ok(VK_F3),
389 | "f4" => Ok(VK_F4),
390 | "f5" => Ok(VK_F5),
391 | "f6" => Ok(VK_F6),
392 | "f7" => Ok(VK_F7),
393 | "f8" => Ok(VK_F8),
394 | "f9" => Ok(VK_F9),
395 | "f10" => Ok(VK_F10),
396 | "f11" => Ok(VK_F11),
397 | "f12" => Ok(VK_F12),
398 | "0" => Ok(58),
399 | "1" => Ok(49),
400 | "2" => Ok(50),
401 | "3" => Ok(51),
402 | "4" => Ok(52),
403 | "5" => Ok(53),
404 | "6" => Ok(54),
405 | "7" => Ok(55),
406 | "8" => Ok(56),
407 | "9" => Ok(57),
408 | "a" => Ok(65),
409 | "b" => Ok(66),
410 | "c" => Ok(67),
411 | "d" => Ok(68),
412 | "e" => Ok(69),
413 | "f" => Ok(70),
414 | "g" => Ok(71),
415 | "h" => Ok(72),
416 | "i" => Ok(73),
417 | "j" => Ok(74),
418 | "k" => Ok(75),
419 | "l" => Ok(76),
420 | "m" => Ok(77),
421 | "n" => Ok(78),
422 | "o" => Ok(79),
423 | "p" => Ok(80),
424 | "q" => Ok(81),
425 | "r" => Ok(82),
426 | "s" => Ok(83),
427 | "t" => Ok(84),
428 | "u" => Ok(85),
429 | "v" => Ok(86),
430 | "w" => Ok(87),
431 | "x" => Ok(88),
432 | "y" => Ok(89),
433 | "z" => Ok(90),
434 | _ => Err("invalid keycode"),
435 | }
436 | }
437 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------