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         "      --channel <channel>       next piece of content should be mapped to audio channel L, R, C, Lfe, Ls or Rs\n"
  59         "      --gain                    next piece of content should have the given audio gain (in dB)\n";
  60
  61
  62 template <class T>
  63 void
  64 argument_option (int& n, int argc, char* argv[], string short_name, string long_name, bool* claimed, optional<string>* error, T* out)
  65 {
  66         string const a = argv[n];
  67         if (a != short_name && a != long_name) {
  68                 return;
  69         }
  70
  71         if ((n + 1) >= argc) {
  72                 **error = String::compose("%1: option %2 requires an argument", argv[0], long_name);
  73                 return;
  74         }
  75
  76         *out = dcp::raw_convert<T>(string(argv[++n]));
  77         *claimed = true;
  78 }
  79
  80
  81 template <class T>
  82 void
  83 argument_option (
  84         int& n,
  85         int argc,
  86         char* argv[],
  87         string short_name,
  88         string long_name,
  89         bool* claimed,
  90         optional<string>* error,
  91         boost::optional<T>* out,
  92         std::function<boost::optional<T> (string s)> convert = [](string s) { return dcp::raw_convert<T>(s); }
  93         )
  94 {
  95         string const a = argv[n];
  96         if (a != short_name && a != long_name) {
  97                 return;
  98         }
  99
 100         if ((n + 1) >= argc) {
 101                 **error = String::compose("%1: option %2 requires an argument", argv[0], long_name);
 102                 return;
 103         }
 104
 105         auto const arg = argv[++n];
 106         auto const value = convert(arg);
 107         if (!value) {
 108                 *error = String::compose("%1: %2 is not valid for %3", argv[0], arg, long_name);
 109                 *claimed = true;
 110                 return;
 111         }
 112
 113         *out = value;
 114         *claimed = true;
 115 }
 116
 117
 118 CreateCLI::CreateCLI (int argc, char* argv[])
 119         : version (false)
 120         , encrypt (false)
 121         , threed (false)
 122         , dcp_content_type (nullptr)
 123         , container_ratio (nullptr)
 124         , still_length (10)
 125         , standard (dcp::Standard::SMPTE)
 126         , no_use_isdcf_name (false)
 127         , fourk (false)
 128 {
 129         string dcp_content_type_string = "TST";
 130         string container_ratio_string;
 131         string standard_string = "SMPTE";
 132         int dcp_frame_rate_int = 0;
 133         string template_name_string;
 134         int j2k_bandwidth_int = 0;
 135         auto next_frame_type = VideoFrameType::TWO_D;
 136         optional<dcp::Channel> channel;
 137         optional<float> gain;
 138
 139         int i = 1;
 140         while (i < argc) {
 141                 string const a = argv[i];
 142                 bool claimed = false;
 143
 144                 if (a == "-v" || a == "--version") {
 145                         version = true;
 146                         return;
 147                 } else if (a == "-h" || a == "--help") {
 148                         error = "Create a film directory (ready for making a DCP) or metadata file from some content files.\n"
 149                                 "A film directory will be created if -o or --output is specified, otherwise a metadata file\n"
 150                                 "will be written to stdout.\n" + String::compose(_help, argv[0]);
 151                         return;
 152                 }
 153
 154                 if (a == "-e" || a == "--encrypt") {
 155                         encrypt = claimed = true;
 156                 } else if (a == "--no-use-isdcf-name") {
 157                         no_use_isdcf_name = claimed = true;
 158                 } else if (a == "--threed") {
 159                         threed = claimed = true;
 160                 } else if (a == "--left-eye") {
 161                         next_frame_type = VideoFrameType::THREE_D_LEFT;
 162                         claimed = true;
 163                 } else if (a == "--right-eye") {
 164                         next_frame_type = VideoFrameType::THREE_D_RIGHT;
 165                         claimed = true;
 166                 } else if (a == "--fourk") {
 167                         fourk = true;
 168                         claimed = true;
 169                 }
 170
 171                 std::function<optional<boost::filesystem::path> (string s)> string_to_path = [](string s) {
 172                         return boost::filesystem::path(s);
 173                 };
 174
 175                 argument_option(i, argc, argv, "-n", "--name",             &claimed, &error, &name);
 176                 argument_option(i, argc, argv, "-t", "--template",         &claimed, &error, &template_name_string);
 177                 argument_option(i, argc, argv, "-c", "--dcp-content-type", &claimed, &error, &dcp_content_type_string);
 178                 argument_option(i, argc, argv, "-f", "--dcp-frame-rate",   &claimed, &error, &dcp_frame_rate_int);
 179                 argument_option(i, argc, argv, "",   "--container-ratio",  &claimed, &error, &container_ratio_string);
 180                 argument_option(i, argc, argv, "-s", "--still-length",     &claimed, &error, &still_length);
 181                 argument_option(i, argc, argv, "",   "--standard",         &claimed, &error, &standard_string);
 182                 argument_option(i, argc, argv, "",   "--config",           &claimed, &error, &config_dir, string_to_path);
 183                 argument_option(i, argc, argv, "-o", "--output",           &claimed, &error, &output_dir, string_to_path);
 184                 argument_option(i, argc, argv, "",   "--j2k-bandwidth",    &claimed, &error, &j2k_bandwidth_int);
 185
 186                 std::function<optional<dcp::Channel> (string)> convert_channel = [](string channel) -> optional<dcp::Channel>{
 187                         if (channel == "L") {
 188                                 return dcp::Channel::LEFT;
 189                         } else if (channel == "R") {
 190                                 return dcp::Channel::RIGHT;
 191                         } else if (channel == "C") {
 192                                 return dcp::Channel::CENTRE;
 193                         } else if (channel == "Lfe") {
 194                                 return dcp::Channel::LFE;
 195                         } else if (channel == "Ls") {
 196                                 return dcp::Channel::LS;
 197                         } else if (channel == "Rs") {
 198                                 return dcp::Channel::RS;
 199                         } else {
 200                                 return {};
 201                         }
 202                 };
 203
 204                 argument_option(i, argc, argv, "", "--channel", &claimed, &error, &channel, convert_channel);
 205                 argument_option(i, argc, argv, "", "--gain", &claimed, &error, &gain);
 206
 207                 if (!claimed) {
 208                         if (a.length() > 2 && a.substr(0, 2) == "--") {
 209                                 error = String::compose("%1: unrecognised option '%2'", argv[0], a) + String::compose(_help, argv[0]);
 210                                 return;
 211                         } else {
 212                                 Content c;
 213                                 c.path = a;
 214                                 c.frame_type = next_frame_type;
 215                                 c.channel = channel;
 216                                 c.gain = gain;
 217                                 content.push_back (c);
 218                                 next_frame_type = VideoFrameType::TWO_D;
 219                                 channel = {};
 220                                 gain = {};
 221                         }
 222                 }
 223
 224                 ++i;
 225         }
 226
 227         if (!template_name_string.empty()) {
 228                 template_name = template_name_string;
 229         }
 230
 231         if (dcp_frame_rate_int) {
 232                 dcp_frame_rate = dcp_frame_rate_int;
 233         }
 234
 235         if (j2k_bandwidth_int) {
 236                 j2k_bandwidth = j2k_bandwidth_int * 1000000;
 237         }
 238
 239         dcp_content_type = DCPContentType::from_isdcf_name(dcp_content_type_string);
 240         if (!dcp_content_type) {
 241                 error = String::compose("%1: unrecognised DCP content type '%2'", argv[0], dcp_content_type_string);
 242                 return;
 243         }
 244
 245         if (!container_ratio_string.empty()) {
 246                 container_ratio = Ratio::from_id (container_ratio_string);
 247                 if (!container_ratio) {
 248                         error = String::compose("%1: unrecognised container ratio %2", argv[0], container_ratio_string);
 249                         return;
 250                 }
 251         }
 252
 253         if (standard_string != "SMPTE" && standard_string != "interop") {
 254                 error = String::compose("%1: standard must be SMPTE or interop", argv[0]);
 255                 return;
 256         }
 257
 258         if (standard_string == "interop") {
 259                 standard = dcp::Standard::INTEROP;
 260         }
 261
 262         if (content.empty()) {
 263                 error = String::compose("%1: no content specified", argv[0]);
 264                 return;
 265         }
 266
 267         if (name.empty()) {
 268                 name = content[0].path.leaf().string();
 269         }
 270
 271         if (j2k_bandwidth && (*j2k_bandwidth < 10000000 || *j2k_bandwidth > Config::instance()->maximum_j2k_bandwidth())) {
 272                 error = String::compose("%1: j2k-bandwidth must be between 10 and %2 Mbit/s", argv[0], (Config::instance()->maximum_j2k_bandwidth() / 1000000));
 273                 return;
 274         }
 275 }