Blenderにライブラリ(AGG、Expat)を組み込む

今回からBlender本体にSVGテクスチャプラグインvectexの機能を組み込む作業に取りかかります。まずは、vectexが使用している2つのライブラリ、AGGとExpatをBlenderのコードから利用できるようにしてみます。

Blenderには様々なライブラリが使用されています。
分かりやすいところではJpeg、PNGなどの画像ファイルを扱うためのライブラリや、動画の処理をするFFmpegなどが使われています。
Blenderのソースコードの中に入っていて静的にリンクされているものと、システムにインストールされているDLL、シェアードライブラリに動的にリンクされるものがあります。

ライブラリを組み込む場合、このどちらの方法でリンクするかによって必要な処理が若干変わってきますが、今回の場合は、

1. AGGはもともとDLL、シェアードライブラリとして使うことを想定したライブラリではないので、静的リンクで使用する。
2. Expatは動的リンクを使うことが可能だが、もともとvectexで静的リンクで使用しているので、同じように静的リンクで使用する。

という感じで、どちらのライブラリもソースコードをBlenderの一部に組み込んで、Blenderのビルド時にまとめてコンパイルするようにします。

vectexを組み込む改造版BlenderのビルドにはSconsを使用する方針です。
とりあえずはSconsの設定ファイルだけを修正していき、CMakeなどの設定ファイルについては余裕ができたら少しずつ対応していくつもりです。

ちなみに今回もLinuxのみに限定して話を進めていきます。
実は、vectexのプラグインについては、Windows上のSconsではまだコンパイルに成功していません。BlenderについてはなんとかMinGW上のSconsでビルドできていますので、改造版BlenderがLinuxで動作できるようになったらWindowsにも対応できると思います。

使用するBlenderのバージョンは今のところ2.48aですが、2.49がリリースされた時点でそちらに移行していくつもりです。
今回作成または修正した部分のソースコードをこちら(src090521.zip)にまとめました。

○ライブラリのソースコードを組み込む
Sconsでビルドを行うための設定ファイルの修正を始める前に、まずAGG、ExpatのソースコードをBlenderのソースディレクトリのどこに置くのかを決める必要があります。

Blenderのトップディレクトリにはextern、internというディレクトリがあり、その中にいくつかのライブラリが置かれています。
どのようなものがどちらに置かれるべきなのか詳しいことはよく分からないのですが、とりあえずexternディレクトリの下に置くことにしてみます。後で別の場所に置くべきだと分かれば、変更するかもしれません。


vectexが使用するライブラリ自体はAGG、Expatの2つなのですが、AGG SVG Viewerの部分のソースコードもライブラリのように扱ってしまった方が構成がすっきりするように思いますので、今回はこの部分をaggsvgというディレクトリにまとめることにします。

ついでにvectex本体のソースコードファイル3つのうちvectex_agg.cpp、vectex.hの2つも、ここに入れてしまうことにします。
vectex_agg.cppは、その拡張子を見て分かる通り「C++」のソースコードですが、Blenderのソースコードは外部のライブラリやゲームエンジン以外は基本的に「C」のソースコードで書かれています。C++のコードとCのコードが混在している場合、ビルド時のコンパイルオプションなどが若干面倒になる可能性もあるため、ちょっと不自然な感じもしますが、今回はこのような感じにファイルを配置することにしました。

ソースコードの配置については、後はvextex.cのソースコードをBlenderのプロシージャルテクスチャをまとめてあるソースファイル「blender/source/blender/render/intern/source/texture.c」の中にまるごと組み込むだけとなります。


○Sconsのビルド用設定ファイル
BlenderをSconsでビルドするための設定ファイルは、トップディレクトリにあるSConscriptファイル以外にもいくつか重要なファイルがあります。
Blenderのトップディレクトリにある「config」フォルダには、ビルドを行う各OSに対応するための「.py」(Python)ファイルがあります。また、同じくトップディレクトリにある「tools」フォルダにもいくつかの「.py」ファイルがあって、こちらもSconsのビルドの時に使用されます。

新規にライブラリを追加するために修正が必要となるのは、「config」フォルダ内のファイル(今回はLinux限定なのでlinux2-config.pyのみ)、「tools」フォルダ内のBlender.pyとbtools.pyです。


具体的にどこをどう修正すればいいかについては、Blenderトップディレクトリにある「doc」フォルダのblender-scons-dev.txtというファイルに詳しく書かれています。


○config/linux2-config.py
本来はすべてのプラットフォームでビルドできるようにするためconfigフォルダ内のすべてのXXX-config.pyファイルを修正するはずなのですが、今回はとりあえずLinux以外については後回しとしてlinux2-config.pyのみを修正することにします。

...
#for vectex SVG texture
WITH_BF_VECTEX = True
BF_AGGSVG = '#extern/aggsvg'
BF_AGGSVG_INC = '${BF_AGGSVG}/include'
BF_AGGSVG_LIB = 'extern_aggsvg'
BF_AGGSVG_LIBPATH = '${BF_AGGSVG}/lib'

BF_AGG = '#extern/agg'
BF_AGG_INC = '${BF_AGG}/include'
BF_AGG_LIB = 'extern_agg'
BF_AGG_LIBPATH = '${BF_AGG}/lib'

BF_EXPAT = '#extern/expat'
BF_EXPAT_INC = '${BF_EXPAT}/include'
BF_EXPAT_LIB = 'extern_expat'
BF_EXPAT_LIBPATH = '${BF_EXPAT}/lib'
...

AGG、EXPAT、AGGSVGのそれぞれについて、ライブラリのベースとなる場所、インクルードファイルの場所、ライブラリ名、ライブラリファイルの場所を指定するためのSconsのオプションを追加しています。
また、今回追加するライブラリをビルド時にオン/オフ切り替えできるようにするためのオプションとしてWITH_BF_VECTEXというものも追加しました。
他のライブラリを見ると、それぞれのライブラリ毎にWITH_BF_XXXオプションを付けているようですが、今回はどれかひとつだけをオフにできるようにしても意味がなさそうなので、ひとつにまとめてしまいました。

○tools/btools.py
このファイルにはライブラリをビルドするためのオプションを全て列挙している記述が2ヶ所ありますので、今回追加したオプションの分を追加します。

def validate_arguments(args, bc):
    opts_list = [
            ...
            'WITH_BF_VECTEX', 'BF_AGGSVG', 'BF_AGGSVG_INC', 'AGGSVG_LIB', 'AGGSVG_LIBPATH',
            'BF_AGG', 'BF_AGG_INC', 'BF_AGG_LIB', 'BF_AGG_LIBPATH',
            'BF_EXPAT', 'BF_EXPAT_INC', 'BF_EXPAT_LIB', 'BF_EXPAT_LIBPATH',
            ...

def read_opts(cfg, args):
    localopts = Options.Options(cfg, args)
    localopts.AddOptions(
        ...
        (BoolOption('WITH_BF_VECTEX', 'Use vectex if tue', True)),
        ('BF_AGGSVG', 'AGGSVG base path', ''),
        ('BF_AGGSVG_INC', 'AGGSVG include path', ''),
        ('BF_AGGSVG_LIB', 'AGGSVG library', ''),
        ('BF_AGGSVG_LIBPATH', 'AGGSVG library path', ''),
   
        ('BF_AGG', 'AGG base path', ''),
        ('BF_AGG_INC', 'AGG include path', ''),
        ('BF_AGG_LIB', 'AGG library', ''),
        ('BF_AGG_LIBPATH', 'AGG library path', ''),
   
        ('BF_EXPAT', 'EXPAT base path', ''),
        ('BF_EXPAT_INC', 'EXPAT include path', ''),
        ('BF_EXPAT_LIB', 'EXPAT library', ''),
        ('BF_EXPAT_LIBPATH', 'EXPAT library path', ''),
        ...

○tools/Blender.py
このファイルでは、ビルド時のライブラリオプションに関する記述を修正します。
こちらはライブラリの場所の記述です。

## TODO: static linking
def setup_staticlibs(lenv):
    statlibs = [
        #here libs for static linking
    ]
    ...
    if lenv['WITH_BF_VECTEX']:
        libincs += Split(lenv['BF_AGGSVG_LIBPATH'])
        libincs += Split(lenv['BF_AGG_LIBPATH'])
        libincs += Split(lenv['BF_EXPAT_LIBPATH'])
    ...

こちらはライブラリ名です。

def setup_syslibs(lenv):
    syslibs = [
       
        lenv['BF_JPEG_LIB'],
        lenv['BF_PNG_LIB'],
        lenv['BF_ZLIB_LIB']
        ]
    ...
    if lenv['WITH_BF_VECTEX']:
        syslibs += Split(lenv['BF_AGGSVG_LIB'])
        syslibs += Split(lenv['BF_AGG_LIB'])
        syslibs += Split(lenv['BF_EXPAT_LIB'])
    ...

○extern/Sconscript
Sconsの全体に関係する設定ファイルの他に、実際にライブラリのソースファイルを置いた場所にあるSConscriptファイルを修正する必要があります。
WITH_BF_VECTEXがオンのとき、aggsvg、agg、expatのそれぞれの場所に置いたSconscriptファイルを実行します。

#!/usr/bin/python

Import('env')

SConscript(['glew/SConscript'])
...
if env['WITH_BF_VECTEX']:
    SConscript(['aggsvg/SConscript'])
    SConscript(['agg/SConscript'])
    SConscript(['expat/SConscript'])
...

○extern/agg/SConscript
前回の記事でテクスチャプラグインとしてvectexをSconsでコンパイルしたときのSConscriptファイルとはかなり違っています。externフォルダにある他のライブラリのSConscriptを参考にして書き直しました。

#!/usr/bin/python
import sys
import os

Import('env')

sources = env.Glob('src/*.cpp') + env.Glob('gpc/*.c') + env.Glob('src/ctrl/*.cpp')
incs = 'include include/ctrl gpc'
defs = ''
cflags = '-fPIC -c -O3'

env.BlenderLib ( libname='extern_agg',
        sources=sources, includes=Split(incs),
        defines=Split(defs),
        libtype=['blender', 'common'],
        priority=[10, 20], compileflags = Split(cflags))

今回は、各ライブラリのトップディレクトリのSConscriptだけで完結するようにしました。
また、最終的にライブラリを作成する部分はenv.Library()ではなくて、tools/Blender.pyの中にあるBlenderLIb()という関数を使っています。
この関数には、ライブラリ名、ソースファイル、インクルードファイルの場所、コンパイルオプションなどの他に、libtype、priorityという引数を渡しています。
この2つについては、今ひとつよくわからなかったのですが、リンク時に問題が起こった場合に調整するために使用するもので、通常は指定する必要はないようです。

○extern/expat/SConscript

#!/usr/bin/python
import sys
import os

Import('env')

sources = ['lib/xmlparse.c','lib/xmlrole.c','lib/xmltok.c',
    'xmlwf/xmlwf.c','xmlwf/xmlfile.c','xmlwf/codepage.c','xmlwf/unixfilemap.c']
incs = '. lib xmlwf'
defs = ''
cflags = '-fPIC -Wall -Wmissing-prototypes -Wstrict-prototypes -fexceptions -DHAVE_EXPAT_CONFIG_H -c'

env.BlenderLib ( libname='extern_expat',
        sources=sources, includes=Split(incs),
        defines=Split(defs),
        libtype=['blender', 'common'],
        priority=[10, 20], compileflags = Split(cflags))

○extern/aggsvg/SConscript
インクルードファイルの指定に#/intern/guardedallocという指定を追加してあります。
これは、テクスチャプラグインとしてvectexが使用していたメモリ処理関連の関数をBlenderの内部用のものに変更したために、そのメモリ処理の関数のライブラリ用のヘッダファイルの場所を追加しています。

#!/usr/bin/python
import sys
import os

Import('env')

sources = env.Glob('*.cpp')
incs = '. ../agg/include ../expat/lib #/intern/guardedalloc'
defs = ''
cflags = '-fPIC -shared -O -ansi'

env.BlenderLib ( libname='extern_aggsvg',
        sources=sources, includes=Split(incs),
        defines=Split(defs),
        libtype=['blender', 'common'],
        priority=[10, 20], compileflags = Split(cflags))

○extern/aggsvg/vectex.h
テクスチャプラグイン用にエクスポートされているメモリ処理関数を使わなくするために、以下の部分をコメントアウトしてあります。

...
/*
EXT void *memory_alloc(int len, char *str);
EXT void memory_free(void *ptr);
*/
...

○extern/aggsvg/vectex_agg.cpp
Blender内部用のメモリ処理関数が書かれたヘッダファイルをインクルードしています。
vectex.h、vectex.cファイルに書かれているmemory_alloc()を使うのを止めて、MEM_malocN()関数を使うようにしました。
この関数は、テクスチャプラグイン用にutil.hでエクスポートされているmallocN()という関数の本体(/source/blender/blendpluginapi/intern/pluginapi.c)で使用されているのと同じものを使っています。

...
#include "MEM_guardedalloc.h"
...
    /*
    unsigned char          *buf = (unsigned char *)memory_alloc(width * height * 3, "vectex:tile");
    */
    unsigned char          *buf = (unsigned char *)MEM_mallocN(width * height * 3, "vectex:tile");
...

○ビルド
以上のファイルを使って実際にビルドを行うためには、この他にBlender/externディレクトリにagg、expat、aggsvgというフォルダを作成し、vectexのソースコードのフォルダから対応するソースコードをコピーしておく必要があります。
aggsvgディレクトリには、vectexソースコードのトップディレクトリにある「.h」「.cpp」ファイルをすべてコピーします。

aggディレクトリには、vectexソースコードのagg-2.5フォルダの中身をまるごとコピーします。
expatディレクトリには、vectexソースコードのexpat-1.95.8フォルダの中身をまるごとコピーします。

これで、Blenderにvectexで使用しているライブラリを組み込む作業が完了しました。

この状態で、とりあえずビルドを実行することができます。
vectexの本体のソースコードはまったく組み込んでいませんので、ビルドの結果できあがるのは普通のBlenderです。
ライブラリのビルドの結果は、Blenderのソースコードディレクトリの外部「build/linux2/lib」にlibextern_agg.a、libextern_expat.a、libextern_aggsvg.aという3つのファイルが作成されていることで確認できます。


次回からは、vectex.cのソースコードをBlenderに組み込んでいく予定です。

Sconsでvectexをコンパイルする

前回Blenderへのプロシージャルテクスチャの追加方法を確認できたので、続いて本番のvectexの方に取りかかりたいところですが、その前にもう少し調べておきたいことがありました。
Blenderにvectexを組み込むためには、vectexで使用しているAgg、ExpatなどのライブラリをBlenderのビルドシステムから利用できるようにする必要があります。

BlenderはビルドのためのツールとしてGnu Make、Scons、CMakeの3種類の方法を用意しています。(詳しくは、こちらのページをご参照ください。)

私自身はLinuxでのビルドにSconsを使い、WindowsではCMake + Visual C++を主に使っています。CMakeを使ってAnjuta、KDevelopなどのLinuxのIDEを使う方法、WindowsのMingw + Sconsというような方法でもビルドできることを確認しています。

vectex自体はGnu Makeでコンパイルするようになっていますので、Gnu Makeのビルドシステムを使うのが一番楽にvectexの組み込みができそうですが、残念ながらこの方法ではWindowsでコンパイルするのが難しいようです。
可能であれば3種類のすべてのビルドシステムに対応できるようにしたいところですが、とりあえずはSconsを使ってビルドを行うことを前提にvectexの組み込みを進めようと思います。

とは言ったものの、これまでLinuxでのプログラミングにはMakefileを少し書いたことがある程度で、他の方法は試したことがありません。
いきなりBlenderのSconsの設定ファイルを読むのは難しそうですので、もう少し基本的なところから少しずつ慣れていく方がよさそうです。

ということで、まずはvectexをSconsを使ってコンパイルしてみることにしました。(今回は、とりあえずLinux上のみに限定しておきます。)
作成したSconsの設定ファイルをこちら(scons_file090513.zip)にまとめてあります。

○Sconsによるビルドの基本
SconsはPythonを使ったビルドシステムです。

Sconsでビルドを行うには「SConstruct」というファイルを用意し、そのファイルが置かれているディレクトリに移動して、コマンドラインから「scons」と実行します。
それぞれ、Gnu Makeを使う場合の「Makefile」、「make」コマンドと同じような感じで使います。

詳しい使い方は、scons.orgのユーザーズガイド、マニュアルをご参照ください。

Makefileの場合は、コマンドラインで入力するコマンドをそのままテキストファイルに記述する感じですが、SConscriptはかなり特殊な記述になります。

伝統的なhello worldで説明すると、
hello.c

#include <stdio.h>
int main(int argc, char** argv)
{
    printf("Hello world.\n");
}

というソースファイルに対して、

Makefile

hello: hello.c
    gcc -o hello hello.c

SConstruct

Program('hello','hello.c')

という感じになります。


○vectexのMakefileをSConstructに置き換える(single_file)
Agg、ExpatについてはとりあえずそれぞれのMakefileを使ってコンパイルを行うことにして、作成済みのlibagg.a、libexpat.aファイルを使用する形でSConstructファイルを作ってみました。

env = Environment()
env.Append(CCFLAGS = '-fPIC -shared -O -ansi')
env.Append(CPPPATH = ['.', 'blender','agg-2.5/include','expat-1.95.8/lib'])
env.Append(LIBS = ['m', 'c'])
env.Append(LIBS=File('agg-2.5/src/libagg.a'))
env.Append(LIBS=File('expat-1.95.8/.libs/libexpat.a'))
env.LoadableModule('vectex.so', ['vectex.c',  'vectex_agg.cpp','agg_svg_parser.cpp','agg_svg_path_renderer.cpp','agg_svg_path_tokenizer.cpp'])

先ほどのhello worldのときのProgram('hello','hello.c')に当たる部分は一番最後の行です。
普通の実行ファイルを作成する場合はProgram()というメソッドを使いましたが、BlenderのテクスチャプラグインのようなDLL、Shared Library形式のファイルを作成するにはSharedLibrary()またはLoadableModule()というメソッドを使用します。
複数のソースファイルから一つの実行ファイルを作成するような場合、

Program('ターゲット名',['ソースファイル1','ソースファイル2' ... ,'ソースファイルn'])

というようにソースファイルをリストでまとめて指定します。
ヘッダファイルについては自動的に処理されるのでファイル名を指定する必要はありません。

それ以外の部分は、コンパイル時のオプション指定、インクルードファイルの場所の指定、使用するライブラリの指定を行っています。
ライブラリの指定は本来ならば、

env.Append(LIBS = ['m', 'c', 'agg', 'expat'])
env.Append(LIBPATH = ['agg-2.5/src','expat-1.95.8/.libs'])

というような形でライブラリ名、ライブラリの場所をそれぞれまとめて指定するべきだと思うのですが、今回はExpatのライブラリファイルの置かれている場所にスタティックリンク用、ダイナミックリンク用の両方のファイルがあり、ファイルの名前を直接指定する方法を使っています。

Environment()というのはちょっと説明しづらいですが、env1、env2というように複数の環境を用意して、それぞれにデバッグ用、リリース用の設定を行うというような使い方ができるようです。
後述するように、サブディレクトリのコンパイルを行う際にトップディレクトリの設定を引き継ぐというような使い方もできます。

このSConstructファイルをvectexのトップディレクトリに置いて、コマンドラインから「scons」と実行することでlibvectex.soというファイルが作成されます。
vectex付属のMakefileを使うとvectex.soというファイル名でプラグインが作成されますが、sconsではShared Library形式でファイルを作成する場合、Linux上では自動的に名前の頭に「lib」が付くようになっています。
付かないように設定することもできるようなのですが、このままでも特に問題ないと思いますのでそのままにしています。


○Agg、ExpatのSconsでのコンパイル(multi_file)
vectex付属のMakefileではAgg、ExpatのコンパイルについてはそれぞれのMakefileを呼び出す形で行っています。
Blenderのソースコードに含まれているFFmpegやOpenJPEGなどのライブラリを見てみると、SConscriptファイルが置かれていてSconsを使ってコンパイルを行うようになっています。
Blenderにこれらのライブラリを組み込むのであれば、Sconsでコンパイルできるようにした方がよさそうです。

SconsではトップディレクトリにあるSConstructというファイルとは別に、サブディレクトリにSConscriptというファイルを置いて、階層的にビルド設定ファイルを分離することができます。
この機能を使用してAgg、ExpatをSconsでコンパイルできるようにしてみました。
SConstruct

env = Environment()
SConscript(['agg-2.5/SConscript','expat-1.95.8/SConscript'])
env.Append(CCFLAGS = '-fPIC -shared -O -ansi')
env.Append(CPPPATH = ['.', 'blender','agg-2.5/include','expat-1.95.8/lib'])
env.Append(LIBS = ['m', 'c'])
env.Append(LIBS=File('agg-2.5/libagg.a'))
env.Append(LIBS=File('expat-1.95.8/libexpat.a'))
env.LoadableModule('vectex.so', ['vectex.c',  'vectex_agg.cpp','agg_svg_parser.cpp','agg_svg_path_renderer.cpp','agg_svg_path_tokenizer.cpp'])

先ほどと違っているのは、2行目
SConscript(['agg-2.5/SConscript','expat-1.95.8/SConscript'])

と6、7行目です。
env.Append(LIBS=File('agg-2.5/libagg.a'))
env.Append(LIBS=File('expat-1.95.8/libexpat.a'))

2行目では、Agg、Expatのディレクトリに置いたSConscriptを呼んで、それぞれのライブラリファイルを作成しています。
6、7行目は、Agg、Expatで作成されるライブラリファイルの場所を変更しているため、ライブラリファイルの指定をそれに合わせています。

○AggのSConscript
Agg-2.5/SConscript

env = Environment()
env.Append(CCFLAGS = '-fPIC -c -O3')
env.Append(CPPPATH = ['#agg-2.5/include'])
Export('env')
objs = []
for subdir in ['src', 'gpc', 'src/ctrl']:
    o = SConscript('%s/SConscript' % subdir)
    objs.append(o)
env.Library('agg', objs)

Aggのソースファイルは「src」「gpc」「src/ctrl」という別のサブディレクトリの中に置かれています。
そのため、それらのサブディレクトリにも、それぞれSConscriptファイルを置いて、AggのトップディレクトリにあるSConscriptファイルから呼び出すようにしました。

Export()を使用すると、envで設定したコンパイルオプション、インクルードファイルの場所、使用するライブラリなどの情報を呼び出される側のSConscriptに渡すことができます。
vectexトップディレクトリにあるSConstructとAgg、ExpatのトップディレクトリのSConscriptのenvの間では設定内容は引き継がれていません。

「CPPPATH =」でインクルードファイルの指定をしている部分を見ると、パスの頭に「#」が付けてあります。
このように「#」を付けてパスを指定すると、その部分はSconsのトップディレクトリ(SConstructのある場所)からの相対パスとして処理されます。
これによりサブディレクトリ内でのコンパイルを行っているときでも、問題なくインクルードファイルを読み込むことができるようになります。

最後の行がhello worldのProgram()に対応する部分で、スタティックライブラリを作成するLibrary()メソッドを使用しています。
SharedLibrary()と同様に、作成されるライブラリファイルの名前は、Linuxでは自動的にlibagg.aというように頭に「lib」が追加されます。

Aggの元のMakefileではsrcディレクトリにライブラリファイルが作成されるようになっていますが、今回作成したSconscriptファイルではAggのトップディレクトリにライブラリファイルlibagg.aが作成されるようになります。


「src」「gpc」「src/ctrl」に置くSConscriptファイルは基本的には同じ内容のものですが、「gpc」にあるソースファイルは拡張子が「.cpp」ではなくて「.c」となっているため、その部分だけ違っています。

Agg-2.5/src/SConscript
Agg-2.5/src/ctrl/SConscript

Import('env')
obj = env.Object(Glob('*.cpp'))
Return('obj')

Agg-2.5/gpc/SConscript

Import('env')
obj = env.Object(Glob('*.c'))
Return('obj')

Import()で、envに設定された情報をAggトップディレクトリのSConscriptファイルから受け取っています。
また、Return()を使用することで、コンパイルして作成されるオブジェクトファイルのリストをAggトップディレクトリのSConscriptファイルに返しています。

○ExpatのSConscript
expat-1.95.8/SConscript

env = Environment()
env.Append(CCFLAGS = '-fPIC -Wall -Wmissing-prototypes -Wstrict-prototypes -fexceptions -DHAVE_EXPAT_CONFIG_H -c')
env.Append(CPPPATH = ['#expat-1.95.8','#expat-1.95.8/lib','#expat-1.95.8/xmlwf'])
Export('env')
objs = []
for subdir in ['lib', 'xmlwf']:
    o = SConscript('%s/SConscript' % subdir)
    objs.append(o)
env.Library('expat', objs)

Aggのものとほとんど同じです。
コンパイルのオプションは、元のMakefileからそのままコピーしています。

expat-1.95.8/lib/SConscript

Import('env')
obj = env.Object(['xmlparse.c','xmlrole.c','xmltok.c'])
Return('obj')

expat-1.95.8/xmlwf/SConscript

Import('env')
obj = env.Object(['xmlwf.c','xmlfile.c','codepage.c','unixfilemap.c'])
Return('obj')

Aggのサブディレクトリでは、Grob()メソッドを使用して同じ拡張子のファイルをまとめて処理していましたが、expatでは「.c」ファイルをインクルードファイルとして使うというようなことが行われているため、実際にオブジェクトファイルを出力するファイルだけを列挙するようにしました。

Blenderへの新しいプロシージャルテクスチャの追加

vectexをマルチスレッドレンダリングに対応させる過程で、Blenderのテクスチャプラグインのプログラミングについて学ぶことができました。今後、vectexをさらに改造していく予定ですが、それに合わせてBlenderのソースコードの中身についても、少しずつ勉強していきたいと思っています。

今後進めていく作業内容としては
・vectexをBlender本体に組み込む
・vectexで使用可能なSVGの機能を強化する
の2つを目標としていきたいと考えています。

テクスチャプラグインの形態のままでSVGの機能を強化し、その後Blenderに組み込むか、現状のままBlenderに組み込んでおいて、後からSVG機能を強化するか、どちらがいいのか悩むところです。
vectexのSVG機能を強化する方法については、
・今のままAGGを使用し続ける。
・別のSVGライブラリに乗り換える。
このどちらかの対応が考えられますが、どちらにしてもかなり苦労しそうな予感がします。

現状のままでvectexをBlenderに組み込むことは、使用しているライブラリのAGG、expatなどをうまくBlenderのビルドシステムに対応させられるかという点に若干不安を感じますが、こちらの方が難易度は低そうに思います。
ということで、まずはvectexをBlenderに組み込む作業を行い、その過程でもう少し経験値を高めてから、後でSVG機能を強化するという方向で行こうと思います。

この作業を行うにあたって、とても参考になりそうな情報(Doc/Adding A Procedural Texture)がBlender.orgにありました。

ここで言うプロシージャルテクスチャというのは、Blenderの「Texture」パネルの「Texture Type」で選択して使用する組み込みテクスチャのことです。
このチュートリアルを最後まで完成させるとジュリアフラクタルテクスチャという新しいテクスチャを使えるようになるというものですが、プログラミングの内容はテクスチャプラグイン作成のためのチュートリアルにかなり近いことを行っていると予想できます。

今回はこのチュートリアルを参考にして、以前書いた「テクスチャプラグインを作ってみる」という記事で作成した非常に簡単なテクスチャをBlenderに組み込んでみたいと思います。


以下、プロシージャルテクスチャを追加するための作業を進めていくわけですが、今回は全部で3つのソースファイルを修正することになります。

1. 変数の定義:　DNA_texture_types.h
2. 描画処理:　texture.c
3. UIの作成:　buttons_shading.c

それぞれ、ソースコードの役割が違うため、置かれている場所も全く違っています。
今回使用しているのはBlender2.48aのソースコードです。修正した部分のソースコードはこちら(src090505.zip)になります。

○変数の定義 (/blender/source/blender/makesdna/DNA_texture_types.h)
Tex構造体の中に変数を追加します。(line:130-176)

typedef struct Tex {
    ID id;
   
    float noisesize, turbul;
    float bright, contrast, rfac, gfac, bfac;
    float filtersize;
    ...
    float test_val;
    ...
    float pad;
    ...
    struct ColorBand *coba;
    struct EnvMap *env;
   
    short fradur[4][2];
   
} Tex;

この構造体には、今回作成するテクスチャも含めて、全てのプロシージャルテクスチャが使用する変数がまとめて置かれています。
今回、新たに追加するのは境界線の位置を調整するための数値を保持するfloat型変数一つだけとなります。

    float test_val;
   
この一行だけを追加した状態で一旦ビルドを実行してみると、エラーが出てしまいます。


これについては元のチュートリアルできちんと解説されています。
詳しいことはよく分からないのですが、この構造体は8byteのアライメントにしたがう必要があるので他に4byte何かのデータを追加してサイズを合わせるように、ということらしいです。

ということで、

    float pad;

という一行を追加しました。
これでエラーが解消され、コンパイルできるようになります。


このファイルには、もう一ヶ所修正が必要な場所があります。
各テクスチャを区別するための番号として定数を割り当てている場所があります。(Line:197-210)

...
#define TEX_VORONOI        12
#define TEX_DISTNOISE    13
#define TEX_TEST        14

/* musgrave stype */
#define TEX_MFRACTAL        0
#define TEX_RIDGEDMF        1
...

最後が13で終わっているので、それに続けて「14」を割り当てます。

○描画処理 (/blender/source/blender/render/intern/source/texture.c)
こちらのソースコードには、色々なテクスチャの関数本体が置かれています。
適当な場所に今回作成するテクスチャのコードを追加します。

static int test_tex(Tex *tex, float *texvec, TexResult *texres)
{
    if (texvec[0] <= tex->test_val) {
            texres->tin = 0;
    } else {
        texres->tin = 1;
    }

    return TEX_INT;
}

この関数は、テクスチャプラグインでのplugin_tex_doit()関数にかなり似ています。

テクスチャプラグインのresult[]配列に相当するのがTexResultという構造体で、この構造体の中に計算結果を入れることでレンダラにデータを渡しています。
テクスチャプラグインのときと同じように、この関数の戻り値は強度、色、ノーマルのうちどの値を使用しているかを指定するために使われています。

ここで行われている計算の中身ですが、先ほどTex構造体の中に作成しておいたtest_valという変数には、後に作成するパネルの数値スライダの値が入ります。
texvec[0]には、レンダラが現在計算している位置のテクスチャ座標のX値が渡されますので、その値が数値スライダの指している位置よりも小さい(左)ならテクスチャのINT(ENSITY)値を0(黒)にし、大きい(右)なら1(白)にします。

最後に、この計算ではテクスチャの強度(INT)のみを使用していますので、関数の戻り値としてTEX_INTを返しています。

このファイルにも、修正箇所がもう一つあります。
Blenderのバージョンアップによってさらに修正箇所が増える可能性もありますので、元のチュートリアルでは「magic」などの既存のテクスチャの名前でファイル内を検索してみるようにと書かれています。

multitex()関数(line:1133-1233)

static int multitex(Tex *tex, float *texvec, float *dxt, float *dyt, int osatex, TexResult *texres)
{
    float tmpvec[3];
    int retval=0; /* return value, int:0, col:1, nor:2, everything:3 */

    texres->talpha= 0;    /* is set when image texture returns alpha (considered premul) */
   
    switch(tex->type) {
   
    case 0:
        texres->tin= 0.0f;
        return 0;
    case TEX_CLOUDS:
        retval= clouds(tex, texvec, texres);
        break;
    case TEX_WOOD:
        retval= wood(tex, texvec, texres);
        break;
    ...
    case TEX_TEST:
        retval = test_tex(tex, texvec, texres);
        break;
    ....
}

この関数の中では、DNA_texture_types.hの中で定義されているTEX_XXXという定数に対応して、テクスチャの描画を行うというような処理が書かれています。
他のテクスチャを参考にして、TEX_TESTの場合にtest_tex()を呼び出すコードを追加しています。

○UI(ユーザーインターフェイス)の作成 (/blender/source/blender/src/buttons_shading.c)
このソースファイルで、パネル上に表示されるボタンなどを設定します。
今回は数値スライダが一つだけの簡単なパネルになります。

static void texture_panel_test_tex(Tex *tex)
{
    uiBlock *block;
   
    block = uiNewBlock(&curarea->uiblocks, "texture_panel_test_tex", UI_EMBOSS, UI_HELV, curarea->win);
    if(uiNewPanel(curarea, block, "Test Tex", "Texture", 640, 0, 318, 204)==0) return;
    uiSetButLock(tex->id.lib!=0,  ERROR_LIBDATA_MESSAGE);

    uiBlockBeginAlign(block);
   
    uiDefButF(block, NUM, B_TEXPRV, "value: ", 10, 90, 150, 19, &tex->test_val, -1.0, 1.0, 10, 0, "Test Value");
   
    uiBlockEndAlign(block);
}

新規に作成したtexture_panel_test_tex()という関数の中でパネルに表示されるボタンなどを作成しています。
1から4行目まではパネルそのものを作成するための記述で、Magicなどの他のテクスチャのソースコードとほとんど共通していますが、パネルに表示される名前等は今回作成しているテストテクスチャ用に修正しています。

5から7行目までがパネルに表示されるボタンのための記述です。
テクスチャプラグインではVarStructという構造体でボタンを作成していましたが、ここではuiDefButF()という関数でボタンの詳細を指定しています。
元のチュートリアルにこの関数の詳しい説明が書かれています。(Blenderのソースコードの「doc」フォルダの中にあるinterface_API.txtから抜粋しているようです)


このファイルには、全部で3ヶ所修正が必要になります。
ここから先は、元のチュートリアルには書かれていませんが、これらの部分を修正しないと「texture」パネルから今回作成した新しいテクスチャを選択することができません。
ここでも「magic」などの既存のテクスチャの名前で検索して、修正が必要な場所を探す方法が有効です。

void texture_panels()関数(line:1576-1702)

static void texture_panel_texture(MTex *actmtex, Material *ma, World *wrld, Lamp *la, bNode *node, Brush *br, SculptData *sd)
{
        ...
        /* newnoise: all texture types as menu, not enough room for more buttons.
         * Can widen panel, but looks ugly when other panels overlap it */
       
        sprintf(textypes, "Texture Type %%t|None %%x%d|Image %%x%d|EnvMap %%x%d|Clouds %%x%d|Marble %%x%d|Stucci %%x%d|Wood %%x%d|Magic %%x%d|Blend %%x%d|Noise %%x%d|Plugin %%x%d|Musgrave %%x%d|Voronoi %%x%d|DistortedNoise %%x%d|TestTex %%x%d", 0, TEX_IMAGE, TEX_ENVMAP, TEX_CLOUDS, TEX_MARBLE, TEX_STUCCI, TEX_WOOD, TEX_MAGIC, TEX_BLEND, TEX_NOISE, TEX_PLUGIN, TEX_MUSGRAVE, TEX_VORONOI, TEX_DISTNOISE, TEX_TEST);
        uiDefBut(block, LABEL, 0, "Texture Type",        160, 150, 140, 20, 0, 0.0, 0.0, 0, 0, "");
        uiDefButS(block, MENU, B_TEXTYPE, textypes,    160, 125, 140, 25, &tex->type, 0,0,0,0, "Select texture type");
        ...
}

この関数の中にある非常に長いsprintf()関数の記述を修正します。
これで、「texture」パネルのポップアップメニューの項目に「TestTex」という新しい項目が追加されます。

texture_panels()関数(line:4508-4616)

void texture_panels()
{
            ...
            case TEX_DISTNOISE:
                texture_panel_distnoise(tex);
                break;
                /* newnoise: voronoi */
            case TEX_VORONOI:
                texture_panel_voronoi(tex);
                break;
            case TEX_TEST:
                texture_panel_test_tex(tex);
                break;
            ...
}

こちらは「texture」パネルで選択された項目に対応するパネルを表示する処理のようです。

以上で必要な修正が完了しました。
新しいファイルを追加したりしていないので、SConsなどのビルドの環境には影響していないはずです。UBUNTU 8.10 amd64の環境では、SConsでビルドすると普通にコンパイルできました。