-
Notifications
You must be signed in to change notification settings - Fork 8
/
QDSpy_core.py
497 lines (427 loc) · 16.9 KB
/
QDSpy_core.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
QDSpy module - main program of command line-version of QDSpy
This is a simple Python software for scripting and presenting stimuli
for visual neuroscience. It is based on QDS, currently uses OpenGL via
pyglet for graphics. It primarly targets Windows, but may also run on
other operating systems
Copyright (c) 2013-2024 Thomas Euler
All rights reserved.
2022-08-03 - Adapt to LINUX
2022-08-06 - Some reformatting
2024-05-12 - Catch if `conda` is not installed
- Reformatted (using Ruff)
"""
# ---------------------------------------------------------------------
__author__ = "code@eulerlab.de"
import time
import sys
import gc
import os
import subprocess
import pickle
from multiprocessing import freeze_support
import QDSpy_global as glo
import QDSpy_stim as stm
import QDSpy_stim_support as ssp
import QDSpy_config as cnf
import QDSpy_core_presenter as cpr
import QDSpy_core_view as cvw
import QDSpy_core_support as csp
import QDSpy_multiprocessing as mpr
import QDSpy_gamma as gma
import QDSpy_probeCenter as pce
import Devices.digital_io as dio
if glo.QDSpy_use_Lightcrafter:
import Devices.lightcrafter as lcr
PLATFORM_WINDOWS = sys.platform == "win32"
# ---------------------------------------------------------------------
# Convenience functions
# ---------------------------------------------------------------------
def logGraphModuleInfo():
try:
import pyglet
ssp.Log.write("INFO", "{0:11}: v{1}".format("pyglet", pyglet.version))
import moviepy.version as mpv
ssp.Log.write("INFO", "{0:11}: v{1}".format("moviepy", mpv.__version__))
except ModuleNotFoundError:
ssp.Log.write("WARNING", "pyglet and/or moviepy not present")
# ---------------------------------------------------------------------
def setPerformanceHigh(_Conf):
if _Conf.disGC:
gc.disable()
if _Conf.incPP:
csp.setHighProcessPrior()
def setPerformanceNormal(_Conf):
if _Conf.incPP:
csp.setNormalProcessPrior()
if _Conf.disGC:
gc.enable()
# ---------------------------------------------------------------------
def loadStimulus(_fNameStim, _Stim):
if len(_fNameStim) == 0:
ssp.Log.write("FATAL", "No stimulus file name provided")
return False
try:
_Stim.load(_fNameStim)
return True
except: # noqa: E722
if _Stim.getLastErrC() != stm.StimErrC.ok:
_sErr = _Stim.getLastErrStr()
ssp.Log.write("FATAL", "Aborted ({0})".format(_sErr))
return False
# ---------------------------------------------------------------------
def connectLCrs(_Conf=None, _Stim=None):
if _Stim is not None and not _Stim.isUseLCr:
return []
if _Conf is None:
if not glo.QDSpy_use_Lightcrafter:
return []
else:
if not _Conf.useLCr:
return []
LCrList = lcr.enumerateLightcrafters()
LCrs = []
nLCrOk = 0
for iLCr, LCr in enumerate(LCrList):
LCrs.append(
lcr.Lightcrafter(
_isCheckOnly=False,
_funcLog=ssp.Log.write,
_logLevel=glo.QDSpy_LCr_LogLevel,
)
)
result = LCrs[iLCr].connect(iLCr)
if result[0] != lcr.ERROR.OK:
LCrs[iLCr] = None
else:
nLCrOk += 1
if nLCrOk == 0:
ssp.Log.write("WARNING", "This script requires a lightcrafter")
return LCrs
def disconnectLCrs(_LCrs):
for LCr in _LCrs:
if LCr is not None:
LCr.disconnect()
return []
# ---------------------------------------------------------------------
def switchGammaLUTByColorMode(_Conf, _View, _Stage, _Stim):
if _Conf.allowGammaLUT:
if _Stim is not None:
_modes = [stm.ColorMode.range0_1, stm.ColorMode.range0_255]
if _Stim.colorMode in _modes:
ssp.Log.write(" ", "Trying to set user-defined gamma LUT ...")
gma.setGammaLUT(_View.winPre._dc, _Stage.LUT_userDefined)
else:
ssp.Log.write(
" ",
"Special color mode (#{0}), setting linear "
" gamma LUT ...".format(_Stim.colorMode),
)
gma.setGammaLUT(_View.winPre._dc, _Stage.LUT_linDefault)
def restoreGammaLUT(_Conf, _View):
if _Conf.allowGammaLUT:
ssp.Log.write(" ", "Restoring linear gamma LUT ...")
gma.restoreGammaLUT(_View.winPre._dc)
# ---------------------------------------------------------------------
# MAIN
# _____________________________________________________________________
def main(_fNameStim, _isParentGUI, _Sync=None):
# Run a stimulus file.
#
if _isParentGUI:
ssp.Log.setGUISync(_Sync)
# Load configuration ...
#
_Conf = cnf.Config()
# Display startup message
#
ssp.Log.write(
"***", glo.QDSpy_versionStr + " Presenter - " + glo.QDSpy_copyrightStr
)
ssp.Log.write("ok", "Initializing ...")
ssp.Log.write(
" ",
"{0:11}: high process priority during presentation".format(
"ENABLED" if _Conf.incPP else "disabled"
),
)
ssp.Log.write(
" ",
"{0:11}: automatic garbage collection".format(
"DISABLED" if _Conf.disGC else "enabled"
),
)
# Log info about the relevant software packages
#
v = sys.version_info
txt = "{0}.{1}.{2}".format(v[0], v[1], v[2])
ssp.Log.write("INFO", "{0:11}: v{1}".format("Python", txt))
if PLATFORM_WINDOWS:
from distutils.spawn import find_executable # type: ignore
if find_executable("conda") is not None:
txt = subprocess.Popen(
"conda -V", shell=True, stdout=subprocess.PIPE
).stdout.read()
ssp.Log.write("INFO", "{0:11}: v{1}".format("Conda", txt.decode()[6:12]))
logGraphModuleInfo()
# Generate stage and stimulus instances, as well as a view instance
# (OpenGL window)
#
_Stage = _Conf.createStageFromConfig()
_Stim = stm.Stim()
_View = cvw.View(_Stage, _Conf)
_View.createStimulusWindow()
_Stage.logInfo()
# Update representation of lightcrafter hardware, if present
#
_Stage.createLEDs(_Conf)
_Stage.updateLEDs(_Conf)
# Initialize digital IO hardware, if requested
#
if _Conf.useDIO:
if _Conf.DIObrdType.upper() in ["ARDUINO"]:
_IO = dio.devIO_Arduino(
_Conf.DIObrd, glo.QDSpy_Arduino_baud, _funcLog=ssp.Log.write
)
ssp.Log.write(
"WARNING",
"Ensure that Arduino BAUD rate is {0}".format(glo.QDSpy_Arduino_baud),
)
else:
try:
ULID = dio.dictULDevices[_Conf.DIObrdType.upper()]
_IO = dio.devIO_UL(
ULID, _Conf.DIObrd, _Conf.DIOdev, _funcLog=ssp.Log.write
)
except KeyError:
_IO = None
if not (_IO):
ssp.Log.write("ERROR", "I/O hardware device name not recognized.")
elif not _IO.isReady:
ssp.Log.write(
"ERROR",
"I/O hardware could not be initialized. Set "
+ "`bool_use_digitalio` in `QDSpy.ini` to False.",
)
else:
# Configure I/O hardware
#
port = _IO.getPortFromStr(_Conf.DIOportOut)
_IO.configDPort(port, dio.devConst.DIGITAL_OUT)
_IO.writeDPort(port, 0)
port = _IO.getPortFromStr(_Conf.DIOportIn)
_IO.configDPort(port, dio.devConst.DIGITAL_IN)
port = _IO.getPortFromStr(_Conf.DIOportOut_User)
_IO.configDPort(port, dio.devConst.DIGITAL_OUT)
_IO.writeDPort(port, 0)
# Set user pins to the resting state
#
print(
_IO,
_Conf.DIOportOut_User,
int(_Conf.DIOpinUserOut1[0]),
int(_Conf.DIOpinUserOut1[2]),
)
csp.setIODevicePin(
_IO,
_Conf.DIOportOut_User,
int(_Conf.DIOpinUserOut1[0]),
int(_Conf.DIOpinUserOut1[2]) != 0,
False,
)
csp.setIODevicePin(
_IO,
_Conf.DIOportOut_User,
int(_Conf.DIOpinUserOut2[0]),
int(_Conf.DIOpinUserOut2[2]) != 0,
False,
)
else:
_IO = None
# Create a presenter instance
#
_Presenter = cpr.Presenter(_Stage, _IO, _Conf, _View)
if not _isParentGUI:
# Called from the command line - - - -- - - - - - - - - - - - - - -
#
# Load stimulus
#
if not loadStimulus(_fNameStim, _Stim):
sys.exit(0)
# Connect to lightcrafter, if required
#
_Presenter.LCr = connectLCrs(_Conf, _Stim)
# Present stimulus, with increased process priority and
# disabled automatic garbage collector, if requested
#
try:
_Presenter.prepare(_Stim)
setPerformanceHigh(_Conf)
try:
_Presenter.run()
except KeyboardInterrupt:
ssp.Log.write(" ", "Aborted by user.")
finally:
_Presenter.finish()
setPerformanceNormal(_Conf)
else:
# Called from the GUI - - - - - - - - - - -- - - - - - - - - - - -
#
# Notify GUI of display parameters
#
_Sync.pipeSrv.send([mpr.PipeValType.toCli_displayInfo, pickle.dumps(_Stage)])
# Start loop to process GUI (=client) requests
#
while _Sync.Request.value is not mpr.TERMINATING:
try:
# Check if new data is in the pipe
#
data = [mpr.PipeValType.toSrv_None]
if _Sync.pipeSrv.poll():
data = _Sync.pipeSrv.recv()
if data[0] == mpr.PipeValType.toSrv_changedStage:
# Stage parameter have changes, update immediately
#
_Stage.scalX_umPerPix = data[1]["scalX_umPerPix"]
_Stage.scalY_umPerPix = data[1]["scalY_umPerPix"]
_Stage.centOffX_pix = data[1]["centOffX_pix"]
_Stage.centOffY_pix = data[1]["centOffY_pix"]
_Stage.rot_angle = data[1]["rot_angle"]
_Stage.dxScr12 = data[1]["dxScr12"]
_Stage.dyScr12 = data[1]["dyScr12"]
_Stage.offXScr1_pix = data[1]["offXScr1_pix"]
_Stage.offYScr1_pix = data[1]["offYScr1_pix"]
_Stage.offXScr2_pix = data[1]["offXScr2_pix"]
_Stage.offYScr2_pix = data[1]["offYScr2_pix"]
data = [mpr.PipeValType.toSrv_None]
if data[0] == mpr.PipeValType.toSrv_changedLEDs:
# LED currents and/or enabled state have changes, update
# immediately
#
_Stage.LEDs = data[1][0]
_Stage.isLEDSeqEnabled = data[1][1]
_Stage.sendLEDChangesToLCr(_Conf)
data = [mpr.PipeValType.toSrv_None]
if data[0] == mpr.PipeValType.toSrv_checkIODev:
# Return readiness of IO device
#
_Sync.pipeSrv.send(
[
mpr.PipeValType.toCli_IODevInfo,
[_IO and _IO.isReady, dio.devConst.NONE, 0],
]
)
data = [mpr.PipeValType.toSrv_None]
if data[0] == mpr.PipeValType.toSrv_setIODevPins:
# Change IO device pins
#
csp.setIODevicePin(_IO, *data[1][0:4])
_Sync.pipeSrv.send(
[
mpr.PipeValType.toCli_IODevInfo,
[_IO and _IO.isReady, data],
]
)
data = [mpr.PipeValType.toSrv_None]
# Parse client's request
#
if _Sync.Request.value == mpr.PRESENTING:
if data[0] == mpr.PipeValType.toSrv_fileName:
# Retrieve stimulus file name from pipe and load stimulus
#
_fNameStim = os.path.normpath(data[1])
data = [mpr.PipeValType.toSrv_None]
loadStimulus(_fNameStim, _Stim)
_Sync.setStateSafe(mpr.PRESENTING)
# Run stimulus ...
#
try:
switchGammaLUTByColorMode(_Conf, _View, _Stage, _Stim)
_Presenter.LCr = connectLCrs(_Conf, _Stim)
_Presenter.prepare(_Stim, _Sync)
setPerformanceHigh(_Conf)
_Presenter.run()
finally:
_Presenter.LCr = disconnectLCrs(_Presenter.LCr)
_Presenter.finish()
setPerformanceNormal(_Conf)
else:
ssp.Log.write("DEBUG", "mpr.PRESENTING, unexpected client data")
_Sync.setStateSafe(mpr.IDLE)
elif _Sync.Request.value == mpr.COMPILING:
if data[0] == mpr.PipeValType.toSrv_fileName:
# Retrieve stimulus file name from pipe and compile stimulus
#
_fNameStim = os.path.abspath(data[1]) + ".py"
data = [mpr.PipeValType.toSrv_None]
_Sync.setStateSafe(mpr.COMPILING)
try:
subprocess.check_call(["python", _fNameStim])
ssp.Log.write("ok", "... done")
except subprocess.CalledProcessError:
ssp.Log.write("ERROR", "... failed.")
else:
ssp.Log.write("DEBUG", "mpr.COMPILING, unexpected client data")
_Sync.setStateSafe(mpr.IDLE)
elif _Sync.Request.value == mpr.PROBING:
if data[0] == mpr.PipeValType.toSrv_probeParams:
# Change into interactive probing mode ...
#
_Sync.setStateSafe(mpr.PROBING)
try:
switchGammaLUTByColorMode(_Conf, _View, _Stage, _Stim)
_Presenter.LCr = connectLCrs(_Conf, _Stim)
setPerformanceHigh(_Conf)
if data[1] == glo.QDSpy_probing_center:
# Currently only interactive center-probing is
# implemented
#
pce.probe_main(data[2], _Sync, _View, _Stage)
finally:
data = [mpr.PipeValType.toSrv_None]
_Presenter.LCr = disconnectLCrs(_Presenter.LCr)
_Presenter.finish()
setPerformanceNormal(_Conf)
else:
ssp.Log.write(
"DEBUG", "mpr.PROBE_CENTER, unexpected client data"
)
_Sync.setStateSafe(mpr.IDLE)
elif _Sync.Request.value not in [
mpr.CANCELING,
mpr.UNDEFINED,
mpr.IDLE,
]:
# Unknown request
#
ssp.Log.write(
"DEBUG", "Request {0} unknown".format(_Sync.Request.value)
)
if data[0] != mpr.PipeValType.toSrv_None:
ssp.Log.write("DEBUG", "unexpected client data left after loop")
finally:
# Clear request
#
_Sync.setRequestSafe(mpr.UNDEFINED)
# Dispatch events for the OpenGL window and sleep for a bit
#
"""
_View.dispatch_events()
"""
time.sleep(0.02) # 0.05
# Restore gamma LUT, if necessary
#
restoreGammaLUT(_Conf, _View)
# Clean up
#
_View.killWindows()
_Presenter.LCr = disconnectLCrs(_Presenter.LCr)
ssp.Log.write("ok", "... done")
# ---------------------------------------------------------------------
if __name__ == "__main__":
freeze_support()
args = cnf.getParsedArgv()
main(args.fNameStim, False)
# ---------------------------------------------------------------------