2 Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "create_cli.h"
22 #include "dcp_content_type.h"
25 #include "compose.hpp"
26 #include <dcp/raw_convert.h>
33 using boost::optional;
35 string CreateCLI::_help =
36 "\nSyntax: %1 [OPTION] <CONTENT> [OPTION] [<CONTENT> ...]\n"
37 " -v, --version show DCP-o-matic version\n"
38 " -h, --help show this help\n"
39 " -n, --name <name> film name\n"
40 " -t, --template <name> template name\n"
41 " -e, --encrypt make an encrypted DCP\n"
42 " -c, --dcp-content-type <type> FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV\n"
43 " -f, --dcp-frame-rate <rate> set DCP video frame rate (otherwise guessed from content)\n"
44 " --container-ratio <ratio> 119, 133, 137, 138, 166, 178, 185 or 239\n"
45 " -s, --still-length <n> number of seconds that still content should last\n"
46 " --standard <standard> SMPTE or interop (default SMPTE)\n"
47 " --no-use-isdcf-name do not use an ISDCF name; use the specified name unmodified\n"
48 " --no-sign do not sign the DCP\n"
49 " --config <dir> directory containing config.xml and cinemas.xml\n"
50 " --fourk make a 4K DCP rather than a 2K one\n"
51 " -o, --output <dir> output directory\n"
52 " --threed make a 3D DCP\n"
53 " --j2k-bandwidth <Mbit/s> J2K bandwidth in Mbit/s\n"
54 " --left-eye next piece of content is for the left eye\n"
55 " --right-eye next piece of content is for the right eye\n";
59 argument_option (int& n, int argc, char* argv[], string short_name, string long_name, bool* claimed, optional<string>* error, T* out)
61 string const a = argv[n];
62 if (a != short_name && a != long_name) {
66 if ((n + 1) >= argc) {
67 **error = String::compose("%1: option %2 requires an argument", argv[0], long_name);
71 *out = dcp::raw_convert<T>(string(argv[++n]));
75 CreateCLI::CreateCLI (int argc, char* argv[])
79 , dcp_content_type (0)
82 , standard (dcp::SMPTE)
83 , no_use_isdcf_name (false)
86 string dcp_content_type_string = "TST";
87 string container_ratio_string;
88 string standard_string = "SMPTE";
89 int dcp_frame_rate_int = 0;
90 string template_name_string;
91 string config_dir_string;
92 string output_dir_string;
93 int j2k_bandwidth_int = 0;
94 VideoFrameType next_frame_type = VIDEO_FRAME_TYPE_2D;
98 string const a = argv[i];
101 if (a == "-v" || a == "--version") {
104 } else if (a == "-h" || a == "--help") {
105 error = "Create a film directory (ready for making a DCP) or metadata file from some content files.\n"
106 "A film directory will be created if -o or --output is specified, otherwise a metadata file\n"
107 "will be written to stdout.\n" + String::compose(_help, argv[0]);
111 if (a == "-e" || a == "--encrypt") {
112 encrypt = claimed = true;
113 } else if (a == "--no-use-isdcf-name") {
114 no_use_isdcf_name = claimed = true;
115 } else if (a == "--threed") {
116 threed = claimed = true;
117 } else if (a == "--left-eye") {
118 next_frame_type = VIDEO_FRAME_TYPE_3D_LEFT;
120 } else if (a == "--right-eye") {
121 next_frame_type = VIDEO_FRAME_TYPE_3D_RIGHT;
123 } else if (a == "--fourk") {
128 argument_option(i, argc, argv, "-n", "--name", &claimed, &error, &name);
129 argument_option(i, argc, argv, "-t", "--template", &claimed, &error, &template_name_string);
130 argument_option(i, argc, argv, "-c", "--dcp-content-type", &claimed, &error, &dcp_content_type_string);
131 argument_option(i, argc, argv, "-f", "--dcp-frame-rate", &claimed, &error, &dcp_frame_rate_int);
132 argument_option(i, argc, argv, "", "--container-ratio", &claimed, &error, &container_ratio_string);
133 argument_option(i, argc, argv, "-s", "--still-length", &claimed, &error, &still_length);
134 argument_option(i, argc, argv, "", "--standard", &claimed, &error, &standard_string);
135 argument_option(i, argc, argv, "", "--config", &claimed, &error, &config_dir_string);
136 argument_option(i, argc, argv, "-o", "--output", &claimed, &error, &output_dir_string);
137 argument_option(i, argc, argv, "", "--j2k-bandwidth", &claimed, &error, &j2k_bandwidth_int);
140 if (a.length() > 2 && a.substr(0, 2) == "--") {
141 error = String::compose("%1: unrecognised option '%2'", argv[0], a) + String::compose(_help, argv[0]);
146 c.frame_type = next_frame_type;
147 content.push_back (c);
148 next_frame_type = VIDEO_FRAME_TYPE_2D;
155 if (!config_dir_string.empty()) {
156 config_dir = config_dir_string;
159 if (!output_dir_string.empty()) {
160 output_dir = output_dir_string;
163 if (!template_name_string.empty()) {
164 template_name = template_name_string;
167 if (dcp_frame_rate_int) {
168 dcp_frame_rate = dcp_frame_rate_int;
171 if (j2k_bandwidth_int) {
172 j2k_bandwidth = j2k_bandwidth_int * 1000000;
175 dcp_content_type = DCPContentType::from_isdcf_name(dcp_content_type_string);
176 if (!dcp_content_type) {
177 error = String::compose("%1: unrecognised DCP content type '%2'", argv[0], dcp_content_type_string);
181 if (!container_ratio_string.empty()) {
182 container_ratio = Ratio::from_id (container_ratio_string);
183 if (!container_ratio) {
184 error = String::compose("%1: unrecognised container ratio %2", argv[0], container_ratio_string);
189 if (standard_string != "SMPTE" && standard_string != "interop") {
190 error = String::compose("%1: standard must be SMPTE or interop", argv[0]);
194 if (content.empty()) {
195 error = String::compose("%1: no content specified", argv[0]);
200 name = content[0].path.leaf().string();
203 if (j2k_bandwidth && (*j2k_bandwidth < 10000000 || *j2k_bandwidth > Config::instance()->maximum_j2k_bandwidth())) {
204 error = String::compose("%1: j2k-bandwidth must be between 10 and %2 Mbit/s", argv[0], (Config::instance()->maximum_j2k_bandwidth() / 1000000));