-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathQDSpy_core_presenter.py
1026 lines (899 loc) · 40.1 KB
/
QDSpy_core_presenter.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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
QDSpy module - interprets and presents compiled stimuli
'Presenter'
Presents a compiled stimulus.
This class is a graphics API independent.
Copyright (c) 2013-2024 Thomas Euler
Distributed under the terms of the GNU General Public License (GPL)
2022-08-06 - Some reformatting (partially)
2024-05-15 - Improved error message for movie errors
- Added the option to play sounds, e.g., at the start and
end of a stimulus presentation (see `QDSpy_global.py`)
2024-08-08 - New digital I/O device added ("RaspberryPi")
"""
# ---------------------------------------------------------------------
__author__ = "code@eulerlab.de"
import os
import pickle
import numpy as np
import PIL
import QDSpy_global as glo
import QDSpy_stim as stm
import QDSpy_stim_movie as mov
import QDSpy_stim_video as vid
import QDSpy_stim_draw as drw
import QDSpy_core_support as csp
import QDSpy_file_support as fsu
import QDSpy_core_shader as csh
from Libraries.log_helper import Log
import Libraries.multiprocess_helper as mpr
import Devices.digital_io as dio
if glo.QDSpy_isUseSound:
from Graphics.sounds import Sounds, SoundPlayer
global Clock
Clock = csp.defaultClock
# ---------------------------------------------------------------------
# Adjust global parameters depending on command line arguments
#
'''
args = cfg.getParsedArgv()
global QDSpy_verbose
QDSpy_verbose = args.verbose
if QDSpy_verbose:
# TODO
pass
'''
# =====================================================================
#
# ---------------------------------------------------------------------
class Presenter:
"""Presenter class
"""
def __init__(self, _Stage, _IO, _Conf, _View, _LCr=[]):
"""Initializing
"""
self.Stage = _Stage
self.IO = _IO
self.Conf = _Conf
self.View = _View
self.LCr = _LCr
self.pathQDSpy = fsu.getQDSpyPath()
self.ShManager = csh.ShaderManager(self.Conf, self.pathQDSpy)
self.useSound = glo.QDSpy_isUseSound
self.reset()
self.dtFr_meas_s = self.Stage.dtFr_s
self.dtFr_thres_s = self.dtFr_meas_s + self.Conf.maxDtTr_ms / 1000.0
# Prepare recording of stimulus presentation, if requested
if self.Conf.recordStim:
self.View.prepareGrabStim()
# Load sounds, if requested
if self.useSound:
Log.write("DEBUG", "Loading sounds ...")
self.SoundPlayer = SoundPlayer()
path = glo.QDSpy_pathSounds
self.SoundPlayer.add(
Sounds.OK,
fsu.getJoinedPath(path, glo.QDSpy_soundOk)
)
self.SoundPlayer.add(
Sounds.ERROR,
fsu.getJoinedPath(path, glo.QDSpy_soundError)
)
self.SoundPlayer.add(
Sounds.STIM_START,
fsu.getJoinedPath(path, glo.QDSpy_soundStimStart)
)
self.SoundPlayer.add(
Sounds.STIM_END,
fsu.getJoinedPath(path, glo.QDSpy_soundStimEnd)
)
Log.write("DEBUG", "... done")
else:
self.SoundPlayer = None
# Define event handler(s)
self.View.setOnKeyboardHandler(self.onKeyboard)
self.View.setOnDrawHandler(self.onDraw)
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def reset(self):
"""Reset presenter
"""
self.Stim = None
self.isReady = False
self.nFr = 0
self.is1FrOfSce = False
self.iSc = 0
self.isNextSce = True
self.isFirstSce = True
self.isEnd = False
self.isIdle = True
self.isUserAbort = False
self.isRunFromGUI = False
self.Sync = None
self.IO_portOut = dio.devConst.NONE
self.IO_portIn = dio.devConst.NONE
self.IO_maskMark = 0
self.IO_isMarkSet = False
self.ignoreFr = False # if waited for trigger
self.nFrTotal = 0 # # of frames rendered
self.tFrRel_s = 0.0 # current stimulus time (relative to stimulus start)
self.tFrRelOff_s = 0.0
self.avFrDur_s = 0.0
self.nRendTotal = 0 # # of scenes rendered (some scene have no duration!)
self.avPresDur_s = 0.0
self.avRendDur_s = 0.0
self.rendDur_s = 0.0
self.tFr = 0.0 # absolute stimulus time (from program start)
self.tStart = 0.0 # start of stimulus (from program start)
if glo.QDSpy_frRateStatsBufferLen > 0:
self.dataDtFr = np.zeros(glo.QDSpy_frRateStatsBufferLen, dtype=float)
else:
self.dataDtFr = []
self.dataDtFrLen = 0
self.dataDtFrOver = False
self.nDroppedFr = 0
self.isInLoop = False
self.nLoopRepeats = 0
self.iFirstLoopSc = -1
self.vertTr = np.array([], dtype=int) # temporary vertex arrays
self.iVertTr = np.array([], dtype=int) # temporary index arrays
self.vRGBTr = np.array([], dtype=np.uint8) # temporary RGBA arrays
self.vRGBTr2 = np.array([], dtype=np.uint8)
self.currShObjIDs = [] # list, IDs of current shader-enabled objects
self.prevShObjIDs = [] # list, IDs of previously shown shader-enabled objects
self.prevObjIDs = [] # list, previously shown objects (all)
self.ShProgList = [] # list, available shader programs (ready to bind)
self.MovieList = [] # list, movie class objects
self.MovieCtrlList = [] # list, movie control class objects
self.VideoList = [] # list, video class objects
self.VideoCtrlList = [] # list, video control class objects
self.markerVert, self.antiMarkerVert = drw.marker2vert(self.Stage, self.Conf)
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def onKeyboard(self, _key, _x, _y):
"""Handle key strokes when running in command line mode
"""
if not (self.isRunFromGUI) and _key in glo.QDSpy_KEY_KillPresent:
self.isUserAbort = True
self.stop()
# --------------------------------------------------------------------
# Scene rendering function
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def renderSce(self, _iSc, _nSc):
"""Renders the indexed scene
"""
if self.Conf.isTrackTime:
t0 = Clock.getTime_s()
sc = self.Stim.SceList[_iSc]
self._waitedForTrigger = False
drawn = True
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
if sc[stm.SC_field_type] == stm.StimSceType.awaitTTL and self.IO:
Log.write("INFO", "Waiting for trigger ...", _isProgress=True)
self.ignoreFr = True
while not self.isUserAbort:
# Continue if trigger pin is HIGH ...
if self.IO.readDPort(self.IO_portIn) > 0:
break
# Allow pyglect event to be processed to detect `q`
# in command line mode
self.View.Renderer.present(flip=False)
self.isUserAbort = self.isEnd
if self.Sync:
# Check if chanceling request arrived from the GUI
if self.Sync.Request.value in [mpr.CANCELING, mpr.TERMINATING]:
self.Sync.setStateSafe(mpr.CANCELING)
self.isUserAbort = True
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.beginLoop:
# Begin of a loop
self.isInLoop = True
self.nLoopRepeats = sc[stm.SC_field_nLoopTrials] - 1
self.iFirstLoopSc = _iSc + 1
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.endLoop:
# End of a loop
if not (self.isInLoop) or (self.nLoopRepeats < 0):
pass
if self.nLoopRepeats > 0:
self.iSc = self.iFirstLoopSc - 1
self.nLoopRepeats -= 1
else:
self.isInLoop = False
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.clearSce:
# Clear scene
self.View.clear()
if self.Stage.useScrOvl:
drawn = False
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.changeBkgCol:
# Change background color
self.View.clear(sc[stm.SC_field_BkgRGB])
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.sendCommandToLCr:
# Change LED currents
_params = sc[stm.SC_field_LCrParams]
if (
(_params[0] == stm.StimLCrCmd.setLEDCurrents)
and (_params[1] >= 0)
and (_params[1] < len(self.LCr))
):
self.LCr[_params[1]].setLEDCurrents(_params[2])
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.logUserParams:
# Write user parameters to the log file
_userParams = sc[stm.SC_field_userParams]
_userParams.update(stimFileName=self.Stim.fileName)
# **************************************
# **************************************
# TODO: Copy also external stimulus files (containing large
# lists or data structures) to the log directory
# **************************************
# **************************************
Log.write("DATA", _userParams.__str__())
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.changeShParams:
# Change shader parameters
_ShID = sc[stm.SC_field_ShID][0]
_iSh = self.Stim.ShDict[_ShID]
self.Stim.ShList[_iSh][stm.SH_field_Params] = sc[stm.SC_field_ShParams]
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.changeObjShader:
# Change object shader
for i in range(len(sc[stm.SC_field_IDs])):
_ObID = sc[stm.SC_field_IDs][i]
_iObj = self.Stim.ObjDict[_ObID]
_ShID = sc[stm.SC_field_ShIDs][i]
if _ShID < 0:
_iSh = -1
else:
_iSh = self.Stim.ShDict[_ShID]
self.Stim.ObjList[_iObj][stm.SO_field_shProgIndex] = _iSh
"""
SO_field_shProgIndex
newSce = [StimSceType.changeObjShader, -1, self.nSce, False,
_IDs, _shIDs]
SC_field_IDs = 4
SC_field_ShIDs = 5
#self.currIVShObjGr[0] = shd.ShaderBindGroup(shd.getStandardShader(), 0)
#self.currIVShObjGr[2] = shd.ShaderBindGroup(shd.getStandardShader(), 2)
newShader = [StimObjType.shader, _shID,
_shType, csh.SH_defaultParams[_shType], _shCode]
self.ShDict[_shID] = len(self.ShList)
self.ShList.append(newShader)
self.ShProgList
SH_field_type = 0
SH_field_ID = 1
SH_field_shaderType = 2
SH_field_Params = 3
SH_field_shaderCode = 4
newBox = [StimObjType.box, _ID,
(float(_dx_um), float(_dy_um)),
SO_defaultFgRGB, SO_defaultAlpha, SO_default_RGBAByVert,
_enShader, -1]
"""
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.startMovie:
# Start running movie ...
#
# Get movie object via movie ID
_MovID = sc[stm.SC_field_IDs][0]
_iMov = self.Stim.MovDict[_MovID]
movOb = self.MovieList[_iMov]
# Create a new movie control object; this internally creates a
# pyglet sprite, with the requested presentation properties
mCtOb = mov.MovieCtrl(sc[stm.SC_field_MovSeq], _MovID, _Movie=movOb)
mCtOb.iScr = sc[stm.SC_field_MovScreen]
mCtOb.setSpriteProperties(
sc[stm.SC_field_posXY],
sc[stm.SC_field_magXY],
sc[stm.SC_field_rot],
sc[stm.SC_field_MovTrans],
)
# Add the move control object to the list of active movies; remove
# previous one, if still present
iMC = 0
while iMC < len(self.MovieCtrlList):
if self.MovieCtrlList[iMC][3] == _MovID:
temp = self.MovieCtrlList.pop(iMC)
temp[0].kill()
else:
iMC += 1
self.MovieCtrlList.append([mCtOb, _iSc, self.nFrTotal, _MovID])
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.startVideo:
# Start running video ...
#
# Get video object via video ID
_VidID = sc[stm.SC_field_IDs][0]
_iVid = self.Stim.VidDict[_VidID]
vidOb = self.VideoList[_iVid]
# Create a new movie control object; this internally creates a
# pyglet sprite, with the requested presentation properties
vCtOb = vid.VideoCtrl(_Video=vidOb)
vCtOb.iScr = sc[stm.SC_field_VidScreen]
vCtOb.setSpriteProperties(
sc[stm.SC_field_posXY],
sc[stm.SC_field_magXY],
sc[stm.SC_field_rot],
sc[stm.SC_field_VidTrans],
)
# Add the video control object to the list of active videos; remove
# previous one, if still present
iVC = 0
while iVC < len(self.VideoCtrlList):
if self.VideoCtrlList[iVC][3] == _VidID:
temp = self.VideoCtrlList.pop(iVC)
temp[0].kill()
else:
iVC += 1
self.VideoCtrlList.append([vCtOb, _iSc, self.nFrTotal, _VidID])
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elif sc[stm.SC_field_type] == stm.StimSceType.renderSce:
# Render objects in scene
self.View.clear()
if self.Stim.cScOList[_iSc][0] >= 0:
if self.is1FrOfSce: # _________________________________________
# First frame of a new scene: Get index of object drawing list of
# this scene and then get vertex data (or reuse previous data, if
# nothing has changed)
iODr, ObjNewMask, ObjIDs, ObjPosXY, ObjRot = self.Stim.cScOList[_iSc]
nObjs = len(self.Stim.cODr_tr_iVert[iODr])
ObjNewMask = np.array(ObjNewMask)
# Generate pyglet Groups to bind shaders to objects, if required
self.Batch.delete_shader_handles()
for iObj, ObjID in enumerate(ObjIDs):
if ObjID < 0:
continue
iObjList = self.Stim.ObjDict[ObjID]
iSh = self.Stim.ObjList[iObjList][stm.SO_field_shProgIndex]
if iSh >= 0:
# Create Group object referencing to requested shader and set
# shader parameters (uniforms)
shPar = self.Stim.ShList[iSh][stm.SH_field_Params]
shType = self.Stim.ShList[iSh][stm.SH_field_shaderType]
self.Batch.add_shader_handle(
ObjID, self.ShProgList[iSh], shType
)
x = ObjPosXY[iObj][0] + self.Stage.dxScr
y = ObjPosXY[iObj][1] + self.Stage.dyScr
a_rad = (ObjRot[iObj] + 90.0) * np.pi / 180.0
self.tFrRelOff_s = self.tFrRel_s
self.Batch.set_shader_time(ObjID, 0.0)
self.Batch.set_shader_parameters(
ObjID, [x, y], a_rad, shPar
)
else:
# No shader
self.Batch.add_shader_handle(ObjID)
# Check if vertex list(s) need(s) to be updated or re-created
#
# self.Stim.cODr_tr_xxx[iODr][iObj][0] := SC_vertDataChanged or not
# self.Stim.cODr_tr_xxx[iODr][iObj][1] := Object ID or -1
# self.Stim.cODr_tr_xxx[iODr][iObj][2] := numpy array with data
#
# Kill vertex data of previous shader-enabled objects
self.currShObjIDs = []
self.Batch.delete_shader_object_data()
for iObj in range(nObjs):
self.iVertTr = self.Stim.cODr_tr_iVert[iODr][iObj][2]
self.vertTr = self.Stim.cODr_tr_vertCoord[iODr][iObj][2]
self.vRGBATr = self.Stim.cODr_tr_vertRGBA[iODr][iObj][2]
self.vRGBATr2 = self.Stim.cODr_tr_vertRGBA2[iODr][iObj][2]
if iObj == 0:
# Not shader-enabled objects ...
if ObjNewMask[iObj] == stm.SC_ObjNewAll:
self.Batch.replace_object_data(
self.iVertTr,
self.vertTr,
self.vRGBATr,
self.vRGBATr2,
)
else:
if (ObjNewMask[iObj] & stm.SC_ObjNewiVer) > 0:
self.Batch.replace_object_data_indices(self.iVertTr)
if (ObjNewMask[iObj] & stm.SC_ObjNewVer) > 0:
self.Batch.replace_object_data_vertices(self.vertTr)
if (ObjNewMask[iObj] & stm.SC_ObjNewRGBA) > 0:
self.Batch.replace_object_data_colors(
self.vRGBATr, self.vRGBATr2
)
else:
# For each shader-enabled object ...
self.currShObjIDs.append(ObjIDs[iObj])
self.Batch.add_shader_object_data(
ObjIDs[iObj],
self.iVertTr,
self.vertTr,
self.vRGBATr,
self.vRGBATr2,
)
self.prevShObjIDs = self.currShObjIDs
self.prevObjIDs = ObjIDs
else: # ______________________________________________________
# Not first frame of a new scene, just update the shader
# parameters, if any, ...
self.Batch.set_shader_time_all(self.tFrRel_s - self.tFrRelOff_s)
# Indicate that the batch needs to be drawn
drawn = False
if (_nSc > 0) and (
not drawn or (len(self.MovieCtrlList) > 0) or (len(self.VideoCtrlList) > 0)
):
# Keep movie control objects updated: Advance or kill, if finished
iMC = 0
while iMC < len(self.MovieCtrlList):
mCtOb, iScWhenStarted, iFrWhenStarted, ID = self.MovieCtrlList[iMC]
if iScWhenStarted == _iSc:
# Don't start playing the movie if we are still in the no-duration
# scene that started the movie
"""
_log.Log.write("DEBUG", "Movie #{0} ID{1} ready, _iSc={2} iFr={3}"
.format(iMC, mCtOb.ID, _iSc, self.nFrTotal))
"""
iMC += 1
continue
res = mCtOb.getNextFrIndex()
if res < 0:
"""
_log.Log.write("DEBUG", "Movie #{0} ID{1} last, _iSc={1} nFr={2}"
.format(iMC, mCtOb.ID, _iSc, self.nFrTotal -iFrWhenStarted))
"""
mCtOb, iScWhenStarted, iFrWhenStarted, ID = self.MovieCtrlList.pop(iMC)
mCtOb.kill()
else:
mCtOb.setSpriteBatch(self.Batch)
iMC += 1
# Keep video control objects updated: Advance or kill, if finished
iVC = 0
while iVC < len(self.VideoCtrlList):
vCtOb, iScWhenStarted, iFrWhenStarted, ID = self.VideoCtrlList[iVC]
if iScWhenStarted == _iSc:
# Don't start playing the video if we are still in the no-duration
# scene that started the video
iVC += 1
continue
res = vCtOb.getNextFrIndex()
if res < 0:
vCtOb, iScWhenStarted, iFrWhenStarted, ID = self.VideoCtrlList.pop(iVC)
vCtOb.kill()
else:
vCtOb.setSpriteBatch(self.Batch)
iVC += 1
# Draw current triangle vertices, acknowledging the scaling and
# rotation of the current display (stage settings)
self.Batch.draw(
self.Stage, self.View, sc[stm.SC_field_type] == stm.StimSceType.clearSce
)
# Show marker, if requested and present in the current scene
if self.Conf.markShowOnScr:
if sc[stm.SC_field_marker]:
self.Batch.add_rect_data(self.markerVert)
else:
self.Batch.add_rect_data(self.antiMarkerVert)
# Track rendering timing, if requested and not waited for trigger
if self.Conf.isTrackTime:
'''
if self.ignoreFr:
self.rendDur_s = self.avRendDur_s
else:
'''
self.rendDur_s = Clock.getTime_s() - t0
self.avRendDur_s += self.rendDur_s
self.nRendTotal += 1
# --------------------------------------------------------------------
# Frame refresh handler
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def onDraw(self):
"""Frame refresh handler
"""
# Check if stimulus is defined
if self.Stim is None:
self.View.clear()
self.isEnd = True
if self.isIdle:
# Stimulus has already ended; nothing to do ...
Log.write("DEBUG", "Presenter.onDraw(), isIdle=True")
self.finish()
return
# If run from GUI (as server) ...
if self.isRunFromGUI:
# Check if GUI requests abort ...
if self.Sync.Request.value in [mpr.CANCELING, mpr.TERMINATING]:
self.Sync.setStateSafe(mpr.CANCELING)
self.isUserAbort = True
self.stop()
if self.Sync.pipeSrv.poll():
data = self.Sync.pipeSrv.recv()
if data[0] == mpr.PipeValType.toSrv_changedStage:
# Stage properties were adjusted by the user, reflect
# immediately in the stimulus presentation
self.Stage.scalX_umPerPix = data[1]["scalX_umPerPix"]
self.Stage.scalY_umPerPix = data[1]["scalY_umPerPix"]
self.Stage.centOffX_pix = data[1]["centOffX_pix"]
self.Stage.centOffY_pix = data[1]["centOffY_pix"]
self.Stage.rot_angle = data[1]["rot_angle"]
self.Stage.dxScr12 = data[1]["dxScr12"]
self.Stage.dyScr12 = data[1]["dyScr12"]
self.Stage.offXScr1_pix = data[1]["offXScr1_pix"]
self.Stage.offYScr1_pix = data[1]["offYScr1_pix"]
self.Stage.offXScr2_pix = data[1]["offXScr2_pix"]
self.Stage.offYScr2_pix = data[1]["offYScr2_pix"]
if data[0] == mpr.PipeValType.toSrv_changedLEDs:
# User changed LED currents and/or toggled LEDs, notify
# lightcrafter immediately
self.Stage.LEDs = data[1][0]
self.Stage.isLEDSeqEnabled = data[1][1]
self.Stage.sendLEDChangesToLCr(self.Conf)
if data[0] == mpr.PipeValType.toSrv_setIODevPins:
# User pressed a user button, change IO device pins accordingly
csp.setIODevicePin(self.IO, data[1][0], data[1][1], data[1][2])
# Send time info back to client (GUI)
self.Sync.pipeSrv.send(
[mpr.PipeValType.toCli_time, self.tFrRel_s, self.nFrTotal]
)
# Render scene
while self.isNextSce and not self.isEnd:
# Load next scene ...
if not self.isFirstSce:
# Increase scene index and check for end of stimulus ...
self.iSc += 1
self.isEnd = self.iSc >= len(self.Stim.SceList)
if self.isEnd:
break
else:
# ... except it is the first scene
self.isFirstSce = False
self.tStart = Clock.getTime_s()
self.nFr = self.Stim.cScDurList[self.iSc]
self.is1FrOfSce = True
if self.nFr <= 0:
# Scene w/o duration, handle immediately
self.renderSce(self.iSc, self.nFr)
self.isNextSce = True
else:
# Scene has a duration, handle it below
self.isNextSce = False
if self.isEnd:
# No more scenes to display or aborted by used, in any case,
# end presentation
isDone = self.iSc >= len(self.Stim.SceList)
if self.Sync:
self.Sync.pipeSrv.send(
[mpr.PipeValType.toCli_playEndInfo, isDone]
)
Log.write("ok", "Done" if isDone else "Aborted by user")
Log.write(
"DATA",
{
"stimFileName": self.Stim.fileName,
"stimState": "FINISHED" if isDone else "ABORTED",
}.__str__(),
)
self.Stim = None
self.isIdle = True
return
if self.nFr > 0:
# Scene has a duration, handle it ...
self.renderSce(self.iSc, self.nFr)
self.nFr -= 1
self.is1FrOfSce = False
self.isNextSce = self.nFr == 0
# Determine if marker should be shown ...
# ************
# TODO: first read port to be able to set/clear only the needed
# pin
# ************
isMaskChanged = False
if self.IO is not None:
if self.Stim.cScMarkList[self.iSc] > 0:
# ...
maskMark = self.IO_maskMark
isMaskChanged = True
self.IO_isMarkSet = True
else:
if self.IO_isMarkSet:
# ...
maskMark = 0
isMaskChanged = True
self.IO_isMarkSet = False
# Flip display buffer ...
t1 = Clock.getTime_s()
self.View.present()
self.avPresDur_s += Clock.getTime_s() - t1
# Send marker signal, if needed
if isMaskChanged:
self.IO.writeDPort(self.IO_portOut, maskMark)
# Record stimulus presentation, if requested
if self.recordStim:
if self.nFrTotal % self.Conf.rec_f_downsample_t == 0:
stimframe = self.View.grabStimFrame()
self.recordedStim.append(stimframe)
# Keep track of refresh duration
if self.Conf.isTrackTime:
if self.nFrTotal == 0:
self.tFr = Clock.getTime_s()
else:
t0 = Clock.getTime_s()
if self.ignoreFr:
# Ignore frame duration because the program waited
# for a trigger
# TODO: Correct calculation of rendering duration
self.ignoreFr = False
dt = 0
else:
dt = t0 - self.tFr
self.avFrDur_s += dt
self.tFr = t0
self.dataDtFr[self.dataDtFrLen] = dt
self.dataDtFrLen += 1
if self.dataDtFrLen >= self.dataDtFr.size:
self.dataDtFrOver = True
self.dataDtFrLen = 0
if self.Conf.isWarnFrDrop and (dt > self.dtFr_thres_s):
self.nDroppedFr += 1
Log.write(
"WARNING",
f"dt of frame #{self.nFrTotal} was "
f"{dt * 1000.0:.3f} ms"
)
self.nFrTotal += 1
self.tFrRel_s = self.nFrTotal * self.Stage.dtFr_s
# --------------------------------------------------------------------
def run(self):
"""Runs the OpenGL/pyglet event loop, thereby any loaded stimulus
"""
if not self.isReady:
return
if self.Stim is None:
Log.write("ok", "Ready.")
return
# Signal start of presentation
if self.useSound:
self.SoundPlayer.play(Sounds.STIM_START)
# Start stimulus ...
self.isEnd = False
Log.write("ok", "Running...")
Log.write(
"DATA",
{
"stimFileName": self.Stim.fileName,
"stimState": "STARTED",
"stimMD5": self.Stim.md5Str,
}.__str__(),
)
# Prepare recording stimulus if requested
self.recordStim = (
self.Conf.recordStim
and self.Stim is not None
and not self.Stim.nameStr.startswith("__")
)
if self.recordStim:
self.View.prepareGrabStim()
self.recordedStim = []
self.recordedStimName = self.Stim.nameStr
self.Stage.logData()
self.View.startRenderingLoop(self)
if self.recordStim:
self.save_stim_to_file()
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def stop(self):
"""Signals event loop to stop
"""
self.isEnd = True
Log.write("DEBUG", "Presenter.stop()")
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def finish(self):
"""Finish presentation
"""
if not self.isReady:
return
if self.isUserAbort:
# Clear screen
self.View.clear()
self.View.present()
Log.write("ABORT", "User aborted program")
else:
Log.write("ok", "Program finished")
# Log timing information
if self.Conf.isTrackTime:
self.avRendDur_s = self.avRendDur_s / self.nRendTotal
self.avPresDur_s = self.avPresDur_s / self.nRendTotal
self.avFrDur_s = self.avFrDur_s / self.nFrTotal
if self.avFrDur_s > 0:
sFreq = f"{1 /self.avFrDur_s:.3f}"
else:
sFreq = "n/a"
Log.write(
"INFO",
f"{self.avFrDur_s * 1000.0:.3f} ms/frame ({sFreq} Hz), "
f"rendering: {self.avRendDur_s * 1000.0:.3f} ms/frame "
f"({self.nFrTotal} frames in total)"
)
Log.write(
"INFO",
f"presenting: {self.avPresDur_s * 1000.0:.3f} ms/frame"
)
if glo.QDSpy_frRateStatsBufferLen > 0:
if not self.dataDtFrOver:
data = self.dataDtFr[: self.dataDtFrLen]
else:
data = self.dataDtFr
else:
data = np.array(self.dataDtFr)
av = data.mean() * 1000.0
std = data.std() * 1000.0
Log.write(
"INFO",
f"{av:.3f} +/- {std:.3f} ms/frame (over the last "
f"{len(data)} frames) = {1000.0 / av:.3} Hz"
)
if self.nDroppedFr > 0:
pcDrFr = 100.0 * self.nDroppedFr / self.nFrTotal
Log.write(
"WARNING",
f"{self.nDroppedFr} frames dropped "
f"(={pcDrFr:.3f} %)"
)
Log.write(
"DATA",
{
"avgFreq_Hz": 0 if self.avFrDur_s == 0 else 1 / self.avFrDur_s,
"nFrames": self.nFrTotal,
"nDroppedFrames": self.nDroppedFr,
}.__str__(),
)
# Signal end of presentation
if self.useSound:
self.SoundPlayer.play(Sounds.STIM_END)
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@staticmethod
def stim_to_pil_image(
image, f_downsample: int = 1
) -> PIL.Image.Image:
"""Convert a stimulus frame into a PIL image
"""
img_data = image.get_data()
pil_image = PIL.Image.new(mode="RGBA", size=(image.width, image.height))
pil_image.frombytes(img_data)
if f_downsample > 1:
pil_image = pil_image.resize(
tuple(s // f_downsample for s in pil_image.size)
)
pil_image = pil_image.convert("RGB")
pil_image = pil_image.transpose(PIL.Image.Transpose.FLIP_TOP_BOTTOM)
return pil_image
@staticmethod
def adapt_stimulus_recording_to_setup(
stimulus_stack: np.array, setup_id: int
) -> np.array:
"""Tweak stimulus according to
https://cin-10.medizin.uni-tuebingen.de/eulerwiki/index.php/Orientation
stimulus_stack.shape: frame, y, x, color
"""
# For both setups the x and y plane is swapped
if setup_id == 1:
# Swap x and y
stimulus_stack = stimulus_stack.transpose(0, 2, 1, 3)
elif setup_id == 3:
# Swap x and y
stimulus_stack = stimulus_stack.transpose(0, 2, 1, 3)
# flip direction in y-axis
stimulus_stack = np.flip(stimulus_stack, axis=1)
else:
raise ValueError(f"Unknown setup: {setup_id=}")
return stimulus_stack
def save_stim_to_file(self) -> None:
"""Save (downsampled) stimulus to file
"""
Log.write(
"DEBUG", f"Prepare saving {len(self.recordedStim)} stimulus frames"
)
stim_folder = "RecordedStimuli"
if not os.path.isdir(stim_folder):
os.mkdir(stim_folder)
pil_image_array = [
self.stim_to_pil_image(s, f_downsample=self.Conf.rec_f_downsample_x)
for s in self.recordedStim
]
recorded_stimulus_stack = np.stack(pil_image_array)
if self.Conf.rec_setup_id is not None:
recorded_stimulus_stack = self.adapt_stimulus_recording_to_setup(
recorded_stimulus_stack, self.Conf.rec_setup_id
)
file_name = f"{stim_folder}/{self.recordedStimName}.pickle"
with open(file_name, "wb") as file:
pickle.dump(recorded_stimulus_stack, file, protocol=pickle.HIGHEST_PROTOCOL)
Log.write("DEBUG", f"Successfully saved stimulus recording to {file_name}")
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def prepare(self, _Stim, _Sync=None, _vol=0):
"""Prepare a stimulus, to be started with the run() function
"""
self.reset()
self.Stim = _Stim
self.isReady = True
if _Sync is not None:
self.isRunFromGUI = True
self.Sync = _Sync
if self.Stim is None:
self.isReady = False
else:
# Set sound volume, if requested
if self.useSound:
self.SoundPlayer.setVol(_vol)
# Setup digital I/O, if used
if self.IO is not None:
self.IO_portOut = self.IO.getPortFromStr(self.Conf.DIOportOut)
self.IO_maskMark = 0x01 << self.Conf.DIOpinMarker
# Load and generate shader(s), if any
self.ShProgList = []
if not glo.QDSpy_loadShadersOnce:
self.ShManager = csh.ShaderManager(self.Conf)
if len(self.Stim.ShList) > 0:
for iSh, Sh in enumerate(self.Stim.ShList):
shType = Sh[stm.SH_field_shaderType]
if shType in self.ShManager.getShaderTypes():
# Create shader program
shader = self.ShManager.createShader(shType)
if shader is not None:
self.ShProgList.append(shader)
else:
self.isReady = False
Log.write(
"ERROR",
f"Stimulus '{_Stim.nameStr}' uses shader "
f"'{shType}' that could not be compiled"
)
else:
# A shaders that is not in the shader folder is required
self.isReady = False
Log.write(
"ERROR",
f"Stimulus '{_Stim.nameStr}' uses shader "
f"'{shType}' that cannot be found"
)
# Load movie files, if any
self.MovieList = []
if len(self.Stim.MovList) > 0:
for Mov in self.Stim.MovList:
movOb = mov.Movie(self.Conf)
res = movOb.load(self.Conf.pathStim + Mov[stm.SM_field_movieFName])
if res == stm.StimErrC.ok:
# Add movie class object to list
self.MovieList.append(movOb)
else:
# The movie file(s) could not be loaded
self.isReady = False
Log.write(
"ERROR",
f"Attempting to load stimulus '{_Stim.nameStr}' "
f"(w/ '{Mov[stm.SM_field_movieFName]}') "
f"resulted in `{stm.StimErrStr[res]}`"
)
# Load videos, if any
self.VideoList = []
if len(self.Stim.VidList) > 0:
for Vid in self.Stim.VidList:
vidOb = vid.Video(self.Conf)
res = vidOb.load(self.Conf.pathStim + Vid[stm.SV_field_videoFName])