sl@27
|
1 |
using System;
|
sl@27
|
2 |
using System.Windows.Forms;
|
sl@27
|
3 |
using System.Runtime.InteropServices;
|
sl@27
|
4 |
using System.Diagnostics;
|
sl@27
|
5 |
using System.Text;
|
sl@27
|
6 |
using Microsoft.Win32.SafeHandles;
|
sl@27
|
7 |
using Win32;
|
sl@27
|
8 |
using System.Collections.Generic;
|
sl@41
|
9 |
using System.Timers;
|
sl@27
|
10 |
|
sl@27
|
11 |
|
sl@27
|
12 |
namespace Hid
|
sl@27
|
13 |
{
|
sl@27
|
14 |
/// <summary>
|
sl@27
|
15 |
/// Represent a HID event.
|
sl@27
|
16 |
/// </summary>
|
sl@41
|
17 |
public class HidEvent: IDisposable
|
sl@27
|
18 |
{
|
sl@27
|
19 |
public bool IsValid { get; private set; }
|
sl@42
|
20 |
public bool IsForeground { get; private set; }
|
sl@27
|
21 |
public bool IsBackground { get{return !IsForeground;} }
|
sl@27
|
22 |
public bool IsMouse { get; private set; }
|
sl@27
|
23 |
public bool IsKeyboard { get; private set; }
|
sl@27
|
24 |
public bool IsGeneric { get; private set; }
|
sl@29
|
25 |
public bool IsButtonDown { get { return Usages.Count == 1 && Usages[0] != 0; } }
|
StephaneLenclud@49
|
26 |
public bool IsButtonUp { get { return Usages.Count == 0; } }
|
sl@44
|
27 |
public bool IsRepeat { get { return RepeatCount != 0; } }
|
sl@44
|
28 |
public uint RepeatCount { get; private set; }
|
sl@27
|
29 |
|
sl@27
|
30 |
public HidDevice Device { get; private set; }
|
sl@27
|
31 |
|
sl@27
|
32 |
public ushort UsagePage { get; private set; }
|
sl@27
|
33 |
public ushort UsageCollection { get; private set; }
|
sl@31
|
34 |
public uint UsageId { get { return ((uint)UsagePage << 16 | (uint)UsageCollection); } }
|
StephaneLenclud@49
|
35 |
public List<ushort> Usages { get; private set; }
|
StephaneLenclud@49
|
36 |
public byte[] InputReport { get; private set; }
|
StephaneLenclud@49
|
37 |
//
|
StephaneLenclud@49
|
38 |
public delegate void HidEventRepeatDelegate(HidEvent aHidEvent);
|
sl@41
|
39 |
public event HidEventRepeatDelegate OnHidEventRepeat;
|
sl@27
|
40 |
|
sl@41
|
41 |
private System.Timers.Timer Timer { get; set; }
|
sl@44
|
42 |
public DateTime Time { get; private set; }
|
sl@44
|
43 |
public DateTime OriginalTime { get; private set; }
|
sl@41
|
44 |
|
sl@43
|
45 |
//Compute repeat delay and speed based on system settings
|
sl@43
|
46 |
//Those computations were taken from the Petzold here: ftp://ftp.charlespetzold.com/ProgWinForms/4%20Custom%20Controls/NumericScan/NumericScan/ClickmaticButton.cs
|
sl@43
|
47 |
private int iRepeatDelay = 250 * (1 + SystemInformation.KeyboardDelay);
|
sl@43
|
48 |
private int iRepeatSpeed = 405 - 12 * SystemInformation.KeyboardSpeed;
|
sl@43
|
49 |
|
sl@42
|
50 |
/// <summary>
|
sl@42
|
51 |
/// Tells whether this event has already been disposed of.
|
sl@42
|
52 |
/// </summary>
|
sl@42
|
53 |
public bool IsStray { get { return Timer == null; } }
|
sl@42
|
54 |
|
sl@43
|
55 |
/// <summary>
|
sl@43
|
56 |
/// We typically dispose of events as soon as we get the corresponding key up signal.
|
sl@43
|
57 |
/// </summary>
|
sl@41
|
58 |
public void Dispose()
|
sl@41
|
59 |
{
|
sl@41
|
60 |
Timer.Enabled = false;
|
sl@41
|
61 |
Timer.Dispose();
|
sl@43
|
62 |
//Mark this event as a stray
|
sl@41
|
63 |
Timer = null;
|
sl@41
|
64 |
}
|
sl@27
|
65 |
|
sl@27
|
66 |
/// <summary>
|
sl@27
|
67 |
/// Initialize an HidEvent from a WM_INPUT message
|
sl@27
|
68 |
/// </summary>
|
sl@27
|
69 |
/// <param name="hRawInputDevice">Device Handle as provided by RAWINPUTHEADER.hDevice, typically accessed as rawinput.header.hDevice</param>
|
sl@41
|
70 |
public HidEvent(Message aMessage, HidEventRepeatDelegate aRepeatDelegate)
|
sl@27
|
71 |
{
|
sl@44
|
72 |
RepeatCount = 0;
|
sl@27
|
73 |
IsValid = false;
|
sl@27
|
74 |
IsKeyboard = false;
|
sl@27
|
75 |
IsGeneric = false;
|
sl@44
|
76 |
|
sl@27
|
77 |
|
sl@44
|
78 |
Time = DateTime.Now;
|
sl@44
|
79 |
OriginalTime = DateTime.Now;
|
sl@41
|
80 |
Timer = new System.Timers.Timer();
|
sl@44
|
81 |
Timer.Elapsed += (sender, e) => OnRepeatTimerElapsed(sender, e, this);
|
sl@27
|
82 |
Usages = new List<ushort>();
|
sl@41
|
83 |
OnHidEventRepeat += aRepeatDelegate;
|
sl@27
|
84 |
|
sl@27
|
85 |
if (aMessage.Msg != Const.WM_INPUT)
|
sl@27
|
86 |
{
|
sl@27
|
87 |
//Has to be a WM_INPUT message
|
sl@27
|
88 |
return;
|
sl@27
|
89 |
}
|
sl@27
|
90 |
|
sl@27
|
91 |
if (Macro.GET_RAWINPUT_CODE_WPARAM(aMessage.WParam) == Const.RIM_INPUT)
|
sl@27
|
92 |
{
|
sl@27
|
93 |
IsForeground = true;
|
sl@27
|
94 |
}
|
sl@27
|
95 |
else if (Macro.GET_RAWINPUT_CODE_WPARAM(aMessage.WParam) == Const.RIM_INPUTSINK)
|
sl@27
|
96 |
{
|
sl@27
|
97 |
IsForeground = false;
|
sl@27
|
98 |
}
|
sl@27
|
99 |
|
sl@27
|
100 |
//Declare some pointers
|
sl@27
|
101 |
IntPtr rawInputBuffer = IntPtr.Zero;
|
sl@27
|
102 |
//My understanding is that this is basically our HID descriptor
|
sl@27
|
103 |
IntPtr preParsedData = IntPtr.Zero;
|
sl@27
|
104 |
|
sl@27
|
105 |
try
|
sl@27
|
106 |
{
|
sl@27
|
107 |
//Fetch raw input
|
sl@27
|
108 |
RAWINPUT rawInput = new RAWINPUT();
|
sl@47
|
109 |
if (!Win32.Utils.RawInput.GetRawInputData(aMessage.LParam, ref rawInput, ref rawInputBuffer))
|
sl@27
|
110 |
{
|
sl@27
|
111 |
return;
|
sl@27
|
112 |
}
|
sl@27
|
113 |
|
sl@27
|
114 |
//Fetch device info
|
sl@27
|
115 |
RID_DEVICE_INFO deviceInfo = new RID_DEVICE_INFO();
|
sl@47
|
116 |
if (!Win32.Utils.RawInput.GetDeviceInfo(rawInput.header.hDevice, ref deviceInfo))
|
sl@27
|
117 |
{
|
sl@27
|
118 |
return;
|
sl@27
|
119 |
}
|
sl@27
|
120 |
|
sl@27
|
121 |
//Get various information about this HID device
|
sl@27
|
122 |
Device = new Hid.HidDevice(rawInput.header.hDevice);
|
sl@27
|
123 |
|
sl@27
|
124 |
if (rawInput.header.dwType == Const.RIM_TYPEHID) //Check that our raw input is HID
|
sl@27
|
125 |
{
|
sl@27
|
126 |
IsGeneric = true;
|
sl@27
|
127 |
|
sl@27
|
128 |
Debug.WriteLine("WM_INPUT source device is HID.");
|
sl@27
|
129 |
//Get Usage Page and Usage
|
sl@27
|
130 |
//Debug.WriteLine("Usage Page: 0x" + deviceInfo.hid.usUsagePage.ToString("X4") + " Usage ID: 0x" + deviceInfo.hid.usUsage.ToString("X4"));
|
sl@27
|
131 |
UsagePage = deviceInfo.hid.usUsagePage;
|
sl@27
|
132 |
UsageCollection = deviceInfo.hid.usUsage;
|
sl@27
|
133 |
|
sl@47
|
134 |
preParsedData = Win32.Utils.RawInput.GetPreParsedData(rawInput.header.hDevice);
|
sl@27
|
135 |
|
sl@27
|
136 |
if (!(rawInput.hid.dwSizeHid > 1 //Make sure our HID msg size more than 1. In fact the first ushort is irrelevant to us for now
|
sl@27
|
137 |
&& rawInput.hid.dwCount > 0)) //Check that we have at least one HID msg
|
sl@27
|
138 |
{
|
sl@27
|
139 |
return;
|
sl@27
|
140 |
}
|
sl@27
|
141 |
|
sl@27
|
142 |
//Allocate a buffer for one HID input
|
StephaneLenclud@49
|
143 |
InputReport = new byte[rawInput.hid.dwSizeHid];
|
sl@27
|
144 |
|
sl@27
|
145 |
Debug.WriteLine("Raw input contains " + rawInput.hid.dwCount + " HID input report(s)");
|
sl@27
|
146 |
|
sl@27
|
147 |
//For each HID input report in our raw input
|
sl@27
|
148 |
for (int i = 0; i < rawInput.hid.dwCount; i++)
|
sl@27
|
149 |
{
|
sl@27
|
150 |
//Compute the address from which to copy our HID input
|
sl@27
|
151 |
int hidInputOffset = 0;
|
sl@27
|
152 |
unsafe
|
sl@27
|
153 |
{
|
sl@27
|
154 |
byte* source = (byte*)rawInputBuffer;
|
sl@27
|
155 |
source += sizeof(RAWINPUTHEADER) + sizeof(RAWHID) + (rawInput.hid.dwSizeHid * i);
|
sl@27
|
156 |
hidInputOffset = (int)source;
|
sl@27
|
157 |
}
|
sl@27
|
158 |
|
sl@27
|
159 |
//Copy HID input into our buffer
|
StephaneLenclud@49
|
160 |
Marshal.Copy(new IntPtr(hidInputOffset), InputReport, 0, (int)rawInput.hid.dwSizeHid);
|
sl@27
|
161 |
|
sl@27
|
162 |
//Print HID input report in our debug output
|
StephaneLenclud@49
|
163 |
//string hidDump = "HID input report: " + InputReportString();
|
StephaneLenclud@49
|
164 |
//Debug.WriteLine(hidDump);
|
sl@27
|
165 |
|
StephaneLenclud@49
|
166 |
//Do proper parsing of our HID report
|
StephaneLenclud@49
|
167 |
//First query our usage count
|
StephaneLenclud@49
|
168 |
uint usageCount = 0;
|
StephaneLenclud@49
|
169 |
Win32.USAGE_AND_PAGE[] usages = null;
|
StephaneLenclud@49
|
170 |
Win32.HidStatus status = Win32.Function.HidP_GetUsagesEx(Win32.HIDP_REPORT_TYPE.HidP_Input, 0, usages, ref usageCount, preParsedData, InputReport, (uint)InputReport.Length);
|
StephaneLenclud@49
|
171 |
if (status == Win32.HidStatus.HIDP_STATUS_BUFFER_TOO_SMALL)
|
StephaneLenclud@49
|
172 |
{
|
StephaneLenclud@49
|
173 |
//Allocate a large enough buffer
|
StephaneLenclud@49
|
174 |
usages = new Win32.USAGE_AND_PAGE[usageCount];
|
StephaneLenclud@49
|
175 |
//...and fetch our usages
|
StephaneLenclud@49
|
176 |
status = Win32.Function.HidP_GetUsagesEx(Win32.HIDP_REPORT_TYPE.HidP_Input, 0, usages, ref usageCount, preParsedData, InputReport, (uint)InputReport.Length);
|
StephaneLenclud@49
|
177 |
if (status != Win32.HidStatus.HIDP_STATUS_SUCCESS)
|
StephaneLenclud@49
|
178 |
{
|
StephaneLenclud@49
|
179 |
Debug.WriteLine("Second pass could not parse HID data: " + status.ToString());
|
StephaneLenclud@49
|
180 |
}
|
StephaneLenclud@49
|
181 |
}
|
StephaneLenclud@49
|
182 |
else if (status != Win32.HidStatus.HIDP_STATUS_SUCCESS)
|
StephaneLenclud@49
|
183 |
{
|
StephaneLenclud@49
|
184 |
Debug.WriteLine("First pass could not parse HID data: " + status.ToString());
|
StephaneLenclud@49
|
185 |
}
|
StephaneLenclud@49
|
186 |
|
StephaneLenclud@49
|
187 |
Debug.WriteLine("Usage count: " + usageCount.ToString());
|
StephaneLenclud@49
|
188 |
|
StephaneLenclud@49
|
189 |
if (usages != null)
|
StephaneLenclud@49
|
190 |
{
|
StephaneLenclud@49
|
191 |
foreach (USAGE_AND_PAGE up in usages)
|
StephaneLenclud@49
|
192 |
{
|
StephaneLenclud@49
|
193 |
//Debug.WriteLine("UsagePage: 0x" + usages[0].UsagePage.ToString("X4"));
|
StephaneLenclud@49
|
194 |
//Debug.WriteLine("Usage: 0x" + usages[0].Usage.ToString("X4"));
|
StephaneLenclud@49
|
195 |
//Add this usage to our list
|
StephaneLenclud@49
|
196 |
Usages.Add(up.Usage);
|
StephaneLenclud@49
|
197 |
}
|
StephaneLenclud@49
|
198 |
}
|
sl@27
|
199 |
}
|
sl@27
|
200 |
}
|
sl@27
|
201 |
else if (rawInput.header.dwType == Const.RIM_TYPEMOUSE)
|
sl@27
|
202 |
{
|
sl@27
|
203 |
IsMouse = true;
|
sl@27
|
204 |
|
sl@27
|
205 |
Debug.WriteLine("WM_INPUT source device is Mouse.");
|
sl@27
|
206 |
// do mouse handling...
|
sl@27
|
207 |
}
|
sl@27
|
208 |
else if (rawInput.header.dwType == Const.RIM_TYPEKEYBOARD)
|
sl@27
|
209 |
{
|
sl@27
|
210 |
IsKeyboard = true;
|
sl@27
|
211 |
|
sl@27
|
212 |
Debug.WriteLine("WM_INPUT source device is Keyboard.");
|
sl@27
|
213 |
// do keyboard handling...
|
sl@27
|
214 |
Debug.WriteLine("Type: " + deviceInfo.keyboard.dwType.ToString());
|
sl@27
|
215 |
Debug.WriteLine("SubType: " + deviceInfo.keyboard.dwSubType.ToString());
|
sl@27
|
216 |
Debug.WriteLine("Mode: " + deviceInfo.keyboard.dwKeyboardMode.ToString());
|
sl@27
|
217 |
Debug.WriteLine("Number of function keys: " + deviceInfo.keyboard.dwNumberOfFunctionKeys.ToString());
|
sl@27
|
218 |
Debug.WriteLine("Number of indicators: " + deviceInfo.keyboard.dwNumberOfIndicators.ToString());
|
sl@27
|
219 |
Debug.WriteLine("Number of keys total: " + deviceInfo.keyboard.dwNumberOfKeysTotal.ToString());
|
sl@27
|
220 |
}
|
sl@27
|
221 |
}
|
sl@27
|
222 |
finally
|
sl@27
|
223 |
{
|
sl@27
|
224 |
//Always executed when leaving our try block
|
sl@27
|
225 |
Marshal.FreeHGlobal(rawInputBuffer);
|
sl@27
|
226 |
Marshal.FreeHGlobal(preParsedData);
|
sl@27
|
227 |
}
|
sl@27
|
228 |
|
sl@47
|
229 |
//
|
sl@47
|
230 |
if (IsButtonDown)
|
sl@41
|
231 |
{
|
StephaneLenclud@49
|
232 |
//TODO: Make this optional
|
sl@43
|
233 |
StartRepeatTimer(iRepeatDelay);
|
sl@41
|
234 |
}
|
sl@41
|
235 |
|
sl@27
|
236 |
IsValid = true;
|
sl@27
|
237 |
}
|
sl@27
|
238 |
|
sl@41
|
239 |
public void StartRepeatTimer(double aInterval)
|
sl@41
|
240 |
{
|
sl@41
|
241 |
if (Timer == null)
|
sl@41
|
242 |
{
|
sl@41
|
243 |
return;
|
sl@41
|
244 |
}
|
sl@41
|
245 |
Timer.Enabled = false;
|
sl@44
|
246 |
//Initial delay do not use auto reset
|
sl@44
|
247 |
//After our initial delay however we do setup our timer one more time using auto reset
|
sl@44
|
248 |
Timer.AutoReset = (RepeatCount!=0);
|
sl@44
|
249 |
Timer.Interval = aInterval;
|
sl@44
|
250 |
Timer.Enabled = true;
|
sl@41
|
251 |
}
|
sl@27
|
252 |
|
sl@44
|
253 |
static private void OnRepeatTimerElapsed(object sender, ElapsedEventArgs e, HidEvent aHidEvent)
|
sl@41
|
254 |
{
|
sl@42
|
255 |
if (aHidEvent.IsStray)
|
sl@42
|
256 |
{
|
sl@42
|
257 |
//Skip events if canceled
|
sl@42
|
258 |
return;
|
sl@42
|
259 |
}
|
sl@44
|
260 |
|
sl@44
|
261 |
aHidEvent.RepeatCount++;
|
sl@44
|
262 |
aHidEvent.Time = DateTime.Now;
|
sl@44
|
263 |
if (aHidEvent.RepeatCount==1)
|
sl@44
|
264 |
{
|
sl@44
|
265 |
//Re-Start our timer only after the initial delay
|
sl@44
|
266 |
aHidEvent.StartRepeatTimer(aHidEvent.iRepeatSpeed);
|
sl@44
|
267 |
}
|
sl@44
|
268 |
|
sl@44
|
269 |
//Broadcast our repeat event
|
sl@44
|
270 |
aHidEvent.OnHidEventRepeat(aHidEvent);
|
sl@41
|
271 |
}
|
sl@27
|
272 |
|
StephaneLenclud@49
|
273 |
/// <summary>
|
StephaneLenclud@49
|
274 |
/// Print information about this device to our debug output.
|
StephaneLenclud@49
|
275 |
/// </summary>
|
StephaneLenclud@49
|
276 |
public void DebugWrite()
|
StephaneLenclud@49
|
277 |
{
|
StephaneLenclud@49
|
278 |
if (!IsValid)
|
StephaneLenclud@49
|
279 |
{
|
StephaneLenclud@49
|
280 |
Debug.WriteLine("==== Invalid HidEvent");
|
StephaneLenclud@49
|
281 |
return;
|
StephaneLenclud@49
|
282 |
}
|
StephaneLenclud@49
|
283 |
Device.DebugWrite();
|
StephaneLenclud@49
|
284 |
if (IsGeneric) Debug.WriteLine("==== Generic");
|
StephaneLenclud@49
|
285 |
if (IsKeyboard) Debug.WriteLine("==== Keyboard");
|
StephaneLenclud@49
|
286 |
if (IsMouse) Debug.WriteLine("==== Mouse");
|
StephaneLenclud@49
|
287 |
Debug.WriteLine("==== Foreground: " + IsForeground.ToString());
|
StephaneLenclud@49
|
288 |
Debug.WriteLine("==== UsagePage: 0x" + UsagePage.ToString("X4"));
|
StephaneLenclud@49
|
289 |
Debug.WriteLine("==== UsageCollection: 0x" + UsageCollection.ToString("X4"));
|
StephaneLenclud@49
|
290 |
Debug.WriteLine("==== InputReport: 0x" + InputReportString());
|
StephaneLenclud@49
|
291 |
foreach (ushort usage in Usages)
|
StephaneLenclud@49
|
292 |
{
|
StephaneLenclud@49
|
293 |
Debug.WriteLine("==== Usage: 0x" + usage.ToString("X4"));
|
StephaneLenclud@49
|
294 |
}
|
StephaneLenclud@49
|
295 |
}
|
StephaneLenclud@49
|
296 |
|
StephaneLenclud@49
|
297 |
/// <summary>
|
StephaneLenclud@49
|
298 |
///
|
StephaneLenclud@49
|
299 |
/// </summary>
|
StephaneLenclud@49
|
300 |
/// <returns></returns>
|
StephaneLenclud@49
|
301 |
public string InputReportString()
|
StephaneLenclud@49
|
302 |
{
|
StephaneLenclud@49
|
303 |
string hidDump = "";
|
StephaneLenclud@49
|
304 |
foreach (byte b in InputReport)
|
StephaneLenclud@49
|
305 |
{
|
StephaneLenclud@49
|
306 |
hidDump += b.ToString("X2");
|
StephaneLenclud@49
|
307 |
}
|
StephaneLenclud@49
|
308 |
return hidDump;
|
StephaneLenclud@49
|
309 |
}
|
StephaneLenclud@49
|
310 |
|
StephaneLenclud@49
|
311 |
|
StephaneLenclud@49
|
312 |
/// <summary>
|
StephaneLenclud@49
|
313 |
/// Create a list view item describing this HidEvent
|
StephaneLenclud@49
|
314 |
/// </summary>
|
StephaneLenclud@49
|
315 |
/// <returns></returns>
|
sl@42
|
316 |
public ListViewItem ToListViewItem()
|
sl@42
|
317 |
{
|
StephaneLenclud@49
|
318 |
string usageText = "";
|
sl@42
|
319 |
|
StephaneLenclud@49
|
320 |
foreach (ushort usage in Usages)
|
StephaneLenclud@49
|
321 |
{
|
StephaneLenclud@49
|
322 |
if (usageText != "")
|
StephaneLenclud@49
|
323 |
{
|
StephaneLenclud@49
|
324 |
//Add a separator
|
StephaneLenclud@49
|
325 |
usageText += ", ";
|
StephaneLenclud@49
|
326 |
}
|
sl@42
|
327 |
|
StephaneLenclud@49
|
328 |
UsagePage usagePage = (UsagePage)UsagePage;
|
StephaneLenclud@49
|
329 |
switch (usagePage)
|
StephaneLenclud@49
|
330 |
{
|
StephaneLenclud@49
|
331 |
case Hid.UsagePage.Consumer:
|
StephaneLenclud@49
|
332 |
usageText += ((Hid.UsageTables.ConsumerControl)usage).ToString();
|
StephaneLenclud@49
|
333 |
break;
|
sl@42
|
334 |
|
StephaneLenclud@49
|
335 |
case Hid.UsagePage.WindowsMediaCenterRemoteControl:
|
StephaneLenclud@49
|
336 |
usageText += ((Hid.UsageTables.WindowsMediaCenterRemoteControl)usage).ToString();
|
StephaneLenclud@49
|
337 |
break;
|
StephaneLenclud@49
|
338 |
|
StephaneLenclud@49
|
339 |
default:
|
StephaneLenclud@49
|
340 |
usageText += usage.ToString("X2");
|
StephaneLenclud@49
|
341 |
break;
|
StephaneLenclud@49
|
342 |
}
|
StephaneLenclud@49
|
343 |
}
|
StephaneLenclud@49
|
344 |
|
StephaneLenclud@49
|
345 |
ListViewItem item = new ListViewItem(new[] { usageText, InputReportString(), UsagePage.ToString("X2"), UsageCollection.ToString("X2"), RepeatCount.ToString(), Time.ToString("HH:mm:ss:fff") });
|
sl@42
|
346 |
return item;
|
sl@42
|
347 |
}
|
sl@42
|
348 |
|
sl@27
|
349 |
}
|
sl@27
|
350 |
|
sl@27
|
351 |
} |