先日、Substance ゆるゆる会にて某氏から聞かれた話。 Substance Designerでテンプレート的なグラフを作成し、特定フォルダ内のすべてのテクスチャに対してそのグラフを適用してテクスチャを生成したいんだけど、できませんか？と。
で、できらぁ！
ということで、Substance Automation Toolkitで上のようなことをやる方法について書いてみます。
さて、既存のテクスチャに何らかの処理を行いたいという話は割とよくある話だと思いますが、Substance らしいこんな話をでっち上げてみましょう。
あなたはあるCG映像会社の社員です。 レンダリング だ！Unreal Engine 4で昔作ったムービーをリアルタイムレンダリング するぞ！と社長に言われました。
そこでまず昔のデータをUE4 に乗っけてみたところ、ノーマルマップもない状態だしPBR対応もしてないしでモデルだけだしても結果はよくありません。 Substance Designerを使って昔のテクスチャを手続き的に処理、ノーマルやラフネスを出力すればなんとかなりそうだというところまでは検証できました。
しかしリソースは大量で、すべてのテクスチャに対してSDでグラフ作成→テクスチャ出力なんてやってられない。
はい、身につまされた人はいませんね？
すでにこんな経験をしている人ならすでに自動化してるとは思いますが、今後こういう事態に陥る人向けにこの記事を書きます。
まずはSDでテンプレートとなるグラフを作成します。 テンプレートグラフ
次にSubstance Automation Toolkitですが、これを利用する方法は2種類あります。
もう1つはPython を使う方法です。 Python を通してBatchtoolsを使用するだけなので実はやってることは同じだったりします。 Python を通してやる方法と採用しています。
まず、Substance Automation ToolkitのPython API をインストールします。 Python API /Pysbs-2018.3.0_install.bat を叩いてPython API をインストールしてください。 Python がインストールされてパスが通っていれば正常にインストールされるはずです。 Mac やLinux についてはよくわからないですが、pip使えれば大丈夫じゃないかと。
次にテキストエディタ でコードを書きます。 Substance 系のコードが増えたらGitHub にリポジトリ 作るかもです。
import os
import sys
import subprocess
import pysbs
from pysbs import batchtools
from pysbs import context
if __name__ == "__main__" :
aContext = context.Context()
template_path = 'MyDocument/Allegorithmic/Substance Automation Toolkit/specialize_test/B2MTest.sbs'
output_path = 'MyDocument/Allegorithmic/Substance Automation Toolkit/specialize_test/'
output_name = 'spec_test'
base_color_image = 'MyDocument/Allegorithmic/Substance Automation Toolkit/specialize_test/Bricks_Test_basecolor.tga'
metallic_image = 'MyDocument/Allegorithmic/Substance Automation Toolkit/specialize_test/Bricks_Test_metallic.tga'
base_color_image_connect = 'input_diffuse@path@' + base_color_image + '@format@JPEG'
metallic_image_connect = 'input_metallic@path@' + metallic_image + '@format@JPEG'
proc = batchtools.sbsmutator_edit(
input =template_path,
presets_path=aContext.getDefaultPackagePath(),
output_name=output_name,
output_path=output_path,
connect_image=(base_color_image_connect, metallic_image_connect),
stderr=subprocess.PIPE)
(out, err) = proc.communicate()
proc.wait()
if err:
print (err)
sys.exit(1 )
proc = batchtools.sbscooker(
inputs=os.path.join(output_path, output_name) + '.sbs' ,
includes=aContext.getDefaultPackagePath(),
size_limit=13 ,
output_path=output_path)
(out, err) = proc.communicate()
proc.wait()
if err:
print (err)
sys.exit(1 )
output_size = 11
proc = batchtools.sbsrender_render(
inputs=os.path.join(output_path, output_name) + '.sbsar' ,
output_name='{inputName}_{outputNodeName}' ,
output_path=output_path,
output_format='tga' ,
set_value=('$outputsize@%s,%s' % (output_size,output_size)))
(out, err) = proc.communicate()
proc.wait()
if err:
print (err)
sys.exit(1 )
フォルダ名やファイル名は適当ですので、必要に応じて変換してください。
簡単に解説していきます。 Substance のPython API をインポートします。
import os
import sys
import subprocess
import pysbs
from pysbs import batchtools
from pysbs import context
今回はbatchtoolsとcontextだけ利用します。
その後はSubstance のコンテキストを取得します。 Substance のPython API を使用する上で基本となるものですが、今回はライブラリフォルダを取得するためだけに使用します。
if __name__ == "__main__" :
aContext = context.Context()
最初に実行するツールはsbsmutatorというツールです。
proc = batchtools.sbsmutator_edit(
input =template_path,
presets_path=aContext.getDefaultPackagePath(),
output_name=output_name,
output_path=output_path,
connect_image=(base_color_image_connect, metallic_image_connect),
stderr=subprocess.PIPE)
(out, err) = proc.communicate()
proc.wait()
コンソールアプリケーションであるsbsmutatorへの引数は、通常 "--" で始まるオプションを利用します。 Python の変数としては使用できない文字列ですので、上記の例の場合は "connect_image" を指定することになります。
また、複数の入力を指定する場合もあります。
sbsmutator.exe --connect-image "input0@path@basecolor.png " --connect-image "input1@path@metallic.png "
Python の可変個引数で辞書を用いる場合、同じ引数名を複数指定はできませんので、1つの引数に対してタプルで複数指定すればOKです。
この命令で特殊化された.sbsファイルが出力されますので、今度はこれを.sbsarファイルに変換します。
proc = batchtools.sbscooker(
inputs=os.path.join(output_path, output_name) + '.sbs' ,
includes=aContext.getDefaultPackagePath(),
size_limit=13 ,
output_path=output_path)
指定したパスに同名の.sbsarファイルが出力されます。
最後に.sbsarファイルからテクスチャを出力します。
output_size = 11
proc = batchtools.sbsrender_render(
inputs=os.path.join(output_path, output_name) + '.sbsar' ,
output_name='{inputName}_{outputNodeName}' ,
output_path=output_path,
output_format='tga' ,
set_value=('$outputsize@%s,%s' % (output_size,output_size)))
(out, err) = proc.communicate()
proc.wait()
"--output-name" オプションにはSDで指定できるグラフ名、出力ノード名などが使用できます。
Substance に渡す各種サイズですが、これは2のn乗のnの値を指定するようにしてください。 レンダリング してくれるんだなぁと感心してしまいました。
以上で一連の流れは完了です。 ソースコード はあくまでの一例でしかありませんし、実際の業務ではファイル名やフォルダ名を指定したり、列挙したファイルに対して処理をしたり、出力フォルダを作成したりといった処理が必要になります。
Batchtoolsを使うと他にも.fbxからジオメトリ関連のマップ(ノーマルやAO、IDマップなど)をベイクし、IDマップに従って特定のマテリアルを割り当てるとかも可能です。
