View source for Sync In CHOP

{{Summary		
	|opFamily=CHOP	
	|opLicense=Pro	
	|opLabel=Sync In	
	|short=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.	
	|opFilter=False	
	|long=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 CHOP]]s. The processes with [[Sync In CHOP]]s should have their '''Realtime flag checked off''', as their frame rates will be determined by the [[Sync Out CHOP]].  Also note, all monitors (including all clients and server) should be set to the '''same rate'''.  Note that unplugging or re-adding monitors may sometime change previously configured settings.


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 CHOP]]s. If any CHOPs fail to communicate, the others will timeout, causing all processes to run slowly. 

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.

In addition any extra CHOP channels sent through the [[Sync Out CHOP]] is received by the [[Sync In CHOP]]s. 
		

'''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:		
* <code>pid</code>: process id of the client		
* <code>address</code>: ip and port number		
* <code>machine_name</code>: client machine name		
* <code>filename</code>: name of the <code>.toe</code> file the client resides in		
* <code>op_path</code>: full operator path to the client		
* <code>include</code>:  when 1, the Sync Out CHOPs waits for a reply, when 0, it is ignored.		
* <code>timeout_total</code>:  The total number of times the Sync Out CHOP stalled waiting for this client		
* <code>timeout_consecutive</code>:  The running number of times the Sync Out CHOP stalled waiting for this client.		
* <code>steady_total</code>: The total number of times the Sync Out CHOP received a reply in time.		
* <code>steady_consecutive</code>: The running number of times the Sync Out CHOP received a reply in time:		
* <code>reply</code>:  The last reply from the client, all clients should have the same increasing value.		
		
<br>		
		
Similarly, an [[Info CHOP]] will reveal further information: [[#Info_CHOP_Channels|Info CHOP Channels]]	
		
==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 <code>Client Timeouts (consecutive)</code> parameter and is reflected by the <code>timeout_consecutive</code> [[Info DAT]] column.		
		
==Fixing Dropped frames on Client==	        
If a particular client is dropping frames, inspect the Sync Out CHOP on the server side with an info DAT.  Look at the column for timeout_consecutive. As well take note of the info chop channel for the sync in CHOP called sync_incompletes.  If one or both of these attributes are increasing, try adjusting the TimeOut parameter on the sync CHOP.  Increasing this value has been known to remedy this issue.


==Banning==		
If a client produces unreliable communication, sometimes steady, sometimes timing out, then it can be permanently ignored by enabling <code>Ban Clients</code> and setting the <code>Total Timeouts</code> accordingly.  Once a client timeouts a certain number of times, its Info DAT <code>include</code> column reports <code>banned</code> 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 <code>Clear Stats</code> in the [[Sync Out CHOP]] also returns to this state, clearing all banned lists, and totals, even in the remote client [[Info CHOP|Info CHOPs]].		
<br>		
<br>		
See also [[Syncing Multiple Computers]] and [[Hardware Frame Lock]].		
	|opType=syncin	
	|opClass=syncinCHOP_Class	
|opCategories=	
	}}		
{{ParameterPage		
	|pageSummary=	
	|items=	
	{{Parameter|parSummary=Whether or not the CHOP is currently attempting to synchronize itself to a [[Sync Out CHOP]].
		|opFamily=CHOP
		|parName=active
		|parOrder=0
		|opType=syncin
		|parLabel=Active
	|parType=Toggle
	|parReadOnly=
		|parItems=
		}}	
	{{Parameter|parSummary=An IP address to communicate on (224.0.0.1).
		|opFamily=CHOP
		|parName=multicastaddress
		|parOrder=1
		|opType=syncin
		|parLabel=Multicast Address
	|parType=Str
	|parReadOnly=
		|parItems=
		}}	
	{{Parameter|parSummary=The network port associated with the address.
		|opFamily=CHOP
		|parName=port
		|parOrder=2
		|opType=syncin
		|parLabel=Network Port
	|parType=Int
	|parReadOnly=
		|parItems=
		}}	
	{{Parameter|parSummary=The maximum amount of time the CHOP will wait for synchronization signals from the other Sync CHOPs. This value is expressed in milliseconds.
		|opFamily=CHOP
		|parName=timeout
		|parOrder=3
		|opType=syncin
		|parLabel=Timeout (msec)
	|parType=Int
	|parReadOnly=
		|parItems=
		}}	
		
	|opFamily=CHOP	
	|pageName=Sync In	
}}		
{{:CHOP Generator Common Page		
}}		

{{InfoCHOPChannels
	|opFamily=CHOP
	|opLabel=Sync In
	|infoChannels={{InfoChannel
	|chanName=sync_incompletes
	|chanSummary=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'''.}}{{InfoChannel
	|chanName=sync_totaldelay
	|chanSummary=The total amount of time spent waiting for the Sync Out CHOP. (milliseconds).}}{{InfoChannel
	|chanName=sync_lastdelay
	|chanSummary=The amount of time waiting for the Sync Out CHOP for the last message (milliseconds).}}{{InfoChannel
	|chanName=sync_serial
	|chanSummary=The last serial index sent from the Sync Out CHOP. Increases each message sent.}}}}
{{History		
}}		
{{CHOPNavBox		
	|opFamily=CHOP	
}}		
{{#invoke:Category		
	|list|CHOPs}}