src/lib/create_cli.cc

   1 /*
   2     Copyright (C) 2019-2022 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  22 #include "compose.hpp"
  23 #include "config.h"
  24 #include "create_cli.h"
  25 #include "dcp_content_type.h"
  26 #include "dcpomatic_log.h"
  27 #include "film.h"
  28 #include "ratio.h"
  29 #include <dcp/raw_convert.h>
  30 #include <iostream>
  31 #include <string>
  32
  33
  34 using std::cout;
  35 using std::make_shared;
  36 using std::shared_ptr;
  37 using std::string;
  38 using std::vector;
  39 using boost::optional;
  40
  41
  42 string CreateCLI::_help =
  43         "\nSyntax: %1 [OPTION] <CONTENT> [OPTION] [<CONTENT> ...]\n"
  44         "  -v, --version                 show DCP-o-matic version\n"
  45         "  -h, --help                    show this help\n"
  46         "  -n, --name <name>             film name\n"
  47         "  -t, --template <name>         template name\n"
  48         "  -e, --encrypt                 make an encrypted DCP\n"
  49         "  -c, --dcp-content-type <type> FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV\n"
  50         "  -f, --dcp-frame-rate <rate>   set DCP video frame rate (otherwise guessed from content)\n"
  51         "      --container-ratio <ratio> 119, 133, 137, 138, 166, 178, 185 or 239\n"
  52         "  -s, --still-length <n>        number of seconds that still content should last\n"
  53         "      --standard <standard>     SMPTE or interop (default SMPTE)\n"
  54         "      --no-use-isdcf-name       do not use an ISDCF name; use the specified name unmodified\n"
  55         "      --config <dir>            directory containing config.xml and cinemas.xml\n"
  56         "      --twok                    make a 2K DCP instead of choosing a resolution based on the content\n"
  57         "      --fourk                   make a 4K DCP instead of choosing a resolution based on the content\n"
  58         "  -o, --output <dir>            output directory\n"
  59         "      --threed                  make a 3D DCP\n"
  60         "      --j2k-bandwidth <Mbit/s>  J2K bandwidth in Mbit/s\n"
  61         "      --left-eye                next piece of content is for the left eye\n"
  62         "      --right-eye               next piece of content is for the right eye\n"
  63         "      --channel <channel>       next piece of content should be mapped to audio channel L, R, C, Lfe, Ls, Rs, BsL, BsR, HI, VI\n"
  64         "      --gain                    next piece of content should have the given audio gain (in dB)\n"
  65         "      --cpl <id>                CPL ID to use from the next piece of content (which is a DCP)\n"
  66         "      --kdm <file>              KDM for next piece of content\n";
  67
  68
  69 template <class T>
  70 void
  71 argument_option (int& n, int argc, char* argv[], string short_name, string long_name, bool* claimed, optional<string>* error, T* out)
  72 {
  73         string const a = argv[n];
  74         if (a != short_name && a != long_name) {
  75                 return;
  76         }
  77
  78         if ((n + 1) >= argc) {
  79                 **error = String::compose("%1: option %2 requires an argument", argv[0], long_name);
  80                 return;
  81         }
  82
  83         *out = dcp::raw_convert<T>(string(argv[++n]));
  84         *claimed = true;
  85 }
  86
  87
  88 template <class T>
  89 void
  90 argument_option (
  91         int& n,
  92         int argc,
  93         char* argv[],
  94         string short_name,
  95         string long_name,
  96         bool* claimed,
  97         optional<string>* error,
  98         boost::optional<T>* out,
  99         std::function<boost::optional<T> (string s)> convert = [](string s) { return dcp::raw_convert<T>(s); }
 100         )
 101 {
 102         string const a = argv[n];
 103         if (a != short_name && a != long_name) {
 104                 return;
 105         }
 106
 107         if ((n + 1) >= argc) {
 108                 **error = String::compose("%1: option %2 requires an argument", argv[0], long_name);
 109                 return;
 110         }
 111
 112         auto const arg = argv[++n];
 113         auto const value = convert(arg);
 114         if (!value) {
 115                 *error = String::compose("%1: %2 is not valid for %3", argv[0], arg, long_name);
 116                 *claimed = true;
 117                 return;
 118         }
 119
 120         *out = value;
 121         *claimed = true;
 122 }
 123
 124
 125 CreateCLI::CreateCLI (int argc, char* argv[])
 126         : version (false)
 127 {
 128         string dcp_content_type_string = "TST";
 129         string container_ratio_string;
 130         string standard_string = "SMPTE";
 131         int dcp_frame_rate_int = 0;
 132         string template_name_string;
 133         int j2k_bandwidth_int = 0;
 134         auto next_frame_type = VideoFrameType::TWO_D;
 135         optional<dcp::Channel> channel;
 136         optional<float> gain;
 137         optional<boost::filesystem::path> kdm;
 138         optional<std::string> cpl;
 139
 140         int i = 1;
 141         while (i < argc) {
 142                 string const a = argv[i];
 143                 bool claimed = false;
 144
 145                 if (a == "-v" || a == "--version") {
 146                         version = true;
 147                         return;
 148                 } else if (a == "-h" || a == "--help") {
 149                         error = "Create a film directory (ready for making a DCP) or metadata file from some content files.\n"
 150                                 "A film directory will be created if -o or --output is specified, otherwise a metadata file\n"
 151                                 "will be written to stdout.\n" + String::compose(_help, argv[0]);
 152                         return;
 153                 }
 154
 155                 if (a == "-e" || a == "--encrypt") {
 156                         encrypt = claimed = true;
 157                 } else if (a == "--no-use-isdcf-name") {
 158                         no_use_isdcf_name = claimed = true;
 159                 } else if (a == "--threed") {
 160                         threed = claimed = true;
 161                 } else if (a == "--left-eye") {
 162                         next_frame_type = VideoFrameType::THREE_D_LEFT;
 163                         claimed = true;
 164                 } else if (a == "--right-eye") {
 165                         next_frame_type = VideoFrameType::THREE_D_RIGHT;
 166                         claimed = true;
 167                 } else if (a == "--twok") {
 168                         twok = true;
 169                         claimed = true;
 170                 } else if (a == "--fourk") {
 171                         fourk = true;
 172                         claimed = true;
 173                 }
 174
 175                 std::function<optional<string> (string s)> string_to_string = [](string s) {
 176                         return s;
 177                 };
 178
 179                 std::function<optional<boost::filesystem::path> (string s)> string_to_path = [](string s) {
 180                         return boost::filesystem::path(s);
 181                 };
 182
 183                 std::function<optional<int> (string s)> string_to_nonzero_int = [](string s) {
 184                         auto const value = dcp::raw_convert<int>(s);
 185                         if (value == 0) {
 186                                 return boost::optional<int>();
 187                         }
 188                         return boost::optional<int>(value);
 189                 };
 190
 191                 argument_option(i, argc, argv, "-n", "--name",             &claimed, &error, &name);
 192                 argument_option(i, argc, argv, "-t", "--template",         &claimed, &error, &template_name_string);
 193                 argument_option(i, argc, argv, "-c", "--dcp-content-type", &claimed, &error, &dcp_content_type_string);
 194                 argument_option(i, argc, argv, "-f", "--dcp-frame-rate",   &claimed, &error, &dcp_frame_rate_int);
 195                 argument_option(i, argc, argv, "",   "--container-ratio",  &claimed, &error, &container_ratio_string);
 196                 argument_option(i, argc, argv, "-s", "--still-length",     &claimed, &error, &still_length, string_to_nonzero_int);
 197                 argument_option(i, argc, argv, "",   "--standard",         &claimed, &error, &standard_string);
 198                 argument_option(i, argc, argv, "",   "--config",           &claimed, &error, &config_dir, string_to_path);
 199                 argument_option(i, argc, argv, "-o", "--output",           &claimed, &error, &output_dir, string_to_path);
 200                 argument_option(i, argc, argv, "",   "--j2k-bandwidth",    &claimed, &error, &j2k_bandwidth_int);
 201
 202                 std::function<optional<dcp::Channel> (string)> convert_channel = [](string channel) -> optional<dcp::Channel>{
 203                         if (channel == "L") {
 204                                 return dcp::Channel::LEFT;
 205                         } else if (channel == "R") {
 206                                 return dcp::Channel::RIGHT;
 207                         } else if (channel == "C") {
 208                                 return dcp::Channel::CENTRE;
 209                         } else if (channel == "Lfe") {
 210                                 return dcp::Channel::LFE;
 211                         } else if (channel == "Ls") {
 212                                 return dcp::Channel::LS;
 213                         } else if (channel == "Rs") {
 214                                 return dcp::Channel::RS;
 215                         } else if (channel == "BsL") {
 216                                 return dcp::Channel::BSL;
 217                         } else if (channel == "BsR") {
 218                                 return dcp::Channel::BSR;
 219                         } else if (channel == "HI") {
 220                                 return dcp::Channel::HI;
 221                         } else if (channel == "VI") {
 222                                 return dcp::Channel::VI;
 223                         } else {
 224                                 return {};
 225                         }
 226                 };
 227
 228                 argument_option(i, argc, argv, "", "--channel", &claimed, &error, &channel, convert_channel);
 229                 argument_option(i, argc, argv, "", "--gain", &claimed, &error, &gain);
 230                 argument_option(i, argc, argv, "", "--kdm", &claimed, &error, &kdm, string_to_path);
 231                 /* It shouldn't be necessary to use this string_to_string here, but using the other argument_option()
 232                  * causes an odd compile error on Ubuntu 18.04.
 233                  */
 234                 argument_option(i, argc, argv, "", "--cpl", &claimed, &error, &cpl, string_to_string);
 235
 236                 if (!claimed) {
 237                         if (a.length() > 2 && a.substr(0, 2) == "--") {
 238                                 error = String::compose("%1: unrecognised option '%2'", argv[0], a) + String::compose(_help, argv[0]);
 239                                 return;
 240                         } else {
 241                                 Content c;
 242                                 c.path = a;
 243                                 c.frame_type = next_frame_type;
 244                                 c.channel = channel;
 245                                 c.gain = gain;
 246                                 c.kdm = kdm;
 247                                 c.cpl = cpl;
 248                                 content.push_back (c);
 249                                 next_frame_type = VideoFrameType::TWO_D;
 250                                 channel = {};
 251                                 gain = {};
 252                         }
 253                 }
 254
 255                 ++i;
 256         }
 257
 258         if (!template_name_string.empty()) {
 259                 template_name = template_name_string;
 260         }
 261
 262         if (dcp_frame_rate_int) {
 263                 dcp_frame_rate = dcp_frame_rate_int;
 264         }
 265
 266         if (j2k_bandwidth_int) {
 267                 j2k_bandwidth = j2k_bandwidth_int * 1000000;
 268         }
 269
 270         dcp_content_type = DCPContentType::from_isdcf_name(dcp_content_type_string);
 271         if (!dcp_content_type) {
 272                 error = String::compose("%1: unrecognised DCP content type '%2'", argv[0], dcp_content_type_string);
 273                 return;
 274         }
 275
 276         if (!container_ratio_string.empty()) {
 277                 container_ratio = Ratio::from_id (container_ratio_string);
 278                 if (!container_ratio) {
 279                         error = String::compose("%1: unrecognised container ratio %2", argv[0], container_ratio_string);
 280                         return;
 281                 }
 282         }
 283
 284         if (standard_string != "SMPTE" && standard_string != "interop") {
 285                 error = String::compose("%1: standard must be SMPTE or interop", argv[0]);
 286                 return;
 287         }
 288
 289         if (standard_string == "interop") {
 290                 standard = dcp::Standard::INTEROP;
 291         }
 292
 293         if (content.empty()) {
 294                 error = String::compose("%1: no content specified", argv[0]);
 295                 return;
 296         }
 297
 298         if (name.empty()) {
 299                 name = content[0].path.leaf().string();
 300         }
 301
 302         if (j2k_bandwidth && (*j2k_bandwidth < 10000000 || *j2k_bandwidth > Config::instance()->maximum_j2k_bandwidth())) {
 303                 error = String::compose("%1: j2k-bandwidth must be between 10 and %2 Mbit/s", argv[0], (Config::instance()->maximum_j2k_bandwidth() / 1000000));
 304                 return;
 305         }
 306 }
 307
 308
 309 shared_ptr<Film>
 310 CreateCLI::make_film() const
 311 {
 312         auto film = std::make_shared<Film>(output_dir);
 313         dcpomatic_log = film->log();
 314         dcpomatic_log->set_types(Config::instance()->log_types());
 315         if (template_name) {
 316                 film->use_template(template_name.get());
 317         }
 318         film->set_name(name);
 319
 320         if (container_ratio) {
 321                 film->set_container(container_ratio);
 322         }
 323         film->set_dcp_content_type(dcp_content_type);
 324         film->set_interop(standard == dcp::Standard::INTEROP);
 325         film->set_use_isdcf_name(!no_use_isdcf_name);
 326         film->set_encrypted(encrypt);
 327         film->set_three_d(threed);
 328         if (twok) {
 329                 film->set_resolution(Resolution::TWO_K);
 330         }
 331         if (fourk) {
 332                 film->set_resolution(Resolution::FOUR_K);
 333         }
 334         if (j2k_bandwidth) {
 335                 film->set_j2k_bandwidth(*j2k_bandwidth);
 336         }
 337
 338         int channels = 6;
 339         for (auto cli_content: content) {
 340                 if (cli_content.channel) {
 341                         channels = std::max(channels, static_cast<int>(*cli_content.channel) + 1);
 342                 }
 343         }
 344         if (channels % 1) {
 345                 ++channels;
 346         }
 347
 348         film->set_audio_channels(channels);
 349
 350         return film;
 351 }
 352