|On this page|
For information about the opposite operation of compiling frame images into a video, see the FFmpeg Encode Video node documentation.
You can use this node in two ways:
If the node has no inputs, you can specify a video file from which to extract images.
If the node has incoming work items with a video file
output, you can extract frames for each incoming work item.
This node generates one work item to extract all images from the input video. It does not generate separate work items for each frame.
outputof the work item is an array of output file names. If you want to wire the output to nodes that expect separate work items per file, use the Work Item Expand node to split out the output files in the work item(s).
This node is a wrapper around the
ffmpeg command line tool. For this node to work, you must have FFmpeg installed on each of your machines.
For the node to find the FFmpeg command line tool, the path to the tool’s executable binary must be available via one of the following methods:
The system path.
Specified in an environment variable
Specified directly in the node by the FFmpeg Binary Path parameter.
$HH/help/files/pdg_examples/top_rop examples show how you can use this node to create a movie from rendered images.
The height of the outputted images.
The width of the outputted images.
The frames per second.
Work Item Generation
Determines when this node will generate work items. You should generally leave this set to “Automatic” unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.
All Upstream Items are Generated
This node will generate work items once all of the input nodes have generated their work items.
All Upstream Items are Cooked
This node will generate work items once all of the input nodes have cooked their work items.
Each Upstream Item is Cooked
This node will generate work items each time a work item in an input node is cooked.
The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.
Specifies the input source.
Upstream Output File
Sets the input as the first output file from the upstream work item with the tag specified by the File Tag parameter.
Custom File Path
Sets the input as the video specified by the File Path parameter.
Specifies the file tag of the input source.
Specifies the file path of the input source.
Frames Per Second
Sets the number of images to extract per second.
Output File Pattern
Specifies the output pattern of the extracted images.
Specifies the file tag of the outputted images.
When on, specifies the width of the output images.
When on, specifies the height of the output images.
Specifies how FFmpeg is called.
Calls FFmpeg from the system path (if available).
Calls FFmpeg using the path stored in the
PDG_FFMPEG environment variable. This environment variable must be user-created.
Calls the FFmpeg binary using the path specified by the FFmpeg Binary Path parameter.
FFmpeg Binary Path
Specifies the path to the FFmpeg binary.
This parameter is only available when FFmpeg Binary is set to Custom Path.
When on, specifies the FFmpeg command that is called when the work item cooks. You can modify this command, but it will not automatically update if the other parameters change.
TOP Scheduler Override
This parameter overrides the TOP scheduler for this node.
Add Job Parms
Opens the Edit Parameter Interface window for the purpose of adding scheduler parameters to the node’s interface.
The Edit Parameter Interface window opens with the In-Process Scheduler’s parameter folder selected in the Create Parameters column.
The Edit Parameter Interface window opens with the Local Scheduler’s parameter folder selected in the Create Parameters column.
The Edit Parameter Interface window opens with the HQueue Scheduler’s parameter folder selected in the Create Parameters column.
Work Item Label
Determines how the node should label its work items. This parameter allows you to assign non-unique label strings to your work items which are then used to identify the work items in the attribute panel, task bar, and scheduler job names.
The work items on this node do not have a label.
Inherit From Upstream Item
The work items inherit their labels from their parent work items.
The work item label is set to the Label Expression custom expression which is evaluated for each item.
Node Defines Label
The work item label is defined in the node’s internal logic.
When on, this parameter specifies a custom label for work items created by this node. The parameter can be an expression that includes references to work item attributes or built-in properties. For example,
$OS: @pdg_frame will set the label of each work item based on its frame value.
Work Item Priority
This parameter determines how the current scheduler prioritizes the work items in this node.
Inherit From Upstream Item
The work items inherit their priority from their parent items. If a work item has no parent, its priority is set to 0.
The work item priority is set to the value of Priority Expression.
Node Defines Priority
This parameter specifies an expression for work item priority. The expression is evaluated for each work item in the node.
This parameter is only available when Work Item Priority is set to Custom Expression.