[TouchDesigner] DATの扱いTips


##はじめに

Qiita初投稿になります。
この記事はTouchDesignerにおけるDATの使用時に便利だったこと気づいたことなどのまとめです。

今年の夏、お仕事でTouchDesignerを使ってみました。
ジェネ！画作り！ではなく動画再生の地味な制御処理の実装でしたが、とても学びある案件だったのでメモがてら、参考になるものになれば幸いです。

>追記20191208
キャプチャ動画と補足を付けて自身のページで同等の内容を記載しました！
キャプチャ見たほうがわかりやすいという方は、そちらもご参考いただけると。
https://shugohirao.com/blog/654


また先日とある大学で行われた制作展のサポートをさせていただき、学生さんにTouchDesignerなどを教える機会がありました。
今後もそういった機会が増えるため、入門者初心者にもなるたけすげーわかりやすく書けるよう努力します、、！！

ここはこういうやり方あるよ、このほうがいいよ、など引っかかることがあれば気軽に教えていただければ幸いです、、！:pray:

ではでは以下、本題です。

<hr>

## DATにまつわる話

#### CSVの読み込み

FileInDATでcsvファイルなどの読み込みができます。(いくらか前は対応してなかったぽいです。）
FileInDATのRefreshトグルをオンにしておくと、読み込み元のファイルの変更を保存ごとに随時反映してくれます。

ちなみにcsvファイルをドラッグアンドドロップすると自動でTableDATに変換して読み込みができます。が、Tableとして読み込まれるためcsvファイルの変更は反映されません。

※FileInでcsvを読み込む際、csvファイルの最終行が読み込まれない場合があるので注意です。
とりあえずcsvファイルを用意する場合は、最終行に空行を追加するなどするのがよいかもです。
![td_filein2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/86eced4e-2acd-2dff-5150-365a8d5f952a.png)
５行目の空行がないと`@hello,he,hello`の行を読み込んでくれません。の図

<!--動画01-->



#### 日本語ファイルの読み込み

日本語を含むcsvファイル（ツイートデータ、歌詞データなど）をTouchDesingerに取り込むときにぶつかる問題です。
TouchDesignerではTextに直接日本語を入力したりはできますが、csvなどファイルから読み込んだときにはエンコードの関係で文字化けしてしまいます。
正しく取り込むためにはPythoのスクリプトを書いてutf8として指定して読み込む必要があります。
以下はそんなスクリプトの一例です。

```python
# loadJapaneseFile - Example

import csv
table = op('loadedCSV')
table.clear()

path = project.folder +'/'+ me.parent().par.Csvfile

with open(path, encoding='utf8') as f:
	data = csv.reader(f)
	cn = len(next(data))
	rn = len(list(data))+1
	table.setSize(rn,cn)
	
with open(path, encoding='utf8') as f:
	data = csv.reader(f)
	r=0
	for row in data:
		c=0
		for col in row:
			print( col )
			table[r,c] = col.strip()
			c+=1
		r+=1
```

上記のスクリプトでは、一度テーブルをリセットして、csvの数だけセル（空白）を作った後、再度読み込んだcsvの値をセットしています。
なんかいろいろ試した際に思うように行かず、取り急ぎ実装した一例なので、あまり効率的でないかも。。いやゼッタイへん。
よりよい実装わかりしだい更新しますね。

<!--念の為toxファイルもおいておきます。-->



#### 指定フォルダ内の動画を再生する

Palleteの中にmoviePlaylistなんてものもありますが。。もっとシンプルでいいんだって時。
FolderDATで、フォルダ内のファイルリストを取得できます。
この際、拡張子の指定や、サブフォルダ（子フォルダ）の中身も参照するかどうかなど、簡単にプロパティから指定できます。

![td_folder01.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/62831780-07e1-e230-0991-00103b47a1e9.png)
![td_folder02.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/d9b28cad-033f-3d94-a51f-63372242517b.png)


####日付順にソート

最新の動画を取得したいなどの要望を叶えるため、
FolderDATで取得したリストを日付順だったり更新順に並べ替えたいという場合があります。
並べ替えたい時はSortDATというものがあるのですが、基本的には数値順かアルファベット順のみです。Dateを表示させると「Fri Dec 6~」みたいな表示でうまく並べ替えできない場合があります。このためDateをEpochというフォーマットに置き換えソートを掛けます。

<!--動画

上記の動画で操作しているように、ポイントはFolderのDateFormatをEpochにするところ。これによって正しくSortをかけることができます。-->
またSortDATにはランダムに並べ替える機能もあり、Seedの値を変更することでランダムな並びを変更できます。
いわゆる配列のシャッフルのように使えるので便利です。
![td_sortRandom.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/d52177a4-25a4-f5a1-e0e3-ff410421a794.png "Seedの変更でランダムを弄れます。の図")


ついでにSort後、再度日付に変換するtoxを作っていたのですが、、ファイル行方不明のため後ほどアップしておきます。。



###TextDAT

Pythonのスクリプトを書き込んで実行することができます。
その他、メモ書きのように利用することもできます。プログラミング言語で言うコメントの役割ですね。

####スクリプトを書く

オペレータをアクティブ状態にするとスクリプトを書くことができます。
書き込んだスクリプトは`TextDATを右クリック＞Run`、または`Ctrl (Cmd)+R`で実行できます。（アクティブ状態で選択しているとき、つまりオペレータに直接入力可能な状態の場合はスクリプトの実行ができません！）

その他、他のスクリプト内から、`op('text1').run()`のようにオペレータを指定してrun()とすることでスクリプトを実行することができます。

そんでから、実行結果はTextportというウィンドウで確認することができます。
`ツールバー＞Dialogs>Textport and DATs`、または`Alt (option)+T`でウィンドウを開くことができます。



####関数ごとにTextを作る

Execute系のオペレータから実行するとき、直接その中に書くと、デバッグしづらいことがあります。
たとえばChopの0,1(OFF,ON)をフラグとして関数を実行する場合、「Chopの値をもとにDATのTextで書いたスクリプトを実行したい」ので、ChopExcuteを使用することになるかと思います。
このとき直接ChopExecuteの中に処理のスクリプトを書いてもいいのですが、ChopExecuteを選択してCtrl+RとしてもonOffToOn()というイベント関数になっているので実行されません。
作業中は任意のタイミングで処理を実行させたい場合が往々にしてあると思います。そんなときのために処理のスクリプトは別のTextDATにわけて書くと後々融通がききやすいです。
![td_textfunc.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/908ea679-d163-01dd-ea1d-ef640bca6416.png "真理の図")

<!--動画-->

後々知りましたが、このことは、かの先生も自身のサイトで述べられていたので、真理なんだと思います。

また関数をひとつのTextDATに書いた際、

```python
print(me) #とか 
print('---'+me.name+'---') #とか
```

などを追加しておけばスクリプトの実行順が追いやすいのでデバッグしやすいかもです。



#### その他ちょっとしたスクリプトTips

- オペレータのpulseパラメータをスクリプトから叩く
たとえばMovieFileInのCuepulsewを叩く時

```python
op('moviefilein1').par.cuepulse.pulse()
```

- ButtonCOMPをスクリプトからクリックする。

```python
op('button1')click()
```

- EvaluateDATのExpressionでスクリプトの簡易チェック
![td_evaluate.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/d1ad0a43-d15d-7dda-3162-75bc712e864d.png)
単純に値をとってくるときなどに意外と便利かもです。

- TD高速化Tips
op('lfo1')['chan1'] よりも op('lfo1')[0] のほうが処理速度は早い（らしい）　
名前指定よりindex指定のほうが早いという話。詳しく試してはないですが、なんとなくそんな感じはします。
D&Dで参照したときは名前指定になるのがデフォルトなようです。



## 初Qiitaなのでおまけ

はじめてなのでちょっとうかれています。

####オペレータに色を付ける。

自作のtoxなどのオペレータに色を付けたい。調べてもパッと出てこなかったけど、何かのチュートリアル動画を見ていたときにしれっと色をつけているのを見てやり方を知りました。

1. Cキーを押してカラーパレットを表示
2. 色を付けたいオペレーターを選択してカラーパレットから色を選択

![td_opColor.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/dbee5769-f627-6bf3-c1de-14dd431c5ea4.png "うかれて着色する図")

<!--動画-->



#### 自作toxのロードについて

いい感じのオペレータ群ができたら、`オペレータ群をまるっと選択＞右クリック＞CollapseSelected` でひとつのコンテナにまとめる。
このコンテナをtoxとして利用するため、`Save Component .tox`でtoxファイルに書き出すのですが、このときのもとの自作コンテナは自動ではtoxファイルを参照していることにはなりません。
CommonでExternal.toxを指定でき、これを指定することで初めて、toxファイルを参照して利用することができます。
`Reload .tox on Start`で起動時にtoxファイルを読み込んできますが、作業中にtoxを編集して再度読み直す場合は、`Common>Re-Init`が便利です。

また初期値として、ReloadCustomParametersがONになっています。このため、toxを使いまわしそれぞれパラメータを調整しても、ここがONのままだと次回起動時に元になっているtoxファイルの値が入ってしまい、調整が水の泡になってしまいます。適宜OFFにするなど注意してください！

![td_base_common.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/109091/8f429edf-6dc0-5204-f317-f440b06e1b71.png "ReloadCustomParametersだけOFFにしたほうがいいでの図")


ちなみに、Built-inのパラメータは`OP.par.cuepulse`のようにパラメータ名がオール小文字ですが、カスタムパラメータは`OP.par.Customparameter`とParameter名の１文字目のみが必ず大文字になります。
標準パラメータとカスタマイズの干渉を防ぐためだったりすると思うのですが、
そんな些細なことになんとなく気がついていたおかげで僕は何度か幸せになることがありました。



##おわりに

DATまわりの知見というか基礎的なところから些細なTipsを書かせていただきました。
なにかひとつでも役に立つものがあれば幸いです。

<!--
動画素材を扱うコンテンツを作る場合は、TouchDesignerとても相性がいいと思います。
oFだと動画再生の安定性という面でどうしても不安が残る印象ですし、わりとそんな評判を耳にすること多い気がします。
Unityでも実は動画再生で細かいバグがあったりする（らしい）という話もちらほら耳にします。
そんななかTouchDesignerは動画の再生まわりについてはとても評判がいい印象で むにゃむにゃ
-->

TouchDesignerはリアルタイム映像ジェネレータとしてとても優秀なソフトでVJ方面での利用が目立つ印象ですが、その一方で、データの管理など裏方処理がバチボコ楽、シリアル通信がバチボコ楽など、
プログラミングしたことないけど何か作りたい学生 にも"うってつけ"だと制作展のサポートで思いました。
（のちのちはプログラミングなどにも興味持ってもらいたいですけど）

<!--ちなみに、今回動画の撮影はFonePawというソフト（無料版は3分間の書き出し制限）を使いました。
入力キーの表示はKeyCastrOWを使いました。KeyCastrOWはGithubから自分でビルドする必要がありますが、ビルド済みのものを配布している方がいらっしゃったのでそちらから拝借。-->


今後もちょろりちょろり書いていきたいです。
- ドングルまわりの話（みんなどうしてるんですか？）
- Instantiateの話
- MovieFileInの話

引き続き、TouchDesigner Advent Calendar 2019 楽しみにしております。
よろしくどうぞ。