Use plain git hash for VERSION when there is no exact tag.
[dcpomatic.git] / src / lib / create_cli.cc
index 2ca17f91b002ba4b8339c5afb2945a04a48f3165..1c2f2c6354fcf3ef4f2edf73096c9add9af39c22 100644 (file)
 #include "config.h"
 #include "create_cli.h"
 #include "dcp_content_type.h"
+#include "dcpomatic_log.h"
+#include "film.h"
 #include "ratio.h"
 #include <dcp/raw_convert.h>
 #include <iostream>
 #include <string>
 
 
-using std::string;
 using std::cout;
+using std::make_shared;
+using std::shared_ptr;
+using std::string;
+using std::vector;
 using boost::optional;
 
 
@@ -40,6 +45,7 @@ string CreateCLI::_help =
        "  -h, --help                    show this help\n"
        "  -n, --name <name>             film name\n"
        "  -t, --template <name>         template name\n"
+       "      --no-encrypt              make an unencrypted DCP\n"
        "  -e, --encrypt                 make an encrypted DCP\n"
        "  -c, --dcp-content-type <type> FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV\n"
        "  -f, --dcp-frame-rate <rate>   set DCP video frame rate (otherwise guessed from content)\n"
@@ -51,12 +57,14 @@ string CreateCLI::_help =
        "      --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 <dir>            output directory\n"
+       "      --twod                    make a 2D DCP\n"
        "      --threed                  make a 3D DCP\n"
        "      --j2k-bandwidth <Mbit/s>  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 <channel>       next piece of content should be mapped to audio channel L, R, C, Lfe, Ls or Rs\n"
+       "      --channel <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 <id>                CPL ID to use from the next piece of content (which is a DCP)\n"
        "      --kdm <file>              KDM for next piece of content\n";
 
 
@@ -118,19 +126,10 @@ argument_option (
 
 CreateCLI::CreateCLI (int argc, char* argv[])
        : version (false)
-       , encrypt (false)
-       , threed (false)
-       , dcp_content_type (nullptr)
-       , container_ratio (nullptr)
-       , still_length (10)
-       , standard (dcp::Standard::SMPTE)
-       , no_use_isdcf_name (false)
-       , twok (false)
-       , fourk (false)
 {
-       string dcp_content_type_string = "TST";
+       optional<string> dcp_content_type_string;
        string container_ratio_string;
-       string standard_string = "SMPTE";
+       optional<string> standard_string;
        int dcp_frame_rate_int = 0;
        string template_name_string;
        int j2k_bandwidth_int = 0;
@@ -138,6 +137,7 @@ CreateCLI::CreateCLI (int argc, char* argv[])
        optional<dcp::Channel> channel;
        optional<float> gain;
        optional<boost::filesystem::path> kdm;
+       optional<string> cpl;
 
        int i = 1;
        while (i < argc) {
@@ -154,12 +154,16 @@ CreateCLI::CreateCLI (int argc, char* argv[])
                        return;
                }
 
-               if (a == "-e" || a == "--encrypt") {
-                       encrypt = claimed = true;
+               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;
+                       _no_use_isdcf_name = claimed = true;
+               } else if (a == "--twod") {
+                       _twod = claimed = true;
                } else if (a == "--threed") {
-                       threed = claimed = true;
+                       _threed = claimed = true;
                } else if (a == "--left-eye") {
                        next_frame_type = VideoFrameType::THREE_D_LEFT;
                        claimed = true;
@@ -167,24 +171,38 @@ CreateCLI::CreateCLI (int argc, char* argv[])
                        next_frame_type = VideoFrameType::THREE_D_RIGHT;
                        claimed = true;
                } else if (a == "--twok") {
-                       twok = true;
+                       _twok = true;
                        claimed = true;
                } else if (a == "--fourk") {
-                       fourk = true;
+                       _fourk = true;
                        claimed = true;
                }
 
+               std::function<optional<string> (string s)> string_to_string = [](string s) {
+                       return s;
+               };
+
                std::function<optional<boost::filesystem::path> (string s)> string_to_path = [](string s) {
                        return boost::filesystem::path(s);
                };
 
-               argument_option(i, argc, argv, "-n", "--name",             &claimed, &error, &name);
+               std::function<optional<int> (string s)> string_to_nonzero_int = [](string s) {
+                       auto const value = dcp::raw_convert<int>(s);
+                       if (value == 0) {
+                               return boost::optional<int>();
+                       }
+                       return boost::optional<int>(value);
+               };
+
+               argument_option(i, argc, argv, "-n", "--name",             &claimed, &error, &_name);
                argument_option(i, argc, argv, "-t", "--template",         &claimed, &error, &template_name_string);
-               argument_option(i, argc, argv, "-c", "--dcp-content-type", &claimed, &error, &dcp_content_type_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);
-               argument_option(i, argc, argv, "",   "--standard",         &claimed, &error, &standard_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, "",   "--j2k-bandwidth",    &claimed, &error, &j2k_bandwidth_int);
@@ -202,6 +220,14 @@ CreateCLI::CreateCLI (int argc, char* argv[])
                                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 {
                                return {};
                        }
@@ -210,6 +236,10 @@ CreateCLI::CreateCLI (int argc, char* argv[])
                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) == "--") {
@@ -222,6 +252,7 @@ CreateCLI::CreateCLI (int argc, char* argv[])
                                c.channel = channel;
                                c.gain = gain;
                                c.kdm = kdm;
+                               c.cpl = cpl;
                                content.push_back (c);
                                next_frame_type = VideoFrameType::TWO_D;
                                channel = {};
@@ -233,7 +264,7 @@ CreateCLI::CreateCLI (int argc, char* argv[])
        }
 
        if (!template_name_string.empty()) {
-               template_name = template_name_string;
+               _template_name = template_name_string;
        }
 
        if (dcp_frame_rate_int) {
@@ -241,30 +272,42 @@ CreateCLI::CreateCLI (int argc, char* argv[])
        }
 
        if (j2k_bandwidth_int) {
-               j2k_bandwidth = j2k_bandwidth_int * 1000000;
+               _j2k_bandwidth = j2k_bandwidth_int * 1000000;
        }
 
-       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 (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) {
+               _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 != "SMPTE" && standard_string != "interop") {
-               error = String::compose("%1: standard must be SMPTE or interop", argv[0]);
-               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 (standard_string == "interop") {
-               standard = dcp::Standard::INTEROP;
+       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()) {
@@ -272,12 +315,78 @@ CreateCLI::CreateCLI (int argc, char* argv[])
                return;
        }
 
-       if (name.empty()) {
-               name = content[0].path.leaf().string();
+       if (_name.empty()) {
+               _name = content[0].path.filename().string();
        }
 
-       if (j2k_bandwidth && (*j2k_bandwidth < 10000000 || *j2k_bandwidth > Config::instance()->maximum_j2k_bandwidth())) {
+       if (_j2k_bandwidth && (*_j2k_bandwidth < 10000000 || *_j2k_bandwidth > Config::instance()->maximum_j2k_bandwidth())) {
                error = String::compose("%1: j2k-bandwidth must be between 10 and %2 Mbit/s", argv[0], (Config::instance()->maximum_j2k_bandwidth() / 1000000));
                return;
        }
 }
+
+
+shared_ptr<Film>
+CreateCLI::make_film() const
+{
+       auto film = std::make_shared<Film>(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 (_j2k_bandwidth) {
+               film->set_j2k_bandwidth(*_j2k_bandwidth);
+       }
+
+       int channels = 6;
+       for (auto cli_content: content) {
+               if (cli_content.channel) {
+                       channels = std::max(channels, static_cast<int>(*cli_content.channel) + 1);
+               }
+       }
+       if (channels % 2) {
+               ++channels;
+       }
+
+       film->set_audio_channels(channels);
+
+       return film;
+}
+