OSC In DAT

From Derivative
Jump to: navigation, search


Summary

The OSC In DAT receives and parses full Open Sound Control packets using UDP by default. Each packet is parsed and appended as a row in the DAT's table. The table is FIFO "fisrt-in first-out" and limited to parameter-set number of lines. An optional script may be run for each packet received. Each packet/row represents either one OSC message, or an entire OSC bundle. Each argument is translated into readable ASCII text.

See also OSC, OSC Out DAT, OSC In CHOP, OSC Out CHOP, iOS and OSC, Network Protocols.

The supported argument tag types are:

  • i int32
  • f float32
  • s OSC-string
  • b OSC-blob
  • h 64 bit big-endian two's complement integer
  • t OSC-timetag
  • d 64 bit ("double") IEEE 754 floating point number
  • S alternate type represented as an OSC-string
  • c ASCII character
  • r 32 bit RGBA color
  • m 4 byte MIDI message
  • T True
  • F False
  • N Nil
  • I Infinitum
  • [ Beginning of an array
  • ] End of an array


In the case of multi-vectored arguments (example "blob", "midi", "rgb", etc), the list of values is enclosed in double quotes. In the case of unknown argument types, a quoted list of decimal values representing the bytes of that argument are included instead.

NOTE for Windows OS - If experiencing connection issues make sure Windows Firewall is disabled.

PythonIcon.pngoscinDAT_Class


Parameters - Connect Page

Protocol protocol - - Select which protocol to use, refer to the Network Protocols article for more information.

  • Messaging (UDP) msging -
  • Multi-Cast Messaging (UDP) multicastmsging -
  • Reliable Messaging (UDT Library) reliablemsging -

Network Address address - For multi-cast protocol, this is the multi-cast address to listen for. For UDT protocol this is the IP address of the server.

Port port - The port which OSC-In will accept packets on.

Shared Connection shared - Use the same connection as other networking DATs using the same network protocol.

Active active - While on, the DAT receives information sent to the network port. While Off, no updating occurs. Data sent to the port is lost.

OSC Address Scope addscope - To reduce which channels are generated, you can use channel name patterns to include or exclude channels. For example, ^*accel* will exclude accelerometer channels coming in from an iOS or iPhone app like mrmr. See Pattern Matching for the syntax of the possible channel name patterns.

Include Type Tag typetag - Includes the argument list type tag in each message. It includes the parameter type keywords (in case the parsing application needs to identify parameter types).

Split Bundle into Messages splitbundle -

Split Message into Columns splitmessage -

Bundle Timestamp Column bundletimestamp -



Parameters - Received Messages Page

Callbacks DAT callbacks - The Callbacks DAT will execute once for each message received. See oscinDAT_Class for usage.

Execute from executeloc - - Determines the location the script is run from.

  • Current Node current - The script is executed from the current node location.
  • Callbacks DAT callbacks - The script is executed from the location of the DAT specified in the Callbacks DAT parameter.
  • Specified Operator op - The script is executed from the operator specified in the From Operator parameter below.

From Operator fromop - The operator whose state change will trigger the DAT to execute its script when Execute from is set to Specified Operator. This operator is also the path that the script will be executed from if the Execute From parameter is set to Specified Operator.

Clamp Output clamp - The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited.

Maximum Lines maxlines - Limits the number of messages, older messages are removed from the list first.

Clear Output clear - Deletes all lines except the heading. To clear with a python script op("opname").par.clear.pulse()

Bytes Column bytes - Outputs the raw bytes of the message in a separate column.



Parameters - Common Page

Language language - - Select how the DAT decides which script language to operate on.

  • Input input - The DAT uses the inputs script language.
  • Node node - The DAT uses it's own script language.


Edit/View Extension extension - - Select the file extension this DAT should expose to external editors.

  • dat dat - various common file extensions.
  • From Language language - pick extension from DATs script language.
  • Custom Extension custom - Specify a custom extension.


Custom Extension customext - Specifiy the custom extension.


Word Wrap wordwrap - - Enable Word Wrap for Node Display.

  • Input input - The DAT uses the inputs setting.
  • On on - Turn on Word Wrap.
  • Off off - Turn off Word Wrap.



DATs
Art-Net • CHOP Execute • CHOP to • Clip • Convert • DAT•  Execute • DAT xport• Error • EtherDream • Evaluate • Examine • Execute • FIFO • File In • File Out • Folder • In • Indices • Info • Insert • Introduction To DATs id• Keyboard In • Merge • MIDI Event • MIDI In • Monitors • MQTT Client • Multi Touch In • Null • OP Execute • OP Find • OSC In • OSC Out • Out • Panel Execute • Parameter Execute • Perform • Render Pick • Reorder • Script • Select • Serial • SOP to • Sort • Substitute • Switch • Table • TCP/IP • Text • Touch In • Touch Out • Transpose • TUIO In • UDP In • UDP Out • UDT In • UDT Out • Web • WebSocket • XML

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

A parameter in most CHOPs that restricts which channels of that CHOP will be affected. Normally all channels of a CHOP are affected by the operator.

Each operator can have a set of text strings that are its "tags". You can set them and search for them within TouchDesigner.

The generic thing that holds an Operator, and includes Flags (display, bypass, lock, render, immune) and its position/size in the network. Whether you "lay down an Operator" or "lay down an Node", you're doing the same thing.

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.