[TouchDesigner] OSC通信を使う。CHOPとDAT

![td_final.png](https://qiita-image-store.s3.amazonaws.com/0/127402/3ddd57d0-8be9-e728-be65-3ca75e58559f.png)

# OSC通信とは
**O**pen **S**ound **C**ontrolと呼ばれる通信プロトコルです。
**主に外部アプリケーションやデバイスとの信号のやりとりに使用されます**。
通信基盤にTCP/IPまたはUDP、UDTを使用します。

プロトコルとは通信を行う際のルールのようなもので、
こういうデータの形で渡してくれるとこっちでも解釈できるよーというフォーマットを定めたものです。

TCP/IPは、送信側が受信側に信号伝達が完了したかどうかの確認を行い、欠損があった場合に再送信する機能があります。
UDPは受信確認を行わないため情報が欠落する場合がありますが、通信効率が良いためリアルタイムアプリケーションの通信によく使用されます。
UDTは受信側が利用できる帯域幅を測定し、算出されたパケット数を送信側に伝えるプロセスを挟みますが、通信自体はUDPを用います。

各通信プロトコルについては以下の記事がわかりやすかったためリンクを貼っておきます。

- [TCPについて](http://www.infraexpert.com/study/tcpip7.html)
- [UDPについて](http://www.infraexpert.com/study/tcpip12.html)
- [UDTについて](http://itpro.nikkeibp.co.jp/article/Keyword/20070222/262901/?rt=nocnt)
- [OSCについて](http://www.slideshare.net/kezzardrix/osc-40158969)

TouchDesignerでのOSC通信は、**UDPまたはUDT経由**をサポートしています。

# OSC通信のフォーマット
OSC通信は、
**/rgba 255 255 10 0.4**
のように、
**(アドレスパターン) (引数) (引数) ・・・**
というメッセージによって構成されます。

アドレスパターンはスラッシュ区切りで階層構造を持たせることができ、引数にはint32, float32, string値などが使用可能です。
ただし、TouchDesignerでは階層構造をうまく扱えない為、単一の階層にしたほうが良いでしょう。

TouchDesignerでは、**OSC In/Out CHOP**、**OSC In/Out DAT**を経由してOSC信号の送受信を行うことができます。

# TouchDesignerでのOSC通信 - CHOP編
**CHOPでのOSC送信では、構造上一つのアドレスパターンにつき1つの引数しかとることができません。**受信はできます。
複数の引数を送信したい場合はDATでのOSC通信を利用してください。


送受信されているデータがどのようにフォーマットされているかを確認するために、外部ソフト「Processing」を使用します。

#### **OSC In CHOP**
ネットワークからOSC信号を受信し、CHOPチャンネル値に変換します。
パラメーターには信号受信の際に開放するポート番号を指定します。

まず、外部ソフトからOSC信号を送信します。
![2017-02-14_161935.png](https://qiita-image-store.s3.amazonaws.com/0/127402/8af648c8-62f3-c549-616b-82ef2444d806.png)

```
/from/processing 10.1209
```

これを、OSC In CHOPで受け取ると以下のようになります。
![2017-02-14_162044.png](https://qiita-image-store.s3.amazonaws.com/0/127402/fd10601a-0da6-9799-2435-02a109ae612c.png)

この例でみられるように、信号は届いていますが、アドレスパターンの階層構造はうまく扱ってくれず、2つ目以降のスラッシュは単に文字として認識されています。
また、小数第3位で切り捨てが発生しています。

1つのアドレスパターンに対して複数の引数を受信した場合は、アドレスパターンに数字のサフィックスが付加されます。
![2017-02-14_172408.png](https://qiita-image-store.s3.amazonaws.com/0/127402/cc1f14f3-6ee6-286a-72f2-f6e7511d042a.png)

-------------

#### **OSC Out CHOP**
接続されたCHOPのチャンネル値をOSC信号に変換して送信します。
このとき、CHOPのチャンネル名がアドレスパターン、チャンネル値が引数となります。

パラメーターには送信先のIPアドレスとポート番号を指定します。
今回は自分のPCへ信号を送信するため、ネットワーク(IP)アドレスをlocalhostに設定していますが、一般的なIPアドレスの確認は以下で可能です。

```
コマンドプロンプト -> 「ipconfig」と入力してエンター -> IPv4アドレス ???.???.???.???
```
![2017-02-14_171129.png](https://qiita-image-store.s3.amazonaws.com/0/127402/0525c27e-84a1-2a4f-e56d-348ee9bbe8cb.png)

以下実際に使用した画像です。

![2017-02-14_161232.png](https://qiita-image-store.s3.amazonaws.com/0/127402/7e093f57-f1ae-e6b2-9ae2-14f16e4c266d.png)
(画像左: TouchDesigner OSC送信画面、画像右: Processing OSC受信画面)

```
アドレスパターン: /h, /s, /v
型: f, f, f
引数: 180, 100, 255
```
受信側では、上記のようにフォーマットされていることがわかりました。

# TouchDesignerでのOSC通信 - DAT編
#### **OSC In DAT**
CHOPと同様パラメータに受信ポートを指定します。
CHOPとは異なり、通信した値の履歴が残るような仕組みとなっています。
また、アドレスパターンでフィルターを掛けることも可能です。
![2017-02-14_174103.png](https://qiita-image-store.s3.amazonaws.com/0/127402/7febe3a9-b790-0e64-80b7-a6a407829b84.png)

-------------

#### **OSC Out DAT**
こちらについてはドキュメンテーションを読んでも正しい使い方がよくわからなかったのですが、自分なりの使用方法を考えてみました。

OSC Out DATクラスには**sendOSC()メンバ関数**があり、こちらの引数に**アドレスパターンのString値**と**OSC引数のリスト**を渡すことで信号の送信が可能なようです。
アドレスパターンについてはスラッシュを記述しなければ怒られます。
sendOSC()関数の呼び出しは、Execute DAT内の毎フレーム実行されるframeStart()関数内で行うことにします。

```py:execute1
def frameStart(frame):
	arg_list = [10, 100, 255, 0.7]           // make an OSC arguments list
	op('oscout1').sendOSC("/rgba", arg_list) // call sendOSC() member method of oscOutDat_class
	return
```
![2017-02-14_174827.png](https://qiita-image-store.s3.amazonaws.com/0/127402/7c212d6c-f55d-0770-bd0d-9a1482111611.png)
OSC Out DATに結果は表示されませんでしたが、Processing側では正しく受信ができています。