-
Notifications
You must be signed in to change notification settings - Fork 0
/
KbWaitEyeTrack.m
178 lines (165 loc) · 7.38 KB
/
KbWaitEyeTrack.m
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
function [secs, keyCode, deltaSecs, gp] = KbWaitEyeTrack(deviceNumber, forWhat, untilTime, obj)
% [secs, keyCode, deltaSecs, gp] = KbWaitEyetrack([deviceNumber][, forWhat=0][, untilTime=inf])
%This is adapted from psychtoolbox code, you need psychtoolbox to run it.
%Notes for custom- so far, rt and length(gp) doesn't line up. Enabling the
%counter suggests that packets at the beginning or end are being missed,
%rather than packets being missed occasionally in the middle. Either its
%not collecting them quickly enough, or its not waiting long enough at the
%end. Turn on counter to test.
%
% Waits until any key is down and optionally returns the time in seconds
% and the keyCode vector of keyboard states, just as KbCheck would do. Also
% allows to wait for release of all keys or for single keystrokes, see
% below.
%
% If the optional parameter 'untilTime' is provided, KbWait will only wait
% until that time and then return regardless if anything happened on the
% keyboard or not.
%
% CAUTION: KbWait periodically checks the keyboard. After each failed check
% (ie. no change in keyboard state) it will wait for 5 msecs before the
% next check. This is done to reduce the load on your system, and it is
% important to do so. However if you want to measure reaction times this is
% clearly not what you want, as it adds up to 5 msecs extra uncertainty to
% all measurements!
%
% If you have trouble with KbWait always returning immediately, this could
% be due to "stuck keys". See "help DisableKeysForKbCheck" on how to work
% around this problem. See also "help RestrictKeysForKbCheck".
%
% GetChar and CharAvail are character oriented (and slow), whereas KbCheck
% and KbWait are keypress oriented (and fast).
%
% Using KbWait from the MATLAB command line: When you type "KbWait" at the
% prompt and hit the enter/return key to execute that command, then KbWait
% will detect the enter/return key press and return immediatly. If you
% want to test KbWait from the command line, then try this:
%
% WaitSecs(0.2);KbWait
%
% KbWait can also wait for releasing of keys instead of pressing of keys
% if you set the optional 2nd argument 'forWhat' to 1.
%
% If you want to wait for a single keystroke, set the 'forWhat' value to 2.
% KbWait will then first wait until all keys are released, then for the
% first keypress, then it will return. The above example could be realized
% via:
%
% KbWait([], 2);
%
% If you would set 'forWhat' to 3 then it would wait for releasing the key
% after pressing it againg, ie. waitForAllKeysReleased -> waitForKeypress
% -> waitForAllKeysReleased -> Return [secs, keyCode] of the key press.
%
%
% OSX and Linux: __________________________________________________________
%
% KbWait uses the PsychHID function, a general purpose function for
% reading from the Human Interface Device (HID) class of USB devices.
%
% KbWait tests the first USB-HID keyboard device by default. Optionally
% you can pass in a 'deviceNumber' to test a different keyboard if multiple
% keyboards are connected to your machine. If deviceNumber is -1, all
% keyboard devices will be checked. If deviceNumber is -2, all keypad
% devices (if any) will be checked. If deviceNumber is -3, all keyboard and
% keypad devices will be checked. The device numbers to be checked are
% determined only on the first call to the function. If these numbers
% change, the function can be reset using "clear KbWait".
%
% As a little bonus, KbWait can also query other HID human input devices
% which have keys or buttons as if they were keyboards. If you pass in the
% deviceIndex of a mouse (GetMouseIndices will provide with them), it will
% treat mouse button state as keyboard state. Similar behaviour usually
% works with Joysticks, Gamepads and other input controllers.
%
% _________________________________________________________________________
%
% See also: KbCheck, KbStrokeWait, KbPressWait, KbReleaseWait, GetChar, CharAvail, KbDemo.
% 3/6/97 dhb Wrote it.
% 8/2/97 dgp Explain difference between key and character. See KbCheck.
% 9/06/03 awi ****** OS X-specific fork from the OS 9 version *******
% Added OS X conditional.
% 7/12/04 awi Cosmetic. OS 9 Section. Uses IsOSX.
% 4/11/05 awi Added to help note about testing kbWait from command line.
% 11/29/05 mk Fixed really stupid bug: deviceNumber wasn't queried!
% 02/22/06 mk Modified for Linux: Currently a hack.
% 10/24/06 mk Replaced by a generic implementation that just uses KbCheck
% in a while loop. This way we directly benefit from KbChecks
% improvements.
% 3/15/07 kas Added in option to poll all keyboard devices by passing
% deviceNumber == -1
%
% 3/03/08 mk Added option 'forWhat' to optionally wait for key release
% or isolated keystrokes, and optional return argument 'keyCode'
% to return keyCode vector, just as KbCheck does.
%
% 12/27/09 mk Remove all the redundant code for 'deviceNumber' specific
% behaviour. This is already covered by code in KbCheck!
% This also fixes a bug reported in forum message 10468
% where KbReleaseWait(-1) didn't wait for all keys on all
% keyboards to be released.
% 12/18/09 rpw Added documentation about keypad devices on OS/X.
% 06/06/15 mk Fix treatment of empty forWhat argument. Suggested by Taylor Hanayik.
% Time (in seconds) to wait between "failed" checks, in order to not
% overload the system in realtime mode. 5 msecs seems to be an ok value...
yieldInterval = 0.005;
tic;
if nargin < 2 || isempty(forWhat)
forWhat = 0;
end
if nargin == 0
deviceNumber = [];
end
if nargin < 3
untilTime = inf;
end
if isempty(untilTime)
untilTime = inf;
end
% Wait for keystroke?
if (forWhat == 2) || (forWhat == 3)
% Wait for keystroke, ie., first make sure all keys are released, then
% wait for a keypress:
% Wait for key release. we know we have deviceNumber valid here:
KbWait(deviceNumber, 1, untilTime);
if forWhat == 2
% Now just go on with forWhat = 0, ie., wait for keypress:
forWhat = 0;
else
% Wait for keypress:
[secs, keyCode, deltaSecs] = KbWait(deviceNumber, 0, untilTime);
% Wait for key release. we know we have deviceNumber valid here:
KbWait(deviceNumber, 1, untilTime);
return;
end
end
secs = -inf;
counter = 1;
setState(obj, 'ENABLE_SEND_DATA', '1');
setState(obj, 'ENABLE_SEND_POG_FIX', '1');
gp = cell(10000,1);
while secs < untilTime
[isDown, secs, keyCode, deltaSecs] = KbCheck(deviceNumber);
if (get(obj.client_socket, 'BytesAvailable') > 0)
gp{counter} = fscanf(obj.client_socket);
end
if (isDown == ~forWhat) || (secs >= untilTime)
secs = toc;
setState(obj, 'ENABLE_SEND_POG_FIX', '0');
setState(obj, 'ENABLE_SEND_DATA', '0');
while (get(obj.client_socket, 'BytesAvailable') > 0)
counter = counter+1;
gp{counter} = fscanf(obj.client_socket);
end
return;
end
% A tribute to Windows: A useless call to GetMouse to trigger
% Screen()'s Windows application event queue processing to avoid
% white-death due to hitting the "Application not responding" timeout:
if IsWin
GetMouse;
end
% Wait for yieldInterval to prevent system overload.
secs = WaitSecs('YieldSecs', yieldInterval);
counter = counter+1;
end