Experimental:Palette:recorder

Summary

The recorder component is a wrapper for the moviefileout TOP. Its purpose is to simplify the video recording process as a single component. It is recommended to be used as the recording system in larger video applications.

To use the recorder:
# Connect your video source TOP to the input
# Set the output folder and filename parts (supports up to 7 filename segments separated by underscores)
# Configure video settings: resolution (custom or from input), frame rate, and frame range
# For audio recording, connect an audio CHOP to the Audio CHOP parameter
# Click Record Start to begin recording, Record Stop to end (or let it auto-stop if using frame range)

Key features:
* Automatic filename generation with configurable segments and auto-incrementing index (N parameter)
* Support for timeline synchronization and frame-accurate recording
* Cook Every Frame option for offline vs real-time recording modes
* Custom resolution override capability
* Header metadata support via DAT input
* Timeline matching utilities for synchronizing recorder settings with project timeline

Palette:recorder

Parameters - Output Settings Page

Configure file output, recording controls, resolution, frame range, and timeline settings

Folder Folder - The directory where the recorded video files are saved.

View Folder Viewfolder - Opens a file browser to where the recorded video files will be saved.

Filename 1 Filename1 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

Filename 2 Filename2 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

Filename 3 Filename3 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

Filename 4 Filename4 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

Filename 5 Filename5 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

Filename 6 Filename6 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

Filename 7 Filename7 - Allows the user to set multiple filename strings. Each string is separated by an underscore.

N N - This parameter increases by 1 each time a recording is generated. The N index is postfixed to the file name and thus filename collisions can be avoided.

File Path Filepath - Shows the complete path (Folder + Filename) where the video will be saved.

Record Start Recordstart - Triggers the start of the recording.

Record Stop Recordstop - Stops the recording.

Record Active Recordactive - Indicates if recording is currently active or not.

Audio CHOP Audiochop - Provide a chop with an audiostream for recording audio into the file.

Header Source DAT Headerdat - Specify a DAT that holds desired meta information for encoding data into the header of the file.

Custom Resolution Customresolution - When active a custom resolution is used instead of the incoming resolution.

Resolution Resolution - ⊞ - A custom resolution to override that which is coming in via the TOP connector.

• Resolution Resolutionw -

• Resolution Resolutionh -

Record Range Recordrange - When active, the specfied frame range is used and once the range has been recorded, the encoder stops automatically. This range corresponds to the timeline range.

Frame Range Framerange - ⊞ - The frame range to record when Record Range paramater is active.

• Frame Range Framerange1 -

• Frame Range Framerange2 -

Rate (FPS) Rate - The frame rate to record at.

Use Timeline Locktotimeline - Ensures the recording is synchronized with a specified timeline or timecode.

Cook Every Frame Cookeveryframe - You want this on if you are doing a high quality offline render. You want this off if you are recording in real-time.

Reload Movie Meta Data Reload - Forces a reload of movie file information from the first moviefileinTOP that is found connected upstream of the input TOP connection.

Match Timeline To Media Matchmedia - Ensures the recorder's settings match the settings of another media file or source.

Match Record Settings to Timeline Matchrecordtotimeline - Sets the recorder comp settings to match the timeline

Match Timeline to Record Settings Matchtimelinetorecord - Matches the timeline to the recorder comp settings

Parameters - Codec Page

Configure video and audio codec settings for encoding

Codec Videocodec - ⊞ - Select the video compression codec used to encode the movie.

Video Codec Type Videocodectype - Some video codecs such as Apple ProRes, Hap and Hap Q have a various different types such as ProRes 442 HQ, ProRe 4444 HQ etc.

Movie Pixel Format Moviepixelformat - Options for the pixel format based on the Video Codec selected. Use this parameter to change the color quality of the output (how many bits are used, YUV sampling etc.), as well as selecting formats that include alpha for codecs that support alpha.

Audio Codec Audiocodec - Select the audio compression codec used to encode the audio.

Quality Quality - Select the quality of the movie compression. NOTE: Some codecs can not output lossless compression.

Stall for File Open Stallforopen - When this is on playback will stall until the file is opened and ready to receive frames, to make sure the frame that was inputted when Record was turned on gets recorded. When this is off recording may start on a later frame, after the file has been opened. Turning this off can avoid a stall in playback, if missing recording some frames at the start is acceptable.

Profile Profile - Select the H.264 profile to use.

Preset Preset - The H264 preset to use.

Bit Rate Mode Bitratemode - Select between Constant or Variable bit rate, and regular or high quality bit rate modes.

Average Bit Rate Avgbitrate - Set the average bitrate target for the encoding.

Peak Bit Rate Peakbitrate - Set the peak bitrate allowed for the encoding.

Keyframe Interval Keyframeinterval - Set the number of frames between key-frames (I-frames) while encoding.

Max B-Frames Maxbframes - Controls the maximum number of B-frames (bi-directional frames) that will be created between pairs of key-frames.

Motion Prediction Motionpredict - Controls the quality of the Motion Prediction used when encoding H264/H265.

Frame Slicing Frameslicing - Controls if H264/H265 frames are sliced into multiple pieces, allowing them to be decoded using multiple CPUs more easily.

Num Slices Numslices - The number of slices each frame is split into.

Secondary Compression Secondarycompression - Hap uses a secondary CPU compression stage usually. Encoding video without this compression will result in faster playback, but potentially larger file sizes (which would require faster drives to play back).

Operator Inputs

• Input 0: in1 - Video input to be recorded

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.

An Operator Family which operate on Channels (a sequence of numbers (Samples)) which are used for animation, audio, mathematics, simulation, logic, UI construction, and data streamed from/to devices and protocols.

To re-compute the output data of the Operators. An operator cooks when (1) its inputs change, (2) its Parameters change, (3) when the timeline moves forward in some cases, or (4) Scripting commands are run on the node. When the operator is a Panel Component, it also cooks when a user interacts with it. When an operator cooks, it usually causes operators connected to its output to re-cook. When TouchDesigner draws the screen, it re-cooks all the Dependencies - the necessary operators in all Networks, contributing to a frame's total "cook time".

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a python Script or GLSL Shader, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

The panel at the bottom of TouchDesigner, it controls the current global looping Time your TouchDesigner project, or of just one component.

A Folder in TouchDesigner always refers to a Windows or macOS operating system directory/folder system that contain files and other folders. It does not refer to operators within TouchDesigner. See Network Path.

The location of an operator within the TouchDesigner environment, for example, /geo1/circle1, a node called circle1 in a component called geo1. The path / is called Root. This path is displayed at the top of every Pane, showing which Component's network you are currently in. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

The width and height of an image in pixels. Most TOPs, like the Movie File In TOP can set the image resolution. See Aspect Ratio for the width/height ratio of an image, taking into account non-square pixels.

The Frames-per-Second that TouchDesigner's Timeline runs at. Set with project.cookRate.

The term "Frame" is a measurement of time used (1) in the Timeline, (2) as a time-unit in CHOPs, and (3) as a time unit in movie files that are read into TOPs and written out from TOPs. The frame rate is the frames per second (FPS).

In the Animation component each keyframe specifies a channel's value at a specific time (or frame). A keyframe holds a value, slopes and accelerations, and an interpolation type. A channel's keyframes are used to interpolate and determine the values of all the samples of the channel.

A built-in panel in TouchDesigner that contains a library of components and media that can be dragged-dropped into a TouchDesigner network.