SDI Out TOP

From TouchDesigner 088 Wiki

Summary

The SDI Out TOP is a TouchDesigner Pro only operator.

The SDI Out TOP uses Nvidia's SDI Output card to output video frames directly to the output card, avoid any issues involved with Windows such as vsync, desktop tearing etc. The SDI Output Card is only compatible with certain models of NVIDIA Quadro video cards. More information can be found here.

By default this node will output the RGB channels of the TOP to the Fill output connector and the Alpha channel of the TOP to the Key output connector. If you are using "Dual YCrCb (4:2:2 + 4:2:2)" data format, then it only outputs the RGB from the two connected TOPs and doesn't output the Alpha anywhere.

The SDI Out TOP accepts a CHOP that contains the audio to output with the SDI signal. The audio CHOP needs to have a sample rate that is compatible with the SDI standard.

See also SDI In TOP.

PythonIcon.png sdioutTOP_Class

Parameters

On /on - Enabled or disabled the output card.

Pause /pause - Keeps the output card active, but stops sending data to it.

Sync /sync - If you need an external sync source to control the output sync, you can select the type here.

  • Internal - No external sync type.
  • SDI Sync - An SDI formatted sync signal.
  • Composite Sync - A composite formatted sync signal.

Sync Type /synctype - There are two types of sync signals to listen for, selectable here.

  • Frame Lock
  • Pixel Lock

Force Signal Format /forcesignalformat - If you are using a sync signal, it usually also contains the signal format to output at. In case this format is not what you want to output at, you can force the signal format to one specified in the Signal Format parameters by turning on this parameter.

Signal Format /signalformat - The signal format to output at. If you are using a Sync Source other than Internal, then this will be selected by the sync signal, unless you turn on Force Signal Format.

Date Format /dateformat - The format of the color data to output. You can output two different RGB images to the two SDI outputs (Key and Fill) by using "Dual YCrCb (4:2:2 + 4:2:2)"

Queue Size /queuesize - The number of video frames to hold in the queue for output.

V-Sync Delay /vsyncdelay - Tell the SDI Output card to apply this delay to the v-sync. I haven't actually seen this do anything yet.

H-Sync Delay /hsyncdelay - Tell the SDI Output card to apply this delay to the h-sync. I haven't actually seen this do anything yet.

Audio CHOP /audiochop - If you want to embed audio data into the SDI output stream, put the path to a Time Sliced CHOP here.

Buffer Length /bufferlength - The length in seconds to delay the audio data, to avoid crackles.

Manual Field Control /manualfield - When outputting interlaced video if you are using a source video that is also interlaced, it's likely you'll want to make sure you are keeping the odd/even fields in sync, otherwise the video will look stuttery. You can use the 'odd_frame' value in the Info CHOP on the Movie File In TOP or SDI In TOP to know if the current frame is the odd field or the even field. In general the odd field is the first frame, so you use this value in the First Field parameter to tell the SDI Out TOP that the current frame is the first field. On the next frame you would put this value to 0 (which is also what the 'odd_frame' will go to) to tell the SDI Out TOP that the current frame is the 2nd frame, and you now have a complete frame to output.

First Field /firstfield - Tells the SDI Out TOP if the current frame being given as it's input is the First or Second field in the final output image, when outputting an interlaced video. Look at the description for Manual Field Control for more information.

Parameters - Common Page

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

  • Input - uses the input's resolution.
  • Eighth, Quarter, Half, 2X, 4X, 8X - multiply the input's resolution by that amount.
  • Fit Resolution - Resizes the input to the size specified in Resolution using the best possible match that does not crop any of the input. It will resize the image to be larger than the input resolution if a larger resolution is specified. It's a "fit inside", Aspect Ratio is maintained.
  • Limit Resolution - Limits the input to the size specified in Resolution using the best possible match that does not crop any of the input. It's a "fit inside", Aspect Ratio is maintained.
  • Custom Resolution - enables the Resolution parameter below, giving direct control over width and height.

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.

Use Global Resolution Multiplier - 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 - 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.)

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

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

  • Nearest Pixel - uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
  • Interpolate Pixels - 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 - 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 - determine how the TOP image is displayed in the viewer.

  • Input - uses the same Fill Viewer settings as it's input.
  • Fill - stretches the image to fit the edges of the viewer.
  • Fit Horizontal - stretches image to fit viewer horizontally.
  • Fit Vertical - stretches image to fit viewer vertically.
  • Fit Best - stretches or squashes image so no part of image is cropped.
  • Fit 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 - displays the native resolution of the image in the viewer.

NOTE: To get an understanding of how TOPs works 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.

Viewer Smoothness - This controls pixel filtering in the viewers.

  • Nearest Pixel - uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
  • Interpolate Pixels - 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 - uses mipmap filtering when scaling images. This can be used to reduce artifacts and sparkling in moving/scaling images that have lots of detail. When the input is 32-bit float format, only nearest filtering will be used (regardless of what is selected).

Passes - duplicates the operation of the TOP the specified number of times.

Channel Mask - 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 used to store data for each channel in the image (ie. R, G, B, and A). Fixed format values are limited to the range [0-1]. Refer to Pixel Formats for more information.

  • Input - uses the input's pixel format.
  • 8-bit fixed (RGBA) - uses 8-bit integer values for each channel.
  • 16-bit float (RGBA) - uses 16-bits per color channel, 64-bits per pixel.
  • 32-bit float (RGBA) - uses 32-bits per color channel, 128-bits per pixels.


  • 10-bit RGB, 2-bit Alpha, fixed (RGBA) - uses 10-bits per color channel and 2-bits for alpha, 32-bits total per pixel.
  • 16-bit fixed (RGBA) - uses 16-bits per color channel, 64-bits total per pixel.
  • 11-bit float (RGB), Positive Values Only - 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).
  • 8-bit fixed (R) - has 8-bits for the red channel, 8-bits total per pixel.
  • 16-bit fixed (R) - has 16-bits for the red channel, 16-bits total per pixel.
  • 16-bit float (R) - has 16-bits for the red channel, 16-bits per pixel.
  • 32-bit float (R) - has 32-bits for the red channel, 32-bits per pixel.
  • 8-bit fixed (RG) - has 8-bits for the red and green channels, 16-bits total per pixel.
  • 16-bit fixed (RG) - has 16-bits for the red and green channels, 32-bits total per pixel.
  • 16-bit float (RG) - has 16-bits for the red and green channels, 32-bits per pixel.
  • 32-bit float (RG) - has 32-bits for the red and green channels, 64-bits per pixel.
  • 8-bit fixed (A) - An Alpha only format that has 8-bits per channel, 8-bits per pixel.
  • 16-bit float (A) - An Alpha only format that has 16-bits per channel, 16-bits per pixel.
  • 32-bit float (A) - An Alpha only format that has 32-bits per channel, 32-bits per pixel.