VST controls are configuration, control, and status variables implemented by VST system and device interface modules. These controls provide an easily extensible mechanism for configuring and controlling device-independent and device-specific features.
![]() | Note: This appendix contains tables summarizing the controls. For complete information on all controls, see the controls man page, vstcontrols(5M). |
The controls fall into the following categories:
![]() | Note: In the Default column in the tables in this appendix, the entry (none) signifies that the control has no default setting. (Parentheses also enclose other explanatory comments in the Default column.) An entry of none signifies that the word “none” is the default. |
System controls are configuration variables not associated with a particular device or unit. These values can be set at startup with a system defaults file. After startup, they can also be queried and set via the MVCP commands SGET and SSET, respectively.
A system defaults file resides in /usr/vtr/config/system-defaults and is named after the subsystem. For example, /usr/vtr/config/system-defaults/main holds the settings for the main system defaults.
The rest of this section explains the controls, in these subsections:
Table A-1 summarizes clip mirror controls. The defaults file is /usr/vtr/config/system-defaults/clipmirror.
Table A-1. System Controls for Clip Mirroring
Control | Default | Use |
---|---|---|
vtr.clipmirror.primary_server. | ““ (null string; mirroring disabled | Specifies name of server to mirror and starts local mirroring of the specified server's clip cache. Unsetting this control halts mirroring. See “Setting Up Primary and Redundant Servers” in Chapter 5. |
vtr.clipmirror.local_server. | ““ (null string; mirroring disabled | Specifies name of redundant server. See “Setting Up Primary and Redundant Servers” in Chapter 5. |
vtr.clipmirror.max_threads | 20 | Specifies the number of concurrent ftp threads allowed. Enter any integer from 0 to 100, based on the available network bandwidth between the two servers. |
vtr.clipmirror.reconnect_interval | 30 | Specifies how often (in seconds) the clip mirror server tries to reconnect to the primary server after the connection is lost. Enter any integer greater than 0. |
Table A-2 summarizes filesystem controls. The defaults file is /usr/vtr/config/system-defaults/fs.
Table A-2. System Controls for Filesystems
Control | Default | Use |
---|---|---|
vtr.storage.fs.grio.enabled | true | Enables or disables use of Guaranteed Rate I/O (GRIO) |
vtr.storage.fs.grio.quantum_increment | 50000 | Specifies the increment in microseconds used to round down GRIO time quantums for reservations |
vtr.storage.fs.grio.reap_interval | 10000000000 | Specifies the interval (in nanoseconds) for deallocating unused GRIO bandwidth reservations |
vtr.storage.fs.grio.reserve_mode {standard | maximum | average} | standard | Specifies disk bandwidth reserved for accessing a clip |
vtr.storage.fs.io_size | 0 (not specified) | Specifies minimum number of bytes read from or written to a clip file |
vtr.storage.fs.latency_warning_threshold | 400 | Specifies threshold (in milliseconds) for a warning message if the threshold is exceeded by a single I/O operation during playback or recording |
vtr.storage.fs.major_alignment | 0 (not specified) | Specifies alignment boundary used to optimize access to clip file |
vtr.storage.fs.max_cue_reservations | 1 | Specifies maximum bandwidth reservations per real-time filesystem for cueing clips for playback |
vtr.storage.fs.max_io_vectors | 0 (use system maximum) | Specifies maximum I/O vectors used in a single I/O operation |
vtr.storage.fs.minor_alignment | 0 (not specified) | Specifies alignment boundary used to match the access requirements of the clip file |
Table A-3 summarizes main system controls. The defaults file is /usr/vtr/config/system-defaults/main.
Table A-3. System Controls for the Main System
Control | Default | Use |
---|---|---|
.vtr.main.heap.dump | 0 | Internal control; do not change |
.vtr.main.heap.trace_heap_pid | 0 | Internal control; do not change |
vtr.main.heap.trace_pid | 0 | Internal control; do not change |
.vtr.main.list_threads | 0 | Internal control; do not change |
.vtr.main.ulock_spin_count | 0 | Internal control; do not change |
.vtr.main.ulock_yield_count | 0 | Internal control; do not change |
vtr.main.log_level.console | 0 | Specifies maximum log level of messages sent to stdout |
vtr.main.log_level.file | 0 | Specifies maximum log level of messages sent to server log file (usually, /usr/vtr/adm/logs/vtrlog) |
vtr.main.log_level.syslog | 0 | Specifies maximum log level of messages sent to system log (usually /var/adm/SYSLOG) |
vtr.main.thread.cpu_limit | 0 | Internal control; do not change |
vtr.main.thread.cpu_limit_interval | 10 | Internal control; do not change |
vtr.main.timing_standard | 525 | Specifies default timing standard for system (525 or 625) |
vtr.main.unit_heap_size | 8388608 | Sets size (in bytes) of the heap allocated to each unit |
Table A-4 summarizes main system controls. The defaults file is /usr/vtr/config/system-defaults/time.
Table A-4. System Controls for the Time Subsystem
Control | Default | Use |
---|---|---|
vtr.time.slave_system_time | true (for channel 1, unless another channel specifically enabled) | Specifies whether system time (maintained by IRIX) is slaved to time code inputs for this time channel. |
vtr.time.offset | -27000000 (Miranda Little Red) -6600000 (Horita PR-232) | Sets offset (in nanoseconds) between actual timebase and decoded input time code |
Table A-5 summarizes device controls for devices that use the Sony protocol.
![]() | Note: Settings in the defaults file /usr/vtr/config/system-defaults/sony apply to all Sony-protocol control ports. Settings that apply to individual control ports are in the file /usr/vtr/config/system-defaults/sony_n, where n is the serial port number. |
Table A-5. System Controls for Sony Protocol Devices
Control | Default | Use |
---|---|---|
(none) | Specifies clip to load on a Sony-protocol-controlled port | |
(none) | Specifies default ID (clip) to be loaded on a port controlled by the Sony protocol | |
(none) | Specifies a descriptive name for the control port | |
0xd803 | Specifies device type identifier response to a DEVICE-TYPE protocol request | |
5 | Specifies delay after an EDIT_ON or EDIT_OFF command is received before specified operation commences | |
5 | Specifies delay after an EE_ON or EE_OFF command is received before the specified operation commences | |
player | Specifies whether the video output is delayed so that seamless playback/EE switching occurs (recorder mode), or whether video output matches time code reported by VST (player mode) | |
true | Specifies whether output is switched to EE mode during recording. | |
hold | Specifies mode of output port when no playback is occurring | |
false | Unsupported | |
true | Specifies whether input port is always active and discarding frames when no recording is occurring | |
3 | Specifies log level of control processor debugging messages | |
0 | Specifies log level of control processor time-code debugging messages | |
false | Specifies whether the superimpose display is enabled; not effective when clips with Rice or DVCPRO compressed video are played | |
drop-frame | Specifies whether control port reports “drop-frame” or “non-drop-frame” time code for 525/59.94 video | |
3:00 | Specifies the postroll for an AUTOEDIT operation | |
5:00 | Specifies the preroll for an AUTOEDIT operation |
Device controls are configuration, control, and status variables that are associated with a particular unit instance of a particular device interface. Device controls can be set at startup through the use of a device-defaults file. In addition, a unit's device controls can be set and queried through the MVCP GET and SET commands.
A device-defaults file resides in /usr/vtr/config/device-defaults. These files are loaded according to a hierarchical scheme enabling common control settings to be shared among devices.
When a unit device interface is initialized, control settings are loaded from device-defaults files in the following order:
Settings for all devices: ALL
Settings for node type: MEDIA or STORAGE
Settings for port type: VIDEO, NETWORK, DECK, or DISK
Settings for device class: deviceclass
Settings for device: devicename
For example, when the unit device interface for the DIVO_1 video device is initialized, settings are loaded from the device defaults files as follows:
ALL
MEDIA
VIDEO
DIVO
DIVO_1
This section discusses device controls in the following subsections:
Table A-6 summarizes device controls for supported video devices. The defaults file is
/usr/vtr/config/device-defaults/DIVO for a DIVO board; /usr/vtr/config/device-defaults/DIVO_n is the port-specific version of the file, n, where n is the port number
/usr/vtr/config/device-defaults/DIVO_DVC for a DIVO-DVC board; /usr/vtr/config/device-defaults/DIVO-DVC_n is the port-specific version of the file
/usr/vtr/config/device-defaults/mvp for an O2 workstation with O2Video
Table A-6. Device Controls for DIVO, DIVO-DVC, and O2Video (mvp) Ports
Control | Default | Use |
---|---|---|
3:00 | Specifies postroll duration for an edit performed by the unit. Not the same as the postroll set for a machine control port (such as for the Sony or Louth protocol). | |
5:00 | Specifies preroll duration for an edit performed by the unit. Not the same as the preroll set for a machine control port (such as for the Sony or Louth protocol). | |
vtr.media.audio.input.channel_map {<map> | *} | * | Specifies mapping from device input audio channels to clip audio channels |
vtr.media.audio.input.channels | 2 | Specifies number of audio input channels to be read from audio device |
-1 | Specifies number of audio channels to put in a new clip | |
0 | Enables an internal test mode | |
DefaultIn | Specifies audio input port | |
48000 | Specifies audio sampling rate in samples per second | |
twos-complement | Specifies format of audio samples | |
24 | Specifies the number of bits of precision in each audio sample | |
0 | Specifies a skew value (in nanoseconds) for adjusting synchronization between input audio and video streams | |
<blank> | Specifies sync source for clocking input audio | |
* | Specifies mapping from clip audio channels to device output audio channels | |
2 | Specifies number of audio output channels to be written to audio device | |
10000000 | Specifies time (in nanoseconds) for fading in audio at a clip transition point | |
10000000 | Specifies nanoseconds for fading out audio at a clip transition point | |
false | Specifies whether normal audio samples are sent to attached audio port or whether zero samples (digital silence) are sent | |
DefaultOut | Specifies audio output port | |
48000 | Specifies audio sampling rate in samples per second | |
twos-complement | Specifies format of audio samples | |
24 | Specifies bits of precision in each audio sample | |
0 | Specifies a skew value (in nanoseconds) for adjusting synchronization between output audio and video streams | |
Video | Specifies sync source for clocking output audio | |
1000 | Specifies frequency (in Hz) of tone output when unit output mode is set to “image” | |
-20 | Specifies level (in dB) of tone output when unit output mode is set to “image” | |
default | Specifies format of new clips | |
true | Specifies whether starting or ending limits are enforced when clip is played back | |
* | Sets upper limit (end) for unit | |
* | Sets lower limit (start) for unit | |
* (none) | Sets location to which clip should be cued if playback or recording is started without the unit's being manually cued | |
(none) | Sets format for creating segmented clips | |
overwrite | Specifies whether a new segment recorded into a segmented clip overwrites the existing frames in the clip, or whether it is inserted into clip at cued location | |
preset | Specifies mode for determining time code of first frame recorded into an empty clip if no time code is specified when unit is cued for recording | |
01:00:00:00 | Specifies time code of first frame recorded into an empty clip if no time code is specified when unit is cued for recording and vtr.media.clip.start.mode is set to “preset” | |
0 | Sets offset (in video frames) between input video/audio and output video/audio when EE mode is active | |
false | Not supported | |
true | Specifies whether video output is displayed in a window (O2 systems only) | |
Video server | Specifies icon name associated with graphical display window (O2 systems only) | |
Video server | Specifies window name (O2 systems only) | |
false | Specifies whether a record operation is automatically aborted if an input frame is dropped | |
3 | Specifies memory for buffering incoming video data before it is written to storage | |
4 | Sets logging level for input frame debugging messages | |
off | Sets idle mode behavior for input port | |
store | Sets recording behavior for input port | |
true | Specifies whether unit can be preempted while idle if idle mode is set to a value other than “off” | |
0 | Sets initial value of free-running counter used by VITC and user bits free-running mode | |
none | Sets type of trigger used to begin recording | |
none | Sets type of trigger used to end recording | |
(none) | Sets VITC of first frame recorded when input trigger-in mode is VITC | |
(none) | Sets VITC of frame following last frame recorded when input trigger-out mode is VITC | |
source | Specifies data stored in the time code user bits for each recorded frame | |
0 | Sets initial value of the free-running and running user bits counters | |
3 | Specifies amount of memory for buffering outgoing video data after it is read from storage system | |
1 | Specifies amount of memory for buffering outgoing video data for a clip being cued to play after it is read from storage system | |
output | Sets unit's output mode when it is cued | |
hold | Sets unit's output mode when it is not playing | |
clip | Sets unit's output mode when it is playing | |
false | Specifies whether unit should pause (instead of stop) when start or end limit is reached | |
true | Specifies whether unit can be preempted while idle if idle mode is a value other than “off” | |
50000 | Sets speed of playback when a fast forward (FF) command is issued | |
-50000 | Sets speed of playback when a rewind (REW) command is issued | |
0 | Sets initial value of free-running counter used by VITC and user bits free-running mode | |
source | Specifies data sent in the time code user bits of each frame | |
0 | Sets initial value of the free-running and running user bits counters | |
true | Specifies whether this media port is enabled for use by VST applications | |
true | Specifies whether access to this media port is shared between VST and other applications | |
auto | Internal control; do not change | |
no | Specifies whether a bell character (\007) is written to log when frame is dropped | |
0.01 | Specifies magnitude of feedback applied in adjusting compression quality when recording a clip using a lossy compression method with a target bit rate | |
25000000 | Specifies target bit rate for compression stage when a clip is recorded using a lossy compression method | |
ccir601 | Specifies color-space encoding for recording input video | |
(none) | Enables an internal diagnostics mode; do not change. | |
(none) | Enables an internal diagnostics mode; do not change. | |
off | Not currently implemented | |
8 | Specifies bits of precision used by compression algorithm to store video component data | |
0.94 | Specifies value of quality parameter supplied to a lossy compression algorithm | |
422 | Specifies type of video component sampling used by compression algorithm | |
default | Specifies type of compression for video frames being recorded | |
f1 | Specifies input field dominance | |
normal | Specifies format of input video data | |
false | For compression modes that support it, specifies whether input video fields are stored as interleaved frames | |
false | When this control is set to true, the associated hardware input port is reset | |
10 | Specifies precision of DIVO Serial Digital Interface (SDI) inputs | |
4 | Specifies transmission rate expected for input from a multiplexed video stream (such as SDTI) | |
R242_8 | Specifies video component packing | |
4 | Specifies number of times VST tries to restart a failed input video transfer (recording) before raising an error on the unit | |
30000000000 | Specifies how long (in nanoseconds) VST waits for a video input signal to be reacquired before signalling error condition on active unit | |
normal | Specifies source for input video | |
auto | Specifies timing for input video | |
source | Specifies mode for storing VITC for frames as they are recorded into a clip | |
14 | Specifies video line used to get VITC from input video signal | |
0x28005c00 | Specifies RGBA pixel value for DIVO output when video port is reset and vtr.media.video.output.boot_image.type is set to “blank” | |
$port | Specifies text displayed in center of DIVO output when video port is reset and vtr.media.video.output.boot_image.type is set to “info” | |
info | Specifies initial DIVO output when video port is reset | |
2 | Specifies number of times each displayed frame is repeated when unit is playing forward or backward at a speed greater than normal | |
f1 | Specifies output video field dominance | |
normal | Specifies format of output video data | |
false | When this control is set to true, the associated hardware output port is reset | |
black | Specifies image displayed when the output mode is “image” and vtr.media.output.image.type is “user” | |
bars | Specifies image displayed when unit output mode is “image” | |
10 | Specifies precision of DIVO Serial Digital Interface (SDI) outputs | |
1 | Specifies maximum video frames queued for video output | |
4 | Specifies transmission rate for output to a multiplexed video stream (such as SDTI) | |
fast | Specifies whether text overlay should be done with as little CPU overhead as possible or so that output text is always clean | |
64 | Specifies horizontal pixel offset of left edge of text overlay | |
-64 | Specifies horizontal pixel offset of upper edge of text overlay | |
(none) | Specifies text of overlay drawn into each outgoing video field | |
no | Specifies whether both fields of video frame are displayed when frame is repeated | |
4 | Specifies the number of times VST tries to restart a failed output video transfer (playback) before raising an error on the unit | |
true | When one or more frames are dropped (and the previous frame is repeated) because of a delay in providing the next frame to the video port, specifies whether the same number of frames are automatically skipped in the clip so that clip playback duration does not change | |
0 | Specifies vertical offset (in lines) applied to output video relative to incoming sync reference | |
external | Specifies source of synchronization for video output | |
system | Specifies default timing standard for video output | |
14 | Specifies video line where VITC is placed in output signal | |
clip | Specifies data sent for VITC of each frame |
Table A-7 summarizes deck and editing device (Diaquest) controls. The defaults file is /usr/vtr/config/device-defaults/dq.
Table A-7. Device Controls for Deck Control Ports
Control | Default | Read Only | Use Summary |
---|---|---|---|
(none) | Yes | Returns last error detected from deck control interface. | |
(none) | Yes | Returns current deck transport status. | |
10 | No | Specifies how far in advance of edit in point that VST attempts to sync. Under some circumstances, the actual coincidence point is a few frames later than specified, so this control should be set to at least 10 frames. | |
5:00 | No | Specifies deck preroll for edit operations | |
3:00 | No | Specifies deck postroll for edit operations | |
{none) | Yes | Returns current status of edit operation that is in progress | |
{none) | Yes | Returns video frame rate reported by deck | |
{none) | No | Specifies port number from which the deck control interface should derive video sync timing | |
pb | No | Specifies current output mode of deck (pb for normal playback, ee for E-to-E) |
Table A-8 summarizes DVB-ASI controls for DVB-ASI ports (Viewgraphics Dynamo MediaPump).
![]() | Note: The port-specific version of the defaults file, /usr/vtr/config/device-defaults/dvb-asi_n, where n is the serial port number, is loaded only when VST is started. This file specifies only vtr.media.dvb-asi.port.total_bitrate and vtr.media.mpeg.pcr.frequency. All other controls are loaded from the non-port-specific defaults file /usr/vtr/config/device-defaults/dvb-asi. |
Table A-8. Device Controls for DVB-ASI Ports
Table A-9 summarizes device controls for storage devices. The defaults file is /usr/vtr/config/device-defaults/fs.
Table A-9. Device Controls for Filesystem Access
Control | Default | Use |
---|---|---|
false | Specifies that frames are automatically cleared from clip after they are played | |
true | Specifies that the unit continues playing after an I/O error | |
4 | Specifies log level for I/O logging messages | |
8 | Specifies maximum number of clip files that the unit can have open concurrently |
Table A-10 summarizes device controls for Vela devices. The defaults file is /usr/vtr/config/device-defaults/vela; /usr/vtr/config/device-defaults/vela_n is the device-specific version of the file {where n is the serial port number).
Table A-10. Device Controls for MPEG Decoder Ports
Control | Default | Use |
---|---|---|
0 | Specifies memory for buffering outgoing video data after it is read from the storage system | |
Internal | Specifies sync source for the video output | |
65536 | Sets size of SCSI write operations used to send MPEG stream to decoder | |
false | Specifies whether software should attempt error recovery when hardware failure is encountered | |
true | Specifies whether software should skip over the time that hardware is not available when attempting error recovery | |
0 | Sets number of seconds to wait before a SCSI timeout is detected | |
0 | Sets command latency of hardware and software in frames | |
true | Specifies whether to query Vela decoder for current location | |
false | Specifies whether to use splicing to provide a seamless concatenation of MPEG streams | |
1 | Sets number of frames blacked out by Vela decoder before video playout | |
-1.0 | Specifies attenuation of Vela decoder's audio output volume in dB |