「Raw Input API」を使用してバックグラウンドアプリケーションを制御するユーザー入力をリッスンします

おそらく、Ctrl + CとCtrl + Vが何であるかを知らない人はほとんどいないでしょう。 より経験豊富なユーザーは、一般的に使用されるアプリケーションのホットキーを知っています。 より複雑な組み合わせを使用する人もいます。たとえば、プレーヤーをバックグラウンドで制御するためです。 開発者にとって、そのような機能の実装は通常それほど大きな問題を引き起こしません。 このタスクは広く行われており、そのソリューションについてはすでに多くのことが書かれています。 しかし、ジョイスティックまたはプレゼンターからのユーザー入力を最小限に抑え、イベントの発生元のデバイスを把握する必要がある場合はどうでしょうか？ 正直に言うと、私たちにとってこのタスクは新しいものであることが判明しました。 猫の下で、「 Raw Input API 」を使用してWPFアプリケーションのC＃でどのように解決したかを説明します 。

背景

Jalinga Studioアプリケーションは、ビデオ、ウェビナー、およびオンラインブロードキャストの撮影に使用され、主にプレゼンターまたはジョイスティックを使用して制御されます（これが必要な理由については、前の記事「プレゼンテーションをアニメーション化する方法」を参照してください）。 ほとんどのプレゼンターはPower Pointで動作するように設計されているため、F5、Page Up、Page Downなどの通常のキーボード入力を生成します。 WPFには、キーボード入力を操作するための標準メカニズムがあります。 重大な欠点に遭遇するまで、初めて使用しました。 実際、このメカニズムはアプリケーションがアクティブ（フォアグラウンド）の場合にのみ機能しますが、一部のクライアントは、たとえばブラウザー入力やキーボード入力を確実に奪う別のプログラムへのアクセスを望んでいます。 最初に、Skypeで行われた方法と同様に、フォアグラウンドに追加の小さなウィンドウを作成して、この問題を回避しようとしました。 ユーザーがマウスを制御する方が便利な場合、このウィンドウにはプログラムのステータスと制御用のいくつかのボタンが表示されます。 このアプローチは最も便利ではありませんでした-コントロールウィンドウをアクティブにする必要があります。 ユーザーがフォーカスを切り替えるのを忘れた場合、プレゼンターからのキーボード入力は現在アクティブなアプリケーションに行きました。 たとえば、ブラウザのF5またはPage Downです。 これに加えて、ある時点でプレゼンターのボタンを見逃し始め、標準のWPFメカニズムではサポートされていないジョイスティックを使用することにしました。

ソリューションを検索する

まず、新しいメカニズムの要件を策定しました。

• アプリケーションがバックグラウンドで実行されている場合、ユーザー入力に関する情報を受け取ります。
  
  
• プレゼンター、ジョイスティック、ゲームパッドと連携する機能。
  
  
• 入力デバイスを区別する方法の存在。
  
  

最初に思いついたのは、 SetWindowsHookEx関数を使用して設定できるフックです。 しかし、ここでもジョイスティックとゲームパッドをサポートするという問題は未解決のままです。 キーロガー、他の人のプログラムの動作に対するフックの影響、32ビットおよび64ビットdllの作成、別のプロセスからのアプリケーションとの相互作用、およびサポートの一般的な複雑さについて、私たちを連れて行ってくれるアンチウイルスについては沈黙しています。



DirectInputまたはXInputの使用を検討。 DirectInputは非推奨です; 代わりにXInputを使用することをお勧めします 。 SetCooperativeLevelメソッドを使用してBackgroundフラグを設定すると、それらを使用して、バックグラウンドでもジョイスティックからユーザー入力を取得できます。 ただし、 XInputはキーボードとマウスをサポートしていません。 私はまだプルモデルの使用が好きではありませんでした。そのため、興味のあるデバイスにある程度の頻度で問い合わせる必要があります。



さらに掘り続けました。 Parallelsのある友人は、 Raw Input APIに目を向けるよう提案しました。 このAPIの機能を分析した結果、必要なのはHIDクラスのさまざまなデバイスの操作、アクティブウィンドウなしで入力を受信する機能、およびイベントの発生元のデバイスの使用可能なIDだけであることがわかりました。 制限もあります-入力が管理プロセスで実行され、プロセスが管理者でない場合、入力イベントは発生しません。 しかし、私たちはそれを必要としません。 極端な場合、管理者権限でいつでもアプリケーションを実行できます。

実装

一般に、「Raw Input API」を使用してユーザー入力を取得するプロセスは、次の手順で構成されます。

1. RegisterRawInputDevicesを使用して、入力イベントを受け取るデバイスのタイプを登録します。
   
   
2. ウィンドウプロシージャでWM_INPUTイベントをリッスンします 。
   
   
3. GetRawInputDataを使用して、受信したイベントを解析します 。
   
   
4. イベントのタイプ（RAWMOUSE、RAWKEYBOARD、RAWHID）を判別し、そのタイプに従って解析します。
   
   

このすべてのシーケンスは、WPFアプリケーションのC＃で実装する必要がありました。 Win API関数の多数のラッパーを独自に記述しないために、 SharpDX.RawInputを使用することが決定されました 。



これは、Windows.Formsを使用した場合に、簡略化されたC＃コードがどのように見えるかです。

public class RawInputListener { public void Init(IntPtr hWnd) { Device.RegisterDevice(UsagePage.Generic, UsageId.GenericGamepad, DeviceFlags.InputSink, hWnd); Device.RegisterDevice(UsagePage.Generic, UsageId.GenericKeyboard, DeviceFlags.InputSink, hWnd); Device.RawInput += OnRawInput; Device.KeyboardInput += OnKeyboardInput; } public void Clear() { Device.RawInput -= OnRawInput; Device.KeyboardInput -= OnKeyboardInput; } private void OnKeyboardInput(object sender, KeyboardInputEventArgs e) { } private void OnRawInput(object sender, RawInputEventArgs e) { } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

DeviceFlags.InputSinkフラグは 、アプリケーションがメッセージをフォアグラウンドにない場合でも受信するために必要です。 このフラグを使用する場合、hWndを指定する必要があります。



WPFを使用する場合、OnRawInputおよびOnKeyboardInputメソッドはこの方法で呼び出されません。 Deviceクラス内に、Windows.FormsのIMessageFilterインターフェイスが実装されています。 Deviceのソースコードを見ると、PreFilterMessageメソッドでHandleMessageが呼び出されていることがわかります。



WPFを使用する場合の簡略化されたC＃コード：

 public class RawInputListener { private const int WM_INPUT = 0x00FF; private HwndSource _hwndSource; public void Init(IntPtr hWnd) { if (_hwndSource != null) { return; } _hwndSource = HwndSource.FromHwnd(hWnd); if (_hwndSource != null) _hwndSource.AddHook(WndProc); Device.RegisterDevice(UsagePage.Generic, UsageId.GenericGamepad, DeviceFlags.InputSink, hWnd); Device.RegisterDevice(UsagePage.Generic, UsageId.GenericKeyboard, DeviceFlags.InputSink, hWnd); Device.RawInput += OnRawInput; Device.KeyboardInput += OnKeyboardInput; } public void Clear() { Device.RawInput -= OnRawInput; Device.KeyboardInput -= OnKeyboardInput; } private IntPtr WndProc(IntPtr hWnd, int msg, IntPtr wParam, IntPtr lParam, ref bool handled) { if (msg == WM_INPUT) { Device.HandleMessage(lParam, hWnd); } return IntPtr.Zero; } private void OnKeyboardInput(object sender, KeyboardInputEventArgs e) { } private void OnRawInput(object sender, RawInputEventArgs e) { } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

イベントの発生元のデバイスを特定するには、RawInputEventArgsクラスのDeviceプロパティを使用します。これにより、次の形式のDeviceNameを取得できます。

 "\\?\HID#{00001124-0000-1000-8000-00805f9b34fb}_VID&000205ac_PID&3232&Col02#8&26f2f425&7&0001#{884b96c3-56ef-11d1-bc8c-00a0c91405dd}"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この名前でベンダーIDと製品IDを見つけるか、 GetRawInputDeviceInfoまたはHidD_GetAttributes関数を使用できます 。 VIDとPIDの詳細については、 こちらとこちらをご覧ください 。



次に、イベントの分析に目を向けます。 キーボードを使用すると、すべてがシンプルであることが判明しました。情報は、KeyboardInputEventArgsクラスで説明されている逆アセンブルされた形式で既に提供されています。 しかし、ゲームパッドではすべてがより複雑になりました。 基本型RawInputEventArgsの引数がOnRawInputに渡されます。 この引数は、HidInputEventArgs型にキャストする必要があり、機能する場合は引き続き機能します。 HidInputEventArgsには、デバイスから送信されたバイトの配列のみがあり、この配列のバイト数は、ジョイスティックやゲームパッドによって異なります。



残念ながら、このデータを解析する方法を説明する小さなドキュメントを見つけることはできませんでした。それは通常、短い形式でさえ見つかりました（MSDNでさえ、この問題についてまったく控えめな表現がありました）。 Cのこのプロジェクトは 、最も有用であることが判明しました 。 最初は作業環境に戻さなければなりませんでしたが、すでに素晴らしいスタートでした。 その後、必要な部品をC＃に転送する必要がありました。



最初のステップは、ネイティブ関数をラップしてC＃コードから呼び出すことでした。 ここでは、いつものように、 pinvoke.netが役に立ちました。 C＃のMarshal、PInvoke、および安全でないコードについては、 こちらをご覧ください 。



次のステップでは、メッセージ解析アルゴリズムを転送します。これは、次のように要約されます。

1. PreparsedDataデバイスの取得（ GetRawInputDeviceInfoまたはHidD_GetPreparsedData ）;
   
   
2. デバイス機能について学習します（ HidP_GetCaps ）。
   
   
3. デバイスボタンの詳細（ HidP_GetButtonCaps ）
   
   
4. 押されたボタンのリストを取得します（ HidP_GetUsages ）。
   
   

以下は、ゲームパッドからのデータ解析コードの一部であり、押されたボタンのリストを出力します。

 public static class RawInputParser { public static bool Parse(HidInputEventArgs hidInput, out List<ushort> pressedButtons) { var preparsedData = IntPtr.Zero; pressedButtons = new List<ushort>(); try { preparsedData = GetPreparsedData(hidInput.Device); if (preparsedData == IntPtr.Zero) return false; HIDP_CAPS hidCaps; CheckError(HidP_GetCaps(preparsedData, out hidCaps)); pressedButtons = GetPressedButtons(hidCaps, preparsedData, hidInput.RawData); } catch (Win32Exception e) { return false; } finally { if (preparsedData != IntPtr.Zero) { Marshal.FreeHGlobal(preparsedData); } } return true; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

PreparsedDataはGetRawInputDeviceInfoを使用すると簡単に取得できます。 必要なデバイスハンドルは既にRawInputEventArgsにあります。 HidD_GetPreparsedData関数はこのハンドルを受け入れません; CreateFileを使用して取得できるハンドルが必要です。



個別のボタンの値を取得する手順は同じです。HidP_GetButtonCapsの代わりに、最初にHidP_GetValueCapsを呼び出してから、 HidP_GetUsageValueを呼び出してボタンの個別の値を取得する必要があります。



HidInputEventArgsからのバイトセットがどのボタンが押されたかに関するデータに変換されたので、キーボードとマウスを操作するためのWPFにあるものと同様のメカニズムを作成できます。



ゲームパッドとキーボードからのユーザー入力を解析するアプリケーションの完全なコードは、GitHubのRawInputWPFプロジェクトで表示できます。

まとめ

このように、「Raw Input API」を使用すると、アプリケーションがバックグラウンドにある場合でも、キーボード、マウス、ジョイスティック、ゲームパッド、またはその他のユーザー入力デバイスからユーザー入力を取得できます。



そして、押されたボタンのデータをどうするかはあなた次第です。