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
|
#!/usr/bin/env python
from dataclasses import dataclass
import threading
import uuid
import gzip
import json
import time
import queue
from argaze import DataStructures
from argaze.TobiiGlassesPro2 import TobiiNetworkInterface
from argaze.utils import MiscFeatures
@dataclass
class DirSig():
"""Define dir sig data (dir sig)."""
dir: int # meaning ?
sig: int # meaning ?
@dataclass
class PresentationTimeStamp():
"""Define presentation time stamp data (pts)."""
value: int
@dataclass
class VideoTimeStamp():
"""Define video time stamp data (vts)."""
value: int
@dataclass
class EventSynch():
"""Define event synch data (evts)."""
value: int # meaning ?
@dataclass
class Event():
"""Define event data (ets type tag)."""
ets: int # meaning ?
type: str
tag: str # dict ?
@dataclass
class Accelerometer():
"""Define accelerometer data (ac)."""
value: tuple((float, float, float))
@dataclass
class Gyroscope():
"""Define gyroscope data (gy)."""
value: tuple((float, float, float))
@dataclass
class PupilCenter():
"""Define pupil center data (gidx pc eye)."""
validity: int
index: int
value: tuple((float, float, float))
eye: str # 'right' or 'left'
@dataclass
class PupilDiameter():
"""Define pupil diameter data (gidx pd eye)."""
validity: int
index: int
value: float
eye: str # 'right' or 'left'
@dataclass
class GazeDirection():
"""Define gaze direction data (gidx gd eye)."""
validity: int
index: int
value: tuple((float, float, float))
eye: str # 'right' or 'left'
@dataclass
class GazePosition():
"""Define gaze position data (gidx l gp)."""
validity: int
index: int
l: str # ?
value: tuple((float, float))
@dataclass
class GazePosition3D():
"""Define gaze position 3D data (gidx gp3)."""
validity: int
index: int
value: tuple((float, float))
@dataclass
class MarkerPosition():
"""Define marker data (marker3d marker2d)."""
value_3d: tuple((float, float, float))
value_2d: tuple((float, float))
class TobiiJsonDataParser():
def parse_dir_sig(self, status, json_data):
return DirSig(json_data['dir'], json_data['sig'])
def parse_pts(self, status, json_data):
return PresentationTimeStamp(json_data['pts'])
def parse_vts(self, status, json_data):
return VideoTimeStamp(json_data['vts'])
def parse_event_synch(self, status, json_data):
return EventSynch(json_data['evts'])
def parse_event(self, status, json_data):
return Event(json_data['ets'], json_data['type'], json_data['tag'])
def parse_accelerometer(self, status, json_data):
return Accelerometer(json_data['ac'])
def parse_gyroscope(self, status, json_data):
return Gyroscope(json_data['gy'])
def parse_pupil_center(self, status, gaze_index, json_data):
return PupilCenter(status, gaze_index, json_data['pc'], json_data['eye'])
def parse_pupil_diameter(self, status, gaze_index, json_data):
return PupilDiameter(status, gaze_index, json_data['pd'], json_data['eye'])
def parse_gaze_direction(self, status, gaze_index, json_data):
return GazeDirection(status, gaze_index, json_data['gd'], json_data['eye'])
def parse_gaze_position(self, status, gaze_index, json_data):
return GazePosition(status, gaze_index, json_data['l'], json_data['gp'])
def parse_gaze_position_3d(self, status, gaze_index, json_data):
return GazePosition3D(status, gaze_index, json_data['gp3'])
def parse_marker_position(self, status, json_data):
return MarkerPosition(json_data['marker3d'], json_data['marker2d'])
def parse_pupil_or_gaze(self, status, json_data):
gaze_index = json_data.pop('gidx')
# parse pupil or gaze data depending second json key
second_key = next(iter(json_data))
parse_map = {
'pc': self.parse_pupil_center,
'pd': self.parse_pupil_diameter,
'gd': self.parse_gaze_direction,
'l': self.parse_gaze_position,
'gp3': self.parse_gaze_position_3d
}
return parse_map[second_key](status, gaze_index, json_data)
def parse_data(self, status, json_data):
# parse data depending first json key
first_key = next(iter(json_data))
parse_map = {
'dir': self.parse_dir_sig,
'pts': self.parse_pts,
'vts': self.parse_vts,
'evts': self.parse_event_synch,
'ets': self.parse_event,
'ac': self.parse_accelerometer,
'gy': self.parse_gyroscope,
'gidx': self.parse_pupil_or_gaze,
'marker3d': self.parse_marker_position
}
return parse_map[first_key](status, json_data)
class TobiiDataSegment():
"""Handle Tobii Glasses Pro 2 segment data file."""
def __init__(self, segment_data_path, start_timestamp = 0, end_timestamp = None):
"""Load segment data from segment directory then parse and register each recorded dataflow as a TimeStampedBuffer member of the TobiiSegmentData instance."""
self.__segment_data_path = segment_data_path
self.__vts_offset = 0
self.__vts_ts = -1
self.__json_data_parser = TobiiJsonDataParser()
self.__ts_data_buffer_dict = {
'DirSig': DataStructures.TimeStampedBuffer(),
'PresentationTimeStamp': DataStructures.TimeStampedBuffer(),
'EventSynch': DataStructures.TimeStampedBuffer(),
'Event': DataStructures.TimeStampedBuffer(),
'Accelerometer': DataStructures.TimeStampedBuffer(),
'Gyroscope': DataStructures.TimeStampedBuffer(),
'PupilCenter': DataStructures.TimeStampedBuffer(),
'PupilDiameter': DataStructures.TimeStampedBuffer(),
'GazeDirection': DataStructures.TimeStampedBuffer(),
'GazePosition': DataStructures.TimeStampedBuffer(),
'GazePosition3D': DataStructures.TimeStampedBuffer(),
'MarkerPosition': DataStructures.TimeStampedBuffer()
}
# define a decoder function
def decode(json_data):
# parse data status
status = json_data.pop('s', -1)
# convert timestamp
ts = json_data.pop('ts')
# watch for vts data to offset timestamps
try:
self.__vts_offset = json_data['vts']
self.__vts_ts = ts
return True # continue
except KeyError:
pass
# ignore data before first vts entry
if self.__vts_ts == -1:
return True # continue
ts -= self.__vts_ts
ts += self.__vts_offset
# ignore timestamps out of the given time range
if ts < start_timestamp:
return True # continue
if ts >= end_timestamp:
return False # stop
# convert json data into data object
data_object = self.__json_data_parser.parse_data(status, json_data)
data_object_type = type(data_object).__name__
# store data object into dedicated timestamped buffer
self.__ts_data_buffer_dict[data_object_type][ts] = data_object
return True # continue
# start loading
with gzip.open(self.__segment_data_path) as f:
for item in f:
if not json.loads(item.decode('utf-8'), object_hook=decode):
break
def __getitem__(self, key):
return self.__ts_data_buffer_dict[key]
def keys(self):
"""Get all registered data keys"""
return list(self.__ts_data_buffer_dict.keys())
def get_path(self):
return self.__segment_data_path
class TobiiDataStream(threading.Thread):
"""Capture Tobii Glasses Pro 2 data stream in separate thread."""
reading_callback = None
def __init__(self, network_interface: TobiiNetworkInterface.TobiiNetworkInterface):
"""Initialise thread super class as a deamon dedicated to data reception."""
threading.Thread.__init__(self)
threading.Thread.daemon = True
self.__network = network_interface
self.__data_socket = self.__network.make_socket()
self.__data_queue = queue.Queue(50) # TODO : set queue size according technical reason
self.__stop_event = threading.Event()
self.__read_lock = threading.Lock()
# prepare keep alive message
self.__keep_alive_msg = "{\"type\": \"live.data.unicast\", \"key\": \""+ str(uuid.uuid4()) +"\", \"op\": \"start\"}"
self.__keep_alive_thread = threading.Thread(target = self.__keep_alive)
self.__keep_alive_thread.daemon = True
self.__json_data_parser = TobiiJsonDataParser()
def __del__(self):
"""Stop data reception before destruction."""
self.close()
def __keep_alive(self):
"""Maintain connection."""
while not self.__stop_event.isSet():
self.__network.send_keep_alive_msg(self.__data_socket, self.__keep_alive_msg)
time.sleep(1)
def open(self):
"""Start data reception."""
self.__first_ts = 0
self.__keep_alive_thread.start()
threading.Thread.start(self)
def close(self):
"""Stop data reception definitively."""
self.__stop_event.set()
threading.Thread.join(self.__keep_alive_thread)
threading.Thread.join(self)
self.__data_socket.close()
def run(self):
"""Managed received data for sync and async reading case.
- Sync: send data to callback function.
- Async: store data into a locked queue for further reading."""
while not self.__stop_event.isSet():
# Sync reading case
if self.reading_callback != None:
# grab data
data = self.__network.grab_data(self.__data_socket)
# decode data
json_data = json.loads(data.decode('utf-8'))
# parse json into timestamped data object
data_ts, data_object, data_object_type = self.__parse_json_data(json_data)
self.reading_callback(data_ts, data_object, data_object_type)
# Async reading case
else:
# wait for queue reading
if self.__data_queue.full():
# sleep 1 micro second
time.sleep(0.0001)
continue
# lock data queue access
self.__read_lock.acquire()
# grab data
data = self.__network.grab_data(self.__data_socket)
# decode data
json_data = json.loads(data.decode('utf-8'))
# write data in queue
self.__data_queue.put(json_data)
# unlock data queue access
self.__read_lock.release()
def read(self):
# no data to read
if self.__data_queue.empty():
raise ValueError
# create a dictionary of timestamped data buffers
ts_data_buffer_dict = {
'DirSig': DataStructures.TimeStampedBuffer(),
'PresentationTimeStamp': DataStructures.TimeStampedBuffer(),
'VideoTimeStamp': DataStructures.TimeStampedBuffer(),
'EventSynch': DataStructures.TimeStampedBuffer(),
'Event': DataStructures.TimeStampedBuffer(),
'Accelerometer': DataStructures.TimeStampedBuffer(),
'Gyroscope': DataStructures.TimeStampedBuffer(),
'PupilCenter': DataStructures.TimeStampedBuffer(),
'PupilDiameter': DataStructures.TimeStampedBuffer(),
'GazeDirection': DataStructures.TimeStampedBuffer(),
'GazePosition': DataStructures.TimeStampedBuffer(),
'GazePosition3D': DataStructures.TimeStampedBuffer(),
'MarkerPosition': DataStructures.TimeStampedBuffer()
}
# if the data acquisition thread is not running
if self.__stop_event.isSet():
return ts_data_buffer_dict
# lock data queue access
self.__read_lock.acquire()
# search for earliest timestamp in the queue
earliest_ts = 0
# read data queue
while not self.__data_queue.empty():
# parse json into timestamped data object
data_ts, data_object, data_object_type = self.__parse_json_data(self.__data_queue.get())
# ignore negative timestamp
if data_ts < 0:
break
# keep earliest timestamp
if data_ts > earliest_ts:
earliest_ts = data_ts
# store data object into dedicated timestamped buffer
ts_data_buffer_dict[data_object_type][data_ts] = data_object
# unlock data queue access
self.__read_lock.release()
return earliest_ts, ts_data_buffer_dict
def __parse_json_data(self, json_data):
# parse data status
status = json_data.pop('s', -1)
# convert timestamp
data_ts = json_data.pop('ts')
# keep first timestamp to offset all timestamps
if self.__first_ts == 0:
self.__first_ts = data_ts
data_ts -= self.__first_ts
# convert json data into data object
data_object = self.__json_data_parser.parse_data(status, json_data)
data_object_type = type(data_object).__name__
return data_ts, data_object, data_object_type
|