asdcp-test man page (deprecated)

Name

asdcp-test — wrap, unwrap and query AS-DCP MXF files **deprecated**

Synopsis

asdcp-test -c <output-file> [-3] [-b <buffer-size>] [-d <duration>] [-e|-E] [-f <starting-frame>] [-j <key-id-string>] [-k <key-string>] [-L] [-M] [-p <frame-rate>] [-R] [-s <num>] [-U] [-v] [-W] [-z| -Z] <input-file> [<input-file2>...]

asdcp-test [-h|-help] [-V ]

asdcp-test -i [-H ] [-n] [-v] <input-file>

asdcp-test -g|-U|-u

asdcp-test -G [-v] <input-file>

asdcp-test -t [-v] <input-file>

asdcp-test -x <file-prefix> [-3] [-b <buffer-size>] [-d <duration>] [-f <starting-frame>] [-m] [-p <frame-rate>] [-R] [-s <num>] [-S|-1] [-v] [-W] [-z| -Z] <input-file>

Description

asdcp-test creates or extracts data from an AS-DCP track file.
asdcp-test can also retrieve metadata information from an AS-DCP track file, as well as information regarding MXF+Interop MPEG essence contained in an AS-DCP track file
Depending on the mode in which asdcp-test is invoked, options exist for a variety of security and content related settings.
The options are described below.
Not all options are available in all modes.
Option availability is described in the command synopses above.

Major Modes

The functionality of asdcp-test is separated into major modes. These modes are exclusive to each other; only one major mode may be used at a time. At least one major mode must be used.

-c <output-file>
– Create mode. This mode creates an AS-DCP track file named using the specified filename. Input files must be of the same essence type and be compatible for encoding in a single AS-DCP track file.

-g
– Generates a random 16 byte value. This string is printed to the standard output.

-G <input-file>
– GOP Display mode. This mode performs a GOP start lookup test on an MXF+Interop MPEG file.

-h, -help
– Prints a brief help screen with the command usage.

-i
– Information mode. This mode reads an AS-DCP track file and prints information about it to the standard output.

-t
– Message Digest Calculation. This mode calculates the message digest of one or more input files and prints the result and the filename to standard output.

-U
– UL label dump mode. This mode prints all of the ULs in the file to the standard output.

-u
– UUID Generator mode. This mode generates a random UUID and prints it to the standard output.

-V
– Prints the version of asdcp-test and the version of asdcplib for
which it is built.

-x <file-prefix>
– Extract mode. This mode extracts D-Cinema essence from an existing AS-DCP track file.
Extracted picture essence is written to files with the prefix of <file-prefix>.
In the case of JPEG2000 essence, a frame-sequence-number is appended to the prefix,
and the suffix “.j2c” is appended to the filename.
In the case of MXF+Interop MPEG video, the extension “.ves” is used.
Extracted Wave essence is named with the file-prefix, an incrementing number reflecting the
number of files containing audio essence being created, and the suffix “.wav”.

Options

-1
– Mono WAVE file creation. When used with -x on a file containing sound essence,
each channel of extracted audio essence will be written to a separate file. The default is to create
multi-channel audio files.

-3
– Stereoscopic file creation. When used with -c, a stereoscopic image file
is created. The input arguments must be two directories of JP2K codestreams. The directories
must have an equal number of frames. Left is first.

-b <buffer-size>
– Specify the size, in bytes, of the picture frame buffer.
If this option is not used, the default buffer size of 4194304 bytes (4MB) is used.

-d <duration>
Specify the duration, in frames, of an AS-DCP encode or extraction process.
If -d is not used then the intrinsic duration of the input-file(s) is
used (all frames). The duration is relative to the starting frame.

-e
– Specifies that the essence in the resulting AS-DCP track file should be encrypted.
This is the default behavior.

-E
– Specifies that the essence in the resulting AS-DCP track file should NOT be encrypted.

-f <starting-frame>
– Specify the frame from which to start creating or extracting the AS-DCP track file.
If this option is not used, the default starting-frame of 0 is used.

-H
– Causes the MXF Header data to be displayed. This option requires
the -i, information, option.

-j
– Optionally specify a KeyID to use for the resulting AS-DCP track file with encrypted essence.
The default is to allow a random KeyID to be generate. Use of this option is discouraged because it
is insecure.

-k
– Optionally specify a track file encryption key to use for ciphertext operations.
When encoding as AS-DCP track file the default is to allow a random key to be generated.
Use of this option when encoding in a production environment is discouraged because it is insecure.

-L
– Write SMPTE UL Values instead of the default MXF Interop values.

-m
– Read and verify HMAC values when reading AS-DCP track files. The default behavior is to NOT verify HMAC values when reading AS-DCP track files.

-M
– Don’t calculate HMAC values when creating AS-DCP track files. The default behavior is to calculate
HMAC values.

-n
– Display the frame index of the MXF file. Also displays the frame type if the input file contains
MXF+Interop MPEG essence.

-p
– Specify the frame rate of the resulting AS-DCP track file. Valid frame rates are 23, 24, and 48 frames per second.
The default frame rate is 24 frames per second (fps).

-R
– The repeating frame option. This option causes the first frame of specified picture essence to be
repeated for the entire duration of the AS-DCP track file.
This option can only be used when major mode -c is used.
This option requires the -d option.

-s<num>
This option dumps the number of specified bytes to the standard error stream (stderr). Dumped bytes are displayed as Hexadecimal. This option requires the -v option.

-S
– Stereo WAVE file creation. When used with -x on a file containing sound essence,
two channels of extracted audio essence will be written to each output file.
The default is to extract sound essence into multi-channel WAVE files.

-v
– Prints informative messages to the standard error stream (stderr).

-W
– This option prevents specified output files from being written. Specified input files are read in and processed as per the options specified on the command line.

-z
– This option causes a wrap operation to fail if the JPEG2000
input files have unequal parameters. This is the default.

-Z
– This option causes the program to ignore unequal parameters in
Jpeg2000 input files.

Examples

  $ asdcp-test -c new_trackfile.mxf -E /source/dcdm/reel1

Causes asdcp-test to create the unencrypted trackfile from the source DCDM. This example implies that the source DCDM directory contains a number of JP2K frames numbered in sequence such that each frame of DCDM essence does not need to be enumerated on the command line.

  $ asdcp-test -i new_trackfile.mxf

Causes asdcp-test to report the file essence type.

  $ asdcp-test -x gwtw-extracted- gwtw_noencrypt_reel1.mxf

Causes asdcp-test to extract each piece of DCDM essence from the MXF wrapped track file.
The resulting essence is named with the prefix specified after the -x option and
the essence’s sequential number as found in the track file.

  $ asdcp-test -t gwtw_noencrypt_reel1.mxf

Causes asdcp-test to calculate the message digest for the file, and print both the message digest and the filename to standard output.

  $ asdcp-test -u

Causes asdcp-test to generate a URN UUID to the standard output.

  $ asdcp-test -g

Causes asdcp-test to generate a random 16 byte value to the standard output.

  $ asdcp-test -G gwtw_MPEG_reel1.mxf

Causes asdcp-test to perform a GOP start lookup on an MXF+Interop MPEG file.