ゲームパッドで起動するランチャー作った

クソアプリ アドベントカレンダー

この記事は 2024 年クソアプリ アドベント カレンダーの２日目の記事です。
クソアプリアドベントカレンダー１０周年おめでとうございます！

デモ

まずはこれを

んん！？　手元も映すと…

わかりづらいので、ここだけピックアップしてみると…

こ、これは波動拳コマンド…！
波動拳コマンドを入れて Photoshop が起動しているッッ！！

(※手はゲーム廃人 妻氏の手)

GamePad Launcher

ということで、ゲームパッドでアプリを起動するランチャーを作りました。
予めボタンの組み合わせを設定しアプリを指定しておくと、その操作をした時アプリが起動します。

ボタンの組み合わせの設定画面はこんな感じです。

PowerPoint には覇王翔吼拳を使わざるを得ない。
昇龍拳は僕が出せないので設定しませんでした！

一番上の notepad の水色枠の部分は L, R ボタンの同時押しを表しています。
たとえば、ABXY を同時に押すコマンドだとこういう表示になります。

実際に押した時は画面中央に↓このように表示されます。

入力されたボタンはリアルタイムで画面中央に表示されます。

ちなみに、この技法を使っているのでフォーカスを奪ったりしません。
ウィンドウも半透明です。

また、単純に Shell Open を叩いているだけなので URL を指定すれば URL も開きます。

※登録ダイアログ左側の画像部分をクリックすると任意の画像を設定できます

実際の登録はこんな感じでゲームパッドのボタンを押しながら [+] ボタンを押すことでコマンドを登録します（アップロードに失敗するため登録シーンは一部カット＆解像度を下げてます）。

利用するゲームパッドを上のドロップダウンで選べます。
普段ゲームに使うメインのゲームパッドしか使えないとゲームしてるときにアプリが起動しちゃいますからね。

…このこだわりで大変なことに

技術紹介

ということで、大変なことになったゲームパッドのリストアップ部分です。

大変だったポイントは２つ
・ゲームパッドのリストアップ（ゲームパッドの特定）
・ゲームパッド名の取得
これについて紹介します。

ゲームパッドのリストアップ

まずはゲームパッドのリストアップおよび特定です。

現在 Windows で使える GamePad API を調べると以下の５つがあります。

API名	概要	リストアップ機能	固有ID	特記事項
RawInput	HIDの生データを処理する仕組み	○	△	HIDデバイス以外のゲームパッドを取得できない生データを解析する必要がある（ゲームパッド毎に違う）
JoyStick	WindowsのマルチメディアAPIの一部	×	×	非推奨
DirectInput	DirectXの入力系API	○	○	非推奨
XInput	GamePadに特化したAPI	×	×	XInput対応ゲームパッドのみ利用可 認識される最大の接続数は４
GameInput	上記全てを内包するスーパーセットを目指したAPI	○	○	未実装項目が多数ある Bluetoothゲームパッドが使えない

このうち「XInput」と「GameInput」は Xbox でも使える事を企図した API です。
他の API は非推奨、Raw Input は生データを処理しないといけないので問題外。
なので実質「XInput」と「GameInput」の２つしか使えません。

最新の GameInput API は Microsoft が推奨しているのですが、未実装項目がたくさんあります。
サンプルコードで普通に未実装のメソッドを使っており、そのままコピーしても動きませんし、その機能が必要でも当然使えません。
また、バグが多く、Bluetooth ゲームパッドが使えない、という最悪のバグもあります（ボタン押下状態が取れない）。
さらに、ゲームパッドを認識するタイミングが「アプリが起動した時」となっていて、アプリ起動中にゲームパッドを追加しても認識されません（何度リストアップしても最初のリストしか取れません）。

これらによって GameInput ではなく XInput を使わざるを得なくなるのですが、XInput はゲームパッド固有の ID を取得できないためゲームパッドを特定できません。
（このアプリ用にどのゲームパッドを使うか覚えておきたかったため、ゲームパッド固有 ID が必須でした）

そこで苦肉の策として DirectInput でゲームパッドのリストアップと固有 ID を取得し、実際の入力では XInput を使う、という方法にしました。
DirectInput が非推奨 API なので、当初は GameInput を使ったのですが上記したようにアプリ起動中の挿抜検知ができないため断念しました。

ということで DirectInput を使う事にしたのですが、ここで問題になるのが DirectInput で返ってくる ID が XInput のゲームパッドのどれにあたるかわからない、ということです。
XInput はゲームパッドを 0～3 の番号でしか管理してないので…

色々調べたところ XInput の隠し API XInputGetCapabilitiesEx を使うと「ベンダーID」と「プロダクト ID」を取れることがわかりました。
DirectInput でも GUID から「ベンダーID」と「プロダクトID」が取れるので、比較すればゲームパッドを特定できそうです。

できそうでした…
違う製品のくせに同じ「プロダクトID」を返してくるメーカーがなければ…
仕方が無いので同じプロダクトIDを持ったゲームパッドが２つ以上見つかった場合、名前を or で繋げることにしました（最初の図に or で繋がった名前があります）。

ゲームパッド名の取得

次にデバイス名の取得です。
DirectInput で取れるゲームパッドの情報が「Bluetooth XINPUT 互換入力デバイス」とかになっている場合があり、製品名を取れないことがあります。
ですがデバイスマネージャーでは取れてるので何か方法があるだろうと試行錯誤しました。

試行錯誤した結果 WMI の Win32_PnPEntity を使えば取れそうでした。

で、結局取れはしたのですが、すごく大変でした。
基本は前述の「ベンダーID」「プロダクトID」を比較して Win32_PnPEntity の Caption プロパティを取ってくるのですが、これの中身が入っていなかったり、入っていても「HID 準拠ゲーム ゲームパッド」だったりするので、この２つの ID から本物の名前を取る小細工をたくさんする必要がありました…（しかも、まだ上手くいっていない
詳しくはソースの PK.Device.GamePad.Win.pas を見てください。

XInput の使い方

今回メインで利用している XInput についてです。
XInput は非常に単純な API になっていてボタンの押下状態の取得はこれだけです。
DirectInput のような初期化処理も必要ありません。いきなり呼び出せます。

例：0番目のGamePadの押下状態を取得

var State: TXInputState;
if XInputGetState(0, State) <> ERROR_SUCCESS then
  Exit;

// Aボタンが押されているか
if (State.Gamepad.wButtons and XINPUT_GAMEPAD_A) <> 0 then
  Log.d('A ボタンが押されている');

// Bボタンが押されているか
if (State.Gamepad.wButtons and XINPUT_GAMEPAD_B) <> 0 then
  Log.d('B ボタンが押されている');

XInputGetState を定期的に呼んであげればボタンの押下状態がとれるということです。
Game を作る上で必要な ゲームループ向きの使いやすい実装ですね。

コマンドの処理

アルゴリズム的な説明もすこし。
コマンドの実装についてです。

今回は、こんな仕組みにしました。

A, B, C でコマンドが発動する事とします。

まず、バッファとバッファの入力位置を示すインデックスポインタを用意します。

入力があったら、インデックスポインタが指す位置に入力を入れて、ポインタを１つ動かします。

続く入力が一定時間内になかった場合、ポインタを 0 の位置に戻します。
0 に戻ると有効な入力も 0 になってしまうので、コマンドが成立しません。

バッファ内の有効ボタン数とインデックスが指す値は常に同じになるため、インデックスポインタの値を見るだけで有効な入力がわかる仕組みです（for 文などで処理しやすくなります）。

一定時間でインデックスポインタが０に戻るため、格ゲーのコマンド入力が難しくなっているわけですね。

また、コマンドは最長一致にしています。
そうでないと「覇王翔吼拳」を出しているときに「波動拳」が出てしまうためです。

利用した外部サービス

次に今回利用したサービスです。

Kenny Input Prompts

https://kenney.nl/assets/input-prompts
CC0 ライセンスで公開されているゲームパッドのドット絵群。
可愛い。CC0 で改変もできるため今回は改変して使用
でも無料だと気がひけるクオリティなので、全てのアセットが使える有料版を購入しました。$19.95 以上で買えます。

Simple WMI View

https://www.nirsoft.net/utils/simple_wmi_view.html
WMI の値を手軽にチェックできるツール。
当然 Query も発行できるので普通に便利です。
これを使って Win32_PnPEntity の結果とにらめっこしながら名前を取得する部分を書きました。

Chet

https://github.com/neslib/Chet
Clang を使ったソース解析で C/C++ のソースを Object Pascal のソースに変換してくれるツール。
使い方には大分くせがあったけど、これを使って GameInput API を移植しました。GameInput は COM（ライト）ベースの API ですが、ちゃんと変換できました。
…結局 GameInput API 使わなかったんですけどね

DelphiStyles.com

https://delphistyles.com/fmx/index.html
美麗な Delphi 用 Style といえばここ。
GetIt でいくつかの Style が提供されているけど背景が単色ではないものは、こっちの有料版の方が多いのでお金に余裕があるならおすすめ。

ただ、KSDev の FireMonkey の生みの親 Eugene Kryukov 氏が亡くなったので今後どうなるか…（DelphiStyles.com は KSDev グループ）
FMX を便利に使わせていただいている身としては、Eugene Kryukov 氏の訃報は衝撃が大きい…ご冥福をお祈りします。

GIFスピードチェンジャー

https://gifspeed.imageonline.co/index-jp.php#google_vignette
このアプリの製作とは関係ないですが記事を書く上で有用だったサービス。
いつも Qiita に上げると GIF の再生スピードが落ちてガッカリしてたんだけど、ここでスピードを最速にすると求めている速さになりました。
処理速度もめちゃくちゃ速いのでオススメ。

検証した GamePad

最後に今回検証したゲームパッドです。
(半分が妻氏のもの…とんでもないゲーマーなので)

大体のコントローラーはちゃんとしていたのですが、その中でもビックリしたのが右上の中華ゲームパッド…こいつ XInput のインジケーター（リング）がちゃんと付いてるし、Xbox 360 Controller っていう文字列返してくれるし一番仕様に準拠してた…恐るべし中華ブランドと思ったけど純正品の流用なのかもしれない。

純正 Xbox ゲームパッドも、もちろんちゃんとしてました。
２つのゲームパッドは当然ながらプロダクトIDは別でした（ちなみに Xbox Design Lab はこちら）。

BIGBIG WON Gale も正しく情報を返してくれました。
この中だと性能は抜群です。
FPS やる人には良さそう。

反面残念だったのが評価の高い 8bitDo のゲームパッド。多分使う人は１つの製品しか使わないだろうという事なのか Pro2 と Zero2 で同じプロダクトIDになっていてどっちか判別できませんでした。
とはいえ、純正品以外のゲームパッドで同じメーカーの物を２つ以上持っていないので実際は他のメーカーもそうなのかも知れません。

DualShock4 は XInput で利用できないけど GameInput だとどうかな？という確認用でしたが、GameInput が使えなかったので結局利用せず…

個人的に手に馴染んでるのは 8bitDo Pro 2…でもプロダクトIDの重複でうーんという感じ。

また、Bluetooth GamePad は一定時間操作がないと切れてしまう物がほとんどなので、このアプリで使うためには有線ゲームパッドじゃないとダメそう…ということは、あんなに苦労せずとも良かったのでは？

まとめ

ゲームパッドが余っていたら使えそうで微妙に使いづらい、絶妙なクソアプリになったのではないでしょうか！

API について

GameInput API は人類にはまだ早い。

現状の方針は
・基本 XInput を使う
・個々のコントーラーの識別が必要なら DirectIpunt も併用する
となります。

バイナリ

こちらからダウンロードできます。
https://piksware.com/xpadlauncher

せっかくだから自分のサイトにアップしときました！

ソース

ソースはこちらに。
https://github.com/freeonterminate/XPadLauncher

今回は僕が普段使っている拙作のライブラリ群もコピーして入れてあります。
VCL 用のライブラリはたくさんありますが、FMX 用のはそんなにないため参考になれば。

ビルド環境

Delphi 12.2 Athens Patch2 で製作。恐らく無料の Community Edition でもビルドできるはず。

今回は Windows オンリーです（Windows 10 以上）。
恐らく以下のファイルを追加したり削除すれば Mac にも対応するような気がします。
ただ、わかりやすくするため全てのライブラリをプロジェクトに登録しているので、Lib 以下のファイルはプロジェクトから外す必要があります。

Mac 用の機能を実装する必要がある Unit

PK.AutoRun.Mac.pas
PK.Device.GamePad.Mac.pas
PK.Graphic.IconConverter.Mac.pas
PK.Graphic.IconUtils.Mac.pas

IFDEF で排除する Windows 用 Unit

PK.HardInfo.WMI.Win.pas
PK.GUI.DarkMode.Win.pas
PK.GUI.NativePopupMenu.Win.pas
Winapi.XInput.pas

おまけ

SendKey との組み合わせ

僕のウェブサイトからダウンロードできる SendKey と組み合わせるとボタンを押したときにショートカットキーを送信できます。
例えば Alt+Shift+Ctrl+S を登録すれば、Photoshop で「Web 用に保存」が実行できます。

Delphi 紹介

Delphi 大好きなのでこの項は譲れない。
Windows, macOS, iOS, Android, Linux のアプリケーションを作れるのは良く言っていますが、Delphi は、こんな風に部品をドラッグ＆ドロップするだけで作れるので楽ちんで本当にオススメ。UI 構築でコードを書く必要はありません！

（×表記になっている部分は BitmapList を使い回しているため）

それとコンパイル型言語とは思えないレベルのビルドの速さも良いですよ！
このプロジェクト一式（33ファイル）フルビルドしても 600[msec]！

その後のゲームパッド達

タワーマンションに居住しています。

MANBA ONE は液晶付いてて便利そうだし GameSir Tarantula Pro はボタンが変わるギミックがスゴイので、ほしい…コントローラー沼