Video Resolution

After setting the file types the resolution is next. Get or set the resolution with the following command:

w stands for width and h for height in pixels of the full frame. Width and height can be arbitrary numbers but need to smaller or equal to the resolution of the program output channel.

Frame rate, scan mode and aspect ratio are copied from the program output channel.

Video Container

The next step is to select the container for the video file. If a key file is requested then it applies for the key file, too. The following commands show how to query, get and set the container type:

• VIDEO_ENUMERATE lists the possible containers. The available containers depend on the resolution.

• VIDEO_GET shows the current container.

• VIDEO_SET sets the container to container.

The argument may be given either as string or integral value. Available containers:

Example: Set Container Type To XDCAM_MXF

Video Codec

Once the container is set, the video codec can be selected. The following commands show how to query, get and set the codec type:

• VIDEO_ENUMERATE lists the possible codecs. The available codecs depend on the container type and the resolution.

• VIDEO_GET shows the current codec.

• VIDEO_SET sets the codec to codec. The argument may be given either as string or integral value.

Example: Set Codec Type To Mpeg IFrame 4224 In SD

Audio Container

If a separate audio file should be generated, then the desired audio container must be set.

The following commands show how to query, get and set the container type:

• AUDIO_ENUMERATE lists the possible containers.

• AUDIO_GET shows the current container.

• AUDIO_SET sets the container type to container. The argument may be given either as string or as integral value.

Available containers:

Example: Set Audio Container To wave64

VBI Container

If a separate .vbi file should be generated, then the VBI container must be specified. The following commands show how to query, get and set the container type:

• VBI_ENUMERATE lists the possible containers are being listed.

• VBI_GET shows the current container.

• VBI_SET sets the container type to container. The container argument may be given either as string or as integral value.

Available containers:

Example: Set VBI Container To AVI

VBI Codec

The following commands show how to query, get and set the codec type:

• VBI_ENUMERATE lists the possible codecs.

• VBI_SET sets the codec to codec. The codec argument may be given either as string or integral value.

• VBI_GET shows the current codec.

Example: Set VBI Codec To YUYV422

Options

Some resolution/container/codec combinations permit or require additional configuration. The following commands show how to query for options and how to get the current options:

• VIDEO_ENUMERATE lists all possible and mandatory options for the specified group. A special group ALL lists all option groups with their possible configurations.

• VIDEO_GET shows the current configuration for the specified group.

Example: Enumerate All Available Video Options

Audio Configuration

The following commands query, get, and set the audio configuration:

• VIDEO_ENUMERATE AUDIO lists the available options.

• VIDEO_GET AUDIO shows the current audio configuration

• VIDEO_SET AUDIO specifies the audio options.

The options argument can be:

• Off: Does not capture audio.

• On: Uses the current audio configuration from Viz Engine.

• ch=n: Uses n audio channels.

• ch=n bits=v: Uses n audio channels with v valid and total bits.

• ch=n bits=v/t: Uses n audio channels with v valid bits and t total bits.

Some codecs require a specific set of audio configuration. In this case, the applied audio option must meet the codec requirements (for example, MXF-XDCAM). Otherwise, the clip fails to open.

Example: Set Audio Configuration

Mpeg IFrame Configuration

Mpeg IFrame codecs require the configuration of the IFRAME parameters. The following commands show how to enumerate, get the current configuration and set new values:

• VIDEO_ENUMERATE IFRAME lists the avaiable mpeg iframe options.

• VIDEO_GET IFRAME lists the current configuration and with VIDEO_SET IFRAME new values can be set.

The options argument can have the following values:

• OFF: Does not configure mpeg iframe.

• bitrate=r: Sets the bitrate (r, an integral value) in Mbits per second.

• forceDCTFrame=b: Switches the forced DCTFrame off or on (b is either 0 or 1).

• DCPrecision: Set to a fixed value: DCPrecision8bits.

• zigzag: Set to a fixed value: ZigZagTypeAlternate.

• rounding: Set to a fixed value: RoundingTypeMatroxCustom.

For a detailed list of available values use the VIDEO_ENUMERATE IFRAME command. All arguments must be given in one command. They do not accumulate.

Example: Mpeg IFrame Configuration For SD

VBI Config

Some codecs, like D10, require VBI information to be written. In that case, this options must be set (even if Viz Engine is not configured for VBI). The following commands show how to enumerate, get the current configuration and set new values:

The options argument is the number of VBI lines to write into the file. It must be an even number for interlaced resolutions. A value of ON can be used as shortcut for setting the Viz Engine configured VBI lines. OFF switches VBI configuration off. Some codecs require a specific set of VBI configuration. In this case, the applied VBI option must meet the codec requirements. Otherwise the clip fails to open.

Example: VBI Configuration

Time Code Configuration

If supported by the container then time code can be written.

The options argument can be omitted to switch on the default time code. Other values can be:

• startTC=hh:mm:ss:ff: Sets hh:mm:ss:ff as start time code.

• OFF: Switches off time code option.

Example: Time Code Configuration

High Quality XDCAM HD

For XDCAM HD, this flag specifies to use the high quality settings in the codec with the compromise to use more CPU and time to generate a compressed image.

The arg argument can be ON or OFF.

• ON: Enables high quality writing.

• OFF: Uses fast encoding.

Example: High Quality XDCAMHD Configuration

ASF Audio Configuration

If the container is of type ASF or WMV, ASF audio can be configured. The following commands show how to enumerate, get the current setting and set new values:

The options argument in VIDEO_SET ASFAUDIO can have the following values:

• codec_type=t: Sets the ASF codec type to t.

• codec_format=f: Sets the ASF codec format to f.

For a detailed list of the available options use the VIDEO_ENUMERATE ASFAUDIO command. All arguments must be given in one command. They do not accumulate.

Example: ASF Audio Configuration

ASF Video Configuration

If the container is of type ASF or WMV, ASF video can be configured. The following commands show how to enumerate, get the current setting and set new values:

The options argument in VIDEO_SET ASFVIDEO can have the following values:

• codec_type=t: Sets the ASF codec type to t.

• codec_mode=m: Sets the ASF codec mode to m.

• bitrate=r: Sets the bitrate to r.

• maxbitrate=r: Sets the maximum bitrate to r.

• bufferwindow=w: Sets the bufferwindow to w.

• maxbufferwindow=w: Sets the maximum buffer window to w.

• secondsperkeyframe=s: Sets the seconds between keyframes to s.

• quality=q: Sets the quality to q.

• vbrquality=q: Sets the variable bitrate quality to q.

For a detailed list of the available options use the VIDEO_ENUMERATE ASFVIDEO command. All arguments must be given in one command. They do not accumulate.

Example: ASF Video Configuration

QT Codec Configuration

If the container is of type QT_MOV then the quicktime framework can be configured. This options is available after the clip has been opened by a successfully NAME SET command. The following command shows how to enumerate the available QT codecs, get the current setting and how to set a new codec.

The options argument for the VIDEO_SET QTCODEC command can have the following values:

• codec_type=c: Sets the QT codec to c. It can be given as 4cc character value or as little endian decoded integer.

Please take a look at the VIDEO_ENUMERATE QTCODEC output.

Example: QT Codec Configuration

QT Video Configuration

If the container is of type QT_MOV, the quicktime framework can be configured. This option is available after the clip has been opened by a successfully NAME SET command.The following command shows how to enumerate the available QT video options, get the current setting and how to set new options:

The options argument for the VIDEO_SET QTVIDEO command can have the following values:

• allow_frame_reordering=0|1: Enables/disables frame reordering when compression video data. If set to true, the decode order of the frames are different from the display order. This operation may produce a better compression.

• allow_temporal_compression=0|1 : Enables/disablestemporal compression when compressing video data. If set to true, frames are compressed based on the previous frames.

• allow_time_frame_change=0|1: Enables/disables frame time changes by the compressor. If set to true, the compressor combines similar adjacent frames into one frame with a duration equal to the sum of the duration of the two frames.

• average_data_rate=r: Average data rate of the resulting QuickTime movie file. The value is expressed in bytes per second. Setting a data rate of zero indicates that the quality setting determines the size of compressed data.

• max_frame_delay_count=n: Maximum number of frames that can be kept into memory before emitting one frame. Set to -1 for no limit.

• max_key_frame_interval=n: Maximum interval between each key frame. If set to 0, all frames are key frames.

• max_partial_sync_frame_interval=n: Maximum interval between each partial key frame.

• cpu_time_budget=n: CPU time budget in microseconds for each frame sent to the codec. This option may be ignored by the codec. If set to 0, the codec attempts to compress the data as fast as possible. If set to 0xFFFFFFFF, no limit is set.

• quality=n: Quality of the video data compression. The value is expressed as an integer going between 0 and 1024 (inclusive) where 0 is the minimum quality and 1024 is lossless compression.

• limit_data_rate=n: Total size of compressed data in bytes per second that the codec output must not exceed.

For a detailed list of available options use the VIDEO_ENUMERATE QTVIDEO command. The options for QTVIDEO accumulate. They may be given on several consecutive command lines.

Example Quicktime Video Configuration

Proxy

If the generation of a proxy file was enabled, the proxy needs to be configured. The procedure is similar to the one from the full resolution above.

Proxy Resolution

First step is to set the resolution. Get or set the resolution with the following commands:

w is width and h is height in pixels of the full frame. Width and height can be arbitrary numbers, but need to be smaller or equal to the resolution of the program output channel. Frame rate, scan mode and aspect ratio are copied from the program output channel. There are some shortcuts available.

• w=0 h=0: Sets the resolution to the same values as for the program output channel.

• w=0 h=n: Sets the resolution to n percent of the program output channel.

Example: Proxy Set Resolution To 50%

Proxy Container

The next step is to select the container for the video file. The following commands show how to query, get and set the container type.:

• PROXY_ENUMERATE lists the possible containers. The available containers depend on the resolution. The container argument may be given either as string or integral value.

• PROXY_GET shows the current container.

Example: Proxy Set Container Type To ASF

Proxy Codec

Once the container is set the video codec can be selected. The following commands show how to query, get and set the codec type:

• PROXY_ENUMERATE lists the possible codecs. The available codecs depend on the container type and the resolution. The codec argument may be given either as string or integral value.

• PROXY_GET shows the current codec.

Example: Proxy Set Codec Type To YUYV422

Proxy Options

Some resolution/container/codec combinations require or permit additional configuration. The following commands show how to query for options and how to get the current options.

• PROXY_ENUMERATE lists all possible and mandatory options for the specified group. A special group ALL lists all option groups with their possible configurations.

• PROXY_GET shows the current configuration for the specified group.

Example: Proxy Enumerate All Available Options

Proxy Audio Configuration

The following commands query, get, and set the audio configuration:

• PROXY_ENUMERATE AUDIO lists the available options.

• PROXY_GET AUDIO shows the current audio configuration.

• PROXY_SET AUDIO specifies audio options.

The options argument can be:

• Off: Does not capture audio.

• On: Uses the current audio configuration from the Viz Engine.

Examples: Proxy Set Audio Configuration

Proxy ASF Audio Configuration

If the container is of type ASF or WMV, ASF audio can be configured. The following commands show how to enumerate, get the current setting and set new values:

The options argument in PROXY_SET ASFAUDIO can have the following values:

• codec_type=t: Sets the ASF codec type to t.

• codec_format=f: Sets the ASF codec format to f.

For a detailed list of the available options use the PROXY_ENUMERATE ASFAUDIO command. All arguments must be given in one command. They do not accumulate.

Example: Proxy ASF Audio Configuration

Proxy ASF Video Configuration

If the container is of type ASF or WMV, ASF video can be configured. The following commands show how to enumerate, get the current setting and set new values:

The options argument in PROXY_SET ASFVIDEO can have the following values:

• codec_type=t: Sets the ASF codec type to t.

• codec_mode=m: Sets the ASF codec mode to m.

• bitrate=r: Sets the bitrate to r.

• maxbitrate=r: Sets the maximum bitrate to r.

• bufferwindow=w: Sets the bufferwindow to w.

• maxbufferwindow=w: Sets the maximum buffer window to w.

• secondsperkeyframe=s: Sets the seconds between keyframes to s.

• quality=q: Sets the quality to q.

• vbrquality=q: Sets the variable bitrate quality to q.

For a detailed list of the available options use the PROXY_ENUMERATE ASFVIDEO command. All arguments must be given in one command. They do not accumulate.

Example: Proxy ASF Video Configuration

Proxy QT Codec

If the container is of type QT_MOV, the quicktime framework can be configured. This options is available after the clip has been opened by a successfully NAME SET command. The following command shows how to enumerate the available QT codecs, get the current setting and how to set a new codec:

The options argument for the PROXY_SET QTCODEC command can have the following values:

• codec_type=c: Sets the QT codec to c. It can be given as 4cc character value or as little endian decoded integer. Please take a look at the PROXY_ENUMERATE QTCODEC output.

Example: Proxy Quicktime Codec Configuration

Proxy QT Video

If the container is of type QT_MOV, the quicktime framework can be configured. This options is available after the clip has been opened by a successfully NAME SET command. The following command shows how to enumerate the available QT video options, get the current setting and how to set new options:

The options argument for the VIDEO_SET QTVIDEO command can have the following values:

• allow_frame_reordering=0|1: Enables/disables frame reordering when compressing video data. If set to true, the decode order of the frames is different from the display order. This operation may produce better compression.

• allow_temporal_compression=0|1: Enables/disables temporal compression when compressing video data. If set to true, frames are compressed based on the previous frames.

• allow_time_frame_change=0|1: Enables/disables frame time changes by the compressor. If set to true, the compressor combines similar adjacent frames into one frame with a duration equal to the sum of the duration of the two frames.

• average_data_rate=r: Average data rate of the resulting QuickTime movie file. The value is expressed in bytes per second. Setting a data rate of zero indicates that the quality setting determines the size of compressed data.

• max_frame_delay_count=n: Maximum number of frames that can be kept into memory before emitting one frame. Set to -1 for no limit.

• max_key_frame_interval=n: Maximum interval between each key frame. If set to 0, all frames are key frames.

• max_partial_sync_frame_interval=n: Maximum interval between each partial key frame.

• cpu_time_budget=n: CPU time budget in microseconds for each frame sent to the codec. This option may be ignored by the codec. If set to 0, the codec attempts to compress the data as fast as possible. If set to 0xFFFFFFFF, no limit is set.

• quality=n: Quality of the video data compression. The value is expressed as an integer between 0 and 1024 (inclusive) where 0 is the minimum quality and 1024 is lossless compression.

• limit_data_rate=n: Total size of compressed data in bytes per second that the codec output must not exceed.

For a detailed list of available options use the PROXY_ENUMERATE QTVIDEO command. The options for QTVIDEO accumulate. They may be given on several consecutive command lines.

Example: Proxy Quicktime Video Configuration

Profile

It is possible to store all commands that make up the configuration of the clip out channel as a profile in the configuration file. The profile is then applied with the PROFILE APPLY command.

Example Apply Stored Profile

The profile can be edited in the configuration settings of Viz Artist under the section CHANNELS_CONFIG.