Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / tools / dcpomatic_kdm_cli.cc
index f8383d98c8b3d47e03528ce1da93bf4f6e4c7700..a3075d6752ac2d7187eeb8cedbc3b2757bee7a3b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -24,8 +24,7 @@
 
 #include "lib/film.h"
 #include "lib/cinema.h"
-#include "lib/screen_kdm.h"
-#include "lib/cinema_kdms.h"
+#include "lib/kdm_with_metadata.h"
 #include "lib/config.h"
 #include "lib/exceptions.h"
 #include "lib/emailer.h"
@@ -42,34 +41,40 @@ using std::cout;
 using std::cerr;
 using std::list;
 using std::vector;
+using std::runtime_error;
 using boost::shared_ptr;
 using boost::optional;
 using boost::bind;
 using boost::dynamic_pointer_cast;
+using namespace dcpomatic;
 
 static void
 help ()
 {
        cerr << "Syntax: " << program_name << " [OPTION] <FILM|CPL-ID|DKDM>\n"
-    "  -h, --help             show this help\n"
-    "  -o, --output           output file or directory\n"
-    "  -f, --valid-from       valid from time (in local time zone of the cinema) (e.g. \"2013-09-28 01:41:51\") or \"now\"\n"
-    "  -t, --valid-to         valid to time (in local time zone of the cinema) (e.g. \"2014-09-28 01:41:51\")\n"
-    "  -d, --valid-duration   valid duration (e.g. \"1 day\", \"4 hours\", \"2 weeks\")\n"
-    "  -F, --formulation      modified-transitional-1, multiple-modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]\n"
-    "  -z, --zip              ZIP each cinema's KDMs into its own file\n"
-    "  -v, --verbose          be verbose\n"
-    "  -c, --cinema           specify a cinema, either by name or email address\n"
-    "  -S, --screen           screen description\n"
-    "  -C, --certificate      file containing projector certificate\n"
-    "  -T, --trusted-device   file containing a trusted device's certificate\n"
-    "      --list-cinemas     list known cinemas from the DCP-o-matic settings\n"
-    "      --list-dkdm-cpls   list CPLs for which DCP-o-matic has DKDMs\n\n"
+               "  -h, --help                               show this help\n"
+               "  -o, --output                             output file or directory\n"
+               "  -K, --filename-format                    filename format for KDMs\n"
+               "  -Z, --container-name-format              filename format for ZIP containers\n"
+               "  -f, --valid-from                         valid from time (in local time zone of the cinema) (e.g. \"2013-09-28 01:41:51\") or \"now\"\n"
+               "  -t, --valid-to                           valid to time (in local time zone of the cinema) (e.g. \"2014-09-28 01:41:51\")\n"
+               "  -d, --valid-duration                     valid duration (e.g. \"1 day\", \"4 hours\", \"2 weeks\")\n"
+               "  -F, --formulation                        modified-transitional-1, multiple-modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]\n"
+               "  -a, --disable-forensic-marking-picture   disable forensic marking of pictures essences\n"
+               "  -a, --disable-forensic-marking-audio     disable forensic marking of audio essences (optionally above a given channel, e.g 12)\n"
+               "  -z, --zip                                ZIP each cinema's KDMs into its own file\n"
+               "  -v, --verbose                            be verbose\n"
+               "  -c, --cinema                             specify a cinema, either by name or email address\n"
+               "  -S, --screen                             screen description\n"
+               "  -C, --certificate                        file containing projector certificate\n"
+               "  -T, --trusted-device                     file containing a trusted device's certificate\n"
+               "      --list-cinemas                       list known cinemas from the DCP-o-matic settings\n"
+               "      --list-dkdm-cpls                     list CPLs for which DCP-o-matic has DKDMs\n\n"
                "CPL-ID must be the ID of a CPL that is mentioned in DCP-o-matic's DKDM list.\n\n"
                "For example:\n\n"
                "Create KDMs for my_great_movie to play in all of Fred's Cinema's screens for the next two weeks and zip them up.\n"
                "(Fred's Cinema must have been set up in DCP-o-matic's KDM window)\n\n"
-               "\tdcpomatic_kdm -c \"Fred's Cinema\" -f now -d \"2 weeks\" -z my_great_movie\n\n";
+               "\t" << program_name << " -c \"Fred's Cinema\" -f now -d \"2 weeks\" -z my_great_movie\n\n";
 }
 
 static void
@@ -123,15 +128,21 @@ always_overwrite ()
 }
 
 void
-write_files (list<ScreenKDM> screen_kdms, bool zip, boost::filesystem::path output, dcp::NameFormat::Map values, bool verbose)
+write_files (
+       list<KDMWithMetadataPtr> kdms,
+       bool zip,
+       boost::filesystem::path output,
+       dcp::NameFormat container_name_format,
+       dcp::NameFormat filename_format,
+       bool verbose
+       )
 {
        if (zip) {
-               int const N = CinemaKDMs::write_zip_files (
-                       CinemaKDMs::collect (screen_kdms),
+               int const N = write_zip_files (
+                       collect (kdms),
                        output,
-                       Config::instance()->kdm_container_name_format(),
-                       Config::instance()->kdm_filename_format(),
-                       values,
+                       container_name_format,
+                       filename_format,
                        bind (&always_overwrite)
                        );
 
@@ -139,8 +150,8 @@ write_files (list<ScreenKDM> screen_kdms, bool zip, boost::filesystem::path outp
                        cout << "Wrote " << N << " ZIP files to " << output << "\n";
                }
        } else {
-               int const N = ScreenKDM::write_files (
-                       screen_kdms, output, Config::instance()->kdm_filename_format(), values,
+               int const N = write_files (
+                       kdms, output, filename_format,
                        bind (&always_overwrite)
                        );
 
@@ -176,10 +187,14 @@ from_film (
        list<shared_ptr<Screen> > screens,
        boost::filesystem::path film_dir,
        bool verbose,
-       optional<boost::filesystem::path> output,
+       boost::filesystem::path output,
+       dcp::NameFormat container_name_format,
+       dcp::NameFormat filename_format,
        boost::posix_time::ptime valid_from,
        boost::posix_time::ptime valid_to,
        dcp::Formulation formulation,
+       bool disable_forensic_marking_picture,
+       optional<int> disable_forensic_marking_audio,
        bool zip
        )
 {
@@ -205,27 +220,24 @@ from_film (
 
        boost::filesystem::path cpl = cpls.front().cpl_file;
 
-       if (!output) {
-               output = ".";
-       }
-
-       dcp::NameFormat::Map values;
-       values['f'] = film->name();
-       values['b'] = dcp::LocalTime(valid_from).date() + " " + dcp::LocalTime(valid_from).time_of_day(true, false);
-       values['e'] = dcp::LocalTime(valid_to).date() + " " + dcp::LocalTime(valid_to).time_of_day(true, false);
-
        try {
-               list<ScreenKDM> screen_kdms = film->make_kdms (
-                       screens, cpl, valid_from, valid_to, formulation
-                       );
-
-               write_files (screen_kdms, zip, *output, values, verbose);
+               list<KDMWithMetadataPtr> kdms;
+               BOOST_FOREACH (shared_ptr<Screen> i, screens) {
+                       KDMWithMetadataPtr p = kdm_for_screen (film, cpl, i, valid_from, valid_to, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
+                       if (p) {
+                               kdms.push_back (p);
+                       }
+               }
+               write_files (kdms, zip, output, container_name_format, filename_format, verbose);
        } catch (FileError& e) {
                cerr << program_name << ": " << e.what() << " (" << e.file().string() << ")\n";
                exit (EXIT_FAILURE);
        } catch (KDMError& e) {
                cerr << program_name << ": " << e.what() << "\n";
                exit (EXIT_FAILURE);
+       } catch (runtime_error& e) {
+               cerr << program_name << ": " << e.what() << "\n";
+               exit (EXIT_FAILURE);
        }
 }
 
@@ -261,10 +273,12 @@ dcp::EncryptedKDM
 kdm_from_dkdm (
        dcp::DecryptedKDM dkdm,
        dcp::Certificate target,
-       vector<dcp::Certificate> trusted_devices,
+       vector<string> trusted_devices,
        dcp::LocalTime valid_from,
        dcp::LocalTime valid_to,
-       dcp::Formulation formulation
+       dcp::Formulation formulation,
+       bool disable_forensic_marking_picture,
+       optional<int> disable_forensic_marking_audio
        )
 {
        /* Signer for new KDM */
@@ -286,7 +300,7 @@ kdm_from_dkdm (
                kdm.add_key(j);
        }
 
-       return kdm.encrypt (signer, target, trusted_devices, formulation);
+       return kdm.encrypt (signer, target, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
 }
 
 void
@@ -294,43 +308,51 @@ from_dkdm (
        list<shared_ptr<Screen> > screens,
        dcp::DecryptedKDM dkdm,
        bool verbose,
-       optional<boost::filesystem::path> output,
+       boost::filesystem::path output,
+       dcp::NameFormat container_name_format,
+       dcp::NameFormat filename_format,
        boost::posix_time::ptime valid_from,
        boost::posix_time::ptime valid_to,
        dcp::Formulation formulation,
+       bool disable_forensic_marking_picture,
+       optional<int> disable_forensic_marking_audio,
        bool zip
        )
 {
-       if (!output) {
-               output = ".";
-       }
-
        dcp::NameFormat::Map values;
-       values['f'] = dkdm.annotation_text().get_value_or("");
-       values['b'] = dcp::LocalTime(valid_from).date() + " " + dcp::LocalTime(valid_from).time_of_day(true, false);
-       values['e'] = dcp::LocalTime(valid_to).date() + " " + dcp::LocalTime(valid_to).time_of_day(true, false);
 
        try {
-               list<ScreenKDM> screen_kdms;
+               list<KDMWithMetadataPtr> kdms;
                BOOST_FOREACH (shared_ptr<Screen> i, screens) {
                        if (!i->recipient) {
                                continue;
                        }
-                       screen_kdms.push_back (
-                               ScreenKDM (
-                                       i,
-                                       kdm_from_dkdm (
-                                               dkdm,
-                                               i->recipient.get(),
-                                               i->trusted_devices,
-                                               dcp::LocalTime(valid_from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
-                                               dcp::LocalTime(valid_to, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
-                                               formulation
-                                               )
-                                       )
-                               );
+
+                       dcp::LocalTime begin(valid_from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
+                       dcp::LocalTime end(valid_to, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
+
+                       dcp::EncryptedKDM const kdm = kdm_from_dkdm(
+                                                       dkdm,
+                                                       i->recipient.get(),
+                                                       i->trusted_device_thumbprints(),
+                                                       begin,
+                                                       end,
+                                                       formulation,
+                                                       disable_forensic_marking_picture,
+                                                       disable_forensic_marking_audio
+                                                       );
+
+                       dcp::NameFormat::Map name_values;
+                       name_values['c'] = i->cinema->name;
+                       name_values['s'] = i->name;
+                       name_values['f'] = dkdm.annotation_text().get_value_or("");
+                       name_values['b'] = begin.date() + " " + begin.time_of_day(true, false);
+                       name_values['e'] = end.date() + " " + end.time_of_day(true, false);
+                       name_values['i'] = kdm.cpl_id();
+
+                       kdms.push_back (KDMWithMetadataPtr(new DCPKDMWithMetadata(name_values, i->cinema, kdm)));
                }
-               write_files (screen_kdms, zip, *output, values, verbose);
+               write_files (kdms, zip, output, container_name_format, filename_format, verbose);
        } catch (FileError& e) {
                cerr << program_name << ": " << e.what() << " (" << e.file().string() << ")\n";
                exit (EXIT_FAILURE);
@@ -366,13 +388,13 @@ dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent)
 
 int main (int argc, char* argv[])
 {
-       optional<boost::filesystem::path> output;
+       boost::filesystem::path output = ".";
+       dcp::NameFormat container_name_format = Config::instance()->kdm_container_name_format();
+       dcp::NameFormat filename_format = Config::instance()->kdm_filename_format();
        optional<string> cinema_name;
        shared_ptr<Cinema> cinema;
-       optional<string> screen_description;
+       string screen_description = "";
        list<shared_ptr<Screen> > screens;
-       optional<dcp::Certificate> certificate;
-       vector<dcp::Certificate> trusted_devices;
        optional<dcp::EncryptedKDM> dkdm;
        optional<boost::posix_time::ptime> valid_from;
        optional<boost::posix_time::ptime> valid_to;
@@ -382,6 +404,8 @@ int main (int argc, char* argv[])
        optional<string> duration_string;
        bool verbose = false;
        dcp::Formulation formulation = dcp::MODIFIED_TRANSITIONAL_1;
+       bool disable_forensic_marking_picture = false;
+       optional<int> disable_forensic_marking_audio;
 
        program_name = argv[0];
 
@@ -390,10 +414,14 @@ int main (int argc, char* argv[])
                static struct option long_options[] = {
                        { "help", no_argument, 0, 'h'},
                        { "output", required_argument, 0, 'o'},
+                       { "filename-format", required_argument, 0, 'K'},
+                       { "container-name-format", required_argument, 0, 'Z'},
                        { "valid-from", required_argument, 0, 'f'},
                        { "valid-to", required_argument, 0, 't'},
                        { "valid-duration", required_argument, 0, 'd'},
                        { "formulation", required_argument, 0, 'F' },
+                       { "disable-forensic-marking-picture", no_argument, 0, 'p' },
+                       { "disable-forensic-marking-audio", optional_argument, 0, 'a' },
                        { "zip", no_argument, 0, 'z' },
                        { "verbose", no_argument, 0, 'v' },
                        { "cinema", required_argument, 0, 'c' },
@@ -405,7 +433,7 @@ int main (int argc, char* argv[])
                        { 0, 0, 0, 0 }
                };
 
-               int c = getopt_long (argc, argv, "ho:f:t:d:F:zvc:S:C:T:BD", long_options, &option_index);
+               int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pa::zvc:S:C:T:BD", long_options, &option_index);
 
                if (c == -1) {
                        break;
@@ -418,6 +446,12 @@ int main (int argc, char* argv[])
                case 'o':
                        output = optarg;
                        break;
+               case 'K':
+                       filename_format = dcp::NameFormat (optarg);
+                       break;
+               case 'Z':
+                       container_name_format = dcp::NameFormat (optarg);
+                       break;
                case 'f':
                        valid_from = time_from_string (optarg);
                        break;
@@ -440,6 +474,17 @@ int main (int argc, char* argv[])
                                error ("unrecognised KDM formulation " + string (optarg));
                        }
                        break;
+               case 'p':
+                       disable_forensic_marking_picture = true;
+                       break;
+               case 'a':
+                       disable_forensic_marking_audio = 0;
+                       if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
+                               disable_forensic_marking_audio = atoi (argv[optind++]);
+                       } else if (optarg) {
+                               disable_forensic_marking_audio = atoi (optarg);
+                       }
+                       break;
                case 'z':
                        zip = true;
                        break;
@@ -447,33 +492,32 @@ int main (int argc, char* argv[])
                        verbose = true;
                        break;
                case 'c':
-                       if (certificate) {
-                               if (!screen_description) {
-                                       screen_description = "";
-                               }
-
-                               shared_ptr<Screen> screen (new Screen (*screen_description, certificate, trusted_devices));
-                               if (cinema_name) {
-                                       cinema->add_screen (screen);
-                               }
-                               screens.push_back (screen);
-
-                               certificate = boost::none;
-                               screen_description = boost::none;
-                               trusted_devices = vector<dcp::Certificate> ();
-                       }
-
+                       /* This could be a cinema to search for in the configured list or the name of a cinema being
+                          built up on-the-fly in the option.  Cater for both possilibities here by storing the name
+                          (for lookup) and by creating a Cinema which the next Screen will be added to.
+                       */
                        cinema_name = optarg;
-                       cinema = shared_ptr<Cinema> (new Cinema (optarg, list<string> (), "", 0, 0 ));
+                       cinema = shared_ptr<Cinema> (new Cinema (optarg, list<string>(), "", 0, 0));
                        break;
                case 'S':
                        screen_description = optarg;
                        break;
                case 'C':
-                       certificate = dcp::Certificate (dcp::file_to_string (optarg));
+               {
+                       /* Make a new screen and add it to the current cinema */
+                       dcp::CertificateChain chain (dcp::file_to_string(optarg));
+                       shared_ptr<Screen> screen (new Screen (screen_description, "", chain.leaf(), vector<TrustedDevice>()));
+                       if (cinema) {
+                               cinema->add_screen (screen);
+                       }
+                       screens.push_back (screen);
                        break;
+               }
                case 'T':
-                       trusted_devices.push_back (dcp::Certificate (dcp::file_to_string (optarg)));
+                       /* A trusted device ends up in the last screen we made */
+                       if (!screens.empty ()) {
+                               screens.back()->trusted_devices.push_back(TrustedDevice(dcp::Certificate(dcp::file_to_string(optarg))));
+                       }
                        break;
                case 'B':
                        list_cinemas = true;
@@ -497,18 +541,6 @@ int main (int argc, char* argv[])
                exit (EXIT_SUCCESS);
        }
 
-       if (certificate) {
-               if (!screen_description) {
-                       screen_description = "";
-               }
-
-               shared_ptr<Screen> screen (new Screen (*screen_description, certificate, trusted_devices));
-               if (cinema_name) {
-                       cinema->add_screen (screen);
-               }
-               screens.push_back (screen);
-       }
-
        if (!duration_string && !valid_to) {
                error ("you must specify a --valid-duration or --valid-to");
        }
@@ -529,8 +561,6 @@ int main (int argc, char* argv[])
                }
 
                screens = find_cinema (*cinema_name)->screens ();
-       }       else if (!cinema_name && !output) {
-               error ("you must specify either a cinema name or output format");
        }
 
        if (duration_string) {
@@ -546,7 +576,20 @@ int main (int argc, char* argv[])
 
        string const thing = argv[optind];
        if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
-               from_film (screens, thing, verbose, output, *valid_from, *valid_to, formulation, zip);
+               from_film (
+                       screens,
+                       thing,
+                       verbose,
+                       output,
+                       container_name_format,
+                       filename_format,
+                       *valid_from,
+                       *valid_to,
+                       formulation,
+                       disable_forensic_marking_picture,
+                       disable_forensic_marking_audio,
+                       zip
+                       );
        } else {
                if (boost::filesystem::is_regular_file(thing)) {
                        dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
@@ -558,7 +601,20 @@ int main (int argc, char* argv[])
                        error ("could not find film or CPL ID corresponding to " + thing);
                }
 
-               from_dkdm (screens, dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()), verbose, output, *valid_from, *valid_to, formulation, zip);
+               from_dkdm (
+                       screens,
+                       dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
+                       verbose,
+                       output,
+                       container_name_format,
+                       filename_format,
+                       *valid_from,
+                       *valid_to,
+                       formulation,
+                       disable_forensic_marking_picture,
+                       disable_forensic_marking_audio,
+                       zip
+                       );
        }
 
        return 0;