/* Copyright (C) 2019-2022 Carl Hetherington This file is part of DCP-o-matic. DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with DCP-o-matic. If not, see . */ #include "compose.hpp" #include "config.h" #include "create_cli.h" #include "dcp_content_type.h" #include "dcpomatic_log.h" #include "film.h" #include "ratio.h" #include "variant.h" #include #include #include using std::cout; using std::make_shared; using std::shared_ptr; using std::string; using std::vector; using boost::optional; string CreateCLI::_help = string("\nSyntax: %1 [OPTION] [OPTION] [ ...]\n") + variant::insert_dcpomatic(" -v, --version show %1 version\n") + " -h, --help show this help\n" " -n, --name film name\n" " -t, --template template name\n" " --no-encrypt make an unencrypted DCP\n" " -e, --encrypt make an encrypted DCP\n" " -c, --dcp-content-type FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV\n" " -f, --dcp-frame-rate set DCP video frame rate (otherwise guessed from content)\n" " --container-ratio 119, 133, 137, 138, 166, 178, 185 or 239\n" " -s, --still-length number of seconds that still content should last\n" " --standard SMPTE or interop (default SMPTE)\n" " --no-use-isdcf-name do not use an ISDCF name; use the specified name unmodified\n" " --config directory containing config.xml and cinemas.xml\n" " --twok make a 2K DCP instead of choosing a resolution based on the content\n" " --fourk make a 4K DCP instead of choosing a resolution based on the content\n" " -o, --output output directory\n" " --twod make a 2D DCP\n" " --threed make a 3D DCP\n" " --j2k-bandwidth J2K bandwidth in Mbit/s\n" " --left-eye next piece of content is for the left eye\n" " --right-eye next piece of content is for the right eye\n" " --channel next piece of content should be mapped to audio channel L, R, C, Lfe, Ls, Rs, BsL, BsR, HI, VI\n" " --gain next piece of content should have the given audio gain (in dB)\n" " --cpl CPL ID to use from the next piece of content (which is a DCP)\n" " --kdm KDM for next piece of content\n"; template void argument_option (int& n, int argc, char* argv[], string short_name, string long_name, bool* claimed, optional* error, T* out) { string const a = argv[n]; if (a != short_name && a != long_name) { return; } if ((n + 1) >= argc) { **error = String::compose("%1: option %2 requires an argument", argv[0], long_name); return; } *out = dcp::raw_convert(string(argv[++n])); *claimed = true; } template void argument_option ( int& n, int argc, char* argv[], string short_name, string long_name, bool* claimed, optional* error, boost::optional* out, std::function (string s)> convert = [](string s) { return dcp::raw_convert(s); } ) { string const a = argv[n]; if (a != short_name && a != long_name) { return; } if ((n + 1) >= argc) { **error = String::compose("%1: option %2 requires an argument", argv[0], long_name); return; } auto const arg = argv[++n]; auto const value = convert(arg); if (!value) { *error = String::compose("%1: %2 is not valid for %3", argv[0], arg, long_name); *claimed = true; return; } *out = value; *claimed = true; } CreateCLI::CreateCLI (int argc, char* argv[]) : version (false) { optional dcp_content_type_string; string container_ratio_string; optional standard_string; int dcp_frame_rate_int = 0; string template_name_string; int64_t video_bit_rate_int = 0; auto next_frame_type = VideoFrameType::TWO_D; optional channel; optional gain; optional kdm; optional cpl; int i = 1; while (i < argc) { string const a = argv[i]; bool claimed = false; if (a == "-v" || a == "--version") { version = true; return; } else if (a == "-h" || a == "--help") { error = "Create a film directory (ready for making a DCP) or metadata file from some content files.\n" "A film directory will be created if -o or --output is specified, otherwise a metadata file\n" "will be written to stdout.\n" + String::compose(_help, argv[0]); return; } if (a == "--no-encrypt") { _no_encrypt = claimed = true; } else if (a == "-e" || a == "--encrypt") { _encrypt = claimed = true; } else if (a == "--no-use-isdcf-name") { _no_use_isdcf_name = claimed = true; } else if (a == "--twod") { _twod = claimed = true; } else if (a == "--threed") { _threed = claimed = true; } else if (a == "--left-eye") { next_frame_type = VideoFrameType::THREE_D_LEFT; claimed = true; } else if (a == "--right-eye") { next_frame_type = VideoFrameType::THREE_D_RIGHT; claimed = true; } else if (a == "--twok") { _twok = true; claimed = true; } else if (a == "--fourk") { _fourk = true; claimed = true; } std::function (string s)> string_to_string = [](string s) { return s; }; std::function (string s)> string_to_path = [](string s) { return boost::filesystem::path(s); }; std::function (string s)> string_to_nonzero_int = [](string s) { auto const value = dcp::raw_convert(s); if (value == 0) { return boost::optional(); } return boost::optional(value); }; argument_option(i, argc, argv, "-n", "--name", &claimed, &error, &_name); argument_option(i, argc, argv, "-t", "--template", &claimed, &error, &template_name_string); /* See comment below about --cpl */ argument_option(i, argc, argv, "-c", "--dcp-content-type", &claimed, &error, &dcp_content_type_string, string_to_string); argument_option(i, argc, argv, "-f", "--dcp-frame-rate", &claimed, &error, &dcp_frame_rate_int); argument_option(i, argc, argv, "", "--container-ratio", &claimed, &error, &container_ratio_string); argument_option(i, argc, argv, "-s", "--still-length", &claimed, &error, &still_length, string_to_nonzero_int); /* See comment below about --cpl */ argument_option(i, argc, argv, "", "--standard", &claimed, &error, &standard_string, string_to_string); argument_option(i, argc, argv, "", "--config", &claimed, &error, &config_dir, string_to_path); argument_option(i, argc, argv, "-o", "--output", &claimed, &error, &output_dir, string_to_path); argument_option(i, argc, argv, "", "--video-bit-rate", &claimed, &error, &video_bit_rate_int); std::function (string)> convert_channel = [](string channel) -> optional{ if (channel == "L") { return dcp::Channel::LEFT; } else if (channel == "R") { return dcp::Channel::RIGHT; } else if (channel == "C") { return dcp::Channel::CENTRE; } else if (channel == "Lfe") { return dcp::Channel::LFE; } else if (channel == "Ls") { return dcp::Channel::LS; } else if (channel == "Rs") { return dcp::Channel::RS; } else if (channel == "BsL") { return dcp::Channel::BSL; } else if (channel == "BsR") { return dcp::Channel::BSR; } else if (channel == "HI") { return dcp::Channel::HI; } else if (channel == "VI") { return dcp::Channel::VI; } else if (channel == "SLV") { return dcp::Channel::SIGN_LANGUAGE; } else { return {}; } }; argument_option(i, argc, argv, "", "--channel", &claimed, &error, &channel, convert_channel); argument_option(i, argc, argv, "", "--gain", &claimed, &error, &gain); argument_option(i, argc, argv, "", "--kdm", &claimed, &error, &kdm, string_to_path); /* It shouldn't be necessary to use this string_to_string here, but using the other argument_option() * causes an odd compile error on Ubuntu 18.04. */ argument_option(i, argc, argv, "", "--cpl", &claimed, &error, &cpl, string_to_string); if (!claimed) { if (a.length() > 2 && a.substr(0, 2) == "--") { error = String::compose("%1: unrecognised option '%2'", argv[0], a) + String::compose(_help, argv[0]); return; } else { Content c; c.path = a; c.frame_type = next_frame_type; c.channel = channel; c.gain = gain; c.kdm = kdm; c.cpl = cpl; content.push_back (c); next_frame_type = VideoFrameType::TWO_D; channel = {}; gain = {}; } } ++i; } if (!template_name_string.empty()) { _template_name = template_name_string; } if (dcp_frame_rate_int) { dcp_frame_rate = dcp_frame_rate_int; } if (video_bit_rate_int) { _video_bit_rate = video_bit_rate_int * 1000000; } if (dcp_content_type_string) { _dcp_content_type = DCPContentType::from_isdcf_name(*dcp_content_type_string); if (!_dcp_content_type) { error = String::compose("%1: unrecognised DCP content type '%2'", argv[0], *dcp_content_type_string); return; } } if (!container_ratio_string.empty()) { _container_ratio = Ratio::from_id (container_ratio_string); if (!_container_ratio) { error = String::compose("%1: unrecognised container ratio %2", argv[0], container_ratio_string); return; } } if (standard_string) { if (*standard_string == "interop") { _standard = dcp::Standard::INTEROP; } else if (*standard_string == "SMPTE") { _standard = dcp::Standard::SMPTE; } else { error = String::compose("%1: standard must be SMPTE or interop", argv[0]); return; } } if (_twod && _threed) { error = String::compose("%1: specify one of --twod or --threed, not both", argv[0]); } if (_no_encrypt && _encrypt) { error = String::compose("%1: specify one of --no-encrypt or --encrypt, not both", argv[0]); } if (content.empty()) { error = String::compose("%1: no content specified", argv[0]); return; } if (_name.empty()) { _name = content[0].path.filename().string(); } if (_video_bit_rate && (*_video_bit_rate < 10000000 || *_video_bit_rate > Config::instance()->maximum_video_bit_rate(VideoEncoding::JPEG2000))) { error = String::compose("%1: video-bit-rate must be between 10 and %2 Mbit/s", argv[0], (Config::instance()->maximum_video_bit_rate(VideoEncoding::JPEG2000) / 1000000)); return; } } shared_ptr CreateCLI::make_film() const { auto film = std::make_shared(output_dir); dcpomatic_log = film->log(); dcpomatic_log->set_types(Config::instance()->log_types()); if (_template_name) { film->use_template(_template_name.get()); } else { /* No template: apply our own CLI tool defaults to override the ones in Config. * Maybe one day there will be no defaults in Config any more (as they'll be in * a default template) and we can decide whether to use the default template * or not. */ film->set_interop(false); film->set_dcp_content_type(DCPContentType::from_isdcf_name("TST")); } film->set_name(_name); if (_container_ratio) { film->set_container(_container_ratio); } if (_dcp_content_type) { film->set_dcp_content_type(_dcp_content_type); } if (_standard) { film->set_interop(*_standard == dcp::Standard::INTEROP); } film->set_use_isdcf_name(!_no_use_isdcf_name); if (_no_encrypt) { film->set_encrypted(false); } else if (_encrypt) { film->set_encrypted(true); } if (_twod) { film->set_three_d(false); } else if (_threed) { film->set_three_d(true); } if (_twok) { film->set_resolution(Resolution::TWO_K); } if (_fourk) { film->set_resolution(Resolution::FOUR_K); } if (_video_bit_rate) { film->set_video_bit_rate(VideoEncoding::JPEG2000, *_video_bit_rate); } int channels = 6; for (auto cli_content: content) { if (cli_content.channel) { channels = std::max(channels, static_cast(*cli_content.channel) + 1); } } if (channels % 2) { ++channels; } film->set_audio_channels(channels); return film; }