Harlequin RIP SDK
SDK and Skin timelines

SDK and Skin timelines. More...

Enumerations

enum  {
  SWTLT_SKIN = (TL_SKIN + ( 0 )) , SWTLT_SKIN_JOB = (TL_SKIN + ( 1 )) , SWTLT_INPUT_PUBLISHING = (TL_SKIN + ( 2 )) , SWTLT_CRD_GENERATION = (TL_SKIN + ( 3 )) ,
  SWTLT_OUTPUT_DIRECT = (TL_SKIN + ( 4 )) , SWTLT_OUTPUT_THROUGHPUT = (TL_SKIN + ( 5 )) , SWTLT_OUTPUT_DISK = (TL_SKIN + ( 6 )) , SWTLT_OUTPUT_COMPOSITED = (TL_SKIN + ( 7 )) ,
  SWTLT_SCALABLERIP_JOB = (TL_SKIN + ( 8 )) , SWTLT_SCALABLE_RIP = (TL_SKIN + ( 9 )) , TL_SKIN_END
}
 Skin timeline types. More...
 
enum  { SW_RENDER_PAGE_NUMBER_CTXT = TL_SKIN+1 , SW_INTERPRET_PAGE_NUMBER_CTXT = SW_RENDER_PAGE_NUMBER_CTXT , SW_SKIN_JOB_NUMBER_CTXT = TL_SKIN+2 }
 Well-known skin context identifiers. More...
 

Detailed Description

SDK and Skin timelines.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Skin timeline types.

These are timelines made publically available in one or more of the RIP skins for consumption by other layers. The enumeration names do not distinguish themselves from core timelines, but the enumeration values are in a separate range.

Enumerator
SWTLT_SKIN 

Skin timeline. This timeline is created by the skin immediately after the timeline system is started, and persists until the timeline system is shut down. It is used as a parent for the SWTLT_CORE timeline. There is no progress recorded on this timeline.

SWTLT_SKIN_JOB 

Skin job timeline. This timeline tracks jobs submitted to the core from the skin. The timeline is started as soon as the config device receives the job details and starts setting it up to run, and terminates when the config device is certain the core does not have the job file still open. A single skin job may result in several trips around the server loops, each with its own SWTLT_JOB_STREAM timeline. The skin job lifetime overlaps rather than encapsulating SWTLT_JOB_STREAM timelines. The title of the timeline will be the job name submitted to the RIP, potentially in a platform-specific encoding. The job number as supplied by the skin is attached to the timeline using context Id SW_SKIN_JOB_NUMBER_CTXT. There is no progress recorded on this timeline.

SWTLT_INPUT_PUBLISHING 

Input manager timeline (HMR only). When publishing inputs, this timeline is updated with the title of each channel. The unit of progress is indeterminate.

SWTLT_CRD_GENERATION 

CRD generation timeline (HMR only). The title of this timeline is the name of the file opened on the CRD generation device. The unit of progress is bytes, for the approximate size of the generated CRD.

SWTLT_OUTPUT_DIRECT 

Direct output (HMR only). This timeline used to track progress of output sent to a plugin in single mode. The unit of progress is the number of lines in the total frame set, similar to the SWTLT_PGB timeline. When created, the end extent indicates the final extent of the timeline. The end extent is updated with the total number of lines transmitted to the plugin. Progress indicates the total number of lines actually printed by the plugin.

SWTLT_OUTPUT_THROUGHPUT 

Throughput output (HMR only). This timeline used to track progress of output sent to a plugin in throughput mode. The unit of progress is the number of lines in the total frame set, similar to the SWTLT_PGB timeline. When created, the end extent indicates the final extent of the timeline. The end extent is updated with the total number of lines transmitted to the plugin. Progress indicates the total number of lines actually printed by the plugin.

SWTLT_OUTPUT_DISK 

Output to disk (HMR only). This timeline used to track progress of output sent to disk by the RIP. The unit of progress is the number of lines in the total frame set, similar to the SWTLT_PGB timeline. When created, the end extent indicates the final extent of the timeline. The end extent is updated with the total number of lines transmitted to the output handler. Progress indicates the total number of lines actually written to disk.

SWTLT_OUTPUT_COMPOSITED 

Output to disk when compositing (HMR only). This timeline used to track progress of output sent to disk when compositing by the RIP. The unit of progress is the number of lines in the total frame set, similar to the SWTLT_PGB timeline. When created, the end extent indicates the final extent of the timeline. The end extent is updated with the total number of lines transmitted to the output handler. Progress indicates the total number of lines actually written to disk.

SWTLT_SCALABLERIP_JOB 

Scalable RIP job timeline. This timeline tracks jobs submitted to the scalable RIP's job controller. The timeline is started as soon as the job is submitted to the job controller, and terminates when the job controller has sent the job complete message. Progress is updated to indicate the number of pages complete, without regard to the order in which the pages are completed by farm RIPs. An initial progress update with zero pages completed is made when the first page range of the job is sent from the job controller to a farm RIP, indicating that the Scalable RIP has started work on the job. The title of the timeline will be the job name submitted to the RIP, potentially in a platform-specific encoding.

SWTLT_SCALABLE_RIP 

Scalable RIP server thread parent timeline. This timeline denotes the extent of the Scalable RIP server thread (the Scalable RIP central controller, Satellite Blade Controller, or Farm RIP). There is no progress recorded on this timeline.

◆ anonymous enum

anonymous enum

Well-known skin context identifiers.

Enumerator
SW_RENDER_PAGE_NUMBER_CTXT 

Context id to find page number from SWTLT_RENDER_PAGE, SWTLT_RENDER_PARTIAL, or SWTLT_RENDER_CACHE timelines.

The render page number starts at 1 and increments with each page rendered. With HVD the render page number may be repeated, and some render page numbers may not be present if a page has no unique content.

SW_INTERPRET_PAGE_NUMBER_CTXT 

Context id to find page number from SWTLT_INTERPRET_PAGE timeline.

This is the same number that will be used for rendering this page, if the page is actually rendered.

SW_SKIN_JOB_NUMBER_CTXT 

Context id to find the skin's job number/ID from skin job timeline.

The RIP skin has its own notions of the job number. The skin's counting of jobs may differ from the core, depending on whether it maintains a persistent job count across RIP instantiations, whether it counts configuration jobs that don't output pages as jobs, etc. The config device should attach its notion of the job count to the SWTLT_SKIN_JOB timeline so that it is visible to normal priority handlers at timeline start. The job ID will be an intptr_t cast to a void pointer.