トップ > Script-Fuスクリプトの制作 >
Script-Fuプログラミングの基礎を学ぶ(バージョン 3)

GIMP専用の手続きを利用する上で、絶対に知っておかなければならない大切なことがあります。 GIMP専用の手続きには結果を返すものと返さないものがありますが、結果を返すGIMP専用の手続きは必ずリストで結果を返す、ということです。

返される結果のデータが1件の場合も複数件の場合も必ずリストで返されます。

つまり、GIMP専用の手続きから返されたデータを参照するには、手続き car・cadrなどを利用する必要がある、ということです。

知らなければならないことは他にもあります。 それは、開いている画像にアクセスするスクリプトは手続き script-fu-register-procedureではなく手続き script-fu-register-filterで登録する必要がある、ということです。

ではここで、新たな手続き gimp-image-get-width と gimp-image-get-height について紹介します。

これらの手続きを利用し、開いている画像の幅と高さを取得して表示するスクリプトを作成してみましょう。 スクリプトファイル myscript.scm を以下のように書き換えます。

では、このスクリプトを試してみましょう。

1. 任意の大きさの画像を開く

上図のように任意の大きさの画像を開きます。 今回は320 x 200の新規画像を作成しました。

では、スクリプトを実行しましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

2. ウィンドウ下部に "Width is 320 / Height is 200" と表示される

上図のようにウィンドウ下部に "Width is 320 / Height is 200" と表示されます。 目指していた通りに、画像の幅と高さを表示させることができました。

では、スクリプトの内容を詳しく見てみましょう。 最初に注目すべきは15行目の、

(script-fu-register-filter

という部分です。 このスクリプトは開いている画像にアクセスしますので、手続き script-fu-register-filterを利用しています。

次に注目すべきは20行目の、

"My Name"                                                        ; 著作権に関する表示

と、22・23行目の、

"RGB* GRAY*"                                                     ; メニュー項目を有効にするためのカラーモードの条件
SF-ONE-DRAWABLE                                                  ; メニュー項目を有効にするためのレイヤ選択の条件

という部分です。 手続き script-fu-register-filterの引数は、これまで利用していた手続き script-fu-register-procedureと比べて大幅に増えています。

では、増えた引数について解説します。 まず、

"My Name"                                                        ; 著作権に関する表示

の部分ですが、ここには著作権に関する表示のための引数を渡します。 1つ前の引数である『作成者の名前』と同じものを渡せばいいと思います。

続いての、

"RGB* GRAY*"                                                     ; メニュー項目を有効にするためのカラーモードの条件

という引数にはメニュー項目を有効にするためのカラーモードの条件を記述します。

今回は "RGB*" と "GRAY*" と記述されていますが、この記述だとカラーモードがRGB形式かグレースケール形式の場合のみメニュー項目が有効になります。 つまり、画像を開いていない状態だとメニュー項目を選択することができなくなります。

さらに次の行の、

SF-ONE-DRAWABLE                                                  ; メニュー項目を有効にするためのレイヤ選択の条件

の部分ですが、ここにはメニュー項目を有効にするためのレイヤ選択の条件を記述します。

長くなってきましたので、以下にスクリプトを再掲載します。 内容は最初に掲載したものと同じです。

続いて注目すべきは、1行目の、

(define (myscript image layers)

という部分です。 関数の名前である myscript の後ろに image と layers という記述があります。 この記述は『image と layers という名前で2つの引数を受け取る』ことを意味しています。

この2つの引数は、手続き script-fu-register-filterで登録した関数であれば必ず受け取らなければなりません。

引数 image には画像番号が、layers には選択中のレイヤ番号(ベクタ)が渡ってきます。

続いては、4・5行目に注目してみましょう。 4・5行目では、

(image-width  0)
(image-height 0)

と、2つの変数を宣言しています。 この2つの変数には後ほど取得する画像の幅と高さを格納します。

最後の注目点が肝心の8・9行目の、

(set! image-width  (car (gimp-image-get-width image)))
(set! image-height (car (gimp-image-get-height image)))

の2行です。 この2行が画像の幅と高さを取得している部分です。

手続き gimp-image-get-width と gimp-image-get-height には、引数として画像番号を渡す必要があります。 受け取った引数 imageが画像番号ですので、引数 imageをそのまま渡しています。

手続き gimp-image-get-width と gimp-image-get-height から返された結果は、手続き carを使って取り出し、変数 image-width と image-height に格納しています。

すでに説明したように、GIMP関連の手続きは戻り値が1件の場合も複数件の場合も必ずリストで返します。 よって、手続き carが必要というわけです。

画像の大きさが320 x 200の場合だと仮定すると、手続き gimp-image-get-width から返された戻り値を入れ子のコンスセルで表現すると、

となり、手続き gimp-image-get-height から返された戻り値は、

となります。 手続き carを利用しなければ、320 や 200 を取り出すことはできません。

ではここで、手続き gimp-image-get-widthの仕様を確認しておきましょう。 引数をいくつ受け取るのか、引数には何を渡すのか、戻り値はいくつで何が返されるのかなどを確認します。

Script-Fu プロシージャブラウザーから確認します。 Script-Fu プロシージャブラウザーの開き方については以前のこの記事で解説しています。

3. 手続き gimp-image-get-widthの詳細が表示される

上図のようにScript-Fu プロシージャブラウザーを開き、gimp-image-get-widthを検索します。 この詳細からわかる内容は以下の通りです。

1つ目の引数の種別が GimpImage となっていますが、これが画像番号のことです。 また、戻り値の種別が gint となっていますが、これは数値(Integer:整数)のことです。

では次に、新たな手続き gimp-image-get-layers と gimp-item-get-name について紹介します。

これらの手続きを利用し、開いている画像のレイヤの名称を列挙するスクリプトを作成してみましょう。 スクリプトファイル myscript.scm を以下のように書き換えます。

では、このスクリプトを試してみましょう。

1. 複数のレイヤを持つ画像を開く

上図のように複数のレイヤを持つ画像を開きます。 今回は上から "太陽" / "雲" / "青空" の3枚のレイヤを持つ画像です。

では、スクリプトを実行しましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

2. ウィンドウ下部に "Layer Name is 太陽 / 雲 / 青空" と表示される

上図のようにウィンドウ下部に "Layer Name is 太陽 / 雲 / 青空" と表示されます。 目指していた通りに、レイヤの名称を列挙することができました。

スクリプトの中身を解説する前に、手続き gimp-image-get-layersの仕様を確認しておきましょう。 Script-Fu プロシージャブラウザーから確認します。

3. 手続き gimp-image-get-layersの詳細が表示される

上図のようにScript-Fu プロシージャブラウザーを開き、gimp-image-get-layersを検索します。 この詳細からわかる内容は以下の通りです。

戻り値の種別が GimpCoreObjectArray となっていますが、これはレイヤ番号(またはチャンネル番号やパス番号)のベクタのことです。 なお、引数や戻り値の種別が xxxxArray となっていても、それが必ずベクタであるとは限りません。 リストの場合もあります。

説明には "The list of layers..." と書かれていますが、ここでの "list" とは "一覧" という意味のリストであり、プログラミング言語Schemeのリスト(コンスセルがつながったもの)のことではありません。

なお、(しつこいようですが)、GIMP関連の手続きは戻り値をリストで返します。 この手続きが返す GimpCoreObjectArrayのlayers もリストの要素として返されます。

例えば、3枚のレイヤを持つ画像で、レイヤ番号が 1・2・8 の場合は、この手続きからの戻り値は、

となります。

従って、手続き carを使うことで、

というレイヤ番号のベクタを取り出すことができます。 取り出したベクタの中のそれぞれの情報を取り出すには、過去の記事で紹介した手続き vector-refを使います。

では、スクリプトの中身を見ていきましょう。 寄り道が長くなったので、以下にスクリプトを再掲載します。 内容は最初に掲載したものと同じです。

まず、4行目から9行目で、

(layer-array 0)
(layer-count 0)
(layer-index 0)
(layer-id    0)
(layer-name  "")
(message     "")

のように変数を宣言していますが、それぞれの変数の役割は以下の通りです。

次に注目すべきは12・13行目です。

(set! layer-array (car (gimp-image-get-layers image)))
(set! layer-count (vector-length (car (gimp-image-get-layers image))))

手続き gimp-image-get-layersから返された戻り値(ベクタ)を変数 layer-arrayに、戻り値のベクタの件数を変数 layer-countに格納しています。

例えば、3枚のレイヤを持つ画像でレイヤ番号が 1・2・8 の場合は、変数 layer-arrayには、

というベクタのデータが格納されます。 同様に変数 layer-countには、

が格納されます。

次に注目すべき箇所は、17行目から31行目までの手続き whileによる繰り返しの部分です。 繰り返しの条件が、

(< layer-index layer-count)

となっており、変数 layer-indexが変数 layer-countよりも小さい間は処理を繰り返します。

変数 layer-indexは初期値が 0(ゼロ) で、30行目の、

(set! layer-index (+ layer-index 1))

という記述により、毎回 +1 されますので、繰り返される回数は変数 layer-countの値(=レイヤの枚数)と同じになります。

繰り返しの内側では、

(set! layer-id (vector-ref layer-array layer-index))

という記述により、変数 layer-arrayのベクタの中の情報が1件だけ取り出されて変数 layer-idに格納されます。 変数 layer-indexを番号とする情報が取り出されるので、繰り返しの1回目では、

が取り出され、繰り返しの2回目には、

が取り出され、繰り返しの3回目には、

が取り出されます。

その次の行の、

(set! layer-name (car (gimp-item-get-name layer-id)))

では、変数 layer-idに格納されているレイヤ番号からレイヤ名称を取得し、変数 layer-nameに格納しています。

同じく繰り返しの内側である22行目から26行目では、

(if (> layer-index 0)
    (begin
        (set! message (string-append message " / "))
    )
)

のように、変数 messageに格納されている文字列を操作しています。 変数 layer-indexが 0(ゼロ) より大きければ変数 messageに文字列 " / " を連結しています。

これは、繰り返しの2回目以降ならレイヤ名とレイヤ名の間を区切るための区切りとして " /" を足す、という処理です。

その次の、

(set! message (string-append message layer-name))

では、20行目で取得したレイヤ名称を変数 messageに連結しています。

繰り返しを抜けると33行目でメッセージが表示されます。

(gimp-message message)

により、変数 messsageの中身がメッセージとして表示されます。

次に紹介するのは、手続き gimp-image-get-selected-layers と gimp-layer-add-alpha の2つです。

これらの手続きを利用し、選択中のレイヤにアルファチャンネルを追加するスクリプトを作成してみましょう。 スクリプトファイル myscript.scm を以下のように書き換えます。

解説の必要がなさそうなほど単純なスクリプトですが、一応説明しておきます。 まず、4行目の、

(activelayer-id 0)

では、変数 activelayer-idを宣言していますが、この変数は選択中のレイヤのレイヤの番号を格納するためのものです。 さらに7行目の、

(set! activelayer-id (vector-ref (car (gimp-image-get-selected-layers image)) 0))

で、変数activelayer-idに手続き gimp-image-get-selected-layersが返す選択中のレイヤのレイヤ番号を格納しています。

9行目の、

(gimp-layer-add-alpha activelayer-id)

が、選択中のレイヤにアルファチャンネルを追加している部分です。 変数activelayer-idのレイヤにアルファチャンネルを追加しています。

では、このスクリプトを試してみましょう。

1. アルファチャンネルを持たないレイヤを含む画像を開く

上図のようにアルファチャンネルを持たないレイヤを含む画像を開きます。 今回は上からアルファチャンネル あり / なし / なし の3枚のレイヤを持つ画像です。

選択されているレイヤは、2枚目のアルファチャンネル なし のレイヤです。 レイヤ名称が太字で表示されていることから判断できます。

では、スクリプトを実行しましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

2. 選択中の2枚目のレイヤにアルファチャンネルが追加されている

上図のように選択中の2枚目のレイヤにアルファチャンネルが追加されています。 レイヤ名称が太字ではなくなっています。