Sync In CHOP

From Derivative
Jump to: navigation, search

Summary
[edit]

Note: Only available in TouchDesigner Pro.

The Sync In CHOP and Sync Out CHOP are used to keep timelines in two or more TouchDesigner processes within a single frame of each other. One process will contain a Sync Out CHOP while one or more other processes contain Sync In CHOPs. In addition any CHOP data sent through the Sync Out CHOP is received by the Sync In CHOPs. The CHOPs synchronize by pausing their own timeline until all Sync In/Out CHOPs have cooked. The Sync Out CHOP will be ahead of the Sync In CHOPs. If any CHOPs fail to communicate, the others will timeout, causing all processes to run slowly. The processes with Sync In CHOPs should have their Realtime flag checked off, as their frame rates will be determined by the Sync Out CHOP.

Client machines may come online at any point, or be switched off as desired, as the Sync Out CHOP will adjust accordingly, either timing out, temporarily or permanently banning individual clients as specified.

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

An Info DAT, pointing to the Sync Out CHOP, provides a detailed list of all clients:

The columns are are:

  • pid: process id of the client
  • address: ip and port number
  • machine_name: client machine name
  • filename: name of the toe file the client resides in
  • op_path: full operator path to the client
  • include: when 1, the Sync Out CHOPs waits for a reply, when 0, it is ignored.
  • timeout_total: The total number of times the Sync Out CHOP stalled waiting for this client
  • timeout_consecutive: The running number of times the Sync Out CHOP stalled waiting for this client.
  • steady_total: The total number of times the Sync Out CHOP received a reply in time.
  • steady_consecutive: The running number of times the Sync Out CHOP received a reply in time:
  • reply: The last reply from the client, all clients should have the same increasing value.


Similarly, an Info CHOP will reveal further information, such as:

  • sync_incompletes: This number is constant when the system is in sync, and will climb up each time the number of clients responding does not match the expected number. When all is steady, the number does not change.
  • sync_internal: The number of clients within the same toe file that it is waiting on.
  • sync_external: The number of clients from different toe files that it is waiting on.


Intermittent Connections

Whenever a client replies, it is immediately assumed reliable, and waited upon, by the Sync Out CHOP each frame thereafter. When a client times-out a number of times in a row, however, it is continuously ignored by the Sync Out CHOP, until it replies on time again. This also applies to clients that have stopped communicating altogether. The number of consecutive timeouts is controlled by the Client Timeouts (consecutive) parameter and is reflected by the timeout_consecutive Info DAT column.

Banning

If a client produces unreliable communication, sometimes steady, sometimes timing out, then it can be permanently ignored by enabling Ban Clients and setting the Total Timeouts accordingly. Once a client timeouts a certain number of times, its Info DAT include column reports banned and it will always be ignored, even if it starts responding in time again.

Resetting

Whenever the Sync Out CHOP first starts any and all clients are accepted, and nothing is banned. Pressing Clear Stats in the Sync Out CHOP also returns to this state, clearing all banned lists, and totals, even in the remote client Info CHOPs.

See also Syncing Multiple Computers and Hardware Frame Lock.

PythonIcon.pngsyncinCHOP_Class


Parameters - Sync In Page

Active active - Whether or not the CHOP is currently attempting to synchronize itself to a Sync Out CHOP.

Multicast Address multicastaddress - An IP address to communicate on (224.0.0.1).

Network Port port - The network port associated with the address.

Timeout (msec) timeout - The maximum amount of time the CHOP will wait for synchronization signals from the other Sync CHOPs. This value is expressed in milliseconds.


Parameters - Common Page

Time Slice 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 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.

Export Method 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 geo1/transform1:tx.

Export Root autoexportroot - This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.

Export Table exporttable - The DAT used to hold the export information when using the DAT Table Export Methods (See above).


CHOPs
Ableton Link • Analyze • Angle • Attribute • Audio Band EQ • Audio Device In • Audio Device Out • Audio Dynamics • Audio File In • Audio Filter • Audio Movie • Audio Oscillator • Audio Para EQ • Audio Play • Audio Render • Audio Spectrum • Audio Stream In • Audio Stream Out • Beat • BlackTrax • Blend • Clip Blender • Clip • Clock • Composite • Constant • Copy • Count • CPlusPlus • Cross • Cycle • DAT to • Delay • Delete • DMX In • DMX Out • Envelope • EtherDream • Event • Expression • Extend • Fan • Feedback • File In • File Out • Filter • Function • Gesture • Handle • Helios DAC • Hog • Hokuyo • Hold • In • Info • Interpolate • Introduction To CHOPs id• Inverse Curve • Inverse Kin • Join • Joystick • Keyboard In • Keyframe • Kinect • Lag • Leap Motion • Leuze ROD4 • LFO • Limit • Logic • Lookup • LTC In • LTC Out • Math • Merge • MIDI In • MIDI In Map • MIDI Out • Mouse In • Mouse Out • NatNet In • Noise • Null • Object • Oculus Audio • Oculus Rift • OpenVR • OSC In • OSC Out • Out • Override • Panel • Parameter • Pattern • Perform • Pipe In • Pipe Out • PosiStageNet • Pulse • RealSense • Record • Rename • Render Pick • Reorder • Replace • Resample • S Curve • Scan • Script • Select • Sequencer • Serial • Shared Mem In • Shared Mem Out • Shift • Shuffle • Slope • SOP to • Sort • Speed • Splice • Spring • Stretch • Switch • Sync In • Sync Out • Tablet • Time Slice • Timeline • Timer • TOP to • Touch In • Touch Out • Trail • Transform • Trigger • Trim • Warp • Wave • ZED

An which operate on (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

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

A Time Slice is the time from the last cook frame to the current cook frame. In CHOPs it is the set of short channels that only contain the CHOP channels' samples between the last and the current cook frame.

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.

samples-per-second of a CHOP. Each CHOP in your network has a sample rate, whether it is used or not. The overall timeline has a "frame rate", which is the number of animation frames per second, generally your monitor display frequency.

Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See .

The location of an operator within the TouchDesigner environment, for example, /geo1/torus1, a node called torus1 in a component called geo1. The path / is called . To refer instead to a filesystem folder, directory, disk file or http: address, see .

Parameters in TouchDesigner are an operator's settings (numbers, menus, flags, strings, paths) which the user can alter. Parameters for any operator can be opened by right-clicking on the operator and selecting "Parameters..." A currently selected operator's parameters can be viewed in a by pressing the keyboard shortcut 'p'.

TouchDesigner is a hierarchy of components. "root" is the top-most network in the hierarchy. The is simply /. A typical path is /project1/moviein1.