src/lib/create_cli.cc

   1 /*
   2     Copyright (C) 2019-2021 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 "ratio.h"
  27 #include <dcp/raw_convert.h>
  28 #include <iostream>
  29 #include <string>
  30
  31
  32 using std::string;
  33 using std::cout;
  34 using boost::optional;
  35
  36
  37 string CreateCLI::_help =
  38         "\nSyntax: %1 [OPTION] <CONTENT> [OPTION] [<CONTENT> ...]\n"
  39         "  -v, --version                 show DCP-o-matic version\n"
  40         "  -h, --help                    show this help\n"
  41         "  -n, --name <name>             film name\n"
  42         "  -t, --template <name>         template name\n"
  43         "  -e, --encrypt                 make an encrypted DCP\n"
  44         "  -c, --dcp-content-type <type> FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV\n"
  45         "  -f, --dcp-frame-rate <rate>   set DCP video frame rate (otherwise guessed from content)\n"
  46         "      --container-ratio <ratio> 119, 133, 137, 138, 166, 178, 185 or 239\n"
  47         "  -s, --still-length <n>        number of seconds that still content should last\n"
  48         "      --standard <standard>     SMPTE or interop (default SMPTE)\n"
  49         "      --no-use-isdcf-name       do not use an ISDCF name; use the specified name unmodified\n"
  50         "      --no-sign                 do not sign the DCP\n"
  51         "      --config <dir>            directory containing config.xml and cinemas.xml\n"
  52         "      --fourk                   make a 4K DCP rather than a 2K one\n"
  53         "  -o, --output <dir>            output directory\n"
  54         "      --threed                  make a 3D DCP\n"
  55         "      --j2k-bandwidth <Mbit/s>  J2K bandwidth in Mbit/s\n"
  56         "      --left-eye                next piece of content is for the left eye\n"
  57         "      --right-eye               next piece of content is for the right eye\n";
  58
  59
  60 template <class T>
  61 void
  62 argument_option (int& n, int argc, char* argv[], string short_name, string long_name, bool* claimed, optional<string>* error, T* out)
  63 {
  64         string const a = argv[n];
  65         if (a != short_name && a != long_name) {
  66                 return;
  67         }
  68
  69         if ((n + 1) >= argc) {
  70                 **error = String::compose("%1: option %2 requires an argument", argv[0], long_name);
  71                 return;
  72         }
  73
  74         *out = dcp::raw_convert<T>(string(argv[++n]));
  75         *claimed = true;
  76 }
  77
  78
  79 CreateCLI::CreateCLI (int argc, char* argv[])
  80         : version (false)
  81         , encrypt (false)
  82         , threed (false)
  83         , dcp_content_type (0)
  84         , container_ratio (0)
  85         , still_length (10)
  86         , standard (dcp::Standard::SMPTE)
  87         , no_use_isdcf_name (false)
  88         , fourk (false)
  89 {
  90         string dcp_content_type_string = "TST";
  91         string container_ratio_string;
  92         string standard_string = "SMPTE";
  93         int dcp_frame_rate_int = 0;
  94         string template_name_string;
  95         string config_dir_string;
  96         string output_dir_string;
  97         int j2k_bandwidth_int = 0;
  98         auto next_frame_type = VideoFrameType::TWO_D;
  99
 100         int i = 1;
 101         while (i < argc) {
 102                 string const a = argv[i];
 103                 bool claimed = false;
 104
 105                 if (a == "-v" || a == "--version") {
 106                         version = true;
 107                         return;
 108                 } else if (a == "-h" || a == "--help") {
 109                         error = "Create a film directory (ready for making a DCP) or metadata file from some content files.\n"
 110                                 "A film directory will be created if -o or --output is specified, otherwise a metadata file\n"
 111                                 "will be written to stdout.\n" + String::compose(_help, argv[0]);
 112                         return;
 113                 }
 114
 115                 if (a == "-e" || a == "--encrypt") {
 116                         encrypt = claimed = true;
 117                 } else if (a == "--no-use-isdcf-name") {
 118                         no_use_isdcf_name = claimed = true;
 119                 } else if (a == "--threed") {
 120                         threed = claimed = true;
 121                 } else if (a == "--left-eye") {
 122                         next_frame_type = VideoFrameType::THREE_D_LEFT;
 123                         claimed = true;
 124                 } else if (a == "--right-eye") {
 125                         next_frame_type = VideoFrameType::THREE_D_RIGHT;
 126                         claimed = true;
 127                 } else if (a == "--fourk") {
 128                         fourk = true;
 129                         claimed = true;
 130                 }
 131
 132                 argument_option(i, argc, argv, "-n", "--name",             &claimed, &error, &name);
 133                 argument_option(i, argc, argv, "-t", "--template",         &claimed, &error, &template_name_string);
 134                 argument_option(i, argc, argv, "-c", "--dcp-content-type", &claimed, &error, &dcp_content_type_string);
 135                 argument_option(i, argc, argv, "-f", "--dcp-frame-rate",   &claimed, &error, &dcp_frame_rate_int);
 136                 argument_option(i, argc, argv, "",   "--container-ratio",  &claimed, &error, &container_ratio_string);
 137                 argument_option(i, argc, argv, "-s", "--still-length",     &claimed, &error, &still_length);
 138                 argument_option(i, argc, argv, "",   "--standard",         &claimed, &error, &standard_string);
 139                 argument_option(i, argc, argv, "",   "--config",           &claimed, &error, &config_dir_string);
 140                 argument_option(i, argc, argv, "-o", "--output",           &claimed, &error, &output_dir_string);
 141                 argument_option(i, argc, argv, "",   "--j2k-bandwidth",    &claimed, &error, &j2k_bandwidth_int);
 142
 143                 if (!claimed) {
 144                         if (a.length() > 2 && a.substr(0, 2) == "--") {
 145                                 error = String::compose("%1: unrecognised option '%2'", argv[0], a) + String::compose(_help, argv[0]);
 146                                 return;
 147                         } else {
 148                                 Content c;
 149                                 c.path = a;
 150                                 c.frame_type = next_frame_type;
 151                                 content.push_back (c);
 152                                 next_frame_type = VideoFrameType::TWO_D;
 153                         }
 154                 }
 155
 156                 ++i;
 157         }
 158
 159         if (!config_dir_string.empty()) {
 160                 config_dir = config_dir_string;
 161         }
 162
 163         if (!output_dir_string.empty()) {
 164                 output_dir = output_dir_string;
 165         }
 166
 167         if (!template_name_string.empty()) {
 168                 template_name = template_name_string;
 169         }
 170
 171         if (dcp_frame_rate_int) {
 172                 dcp_frame_rate = dcp_frame_rate_int;
 173         }
 174
 175         if (j2k_bandwidth_int) {
 176                 j2k_bandwidth = j2k_bandwidth_int * 1000000;
 177         }
 178
 179         dcp_content_type = DCPContentType::from_isdcf_name(dcp_content_type_string);
 180         if (!dcp_content_type) {
 181                 error = String::compose("%1: unrecognised DCP content type '%2'", argv[0], dcp_content_type_string);
 182                 return;
 183         }
 184
 185         if (!container_ratio_string.empty()) {
 186                 container_ratio = Ratio::from_id (container_ratio_string);
 187                 if (!container_ratio) {
 188                         error = String::compose("%1: unrecognised container ratio %2", argv[0], container_ratio_string);
 189                         return;
 190                 }
 191         }
 192
 193         if (standard_string != "SMPTE" && standard_string != "interop") {
 194                 error = String::compose("%1: standard must be SMPTE or interop", argv[0]);
 195                 return;
 196         }
 197
 198         if (standard_string == "interop") {
 199                 standard = dcp::Standard::INTEROP;
 200         }
 201
 202         if (content.empty()) {
 203                 error = String::compose("%1: no content specified", argv[0]);
 204                 return;
 205         }
 206
 207         if (name.empty()) {
 208                 name = content[0].path.leaf().string();
 209         }
 210
 211         if (j2k_bandwidth && (*j2k_bandwidth < 10000000 || *j2k_bandwidth > Config::instance()->maximum_j2k_bandwidth())) {
 212                 error = String::compose("%1: j2k-bandwidth must be between 10 and %2 Mbit/s", argv[0], (Config::instance()->maximum_j2k_bandwidth() / 1000000));
 213                 return;
 214         }
 215 }