Touch In CHOP
The Touch In CHOP can be used to create a high speed connection between two TouchDesigner processes via CHOPs.
Data is sent over TCP/IP. The Touch In CHOP (client) receives its data from a Touch Out CHOP (server). The Touch In CHOP is similar to a Pipe In CHOP but highly optimized for TouchDesigner-to-TouchDesigner communication. For interfacing with other software or devices, see the Pipe In CHOP or the TCP/IP DAT.
To receive network data from another "server" computer (e.g. from a Touch Out CHOP running remotely), a connection must be established between the server and the Touch In CHOP before data is sent.
To analyze the timing of the messages coming in, attach an Info CHOP to the Touch In CHOP. It will show the internal queue size and whether it is dropping or missing data (
queue_retarded_total should not be increasing, and
queue_length should not be zero).
NOTE for Windows OS - If experiencing connection issues, confirm Windows Firewall is disabled for TouchDesigner.
See also: OSC In CHOP
Parameters - Touch In Page
protocol - ⊞ - Selects which network protocol to use to transfer data. Different protocol's have methods of connecting and using the address parameter. For more information refer to the Network Protocols article.
- Streaming (TCP/IP)
- Messaging (UDP)
- Multi-Cast Messaging (UDP)
address - The computer name or IP address of the server computer. You can use an IP address (e.g.
100.123.45.78) or the computer's network name can be used directly. If you put "
localhost", it means the other end of the pipe is on the same computer.
port - The network port of the server.
active - While on, the CHOP receives information from the pipe or server. While off, no updating occurs. Data sent by a server is lost, but a pipe will store the data until Active is turned on again. If in Network mode, turning this parameter on initiates a connection, and turning it off breaks the connection.
queuetarget - The target queue length the CHOP will attempt to maintain.
Queue Target Unit
queuetargetunit - Choose between using Samples, Frames, or Seconds as the units for this parameter.
queuevariance - The range around the Queue Target that's acceptable. If the queue's length is within the target and variance range, the CHOP will not bother to adjust the queue length.
Queue Variance Unit
queuevarianceunit - Choose between using Samples, Frames, or Seconds as the units for this parameter.
maxqueue - The maximum size of the queue when full. Incoming samples will be dropped if the maximum queue is reached.
Max Queue Unit
maxqueueunit - Choose between using Samples, Frames, or Seconds as the units for this parameter.
Queue Adjust Time
adjusttime - Specifies how often to repeat/drop a samples in order to get closer to the queue target range. If the value = 1 and the units = seconds, then it will try to repeat/drop a sample once per second to maintain the queue target set in the Minimum Target and Maximum Target parameters above.
adjusttimeunit - Choose between using Samples, Frames, or Seconds as the units for this parameter.
Recover Outside Range
recover - If the queue size goes outside of the target size range for more than the 'adjust time', then if this option is on it will stop delivering new data or throw away a lot of data, until queue size is back in the middle of the min/max target. If this option is of the queue size will be slowly inched towards the target size instead (by dropping or repeating single frames every once in a while).
Use Synced Ports
syncports - ⊞ - This parameter lets you send the the data in a single global pipe if required. This can be important if various data streams must be sent in frame sync.
off- Uses separate ports for each port number assigned.
on- Uses a single global pipe for all Touch Out CHOPs using this Transfer Port Type. The global pipe uses port 10500 internally to send all the global port type data together at once. The Network Port parameter is still used to determine which Touch In CHOP gets the data on the receiving side.
Parameters - Common Page
timeslice - Turning this on forces the channels to be "Time Sliced". A Time Slice is the time between the last cook frame and the current cook frame.
scope - To determine which channels get affected, some CHOPs use a Scope string on the Common page.
Sample Rate Match
srselect - ⊞ - Handle cases where multiple input CHOPs' sample rates are different. When Resampling occurs, the curves are interpolated according to the Interpolation Method Option, or "Linear" if the Interpolate Options are not available.
- Resample At First Input's Rate
first- Use rate of first input to resample others.
- Resample At Maximum Rate
max- Resample to the highest sample rate.
- Resample At Minimum Rate
min- Resample to the lowest sample rate.
- Error If Rates Differ
err- Doesn't accept conflicting sample rates.
exportmethod - ⊞ - This will determine how to connect the CHOP channel to the parameter. Refer to the Export article for more information.
- DAT Table by Index
datindex- Uses the docked DAT table and references the channel via the index of the channel in the CHOP.
- DAT Table by Name
datname- Uses the docked DAT table and references the channel via the name of the channel in the CHOP.
- Channel Name is Path:Parameter
autoname- The channel is the full destination of where to export to, such has
autoexportroot - This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.
exporttable - The DAT used to hold the export information when using the DAT Table Export Methods (See above).
Info CHOP Channels
Extra Information for the Touch In CHOP can be accessed via an Info CHOP.
Specific Touch In CHOP Info Channels
- read_index -
- time_queue_under_min_target -
- time_queue_over_max_target -
- queue_retarded_total -
- queue_advanced_total -
- queue_recover_total -
- queue_size_start -
- queue_added -
- queue_size_end -
- queue_bumped -
- read_repeat -
- read_filled -
- frames_received -
- send_receive_diff -
- local_clock_rate -
- remote_clock_rate -
- remote_elapsed_time -
- remote_frame -
- remote_frame_lag -
- remote_frame_range -
- io_errors -
- connected -
- names_resent -
Common CHOP Info Channels
- start - Start of the CHOP interval in samples.
- length - Number of samples in the CHOP.
- sample_rate - The samplerate of the channels in frames per second.
- num_channels - Number of channels in the CHOP.
- time_slice - 1 if CHOP is Time Slice enabled, 0 otherwise.
- export_sernum - A count of how often the export connections have been updated.
Common Operator Info Channels
- total_cooks - Number of times the operator has cooked since the process started.
- cook_time - Duration of the last cook in milliseconds.
- cook_frame - Frame number when this operator was last cooked relative to the component timeline.
- cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
- cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
- cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
- cooked_this_frame - 1 if operator was cooked this frame.
- warnings - Number of warnings in this operator if any.
- errors - Number of errors in this operator if any.