.\" vidio.1: auto-generated, DO NOT EDIT
.\"
.\" Copyright 2011-2020. Quantum Corporation. All Rights Reserved.
.\" StorNext is either a trademark or registered trademark of
.\" Quantum Corporation in the US and/or other countries.
.\"
.\" Code start macro
.de Cs
.sp
.ft C
.in +0.3i
.nf
..
.\" Code end macro
.de Ce
.fi
.in -0.3i
.ft R
..
.TH vidio 1 "June 2020" "StorNext File System"
.SH NAME
vidio, vidio2 \- Video frame producer consumer performance test
.SH SYNOPSIS
.na
.nh
.HP
.B vidio
.RI [ options ]
.I dir_path
.RI [ dir_path ...]
.HP
.B vidio2
.RI [ options ]
.I dir_path
.RI [ dir_path ...]
.ad
.hy
.SH DESCRIPTION
\fBvidio\fR can emulate a producer or a consumer of video frames.  When run as
a producer (write mode), \fBvidio\fR generates video frames and writes them
to files that are created in the specified directory.  When \fBvidio\fR is  run 
as a consumer (read mode), it reads frames from the files in the specified 
directory that were previously created and written.  By default, \fBvidio\fR 
runs in producer mode and creates one file for each frame.
.PP
\fBvidio\fR will run in one of two modes, constrained or unconstrained.
The default mode is unconstrained and \fBvidio\fR will produce or consume frames
at an unconstrained rate; as fast as the I/O will allow.  If the \fB-F\fP option
is specified, \fBvidio\fR will produce or consume frames based upon the specified
frame rate.  Dropped frames are noted in the output.
.PP
Optionally, more than one directory can be named.  In this case, \fBvidio\fR
will start an identical I/O stream in each specified directory.
.PP
\fBvidio\fR will then write performance information to the standard output.  The
verbosity of the performance data can be controlled using the -v option.  A realtime
updating curses based display is optionally available via the \fB-c\fR option.
.PP
\fBvidio2\fR is an experimental version of \fBvidio\fR with the same syntax but
containing an updated I/O engine. Its behavior is subject to change with future
releases.
.SH OPTIONS
.IP \fB-?\fR
Display usage.
.IP \fB-B\fR
Use system buffered IO per StorNext rules.  The default is direct I/O.
.IP \fB-c\fR 
Display important statistics via a curses based continuously updating display.
.IP \fB-d\fR[\fBdd\fR] 
Run in debug mode. The more "d's" specified, the more debug
information is printed.
.IP "\fB-f\fP \fIframesize\fP"
Specify the \fIframesize\fR or the frame type.  Various type of video
frame types may be specified.  The default frame type is "hdtv".
Currently this results in a frame size of 8,294,400 bytes.  Use 
the -? option to get a list of currently supported frame types. 
The \fIframesize\fR can also be specified in bytes.  Optionally, the suffixes
k, m, g, K, M or G can be added to the numeric frame size value to
represent kilobytes, megabytes, gigabytes, kilobinary, megabinary or
gigabinary values, respectively.  The lowercase letters represent base 10
units (e.g. 1k = 1000) and the uppercase letters represent base 2 units 
(e.g. 1K = 1024.)
.IP "\fB-F\fP \fIframerate\fP"
Emulate a frame producing or consuming device by limiting the
number of frames produced or consumed per second to the specified frame rate.
If the file file system cannot keep up to the specified frame rate,
the "Dropped frames" stat is incremented. 
.IP "\fB-l\fP \fIfilelist\fP"
\fBvidio\fR can process frames from a file containing a list of frames/files.
In this manner, vidio can be used to process a directory of arbitrary DPX
files. Currently this option only works in read mode.
The filelist is simply a file containing a list of frames to be processed in
order.  The list can have empty lines and/or comment lines that must begin
with #.  All other lines are assumed to be file names in the directory
dir_path.
.PP
.IP "\fB-n\fP \fInframes\fP"
The number of frames to read or write.  The default is currently 60 frames.
.IP "\fB-N\fP \fInframes\fP"
The number of frames per file. The default is one.
.IP "\fB-O\fP \fIoffset\fP"
File offset in bytes at which to start frames, default 0. This allows very basic
emulation of mfx files with non-aligned essence data.
.IP "\fB-u\fP"
Use non-aligned memory buffer, simulate bad application buffer alignment.
.IP "\fB-R\fP"
Read files in reverse order, simulate scrubbing backwards during edit.
A starting offset near the end of the file must be used.
.IP "\fB-p\fP \fIprefix\fP"
Frame file names use the given \fIprefix\fR instead of the default of "vidio".
Vidio then appends '_NNNNNNN' as the frame number to the \fIprefix\fR.
.IP "\fB-q\fP \fIqdepth\fP"
Do asynchronous I/O by queuing requests \fIqdepth\fR deep.  If a frame rate
is specified, the \fIqdepth\fP will effectively equate to the number of frames
that are buffered.
.IP \fB-r\fR
Consumer mode.  Read frames of previously created using the -w option.
.IP "\fB-T\fP \fImilliseconds\fP"
When in constrained mode, stop the test with an error if the actual IO time is
greater than the specified number of milliseconds.
.IP \fB-v\fR[\fBvv\fR]
Print performance output in a more verbose fashion.  The more
"v's" specified, the more performance information is printed.
.IP \fB-V\fR
Show the vidio version and exit.
.IP \fB-w\fR 
Producer mode.  Create files and write frames.  Create and write
is the default test mode.
.SH FILES
.I /System/Library/Filesystems/acfs.fs/Contents/bin/vidio
.br
.I /System/Library/Filesystems/acfs.fs/Contents/bin/vidio2
.SH "SEE ALSO"
.BR cvfs (8)