/*
- Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
#include "cross.h"
#include "film.h"
#include "dkdm_wrapper.h"
+#include "compose.hpp"
#include <dcp/raw_convert.h>
#include <dcp/name_format.h>
#include <dcp/certificate_chain.h>
using dcp::raw_convert;
Config* Config::_instance = 0;
+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;
/** Construct default configuration */
Config::Config ()
_tms_password = "";
_cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
_allow_any_dcp_frame_rate = false;
+ _allow_any_container = false;
_language = optional<string> ();
_default_still_length = 10;
_default_container = Ratio::from_id ("185");
_default_j2k_bandwidth = 100000000;
_default_audio_delay = 0;
_default_interop = true;
+ _default_upload_after_make_dcp = false;
_mail_server = "";
_mail_port = 25;
_mail_user = "";
_kdm_from = "";
_kdm_cc.clear ();
_kdm_bcc = "";
+ _notification_from = "";
+ _notification_to = "";
+ _notification_cc.clear ();
+ _notification_bcc = "";
_check_for_updates = false;
_check_for_test_updates = false;
_maximum_j2k_bandwidth = 250000000;
for (int i = 0; i < NAG_COUNT; ++i) {
_nagged[i] = false;
}
- _sound = false;
+ _sound = true;
_sound_output = optional<string> ();
_last_kdm_write_type = KDM_WRITE_FLAT;
+ _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
/* I think the scaling factor here should be the ratio of the longest frame
encode time to the shortest; if the thread count is T, longest time is L
use about 240Mb with 72 encoding threads.
*/
_frames_in_memory_multiplier = 3;
+ _decode_reduction = optional<int>();
+ _default_notify = false;
+ for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
+ _notification[i] = false;
+ }
+ _barco_username = optional<string>();
+ _barco_password = optional<string>();
+ _christie_username = optional<string>();
+ _christie_password = optional<string>();
+ _gdc_username = optional<string>();
+ _gdc_password = optional<string>();
_allowed_dcp_frame_rates.clear ();
_allowed_dcp_frame_rates.push_back (24);
_allowed_dcp_frame_rates.push_back (60);
set_kdm_email_to_default ();
+ set_notification_email_to_default ();
set_cover_sheet_to_default ();
}
);
}
+void
+Config::backup ()
+{
+ /* Make a copy of the configuration */
+ try {
+ int n = 1;
+ while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
+ ++n;
+ }
+
+ 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));
+ } catch (...) {}
+}
+
void
Config::read ()
try
f.read_file (config_file ());
optional<int> version = f.optional_number_child<int> ("Version");
+ if (version && *version < _current_version) {
+ /* Back up the old config before we re-write it in a back-incompatible way */
+ backup ();
+ }
if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
_master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
_default_scale_to = Ratio::from_id (c.get ());
}
- c = f.optional_string_child ("DefaultDCPContentType");
- if (c) {
- _default_dcp_content_type = DCPContentType::from_isdcf_name (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);
if (f.optional_string_child ("DCPMetadataIssuer")) {
_dcp_issuer = f.string_child ("DCPIssuer");
}
+ _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
_dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
if (version && version.get() >= 2) {
_mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
_mail_user = f.optional_string_child("MailUser").get_value_or ("");
_mail_password = f.optional_string_child("MailPassword").get_value_or ("");
+
_kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
_kdm_from = f.string_child ("KDMFrom");
BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
_kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
_kdm_email = f.string_child ("KDMEmail");
+ _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
+ _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
+ _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
+ BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
+ if (!i->content().empty()) {
+ _notification_cc.push_back (i->content ());
+ }
+ }
+ _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
+ if (f.optional_string_child("NotificationEmail")) {
+ _notification_email = f.string_child("NotificationEmail");
+ }
+
_check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
_check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
_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);
_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);
_win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
#endif
- list<cxml::NodePtr> his = f.node_children ("History");
BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
_history.push_back (i->content ());
}
+ BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
+ _player_history.push_back (i->content ());
+ }
+
cxml::NodePtr signer = f.optional_node_child ("Signer");
if (signer) {
shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
_signer_chain = create_certificate_chain ();
}
+ /* These must be done before we call BadSignerChain as that might set one
+ of the nags.
+ */
+ BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
+ int const id = i->number_attribute<int>("Id");
+ if (id >= 0 && id < NAG_COUNT) {
+ _nagged[id] = raw_convert<int>(i->content());
+ }
+ }
+
+ bool bad_signer_chain = false;
+ BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
+ if (i.has_utf8_strings()) {
+ bad_signer_chain = true;
+ }
+ }
+
+ if (bad_signer_chain) {
+ optional<bool> const remake = BadSignerChain();
+ if (remake && *remake) {
+ _signer_chain = create_certificate_chain ();
+ }
+ }
+
cxml::NodePtr decryption = f.optional_node_child ("Decryption");
if (decryption) {
shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
_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);
- BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
- int const id = i->number_attribute<int>("Id");
- if (id >= 0 && id < NAG_COUNT) {
- _nagged[id] = raw_convert<int>(i->content());
- }
- }
/* The variable was renamed but not the XML tag */
- _sound = f.optional_bool_child("PreviewSound").get_value_or (false);
+ _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
_sound_output = f.optional_string_child("PreviewSoundOutput");
if (f.optional_string_child("CoverSheet")) {
_cover_sheet = f.optional_string_child("CoverSheet").get();
_last_kdm_write_type = KDM_WRITE_ZIP;
}
}
+ if (f.optional_string_child("LastDKDMWriteType")) {
+ if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
+ _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
+ } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
+ _last_dkdm_write_type = DKDM_WRITE_FILE;
+ }
+ }
_frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
+ _decode_reduction = f.optional_number_child<int>("DecodeReduction");
+ _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
+
+ BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
+ int const id = i->number_attribute<int>("Id");
+ if (id >= 0 && id < NOTIFICATION_COUNT) {
+ _notification[id] = raw_convert<int>(i->content());
+ }
+ }
+
+ _barco_username = f.optional_string_child("BarcoUsername");
+ _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");
/* Replace any cinemas from config.xml with those from the configured file */
if (boost::filesystem::exists (_cinemas_file)) {
}
catch (...) {
if (have_existing ("config.xml")) {
-
- /* Make a copy of the configuration */
- try {
- boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false));
- boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
- } catch (...) {}
-
+ backup ();
/* We have a config file but it didn't load */
FailedToLoad ();
}
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";
+ p /= g_get_home_dir ();
+ p /= "Library";
+ p /= "Preferences";
+ p /= "com.dcpomatic";
+ p /= "2";
#else
- p /= g_get_user_config_dir ();
- p /= "dcpomatic2";
+ p /= g_get_user_config_dir ();
+ p /= "dcpomatic2";
#endif
+ }
boost::system::error_code ec;
if (create_directories) {
boost::filesystem::create_directories (p, ec);
xmlpp::Document doc;
xmlpp::Element* root = doc.create_root_node ("Config");
- /* [XML] Version The version number of the configuration file format; currently 2. */
- root->add_child("Version")->add_child_text ("2");
+ /* [XML] Version The version number of the configuration file format */
+ root->add_child("Version")->add_child_text (String::compose ("%1", _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("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] 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("MailUser")->add_child_text (_mail_user);
/* [XML] MailPassword Password to use on SMTP server. */
root->add_child("MailPassword")->add_child_text (_mail_password);
+
/* [XML] KDMSubject Subject to use for KDM emails. */
root->add_child("KDMSubject")->add_child_text (_kdm_subject);
/* [XML] KDMFrom From address to use for KDM emails. */
/* [XML] KDMEmail Text of KDM email */
root->add_child("KDMEmail")->add_child_text (_kdm_email);
+ /* [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. */
+ root->add_child("NotificationFrom")->add_child_text (_notification_from);
+ /* [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. */
+ root->add_child("NotificationCC")->add_child_text (i);
+ }
+ /* [XML] NotificationBCC BCC address to use for Notification emails */
+ root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
+ /* [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 */
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 */
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 */
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 */
+ root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "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("History")->add_child_text (i.string ());
}
+ BOOST_FOREACH (boost::filesystem::path i, _player_history) {
+ root->add_child("PlayerHistory")->add_child_text (i.string ());
+ }
+
/* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
or <code><DKDM></code> tags.
*/
break;
}
}
+ if (_last_dkdm_write_type) {
+ switch (_last_dkdm_write_type.get()) {
+ case DKDM_WRITE_INTERNAL:
+ root->add_child("LastDKDMWriteType")->add_child_text("internal");
+ break;
+ case DKDM_WRITE_FILE:
+ root->add_child("LastDKDMWriteType")->add_child_text("file");
+ break;
+ }
+ }
/* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
frames to be held in memory at once.
*/
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 */
+ 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 */
+ root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "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));
+ e->add_child_text (_notification[i] ? "1" : "0");
+ }
+
+ if (_barco_username) {
+ root->add_child("BarcoUsername")->add_child_text(*_barco_username);
+ }
+ if (_barco_password) {
+ root->add_child("BarcoPassword")->add_child_text(*_barco_password);
+ }
+
+ if (_christie_username) {
+ root->add_child("ChristieUsername")->add_child_text(*_christie_username);
+ }
+ if (_christie_password) {
+ root->add_child("ChristiePassword")->add_child_text(*_christie_password);
+ }
+
+ if (_gdc_username) {
+ root->add_child("GDCUsername")->add_child_text(*_gdc_username);
+ }
+ if (_gdc_password) {
+ root->add_child("GDCPassword")->add_child_text(*_gdc_password);
+ }
+
try {
doc.write_to_file_formatted(config_file().string());
} catch (xmlpp::exception& e) {
);
}
+void
+Config::set_notification_email_to_default ()
+{
+ _notification_subject = _("DCP-o-matic notification");
+
+ _notification_email = _(
+ "$JOB_NAME: $JOB_STATUS"
+ );
+}
+
void
Config::reset_kdm_email ()
{
changed ();
}
+void
+Config::reset_notification_email ()
+{
+ set_notification_email_to_default ();
+ changed ();
+}
+
void
Config::set_cover_sheet_to_default ()
{
void
Config::add_to_history (boost::filesystem::path p)
+{
+ add_to_history_internal (_history, p);
+}
+
+void
+Config::add_to_player_history (boost::filesystem::path p)
+{
+ add_to_history_internal (_player_history, p);
+}
+
+void
+Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
{
/* Remove existing instances of this path in the history */
- _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
+ h.erase (remove (h.begin(), h.end(), p), h.end ());
- _history.insert (_history.begin (), p);
- if (_history.size() > HISTORY_SIZE) {
- _history.pop_back ();
+ h.insert (h.begin (), p);
+ if (h.size() > HISTORY_SIZE) {
+ h.pop_back ();
}
changed ();
void
Config::set_cinemas_file (boost::filesystem::path file)
{
+ if (file == _cinemas_file) {
+ return;
+ }
+
_cinemas_file = file;
if (boost::filesystem::exists (_cinemas_file)) {