/*
- Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
*/
+
/** @file src/tools/dcpomatic_kdm_cli.cc
* @brief Command-line program to generate KDMs.
*/
-#include "lib/film.h"
+
#include "lib/cinema.h"
-#include "lib/screen_kdm.h"
-#include "lib/cinema_kdms.h"
#include "lib/config.h"
-#include "lib/exceptions.h"
-#include "lib/emailer.h"
#include "lib/dkdm_wrapper.h"
+#include "lib/emailer.h"
+#include "lib/exceptions.h"
+#include "lib/film.h"
+#include "lib/kdm_with_metadata.h"
#include "lib/screen.h"
#include <dcp/certificate.h>
#include <dcp/decrypted_kdm.h>
#include <getopt.h>
#include <iostream>
-using std::string;
-using std::cout;
+
using std::cerr;
+using std::cout;
+using std::dynamic_pointer_cast;
using std::list;
+using std::make_shared;
+using std::runtime_error;
+using std::shared_ptr;
+using std::string;
using std::vector;
-using boost::shared_ptr;
using boost::optional;
using boost::bind;
-using boost::dynamic_pointer_cast;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
+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"
- " -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"
- " -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
error (string m)
{
exit (EXIT_FAILURE);
}
+
static boost::posix_time::ptime
time_from_string (string t)
{
return boost::posix_time::time_from_string (t);
}
+
static boost::posix_time::time_duration
duration_from_string (string d)
{
exit (EXIT_FAILURE);
}
+
static bool
always_overwrite ()
{
return true;
}
+
void
write_files (
- list<ScreenKDM> screen_kdms,
+ 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,
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, filename_format, values,
+ int const N = write_files (
+ kdms, output, filename_format,
bind (&always_overwrite)
);
}
}
+
shared_ptr<Cinema>
find_cinema (string cinema_name)
{
- list<shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
- list<shared_ptr<Cinema> >::const_iterator i = cinemas.begin();
+ auto cinemas = Config::instance()->cinemas ();
+ auto i = cinemas.begin();
while (
i != cinemas.end() &&
(*i)->name != cinema_name &&
return *i;
}
+
void
from_film (
- list<shared_ptr<Screen> > screens,
+ list<shared_ptr<Screen>> screens,
boost::filesystem::path film_dir,
bool verbose,
boost::filesystem::path output,
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
)
{
shared_ptr<Film> film;
try {
- film.reset (new Film (film_dir));
+ film = make_shared<Film>(film_dir);
film->read_metadata ();
if (verbose) {
cout << "Read film " << film->name () << "\n";
error ("more than one CPL found in film");
}
- boost::filesystem::path cpl = cpls.front().cpl_file;
-
- 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);
+ auto cpl = cpls.front().cpl_file;
try {
- list<ScreenKDM> screen_kdms = film->make_kdms (
- screens, cpl, valid_from, valid_to, formulation
- );
-
- write_files (screen_kdms, zip, output, container_name_format, filename_format, values, verbose);
+ list<KDMWithMetadataPtr> kdms;
+ for (auto i: screens) {
+ auto 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);
}
}
+
optional<dcp::EncryptedKDM>
sub_find_dkdm (shared_ptr<DKDMGroup> group, string cpl_id)
{
- BOOST_FOREACH (shared_ptr<DKDMBase> i, group->children()) {
- shared_ptr<DKDMGroup> g = dynamic_pointer_cast<DKDMGroup>(i);
+ for (auto i: group->children()) {
+ auto g = dynamic_pointer_cast<DKDMGroup>(i);
if (g) {
- optional<dcp::EncryptedKDM> dkdm = sub_find_dkdm (g, cpl_id);
+ auto dkdm = sub_find_dkdm (g, cpl_id);
if (dkdm) {
return dkdm;
}
} else {
- shared_ptr<DKDM> d = dynamic_pointer_cast<DKDM>(i);
+ auto d = dynamic_pointer_cast<DKDM>(i);
assert (d);
if (d->dkdm().cpl_id() == cpl_id) {
return d->dkdm();
return optional<dcp::EncryptedKDM>();
}
+
optional<dcp::EncryptedKDM>
find_dkdm (string cpl_id)
{
return sub_find_dkdm (Config::instance()->dkdms(), cpl_id);
}
+
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 */
- shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
+ auto signer = Config::instance()->signer_chain ();
if (!signer->valid ()) {
error ("signing certificate chain is invalid.");
}
dcp::LocalTime().as_string()
);
- BOOST_FOREACH (dcp::DecryptedKDMKey const & j, dkdm.keys()) {
+ for (auto 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 (
- list<shared_ptr<Screen> > screens,
+ list<shared_ptr<Screen>> screens,
dcp::DecryptedKDM dkdm,
bool verbose,
boost::filesystem::path output,
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
)
{
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, screens) {
+ list<KDMWithMetadataPtr> kdms;
+ for (auto 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());
+
+ auto 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 (make_shared<KDMWithMetadata>(name_values, i->cinema.get(), i->cinema->emails, kdm));
}
- write_files (screen_kdms, zip, output, container_name_format, filename_format, 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);
}
}
+
void
dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent)
{
}
cout << group->name() << "\n";
}
- BOOST_FOREACH (shared_ptr<DKDMBase> i, group->children()) {
- shared_ptr<DKDMGroup> g = dynamic_pointer_cast<DKDMGroup>(i);
+ for (auto i: group->children()) {
+ auto g = dynamic_pointer_cast<DKDMGroup>(i);
if (g) {
dump_dkdm_group (g, indent + 2);
} else {
for (int j = 0; j < indent; ++j) {
cout << " ";
}
- shared_ptr<DKDM> d = dynamic_pointer_cast<DKDM>(i);
+ auto d = dynamic_pointer_cast<DKDM>(i);
assert(d);
cout << d->dkdm().cpl_id() << "\n";
}
}
}
+
int main (int argc, char* argv[])
{
boost::filesystem::path output = ".";
- dcp::NameFormat container_name_format = Config::instance()->kdm_container_name_format();
- dcp::NameFormat filename_format = Config::instance()->kdm_filename_format();
+ auto container_name_format = Config::instance()->kdm_container_name_format();
+ auto 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::Certificate> certificate;
+ 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;
bool list_dkdm_cpls = false;
optional<string> duration_string;
bool verbose = false;
- dcp::Formulation formulation = dcp::MODIFIED_TRANSITIONAL_1;
+ dcp::Formulation formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
+ bool disable_forensic_marking_picture = false;
+ optional<int> disable_forensic_marking_audio;
program_name = argv[0];
{ "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' },
{ 0, 0, 0, 0 }
};
- int c = getopt_long (argc, argv, "ho:K:Z: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;
duration_string = optarg;
break;
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") {
- formulation = dcp::DCI_SPECIFIC;
+ if (string(optarg) == "modified-transitional-1") {
+ formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
+ } else if (string(optarg) == "multiple-modified-transitional-1") {
+ formulation = dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1;
+ } else if (string(optarg) == "dci-any") {
+ formulation = dcp::Formulation::DCI_ANY;
+ } else if (string(optarg) == "dci-specific") {
+ formulation = dcp::Formulation::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;
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 ));
+ cinema = make_shared<Cinema>(optarg, list<string>(), "", 0, 0);
break;
case 'S':
screen_description = optarg;
break;
- case 'C': {
- certificate = dcp::Certificate (dcp::file_to_string (optarg));
- vector<dcp::Certificate> trusted_devices;
- shared_ptr<Screen> screen (new Screen (screen_description, certificate, trusted_devices));
- if (cinema_name) {
+ case 'C':
+ {
+ /* Make a new screen and add it to the current cinema */
+ dcp::CertificateChain chain (dcp::file_to_string(optarg));
+ auto screen = make_shared<Screen>(screen_description, "", chain.leaf(), vector<TrustedDevice>());
+ if (cinema) {
cinema->add_screen (screen);
}
screens.push_back (screen);
break;
}
case 'T':
- screens.back()->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;
}
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";
+ auto cinemas = Config::instance()->cinemas ();
+ for (auto i: cinemas) {
+ cout << i->name << " (" << Emailer::address_list (i->emails) << ")\n";
}
exit (EXIT_SUCCESS);
}
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, container_name_format, filename_format, *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));
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, container_name_format, filename_format, *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;
projects / dcpomatic.git / blobdiff