Using Scripting Functionality#
easyDCP Creator can be used with command line arguments. Using easyDCP Creator with command line arguments can be very useful for scripting purposes or in a scripting environment where many operations have to be executed automatically. For example this can be a weekly advertisement where the workflow is always the same. Or maybe you want to create a bunch of DCPs all with the same picture but with a somewhat different sound to find out which is the best.
On Windows#
On Windows, the command prompt or a script (e.g. a batch file) would typically be used to pass command line parameters to easyDCP Creator. easyDCP Creator.exe / easyDCP Creator.exe were built using the Windows Subsystem and therefore their output is not visible in the command prompt. Instead, easyDCP Creator.com / easyDCP Creator.com should be used. Since the executable file contains a space, enclose any calls into “”, e.g.
C:>”Program FilesFraunhofer IISeasyDCP Creator+ 4.0.0bineasyDCP Creator.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 Creator. The easyDCP Creator application is in truth a directory called “easyDCP Creator+.app”. The executable file which can be started and get passed parameters is “easyDCP Creator+.app/Contents/MacOS/easyDCP Creator”. Since the executable file contains a space, enclose any calls into “”, e.g.
Mymac:~ user$ “/Applications/easyDCP Creator+ 4.0.0.app/Contents/MacOS/easyDCP Creator 3.7.0” -help
Using command line (CLI) arguments#
For detailed descriptions of the available parameters, call the executable file with the parameter “–help”.
C:Program FilesFraunhofer IISeasyDCP Creator+ 4.0.0bin>”easyDCP Creator+.com” –h easyDCP Creator+ 4.0.0 rev.105190 Usage: “ C:/Program Files/Fraunhofer IIS/easyDCP Creator+ 4.0.0/bin/easyDCP Creator+.exe” <parameters> “
Optional parameters:
-username Login username - optional if already stored
-password Login password - optional if already stored
-i <projectfile>
-o <output directory>
-mbits <mbits> optional - set mbits per second for encoding.
Default: 250 mbits for DCP
-d <digest filename>
-p <password for signature certificate private key>
-writeCplMetadata Set CPL metadata writing enabled
This setting will be taken into account for SMPTE DCPs only
-trimTrackFiles Set Track File trimming enabled
This setting will cause mxf files to only contain used ranges of
Frames:
-forceReencoding Force re-encoding of sources
All frames get re-encoded
-forceNoReencoding Force no re-encoding, just re-wrapping
No frames will be re-encoded and the frames will be packed into a
new mxf file You have to make sure that the content properties are valid for
the selected package type (profile/codec, bitrate, color space).
-reencodeOnDemand Re-encode if necessary
Only frames that don't match the target settings (profile/codec,
bitrate, color space) get re-encoded.
-copySourceFiles All other frames will be packaged as they are.
Copy mxf files to destination without touching sources
No frames will be re-encoded and the existing MXF files will be
copied to the destination folder.
You have to make sure that the content properties are valid for
the selected package type (profile/codec, bitrate, color space).
-forceWildTrackFormat Enforce wild track format for the package (Audio)
No matter what the originally configured audio channel format is
wild track format will be used.
-ph print system hash (required for requesting a license)
-log <logfile>|CON|CONSOLE
enable log and write it to a file or the console
-h print this help
Device Management:
Select which devices should be used for generation:
-deviceCpuOnly Use only CPU for generation
-deviceGpuOnly Use most powerful GPU for generation
-deviceId <device ID>
Use specific GPU, identified by device id
CUDA devices:
[1] [CUDA] "GeForce RTX 2080" (cc7.5, 46 x 128 processors, 8192 MB)
Example:
C:\Program Files\Fraunhofer IIS\easyDCP Creator+ 4.0.0\bin\easyDCP Creator+.exe -i
C:\myDCPprojs\test.dcpproj -o C:\myDCP\newDCP -d C:\MyDigests\newDigest.dcpdig
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
Examples#
easyDCP_Creator “c:/myprojects/Africa.dcpproj”
Starts easyDCP Creator and automatically opens the Project File “c:/myprojects/Africa.dcpproj”.
easyDCP_Creator -i “c:DCPprojtest.dcpproj” -o “c:DCP” -d “c:digestsnew.dcpdig”
Creates a DCP into the folder “c:DCP” using the Project File “test.dcpproj” and generates the DCP Digest file “new.dcpdig”.
Standalone Transcoder#
The standalone transcoder application can be used in the same way as described for easyDCP Creator above. Starting easyDCP Standalone Transcoder with the parameter “–help” will display a list of available parameters.
C:\Program Files\Fraunhofer IIS\easyDCP Creator+ 4.0.0\bin>"easyDCP JPEG 2000 Standalone
Transcoder.com" -h
Usage:
C:\Program Files\Fraunhofer IIS\easyDCP Creator+ 4.0.0\bin\easyDCP JPEG 2000 Standalone
Transcoder.exe
-input /-i <input_file>
[-start /-s <start_frame> ]
[-end /-e <end_frame> ]
-output /-o <output_folder>
[-subfolder /-sf ]
[-type /-t <project_type> ]
[-fpsnum /-f <fps_numerator> ]
[-fpsdenom /-d <fps_denominator> ]
[-bitrate /-b <bitrate> ]
[-letterboxing /-p <letterboxing> ]
[-scaling /-sc <scaling> ]
[-colortransform /-c <color_transformation> ]
[-sourcecolorspace /-ss <source_color_space> ]
[-destinationcolorspace /-ds <destination_color_space> ]
[-numthreads /-n <number_of_threads> ]
[-log <log_file_path> ]
[-gui /-g ]
[-help /-h ]
[-username <username> ]
[-password <password> ]
Parameter Descriptions:
Parameter Descriptions:#
- <input_file>
First input image or the movie file.
- <start_frame>
First frame to be processed. (Default: 0)
- <end_frame>
Last frame to be processed. (Default: last frame)
- <output_folder>
Output folder.
- subfolder / -sf
Create a subfolder based on the input file name. (Default: Don’t create subfolder)
- <project_type>
Type of the project and images. Options: DCP2k, DCP2k3D, DCP4k, DCP4k3D, IAP2k, IAP4k, MAP (Default: DCP2k)
- <fps_numerator>
Numerator of frames per second. (Default: 24)
- <fps_denominator>
Denominator of frames per second. (Default: 1)
- <bitrate>
Bitrate for JPEG 2000 compression in MBit/s or lossless: 60 for 60MBit/s, lossless - lossless compression.
- <letterboxing>
Letterboxing applied. Options: full, flat, scope, automatic, off (Default: automatic)
- <scaling>
Scaling applied. Options: off, fit, fill (Default: off)
- <color_transformation>
Color transformation (name or filename). (Default: None)
- <source_color_space>
Color space of the source (name or filename). (Default: None)
- <destination_color_space>
Color space of the destination (name or filename). (Default: None)
- <number_of_threads>
Number of threads used for processing. (Default: maximum)
- <log_file_path>
Path for the log file, or use “-” / “Con” for console logging.
- gui / -g
Force start of GUI.
- <username>
Login username for easyDCP license server.
- <password>
Login password for easyDCP license server.
Available Color Transforms:
ITU 709 (Gamma 2.2) -> X'Y'Z'
ITU 709 (Gamma 2.4) -> X'Y'Z'
P3 -> X'Y'Z'
R'G'B' Full Range -> Y'Cb'Cr' Legal Range (Rec BT.709)
Available Color Spaces:
Eclair Color
RGB (ITU-R BT.2020 / PQ)
RGB (ITU-R BT.2020 / PQ) - Full Range
RGB (ITU-R BT.709 Full-Range)
RGB (ITU-R BT.709)
RGB (ITU-R BT.709) Legal Range Gamma 2.0
RGB (ITU-R BT.709) Legal Range Gamma 2.2
RGB (ITU-R BT.709) Legal Range Gamma 2.3
RGB (ITU-R BT.709) Legal Range Gamma 2.6
RGB P3 (D65)
RGB P3 (D65) PQ
RGB P3 (DCI)
Standard RGB (sRGB)
XYZ (DCI)
YCbCr (ITU-R BT.709)