File: spacemouse.cpp

package info (click to toggle)
freespace2 24.2.0%2Brepack-1
  • links: PTS, VCS
  • area: non-free
  • in suites: forky, sid
  • size: 43,716 kB
  • sloc: cpp: 595,001; ansic: 21,741; python: 1,174; sh: 457; makefile: 248; xml: 181
file content (179 lines) | stat: -rw-r--r-- 6,231 bytes parent folder | download | duplicates (2)
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
#include "spacemouse.h"

#include <hidapi/hidapi.h>

using namespace io::spacemouse;

#pragma pack(push,1)
struct connexion_3d_old_protocol {
	uint8_t type;
	union {
		struct {
			int16_t trans_x, trans_y, trans_z;
		} type1;
		struct {
			int16_t rot_x, rot_y, rot_z;
		} type2;
		struct {
			uint8_t buttons[4];
		} type3;
	} data;
};

struct connexion_3d_new_protocol {
	uint8_t type;
	union {
		struct {
			int16_t trans_x, trans_y, trans_z;
			int16_t rot_x, rot_y, rot_z;
		} type1;
		struct {
			uint8_t buttons[4];
		} type3;
	} data;
};
#pragma pack(pop)

void SpaceMouse::poll() {
	int bytes_read = 0;
	do {
		//Read until we have all reports, since we need the last one in the buffer for each type as the most up to date one.

		switch (m_definition.protocol) {
		case SpaceMouseDefinition::Protocol::CONNEXION_3D_OLD: {
			static connexion_3d_old_protocol data;

			bytes_read = hid_read(m_deviceHandle, reinterpret_cast<unsigned char*>(&data), sizeof(connexion_3d_old_protocol));
			if (bytes_read <= 0)
				continue;

			switch (data.type) {
			case 1:
				m_current.translation.xyz.x = static_cast<float>(data.data.type1.trans_x) / 150.0f;
				m_current.translation.xyz.y = static_cast<float>(data.data.type1.trans_y) / -150.0f;
				m_current.translation.xyz.z = static_cast<float>(data.data.type1.trans_z) / -150.0f;
				break;
			case 2:
				m_current.rotation.p = static_cast<float>(data.data.type2.rot_x) / -350.0f;
				m_current.rotation.b = static_cast<float>(data.data.type2.rot_y) / 350.0f;
				m_current.rotation.h = static_cast<float>(data.data.type2.rot_z) / 350.0f;
				break;
			case 3:
				//Buttons are not yet handled
				break;
			default:
				break;
			}
			break;
		}
		case SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW: {
			static connexion_3d_new_protocol data;

			bytes_read = hid_read(m_deviceHandle, reinterpret_cast<unsigned char*>(&data), sizeof(connexion_3d_new_protocol));
			if (bytes_read <= 0)
				continue;

			switch (data.type) {
			case 1:
				m_current.translation.xyz.x = static_cast<float>(data.data.type1.trans_x) / 150.0f;
				m_current.translation.xyz.y = static_cast<float>(data.data.type1.trans_y) / -150.0f;
				m_current.translation.xyz.z = static_cast<float>(data.data.type1.trans_z) / -150.0f;
				m_current.rotation.p = static_cast<float>(data.data.type1.rot_x) / -350.0f;
				m_current.rotation.b = static_cast<float>(data.data.type1.rot_y) / 350.0f;
				m_current.rotation.h = static_cast<float>(data.data.type1.rot_z) / 350.0f;
				break;
			case 3:
				//Buttons are not yet handled
				break;
			default:
				m_current.translation = ZERO_VECTOR;
				m_current.rotation = ZERO_ANGLES;
				break;
			}
			break;
		}
		default:
			UNREACHABLE("Bad SpaceMouse protocol specified!");
		}
	} while (bytes_read > 0);
}

void SpaceMouse::pollMaybe() {
	UI_TIMESTAMP now = ui_timestamp();
	if (ui_timestamp_get_delta(m_lastPolled, now) > m_pollingFrequency) {
		m_lastPolled = std::move(now);
		poll();
	}
}

SpaceMouse::SpaceMouse(const SpaceMouseDefinition& definition, hid_device* deviceHandle, int pollingFrequency)
	: m_definition(definition), m_pollingFrequency(pollingFrequency), m_deviceHandle(deviceHandle),
	  m_current({ ZERO_VECTOR, ZERO_ANGLES }), m_keypresses(definition.buttons, false), m_lastPolled(UI_TIMESTAMP::never()) {
	hid_set_nonblocking(m_deviceHandle, 1);
}

SpaceMouse::~SpaceMouse() {
	hid_close(m_deviceHandle);
}

const SpaceMouseMovement& SpaceMouse::getMovement() {
	pollMaybe();
	return m_current;
}

bool SpaceMouse::isButtonPressed(size_t number) {
	if (number >= m_definition.buttons)
		return false;

	pollMaybe();
	return m_keypresses[number];
}

const static SCP_vector<SpaceMouseDefinition> knownSpaceMice {
	SpaceMouseDefinition { 0x046D, 0xC626,  2, SpaceMouseDefinition::Protocol::CONNEXION_3D_OLD }, //SpaceNavigator
	SpaceMouseDefinition { 0x046D, 0xC628,  2, SpaceMouseDefinition::Protocol::CONNEXION_3D_OLD }, //SpaceNavigator
	SpaceMouseDefinition { 0x256F, 0xC635,  2, SpaceMouseDefinition::Protocol::CONNEXION_3D_OLD }, //SpaceMouse Compact
	SpaceMouseDefinition { 0x256F, 0xC62E,  2, SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW }, //SpaceMouse Wireless
	SpaceMouseDefinition { 0x256F, 0xC62F,  2, SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW }, //SpaceMouse Wireless
	SpaceMouseDefinition { 0x256F, 0xC658,  2, SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW }, //SpaceMouse Wireless
	SpaceMouseDefinition { 0x046D, 0xC62B, 15, SpaceMouseDefinition::Protocol::CONNEXION_3D_OLD }, //SpaceMouse Pro
	SpaceMouseDefinition { 0x256F, 0xC631, 15, SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW }, //SpaceMouse Pro Wireless
	SpaceMouseDefinition { 0x256F, 0xC632, 15, SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW }, //SpaceMouse Pro Wireless
	SpaceMouseDefinition { 0x046D, 0xC629, 21, SpaceMouseDefinition::Protocol::CONNEXION_3D_OLD }, //SpacePilot Pro
	SpaceMouseDefinition { 0x256F, 0xC652, 15, SpaceMouseDefinition::Protocol::CONNEXION_3D_NEW }, //3Dconnexion Universal Receiver
};

std::unique_ptr<SpaceMouse> SpaceMouse::searchSpaceMice(int pollingFrequency) {
	std::unique_ptr<SpaceMouse> mouse = nullptr;
	
	hid_device_info* devices = hid_enumerate(0, 0);

	for (const hid_device_info* head = devices; head != nullptr && mouse == nullptr; head = head->next) {
		for (const SpaceMouseDefinition& mouseDef : knownSpaceMice) {
			if (mouseDef.vendorID != head->vendor_id || mouseDef.productID != head->product_id)
				continue;

			hid_device* device = hid_open_path(head->path);

			if (device != nullptr) {
				mouse = std::unique_ptr<SpaceMouse>(new SpaceMouse(mouseDef, device, pollingFrequency));
				break;
			}
		}
	}

	hid_free_enumeration(devices);

	return mouse;
}

#define HANDLE_NONLINEARITY(field, idx) field = copysignf(powf(field, std::get<0>(spacemouse_nonlinearity[idx])) * std::get<1>(spacemouse_nonlinearity[idx]), field)

void SpaceMouseMovement::handleNonlinearities(std::array<std::tuple<float, float>, 6>& spacemouse_nonlinearity) {
	HANDLE_NONLINEARITY(translation.xyz.x, 0);
	HANDLE_NONLINEARITY(translation.xyz.y, 1);
	HANDLE_NONLINEARITY(translation.xyz.z, 2);
	HANDLE_NONLINEARITY(rotation.p, 3);
	HANDLE_NONLINEARITY(rotation.b, 4);
	HANDLE_NONLINEARITY(rotation.h, 5);
}