/*
- Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
#include "types.h"
#include "log.h"
#include "dcp_content_type.h"
-#include "cinema_sound_processor.h"
#include "colour_conversion.h"
#include "cinema.h"
#include "util.h"
#include "film.h"
#include "dkdm_wrapper.h"
#include "compose.hpp"
+#include "crypto.h"
+#include "dkdm_recipient.h"
#include <dcp/raw_convert.h>
#include <dcp/name_format.h>
#include <dcp/certificate_chain.h>
using std::ifstream;
using std::string;
using std::list;
+using std::min;
using std::max;
using std::remove;
using std::exception;
int const Config::_current_version = 3;
boost::signals2::signal<void ()> Config::FailedToLoad;
boost::signals2::signal<void (string)> Config::Warning;
-boost::signals2::signal<bool (void)> Config::BadSignerChain;
-boost::optional<boost::filesystem::path> Config::override_path;
+boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
/** Construct default configuration */
Config::Config ()
_use_any_servers = true;
_servers.clear ();
_only_servers_encode = false;
- _tms_protocol = PROTOCOL_SCP;
+ _tms_protocol = FILE_TRANSFER_PROTOCOL_SCP;
_tms_ip = "";
_tms_path = ".";
_tms_user = "";
_tms_password = "";
- _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
_allow_any_dcp_frame_rate = false;
_allow_any_container = false;
+ _show_experimental_audio_processors = false;
_language = optional<string> ();
_default_still_length = 10;
_default_container = Ratio::from_id ("185");
- _default_scale_to = 0;
_default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
_default_dcp_audio_channels = 6;
- _default_j2k_bandwidth = 100000000;
+ _default_j2k_bandwidth = 150000000;
_default_audio_delay = 0;
_default_interop = true;
- _default_upload_after_make_dcp = false;
+ _upload_after_make_dcp = false;
_mail_server = "";
_mail_port = 25;
+ _mail_protocol = EMAIL_PROTOCOL_AUTO;
_mail_user = "";
_mail_password = "";
_kdm_from = "";
_win32_console = false;
#endif
_cinemas_file = path ("cinemas.xml");
+ _dkdm_recipients_file = path ("dkdm_recipients.xml");
_show_hints_before_make_dcp = true;
_confirm_kdm_email = true;
_kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
_kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
+ _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
_dcp_metadata_filename_format = dcp::NameFormat ("%t");
_dcp_asset_filename_format = dcp::NameFormat ("%t");
_jump_to_selected = true;
_barco_password = optional<string>();
_christie_username = optional<string>();
_christie_password = optional<string>();
+ _gdc_username = optional<string>();
+ _gdc_password = optional<string>();
+ _interface_complexity = INTERFACE_SIMPLE;
+ _player_mode = PLAYER_MODE_WINDOW;
+ _image_display = 0;
+ _video_view_type = VIDEO_VIEW_SIMPLE;
+ _respect_kdm_validity_periods = true;
+ _player_activity_log_file = boost::none;
+ _player_debug_log_file = boost::none;
+ _player_content_directory = boost::none;
+ _player_playlist_directory = boost::none;
+ _player_kdm_directory = boost::none;
+ _audio_mapping = boost::none;
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ _player_background_image = boost::none;
+ _kdm_server_url = "http://localhost:8000/{CPL}";
+ _player_watermark_theatre = "";
+ _player_watermark_period = 1;
+ _player_watermark_duration = 50;
+ _player_lock_file = boost::none;
+ _signer_chain_path = "signer";
+ _decryption_chain_path = "decryption";
+#endif
_allowed_dcp_frame_rates.clear ();
_allowed_dcp_frame_rates.push_back (24);
boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
+ boost::filesystem::copy_file(path("dkdm_recipients.xml", false), path(String::compose("dkdm_recipients.xml.%1", n), false));
} catch (...) {}
}
Config::read ()
try
{
+#if defined(DCPOMATIC_VARIANT_SWAROOP) && defined(DCPOMATIC_LINUX)
+ if (geteuid() == 0) {
+ /* Take ownership of the config file if we're root */
+ chown (config_file().string().c_str(), 0, 0);
+ chmod (config_file().string().c_str(), 0644);
+ }
+#endif
+
cxml::Document f ("Config");
f.read_file (config_file ());
}
_only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
- _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
+ _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
_tms_ip = f.string_child ("TMSIP");
_tms_path = f.string_child ("TMSPath");
_tms_user = f.string_child ("TMSUser");
_tms_password = f.string_child ("TMSPassword");
- optional<string> c;
- c = f.optional_string_child ("SoundProcessor");
- if (c) {
- _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
- }
- c = f.optional_string_child ("CinemaSoundProcessor");
- if (c) {
- _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
- }
-
_language = f.optional_string_child ("Language");
- c = f.optional_string_child ("DefaultContainer");
+ optional<string> c = f.optional_string_child ("DefaultContainer");
if (c) {
_default_container = Ratio::from_id (c.get ());
}
_default_container = Ratio::from_id ("185");
}
- c = f.optional_string_child ("DefaultScaleTo");
- if (c) {
- _default_scale_to = Ratio::from_id (c.get ());
- }
-
_default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
_default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
_dcp_issuer = f.string_child ("DCPIssuer");
}
- _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
+ optional<bool> up = f.optional_bool_child("UploadAfterMakeDCP");
+ if (!up) {
+ up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
+ }
+ _upload_after_make_dcp = up.get_value_or (false);
_dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
+ _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
+ _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
+ _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
+ _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
if (version && version.get() >= 2) {
_default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
_default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
_default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
- /* Load any cinemas from config.xml */
+ /* Read any cinemas that are still lying around in the config file
+ * from an old version.
+ */
read_cinemas (f);
_mail_server = f.string_child ("MailServer");
_mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
+
+ {
+ /* Make sure this matches the code in write_config */
+ string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
+ if (protocol == "Auto") {
+ _mail_protocol = EMAIL_PROTOCOL_AUTO;
+ } else if (protocol == "Plain") {
+ _mail_protocol = EMAIL_PROTOCOL_PLAIN;
+ } else if (protocol == "STARTTLS") {
+ _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
+ } else if (protocol == "SSL") {
+ _mail_protocol = EMAIL_PROTOCOL_SSL;
+ }
+ }
+
_mail_user = f.optional_string_child("MailUser").get_value_or ("");
_mail_password = f.optional_string_child("MailPassword").get_value_or ("");
_maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
_allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
_allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
+ _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
_log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
_analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
}
cxml::NodePtr signer = f.optional_node_child ("Signer");
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ if (signer && signer->node_children().size() == 1) {
+ /* The content of <Signer> is a path to a file; if it's relative it's in the same
+ directory as .config. */
+ _signer_chain_path = signer->content();
+ if (_signer_chain_path.is_relative()) {
+ _signer_chain = read_swaroop_chain (path(_signer_chain_path.string()));
+ } else {
+ _signer_chain = read_swaroop_chain (_signer_chain_path);
+ }
+ } else {
+ /* <Signer> is not present or has children: ignore it and remake. */
+ _signer_chain = create_certificate_chain ();
+ }
+#else
if (signer) {
shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
/* Read the signing certificates and private key in from the config file */
/* Make a new set of signing certificates and key */
_signer_chain = create_certificate_chain ();
}
+#endif
+
+ cxml::NodePtr decryption = f.optional_node_child ("Decryption");
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ if (decryption && decryption->node_children().size() == 1) {
+ /* The content of <Decryption> is a path to a file; if it's relative, it's in the same
+ directory as .config. */
+ _decryption_chain_path = decryption->content();
+ if (_decryption_chain_path.is_relative()) {
+ _decryption_chain = read_swaroop_chain (path(_decryption_chain_path.string()));
+ } else {
+ _decryption_chain = read_swaroop_chain (_decryption_chain_path);
+ }
+ } else {
+ /* <Decryption> is not present or has more children: ignore it and remake. */
+ _decryption_chain = create_certificate_chain ();
+ }
+#else
+ if (decryption) {
+ shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
+ BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
+ c->add (dcp::Certificate (i->content ()));
+ }
+ c->set_key (decryption->string_child ("PrivateKey"));
+ _decryption_chain = c;
+ } else {
+ _decryption_chain = create_certificate_chain ();
+ }
+#endif
- /* These must be done before we call BadSignerChain as that might set one
+ /* These must be done before we call Bad as that might set one
of the nags.
*/
BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
}
}
- bool bad_signer_chain = false;
+ optional<BadReason> bad;
+
BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
if (i.has_utf8_strings()) {
- bad_signer_chain = true;
+ bad = BAD_SIGNER_UTF8_STRINGS;
}
}
- if (bad_signer_chain) {
- optional<bool> const remake = BadSignerChain();
- if (remake && *remake) {
- _signer_chain = create_certificate_chain ();
- }
+ if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
+ bad = BAD_SIGNER_INCONSISTENT;
}
- cxml::NodePtr decryption = f.optional_node_child ("Decryption");
- if (decryption) {
- shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
- BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
- c->add (dcp::Certificate (i->content ()));
+ if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
+ bad = BAD_DECRYPTION_INCONSISTENT;
+ }
+
+ if (bad) {
+ optional<bool> const remake = Bad(*bad);
+ if (remake && *remake) {
+ switch (*bad) {
+ case BAD_SIGNER_UTF8_STRINGS:
+ case BAD_SIGNER_INCONSISTENT:
+ _signer_chain = create_certificate_chain ();
+ break;
+ case BAD_DECRYPTION_INCONSISTENT:
+ _decryption_chain = create_certificate_chain ();
+ break;
+ }
}
- c->set_key (decryption->string_child ("PrivateKey"));
- _decryption_chain = c;
- } else {
- _decryption_chain = create_certificate_chain ();
}
if (f.optional_node_child("DKDMGroup")) {
}
}
_cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
+ _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or (path("dkdm_recipients.xml").string());
_show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
_confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
_kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
_kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
+ _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
_dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
_dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
_jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
_barco_password = f.optional_string_child("BarcoPassword");
_christie_username = f.optional_string_child("ChristieUsername");
_christie_password = f.optional_string_child("ChristiePassword");
+ _gdc_username = f.optional_string_child("GDCUsername");
+ _gdc_password = f.optional_string_child("GDCPassword");
+
+ optional<string> ic = f.optional_string_child("InterfaceComplexity");
+ if (ic && *ic == "full") {
+ _interface_complexity = INTERFACE_FULL;
+ }
+ optional<string> pm = f.optional_string_child("PlayerMode");
+ if (pm && *pm == "window") {
+ _player_mode = PLAYER_MODE_WINDOW;
+ } else if (pm && *pm == "full") {
+ _player_mode = PLAYER_MODE_FULL;
+ } else if (pm && *pm == "dual") {
+ _player_mode = PLAYER_MODE_DUAL;
+ }
+
+ _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
+ optional<string> vc = f.optional_string_child("VideoViewType");
+ if (vc && *vc == "opengl") {
+ _video_view_type = VIDEO_VIEW_OPENGL;
+ } else if (vc && *vc == "simple") {
+ _video_view_type = VIDEO_VIEW_SIMPLE;
+ }
+ _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
+ /* PlayerLogFile is old name */
+ _player_activity_log_file = f.optional_string_child("PlayerLogFile");
+ if (!_player_activity_log_file) {
+ _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
+ }
+ _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
+ _player_content_directory = f.optional_string_child("PlayerContentDirectory");
+ _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
+ _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
+
+ if (f.optional_node_child("AudioMapping")) {
+ _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
+ }
+
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ _player_background_image = f.optional_string_child("PlayerBackgroundImage");
+ _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}");
+ _player_watermark_theatre = f.optional_string_child("PlayerWatermarkTheatre").get_value_or("");
+ _player_watermark_period = f.optional_number_child<int>("PlayerWatermarkPeriod").get_value_or(1);
+ _player_watermark_duration = f.optional_number_child<int>("PlayerWatermarkDuration").get_value_or(150);
+ BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("RequiredMonitor")) {
+ _required_monitors.push_back(Monitor(i));
+ }
+ _player_lock_file = f.optional_string_child("PlayerLockFile");
+#endif
- /* Replace any cinemas from config.xml with those from the configured file */
if (boost::filesystem::exists (_cinemas_file)) {
cxml::Document f ("Cinemas");
f.read_file (_cinemas_file);
read_cinemas (f);
}
+
+ if (boost::filesystem::exists (_dkdm_recipients_file)) {
+ cxml::Document f ("DKDMRecipients");
+ f.read_file (_dkdm_recipients_file);
+ read_dkdm_recipients (f);
+ }
}
catch (...) {
if (have_existing ("config.xml")) {
write ();
}
-/** @return Filename to write configuration to */
-boost::filesystem::path
-Config::path (string file, bool create_directories)
-{
- boost::filesystem::path p;
- if (override_path) {
- p = *override_path;
- } else {
-#ifdef DCPOMATIC_OSX
- p /= g_get_home_dir ();
- p /= "Library";
- p /= "Preferences";
- p /= "com.dcpomatic";
- p /= "2";
-#else
- p /= g_get_user_config_dir ();
- p /= "dcpomatic2";
-#endif
- }
- boost::system::error_code ec;
- if (create_directories) {
- boost::filesystem::create_directories (p, ec);
- }
- p /= file;
- return p;
-}
-
/** @return Singleton instance */
Config *
Config::instance ()
{
write_config ();
write_cinemas ();
+ write_dkdm_recipients ();
}
void
xmlpp::Document doc;
xmlpp::Element* root = doc.create_root_node ("Config");
- /* [XML] Version The version number of the configuration file format */
- root->add_child("Version")->add_child_text (String::compose ("%1", _current_version));
+ /* [XML] Version The version number of the configuration file format. */
+ root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
/* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
/* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
/* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
- /* [XML] TMSIP IP address of TMS */
+ /* [XML] TMSIP IP address of TMS. */
root->add_child("TMSIP")->add_child_text (_tms_ip);
- /* [XML] TMSPath Path on the TMS to copy files to */
+ /* [XML] TMSPath Path on the TMS to copy files to. */
root->add_child("TMSPath")->add_child_text (_tms_path);
- /* [XML] TMSUser Username to log into the TMS with */
+ /* [XML] TMSUser Username to log into the TMS with. */
root->add_child("TMSUser")->add_child_text (_tms_user);
- /* [XML] TMSPassword Password to log into the TMS with */
+ /* [XML] TMSPassword Password to log into the TMS with. */
root->add_child("TMSPassword")->add_child_text (_tms_password);
- if (_cinema_sound_processor) {
- /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
- gain changes from fader positions. Currently can only be <code>dolby_cp750</code>.
- */
- root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
- }
if (_language) {
/* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
root->add_child("Language")->add_child_text (_language.get());
}
if (_default_container) {
/* [XML:opt] DefaultContainer ID of default container
- * to use when creating new films (<code>185</code>,<code>239</code> or
- * <code>190</code>).
+ to use when creating new films (<code>185</code>,<code>239</code> or
+ <code>190</code>).
*/
root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
}
- if (_default_scale_to) {
- /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
- (see <code>DefaultContainer</code> for IDs).
- */
- root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
- }
if (_default_dcp_content_type) {
/* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
<code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
/* [XML] DCPIssuer Creator text to write into CPL files. */
root->add_child("DCPCreator")->add_child_text (_dcp_creator);
- root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
+ /* [XML] Company name to write into MXF files. */
+ root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
+ /* [XML] Product name to write into MXF files. */
+ root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
+ /* [XML] Product version to write into MXF files. */
+ root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
+ /* [XML] Comment to write into JPEG2000 data. */
+ root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
+ /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
+ root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
/* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
<code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
root->add_child("MailServer")->add_child_text (_mail_server);
/* [XML] MailPort Port number to use on SMTP server. */
root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
+ /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
+ switch (_mail_protocol) {
+ case EMAIL_PROTOCOL_AUTO:
+ root->add_child("MailProtocol")->add_child_text("Auto");
+ break;
+ case EMAIL_PROTOCOL_PLAIN:
+ root->add_child("MailProtocol")->add_child_text("Plain");
+ break;
+ case EMAIL_PROTOCOL_STARTTLS:
+ root->add_child("MailProtocol")->add_child_text("STARTTLS");
+ break;
+ case EMAIL_PROTOCOL_SSL:
+ root->add_child("MailProtocol")->add_child_text("SSL");
+ break;
+ }
/* [XML] MailUser Username to use on SMTP server. */
root->add_child("MailUser")->add_child_text (_mail_user);
/* [XML] MailPassword Password to use on SMTP server. */
/* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
root->add_child("KDMCC")->add_child_text (i);
}
- /* [XML] KDMBCC BCC address to use for KDM emails */
+ /* [XML] KDMBCC BCC address to use for KDM emails. */
root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
- /* [XML] KDMEmail Text of KDM email */
+ /* [XML] KDMEmail Text of KDM email. */
root->add_child("KDMEmail")->add_child_text (_kdm_email);
- /* [XML] NotificationSubject Subject to use for Notification emails. */
+ /* [XML] NotificationSubject Subject to use for notification emails. */
root->add_child("NotificationSubject")->add_child_text (_notification_subject);
- /* [XML] NotificationFrom From address to use for Notification emails. */
+ /* [XML] NotificationFrom From address to use for notification emails. */
root->add_child("NotificationFrom")->add_child_text (_notification_from);
- /* [XML] NotificationFrom To address to use for Notification emails. */
+ /* [XML] NotificationFrom To address to use for notification emails. */
root->add_child("NotificationTo")->add_child_text (_notification_to);
BOOST_FOREACH (string i, _notification_cc) {
- /* [XML] NotificationCC CC address to use for Notification emails; you can use as many of these tags as you like. */
+ /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
root->add_child("NotificationCC")->add_child_text (i);
}
- /* [XML] NotificationBCC BCC address to use for Notification emails */
+ /* [XML] NotificationBCC BCC address to use for notification emails. */
root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
- /* [XML] NotificationEmail Text of Notification email */
+ /* [XML] NotificationEmail Text of notification email. */
root->add_child("NotificationEmail")->add_child_text (_notification_email);
- /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
+ /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
- /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
+ /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
- /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
+ /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
- /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
+ /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
- /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers */
+ /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
+ /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
+ root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
/* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
to sending email.
root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
#endif
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ if (_signer_chain_path.is_relative()) {
+ write_swaroop_chain (_signer_chain, path(_signer_chain_path.string()));
+ } else {
+ write_swaroop_chain (_signer_chain, _signer_chain_path);
+ }
+ root->add_child("Signer")->add_child_text(_signer_chain_path.string());
+#else
/* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
*/
signer->add_child("Certificate")->add_child_text (i.certificate (true));
}
signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
+#endif
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ if (_decryption_chain_path.is_relative()) {
+ write_swaroop_chain (_decryption_chain, path(_decryption_chain_path.string()));
+ } else {
+ write_swaroop_chain (_decryption_chain, _decryption_chain_path);
+ }
+ root->add_child("Decryption")->add_child_text(_decryption_chain_path.string());
+#else
/* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
xmlpp::Element* decryption = root->add_child ("Decryption");
DCPOMATIC_ASSERT (_decryption_chain);
decryption->add_child("Certificate")->add_child_text (i.certificate (true));
}
decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
+#endif
/* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
of these tags.
root->add_child("History")->add_child_text (i.string ());
}
+ /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
+ of these tags.
+ */
BOOST_FOREACH (boost::filesystem::path i, _player_history) {
root->add_child("PlayerHistory")->add_child_text (i.string ());
}
/* [XML] DKDM A DKDM as XML */
_dkdms->as_xml (root);
- /* [XML] CinemasFile Filename of cinemas list file */
+ /* [XML] CinemasFile Filename of cinemas list file. */
root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
- /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
+ /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
+ root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
+ /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
- /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
+ /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
- /* [XML] KDMFilenameFormat Format for KDM filenames */
+ /* [XML] KDMFilenameFormat Format for KDM filenames. */
root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
- /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
+ /* [XML] KDMFilenameFormat Format for DKDM filenames. */
+ root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
+ /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
- /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
+ /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
- /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
+ /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
- /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
+ /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
- /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
+ /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
for (int i = 0; i < NAG_COUNT; ++i) {
xmlpp::Element* e = root->add_child ("Nagged");
e->set_attribute ("Id", raw_convert<string>(i));
e->add_child_text (_nagged[i] ? "1" : "0");
}
- /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
+ /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
if (_sound_output) {
- /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
+ /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
}
- /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
+ /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
root->add_child("CoverSheet")->add_child_text (_cover_sheet);
if (_last_player_load_directory) {
root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
}
+ /* [XML] LastKDMWriteType Last type of KDM-write: <code>flat</code> for a flat file, <code>folder</code> for a folder or <code>zip</code> for a ZIP file. */
if (_last_kdm_write_type) {
switch (_last_kdm_write_type.get()) {
case KDM_WRITE_FLAT:
break;
}
}
+ /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
if (_last_dkdm_write_type) {
switch (_last_dkdm_write_type.get()) {
case DKDM_WRITE_INTERNAL:
*/
root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
- /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */
+ /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
if (_decode_reduction) {
root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
}
- /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0 */
+ /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
- /* [XML] Notification 1 if a notification type is enabled, otherwise 0 */
+ /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
xmlpp::Element* e = root->add_child ("Notification");
e->set_attribute ("Id", raw_convert<string>(i));
}
if (_barco_username) {
+ /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
root->add_child("BarcoUsername")->add_child_text(*_barco_username);
}
if (_barco_password) {
+ /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
root->add_child("BarcoPassword")->add_child_text(*_barco_password);
}
if (_christie_username) {
+ /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
root->add_child("ChristieUsername")->add_child_text(*_christie_username);
}
if (_christie_password) {
+ /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
root->add_child("ChristiePassword")->add_child_text(*_christie_password);
}
+ if (_gdc_username) {
+ /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
+ root->add_child("GDCUsername")->add_child_text(*_gdc_username);
+ }
+ if (_gdc_password) {
+ /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
+ root->add_child("GDCPassword")->add_child_text(*_gdc_password);
+ }
+
+ /* [XML] InterfaceComplexity <code>simple</code> for the reduced interface or <code>full</code> for the full interface. */
+ switch (_interface_complexity) {
+ case INTERFACE_SIMPLE:
+ root->add_child("InterfaceComplexity")->add_child_text("simple");
+ break;
+ case INTERFACE_FULL:
+ root->add_child("InterfaceComplexity")->add_child_text("full");
+ break;
+ }
+
+ /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
+ with controls on another monitor.
+ */
+ switch (_player_mode) {
+ case PLAYER_MODE_WINDOW:
+ root->add_child("PlayerMode")->add_child_text("window");
+ break;
+ case PLAYER_MODE_FULL:
+ root->add_child("PlayerMode")->add_child_text("full");
+ break;
+ case PLAYER_MODE_DUAL:
+ root->add_child("PlayerMode")->add_child_text("dual");
+ break;
+ }
+
+ /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
+ root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
+ switch (_video_view_type) {
+ case VIDEO_VIEW_SIMPLE:
+ root->add_child("VideoViewType")->add_child_text("simple");
+ break;
+ case VIDEO_VIEW_OPENGL:
+ root->add_child("VideoViewType")->add_child_text("opengl");
+ break;
+ }
+ /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
+ root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
+ if (_player_activity_log_file) {
+ /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
+ root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
+ }
+ if (_player_debug_log_file) {
+ /* [XML] PlayerLogFile Filename to use for player debug logs */
+ root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
+ }
+ if (_player_content_directory) {
+ /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
+ root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
+ }
+ if (_player_playlist_directory) {
+ /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
+ root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
+ }
+ if (_player_kdm_directory) {
+ /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
+ root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
+ }
+ if (_audio_mapping) {
+ _audio_mapping->as_xml (root->add_child("AudioMapping"));
+ }
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+ if (_player_background_image) {
+ root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string());
+ }
+ root->add_child("KDMServerURL")->add_child_text(_kdm_server_url);
+ root->add_child("PlayerWatermarkTheatre")->add_child_text(_player_watermark_theatre);
+ root->add_child("PlayerWatermarkPeriod")->add_child_text(raw_convert<string>(_player_watermark_period));
+ root->add_child("PlayerWatermarkDuration")->add_child_text(raw_convert<string>(_player_watermark_duration));
+ BOOST_FOREACH (Monitor i, _required_monitors) {
+ i.as_xml(root->add_child("RequiredMonitor"));
+ }
+ if (_player_lock_file) {
+ root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string());
+ }
+#endif
+
try {
- doc.write_to_file_formatted(config_file().string());
+ string const s = doc.write_to_string_formatted ();
+ boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
+ FILE* f = fopen_boost (tmp, "w");
+ if (!f) {
+ throw FileError (_("Could not open file for writing"), tmp);
+ }
+ checked_fwrite (s.c_str(), s.length(), f, tmp);
+ fclose (f);
+ boost::filesystem::remove (config_file());
+ boost::filesystem::rename (tmp, config_file());
} catch (xmlpp::exception& e) {
string s = e.what ();
trim (s);
- throw FileError (s, path("config.xml"));
+ throw FileError (s, config_file());
}
}
+
+template <class T>
void
-Config::write_cinemas () const
+write_file (string root_node, string node, string version, list<shared_ptr<T> > things, boost::filesystem::path file)
{
xmlpp::Document doc;
- xmlpp::Element* root = doc.create_root_node ("Cinemas");
- root->add_child("Version")->add_child_text ("1");
+ xmlpp::Element* root = doc.create_root_node (root_node);
+ root->add_child("Version")->add_child_text(version);
- BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
- i->as_xml (root->add_child ("Cinema"));
+ BOOST_FOREACH (shared_ptr<T> i, things) {
+ i->as_xml (root->add_child(node));
}
try {
- doc.write_to_file_formatted (_cinemas_file.string ());
+ doc.write_to_file_formatted (file.string() + ".tmp");
+ boost::filesystem::remove (file);
+ boost::filesystem::rename (file.string() + ".tmp", file);
} catch (xmlpp::exception& e) {
string s = e.what ();
trim (s);
- throw FileError (s, _cinemas_file);
+ throw FileError (s, file);
}
}
+
+void
+Config::write_cinemas () const
+{
+ write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
+}
+
+
+void
+Config::write_dkdm_recipients () const
+{
+ write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
+}
+
+
boost::filesystem::path
Config::default_directory_or (boost::filesystem::path a) const
{
add_to_history_internal (_history, p);
}
+/** Remove non-existant items from the history */
+void
+Config::clean_history ()
+{
+ clean_history_internal (_history);
+}
+
void
Config::add_to_player_history (boost::filesystem::path p)
{
add_to_history_internal (_player_history, p);
}
+/** Remove non-existant items from the player history */
+void
+Config::clean_player_history ()
+{
+ clean_history_internal (_player_history);
+}
+
void
Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
{
h.pop_back ();
}
- changed ();
+ changed (HISTORY);
+}
+
+void
+Config::clean_history_internal (vector<boost::filesystem::path>& h)
+{
+ vector<boost::filesystem::path> old = h;
+ h.clear ();
+ BOOST_FOREACH (boost::filesystem::path i, old) {
+ try {
+ if (boost::filesystem::is_directory(i)) {
+ h.push_back (i);
+ }
+ } catch (...) {
+ /* We couldn't find out if it's a directory for some reason; just ignore it */
+ }
+ }
}
bool
changed (OTHER);
}
+
+void
+Config::read_dkdm_recipients (cxml::Document const & f)
+{
+ _dkdm_recipients.clear ();
+ list<cxml::NodePtr> cin = f.node_children ("DKDMRecipient");
+ BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDMRecipient")) {
+ _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
+ }
+}
+
+void
+Config::set_dkdm_recipients_file (boost::filesystem::path file)
+{
+ if (file == _dkdm_recipients_file) {
+ return;
+ }
+
+ _dkdm_recipients_file = file;
+
+ if (boost::filesystem::exists (_dkdm_recipients_file)) {
+ /* Existing file; read it in */
+ cxml::Document f ("DKDMRecipients");
+ f.read_file (_dkdm_recipients_file);
+ read_dkdm_recipients (f);
+ }
+
+ changed (OTHER);
+}
+
+
void
Config::save_template (shared_ptr<const Film> film, string name) const
{
}
/* See if there's a link */
- f.read_file (main);
- optional<string> link = f.optional_string_child("Link");
- if (link) {
- return *link;
+ try {
+ f.read_file (main);
+ optional<string> link = f.optional_string_child("Link");
+ if (link) {
+ return *link;
+ }
+ } catch (xmlpp::exception& e) {
+ /* There as a problem reading the main configuration file,
+ so there can't be a link.
+ */
}
return main;
boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
link (new_file);
}
+
+bool
+Config::have_write_permission () const
+{
+ FILE* f = fopen_boost (config_file(), "r+");
+ if (!f) {
+ return false;
+ }
+
+ fclose (f);
+ return true;
+}
+
+/** @param output_channels Number of output channels in use.
+ * @return Audio mapping for this output channel count (may be a default).
+ */
+AudioMapping
+Config::audio_mapping (int output_channels)
+{
+ if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
+ /* Set up a default */
+ _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
+ if (output_channels == 2) {
+ /* Special case for stereo output.
+ Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
+ Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
+ */
+ _audio_mapping->set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
+ _audio_mapping->set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
+ _audio_mapping->set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
+ _audio_mapping->set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
+ _audio_mapping->set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
+ _audio_mapping->set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
+ _audio_mapping->set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
+ _audio_mapping->set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
+ } else {
+ /* 1:1 mapping */
+ for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
+ _audio_mapping->set (i, i, 1);
+ }
+ }
+ }
+
+ return *_audio_mapping;
+}
+
+void
+Config::set_audio_mapping (AudioMapping m)
+{
+ _audio_mapping = m;
+ changed (AUDIO_MAPPING);
+}
+
+void
+Config::set_audio_mapping_to_default ()
+{
+ DCPOMATIC_ASSERT (_audio_mapping);
+ int const ch = _audio_mapping->output_channels ();
+ _audio_mapping = boost::none;
+ _audio_mapping = audio_mapping (ch);
+ changed (AUDIO_MAPPING);
+}