2012-12-28

Lua-GD でのアルファチャンネルの扱い

Lua-GD のアルファチャンネルの扱いでよく失敗するのでまとめました。勘違いしていると、じつは画像が透明だったり、不透明だったり、半透明があるのに思い通りにブレンドされなかったりします。

内容は Lua-GD 2.0.33r2 に準拠しています。他の環境下での挙動は保証しません。

画像の新規作成 (フルカラー)

フルカラー画像の作成には、gd.createTrueColor(x, y) を利用。
画像作成後は、全面不透明黒で塗られた状態（透明ではない）
画像作成後は、gdImage:alphaBlending(true) の状態。
画像作成後は、gdImage:saveAlpha(false) の状態。
アルファチャンネルの範囲は 0〜127 であり、0〜255 ではないので注意。
透明なキャンバスを作成するには透明ピクセルで塗りつぶす必要がある。下記にフルカラー透過画像を作成するコードを示す。

-- create a blank truecolor image
gd.createTrueColorBlank = function(x, y)
	local gdImage = gd.createTrueColor(x, y)
	if gdImage == nil then return nil end

	local colorTrans = gdImage:colorAllocateAlpha(255, 255, 255, 127)
	gdImage:alphaBlending(false)
	gdImage:filledRectangle(0, 0, gdImage:sizeX() - 1, gdImage:sizeY() - 1, colorTrans)
	gdImage:alphaBlending(true)
	gdImage:colorDeallocate(colorTrans)
	return gdImage
end

余談ですが、gd.create(gdImage) 的な関数はありそうでないです。

画像の読込 (PNG)

PNG画像の読込には、gd.createFromPng(filename) を利用。
- ファイル内容を文字列をとして読み込んである場合は gd.createFromPngStr(string) を利用。
パレットかフルカラーかは入力ファイルに基づく（要注意！）

画像の保存 (PNG)

PNG画像の保存には、gdImage:png(filename), gdImage:pngEx(filename, compression_level) を利用。
出力ファイルがパレットかフルカラーかは入力画像に基づく。
アルファチャンネルの保存は gdImage:saveAlpha(true) を実行していないと行われない。

画像のコピー・貼り付け

画像の一部を転写するには gd.copy(dstImage, srcImage, dstX, dstY, srcX, srcY, w, h) を利用。
フルカラー画像は dstImage:alphaBlending(boolean) の設定により挙動が異なる。true であればブレンディングを行うが、false であればアルファ値を含めてピクセルをそのままコピーする*1。
フルカラーとパレットの混在時には注意を要する（後述）

パレットとフルカラー

フルカラーとパレットの混在時には注意を要する場合がある。

画像がフルカラーかどうか調べるには、下記のようなメソッドを要する。

gd.isTrueColor = function(gdImage)
	if gdImage == nil then return nil end
	local gdStr = gdImage:gdStr()
	if gdStr == nil then return nil end
	return (gdStr:byte(2) == 254)
end

パレットの「透過色」とフルカラーの「アルファ」は異なる概念である。それ故か下記の問題がある。
- gd.copy() でパレット→フルカラーのコピーを行うとき、gdImage:alphaBlending(boolean) に関わらず透過ピクセルが透過コピーされてしまう。ただし、gd.copyResampled() であれば gdImage:alphaBlending(boolean) を尊重したコピーが行われる。
上記を考慮すると、画像をフルカラーに変換する下記のコードが書ける。

-- return a converted image
gd.convertToTrueColor = function(srcImage)
	if srcImage == nil then return nil end
	if gd.isTrueColor(srcImage) then return srcImage end

	local gdImage = gd.createTrueColor(srcImage:sizeX(), srcImage:sizeY())
	if gdImage == nil then return nil end

	gdImage:alphaBlending(false)
	local colorTrans = gdImage:colorAllocateAlpha(255, 255, 255, 127)
	gdImage:filledRectangle(0, 0, gdImage:sizeX() - 1, gdImage:sizeY() - 1, colorTrans)
	gdImage:copyResampled(srcImage, 0, 0, 0, 0, gdImage:sizeX(), gdImage:sizeY(), gdImage:sizeX(), gdImage:sizeY())
	gdImage:alphaBlending(true)

	return gdImage
end

おまけ：画像の左右反転

拡大コピーで負数を指定
反転画像の作成は、新しいGDライブラリにはあるが、上記 Lua-GD にはない。ただし下記で代用できる（巨大画像では低速）

-- flip an image about the vertical axis
gd.flipVertical = function(gdImage)
	if gdImage == nil then return nil end
	gdImage:alphaBlending(false)
	for x = 0, gdImage:sizeX() do
		for y = 0, math.floor(gdImage:sizeY()/2) - 1 do
			local c1, c2 = gdImage:getPixel(x, y), gdImage:getPixel(x, gdImage:sizeY()-1-y)
			gdImage:setPixel(x, y, c2)
			gdImage:setPixel(gdImage:sizeX()-1-x, y, c1)
		end
	end
	gdImage:alphaBlending(true) -- TODO: restore the previous value
	return gdImage
end
-- flip an image about the horizontal axis
gd.flipHorizontal = function(gdImage)
	if gdImage == nil then return nil end
	gdImage:alphaBlending(false)
	for y = 0, gdImage:sizeY() do
		for x = 0, math.floor(gdImage:sizeX()/2) - 1 do
			local c1, c2 = gdImage:getPixel(x, y), gdImage:getPixel(gdImage:sizeX()-1-x, y)
			gdImage:setPixel(x, y, c2)
			gdImage:setPixel(gdImage:sizeX()-1-x, y, c1)
		end
	end
	gdImage:alphaBlending(true) -- TODO: restore the previous value
	return gdImage
end
-- applies vertical and horizontal flip
gd.flipBoth = function(gdImage)
	-- use of gd.copyRotated() can provide the same result?
	gd.flipVertical(gdImage)
	gd.flipHorizontal(gdImage)
	return gdImage
end

おまけ：EmuLua

今日以前の desmume は gui.gdscreenshot() で透明な画像を返す
- gd.createFromPngStr(gd.createFromGdStr(gui.gdscreenshot()):pngStr()) と書けば1行でアルファを切り捨て可能

*1:srcImage が完全に透明な画像を考えるとわかりやすい。true の際は dstImage に変化はないが、false の際は dstImage のコピー部分が透明ピクセルに変化する。

2011-08-28

VisualBoyAdvance でキー入力をAVIに出力するには？

ゲームゲーム-TAS 技術技術-プログラミング技術-プログラミング-Lua

Web拍手経由でご質問いただきました。

VisualboyAdvanceでLuaでの入力表示に関して色々とぐぐってたら、vba-rerecording rr22?とかいうのでjoypad.getdown(int port)という文章を見つけたので、RamWriter.lua（空白区切り版）という奴に file:write(string.format("%d ", joypad.get())) というのを書いて見たんですが、普通にエラーで出てしまいました。これってどういう風に Joypad.get を書けば入力キーを出力できるようになるんでしょうか？

AVIファイルにキー入力を表示させたいという観点でいくつかお答えします。

Lua を使わずにキー入力を AVI に書き出すアプローチ

ただ AVI に Input Display の表示を書き出すだけなら、Lua を使わなくてもできます。

「,」キーを押して Input Display を表示する。
AVI にも表示されるように、HUD の表示を In Game に変更する（下記画像参照）。
AVI の録画を行う。

利点は実現が楽なことです。欠点は表示形式をカスタマイズできないことです。

Lua を使ってキー入力を得るには？

まず最初に、以下の記事からスクリプトを再度ダウンロードしてください。数あるエミュレータの中でもVBAはAVI書き出し時にフレームが複製されて記録される問題があり、本日それに対する対応コードを加筆しました。

メモリ内容等を動画（の外側）に表示させる方法

file:write(string.format("%d ", joypad.get())) というのを書いて見たんですが普通にエラーで出てしまいました。

joypad.get() の戻り値は table 型です*1が、%d で number 型の出力を行おうとしているからエラーが出ます。

賢い方法はともかく、メモリの値を出力する場面で以下のようなコードを書けば、Aボタンが押されているかいないかを記録できます。

-- RamWriter.lua:
local pad = joypad.get(1)
framedata = framedata .. string.format("%d ", (pad.A and 1 or 0))

対応する読み込み側の一例は次のような感じです。

-- RamReader.lua:
i = file:read("*n"); frame[f].A = ((i ~= 0) and true or false)

*1:print( joypad.get() ) を行ってみるとより詳しく中身がわかります。

2011-07-16

プロセスメモリエディタ「MHS」を利用したメモリ監視・操作

ゲームゲーム-TAS 技術

MHSはいわゆるプロセスメモリエディタと呼ばれるもので、ゲームの見えないパラメータを表示させたり、値を書き換えたりすることができます。類似のツールはほかにもありますが、TAS界隈ではよくこのMHSが利用されます*1。

日本では同様のツールとして、うさみみハリケーンなどが知られています。噂に聞くところでは検索機能はこちらの方が高度とも聞きますし、可能であれば他のプロセスメモリエディタ、デバッガと組み合わせて利用すると、できることの幅は広がるでしょう。個人的にはMHSの基本のシンプルさがとても好きです。

それでは、導入から簡単な利用までを見てみましょう。

ダウンロードとインストール

MHS Download Page から MHS6.1.rar をダウンロードして展開するだけです。

起動〜対象プロセス選択

メモリ監視対象のプログラム（ゲーム）を起動した状態で MHS.exe を起動します。初回起動時には下記のダイアログが表示されます。

Would you like to personalize this software?
Doing this can allow you to avoid detection by anti-cheat software.

If you do not want to do this now, you can always do it later from the Tools/Modify Self menu. (はい/いいえ)

「不正防止つきソフトウェアへの対策として、MHSを改変しますか？」というような内容です。TAS目的の方にはまず不要ですし、Tools/Modify Self メニューから後で改変を実施することもできますので、ここでは「いいえ」を選択して次へ進みます。

メインウィンドウが表示されたら、メニューから File → Open Process を開きます。

現在起動中のプロセスを一覧表示したダイアログが開くので、タイトルや実行ファイル名を参考に、メモリ監視対象のプロセスを選択して、OKを押してください。

これで、MHS でメモリにアクセスする準備ができました。

メモリアドレスを検索する

メモリアドレスを検索するには、Found Addresses ウィンドウにある、虫眼鏡（単一）アイコンのボタンをクリックします（あるいはメニューから Search → Data-Type Search を選択）。

すると、検索のための Data-Type Search ダイアログが表示されます。

まずは、Search グループで基本的な検索条件を指定します。選択肢の意味は下記の表のとおりです。

Data Type	バイト数	値の型・範囲
Byte	1	0〜255 の整数
Char	1	-128〜-127 の整数
Short	2	-32768〜-32767 の整数
Unsigned Short	2	0〜65535 の整数
Long	4	-2147483648〜-2147483647 の整数
Unsigned Long	4	0〜4294967295 の整数
64-bit Integer	8	-9223372036854775808〜9223372036854775807 の整数
Unsigned 64-bit Integer	8	0〜18446744073709551615 の整数
Float	4	実数 (単精度浮動小数点数)
Double	8	実数 (倍精度浮動小数点数)

Evalutation Type	説明
Exact Value	Value to Find に一致する値を検索する。
Not Equal To	Value to Find に一致しない値を検索する。
Range	From より大きく、To より小さい値を検索する。
Greater Than	Find Values Greater Than よりも大きい値を検索する。
Lower Than	Find Values Lower Than よりも小さい値を検索する。
Unknown	(不明。指定した型に合う全候補を表示？)

その他の主なポイントは以下のとおりです。

デフォルトではマップされたメモリが検索対象に含まれない（エミュレータのメモリアドレスが見つけられない可能性がある）ので、Options の General Search Options から設定画面を開いて、General Search タブで MEM_MAPPED を検索対象とするよう、チェックを付けるとよいかもしれません（ただし検索速度は遅くなります）。
Search Range は検索対象とするメモリアドレスの範囲です。おおよそ変更する必要はありません。

OKボタンを押して検索を行うと、Found Addresses の一覧に結果が表示されます。

多くの場合、ここから絞り込み検索を必要とします。Found Addresses ウィンドウにある、虫眼鏡（複数）アイコンのボタンをクリックします（あるいはメニューから Search → Sub Search を選択）。

すると Sub Search ダイアログが表示されます。使い方は先ほどのダイアログと同じなので割愛します。

探しているメモリアドレスが見つかったら、項目を右クリックして Add Selected を選択します。

メインウィンドウで特定のメモリアドレスの値を見ることができるようになりました。

おまけ：ポインタの検索

特定のアドレス領域を指しているポインタを検索する機能があります。メニューから Search → Pointer Search をクリックすると、下図のダイアログが表示されます。

動的に変化するアドレスを追いたいときには、ポインタの検索が必要になります。これを知らなくても MHS は使えますが、使い方が想像できる人は知っているとお得です。

ウォッチの編集、改造コード機能の利用

メインウィンドウにあるメモリアドレス一覧の項目をダブルクリックすると、Modify Address ダイアログが開きます。

Description を編集して、説明文を変更できます。
Type を変更すると、値のサイズ・型が変更できます。
Show as Hex にチェックを入れると、値を16進数で表示できます。

また、Locked のチェックボックスにチェックを付けると、改造コード機能が利用できます。Lock Type の意味は下記のとおりです。

Evalutation Type	説明
Exact	指定値を強制する。
Range	指定した下限値〜上限値の範囲を強制する。
No Lower Than	指定値より小さくならないよう強制する。
No Greater Than	指定値より大きくならないよう強制する。

OKを押すと変更が反映されます。

おまけ：アドレス計算に式を利用する

動的に確保されるメモリ領域はメモリアドレスが不定になるため、ここまでで紹介した方法では、起動後に毎回再検索しなければなりません。MHS にはポインタの参照先を辿って動的にアドレスを指定する方法が用意されています。

Modify Address ダイアログの Normal Address タブを開きます。

中断の Complex Address (Overrides Simple) というチェックボックスにチェックを付けると、下部の入力欄にて、メモリアドレスの表現に式が利用できます。

計算式の仕様は下記のとおりです。

式ではC言語の基本的な演算子が利用可能。
間接参照は [40B0F0] のように角括弧で行う（括弧は入れ子にしても問題ない）。

記述例: [40B0F0] + 0x1536 + ([40B0F4] & 0xff)

おまけ：値を計算式で加工して表示する

Expression Evaluator ウィンドウに式を入力して追加すると、値を計算式で加工して表示することができます。

計算式の仕様は、動的アドレス計算に使用するものと同じです（上記参照）。

メモリウォッチ内容の保存

MHS を終了する前に、メモリウォッチの内容を保存しておきましょう。

ファイルの保存は、メニューから File → Save Selected As を選択して行います。

保存したファイルは次回、File → Open Save File から開くことができます。

まとめ

とりとめのない紹介になりましたが、下記をもってまとめとします。

MHS を使えば簡単・強力にメモリの検索・監視・書き換えが行える。
解析技術があれば、動的に変化するアドレスにも柔軟に対応できる。よくわからなければ、メモリアドレスによっては、起動ごとに毎回検索する必要があることに注意すべし。
MHS には Script など、まだ紹介されていない興味深い機能が多数ある。

Windows 上で動くゲームの TAS 制作を考えている方の参考になればうれしいです！

GitHubへのコミットをIRCにリアルタイム通知するには？

技術

GitHubのリポジトリにコミットしたとき、CIA.vcを利用してIRCにメッセージが飛ぶようにします。簡単、無料です。

GitHub の設定

リポジトリの Admin ページを開く (管理者アカウントが必要)
Service Hooks をクリックして、一覧からCIAを選択
Active にチェックを入れて、Update Settings で変更を保存

これだけ、じつに簡単です。ほかにも Twitter などとも連携できるようです。

CIA.vc の設定

アカウントを持っていなければ、CIA.vc - Register an Account から登録してください。アカウント名やメールアドレスなど、若干の基本的な情報を聞かれるだけで簡単、無料です。また、アカウント名以外はあとから変更できます。

アカウントが準備できたら、ログインして CIA.vc - Your Account ページを開きましょう。

まず、通知メッセージを流したいチャンネルを追加します。左側のメニューから Bots → Add bot... とクリック、サーバとチャンネル名を入力して Add します（例：Freenode, TASers）。

追加されたチャンネルが一覧に表示されるのでクリック、Filter by project を選択して入力欄にプロジェクト名を入力してください（たとえば https://github.com/snes9xgit/snes9x の場合であれば snes9x と入力する。また、複数のプロジェクトの状況を監視したければ改行区切りで入力する）。Save を押して変更を保存すれば、これで指定のIRCチャンネルにコミット情報が通知されるようになります。

高度なフィルタリング (forkの考慮)

上記の方法でプロジェクトを追加すると、forkによる派生版の情報もIRCに流されます。派生リポジトリが本家のアップデートをマージすると、その分のコミット情報もすべて流れてきます。いくつか派生版があって、それらすべてがこまめに本家リポジトリの更新を取り込んでいるとすると、IRCに同じ情報が何度も流れてきて非常に不都合です。

状況を改善するには、Filter by project の代わりに Custom filter を選択して、より細かなフィルタリングを行います*1。フィルタリングの記法は CIA.vc - Advanced Filtering で説明されています。難しくはないので、内容に関しては割愛します。

以下にフィルタの例を示します。snes9xgit/snes9x の gocha さん以外からのコミットと、snes9x-rr の gocha さんからのコミットだけを通知しています。

<or>
  <and>
    <match path="project">snes9x</match>
    <or>
      <and>
        <find path="url">github.com/snes9xgit/snes9x</find>
        <not><match path="author">gocha</match></not>
      </and>
      <and>
        <find path="url">github.com/snes9x-rr/snes9x</find>
        <match path="author">gocha</match>
      </and>
    </or>
  </and>
</or>

<formatter medium="irc"/>
<formatter name="IRCProjectName"/>

なお、特定の人のコミット情報は http://cia.vc/stats/author/gocha のようなURLから閲覧可能です。Link をたどるとコミット情報を記した XML データを閲覧することができます。フィルタの作成にあたっては、一度どのようなデータが含まれているか眺めてみると役に立つことでしょう。

*1:Filter by project と Custom filter の併用はできない。乗り換える場合は <match path="project"> を記述して同等の効果を得るようにする。

ごちゃペディア

はなまるデジタル創作紀行（DTM、TAS、いろいろな技術）