/*
- 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.
#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"
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>\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"
- " --formulation 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"
- " --certificate file containing projector certificate\n"
- " --cinemas list known cinemas from the DCP-o-matic settings\n"
- " --dkdm-cpls list CPLs for which DCP-o-matic has DKDMs\n\n"
+ cerr << "Syntax: " << program_name << " [OPTION] <FILM|CPL-ID|DKDM>\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
}
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,
+ dcp::NameFormat::Map values,
+ 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(),
+ container_name_format,
+ filename_format,
values,
bind (&always_overwrite)
);
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, values,
bind (&always_overwrite)
);
void
from_film (
+ list<shared_ptr<Screen> > screens,
boost::filesystem::path film_dir,
bool verbose,
- optional<string> cinema_name,
- optional<boost::filesystem::path> output,
- optional<boost::filesystem::path> certificate_file,
+ 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
)
{
boost::filesystem::path cpl = cpls.front().cpl_file;
- if (!cinema_name) {
-
- if (!output) {
- error ("you must specify --output");
- }
+ dcp::NameFormat::Map values;
- dcp::Certificate certificate (dcp::file_to_string (*certificate_file));
- dcp::EncryptedKDM kdm = film->make_kdm (
- certificate, vector<dcp::Certificate>(), cpl, dcp::LocalTime (valid_from), dcp::LocalTime (valid_to), formulation
- );
- kdm.as_xml (*output);
- if (verbose) {
- cout << "Generated KDM " << *output << " for certificate.\n";
- }
- } else {
-
- if (!output) {
- output = ".";
+ try {
+ list<KDMWithMetadataPtr> kdms;
+
+ BOOST_FOREACH (shared_ptr<Screen> i, screens) {
+ if (i->recipient) {
+
+ dcp::LocalTime const begin(valid_from, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0);
+ dcp::LocalTime const end(valid_to, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0);
+
+ dcp::EncryptedKDM const kdm = film->make_kdm (
+ i->recipient.get(),
+ i->trusted_device_thumbprints(),
+ cpl,
+ 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'] = film->name();
+ name_values['b'] = dcp::LocalTime(begin).date() + " " + dcp::LocalTime(begin).time_of_day(true, false);
+ name_values['e'] = dcp::LocalTime(end).date() + " " + dcp::LocalTime(end).time_of_day(true, false);
+
+ kdms.push_back (KDMWithMetadataPtr(new DCPKDMWithMetadata(name_values, i->cinema, kdm)));
+ }
}
- 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 (
- find_cinema(*cinema_name)->screens(), cpl, valid_from, valid_to, formulation
- );
-
- write_files (screen_kdms, zip, *output, values, 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);
- }
+ write_files (kdms, zip, output, container_name_format, filename_format, values, 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);
}
}
dcp::EncryptedKDM
kdm_from_dkdm (
- dcp::EncryptedKDM 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
)
{
- /* Decrypted DKDM */
- dcp::DecryptedKDM decrypted_dkdm (dkdm, Config::instance()->decryption_chain()->key().get());
-
/* Signer for new KDM */
shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
if (!signer->valid ()) {
dcp::LocalTime().as_string()
);
- BOOST_FOREACH (dcp::DecryptedKDMKey const & j, decrypted_dkdm.keys()) {
+ BOOST_FOREACH (dcp::DecryptedKDMKey const & j, dkdm.keys()) {
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
from_dkdm (
- dcp::EncryptedKDM dkdm,
+ list<shared_ptr<Screen> > screens,
+ dcp::DecryptedKDM dkdm,
bool verbose,
- optional<string> cinema_name,
- optional<boost::filesystem::path> output,
- optional<boost::filesystem::path> certificate_file,
+ 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 (!cinema_name) {
- if (!output) {
- error ("you must specify --output");
- }
-
- dcp::EncryptedKDM kdm = kdm_from_dkdm (
- dkdm,
- dcp::Certificate (dcp::file_to_string (*certificate_file)),
- vector<dcp::Certificate>(),
- dcp::LocalTime(valid_from), dcp::LocalTime(valid_to),
- formulation
- );
+ dcp::NameFormat::Map values;
- kdm.as_xml (*output);
- if (verbose) {
- cout << "Generated KDM " << *output << " for certificate.\n";
- }
- } else {
-
- if (!output) {
- output = ".";
- }
+ try {
+ list<KDMWithMetadataPtr> kdms;
+ BOOST_FOREACH (shared_ptr<Screen> i, screens) {
+ if (!i->recipient) {
+ continue;
+ }
- 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;
- BOOST_FOREACH (shared_ptr<Screen> i, find_cinema(*cinema_name)->screens()) {
- if (!i->recipient) {
- continue;
- }
- screen_kdms.push_back (
- ScreenKDM (
- i,
- kdm_from_dkdm (
+ 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::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);
+
+ kdms.push_back (
+ KDMWithMetadataPtr(
+ new DCPKDMWithMetadata(
+ name_values,
+ i->cinema,
+ 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
+ i->trusted_device_thumbprints(),
+ begin,
+ end,
+ formulation,
+ disable_forensic_marking_picture,
+ disable_forensic_marking_audio
)
)
- );
- }
- write_files (screen_kdms, zip, *output, values, 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);
+ )
+ );
}
+ write_files (kdms, zip, output, container_name_format, filename_format, values, 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);
}
}
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;
+ string screen_description = "";
+ list<shared_ptr<Screen> > screens;
+ optional<dcp::EncryptedKDM> dkdm;
optional<boost::posix_time::ptime> valid_from;
optional<boost::posix_time::ptime> valid_to;
- optional<boost::filesystem::path> certificate_file;
bool zip = false;
- optional<string> cinema_name;
- bool cinemas = false;
- bool dkdm_cpls = false;
+ bool list_cinemas = false;
+ bool list_dkdm_cpls = false;
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];
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'},
- { "certificate", required_argument, 0, 'A' },
- { "cinema", required_argument, 0, 'c' },
- { "cinemas", no_argument, 0, 'B' },
- { "dkdm-cpls", no_argument, 0, 'D' },
+ { "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' },
- { "duration", required_argument, 0, 'd' },
{ "verbose", no_argument, 0, 'v' },
- { "formulation", required_argument, 0, 'C' },
+ { "cinema", required_argument, 0, 'c' },
+ { "screen", required_argument, 0, 'S' },
+ { "certificate", required_argument, 0, 'C' },
+ { "trusted-device", required_argument, 0, 'T' },
+ { "list-cinemas", no_argument, 0, 'B' },
+ { "list-dkdm-cpls", no_argument, 0, 'D' },
{ 0, 0, 0, 0 }
};
- int c = getopt_long (argc, argv, "ho:f:t:c:A:Bzd:vC:D", 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;
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;
case 't':
valid_to = time_from_string (optarg);
break;
- case 'A':
- certificate_file = optarg;
- break;
- case 'c':
- cinema_name = optarg;
- break;
- case 'B':
- cinemas = true;
- break;
- case 'D':
- dkdm_cpls = true;
- break;
- case 'z':
- zip = true;
- break;
case 'd':
duration_string = optarg;
break;
- case 'v':
- verbose = true;
- break;
- case 'C':
+ case 'F':
if (string (optarg) == "modified-transitional-1") {
formulation = dcp::MODIFIED_TRANSITIONAL_1;
+ } else if (string (optarg) == "multiple-modified-transitional-1") {
+ formulation = dcp::MULTIPLE_MODIFIED_TRANSITIONAL_1;
} else if (string (optarg) == "dci-any") {
formulation = dcp::DCI_ANY;
} else if (string (optarg) == "dci-specific") {
} else {
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;
+ case 'v':
+ verbose = true;
+ break;
+ case 'c':
+ /* 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));
+ break;
+ case 'S':
+ screen_description = optarg;
+ break;
+ case 'C':
+ {
+ /* 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':
+ /* 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;
+ break;
+ case 'D':
+ list_dkdm_cpls = true;
+ break;
}
}
- if (cinemas) {
+ if (list_cinemas) {
list<boost::shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
for (list<boost::shared_ptr<Cinema> >::const_iterator i = cinemas.begin(); i != cinemas.end(); ++i) {
cout << (*i)->name << " (" << Emailer::address_list ((*i)->emails) << ")\n";
exit (EXIT_SUCCESS);
}
- if (dkdm_cpls) {
+ if (list_dkdm_cpls) {
dump_dkdm_group (Config::instance()->dkdms(), 0);
exit (EXIT_SUCCESS);
}
exit (EXIT_FAILURE);
}
- if (!cinema_name && !certificate_file) {
- error ("you must specify either a cinema, a screen or a certificate file");
+ if (screens.empty()) {
+ if (!cinema_name) {
+ error ("you must specify either a cinema or one or more screens using certificate files");
+ }
+
+ screens = find_cinema (*cinema_name)->screens ();
}
if (duration_string) {
string const thing = argv[optind];
if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
- from_film (thing, verbose, cinema_name, output, certificate_file, *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 {
- optional<dcp::EncryptedKDM> dkdm = find_dkdm (thing);
+ if (boost::filesystem::is_regular_file(thing)) {
+ dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
+ } else {
+ dkdm = find_dkdm (thing);
+ }
+
if (!dkdm) {
error ("could not find film or CPL ID corresponding to " + thing);
}
- from_dkdm (*dkdm, verbose, cinema_name, output, certificate_file, *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;