Introduction
This document describes the built-in Flow Graph modules of the following categories for compounds:
- Video / Source - Modules that generate or capture video frames from built-in and external sources.
- Video / Postprocessing - Modules that filter, analyze, and transform video frames for post-processing and effects.
- Video / Color - Modules that correct, convert, and grade color in video signals.
- Video / Keying - Modules that extract and refine keys for compositing foreground and background imagery.
Video / Source
This section describes the built-in Flow Graph modules that generate or capture video frames from built-in and external sources.
Checkerboard
- Category: Video / Source
- Access: All editions.
- Function: Renders a checkerboard test pattern with configurable cell size and two alternating colors.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Out Size (vector) - Output frame width and height; unset components pick the default frame size.
- ⏺ Square Size (integer) - Checker square edge length in pixels for scaling the shader grid.
- ⏺ Color 1 (color) - First alternating tile color.
- ⏺ Color 2 (color) - Second alternating tile color.
- Output pins:
- ⏺ Out (video) - Rendered checker pattern on the sized output frame.
Curve Gradient
- Category: Video / Source
- Access: All editions.
- Function: Builds a gradient image by sampling horizontal and vertical color curves with axial or radial layouts.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Mode (integer, Gradient Mode) - Axial gradient, radial gradient, or repeating radial gradient.
- ⏺ Horiz Curve (color curve) - Color curve sampled across the horizontal axis (and sole axis for radial modes).
- ⏺ Vert Curve (color curve) - Color curve sampled across the vertical axis in axial mode.
- ⏺ Use Intervals (logical) - When on, samples each curve across its authored time range instead of a fixed 0–1 span.
- ⏺ Horiz Offset (scalar) - Horizontal phase shift applied through the gradient shader transform.
- ⏺ Horiz Repeat (scalar) - Horizontal repeat scale for the gradient coordinates.
- ⏺ Vert Offset (scalar) - Vertical phase shift applied through the gradient shader transform.
- ⏺ Vert Repeat (scalar) - Vertical repeat scale for the gradient coordinates.
- ⏺ Out Size (vector) - Output frame width and height.
- ⏺ HDR Out (logical) - When on, targets HDR-style extended-range frame encoding.
- ⏺ Mono Out (logical) - When on, outputs luminance-only video.
- Output pins:
- ⏺ Out (video) - Rendered gradient texture at the requested size and format.
- ⏺ Horiz Interval (vector) - Horizontal curve domain actually sampled (start and end time).
- ⏺ Vert Interval (vector) - Vertical curve domain actually sampled (start and end time).
Curve LUT
- Category: Video / Source
- Access: All editions.
- Function: Samples a scalar curve across a 1D LUT width and outputs it as both a strip texture and numeric values.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Curve (curve) - Curve evaluated from 0 to 1 to build LUT samples.
- ⏺ Out Size (integer) - Horizontal resolution (pixel width) of the LUT strip.
- Output pins:
- ⏺ Out (video) - Single-row texture holding the sampled LUT.
- ⏺ Values (vector) - Per-sample scalar values copied from the curve.
Image
- Category: Video / Source
- Access: All editions.
- Function: Loads a still image asset and outputs it as a fixed-frame video source with optional metadata.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Image File (text) - Image file path or asset id to bind as the texture.
- Output pins:
- ⏺ Out (video) - Video carrying the loaded texture each run.
- ⏺ Metadata (collection) - Attachment metadata exposed by the loaded image resource.
LUT Input
- Category: Video / Source
- Access: All editions.
- Function: Opens a LUT input device and outputs its current LUT texture.
- Input pins:
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open or read the LUT device.
- ⏺ Device (text) - LUT device name chosen from installed LUT inputs.
- ⏺ Open (logical) - When on and a device name is set, connects and reads frames; when off, releases the device.
- Output pins:
- ⏺ Out (video) - Latest LUT texture supplied by the device.
Meteo Grid
- Category: Video / Source
- Access: Broadcast & Film Edition required.
- Function: Renders weather grid volumes as video with geographic projection, sequencer-driven time sampling, and companion samplers.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ URI (text) - Resource locator used to acquire or identify grid data for this grid instance.
- ⏺ Lat Long Offset (vector) - Shifts the geographic bounding rectangle before projection mapping.
- ⏺ Lat Long Scale (vector) - Scales latitude-longitude extent of the mapped bounds.
- ⏺ Preprojected (logical) - When on, treats stored bounds as already converted by the selected projection.
- ⏺ Sequencer (sequence track reference) - Timeline reference whose clock selects the grid sample time.
- ⏺ Manual Time (double precision scalar) - Overrides sequencer time when connected.
- ⏺ Grid Data (binary buffer) - Binary stream with grid payloads or time shifts streaming from upstream loaders.
- ⏺ Geo Grid Transf (vector) - When fourteen values are supplied, selects projection mode, a 4x3 geographic transform, and aspect to derive output dimensions.
- ⏺ Value Offset (scalar) - Additive bias applied after sampling grid data.
- ⏺ Value Scale (scalar) - Multiplier applied after offset when sampling grid data.
- ⏺ Frame Blend (logical) - When on, linearly interpolates between stored time slices; when off, holds the nearest slice.
- ⏺ Out Width (scalar) - Target width or height used with grid aspect to pick the rendered frame size.
- Output pins:
- ⏺ Out (video) - Shaded visualization of the grid texture at the evaluated time.
- ⏺ Samplers (meteo grid sampler reference) - Reference feed that paired sampler inputs use to query scalar weather values from this grid.
Monoscope
- Category: Video / Source
- Access: All editions.
- Function: Draws a broadcast-style monoscope test card with editable corner and banner labels.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Main Text (text) - Large center label text.
- ⏺ Top Text (text) - Upper banner text.
- ⏺ Bottom Text (text) - Lower banner text (supports live tokens such as clock placeholders).
- ⏺ Left Text (text) - Left edge label text.
- ⏺ Right Text (text) - Right edge label text.
- ⏺ Out Size (vector) - Output frame width and height.
- Output pins:
- ⏺ Out (video) - Rendered monoscope graphic at the requested size.
Noise
- Category: Video / Source
- Access: All editions.
- Function: Renders procedural noise with adjustable frequency, optional RGB offsets, gamma, and still versus animated phases.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ H Scale (scalar) - Horizontal spatial scale of the noise field.
- ⏺ V Scale (scalar) - Vertical spatial scale of the noise field.
- ⏺ Colored (logical) - When on, generates uncorrelated RGB noise; when off, single-channel grayscale noise.
- ⏺ Gamma (scalar) - Output gamma shaping applied in the shader.
- ⏺ Still (logical) - When on, fixes noise phase components to the Still Pos pins; when off, randomizes phase each run.
- ⏺ Still Pos (vector) - Fixed horizontal and vertical phase for grayscale noise when Still is on.
- ⏺ Still Pos G (vector) - Fixed phase for the green channel when Colored and Still are on.
- ⏺ Still Pos B (vector) - Fixed phase for the blue channel when Colored and Still are on.
- ⏺ Out Size (vector) - Output frame width and height.
- Output pins:
- ⏺ Out (video) - Rendered noise texture at the chosen size and scaling.
Output Capture
- Category: Video / Source
- Access: All editions.
- Function: Samples the video (and optionally audio) routed to a numbered Video Out channel.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Output Index (integer) - Video Out channel index to read (0 yields no capture).
- Output pins:
- ⏺ Out (video) - Texture captured from that Video Out feed.
- ⏺ Audio (audio) - Audio chunk captured from the same channel when this output is connected.
Perlin Noise
- Category: Video / Source
- Access: All editions.
- Function: Renders Perlin-style fractal noise with selectable profile, fractal controls, optional HDR output, and optional shuffle modulation.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Type (integer, Perlin Noise Type) - Noise character: soft clouds, turbulence, or ridged multifractal.
- ⏺ H Offset (scalar) - Horizontal translation of the sampling coordinates.
- ⏺ V Offset (scalar) - Vertical translation of the sampling coordinates.
- ⏺ D Offset (scalar) - Depth slice offset for 3D noise sampling.
- ⏺ H Scale (scalar) - Horizontal frequency of the base noise octave.
- ⏺ V Scale (scalar) - Vertical frequency of the base noise octave.
- ⏺ Rotation (scalar) - Rotation angle applied before scaling the sampling coordinates.
- ⏺ Out Size (vector) - Output frame width and height.
- ⏺ Octaves (integer) - Number of fractal octaves composited in the shader.
- ⏺ Lacunarity (scalar) - Frequency multiplier between successive octaves.
- ⏺ Gain (scalar) - Amplitude multiplier applied per octave.
- ⏺ Ridge Offs (scalar) - Bias added in ridged mode to sharpen ridges.
- ⏺ Shuffle (logical) - When on, modulates output with an auxiliary noise texture path.
- ⏺ Shuffle H Scale (scalar) - Horizontal scale of the shuffle modulation texture.
- ⏺ Shuffle V Scale (scalar) - Vertical scale of the shuffle modulation texture.
- ⏺ Gamma (scalar) - Post-composite gamma shaping.
- ⏺ HDR Out (logical) - When on, targets HDR-style extended-range frame encoding.
- ⏺ Mono Out (logical) - When on, outputs luminance-only video.
- Output pins:
- ⏺ Out (video) - Rendered fractal noise field.
QR Code
- Category: Video / Source
- Access: All editions.
- Function: Encodes text as a QR symbol, scales it to a square output, and reports encode success and symbol size.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Text (text) - Payload encoded into the QR symbol.
- ⏺ Error Toler (integer, QR Error Correction) - Error correction level controlling redundancy versus density.
- ⏺ Border (integer) - Quiet margin width in modules around the QR matrix.
- ⏺ Out Size (integer) - Edge length in pixels of the final rendered square.
- Output pins:
- ⏺ Out (video) - Scaled QR image with sharp module edges.
- ⏺ Error (logical) - On when the encoder rejected the current text or settings.
- ⏺ Size (integer) - Side length in modules of the encoded QR matrix before border padding.
Screen Capture
- Category: Video / Source
- Access: All editions.
- Function: Grabs a desktop region or application client area asynchronously and streams it as video.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Monitor (text) - Display device name to capture when no application window is targeted.
- ⏺ App Name (text) - Process or window identifier used to capture a specific application instead of a monitor.
- ⏺ Direct (logical) - When capturing an app, keeps capture tied to the live window; when off, freezes the last client rectangle in screen space.
- ⏺ Keep Topmost (logical) - When capturing an app, temporarily raises the window while acquiring geometry.
- ⏺ Area (vector) - Optional left, top, width, height crop in pixels applied after the target rectangle is chosen.
- Output pins:
- ⏺ Out (video) - Video sized to the captured bitmap for the active target.
Sequence Video
- Category: Video / Source
- Access: All editions.
- Function: Decodes an opened media clip while driving playback time, opacity, and volume from a sequencer track.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open the media file or play back.
- ⏺ Video File (text) - Path to a video file, image sequence, or still image to decode.
- ⏺ Open (logical) - When on, loads VideoFile when set; when off, closes the media.
- ⏺ Video Stream Index (integer) - Selects which video stream index to decode from the file.
- ⏺ Audio Stream Index (integer) - Selects which audio stream index to decode from the file.
- ⏺ Use Audio Device (logical) - When on, sends decoded audio to the named playback device for monitoring.
- ⏺ Audio Device (text) - Playback device used when Use Audio Device is on.
- ⏺ Allow Audio Stretch (logical) - When on, allows audio timing to stretch to track playback speed changes.
- ⏺ Clear Audio On Disconnect (logical) - When on, clears routed audio when the main video output is disconnected.
- ⏺ Resolution (integer, Video Decoding Resolution) - Decoded picture size preset relative to the native stream.
- ⏺ Force 8 Bit (logical) - When on, decodes to 8-bit channel depth.
- ⏺ Keep Color Space (logical) - When on, performs no color-space conversion on incoming color, leaving the signal for your own LUT afterward.
- ⏺ Color Space (integer, Color Space) - Manual color-space choice when not keeping embedded tags.
- ⏺ Gamma Curve (integer, Gamma Usage) - How gamma is interpreted versus linear working space.
- ⏺ Exposure (scalar) - Linear exposure multiplier before writing the frame (near zero skips the fast output path).
- ⏺ HDR Out (logical) - When on, targets HDR-style extended range output.
- ⏺ Chroma Offset (scalar) - Fine chroma plane shift for planar YUV frames.
- ⏺ Default Frame Rate (double precision scalar) - Fallback frames-per-second used when the file lacks reliable timing.
- ⏺ Select Field (integer, Video Field) - Which interlaced field to emphasize when playback speed deviates from normal.
- ⏺ Frame Blending (logical) - When on, blends neighboring frames to smooth motion under uneven timing.
- ⏺ Strict Frame Blend (logical) - When on with frame blending, uses the decoder blend pair instead of width-based blending.
- ⏺ Frame Blend Width (scalar) - Blend zone width for non-strict frame blending.
- ⏺ Premul (logical) - When on, treats alpha as premultiplied in the GPU conversion path.
- ⏺ Mipmaps (logical) - When on, builds mipmaps on the output texture after conversion.
- ⏺ Buffer Min (integer) - Minimum decoder buffer fill targeted before playback runs full speed.
- ⏺ Buffer Max (integer) - Upper bound on decoder read-ahead buffering.
- ⏺ Show Buffer Icon (logical) - When on, draws a buffering indicator while the decoder catches up.
- ⏺ Dummy Out (logical) - When on, trims GPU preload work for lightweight preview use.
- ⏺ Sequencer (sequence track reference) - Reference to the timeline whose clock feeds the sequence track.
- ⏺ Manual Time (double precision scalar) - Overrides sequencer time when connected.
- ⏺ Start Time (double precision scalar) - Seconds added to the scaled sequencer time before playback sampling.
- ⏺ Speed (scalar) - Multiplier applied to sequencer time before mapping into the clip.
- ⏺ Looping (logical) - When on, wraps playback time across the clip duration; when off, clamps to the ends.
- ⏺ Timecode Master (logical) - When on, overwrites system Master Timecode with the timecode coming from the source.
- ⏺ Reset Track (trigger) - Trigger that refreshes the hidden duration handoff to the sequence curves.
- Output pins:
- ⏺ Loaded (trigger) - Pulses once after the media opens or the file parameters change successfully.
- ⏺ Out (video) - Decoded video frame at the evaluated playback time.
- ⏺ Audio (audio) - Decoded audio aligned to the same playback time after volume shaping.
- ⏺ Active (logical) - On while the sequence track reports an active segment at the current time.
- ⏺ Opacity (scalar) - Opacity curve sample applied to this render pass.
- ⏺ Volume (scalar) - Volume curve sample applied to audio routing.
- ⏺ Duration (double precision scalar) - Opened media duration used for looping and clamping.
- ⏺ Frame Count (integer) - Declared frame count reported by the decoder.
- ⏺ Frame Rate (double precision scalar) - Declared frame rate reported by the decoder.
- ⏺ Interlaced (logical) - On when the stream is flagged interlaced.
- ⏺ Position (double precision scalar) - Playback time in seconds after start offset, speed, and looping rules.
- ⏺ Timecode (integer) - Embedded timecode associated with the displayed frame.
- ⏺ Frame Index (integer) - Display frame index from the decoder.
- ⏺ Metadata (collection) - Attachment metadata carried on the displayed frame when present.
- ⏺ Buffer Level (integer) - Decoder buffer fill used for streaming read-ahead.
Solid Color
- Category: Video / Source
- Access: All editions.
- Function: Fills the output frame with a single solid color and optional HDR or monochrome encoding.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Color (color) - Fill color applied across the frame.
- ⏺ Out Size (vector) - Output frame width and height.
- ⏺ HDR Out (logical) - When on, targets HDR-style extended-range frame encoding.
- ⏺ Mono Out (logical) - When on, outputs luminance-only video.
- Output pins:
- ⏺ Out (video) - Uniform-color frame at the requested size.
Text Image
- Category: Video / Source
- Access: All editions.
- Function: Renders formatted text into a bitmap with optional auto sizing, mipmaps, and placement readouts.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Auto Image Size (logical) - When on, measures text to choose output dimensions unless fixed axes lock width or height.
- ⏺ Fixed Width (logical) - When on with auto sizing, keeps the authored width while height grows.
- ⏺ Fixed Height (logical) - When on with auto sizing, keeps the authored height while width grows.
- ⏺ Image Size (vector) - Manual frame size when auto sizing is off; starting width or height when auto sizing trims the other axis.
- ⏺ Adjust Auto Size (vector) - Extra pixels added after automatic width and height measurement.
- ⏺ Adjust Position (vector) - Translation applied before drawing the text layout origin.
- ⏺ Text Format (text format) - Typography resource controlling font, alignment, and wrapping.
- ⏺ Bg Color (color) - Premultiplied background fill cleared before drawing.
- ⏺ Color (color) - Foreground brush color for the glyphs.
- ⏺ Text (text) - Characters rendered into the layout.
- ⏺ Mipmaps (logical) - When on, generates mipmaps on the final GPU texture path.
- Output pins:
- ⏺ Out (video) - Rasterized text image with alpha.
- ⏺ Text Pos (vector) - Top-left metrics position returned from the layout.
- ⏺ Text Size (vector) - Measured width and height of the laid-out text block.
Video Input
- Category: Video / Source
- Access: All editions.
- Function: Captures live video and optional audio from a hardware or remote device with delay, color processing, and diagnostics.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open or capture from the device.
- ⏺ Device (text) - Video input device name from the capture stack.
- ⏺ Mode (text) - Capture mode preset for the device, or automatic selection when empty.
- ⏺ Open (logical) - When on and a device is named, connects the reader; when off, closes capture.
- ⏺ Delay (double precision scalar) - Seconds of delay inserted in the sync reader before frames surface.
- ⏺ Timecode Master (logical) - When on, overwrites system Master Timecode with the timecode coming from the source.
- ⏺ Keep Color Space (logical) - When on, performs no color-space conversion on incoming color, leaving the signal for your own LUT afterward.
- ⏺ Color Space (integer, Color Space) - Overrides input color interpretation when tags are ignored.
- ⏺ Gamma Curve (integer, Gamma Usage) - Selects how incoming gamma is interpreted versus linear working space.
- ⏺ Exposure (scalar) - Linear exposure multiplier before GPU conversion (near zero forces a lightweight dummy path).
- ⏺ HDR Out (logical) - When on, renders into HDR-range frame buffers.
- ⏺ Chroma Offset (scalar) - Subpixel chroma shift for planar YUV sources.
- ⏺ Select Field (integer, Video Field) - Which interlaced field to honor when the stream is interlaced.
- ⏺ Mipmaps (logical) - When on, builds mipmaps on the converted output texture.
- ⏺ Opacity (scalar) - Opacity applied when compositing live frames or fallback imagery.
- ⏺ No Input Image (video) - Video texture shown when the device reports no signal but this pin carries a frame.
- ⏺ Dummy Out (logical) - When on, skips heavy GPU conversion and fills a black preview frame at native dimensions.
- ⏺ Enable Log (logical) - When on, routes device errors through the logging pin pair on the error state helper.
- Output pins:
- ⏺ Out (video) - Converted live frame, status slate, or fallback image depending on device health.
- ⏺ Audio (audio) - Captured audio chunk aligned with the video frame when available.
- ⏺ Frame Rate (double precision scalar) - Reported input frame rate from device metadata.
- ⏺ Interlaced (logical) - On when the active mode is interlaced.
- ⏺ Timecode (integer) - Embedded timecode from the latest frame, or sentinels for cloud handoff modes.
- ⏺ Frame Index (integer) - Decoder frame index for the displayed sample.
- ⏺ Timestamp (double precision scalar) - Decoder timestamp for the displayed sample.
- ⏺ Time Delta (double precision scalar) - Delta between successive frame timestamps from the reader.
- ⏺ Sync Delta (double precision scalar) - Difference between media timestamps and the sync reader clock.
- ⏺ Metadata (collection) - Attachment metadata from the active video frame.
- ⏺ Buffer Level (integer) - Buffered frame depth reported by the sync reader.
Video Player
- Category: Video / Source
- Access: All editions.
- Function: Plays a video file with transport controls (play, pause, stop, restart), looping, and timeline control.
- Input pins:
- ⏺ Active (logical) - When off, skips generating output so this source does no per-run work (players also stop decoding and timeline advance).
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open the media file or play back.
- ⏺ Video File (text) - Path to a video file, image sequence, or still image to decode.
- ⏺ Open (logical) - When on, loads VideoFile when set; when off, closes the media.
- ⏺ Video Stream Index (integer) - Selects which video stream index to decode from the file.
- ⏺ Audio Stream Index (integer) - Selects which audio stream index to decode from the file.
- ⏺ Use Audio Device (logical) - When on, sends decoded audio to the named playback device for monitoring.
- ⏺ Audio Device (text) - Playback device used when Use Audio Device is on.
- ⏺ Allow Audio Stretch (logical) - When on, allows audio timing to stretch to track playback speed changes.
- ⏺ Clear Audio On Disconnect (logical) - When on, clears routed audio when the main video output is disconnected.
- ⏺ Resolution (integer, Video Decoding Resolution) - Decoded picture size preset relative to the native stream.
- ⏺ Force 8 Bit (logical) - When on, decodes to 8-bit channel depth.
- ⏺ Keep Color Space (logical) - When on, performs no color-space conversion on incoming color, leaving the signal for your own LUT afterward.
- ⏺ Color Space (integer, Color Space) - Manual color-space choice when not keeping embedded tags.
- ⏺ Gamma Curve (integer, Gamma Usage) - How gamma is interpreted versus linear working space.
- ⏺ Exposure (scalar) - Linear exposure multiplier before writing the frame (near zero skips the fast output path).
- ⏺ HDR Out (logical) - When on, targets HDR-style extended range output.
- ⏺ Chroma Offset (scalar) - Fine chroma plane shift for planar YUV frames.
- ⏺ Default Frame Rate (double precision scalar) - Fallback frames-per-second used when the file lacks reliable timing.
- ⏺ Select Field (integer, Video Field) - Which interlaced field to emphasize when playback speed deviates from normal.
- ⏺ Frame Blending (logical) - When on, blends neighboring frames to smooth motion under uneven timing.
- ⏺ Strict Frame Blend (logical) - When on with frame blending, uses the decoder blend pair instead of width-based blending.
- ⏺ Frame Blend Width (scalar) - Blend zone width for non-strict frame blending.
- ⏺ Premul (logical) - When on, treats alpha as premultiplied in the GPU conversion path.
- ⏺ Mipmaps (logical) - When on, builds mipmaps on the output texture after conversion.
- ⏺ Buffer Min (integer) - Minimum decoder buffer fill targeted before playback runs full speed.
- ⏺ Buffer Max (integer) - Upper bound on decoder read-ahead buffering.
- ⏺ Show Buffer Icon (logical) - When on, draws a buffering indicator while the decoder catches up.
- ⏺ Dummy Out (logical) - When on, trims GPU preload work for lightweight preview use.
- ⏺ Cursor (double precision scalar) - Playback sample position in seconds, or frame index when Frames is on (snapped unless strict frame blending is active).
- ⏺ Timecode Sync (logical) - When on and Frames is off, drives playback time from RefTimecode instead of Cursor and speed integration.
- ⏺ Ref Timecode (integer) - Embedded timecode value mapped to playback time while timecode sync is on.
- ⏺ Offset (double precision scalar) - Adds to the playback clock before sampling; combined time stays within the clip.
- ⏺ Playing State (integer, Playing State) - Stopped, paused, or playing; unconnected Play, Pause, or Stop pins update this value when those triggers fire.
- ⏺ Play (trigger) - Starts or resumes advancing playback; Restart also selects the playing state.
- ⏺ Pause (trigger) - Halts advancing playback.
- ⏺ Stop (trigger) - Halts playback and selects the stopped state.
- ⏺ Restart (trigger) - Runs the same seek reset path as initial open, respecting Skip on Init and Cursor.
- ⏺ Speed (scalar) - Playback rate multiplier; snaps to integer steps when Frames is on and eases while the decoder buffers.
- ⏺ Frames (logical) - When on, runs the timeline in frame units and converts Cursor and Offset via the stream frame rate.
- ⏺ Looping (logical) - When on, wraps playback at the clip ends instead of stopping at the bounds.
- ⏺ Skip On Init (logical) - When on, first execution snaps to the clip end instead of Cursor.
- ⏺ Stop When Inactive (logical) - When on, idle executions still decode preview frames after stop or file change so Cursor edits stay visible.
- ⏺ Timecode Master (logical) - When on, overwrites system Master Timecode with the timecode coming from the source.
- ⏺ Opacity (scalar) - Scales rendered picture opacity (0 fully transparent, 1 unchanged).
- ⏺ Volume (scalar) - Gain before the Audio output and optional device monitoring path.
- Output pins:
- ⏺ Loaded (trigger) - Pulses once after the media opens or the file parameters change successfully.
- ⏺ Out (video) - Decoded picture at the sampled time after color conversion and HDR options.
- ⏺ Audio (audio) - Decoded sound chunk aligned to playback time after Volume gain.
- ⏺ Duration (double precision scalar) - Overall clip span in seconds, or frames when Frames is on.
- ⏺ Frame Count (integer) - Declared frame total for the opened stream.
- ⏺ Frame Rate (double precision scalar) - Declared frames-per-second for the opened stream.
- ⏺ Interlaced (logical) - On when the opened stream reports interlaced cadence.
- ⏺ Position (double precision scalar) - Playback clock after advancement and clamping (seconds or frame units per Frames).
- ⏺ Timecode (integer) - Embedded timecode carried on the displayed sample, field-adjusted when interlaced.
- ⏺ Frame Index (integer) - Display index taken from the decoded frame.
- ⏺ Metadata (collection) - Attachment metadata on the displayed frame when supplied; clears when the clip changes until a frame returns.
- ⏺ Ended (trigger) - Pulses when advancing playback reaches or wraps the clip bounds.
- ⏺ Buffer Level (integer) - Decoder buffer occupancy used for streaming read-ahead.
Video / Postprocessing
This section describes the built-in Flow Graph modules that filter, analyze, and transform video frames for post-processing and effects.
Adjuster
- Category: Video / Postprocessing
- Access: All editions.
- Function: Adjusts tone and color in RGB or HSX spaces using brightness, contrast, saturation, hue, channel balance, black/white levels, and gamma, with optional HDR frame encoding.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Space (integer, Color Space HSX) - Working color model for the adjustment math (RGB, YUV, Lab-style HSX variants, etc.).
- ⏺ Brightness (scalar) - Overall luminance scale applied in the chosen space.
- ⏺ Contrast (scalar) - Stretch or compress tonal range around mid-gray in the chosen space.
- ⏺ Saturation (scalar) - Color purity scale in the chosen chroma plane.
- ⏺ Hue (scalar) - Rotation or shift of hue in the chosen chroma plane.
- ⏺ Red (scalar) - Multiplier on the red channel within RGB-style balance.
- ⏺ Green (scalar) - Multiplier on the green channel within RGB-style balance.
- ⏺ Blue (scalar) - Multiplier on the blue channel within RGB-style balance.
- ⏺ Black (scalar) - Lower bound mapped into the tonal transform before gamma.
- ⏺ White (scalar) - Upper bound mapped into the tonal transform before gamma.
- ⏺ Gamma (scalar) - Gamma exponent applied after the tonal matrix.
- ⏺ HDR Out (logical) - When on, requests an HDR-compatible output surface format.
- Output pins:
- ⏺ Out (video) - Adjusted video in the requested format.
Blob Bounding Box Finder
- Category: Video / Postprocessing
- Access: All editions.
- Function: Finds the largest horizontal and vertical spans of mask coverage and outputs their inclusive pixel coordinates, with optional latency stabilization and mask preview.
- Input pins:
- ⏺ Mask (video) - Single-channel mask texture whose non-zero pixels define foreground regions.
- ⏺ Fix Latency (integer) - Number of frames the GPU readback pipeline keeps staggered when sampling bounds.
- Output pins:
- ⏺ X Left (integer) - Inclusive left pixel index of the widest horizontal foreground interval.
- ⏺ X Right (integer) - Inclusive right pixel index of that horizontal interval.
- ⏺ Y Top (integer) - Inclusive top pixel index of the tallest vertical foreground interval.
- ⏺ Y Bottom (integer) - Inclusive bottom pixel index of that vertical interval.
- ⏺ Mask (video) - Optional reconstructed rectangle mask rendered when this output is wired.
- ⏺ Latency (integer) - Echo of the Fix Latency setting applied to extraction.
Blurrer
- Category: Video / Postprocessing
- Access: All editions.
- Function: Applies separated Gaussian-style blur with selectable axis, quality, edge repeat rules, optional mask-weighted blending, and zero-radius passthrough.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Direction (integer, Bidir Convolver Dir) - Which axes receive blur passes (horizontal, vertical, or both).
- ⏺ Quality (integer, Blur Quality) - Sampling quality preset for the blur kernel.
- ⏺ Edge Mode (integer, Repeat Type) - Texture addressing at blur margins (clamp, mirror, none, etc.).
- ⏺ Radius (scalar) - Blur extent; at zero the input passes through unchanged.
- ⏺ Masked (logical) - When on, weights blur by the Mask texture per pixel.
- ⏺ Mask (video) - Mask texture used when masked blending is enabled.
- Output pins:
- ⏺ Out (video) - Blurred frame at the source size and format.
Bounds Finder
- Category: Video / Postprocessing
- Access: All editions.
- Function: Tracks upper and lower row bounds where luminance crosses a threshold, with optional fixed-latency smoothing and reset-triggered averaging of prior measurements.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Threshold (scalar) - Intensity gate defining visible content when building bounds.
- ⏺ Reset (trigger) - Trigger that finalizes averaged bounds and restarts accumulation windows.
- ⏺ Use Fix Latency (logical) - When on, delays outputs by Fix Latency frames for temporal stability.
- ⏺ Fix Latency (integer) - Frames to align readback when fixed latency is enabled.
- Output pins:
- ⏺ Top Bound X (integer) - Horizontal pixel index of the upper visible edge region.
- ⏺ Top Bound Y (scalar) - Normalized vertical coordinate of the upper bound.
- ⏺ Bottom Bound X (integer) - Horizontal pixel index of the lower visible edge region.
- ⏺ Bottom Bound Y (scalar) - Normalized vertical coordinate of the lower bound.
- ⏺ Is Valid (logical) - On when both bounds carry meaningful coordinates.
Bumper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Builds a tangent-space–style bump normal from luminance variation so lighting can read relief from flat imagery.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Bump Scale (scalar) - Strength of the derived surface normal perturbation.
- Output pins:
- ⏺ Out (video) - Normal-style video derived from the input detail.
Center Finder
- Category: Video / Postprocessing
- Access: All editions.
- Function: Computes intensity-weighted centroid coordinates of a mask, optional angular field compensation, pixel count, and normalized weight with GPU shrink-down readback.
- Input pins:
- ⏺ Mask (video) - Mask channel whose mass defines the region to summarize.
- ⏺ HFOV (scalar) - Optional horizontal field of view in degrees to undo perspective when finding center.
- ⏺ VFOV (scalar) - Optional vertical field of view in degrees paired with horizontal FOV.
- ⏺ Fix Latency (integer) - Frames of latency matching used by the 1×1 texture readback path.
- Output pins:
- ⏺ X (scalar) - Horizontal pixel coordinate of the weighted center.
- ⏺ Y (scalar) - Vertical pixel coordinate of the weighted center.
- ⏺ Count (integer) - Approximate masked pixel count contributing to the centroid.
- ⏺ Weight (scalar) - Normalized coverage measure from the shrink pass.
- ⏺ Latency (integer) - Echo of the Fix Latency setting applied to extraction.
Clamper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Clamps each enabled channel between minimum and maximum scalars while copying the frame.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Minimum (scalar) - Lower clamp bound applied to enabled channels.
- ⏺ Maximum (scalar) - Upper clamp bound applied to enabled channels.
- ⏺ Red (logical) - When on, clamps the red channel.
- ⏺ Green (logical) - When on, clamps the green channel.
- ⏺ Blue (logical) - When on, clamps the blue channel.
- ⏺ Alpha (logical) - When on, clamps the alpha channel.
- Output pins:
- ⏺ Out (video) - Clamped video.
Color Mapper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Uses each pixel’s color as coordinates into a volumetric (3D) color-map texture to recolor or grade the image, with optional HDR output and map encoding hints.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Color Map (video) - 3D texture defining output color by lookup along three axes; must be volumetric—otherwise the video input passes through unchanged.
- ⏺ HDR Out (logical) - When on, allocates HDR-capable output buffers.
- ⏺ Map Uses SRGB Input (logical) - When on, treats map coordinates as if authored in sRGB.
- ⏺ Map Gives SRGB Output (logical) - When on, interprets map texels as sRGB-encoded values.
- Output pins:
- ⏺ Out (video) - Color-mapped frame.
Converter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Changes pixel format, optional grayscale and alpha handling, color space and gamma interpretation, exposure offset, and mip chain presence while preserving dimensions unless format forces otherwise.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Format (integer, Converter Format) - Target DXGI-style surface format preset or unchanged.
- ⏺ Red To Gray (logical) - When on and the input is luminance-ready, collapses red into grayscale luminance.
- ⏺ Remove Alpha (logical) - When on, strips alpha while optionally unpremultiplying RGB.
- ⏺ With Unpremul (logical) - When removing alpha, divides RGB by alpha before drop.
- ⏺ In Color Space (integer, Color Space) - Overrides automatic detection of incoming RGB space.
- ⏺ In Gamma Curve (integer, Gamma Usage) - Overrides automatic incoming gamma curve usage.
- ⏺ Out Color Space (integer, Color Space) - Target RGB space for the written texture.
- ⏺ Out Gamma Curve (integer, Gamma Usage) - Target gamma curve encoding for the written texture.
- ⏺ Exposure (scalar) - Linear exposure offset applied during conversion.
- ⏺ Mipmaps (integer, Converter Mimpmaps) - Whether to keep, add, or strip mip levels relative to the source.
- Output pins:
- ⏺ Out (video) - Converted texture with requested encoding.
Cropper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Trims normalized margins from the frame, optionally keeps canvas size, recenters using guard-band sizing, and can emit protected bounds for licensing builds.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Left (scalar) - Fraction of width cropped from the left edge.
- ⏺ Top (scalar) - Fraction of height cropped from the top edge.
- ⏺ Right (scalar) - Fraction of width cropped from the right edge.
- ⏺ Bottom (scalar) - Fraction of height cropped from the bottom edge.
- ⏺ Keep Size (logical) - When on, draws the cropped rectangle into a full-size frame; when off, resizes to the crop.
- ⏺ Guard Band (logical) - When on, overrides width and height using Guarded Size centered in the computed crop.
- ⏺ Guarded Size (vector) - Explicit pixel width and height used when Guard Band is on.
- ⏺ Out Bounds (logical) - When on, skips clamping crop rectangles to the frame interior for special authoring modes.
- Output pins:
- ⏺ Out (video) - Cropped or letterboxed video.
Cropper Precise
- Category: Video / Postprocessing
- Access: All editions.
- Function: Aligns a crop using pixel or normalized offsets with independent horizontal and vertical placement rules.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Horiz Align (integer, Placer Horiz Align) - How horizontal pixel bounds anchor (edges vs center).
- ⏺ Vert Align (integer, Placer Vert Align) - How vertical pixel bounds anchor (edges vs center).
- ⏺ Left Pixel (scalar) - Left edge position in pixels when using pixel mode.
- ⏺ Top Pixel (scalar) - Top edge position in pixels when using pixel mode.
- ⏺ Right Pixel (scalar) - Right edge position in pixels when using pixel mode.
- ⏺ Bottom Pixel (scalar) - Bottom edge position in pixels when using pixel mode.
- ⏺ Width Pixel (scalar) - Explicit crop width in pixels when alignment modes require it.
- ⏺ Height Pixel (scalar) - Explicit crop height in pixels when alignment modes require it.
- ⏺ Left Norm (scalar) - Normalized horizontal inset or offset paired with alignment rules.
- ⏺ Top Norm (scalar) - Normalized vertical inset or offset paired with alignment rules.
- ⏺ Right Norm (scalar) - Normalized horizontal inset from the opposite edge.
- ⏺ Bottom Norm (scalar) - Normalized vertical inset from the opposite edge.
- ⏺ Width Norm (scalar) - Normalized width span used by certain alignment presets.
- ⏺ Height Norm (scalar) - Normalized height span used by certain alignment presets.
- ⏺ Keep Size (logical) - When on, preserves full frame dimensions while placing the crop region.
- Output pins:
- ⏺ Out (video) - Precisely cropped video.
Custom Processor
- Category: Video / Postprocessing
- Access: All editions.
- Function: Runs a user shader over the video with optional explicit output dimensions or format inherited from the input.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Shader (shader) - Pixel shader resource defining the processing pass.
- ⏺ Out Size (vector) - Target width and height; zero axes inherit the input size unless Keep In Size prevents resize.
- ⏺ Keep In Size (logical) - When on, keeps output dimensions aligned with the input regardless of Out Size.
- Output pins:
- ⏺ Out (video) - Shader result.
Delayer
- Category: Video / Postprocessing
- Access: All editions.
- Function: Ring-buffer delay line that shifts video by whole frames and can clear history on Reset.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Frames (integer) - Lag in frames between input acceptance and output presentation.
- ⏺ Reset (trigger) - Trigger that clears buffered frames.
- Output pins:
- ⏺ Out (video) - Delayed frame from the ring buffer.
Denoiser
- Category: Video / Postprocessing
- Access: All editions.
- Function: Runs spatial bilateral or local-average smoothing with adjustable radius and strength for noise suppression.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Type (integer, Denoiser Type) - Nearest-neighborhood average versus edge-preserving bilateral filtering.
- ⏺ Radius (scalar) - Spatial footprint of the filter kernel.
- ⏺ Strength (scalar) - Blend toward the filtered result versus the original.
- Output pins:
- ⏺ Out (video) - Spatially denoised frame.
Detwitterer
- Category: Video / Postprocessing
- Access: All editions.
- Function: Mitigates alternating-line twitter on interlaced-like content by adaptive vertical filtering.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ When Interlaced (logical) - When on, applies the filter only when the frame is flagged interlaced.
- Output pins:
- ⏺ Out (video) - Detwittered frame.
Directional Blurrer
- Category: Video / Postprocessing
- Access: All editions.
- Function: Separable blur steered by rotation with optional mask gating and optional rotation-map modulation.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Quality (integer, Blur Quality) - Sampling quality preset.
- ⏺ Edge Mode (integer, Repeat Type) - Edge sampling rules at texture bounds.
- ⏺ Radius (scalar) - Blur kernel radius along the oriented axis.
- ⏺ Rotation (scalar) - Angle of the blur axis in the image plane.
- ⏺ Masked (logical) - When on, limits blur using the Mask texture.
- ⏺ Mask (video) - Weight map for masked directional blur.
- ⏺ Rot Mapped (logical) - When on, perturbs rotation per pixel using Rot Map.
- ⏺ Rot Map (video) - Texture supplying per-pixel rotation offsets when Rot Mapped is on.
- Output pins:
- ⏺ Out (video) - Directionally blurred output.
Displace Bumper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Treats a displacement map as surface relief combined with a detail normal for bump shading.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Displace Map (video) - Height or displacement texture driving perturbation.
- ⏺ Displace Scale (scalar) - Amplitude of displacement-driven shading.
- ⏺ Detail Normal Map (video) - Fine normal overlay blended into the bump response.
- Output pins:
- ⏺ Out (video) - Bump-shaded result texture.
Distorter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Offsets sampling coordinates using a normal-map-style distortion texture with configurable horizontal and vertical strength.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Distort Map (video) - Tangent-space normal map encoding displacement direction and amount.
- ⏺ Edge Mode (integer, Repeat Type) - Sampling behavior beyond frame edges during warp.
- ⏺ H Amount (scalar) - Horizontal warp strength derived from the map.
- ⏺ V Amount (scalar) - Vertical warp strength derived from the map.
- Output pins:
- ⏺ Out (video) - Warped frame.
Edge Detector
- Category: Video / Postprocessing
- Access: All editions.
- Function: Computes gradient magnitude edges with selectable Prewitt, Sobel, or Scharr operators.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Operator (integer, Edge Detector Operator) - Finite-difference kernel family.
- Output pins:
- ⏺ Out (video) - Edge-emphasized frame.
Error Remover
- Category: Video / Postprocessing
- Access: All editions.
- Function: Sanitizes non-finite or out-of-range pixel values and can visualize fault locations while optionally clamping per channel.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ NAN (logical) - When on, replaces not-a-number samples.
- ⏺ Infinite (logical) - When on, replaces infinite magnitude samples.
- ⏺ Negative (logical) - When on, treats negative HDR values as errors for replacement.
- ⏺ Replace With (color) - Color used when substituting invalid samples.
- ⏺ Per Channel (logical) - When on, clamps each RGBA channel independently to min/max bounds.
- ⏺ Show Errors (logical) - When on, highlights faulty pixels instead of silently fixing them.
- Output pins:
- ⏺ Out (video) - Cleaned or debug-visualized frame.
Filter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Multiplies RGBA by a tint color in linear or gamma-aware paths with optional HDR targets.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Color (color) - Multiply color applied per channel.
- ⏺ HDR Out (logical) - When on, writes HDR-range surfaces.
- Output pins:
- ⏺ Out (video) - Tinted premultiplied result.
Gradient Mapper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Uses horizontal position within a gradient texture to recolor source luminance over an adjustable interval.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Gradient (video) - Horizontal ramp texture supplying replacement colors.
- ⏺ Interval (vector) - Low and high luminance mapped to gradient ends.
- Output pins:
- ⏺ Out (video) - Gradient-mapped frame.
Guard Extend
- Category: Video / Postprocessing
- Access: All editions.
- Function: Purely computes padded dimensions, economical inner size, adjusted zoom factor, and logical aspect from nominal size plus guard-band and aspect hints.
- Input pins:
- ⏺ Size (vector) - Baseline frame width and height before padding.
- ⏺ Zoom Factor (scalar) - Nominal zoom before guard-band adjustment.
- ⏺ Aspect (scalar) - Desired logical aspect tweak; unset keeps width over height.
- ⏺ Guard Band (scalar) - Fraction of height converted to symmetrical border growth.
- Output pins:
- ⏺ Size (vector) - Expanded width and height including guard borders.
- ⏺ Eco Size (vector) - Largest rectangle with the desired aspect fitting inside the original extents.
- ⏺ Zoom Factor (scalar) - Zoom corrected for guard-band scaling.
- ⏺ Aspect (vector) - Effective logical aspect ratio pair.
Guard Extender
- Category: Video / Postprocessing
- Access: All editions.
- Function: Pads the frame with replicated border texels sized by guard-band fraction of height, adjusts reported zoom factor, and outputs logical aspect alongside the resized video.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Zoom Factor (scalar) - Nominal optical zoom multiplier before guard-band normalization.
- ⏺ Aspect (scalar) - Optional logical aspect multiplier applied after padding.
- ⏺ Guard Band (scalar) - Fraction of source height added symmetrically as padding bands.
- Output pins:
- ⏺ Out (video) - Expanded frame preserving source format.
- ⏺ Zoom Factor (scalar) - Adjusted zoom divided by guard-band expansion factor.
- ⏺ Aspect (vector) - Effective width-over-height logical aspect including padding effects.
Holder
- Category: Video / Postprocessing
- Access: All editions.
- Function: Samples and freezes video on triggers or periodic cadence while optionally forcing fresh reads, clearing hold when Active passthrough disables processing.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Pass (trigger) - Trigger that marks the next eligible update window.
- ⏺ Pass If (logical) - Logical gate that opens an update window while on.
- ⏺ Pass Periodically (logical) - When on, retriggers Pass timing using Period.
- ⏺ Period (scalar) - Seconds between automatic Pass emissions when periodic mode is on.
- ⏺ Force (logical) - When on, always evaluates Video before deciding holds.
- Output pins:
- ⏺ Out (video) - Latest held GPU texture snapshot.
- ⏺ Passed (trigger) - Trigger emitted whenever a new hold capture is scheduled.
Inverter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Subtracts enabled RGBA channels from one to invert polarity per channel.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Red (logical) - When on, inverts red.
- ⏺ Green (logical) - When on, inverts green.
- ⏺ Blue (logical) - When on, inverts blue.
- ⏺ Alpha (logical) - When on, inverts alpha.
- Output pins:
- ⏺ Out (video) - Channel-wise inverted frame.
Lens Distorter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Warps video using radial lens models, optional tracking vector payloads, filtered sampling, guard resizing, pure aspect correction-only mode, and echoed lens payload output.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Undistort (logical) - When on, applies inverse lens mapping instead of forward distortion.
- ⏺ Desc Type (integer, Camera Lens Desc Type) - Lens descriptor layout when no packed Lens Data vector is supplied.
- ⏺ Sensor Width (scalar) - Physical sensor width paired with field-of-view math.
- ⏺ Field Of View (scalar) - Horizontal full field of view in degrees for synthetic descriptors.
- ⏺ Aspect (scalar) - Override aspect ratio for synthetic descriptors when positive.
- ⏺ Center Shift (vector) - Principal-point offset from image center.
- ⏺ Radial Distortion (vector) - Packed radial coefficients for the synthetic lens model.
- ⏺ Lens Data (vector) - Serialized lens descriptor from tracking or calibration; overrides manual fields when valid.
- ⏺ Filter (integer, Filter Type) - Texture filtering mode at sample boundaries.
- ⏺ Corr Aspect (logical) - When on, applies aspect-correction scaling alongside radial terms.
- ⏺ Only Corr Aspect (logical) - When on, performs aspect normalization only and skips radial warp when correction is near unity.
- ⏺ Guard Band (logical) - When on, targets Guarded Size dimensions including padding math.
- ⏺ Guarded Size (vector) - Explicit guarded width and height when Guard Band is on.
- Output pins:
- ⏺ Out (video) - Warped output frame.
- ⏺ Lens Data (vector) - Echo of the resolved descriptor vector when connected.
Level Color Mapper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Maps luminance through a multi-stop color ramp with optional smooth blending, HDR or monochrome outputs, automatic equal spacing of levels or colors, and pin push-back when equalizing.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Smooth (logical) - When on, interpolates smoothly between stops; when off, uses hard bands.
- ⏺ HDR Out (logical) - When on, allocates HDR buffers for the graded output.
- ⏺ Mono Out (logical) - When on, emits luminance-only output.
- ⏺ Num Levels (integer) - How many Level/Color pairs participate (2–11).
- ⏺ Auto Equal Steps (logical) - When on, each run evenly spaces interior Level values between first and last.
- ⏺ Auto Equal Grad (logical) - When on, each run evenly interpolates interior Colors between endpoints.
- ⏺ Equal Steps (trigger) - Trigger that reapplies equal spacing and pushes updated Level constants to the UI.
- ⏺ Equal Grad (trigger) - Trigger that reapplies equal color ramps and pushes updated Color constants to the UI.
- ⏺ Level 1 (scalar) - First luminance breakpoint (dark end).
- ⏺ Color 1 (color) - Color paired with Level1.
- ⏺ Level 2 (scalar) - Second luminance breakpoint.
- ⏺ Color 2 (color) - Color paired with Level2.
- ⏺ Level 3 (scalar) - Third luminance breakpoint.
- ⏺ Color 3 (color) - Color paired with Level3.
- ⏺ Level 4 (scalar) - Fourth luminance breakpoint.
- ⏺ Color 4 (color) - Color paired with Level4.
- ⏺ Level 5 (scalar) - Fifth luminance breakpoint.
- ⏺ Color 5 (color) - Color paired with Level5.
- ⏺ Level 6 (scalar) - Sixth luminance breakpoint.
- ⏺ Color 6 (color) - Color paired with Level6.
- ⏺ Level 7 (scalar) - Seventh luminance breakpoint.
- ⏺ Color 7 (color) - Color paired with Level7.
- ⏺ Level 8 (scalar) - Eighth luminance breakpoint.
- ⏺ Color 8 (color) - Color paired with Level8.
- ⏺ Level 9 (scalar) - Ninth luminance breakpoint.
- ⏺ Color 9 (color) - Color paired with Level9.
- ⏺ Level 10 (scalar) - Tenth luminance breakpoint.
- ⏺ Color 10 (color) - Color paired with Level10.
- ⏺ Level 11 (scalar) - Eleventh luminance breakpoint (bright end).
- ⏺ Color 11 (color) - Color paired with Level11.
- Output pins:
- ⏺ Out (video) - Pseudo-colored frame after level mapping.
Levels
- Category: Video / Postprocessing
- Access: All editions.
- Function: Applies classic lift/gamma/gain style remapping with optional per-channel clamping using input and output black/white controls.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ In Black (scalar) - Input value mapped to Out Black.
- ⏺ In White (scalar) - Input value mapped to Out White.
- ⏺ Gamma (scalar) - Midtone power curve between black and white anchors.
- ⏺ Out Black (scalar) - Destination black level after scaling.
- ⏺ Out White (scalar) - Destination white level after scaling.
- ⏺ Clamp (logical) - When on, clamps results to the output black/white span.
- ⏺ Red (logical) - When on, applies levels math to red independently.
- ⏺ Green (logical) - When on, applies levels math to green independently.
- ⏺ Blue (logical) - When on, applies levels math to blue independently.
- ⏺ Alpha (logical) - When on, applies levels math to alpha independently.
- Output pins:
- ⏺ Out (video) - Tonally remapped frame.
LUT Inverter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Builds an inverse 3D LUT texture from a forward cube LUT by heavy CPU analysis, triggered on Update, with selectable resolution and format and a Done pulse when finished.
- Input pins:
- ⏺ LUT (video) - Equal-edge cube LUT texture whose texels define the forward mapping.
- ⏺ Out Size (integer, LUT Inverter Out Size) - Edge length of the output cube or automatic sizing based on input complexity.
- ⏺ Out Format (integer, LUT Inverter Out Format) - Preferred texel format for the generated cube.
- ⏺ Update (trigger) - Trigger that restarts inversion from the current LUT input.
- Output pins:
- ⏺ Out (video) - Inverse LUT volume updated after processing completes.
- ⏺ Done (trigger) - Pulses once each time a new inverse texture is ready.
Measurer
- Category: Video / Postprocessing
- Access: All editions.
- Function: Measures normalized or paint-space rectangles to report sizing, luminance centroid, HDR flags, pixel format detail, optional min/max colors with smoothing, and extractor latency alignment.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Prop Area (logical) - When on, treats Area bounds as paint-document coordinates transformed into pixels.
- ⏺ Area Left (scalar) - Left boundary of the measurement rectangle (normalized or proportional units depending on Prop Area).
- ⏺ Area Top (scalar) - Top boundary of the measurement rectangle.
- ⏺ Area Right (scalar) - Right boundary of the measurement rectangle.
- ⏺ Area Bottom (scalar) - Bottom boundary of the measurement rectangle.
- ⏺ Smooth Min Max (logical) - When on, averages during min/max pyramid reduction for softer extrema.
- ⏺ Keep Linear (logical) - When off and the linear pipeline is active, converts extrema to display gamma for min/max outputs.
- ⏺ Use Fix Latency (logical) - When on, aligns GPU readbacks with Fix Latency frames.
- ⏺ Fix Latency (integer) - Latency frames used when fixed alignment is enabled.
- Output pins:
- ⏺ Size (vector) - Pixel width and height of the clipped measurement area.
- ⏺ Aspect (vector) - Effective width-over-height accounting for pixel aspect metadata.
- ⏺ Pixel Aspect (scalar) - Pixel aspect ratio inherited from the frame descriptor.
- ⏺ Pixel Format (text) - Human-readable DXGI format identifier for the sampled surface.
- ⏺ Deep Color (logical) - On when the surface uses HDR or high-precision channel formats.
- ⏺ HDR (logical) - On when the sampled format is HDR-range.
- ⏺ Luminance (scalar) - Average luminance extracted from the weighted measurement region.
- ⏺ Color (color) - Average premultiplied color inside the region.
- ⏺ Minimum (color) - Downscaled minimum color inside the region when connected.
- ⏺ Maximum (color) - Downscaled maximum color inside the region when connected.
Median Filter
- Category: Video / Postprocessing
- Access: All editions.
- Function: Applies an expanding-axis median filter with clamped edges; radius zero passes the frame through unchanged.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Radius (integer) - Half-width of the median window along each separable axis.
- Output pins:
- ⏺ Out (video) - Median-filtered frame.
Meteo Grid Sampler
- Category: Video / Postprocessing
- Access: Broadcast & Film Edition required.
- Function: Looks up a scalar weather value from a connected Meteo Grid sampler reference at the given latitude and longitude.
- Input pins:
- ⏺ Grid (meteo grid sampler reference) - Sampler reference produced by Meteo Grid to read cell data from.
- ⏺ Lat Long (vector) - Latitude and longitude in degrees used for bilinear-style sampling.
- Output pins:
- ⏺ Out (scalar) - Scalar field value returned by the grid at that location.
Normal Scaler
- Category: Video / Postprocessing
- Access: All editions.
- Function: Renormalizes tangent-space normals after scaling their XY perturbation so lighting stays consistent.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Normal Map (video) - Packed normal texture to amplify or damp.
- ⏺ Scale (scalar) - Multiplier on XY bump before renormalizing Z.
- Output pins:
- ⏺ Out (video) - Rescaled normal map.
Retro Film
- Category: Video / Postprocessing
- Access: All editions.
- Function: Overlays procedural dust, scratches, blotches, and gate-weave style shake driven by stochastic periods and densities.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Dust Period (scalar) - Average seconds between dust specks.
- ⏺ Dust Length (scalar) - Typical streak length for dust scratches.
- ⏺ Dust Density (scalar) - Probability multiplier for dust events.
- ⏺ Hair Period (scalar) - Timing driver for thin vertical hair scratches.
- ⏺ Scratch Density (scalar) - Intensity of fine scratches relative to velocity scaling.
- ⏺ Mass Scratch Density (scalar) - Intensity of broad scratches tied to scratch velocity.
- ⏺ Scratch Velocity (scalar) - Scroll speed factor applied to scratch placement.
- ⏺ Splotch Period (scalar) - Average seconds between chemical blotches.
- ⏺ Splotch Length (scalar) - Characteristic length of blot artifacts.
- ⏺ Splotch Density (scalar) - Probability multiplier for blot events.
- ⏺ Shake Period (scalar) - Average seconds between gate-weave impulses.
- ⏺ Shake Length (scalar) - Temporal duration of shake bursts.
- ⏺ Shake Amount (scalar) - Pixel amplitude of positional jitter.
- Output pins:
- ⏺ Out (video) - Film-aged composite.
Scope
- Category: Video / Postprocessing
- Access: All editions.
- Function: Renders diagnostic scope imagery via a chosen shader into a configurable output frame size.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Shader (shader) - Visualization shader defining how samples are plotted.
- ⏺ Out Size (vector) - Raster width and height for the diagnostic render.
- Output pins:
- ⏺ Out (video) - Rendered scope image.
Shaper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Runs iterative erode, dilate, open, or close stacks with fractional morphological blending controlled by Amount and edge sampling rules.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Operator (integer, Shaper Operator) - Morphological recipe applied sequentially.
- ⏺ Edge Mode (integer, Repeat Type) - Sampling beyond borders during convolutions.
- ⏺ Amount (scalar) - Iteration count plus fractional blend between last passes.
- Output pins:
- ⏺ Out (video) - Morphologically shaped result.
Sharpener
- Category: Video / Postprocessing
- Access: All editions.
- Function: Applies a fixed 3×3 Laplacian-like sharpen kernel with standard or stronger coefficients selected by More.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ More (logical) - When on, selects the higher-contrast kernel preset.
- Output pins:
- ⏺ Out (video) - Sharpened frame matching source format.
Soft Cropper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Feathers one image edge inward using a raised profile controllable by width, center, power, and gamma shaping.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Side (integer, Soft Cropper Side) - Which border region receives the feather.
- ⏺ Offset (scalar) - Slides the feather region along the chosen side.
- ⏺ Width (scalar) - Normalized extent of the feather band.
- ⏺ Center (scalar) - Normalized center position of the feather within the side.
- ⏺ Power (scalar) - Exponent shaping the feather ramp steepness.
- ⏺ Gamma (scalar) - Gamma correction applied to the feather mask.
- Output pins:
- ⏺ Out (video) - Video with multiplied edge attenuation.
Temporal Denoiser
- Category: Video / Postprocessing
- Access: All editions.
- Function: Blends current and previous frames using color-distance gating and copies the filtered result back into history each run.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Threshold (scalar) - Allowed per-pixel color delta before rejecting history.
- ⏺ Blend Factor (scalar) - Blend weight toward the temporal accumulation.
- Output pins:
- ⏺ Out (video) - Temporally stabilized frame.
Tone Mapper
- Category: Video / Postprocessing
- Access: All editions.
- Function: Tone-maps HDR or linear scenes with selectable operators, exposure and peak-luminance caps, bloom and glare extraction, streak and ghost libraries, and packed parameter telemetry for downstream reuse.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Exposure (scalar) - Linear exposure multiplier prior to curve application.
- ⏺ Max Out Lum (scalar) - Peak luminance clamp applied after tone shaping.
- ⏺ Max Out Lum In Nits (logical) - When on, treats Max Out Lum as candela-per-square-meter scaled internally.
- ⏺ Method (integer, Tone Mapping Method) - Tone-mapping curve family (Reinhard, ACES, Hable, Advanced, etc.).
- ⏺ White Lum (scalar) - Reference white for Reinhard-style shoulder control.
- ⏺ Toe Strength (scalar) - Toe curvature weight for Hable Filmic controls.
- ⏺ Toe Length (scalar) - Toe length term for Hable Filmic controls.
- ⏺ Shoulder Strength (scalar) - Shoulder blend strength in Hable mode.
- ⏺ Shoulder Length (scalar) - Shoulder length term in Hable mode.
- ⏺ Shoulder Angle (scalar) - Shoulder angle shaping in Hable mode.
- ⏺ Gamma (scalar) - Gamma correction applied inside the Hable piecewise curve.
- ⏺ Midpoint (scalar) - Log-space pivot for the Advanced curve.
- ⏺ Contrast (scalar) - Contrast shaping for the Advanced curve.
- ⏺ Glares (logical) - When on, renders bloom passes and optional separate Glares output.
- ⏺ Bright Threshold (scalar) - Luminance cutoff feeding bloom extraction.
- ⏺ Bright Upper Cut (scalar) - Upper luminance clamp for bloom source.
- ⏺ Bright Offset (scalar) - Additive offset on bright-region selection.
- ⏺ Bloom Steps (integer) - Iterations of downsampling blur for bloom.
- ⏺ Bloom Intensity (scalar) - Gain on the bloom composite.
- ⏺ Bloom Gamma (scalar) - Gamma shaping on bloom energy.
- ⏺ Bloom Size (scalar) - Spatial spread scale of bloom.
- ⏺ Streaks (logical) - When on, convolves streak kernels into the glare pass.
- ⏺ Streak Type (integer, Glare Streak Lib Type) - Library preset defining streak aperture response.
- ⏺ Streak Intensity (scalar) - Gain on streak glare contribution.
- ⏺ Streak Gamma (scalar) - Gamma shaping along streak lobes.
- ⏺ Streak Size (scalar) - Radial span multiplier for streaks.
- ⏺ Streak Rotation (scalar) - Angular rotation applied to streak patterns.
- ⏺ Streak Chrom Aberr (scalar) - Separates streak RGB channels for chromatic fringe.
- ⏺ Streak Blue Depth (scalar) - Additional blue-channel elongation for streak ghosts.
- ⏺ Ghosts (logical) - When on, adds aperture ghost plates to the glare pass.
- ⏺ Ghost Type (integer, Glare Ghost Lib Type) - Library preset for ghost reflection layout.
- ⏺ Ghost Intensity (scalar) - Gain on ghost reflections.
- ⏺ Ghost Gamma (scalar) - Gamma shaping within ghost plates.
- ⏺ Force Linear Input (logical) - When on, evaluates exposure and thresholds in linear light even if the viewer pipeline is not.
- ⏺ Force HDR Out (logical) - When on, forces HDR destination surfaces regardless of peak white.
- Output pins:
- ⏺ Out (video) - Tone-mapped base image with optional bloom merged in.
- ⏺ Glares (video) - Isolated bloom/glare layer when connected.
- ⏺ Parameters (vector) - Packed scalars describing active operator, exposure, peak white, linear mode, and method-specific coefficients.
Unsharp Masker
- Category: Video / Postprocessing
- Access: All editions.
- Function: Subtracts a premade blurred plate from the source with thresholded high-frequency emphasis for controllable sharpening.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Blurred (video) - Low-pass companion frame matching the sharp input.
- ⏺ Amount (scalar) - Strength of the high-frequency add-back.
- ⏺ Threshold (scalar) - Minimum edge delta that receives sharpening boost.
- Output pins:
- ⏺ Out (video) - Sharpened output at the sharp input format.
Video / Color
This section describes the built-in Flow Graph modules that correct, convert, and grade color in video signals.
Alpha Merger
- Category: Video / Color
- Access: All editions.
- Function: Combines RGB video with an alpha mask into one merged output stream.
- Input pins:
- ⏺ RGB (video) - Color layer merged with the alpha mask before output.
- ⏺ Alpha (video) - Opacity mask; when missing or empty, the merge treats alpha as fully opaque.
- ⏺ Premul (logical) - When on, uses the premultiplied-alpha merge path; when off, uses straight alpha.
- Output pins:
- ⏺ Out (video) - Merged color and transparency in one stream.
Alpha Splitter
- Category: Video / Color
- Access: All editions.
- Function: Splits video into separate RGB and alpha outputs.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Unpremul (logical) - When on, treats the input as premultiplied when splitting; when off, treats it as straight alpha.
- ⏺ Mono Out (logical) - When on, writes the alpha output as monochrome (single-channel) video.
- Output pins:
- ⏺ RGB (video) - Color-only output matching the input frame layout.
- ⏺ Alpha (video) - Alpha-only mask output with color-space tagging cleared for mask-style use.
Chroma Composer
- Category: Video / Color
- Access: All editions.
- Function: Merges separate chroma, luma, and alpha inputs into one output stream.
- Input pins:
- ⏺ Chroma (video) - Chroma (color-difference) plane merged with luma and alpha.
- ⏺ Luma (video) - Luminance plane; output dimensions accommodate chroma, luma, and alpha together.
- ⏺ Alpha (video) - Opacity mask; when missing or empty, the merge treats alpha as fully opaque.
- ⏺ Premul (logical) - When on, uses the premultiplied-alpha merge path; when off, uses straight alpha.
- Output pins:
- ⏺ Out (video) - Merged chroma, luma, and alpha in display RGB layout.
Chroma Decomposer
- Category: Video / Color
- Access: All editions.
- Function: Splits video into chroma, luma, and alpha planes; produces no output when the incoming frame is empty.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Unpremul (logical) - When on, treats the input as premultiplied when decomposing; when off, treats it as straight alpha.
- ⏺ Mono Out (logical) - When on, forces luma and alpha outputs into monochrome format.
- Output pins:
- ⏺ Chroma (video) - Chroma plane extracted from the input.
- ⏺ Luma (video) - Luminance plane extracted from the input.
- ⏺ Alpha (video) - Alpha plane as a separate video stream.
CMYK Composer
- Category: Video / Color
- Access: All editions.
- Function: Composes cyan, magenta, yellow, key, and alpha plates into one output stream.
- Input pins:
- ⏺ Cyan (video) - Cyan plate merged with the other inks and alpha.
- ⏺ Magenta (video) - Magenta plate merged with the other inks and alpha.
- ⏺ Yellow (video) - Yellow plate merged with the other inks and alpha.
- ⏺ Key (video) - Black (key) plate merged with the process inks and alpha.
- ⏺ Alpha (video) - Opacity mask; when missing or empty, the merge treats alpha as fully opaque.
- ⏺ Premul (logical) - When on, uses the premultiplied-alpha merge path; when off, uses straight alpha.
- Output pins:
- ⏺ Out (video) - Merged CMYK plates and alpha in display RGB layout.
CMYK Decomposer
- Category: Video / Color
- Access: All editions.
- Function: Splits video into cyan, magenta, yellow, key, and alpha plates; produces no output when the incoming frame is empty.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Unpremul (logical) - When on, treats the input as premultiplied when decomposing; when off, treats it as straight alpha.
- ⏺ Mono Out (logical) - When on, forces all channel outputs into monochrome format.
- Output pins:
- ⏺ Cyan (video) - Cyan channel extracted as its own video stream.
- ⏺ Magenta (video) - Magenta channel extracted as its own video stream.
- ⏺ Yellow (video) - Yellow channel extracted as its own video stream.
- ⏺ Key (video) - Key (black) channel extracted as its own video stream.
- ⏺ Alpha (video) - Alpha channel extracted as its own video stream.
Color Composer
- Category: Video / Color
- Access: All editions.
- Function: Builds video from three component planes and alpha using the selected color-space interpretation.
- Input pins:
- ⏺ C 1 (video) - Video for the first axis of the active Space (meaning follows the Space selection).
- ⏺ C 2 (video) - Video for the second axis of the active Space (meaning follows the Space selection).
- ⏺ C 3 (video) - Video for the third axis of the active Space (meaning follows the Space selection).
- ⏺ Alpha (video) - Opacity mask; when missing or empty, the merge treats alpha as fully opaque.
- ⏺ Space (integer, Color Space HSX) - Chooses among RGB, CMY, HSB, HSL, Lab, Luv, LCH, YCbCr, and XYZ interpretations of the three inputs.
- ⏺ Premul (logical) - When on, uses the premultiplied-alpha merge path; when off, uses straight alpha.
- Output pins:
- ⏺ Out (video) - Merged output from the three components and alpha for the chosen Space.
Color Decomposer
- Category: Video / Color
- Access: All editions.
- Function: Splits video into three component planes and alpha using the selected color-space interpretation.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Space (integer, Color Space HSX) - Chooses among RGB, CMY, HSB, HSL, Lab, Luv, LCH, YCbCr, and XYZ interpretations of the outputs.
- ⏺ Unpremul (logical) - When on, treats the input as premultiplied when decomposing; when off, treats it as straight alpha.
- ⏺ Mono Out (logical) - When on, forces all component and alpha outputs into monochrome format.
- Output pins:
- ⏺ C 1 (video) - First of three component planes; channel role depends on the selected Space.
- ⏺ C 2 (video) - Second of three component planes; channel role depends on the selected Space.
- ⏺ C 3 (video) - Third of three component planes; channel role depends on the selected Space.
- ⏺ Alpha (video) - Alpha plane as a separate stream with color-space tagging cleared.
Color Merger
- Category: Video / Color
- Access: All editions.
- Function: Merges separate red, green, blue, and alpha channels into one output stream.
- Input pins:
- ⏺ Red (video) - Red channel merged with green, blue, and alpha.
- ⏺ Green (video) - Green channel merged with red, blue, and alpha.
- ⏺ Blue (video) - Blue channel merged with red, green, and alpha.
- ⏺ Alpha (video) - Opacity mask; when missing or empty, the merge treats alpha as fully opaque.
- ⏺ Premul (logical) - When on, uses the premultiplied-alpha merge path; when off, uses straight alpha.
- Output pins:
- ⏺ Out (video) - Combined red, green, blue, and alpha from the four inputs.
Color Splitter
- Category: Video / Color
- Access: All editions.
- Function: Splits video into separate red, green, blue, and alpha channels.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Unpremul (logical) - When on, treats the input as premultiplied when splitting; when off, treats it as straight alpha.
- ⏺ Mono Out (logical) - When on, forces red, green, blue, and alpha outputs into monochrome format.
- Output pins:
- ⏺ Red (video) - Red channel extracted as its own video stream.
- ⏺ Green (video) - Green channel extracted as its own video stream.
- ⏺ Blue (video) - Blue channel extracted as its own video stream.
- ⏺ Alpha (video) - Alpha channel extracted as its own stream with color-space tagging cleared.
Video / Keying
This section describes the built-in Flow Graph modules that extract and refine keys for compositing foreground and background imagery.
Chroma Keyer
- Category: Video / Keying
- Access: All editions.
- Function: Builds a monochrome matte from hue distance to a key swatch for pixels inside adjustable saturation and brightness gates.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Color (color) - Key hue is taken from this color while tolerance and softness shape the matte edge.
- ⏺ Hue Tolerance (scalar) - Hue angular scale used before smoothness divides the fringe (smaller asks for tighter hue agreement).
- ⏺ Hue Smooth (scalar) - Additional softness applied after the hue ratio step to widen or narrow fringe pixels.
- ⏺ Min Saturation (scalar) - Keying engages only where saturation stays at or above this level.
- ⏺ Min Brightness (scalar) - Keying engages only where brightness stays at or above this level.
- ⏺ Max Brightness (scalar) - Keying engages only where brightness stays at or below this level.
- ⏺ Mono Out (logical) - When on, writes the matte output as monochrome (single-channel) video.
- Output pins:
- ⏺ Out (video) - Monochrome matte carried equally in the RGB channels; color-space tagging cleared for downstream masking.
Color Diff Keyer
- Category: Video / Keying
- Access: All editions.
- Function: Builds a monochrome matte by treating strong dominance on one RGB channel over the other two as background.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Channel (integer, Color Diff Channel) - Selects red, green, or blue dominance rule (for example green for greenscreen).
- ⏺ Mono Out (logical) - When on, writes the matte output as monochrome (single-channel) video.
- Output pins:
- ⏺ Out (video) - Monochrome matte carried equally in the RGB channels; color-space tagging cleared for downstream masking.
Despiller
- Category: Video / Keying
- Access: All editions.
- Function: Suppresses spill on one RGB axis by capping that channel against the others, without rebuilding the matte.
- Input pins:
- ⏺ Active (logical) - When off, passes the video input through to the output unchanged and skips processing; when on, runs the module effect.
- ⏺ Video (video) - The source image
- ⏺ Channel (integer, Color Diff Channel) - Spill axis to tame: red, green, or blue (for example green after a greenscreen key).
- ⏺ Threshold (scalar) - How strongly the spill channel is limited relative to the other two (range 0.5–1.5).
- Output pins:
- ⏺ Out (video) - Output with spill pulled down on the chosen channel; matches the input size and layout.
Luma Keyer
- Category: Video / Keying
- Access: All editions.
- Function: Builds a monochrome matte from luminance distance to a chosen level with tolerance and edge softness.
- Input pins:
- ⏺ Video (video) - The source image
- ⏺ Level (scalar) - Center luminance around which pixels are keyed.
- ⏺ Tolerance (scalar) - Width of the ramp before smoothness rescales it (distance is divided by tolerance).
- ⏺ Smooth (scalar) - Softens the matte fringe after the distance ratio step.
- ⏺ Mono Out (logical) - When on, writes the matte output as monochrome (single-channel) video.
- Output pins:
- ⏺ Out (video) - Monochrome matte carried equally in the RGB channels; color-space tagging cleared for downstream masking.