Image Mixer プロセッサ開発キット(PDK) Ver. 2.0.0

このドキュメントは、Image Mixerで使用する画像プロセッサパッケージを開発するプログラマの皆様に、Image Mixerプロセッサの仕様情報と開発手順を提供するものです。不明な点がございましたら、Eizawaまでメールでご連絡ください。ドキュメントの製作にはNetscape Composer 4.7を使用しました。なお、開発に際して発生したいかなる損害にも、Eizawaはその責を負いません。
−written by Eizawa. last update 2/xx/2001

目次

１．開発環境
　１．１　開発に必要な環境
　１．２　PDKファイルのインストール
２．開発手順1−テストベンチを用いた作業
　２．１　プロセッサの仕様(概略)を確認
　２．２　テストベンチにプロセッサを追加
　２．３　クラス名を変更する
　２．４　パラメータを実装する
　２．５　プレビュー許可を変更する場合
　２．６　ユーザーインターフェイス処理で入力画像を使用する場合
　２．７　サイズを変更するフィルタの場合
　２．８　プロセッサ処理を記述する
　２．９　テストベンチを実行し、デバッグする
３．開発手順2−Image Mixerを用いた作業
　３．１　パッケージを作成、または既存のパッケージのプロセッサを追加する
　３．２　パッケージをビルドする
　３．３　Image Mixerを実行し、動作を確認する
４．クラス等の仕様
５．Tips
６．配布について
７．変更履歴


１．開発環境

まず、Image Mixerプロセッサの開発を行うために用意する必要のある環境について説明します。次に、このPDKに含まれるソースコード等のうち、開発環境での設定が必要なものについて説明します。
 

１．１　開発に必要な環境

開発にはBorlandのDelphi4が必要です。プロセッサパッケージをDelphi/C++Builderのパッケージライブラリ(*.bpl)としたためにこのような制限があります。私はDelphi5を持っていないため試していませんが、Delphi5を使用した場合は、異なるバージョンのVCLパッケージを同一プロセスでロードすることになり、干渉して動かないものと思われます。また、C++Builder4も使用可能と思いますが、IMProc.pasをC++で書き直す必要があります。で、してません(笑)。誰か書いて…
参考までに、作者Eizawaの環境を記しておきます(2001年2月現在)。
・Delphi4J+UpdatePack3
・Windows2000+SP1
・自作K6-3機メモリ256MB
・1280*1024*32bit


１．２　PDKファイルのインストール

このPDKを(ディレクトリ付きで)展開すると、srcディレクトリに開発に必要なソースコード等があります。これらのファイルは、開発するプロセッサのDelphiプロジェクトファイルと同じディレクトリにコピーしてください。
ソースファイルのうち、IMFｌｔFrm.pas、IMMｘｒFrm.pas、IMGnrFrm.pasはプロセッサのテンプレートです。これら3つのファイル(に対応するフォーム)をDelphiのリポジトリに登録してください。プロセッサを製作するとき、これらのテンプレートのコピーを基に作業をすることになります。また、設計時パッケージIMPrcDef.dcpをインストールしてください。プロセッサの基本クラスの定義(IMProc.pas)が入っています。
 
２．開発手順1−テストベンチを用いた作業
開発は2つのステージに分かれます。まず、1つめのステージで中核の処理部分とユーザーインターフェイス部分を完成させ、2つめのステージでスクリプトやプレビューなどのデバッグを行います。開発時のホストアプリケーションは、1つめのステージでは専用のテストベンチ(PDKに収録)、2つめのステージではIM.exeを使用します。IM.exe使用時は(たぶん)統合デバッガが使えず、開発が困難になるために2段階の開発形態になっています。
＃ちなみに、私もこの形態です。IM.exeが統合環境から実行できないので(IM用カスタムコンポーネントのパッケージが干渉か？)。
注：メソッドをオーバーライドする際は、特に指定がない限り元のメソッドを呼び出す必要はありません。

以下、1つめのステージ−テストベンチ上での作業手順−を説明します。IMBench.dprがテストベンチのプロジェクトファイルです。
 

２．１　プロセッサの仕様(概略)を確認


２．２　テストベンチにプロセッサを追加

IMBenchプロジェクトを開き、プロセッサを追加します。新しいプロセッサのジャンル(ジェネレータ・フィルタ・ミキサーのいずれか)を確認し、「ファイル」−「新規作成」で対応するテンプレートを指定すると新しいフォームが作成されます。このとき、「コピー」を指定します。テストベンチは同じジャンルのプロセッサを1つずつしか扱えないので、既存の同ジャンルのユニットはプロジェクトから削除しておきます。
次に、テストベンチで使用する入力画像を読み込んでおきます。ジェネレータの場合は当然必要ありませんが、フィルタは入力画像1、ミキサーは入力画像1と2の両方のTImageにビットマップを読み込んでおきます。


２．３　クラス名を変更する

フォームとプロセッサのクラス名を変更します。最初にオブジェクトインスペクタでフォームの名前を変更し、残りは、参照している個所が多いので置換機能を使いましょう。フォーム名を置換するときは、インスタンス名(Tが付かないほう)をキーに指定します。プロセッサ名はクラス名(T付き)で置換すればOKです。次に、メニュー用のアクションの名前を変更します。また、フォームのFormCreateハンドラにスクリプトで使用するプロセッサ名と処理後にタイトルバーに表示する内容を指定します。
パラメータが必要な場合は、パラメータクラスのコメントアウトを解除し、クラス名を置換します。また、CreateParamPackメソッドの変数型とインスタンスの型を修正します。


２．４　パラメータを実装する

ここでの作業は、パラメータが必要な場合のみ行うものです。
最初に、どんなパラメータが必要か確認し、パラメータクラスにデータフィールド(変数)を宣言します。ただし、このときに使用できる型は、Integer、Boolean、Single、Double、Stringのみです。これは、スクリプトで扱える型が上記のもののみであるためです。配列や構造体も使えません。
次に、グローバル変数のCurPackの宣言およびinitialization部とfinalization部の生成・開放処理のコメントアウトを解除します。
次に、パラメータを操作するメソッドを定義します。フィルタクラスのコメントアウトされたメソッドのうち、MakeList、GetParams、UpdateParam、ApplyParamを宣言します。MakeListとGetParamsの定義はコメントアウトされているので、解除して実装します。UpdateParamとApplyParamの定義は新しく作成します。また、CreateParamPackにもコードを記述する必要があります。以下にそれぞれのメソッドで実装すべき処理を説明します。
CreateParamPack：最初に、変数Packの型が先ほどのパラメータクラスになっているか確認し、なっていなければ修正します。追加すべき処理は、グローバルオブジェクトCurPackから新しく作ったPackへデータをコピーすることです。
GetPartams：CreateParamPackとは逆の処理になります。つまり、引数のPackからCurPackへデータをコピーします。
MakeList：スクリプト実行時にパラメータにアクセスするための、名前とポインタを対応付けるリストを生成します。
UpdateParam：フォーム上のコンポーネントからCurPackへ値を読み込みます。
ApplyParam：UpdateParamの逆、CurPackからフォームへ値を設定します。
最後に、パラメータの保存・復帰処理を記述します。initialization部とfinalization部にINIファイルの読み込み・書き込み処理を記述します。INIファイル名とセクション名の書き換えを忘れずに。
パラメータが変更されてプレビュー画像を更新したい場合は、UpdatePrevImgメソッドを呼びます。ただし、この機能はテストベンチでは動作しません。(プレビュー機能自体がないので)


２．５　プレビュー許可を変更する場合

デフォルトでは常にプレビューが可能ですが、画像サイズに依存する処理の場合は正しいプレビューが得られないため、この作業を行う必要があります。
まず、プロセッサ宣言のCanPreview関数のコメントアウトを解除します。
CanPreviewの定義は、常にプレビュー不可の場合は
　Result := False;
だけでOKです。プレビューの可否に条件がある場合は、その条件を判定します。


２．６　ユーザーインターフェイス処理で入力画像を使用する場合

ユーザーがパラメータを入力する際に画像を表示する必要がある場合、この作業を行います。Image Mixer標準のプロセッサでは、アフィン変換やヒストグラム平坦化などがこの機能を使用しています。
まず、新しい画像が選択された場合の処理を記述します。OnImageChangeメソッドをオーバーライドし、必要な処理を記述します。
フォーム上のコンポーネントのイベントハンドラなどで画像を使用したい場合は、
　フィルタ：GetCurrentImage
　ミキサー：GetFGImage、GetBGImage
を使用してください。これらの関数はnilを返す場合があるので注意します。ミキサーのOnImageChangeもnilパラメータで呼び出される場合があります。
この機能はテストベンチでは利用できないため、デバッグはIM.exeを使用します。


２．７　サイズを変更するフィルタの場合

フィルタに限り、出力画像のサイズを自由に変更することができます。変更する場合は、InitSizeをオーバーライドします。参照引数Sizeには入力画像のサイズが入っているので、出力画像のサイズを計算して書き換えます。
なお、サイズを変更する場合は必ずプレビュー不可にしてください。


２．８　プロセッサ処理を記述する

最後に、プロセッサ本来の画像処理を記述します。画像は全て32bit/pixelです。ピクセルの上位8bitはImage Mixer本体がアルファチャンネルに使用します。処理中に画像サイズを変更しないでください。
フィルタの場合：Filterメソッドの中に処理を記述します。引数はSｒｃが入力画像、Destが出力画像です。出力画像のサイズは設定済みです。
ミキサーの場合：Mixerメソッドに処理を記述します。引数はSrc1が背景画像、Src2が前景画像、Destが出力画像、Orgが合成範囲の左上座標です。画像の大きさは、2つの入力画像は合成範囲と同じ大きさで、出力画像は「重ならない部分を捨てる」のチェックの有無により異なり、
　チェック有り：出力画像は合成範囲と同じ大きさで、Orgは常に(0,0)
　チェック無し：出力画像は背景画像と同じ大きさ(合成範囲より大きい)で、Orgに合成範囲の位置(左上隅の出力画像上の座標)が入る
となります。Orgによる座標値の修正についてはミキサーサンプルのコードを参照してください。
ジェネレータの場合：Generatorメソッドに処理を記述します。引数Destは出力画像で、すでにサイズが設定されています。
処理中にはプログレスイベントを発生させるようにしてください。Progressメソッドに現在の進行状況を0〜1の小数値で渡します。


２．９　テストベンチを実行し、デバッグする

ここまでの作業でコーディングは終了です。お疲れ様でした。
テストベンチをビルド・実行し、製作したプロセッサの動作を確認します。このとき、テンプレートはProcLibフォルダにINIファイルを置くようになっているので、変更しない限り、フォルダを作らないとエラーが発生します。
処理を実行し、意図したとおりの結果が得られるようになったらテストベンチでの作業は終了です。
 
３．開発手順2−Image Mixerを用いた作業
第2ステージは、パッケージを作成してIM.exe上で実行し、テストベンチにはないスクリプトやプレビューなどの機能を中心に、最終的なデバッグを行います。

３．１　パッケージを作成、または既存のパッケージのプロセッサを追加する
 

パッケージファイルのテンプレート(MyPrcPak.dpk)がこのPDKに同梱されていますので、リネームしてプロセッサのユニットを追加します。すでにパッケージを作ってある場合は、そこに追加します。出力ディレクトリをImage MixerのProcLibフォルダに設定するとデバッグ時にコピーの手間が省けます。


３．２　パッケージをビルドする

パッケージをコンパイルし(インストールではありません)、出力された.pblファイルをImage MixerのProcLibフォルダにコピーします。デフォルトの設定では、.bplファイルはDelphiのLibフォルダに出力されます。


３．３　Image Mixerを実行し、動作を確認する
 

IM.exeを実行し、プロセッサの動作を確認します。プロセッサがロードされている(はず)ので、実行して動作を確認します。また、スクリプトからも正常に実行できることを確認します。
正常動作するようになったら完成です。
４．クラス等の仕様
(未製作)
 
５．Tips
(未製作)
 
６．配布について
プロセッサパッケージの配布はご自由にされて結構です。通常は製作した.bplファイルのみを配布すればOKですが、VCL40とIMPｒｃDef以外のパッケージが必要な場合(パッケージのRequiresに上記2つ以外のパッケージがある場合)は、そのパッケージも配布してください。
また、ユーザがスクリプトでプロセッサを使用するために必要な、プロセッサ名とパラメータ名を公開してください。
現在(2001年2月)、Image Mixerがβ版のため再配布禁止としております。よって、Image Mixer本体を同梱しての配布はご遠慮ください。
７．変更履歴