Close

Experimental:Movie File Out TOP

Summary

The Movie File Out TOP saves a TOP stream out to a movie file (.mov/.mp4) using a variety of codecs, including the Animation, H.264/H.265, Hap Q, and NotchLC video codecs. It can also save single frame images, image sequences, or stop-frame movies.

The Export Movie Dialog is a user interface built around the Movie File Out TOP.

To record movies with audio using the Movie File Out TOP, a time-sliced CHOP with mono or stereo channels of audio is required. If TouchDesigner is running at a lower frame rate than the target video frame rate and a CHOP is specified for audio, the Movie File Out TOP will automatically repeat video frames to ensure the video and audio stay in sync.

Recording a movie without frame drops can be done in non-realtime by turning off the Realtime flag at the top of the user interface. The length of the video is not predetermined and depends on the amount of time the Record parameter is on.

You can record a sequence of .tif or .exr files by setting the Type parameter to Image Sequence. When Image File Type is set to OpenEXR, the EXR page has options to record any number of color channels from multiple TOPs into an EXR image file, and can create it with metadata that would get read by a Point File In TOP.

H264 NOTE: Encoding movies in H.264 codec is only available with a Commercial or Pro license. Nvidia graphic hardware is also required.

*** WARNING - GPU Driver Timeout on long GPU activities *** Encoding some formats at high-resolution may be a slow, GPU-intensive operation. Generally only the RGBA BC7 mode for HapQ can suffer from this though. Consequently it will usually take longer than the default 2 seconds per frame that Windows gives the GPU driver to complete an operation. If you see a message saying that Windows has reset the GPU driver, this is the issue you are running into. To fix the issue, create this registry value: HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\GraphicsDrivers\TdrDelay
The value should be of type REG_DWORD. The value is the number of seconds an operation can take before the OS resets the GPU driver. Set it to something larger, like 20-40 (seconds), depending on the resolution you intend to encode. You must reboot your machine for this setting to take effect. If you still get driver resets, make it even larger.

Recording still images and stop-frame animation can be done by changing the 'Type' parameter. Then the 'Add Frame' pulse button can be pulsed manually or via a script to cause the frames to be written.

See also Movie File In TOP, Recording Movies with Audio.

PythonIcon.pngmoviefileoutTOP_Class


Parameters - Movie Out Page

Type type - - Output either a movie, image, image sequence, or stop-frame movie.

  • Movie movie - Records a movie file.
  • Image image - Records a single image.
  • Image Sequence imagesequence - Records a sequence of images. Available in the 2018.20000 series of builds or later.
  • Stop-Frame Movie stopframemovie -

Video Codec videocodec - - Select the video compression codec used to encode the movie.

  • Animation rle - Run-length encoded video, lossless codec and low decode times, but very large file size. Alpha channel can be included when Pixel Format is RGBA.
  • Photo/Motion JPEG mjpa - JPEG encoded video, lossy codec and low decode times with medium file sizes. Good for playback both forwards and backwards or for random access.
  • MPEG 4 (Part 2) mpeg4 - High quality but can produce large files size and/or have high decode times.
  • H.264 (NVIDIA GPU) h264nvgpu - H.264 GPU encoding, only available when using Nvidia graphics cards. Great compression and quality and small file sizes. However can suffer from high decode times and not the best for random access, scrubbing, or reverse playback. See the H264 parameter page for additional H264 encoding options.
  • GoPro-Cineform cineform - A lossy compression similar to Apple ProRes. Alpha channel can be included.
  • Hap hap - See Hap, a fast codec that uses the GPU. Lower quality than Hap Q.
  • Hap Q hapq - See Hap, a fast codec that uses the GPU. Higher quality than regular Hap.
  • H.265/HEVC (NVIDIA GPU) h265nvgpu - H.265 GPU encoding, only available when using Nvidia graphics cards. Better compression (and sometimes quality) than H.264 but more resource intensive to encode/decode.
  • GIF gif -
  • NotchLC notchlc - NotchLC is a high quality, GPU accelerated video format. It offers higher quality results than HapQ, at the cost of higher GPU usage as well as larger file sizes.

Image File Type imagefiletype - - Choose what file type to use when Type is set to Image.

  • TIFF tiff - A lossless, compressed, image format that includes alpha.
  • JPEG jpeg - A lossy image format, very well compressed. No support for alpha.
  • BMP bmp - A lossless, uncompressed, image format that includes alpha.
  • OpenEXR exr - A lossless, compressed, image format that can save files in 16-bit float and 32-bit float formats. Can also include alpha. More information here.
  • PNG png - A lossless, compressed, image format that can include alpha. Supports bit 8-bit and 16-bit fixed data.
  • DDS dds - A lossless, uncompressed, image format that can include alpha. Can include mipmap information. Natively support most pixel formats supported by TOPs.

Unique Suffix uniquesuff - When enabled, me.fileSuffix will be a unique suffix when used in the file parameter.  

N n - Using me.par.n as part of the expression in the filename (in the File parameter) in conjuction with the N parameter here gives a method of incrementing file names. The N parameter must manually be incremented each time. Exporting a Count CHOP which increments each time you want to save out a new file is an easy way to do this.  

File file - Sets the path and filename of the movie file that is saved out. QuickTime movies should be saved with the .mov file extension.  

Movie Pixel Format moviepixelformat - - Options for the pixel format based on the Video Codec selected.

  • YUV 4:2:0 yuv420 - (Photo/Motion JPEG, MPEG 4 (Part 2), )
  • YUV 4:2:0 (8-Bit) yuv420 - (H.264 (NVIDIA GPU), H.265/HEVC (NVIDIA GPU))
  • YUV 4:2:0 (10-Bit) yuv420p10bit - (H.265/HEVC (NVIDIA GPU))
  • YUV 4:2:2 yuv422 - (Photo/Motion JPEG, )
  • YUV 4:4:4 (8-Bit) yuv444 - (H.264 (NVIDIA GPU), H.265/HEVC (NVIDIA GPU))
  • YUV 4:4:4 (10-Bit) yuv444p10bit - (H.265/HEVC (NVIDIA GPU))
  • RGB rgb - (Animation, Hap, Hap Q)
  • RGBA rgba - (Animation, GoPro-Cineform, Hap, Hap Q)
  • RGBA BC7 rgba - (Hap Q) - Slow, Read Help Before Using!
  • RGB Palette 3 - (GIF)

Audio CHOP audiochop - Specify a CHOP to use as the audio track for the movie. Drag & Drop a CHOP here or manually enter the CHOP's path. The CHOP needs to be time-sliced.  

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

  • ALAC (Apple Lossless) alac - A lossless audio codec that still offers some compression for the data.
  • MP3 mp3 - Highly compressed lossy codec. Can only do 2 channels of audio. MP3 compression will not have gapless playback.
  • Uncompressed 16-bit (PCM) pcm16 - Uncompressed audio (Pulse Code Modulation)
  • Uncompressed 24-bit (PCM) pcm24 - Uncompressed audio (Pulse Code Modulation)
  • Uncompressed 32-bit (PCM) pcm32 - Uncompressed audio (Pulse Code Modulation)
  • Vorbis vorbis - Vorbis is a lossy audio compression codec. Vorbis compression will have gapless playback.

Audio Bit Rate audiobitrate - - The bitrate to write the audio out at.

  • 96 kb/s b96 -
  • 128 kb/s b128 -
  • 192 kb/s b192 -
  • 256 kb/s b256 -
  • 320 kb/s b320 -

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

Movie FPS fps - The frame rate of the movie file created.  

Record record - When this parameter is set to 1, the movie will be recording.  

Pause pause - Pauses the recording.  

Add Frame addframe - Adds a single frame to the output for each click of the button. Pause must be On to enable the Add Frame parameter.  

Max Threads maxthread -  

Header Source DAT headerdat - The path to a Table DAT that stores header metadata that should be written to the output image or movie file. Header data is written as key-value pairs with the first column storing the keys and the second column storing the associated values. Note: Currently only supported for EXR files. Warning: Files may fail to save if the header data conflicts with system headers.  


Parameters - EXR Page

The Inputs page can be used to add extra channels of image data to the output file and to change the names of the base 4 channels.

Each 'Additional Input TOP' is a path to a TOP containing the image data to add to the file. The associated Red, Green, Blue and Alpha parameters are the names assigned to that input's channels in the new file. If the channel parameter is left blank, that channel will not be added to the output file. Channels with duplicate names will be overwritten.

Note: Additional inputs are currently only supported in EXR images and sequences. In EXR files, channels are stored in alphabetical order.

Save as Point Cloud pointcloud - When enabled, an additional header will be added to the file that indicates the contents are point data rather than images. This header is used to automatically load the file into a Point File In TOP rather than a Movie File In TOP when dragging and dropping.  

Additional Input TOP 0 inputtop0 - The path to the TOP used to specify addition channels to the EXR file. The first 4 channels specified above come from the input connected to the Movie File Out TOP, this TOPs RGBA data can be assigned unique names in the EXR file using the Red, Green, Blue, Alpha parameters below.  

Red inputr0 - Name assigned to the specified TOP's Red channel.  

Green inputg0 - Name assigned to the specified TOP's Green channel.  

Blue inputb0 - Name assigned to the specified TOP's Blue channel.  

Alpha inputa0 - Name assigned to the specified TOP's Alpha channel.  


Parameters - Advanced Page

For use when Video Codec is set to H264.

Stall For 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.  

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.

  • Baseline baseline -
  • Main main -
  • High high -

Preset preset - - Select from the available presets.

  • None none -
  • Lossless lossless -

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

  • Constant (CBR) constant -
  • Variable (VBR) variable -
  • Constant HQ (CBR) constanthq -
  • Variable HQ (VBR) variablehq -

Average Bitrate (Kb/s) avgbitrate - Set the average bitrate target for the encoding.  

Peak Bitrate (Kb/s) peakbitrate - Set the peak bitrate allowed for the encoding.  

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

Motion Prediction motionpredict - - This setting can effect the final size of the compressed video but depends greatly on the complexity of the scene being encoded. The menu entries refers to the distance between pixels (quarter distance, half distance, or full distance which is a full pixel) as the motion vector precision for motion estimation during video compression. Quarter pixel precision can increase the quality of the motion prediction signal over half pixel precision, and this can sometimes result in better overall size compression if the improved prediction signal can offset the additional bits it takes to encode the higher precision motion vectors.

  • Default default -
  • Quarter quarter -
  • Half half -
  • Full full -

Frame Slicing frameslicing - Enables frame slicing in the encoding which can control error resiliance of the video. See Flexible Macroblock Ordering for additional information.  

Num Slices numslices - The number of slices to use when Frame Slicing is On.  

Entropy Mode entropymode - - Select the EntropyMode to use for H.264.

  • Auto-Select autoselect - Select the Entropy Mode automatically.
  • CABAC cabac -
  • CAVLC cavlc -
  • Auto-Select autoselect -
  • CABAC cabac -
  • CAVLC cavlc -

Hap Secondary Compression hapsecondarycompression - 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).  

Encode Test Mode encodetestmode - When this mode is enabled no file will be written out. This allows testing the performance of all the encoding operations, except for writting the file out to disk. This can be used to remove the disk write speed as a variable when testing encoding performance.  

Include Mip Maps mipmaps - When saving out .dds file, mipmaps can be included if this is enabled. This is primarily used for the PreFilter Map TOP, which will encode special information into the mipmap levels of the texture which needs to be maintained.  


Parameters - Common Page

Output Resolution outputresolution - - quickly change the resolution of the TOP's data.

  • Use Input useinput - Uses the input's resolution.
  • Eighth eighth - Multiply the input's resolution by that amount.
  • Quarter quarter - Multiply the input's resolution by that amount.
  • Half half - Multiply the input's resolution by that amount.
  • 2X 2x - Multiply the input's resolution by that amount.
  • 4X 4x - Multiply the input's resolution by that amount.
  • 8X 8x - Multiply the input's resolution by that amount.
  • Fit Resolution fit - Fits the width and height to the resolution given below, while maintaining the aspect ratio.
  • Limit Resolution limit - The width and height are limited to the resolution given below. If one of the dimensions exceeds the given resolution, the width and height will be reduced to fit inside the given limits while maintaining the aspect ratio.
  • Custom Resolution custom - Enables the Resolution parameter below, giving direct control over width and height.

Resolution resolution - - Enabled only when the Resolution parameter is set to Custom Resolution. Some Generators like Constant and Ramp do not use inputs and only use this field to determine their size. The drop down menu on the right provides some commonly used resolutions.

  • W resolutionw -
  • H resolutionh -

Resolution Menu resmenu - A drop-down menu with some commonly used resolutions.  

Use Global Res Multiplier resmult - Uses the Global Resolution Multiplier found in Edit>Preferences>TOPs. This multiplies all the TOPs resolutions by the set amount. This is handy when working on computers with different hardware specifications. If a project is designed on a desktop workstation with lots of graphics memory, a user on a laptop with only 64MB VRAM can set the Global Resolution Multiplier to a value of half or quarter so it runs at an acceptable speed. By checking this checkbox on, this TOP is affected by the global multiplier.  

Output Aspect outputaspect - - Sets the image aspect ratio allowing any textures to be viewed in any size. Watch for unexpected results when compositing TOPs with different aspect ratios. (You can define images with non-square pixels using xres, yres, aspectx, aspecty where xres/yres != aspectx/aspecty.)

  • Use Input useinput - Uses the input's aspect ratio.
  • Resolution resolution - Uses the aspect of the image's defined resolution (ie 512x256 would be 2:1), whereby each pixel is square.
  • Custom Aspect custom - Lets you explicitly define a custom aspect ratio in the Aspect parameter below.

Aspect aspect - - Use when Output Aspect parameter is set to Custom Aspect.

  • Aspect1 aspect1 -
  • Aspect2 aspect2 -

Aspect Menu armenu - A drop-down menu with some commonly used aspect ratios.  

Input Smoothness inputfiltertype - - This controls pixel filtering on the input image of the TOP.

  • Nearest Pixel nearest - Uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
  • Interpolate Pixels linear - Uses linear filtering between pixels. This is how you get TOP images in viewers to look good at various zoom levels, especially useful when using any Fill Viewer setting other than Native Resolution.
  • Mipmap Pixels mipmap - Uses mipmap filtering when scaling images. This can be used to reduce artifacts and sparkling in moving/scaling images that have lots of detail.

Fill Viewer fillmode - - Determine how the TOP image is displayed in the viewer. NOTE:To get an understanding of how TOPs work with images, you will want to set this to Native Resolution as you lay down TOPs when starting out. This will let you see what is actually happening without any automatic viewer resizing.

  • Use Input useinput - Uses the same Fill Viewer settings as it's input.
  • Fill fill - Stretches the image to fit the edges of the viewer.
  • Fit Horizontal width - Stretches image to fit viewer horizontally.
  • Fit Vertical height - Stretches image to fit viewer vertically.
  • Fit Best best - Stretches or squashes image so no part of image is cropped.
  • Fit Outside outside - Stretches or squashes image so image fills viewer while constraining it's proportions. This often leads to part of image getting cropped by viewer.
  • Native Resolution nativeres - Displays the native resolution of the image in the viewer.

Viewer Smoothness filtertype - - This controls pixel filtering in the viewers.

  • Nearest Pixel nearest - Uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
  • Interpolate Pixels linear - Uses linear filtering between pixels. Use this to get TOP images in viewers to look good at various zoom levels, especially useful when using any Fill Viewer setting other than Native Resolution.
  • Mipmap Pixels mipmap - Uses mipmap filtering when scaling images. This can be used to reduce artifacts and sparkling in moving/scaling images that have lots of detail.

Passes npasses - Duplicates the operation of the TOP the specified number of times. Making this larger than 1 is essentially the same as taking the output from each pass, and passing it into the first input of the node and repeating the process. Other inputs and parameters remain the same for each pass.  

Channel Mask chanmask - Allows you to choose which channels (R, G, B, or A) the TOP will operate on. All channels are selected by default.  

Pixel Format format - - Format used to store data for each channel in the image (ie. R, G, B, and A). Refer to Pixel Formats for more information.

  • Use Input useinput - Uses the input's pixel format.
  • 8-bit fixed (RGBA) rgba8fixed - Uses 8-bit integer values for each channel.
  • sRGB 8-bit fixed (RGBA) srgba8fixed - Uses 8-bit integer values for each channel and stores color in sRGB colorspace.
  • 16-bit float (RGBA) rgba16float - Uses 16-bits per color channel, 64-bits per pixel.
  • 32-bit float (RGBA) rgba32float - Uses 32-bits per color channel, 128-bits per pixels.
  • 10-bit RGB, 2-bit Alpha, fixed (RGBA) rgb10a2fixed - Uses 10-bits per color channel and 2-bits for alpha, 32-bits total per pixel.
  • 16-bit fixed (RGBA) rgba16fixed - Uses 16-bits per color channel, 64-bits total per pixel.
  • 11-bit float (RGB), Positive Values Only rgba11float - A RGB floating point format that has 11 bits for the Red and Green channels, and 10-bits for the Blue Channel, 32-bits total per pixel (therefore the same memory usage as 8-bit RGBA). The Alpha channel in this format will always be 1. Values can go above one, but can't be negative. ie. the range is [0, infinite).
  • 16-bit float (RGB) rgb16float -
  • 32-bit float (RGB) rgb32float -
  • 8-bit fixed (Mono) mono8fixed - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 8-bits per pixel.
  • 16-bit fixed (Mono) mono16fixed - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 16-bits per pixel.
  • 16-bit float (Mono) mono16float - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 16-bits per pixel.
  • 32-bit float (Mono) mono32float - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 32-bits per pixel.
  • 8-bit fixed (RG) rg8fixed - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 8-bits per channel, 16-bits total per pixel.
  • 16-bit fixed (RG) rg16fixed - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 16-bits per channel, 32-bits total per pixel.
  • 16-bit float (RG) rg16float - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 16-bits per channel, 32-bits total per pixel.
  • 32-bit float (RG) rg32float - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 32-bits per channel, 64-bits total per pixel.
  • 8-bit fixed (A) a8fixed - An Alpha only format that has 8-bits per channel, 8-bits per pixel.
  • 16-bit fixed (A) a16fixed - An Alpha only format that has 16-bits per channel, 16-bits per pixel.
  • 16-bit float (A) a16float - An Alpha only format that has 16-bits per channel, 16-bits per pixel.
  • 32-bit float (A) a32float - An Alpha only format that has 32-bits per channel, 32-bits per pixel.
  • 8-bit fixed (Mono+Alpha) monoalpha8fixed - A 2 channel format, one value for RGB and one value for Alpha. 8-bits per channel, 16-bits per pixel.
  • 16-bit fixed (Mono+Alpha) monoalpha16fixed - A 2 channel format, one value for RGB and one value for Alpha. 16-bits per channel, 32-bits per pixel.
  • 16-bit float (Mono+Alpha) monoalpha16float - A 2 channel format, one value for RGB and one value for Alpha. 16-bits per channel, 32-bits per pixel.
  • 32-bit float (Mono+Alpha) monoalpha32float - A 2 channel format, one value for RGB and one value for Alpha. 32-bits per channel, 64-bits per pixel.


Operator Inputs

  • Input 0 -