Command-Line Interface (CLI)#
easyDCP Player+ can be used on the command line to perform a hash-check on a package. Additionally all options required to export or validate a package are available. For detailed descriptions of the available parameters, call the executable file with the parameter “–help”.
C:\Program Files\Fraunhofer IIS\easyDCP Player+ 4.0.0\bin>"easyDCP
Player+.com" -h
easyDCP Player+ 4.0.0 rev.104718
Usage: "C:/Program Files/Fraunhofer IIS/easyDCP Player+ 4.0.0/bin/easyDCP Player+.exe"
<source>
A source can be the path to a DCP directory, CPL,
Assetmap, easyDCP project file, QuickTime, MXF, J2C,
any other supported still image, WAV file or M3U Playlist.
Individual audio and video sources need to be separated with a space.
When a KDM or digest is required to load the source, just provide it separated by a
space.
Login parameters:
-username Login username - optional if already stored
-password Login password - optional if already stored
Optional parameters:
-stats <statsfile.csv>
Write fps performance statistics to a file.
-log <logfile>|CONSOLE
Enable log and write it to a file or the console
-hashCheck Only perform a hash check
Playback options:
-play Start playback immediately
-quitAfterPlayback Close the player after end of first asset is reached
-quality <0 to 100>
specifies the quality for JPEG 2000 playback
Device management:
Select which devices should be used for playback or export
-deviceCpuOnly Use only CPU for decoding
-deviceGpuOnly Use most powerful GPU for decoding
For playback the most powerful GPU will be used, which
doesn't have a monitor attached
-deviceId <device ID>
Use specific GPU, identified by device id
CUDA devices:
[1] [CUDA] "GeForce RTX 2080 Ti" (cc7.5, 68 x 128 processors, 11264 MB)
[2] [CUDA] "GeForce GTX 750 Ti" (cc5.0, 5 x 128 processors, 2048 MB)
Export parameters:
Attention:
In case an IMF package containing Dolby Vision metadata should be exported,
all color transform related parameters will be ignored.
--exportDirectory|-o <path to export directory>
Sets the export directory. The directory has to exist.
[--exportType|-t Project|Sequence|Reel]
Select export type:
Unwrap easyDCP project
Export a frame sequence
Export reels
[--exportFilePrefixMode|-pm CplTitle|PklTitle|Custom]
Specify which file prefix should be used for export.
"Custom" can be used in combination with -p.
[--exportFilePrefix|-p <export file prefix>]
Specify file prefix, e.g. "image_".
Options:
%1 Current date (yyyy-MM-dd)
%2 CPL Title
%3 PKL Title
[--exportVideo|-v DPX|TIFF|J2C|MOV|MP4]
Select image file format for export sequence.
[--exportAudio|-a MultichannelWAV|WAV|MOV|MP4]
Select audio file format for export sequence.
[--exportAudioOutputRouting|-aor]
Set the audio output routing preset
"5.1, 7.1 DS, 7.1 SDDS"
"5.1"
"5.1 to Stereo Downmix"
"5.1 + HI/VI-N"
"5.1 + VIN to Stereo Downmix"
"5.1 + HI to Stereo Downmix"
"6.1"
"6.1 + HI/VI-N"
"7.1 DS"
"7.1 + HI/VI-N"
"7.1 SDDS"
"7.1 SDDS + HI/VI-N"
"2.0 Stereo"
"Lossless passthrough"
"HI on all channels"
"VI-N on all channels"
[--exportStartIndex|-from]
Set start of sequence, 0 is the default.
[--exportStopIndex|-to]
Set end of sequence, the last frame is the default.
[--exportStereoMode|-c left|right|leftandright]
Select export channel for stereoscopic 3D assets.
[--exportRlvl|-rlvl]
Set number of resolution levels to be discarded.
Default is 0 for full resolution.
[--exportColorDepth|-bps 8|10|12|16]
Select color depth 8, 10, 12 or 16. Default is the original color depth
of the video asset.
[--exportColorTransformation|-ct]
Set the color transformation XML preset to use.
Default is no color transformation.
Brighter for Shutter Glasses"
"X'Y'Z' -> R'G'B' (P3)"
"X'Y'Z' -> R'G'B' (Rec BT.709)"
"X'Y'Z' -> R'G'B' (Rec BT.709) (Brighter for Shutter Glasses)"
"X'Y'Z' -> R'G'B' Legal Range (Rec BT.709)"
"Y'Cb'Cr' Legal Range -> R'G'B' Full Range (Rec BT.709)"
[--exportSourceColorSpace|-ss]
Set the input source color space. If a destination
space is selected, a color transformation will be applied.
"Eclair Color"
"RGB (ITU-R BT.709 Full-Range)"
"RGB (ITU-R BT.709)"
"RGB P3 (D65)"
"RGB P3 (DCI)"
"Standard RGB (sRGB)"
"XYZ (DCI)"
"YCbCr (ITU-R BT.709)"
[--exportDestinationColorSpace|-ds]
Set the desired output color space. If an input
space is selected, a color transformation will be applied.
"Eclair Color"
"RGB (ITU-R BT.709 Full-Range)"
"RGB (ITU-R BT.709)"
"RGB P3 (D65)"
"RGB P3 (DCI)"
"Standard RGB (sRGB)"
"XYZ (DCI)"
"YCbCr (ITU-R BT.709)"
[--exportDolbyVisionTargetDisplayId|-dovitgtdsplyid]
Specifies the target display, identified by id,
to which the image should be mapped to
[--exportVideoBitrate|-b]
Set the desired average video bitrate in kbit/s.
[--exportScaleX|-scaleX <width in pixels>]
Set scaled width in pixels. If aspect ratio is different,
the remaining pixels will be letterboxed.
[--exportScaleY|-scaleY <height in pixels>]
Set scaled height in pixels. If aspect ratio is different,
the remaining pixels will be letterboxed.
[--exportFourCC|-fourcc <FourCC>]
Set one of the following FourCC codes for MOV, MP4 video export:
Available codecs for container "MOV":
"mpeg1video" (MPEG-1 video)
"mpeg2video" (MPEG-2 video)
"mpeg4" (MPEG-4 part 2)
"dnxhd" (VC3/DNxHD)
"prores" (Apple ProRes)
"h264" (H264)
Available codecs for container "MP4":
"mpeg1video" (MPEG-1 video)
"mpeg2video" (MPEG-2 video)
"mpeg4" (MPEG-4 part 2)
"h264" (H264)
[--exportVideoOutputProfile|-videooutputprofile <Profile>]
Set one of the following profiles when using Apple Prores or H264 codec for video
export:
Available profiles for Apple ProRes:
"apco" (Apple ProRes 422 Proxy)
"apcs" (Apple ProRes 422 LT)
"apcn" (Apple ProRes 422)
"apch" (Apple ProRes 422 HQ)
"ap4h" (Apple ProRes 4444)
"ap4x" (Apple ProRes 4444 XQ)
Available profiles for H264:
"baseline" (H264 Baseline)
[--exportAudioFourCC|-audiofourcc <FourCC>]
Set one of the following FourCC codes for MOV, MP4 audio export:
Available codecs for container "MOV":
"aac" (AAC (Advanced Audio Coding))
"alac" (ALAC (Apple Lossless Audio Codec))
"pcm_s16le" (PCM signed 16-bit little-endian)
"pcm_s16be" (PCM signed 16-bit big-endian)
"pcm_s32le" (PCM signed 32-bit little-endian)
"pcm_s32be" (PCM signed 32-bit big-endian)
"pcm_s24le" (PCM signed 24-bit little-endian)
"pcm_s24be" (PCM signed 24-bit big-endian)
"pcm_f32be" (PCM 32-bit floating point big-endian)
"pcm_f32le" (PCM 32-bit floating point little-endian)
Available codecs for container "MP4":
"aac" (AAC (Advanced Audio Coding))
[--exportBurnInSubtitles|-burnsub]
Burn in subtitles.
[--exportBurnInSubtitlesVOffset|-burnsubvoffs] <offset 0-100>
Set additional vertical offset from bottom in procent 0-100.
[--exportBurnInSubtitlesType|-burnsubtype]
Set one of the following codes:
"OpenSubtitle"
"MainSubtitle"
"ClosedSubtitle"
"OpenCaption"
"MainCaption"
"ClosedCaption"
"MainClosedCaption"
[--exportBurnInSubtitlesLanguage|-burnsublang]
Set specific language of subtitle.
None (default) means all available languages for the given type are used.
[--exportBurnInTimecode|-burntc]
Burn in time-code.
[--exportBurnInTimecodeVOffset|-burntcvoffs <offset 0-100>]
Specify vertical offset from bottom in procent 0-100.
[--exportBurnInTimecodeColor|-burntccolor <color e.g. "red", "#RGB", "#RRGGBB">]
Set color for burning-in time-code.
[--exportBurnInTimecodeFont|-burntcfont <color e.g. "arial">]
Set font for burning-in time-code.
[--exportBurnInTimecodeFontSize|-burntcfontsize <font size in points>]
Set font size for burning-in time-code.
[--exportBurnInText|-burntxt <text>]
Burn in static text, e.g. "property of Fraunhofer IIS".
[--exportBurnInTextVOffset|-burntxtvoffs] <offset 0-100>
Specify vertical offset from bottom in procent 0-100.
[--exportBurnInTextColor|-burntxtcolor] <color>
Set color for burning-in text.
Format can be "red", "#RGB" or "#RRGGBB"
[--exportBurnInTextFont|-burntxtfont] <color e.g. "arial">
Set font for burning-in text.
[--exportBurnInTimecodeFontSize|-burntcfontsize] <font size in points>
Set font size for burning-in text.
Validation parameters:
-validate
Performs a validation of the provided package.
[--reportFile|-o <report.html>]
Sets the path for the output file of validation. The directory has to exist.
If the path is a directory, the package's folder name will be used as file base name.
This way, all reports for a validation batch job can be conveniently stored in a
single folder.
[--comment|-c <comment>]
Write a custom comment to the quality report.
[--tests|-t <"1,2,3">]
List of tests which should be executed. If no tests are selected, all available tests
will be executed.
Mutually exclusive with -skipTests.
[--skipTests|-s <"1,2,3">]
List of tests which should not be executed. All other tests will be enabled.
Mutually exclusive with -tests.
Available tests:
Id Name
1 File Sizes
2 XML files' digital signature
3 XML Schema
9 File Hashes
10 File Hashes (small files only)
11 JPEG 2000 Code Streams
12 JPEG 2000 Code Streams (probe only)
13 JPEG 2000 Bit Rate
14 Audio Buffers
15 Digital Cinema Naming Convention
16 Package Title
17 Consistent Trackfiles
18 XML Format
19 Fonts/PNGs Listed in Package
20 Out of Bounds Timestamps
21 Characters Available
23 Fonts/PNGs Available
24 Order of Time-in Timestamps
25 Order of Timed Text Spot Numbers
26 Open Subtitles Language
27 Subtitle Burnin Overlap
28 Number of Compositions
29 Conformity
30 Output Profile List
31 Issuer Language
32 Timed Text Usage
33 Frame Rate Conformity
34 Frame Rate Limit
35 Subtitle Multi Usage
36 Digital Cinema Naming Convention
37 Audio Language Codes
38 Track Edit Rates
39 Track Frame Rates
40 Subtitle Display Type
41 Subtitle Language
42 Resolution
43 Image Subsampling
44 Source Colorspace
45 Audio Channel Configuration
46 Audio Sampling Rate
47 Audio Bits
48 JPEG 2000 Properties
50 Number of Sequences/Tracks
51 Sequence Durations
52 Sequence Edit Rates
53 Subtitle Burn-in
54 Subtitle Display Type
55 Subtitle Language
56 Subtitle Multi Usage
57 Dolby Atmos
58 Sequence Duration
59 Audio Sequence Duration with NTSC Frame Rates
60 Number of Entries
61 Sound Language Code
62 Intrinsic Duration
63 Frame and Edit Rate
64 Frame and Edit Rate Metadata
65 Picture Track Subsampling
66 Resolution
67 Track audio padding
68 Subtitle Track Source Document
69 Subtitle Track Conformity
70 Subtitle Track Schema Check
71 Subtitle Track Semantics Check
72 Subtitle Track Edit Rate
73 Subtitle Track Resource
74 Subtitle Track Encryption
75 Subtitle Entries After Picture
76 Frame Rate Conformity
77 Subsampling Resolution
78 Dolby Vision Metadata
79 Dolby Vision Metadata Supplemental
80 Equal Sound Count
81 CPL contains Reel
82 Contains CPLs
83 Parsing OPLs
84 Max Path Length of Package Files
85 Valid color processing configuration
86 Valid subsampling configuration
87 Check for valid CPL metadata
88 Check for CPL metadata extension sign language video
89 JPEG 2000 Component Bit Rate Recommendation
90 Subtitle Track ReelNumber
91 SMPTE Subtitle Namespace Prefix
On Windows#
On Windows, the command prompt or a script (e.g. a batch file) would typically be used pass command line parameters to easyDCP Player+. easyDCP Player+.exe was built using the Windows Subsystem and therefore their output is not visible in the command prompt. Instead, easyDCP Player+. com should be used. Since the executable file contains a space, enclose any calls into “”, e.g.
C:\>”Program Files\Fraunhofer IIS\easyDCP Player+ 4.0.0\bin\easyDCP
Player+.com” –help
On Mac OS X#
On Mac OS X, the terminal or a script (e.g. a shell script) would typically be used to pass command line parameters to easyDCP Player+. The easyDCP Player+ application is in truth a directory called “easyDCP Player+.app”. The executable file which can be started and passed parameters is “easyDCP Player+.app/Contents/MacOS/easyDCP Player+”. Since the executable file contains a space, enclose any calls into “”, e.g.
Mymac:~ user$ “/Applications/easyDCP Player+ 4.0.0.app/Contents/MacOS/easyDCP
Player+ 4.0.0” -h