src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #include "cinema.h"
  23 #include "colour_conversion.h"
  24 #include "compose.hpp"
  25 #include "config.h"
  26 #include "cross.h"
  27 #include "crypto.h"
  28 #include "dcp_content_type.h"
  29 #include "dkdm_recipient.h"
  30 #include "dkdm_wrapper.h"
  31 #include "film.h"
  32 #include "filter.h"
  33 #include "log.h"
  34 #include "ratio.h"
  35 #include "types.h"
  36 #include "util.h"
  37 #include "zipper.h"
  38 #include <dcp/certificate_chain.h>
  39 #include <dcp/name_format.h>
  40 #include <dcp/raw_convert.h>
  41 #include <libcxml/cxml.h>
  42 #include <glib.h>
  43 #include <libxml++/libxml++.h>
  44 #include <boost/filesystem.hpp>
  45 #include <boost/algorithm/string.hpp>
  46 #include <boost/thread.hpp>
  47 #include <cstdlib>
  48 #include <fstream>
  49 #include <iostream>
  50
  51 #include "i18n.h"
  52
  53
  54 using std::cout;
  55 using std::dynamic_pointer_cast;
  56 using std::ifstream;
  57 using std::list;
  58 using std::make_shared;
  59 using std::max;
  60 using std::min;
  61 using std::remove;
  62 using std::shared_ptr;
  63 using std::string;
  64 using std::vector;
  65 using boost::algorithm::trim;
  66 using boost::optional;
  67 using dcp::raw_convert;
  68
  69
  70 Config* Config::_instance = 0;
  71 int const Config::_current_version = 3;
  72 boost::signals2::signal<void ()> Config::FailedToLoad;
  73 boost::signals2::signal<void (string)> Config::Warning;
  74 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
  75
  76
  77 /** Construct default configuration */
  78 Config::Config ()
  79         /* DKDMs are not considered a thing to reset on set_defaults() */
  80         : _dkdms (new DKDMGroup ("root"))
  81         , _default_kdm_duration (1, RoughDuration::Unit::WEEKS)
  82 {
  83         set_defaults ();
  84 }
  85
  86 void
  87 Config::set_defaults ()
  88 {
  89         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  90         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  91         _server_port_base = 6192;
  92         _use_any_servers = true;
  93         _servers.clear ();
  94         _only_servers_encode = false;
  95         _tms_protocol = FileTransferProtocol::SCP;
  96         _tms_ip = "";
  97         _tms_path = ".";
  98         _tms_user = "";
  99         _tms_password = "";
 100         _allow_any_dcp_frame_rate = false;
 101         _allow_any_container = false;
 102         _allow_96khz_audio = false;
 103         _show_experimental_audio_processors = false;
 104         _language = optional<string> ();
 105         _default_still_length = 10;
 106         _default_container = Ratio::from_id ("185");
 107         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
 108         _default_dcp_audio_channels = 6;
 109         _default_j2k_bandwidth = 150000000;
 110         _default_audio_delay = 0;
 111         _default_interop = false;
 112         _default_metadata.clear ();
 113         _upload_after_make_dcp = false;
 114         _mail_server = "";
 115         _mail_port = 25;
 116         _mail_protocol = EmailProtocol::AUTO;
 117         _mail_user = "";
 118         _mail_password = "";
 119         _kdm_from = "";
 120         _kdm_cc.clear ();
 121         _kdm_bcc = "";
 122         _notification_from = "";
 123         _notification_to = "";
 124         _notification_cc.clear ();
 125         _notification_bcc = "";
 126         _check_for_updates = false;
 127         _check_for_test_updates = false;
 128         _maximum_j2k_bandwidth = 250000000;
 129         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
 130         _analyse_ebur128 = true;
 131         _automatic_audio_analysis = false;
 132 #ifdef DCPOMATIC_WINDOWS
 133         _win32_console = false;
 134 #endif
 135         /* At the moment we don't write these files anywhere new after a version change, so they will be read from
 136          * ~/.config/dcpomatic2 (or equivalent) and written back there.
 137          */
 138         _cinemas_file = read_path ("cinemas.xml");
 139         _dkdm_recipients_file = read_path ("dkdm_recipients.xml");
 140         _show_hints_before_make_dcp = true;
 141         _confirm_kdm_email = true;
 142         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
 143         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
 144         _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
 145         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
 146         _dcp_asset_filename_format = dcp::NameFormat ("%t");
 147         _jump_to_selected = true;
 148         for (int i = 0; i < NAG_COUNT; ++i) {
 149                 _nagged[i] = false;
 150         }
 151         _sound = true;
 152         _sound_output = optional<string> ();
 153         _last_kdm_write_type = KDM_WRITE_FLAT;
 154         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 155
 156         /* I think the scaling factor here should be the ratio of the longest frame
 157            encode time to the shortest; if the thread count is T, longest time is L
 158            and the shortest time S we could encode L/S frames per thread whilst waiting
 159            for the L frame to encode so we might have to store LT/S frames.
 160
 161            However we don't want to use too much memory, so keep it a bit lower than we'd
 162            perhaps like.  A J2K frame is typically about 1Mb so 3 here will mean we could
 163            use about 240Mb with 72 encoding threads.
 164         */
 165         _frames_in_memory_multiplier = 3;
 166         _decode_reduction = optional<int>();
 167         _default_notify = false;
 168         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 169                 _notification[i] = false;
 170         }
 171         _barco_username = optional<string>();
 172         _barco_password = optional<string>();
 173         _christie_username = optional<string>();
 174         _christie_password = optional<string>();
 175         _gdc_username = optional<string>();
 176         _gdc_password = optional<string>();
 177         _player_mode = PLAYER_MODE_WINDOW;
 178         _image_display = 0;
 179         _video_view_type = VIDEO_VIEW_SIMPLE;
 180         _respect_kdm_validity_periods = true;
 181         _player_debug_log_file = boost::none;
 182         _player_content_directory = boost::none;
 183         _player_playlist_directory = boost::none;
 184         _player_kdm_directory = boost::none;
 185         _audio_mapping = boost::none;
 186         _custom_languages.clear ();
 187         _add_files_path = boost::none;
 188         _use_isdcf_name_by_default = true;
 189         _write_kdms_to_disk = true;
 190         _email_kdms = false;
 191         _default_kdm_type = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
 192         _default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
 193         _auto_crop_threshold = 0.1;
 194
 195         _allowed_dcp_frame_rates.clear ();
 196         _allowed_dcp_frame_rates.push_back (24);
 197         _allowed_dcp_frame_rates.push_back (25);
 198         _allowed_dcp_frame_rates.push_back (30);
 199         _allowed_dcp_frame_rates.push_back (48);
 200         _allowed_dcp_frame_rates.push_back (50);
 201         _allowed_dcp_frame_rates.push_back (60);
 202
 203         set_kdm_email_to_default ();
 204         set_notification_email_to_default ();
 205         set_cover_sheet_to_default ();
 206 }
 207
 208 void
 209 Config::restore_defaults ()
 210 {
 211         Config::instance()->set_defaults ();
 212         Config::instance()->changed ();
 213 }
 214
 215 shared_ptr<dcp::CertificateChain>
 216 Config::create_certificate_chain ()
 217 {
 218         return make_shared<dcp::CertificateChain> (
 219                 openssl_path(),
 220                 CERTIFICATE_VALIDITY_PERIOD,
 221                 "dcpomatic.com",
 222                 "dcpomatic.com",
 223                 ".dcpomatic.smpte-430-2.ROOT",
 224                 ".dcpomatic.smpte-430-2.INTERMEDIATE",
 225                 "CS.dcpomatic.smpte-430-2.LEAF"
 226                 );
 227 }
 228
 229 void
 230 Config::backup ()
 231 {
 232         using namespace boost::filesystem;
 233
 234         auto copy_adding_number = [](path const& path_to_copy) {
 235
 236                 auto add_number = [](path const& path, int number) {
 237                         return String::compose("%1.%2", path, number);
 238                 };
 239
 240                 int n = 1;
 241                 while (n < 100 && exists(add_number(path_to_copy, n))) {
 242                         ++n;
 243                 }
 244                 boost::system::error_code ec;
 245                 copy_file(path_to_copy, add_number(path_to_copy, n), ec);
 246         };
 247
 248         /* Make a backup copy of any config.xml, cinemas.xml, dkdm_recipients.xml that we might be about
 249          * to write over.  This is more intended for the situation where we have a corrupted config.xml,
 250          * and decide to overwrite it with a new one (possibly losing important details in the corrupted
 251          * file).  But we might as well back up the other files while we're about it.
 252          */
 253
 254         /* This uses the State::write_path stuff so, e.g. for a current version 2.16 we might copy
 255          * ~/.config/dcpomatic2/2.16/config.xml to ~/.config/dcpomatic2/2.16/config.xml.1
 256          */
 257         copy_adding_number (config_write_file());
 258
 259         /* These do not use State::write_path, so whatever path is in the Config we will copy
 260          * adding a number.
 261          */
 262         copy_adding_number (_cinemas_file);
 263         copy_adding_number (_dkdm_recipients_file);
 264 }
 265
 266 void
 267 Config::read ()
 268 try
 269 {
 270         cxml::Document f ("Config");
 271         f.read_file (config_read_file());
 272
 273         auto version = f.optional_number_child<int> ("Version");
 274         if (version && *version < _current_version) {
 275                 /* Back up the old config before we re-write it in a back-incompatible way */
 276                 backup ();
 277         }
 278
 279         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 280                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 281         } else {
 282                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 283                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 284         }
 285
 286         _default_directory = f.optional_string_child ("DefaultDirectory");
 287         if (_default_directory && _default_directory->empty ()) {
 288                 /* We used to store an empty value for this to mean "none set" */
 289                 _default_directory = boost::optional<boost::filesystem::path> ();
 290         }
 291
 292         auto b = f.optional_number_child<int> ("ServerPort");
 293         if (!b) {
 294                 b = f.optional_number_child<int> ("ServerPortBase");
 295         }
 296         _server_port_base = b.get ();
 297
 298         auto u = f.optional_bool_child ("UseAnyServers");
 299         _use_any_servers = u.get_value_or (true);
 300
 301         for (auto i: f.node_children("Server")) {
 302                 if (i->node_children("HostName").size() == 1) {
 303                         _servers.push_back (i->string_child ("HostName"));
 304                 } else {
 305                         _servers.push_back (i->content ());
 306                 }
 307         }
 308
 309         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 310         _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
 311         _tms_ip = f.string_child ("TMSIP");
 312         _tms_path = f.string_child ("TMSPath");
 313         _tms_user = f.string_child ("TMSUser");
 314         _tms_password = f.string_child ("TMSPassword");
 315
 316         _language = f.optional_string_child ("Language");
 317
 318         auto c = f.optional_string_child ("DefaultContainer");
 319         if (c) {
 320                 _default_container = Ratio::from_id (c.get ());
 321         }
 322
 323         if (_default_container && !_default_container->used_for_container()) {
 324                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
 325                 _default_container = Ratio::from_id ("185");
 326         }
 327
 328         _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
 329         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 330
 331         if (f.optional_string_child ("DCPMetadataIssuer")) {
 332                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 333         } else if (f.optional_string_child ("DCPIssuer")) {
 334                 _dcp_issuer = f.string_child ("DCPIssuer");
 335         }
 336
 337         auto up = f.optional_bool_child("UploadAfterMakeDCP");
 338         if (!up) {
 339                 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
 340         }
 341         _upload_after_make_dcp = up.get_value_or (false);
 342         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 343         _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
 344         _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
 345         _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
 346         _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
 347
 348         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 349         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 350         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 351         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 352
 353         for (auto const& i: f.node_children("DefaultMetadata")) {
 354                 _default_metadata[i->string_attribute("key")] = i->content();
 355         }
 356
 357         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 358
 359         /* Read any cinemas that are still lying around in the config file
 360          * from an old version.
 361          */
 362         read_cinemas (f);
 363
 364         _mail_server = f.string_child ("MailServer");
 365         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 366
 367         {
 368                 /* Make sure this matches the code in write_config */
 369                 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
 370                 if (protocol == "Auto") {
 371                         _mail_protocol = EmailProtocol::AUTO;
 372                 } else if (protocol == "Plain") {
 373                         _mail_protocol = EmailProtocol::PLAIN;
 374                 } else if (protocol == "STARTTLS") {
 375                         _mail_protocol = EmailProtocol::STARTTLS;
 376                 } else if (protocol == "SSL") {
 377                         _mail_protocol = EmailProtocol::SSL;
 378                 }
 379         }
 380
 381         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 382         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 383
 384         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 385         _kdm_from = f.string_child ("KDMFrom");
 386         for (auto i: f.node_children("KDMCC")) {
 387                 if (!i->content().empty()) {
 388                         _kdm_cc.push_back (i->content ());
 389                 }
 390         }
 391         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 392         _kdm_email = f.string_child ("KDMEmail");
 393
 394         _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
 395         _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
 396         _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
 397         for (auto i: f.node_children("NotificationCC")) {
 398                 if (!i->content().empty()) {
 399                         _notification_cc.push_back (i->content ());
 400                 }
 401         }
 402         _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
 403         if (f.optional_string_child("NotificationEmail")) {
 404                 _notification_email = f.string_child("NotificationEmail");
 405         }
 406
 407         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 408         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 409
 410         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 411         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 412         _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
 413         _allow_96khz_audio = f.optional_bool_child("Allow96kHzAudio").get_value_or(false);
 414         _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
 415
 416         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 417         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 418         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 419 #ifdef DCPOMATIC_WINDOWS
 420         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 421 #endif
 422
 423         for (auto i: f.node_children("History")) {
 424                 _history.push_back (i->content ());
 425         }
 426
 427         for (auto i: f.node_children("PlayerHistory")) {
 428                 _player_history.push_back (i->content ());
 429         }
 430
 431         auto signer = f.optional_node_child ("Signer");
 432         if (signer) {
 433                 auto c = make_shared<dcp::CertificateChain>();
 434                 /* Read the signing certificates and private key in from the config file */
 435                 for (auto i: signer->node_children ("Certificate")) {
 436                         c->add (dcp::Certificate (i->content ()));
 437                 }
 438                 c->set_key (signer->string_child ("PrivateKey"));
 439                 _signer_chain = c;
 440         } else {
 441                 /* Make a new set of signing certificates and key */
 442                 _signer_chain = create_certificate_chain ();
 443         }
 444
 445         auto decryption = f.optional_node_child ("Decryption");
 446         if (decryption) {
 447                 auto c = make_shared<dcp::CertificateChain>();
 448                 for (auto i: decryption->node_children ("Certificate")) {
 449                         c->add (dcp::Certificate (i->content ()));
 450                 }
 451                 c->set_key (decryption->string_child ("PrivateKey"));
 452                 _decryption_chain = c;
 453         } else {
 454                 _decryption_chain = create_certificate_chain ();
 455         }
 456
 457         /* These must be done before we call Bad as that might set one
 458            of the nags.
 459         */
 460         for (auto i: f.node_children("Nagged")) {
 461                 auto const id = i->number_attribute<int>("Id");
 462                 if (id >= 0 && id < NAG_COUNT) {
 463                         _nagged[id] = raw_convert<int>(i->content());
 464                 }
 465         }
 466
 467         auto bad = check_certificates ();
 468         if (bad) {
 469                 auto const remake = Bad(*bad);
 470                 if (remake && *remake) {
 471                         switch (*bad) {
 472                         case BAD_SIGNER_UTF8_STRINGS:
 473                         case BAD_SIGNER_INCONSISTENT:
 474                         case BAD_SIGNER_VALIDITY_TOO_LONG:
 475                                 _signer_chain = create_certificate_chain ();
 476                                 break;
 477                         case BAD_DECRYPTION_INCONSISTENT:
 478                                 _decryption_chain = create_certificate_chain ();
 479                                 break;
 480                         }
 481                 }
 482         }
 483
 484         if (f.optional_node_child("DKDMGroup")) {
 485                 /* New-style: all DKDMs in a group */
 486                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
 487         } else {
 488                 /* Old-style: one or more DKDM nodes */
 489                 _dkdms = make_shared<DKDMGroup>("root");
 490                 for (auto i: f.node_children("DKDM")) {
 491                         _dkdms->add (DKDMBase::read (i));
 492                 }
 493         }
 494         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
 495         _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
 496         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 497         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 498         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 499         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 500         _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
 501         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 502         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 503         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 504         /* The variable was renamed but not the XML tag */
 505         _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
 506         _sound_output = f.optional_string_child("PreviewSoundOutput");
 507         if (f.optional_string_child("CoverSheet")) {
 508                 _cover_sheet = f.optional_string_child("CoverSheet").get();
 509         }
 510         _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
 511         if (f.optional_string_child("LastKDMWriteType")) {
 512                 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
 513                         _last_kdm_write_type = KDM_WRITE_FLAT;
 514                 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
 515                         _last_kdm_write_type = KDM_WRITE_FOLDER;
 516                 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
 517                         _last_kdm_write_type = KDM_WRITE_ZIP;
 518                 }
 519         }
 520         if (f.optional_string_child("LastDKDMWriteType")) {
 521                 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
 522                         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 523                 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
 524                         _last_dkdm_write_type = DKDM_WRITE_FILE;
 525                 }
 526         }
 527         _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
 528         _decode_reduction = f.optional_number_child<int>("DecodeReduction");
 529         _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
 530
 531         for (auto i: f.node_children("Notification")) {
 532                 int const id = i->number_attribute<int>("Id");
 533                 if (id >= 0 && id < NOTIFICATION_COUNT) {
 534                         _notification[id] = raw_convert<int>(i->content());
 535                 }
 536         }
 537
 538         _barco_username = f.optional_string_child("BarcoUsername");
 539         _barco_password = f.optional_string_child("BarcoPassword");
 540         _christie_username = f.optional_string_child("ChristieUsername");
 541         _christie_password = f.optional_string_child("ChristiePassword");
 542         _gdc_username = f.optional_string_child("GDCUsername");
 543         _gdc_password = f.optional_string_child("GDCPassword");
 544
 545         auto pm = f.optional_string_child("PlayerMode");
 546         if (pm && *pm == "window") {
 547                 _player_mode = PLAYER_MODE_WINDOW;
 548         } else if (pm && *pm == "full") {
 549                 _player_mode = PLAYER_MODE_FULL;
 550         } else if (pm && *pm == "dual") {
 551                 _player_mode = PLAYER_MODE_DUAL;
 552         }
 553
 554         _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
 555         auto vc = f.optional_string_child("VideoViewType");
 556         if (vc && *vc == "opengl") {
 557                 _video_view_type = VIDEO_VIEW_OPENGL;
 558         } else if (vc && *vc == "simple") {
 559                 _video_view_type = VIDEO_VIEW_SIMPLE;
 560         }
 561         _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
 562         _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
 563         _player_content_directory = f.optional_string_child("PlayerContentDirectory");
 564         _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
 565         _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
 566
 567         if (f.optional_node_child("AudioMapping")) {
 568                 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
 569         }
 570
 571         for (auto i: f.node_children("CustomLanguage")) {
 572                 try {
 573                         /* This will fail if it's called before dcp::init() as it won't recognise the
 574                          * tag.  That's OK because the Config will be reloaded again later.
 575                          */
 576                         _custom_languages.push_back (dcp::LanguageTag(i->content()));
 577                 } catch (std::runtime_error& e) {}
 578         }
 579
 580         _add_files_path = f.optional_string_child("AddFilesPath");
 581         _use_isdcf_name_by_default = f.optional_bool_child("UseISDCFNameByDefault").get_value_or(true);
 582         _write_kdms_to_disk = f.optional_bool_child("WriteKDMsToDisk").get_value_or(true);
 583         _email_kdms = f.optional_bool_child("EmailKDMs").get_value_or(false);
 584         _default_kdm_type = dcp::string_to_formulation(f.optional_string_child("DefaultKDMType").get_value_or("modified-transitional-1"));
 585         if (auto duration = f.optional_node_child("DefaultKDMDuration")) {
 586                 _default_kdm_duration = RoughDuration(duration);
 587         } else {
 588                 _default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
 589         }
 590         _auto_crop_threshold = f.optional_number_child<double>("AutoCropThreshold").get_value_or(0.1);
 591
 592         if (boost::filesystem::exists (_cinemas_file)) {
 593                 cxml::Document f ("Cinemas");
 594                 f.read_file (_cinemas_file);
 595                 read_cinemas (f);
 596         }
 597
 598         if (boost::filesystem::exists (_dkdm_recipients_file)) {
 599                 cxml::Document f ("DKDMRecipients");
 600                 f.read_file (_dkdm_recipients_file);
 601                 read_dkdm_recipients (f);
 602         }
 603 }
 604 catch (...) {
 605         if (have_existing("config.xml") || have_existing("cinemas.xml") || have_existing("dkdm_recipients.xml")) {
 606                 backup ();
 607                 /* We have a config file but it didn't load */
 608                 FailedToLoad ();
 609         }
 610         set_defaults ();
 611         /* Make a new set of signing certificates and key */
 612         _signer_chain = create_certificate_chain ();
 613         /* And similar for decryption of KDMs */
 614         _decryption_chain = create_certificate_chain ();
 615         write ();
 616 }
 617
 618 /** @return Singleton instance */
 619 Config *
 620 Config::instance ()
 621 {
 622         if (_instance == nullptr) {
 623                 _instance = new Config;
 624                 _instance->read ();
 625         }
 626
 627         return _instance;
 628 }
 629
 630 /** Write our configuration to disk */
 631 void
 632 Config::write () const
 633 {
 634         write_config ();
 635         write_cinemas ();
 636         write_dkdm_recipients ();
 637 }
 638
 639 void
 640 Config::write_config () const
 641 {
 642         xmlpp::Document doc;
 643         auto root = doc.create_root_node ("Config");
 644
 645         /* [XML] Version The version number of the configuration file format. */
 646         root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
 647         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
 648         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 649         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
 650         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 651         if (_default_directory) {
 652                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
 653                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 654         }
 655         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
 656            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
 657            by the batch converter to listen for job requests.
 658         */
 659         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 660         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
 661         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 662
 663         for (auto i: _servers) {
 664                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
 665                    as you like.
 666                 */
 667                 root->add_child("Server")->add_child_text (i);
 668         }
 669
 670         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
 671            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
 672         */
 673         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 674         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
 675         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 676         /* [XML] TMSIP IP address of TMS. */
 677         root->add_child("TMSIP")->add_child_text (_tms_ip);
 678         /* [XML] TMSPath Path on the TMS to copy files to. */
 679         root->add_child("TMSPath")->add_child_text (_tms_path);
 680         /* [XML] TMSUser Username to log into the TMS with. */
 681         root->add_child("TMSUser")->add_child_text (_tms_user);
 682         /* [XML] TMSPassword Password to log into the TMS with. */
 683         root->add_child("TMSPassword")->add_child_text (_tms_password);
 684         if (_language) {
 685                 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
 686                 root->add_child("Language")->add_child_text (_language.get());
 687         }
 688         if (_default_container) {
 689                 /* [XML:opt] DefaultContainer ID of default container
 690                    to use when creating new films (<code>185</code>,<code>239</code> or
 691                    <code>190</code>).
 692                 */
 693                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 694         }
 695         if (_default_dcp_content_type) {
 696                 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
 697                    <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
 698                    <code>PSA</code> or <code>ADV</code>). */
 699                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 700         }
 701         /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
 702         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 703         /* [XML] DCPIssuer Issuer text to write into CPL files. */
 704         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 705         /* [XML] DCPCreator Creator text to write into CPL files. */
 706         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 707         /* [XML] Company name to write into MXF files. */
 708         root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
 709         /* [XML] Product name to write into MXF files. */
 710         root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
 711         /* [XML] Product version to write into MXF files. */
 712         root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
 713         /* [XML] Comment to write into JPEG2000 data. */
 714         root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
 715         /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
 716         root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
 717
 718         /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
 719         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 720         /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
 721         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 722         /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
 723         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 724         /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
 725         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 726         for (auto const& i: _default_metadata) {
 727                 auto c = root->add_child("DefaultMetadata");
 728                 c->set_attribute("key", i.first);
 729                 c->add_child_text(i.second);
 730         }
 731         if (_default_kdm_directory) {
 732                 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
 733                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 734         }
 735         _default_kdm_duration.as_xml(root->add_child("DefaultKDMDuration"));
 736         /* [XML] MailServer Hostname of SMTP server to use. */
 737         root->add_child("MailServer")->add_child_text (_mail_server);
 738         /* [XML] MailPort Port number to use on SMTP server. */
 739         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 740         /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
 741         switch (_mail_protocol) {
 742         case EmailProtocol::AUTO:
 743                 root->add_child("MailProtocol")->add_child_text("Auto");
 744                 break;
 745         case EmailProtocol::PLAIN:
 746                 root->add_child("MailProtocol")->add_child_text("Plain");
 747                 break;
 748         case EmailProtocol::STARTTLS:
 749                 root->add_child("MailProtocol")->add_child_text("STARTTLS");
 750                 break;
 751         case EmailProtocol::SSL:
 752                 root->add_child("MailProtocol")->add_child_text("SSL");
 753                 break;
 754         }
 755         /* [XML] MailUser Username to use on SMTP server. */
 756         root->add_child("MailUser")->add_child_text (_mail_user);
 757         /* [XML] MailPassword Password to use on SMTP server. */
 758         root->add_child("MailPassword")->add_child_text (_mail_password);
 759
 760         /* [XML] KDMSubject Subject to use for KDM emails. */
 761         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 762         /* [XML] KDMFrom From address to use for KDM emails. */
 763         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 764         for (auto i: _kdm_cc) {
 765                 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
 766                 root->add_child("KDMCC")->add_child_text (i);
 767         }
 768         /* [XML] KDMBCC BCC address to use for KDM emails. */
 769         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 770         /* [XML] KDMEmail Text of KDM email. */
 771         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 772
 773         /* [XML] NotificationSubject Subject to use for notification emails. */
 774         root->add_child("NotificationSubject")->add_child_text (_notification_subject);
 775         /* [XML] NotificationFrom From address to use for notification emails. */
 776         root->add_child("NotificationFrom")->add_child_text (_notification_from);
 777         /* [XML] NotificationFrom To address to use for notification emails. */
 778         root->add_child("NotificationTo")->add_child_text (_notification_to);
 779         for (auto i: _notification_cc) {
 780                 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
 781                 root->add_child("NotificationCC")->add_child_text (i);
 782         }
 783         /* [XML] NotificationBCC BCC address to use for notification emails. */
 784         root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
 785         /* [XML] NotificationEmail Text of notification email. */
 786         root->add_child("NotificationEmail")->add_child_text (_notification_email);
 787
 788         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
 789         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 790         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
 791         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 792
 793         /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
 794         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 795         /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
 796         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 797         /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
 798         root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
 799         /* [XML] Allow96kHzAudio 1 to allow users to make DCPs with 96kHz audio, 0 to always make 48kHz DCPs */
 800         root->add_child("Allow96kHzAudio")->add_child_text(_allow_96khz_audio ? "1" : "0");
 801         /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
 802         root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
 803         /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
 804            to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
 805            to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
 806            related to the player, 1024 debug information related to audio analyses.
 807         */
 808         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 809         /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
 810         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 811         /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
 812         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 813 #ifdef DCPOMATIC_WINDOWS
 814         if (_win32_console) {
 815                 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
 816                  * We only write this if it's true, which is a bit of a hack to allow unit tests to work
 817                  * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
 818                  */
 819                 root->add_child("Win32Console")->add_child_text ("1");
 820         }
 821 #endif
 822
 823         /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
 824            tags in order and a <code>&lt;PrivateKey&gt;</code> tag all containing PEM-encoded certificates or private keys as appropriate.
 825         */
 826         auto signer = root->add_child ("Signer");
 827         DCPOMATIC_ASSERT (_signer_chain);
 828         for (auto const& i: _signer_chain->unordered()) {
 829                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 830         }
 831         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 832
 833         /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
 834         auto decryption = root->add_child ("Decryption");
 835         DCPOMATIC_ASSERT (_decryption_chain);
 836         for (auto const& i: _decryption_chain->unordered()) {
 837                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 838         }
 839         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 840
 841         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
 842            of these tags.
 843         */
 844         for (auto i: _history) {
 845                 root->add_child("History")->add_child_text (i.string ());
 846         }
 847
 848         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
 849            of these tags.
 850         */
 851         for (auto i: _player_history) {
 852                 root->add_child("PlayerHistory")->add_child_text (i.string ());
 853         }
 854
 855         /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code>&lt;DKDMGroup&gt;</code>
 856            or <code>&lt;DKDM&gt;</code> tags.
 857         */
 858         /* [XML] DKDM A DKDM as XML */
 859         _dkdms->as_xml (root);
 860
 861         /* [XML] CinemasFile Filename of cinemas list file. */
 862         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 863         /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
 864         root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
 865         /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
 866         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 867         /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
 868         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 869         /* [XML] KDMFilenameFormat Format for KDM filenames. */
 870         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 871         /* [XML] KDMFilenameFormat Format for DKDM filenames. */
 872         root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
 873         /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
 874         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 875         /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
 876         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 877         /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
 878         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 879         /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
 880         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 881         /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
 882         for (int i = 0; i < NAG_COUNT; ++i) {
 883                 xmlpp::Element* e = root->add_child ("Nagged");
 884                 e->set_attribute ("Id", raw_convert<string>(i));
 885                 e->add_child_text (_nagged[i] ? "1" : "0");
 886         }
 887         /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
 888         root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
 889         if (_sound_output) {
 890                 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
 891                 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
 892         }
 893         /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
 894         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 895         if (_last_player_load_directory) {
 896                 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
 897         }
 898         /* [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. */
 899         if (_last_kdm_write_type) {
 900                 switch (_last_kdm_write_type.get()) {
 901                 case KDM_WRITE_FLAT:
 902                         root->add_child("LastKDMWriteType")->add_child_text("flat");
 903                         break;
 904                 case KDM_WRITE_FOLDER:
 905                         root->add_child("LastKDMWriteType")->add_child_text("folder");
 906                         break;
 907                 case KDM_WRITE_ZIP:
 908                         root->add_child("LastKDMWriteType")->add_child_text("zip");
 909                         break;
 910                 }
 911         }
 912         /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
 913         if (_last_dkdm_write_type) {
 914                 switch (_last_dkdm_write_type.get()) {
 915                 case DKDM_WRITE_INTERNAL:
 916                         root->add_child("LastDKDMWriteType")->add_child_text("internal");
 917                         break;
 918                 case DKDM_WRITE_FILE:
 919                         root->add_child("LastDKDMWriteType")->add_child_text("file");
 920                         break;
 921                 }
 922         }
 923         /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
 924            frames to be held in memory at once.
 925         */
 926         root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
 927
 928         /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
 929         if (_decode_reduction) {
 930                 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
 931         }
 932
 933         /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
 934         root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
 935
 936         /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
 937         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 938                 xmlpp::Element* e = root->add_child ("Notification");
 939                 e->set_attribute ("Id", raw_convert<string>(i));
 940                 e->add_child_text (_notification[i] ? "1" : "0");
 941         }
 942
 943         if (_barco_username) {
 944                 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
 945                 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
 946         }
 947         if (_barco_password) {
 948                 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
 949                 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
 950         }
 951
 952         if (_christie_username) {
 953                 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
 954                 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
 955         }
 956         if (_christie_password) {
 957                 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
 958                 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
 959         }
 960
 961         if (_gdc_username) {
 962                 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
 963                 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
 964         }
 965         if (_gdc_password) {
 966                 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
 967                 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
 968         }
 969
 970         /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
 971            with controls on another monitor.
 972         */
 973         switch (_player_mode) {
 974         case PLAYER_MODE_WINDOW:
 975                 root->add_child("PlayerMode")->add_child_text("window");
 976                 break;
 977         case PLAYER_MODE_FULL:
 978                 root->add_child("PlayerMode")->add_child_text("full");
 979                 break;
 980         case PLAYER_MODE_DUAL:
 981                 root->add_child("PlayerMode")->add_child_text("dual");
 982                 break;
 983         }
 984
 985         /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
 986         root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
 987         switch (_video_view_type) {
 988         case VIDEO_VIEW_SIMPLE:
 989                 root->add_child("VideoViewType")->add_child_text("simple");
 990                 break;
 991         case VIDEO_VIEW_OPENGL:
 992                 root->add_child("VideoViewType")->add_child_text("opengl");
 993                 break;
 994         }
 995         /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
 996         root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
 997         if (_player_debug_log_file) {
 998                 /* [XML] PlayerLogFile Filename to use for player debug logs. */
 999                 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
1000         }
1001         if (_player_content_directory) {
1002                 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
1003                 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
1004         }
1005         if (_player_playlist_directory) {
1006                 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
1007                 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1008         }
1009         if (_player_kdm_directory) {
1010                 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1011                 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1012         }
1013         if (_audio_mapping) {
1014                 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1015         }
1016         for (auto const& i: _custom_languages) {
1017                 root->add_child("CustomLanguage")->add_child_text(i.to_string());
1018         }
1019         if (_add_files_path) {
1020                 /* [XML] AddFilesPath The default path that will be offered in the picker when adding files to a film. */
1021                 root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
1022         }
1023         root->add_child("UseISDCFNameByDefault")->add_child_text(_use_isdcf_name_by_default ? "1" : "0");
1024         root->add_child("WriteKDMsToDisk")->add_child_text(_write_kdms_to_disk ? "1" : "0");
1025         root->add_child("EmailKDMs")->add_child_text(_email_kdms ? "1" : "0");
1026         root->add_child("DefaultKDMType")->add_child_text(dcp::formulation_to_string(_default_kdm_type));
1027         root->add_child("AutoCropThreshold")->add_child_text(raw_convert<string>(_auto_crop_threshold));
1028
1029         auto target = config_write_file();
1030
1031         try {
1032                 auto const s = doc.write_to_string_formatted ();
1033                 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1034                 dcp::File f(tmp, "w");
1035                 if (!f) {
1036                         throw FileError (_("Could not open file for writing"), tmp);
1037                 }
1038                 f.checked_write(s.c_str(), s.bytes());
1039                 f.close();
1040                 boost::filesystem::remove (target);
1041                 boost::filesystem::rename (tmp, target);
1042         } catch (xmlpp::exception& e) {
1043                 string s = e.what ();
1044                 trim (s);
1045                 throw FileError (s, target);
1046         }
1047 }
1048
1049
1050 template <class T>
1051 void
1052 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1053 {
1054         xmlpp::Document doc;
1055         auto root = doc.create_root_node (root_node);
1056         root->add_child("Version")->add_child_text(version);
1057
1058         for (auto i: things) {
1059                 i->as_xml (root->add_child(node));
1060         }
1061
1062         try {
1063                 doc.write_to_file_formatted (file.string() + ".tmp");
1064                 boost::filesystem::remove (file);
1065                 boost::filesystem::rename (file.string() + ".tmp", file);
1066         } catch (xmlpp::exception& e) {
1067                 string s = e.what ();
1068                 trim (s);
1069                 throw FileError (s, file);
1070         }
1071 }
1072
1073
1074 void
1075 Config::write_cinemas () const
1076 {
1077         write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1078 }
1079
1080
1081 void
1082 Config::write_dkdm_recipients () const
1083 {
1084         write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1085 }
1086
1087
1088 boost::filesystem::path
1089 Config::default_directory_or (boost::filesystem::path a) const
1090 {
1091         return directory_or (_default_directory, a);
1092 }
1093
1094 boost::filesystem::path
1095 Config::default_kdm_directory_or (boost::filesystem::path a) const
1096 {
1097         return directory_or (_default_kdm_directory, a);
1098 }
1099
1100 boost::filesystem::path
1101 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1102 {
1103         if (!dir) {
1104                 return a;
1105         }
1106
1107         boost::system::error_code ec;
1108         auto const e = boost::filesystem::exists (*dir, ec);
1109         if (ec || !e) {
1110                 return a;
1111         }
1112
1113         return *dir;
1114 }
1115
1116 void
1117 Config::drop ()
1118 {
1119         delete _instance;
1120         _instance = 0;
1121 }
1122
1123 void
1124 Config::changed (Property what)
1125 {
1126         Changed (what);
1127 }
1128
1129 void
1130 Config::set_kdm_email_to_default ()
1131 {
1132         _kdm_subject = _("KDM delivery: $CPL_NAME");
1133
1134         _kdm_email = _(
1135                 "Dear Projectionist\n\n"
1136                 "Please find attached KDMs for $CPL_NAME.\n\n"
1137                 "Cinema: $CINEMA_NAME\n"
1138                 "Screen(s): $SCREENS\n\n"
1139                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1140                 "Best regards,\nDCP-o-matic"
1141                 );
1142 }
1143
1144 void
1145 Config::set_notification_email_to_default ()
1146 {
1147         _notification_subject = _("DCP-o-matic notification");
1148
1149         _notification_email = _(
1150                 "$JOB_NAME: $JOB_STATUS"
1151                 );
1152 }
1153
1154 void
1155 Config::reset_kdm_email ()
1156 {
1157         set_kdm_email_to_default ();
1158         changed ();
1159 }
1160
1161 void
1162 Config::reset_notification_email ()
1163 {
1164         set_notification_email_to_default ();
1165         changed ();
1166 }
1167
1168 void
1169 Config::set_cover_sheet_to_default ()
1170 {
1171         _cover_sheet = _(
1172                 "$CPL_NAME\n\n"
1173                 "CPL Filename: $CPL_FILENAME\n"
1174                 "Type: $TYPE\n"
1175                 "Format: $CONTAINER\n"
1176                 "Audio: $AUDIO\n"
1177                 "Audio Language: $AUDIO_LANGUAGE\n"
1178                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1179                 "Length: $LENGTH\n"
1180                 "Size: $SIZE\n"
1181                 );
1182 }
1183
1184 void
1185 Config::add_to_history (boost::filesystem::path p)
1186 {
1187         add_to_history_internal (_history, p);
1188 }
1189
1190 /** Remove non-existant items from the history */
1191 void
1192 Config::clean_history ()
1193 {
1194         clean_history_internal (_history);
1195 }
1196
1197 void
1198 Config::add_to_player_history (boost::filesystem::path p)
1199 {
1200         add_to_history_internal (_player_history, p);
1201 }
1202
1203 /** Remove non-existant items from the player history */
1204 void
1205 Config::clean_player_history ()
1206 {
1207         clean_history_internal (_player_history);
1208 }
1209
1210 void
1211 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1212 {
1213         /* Remove existing instances of this path in the history */
1214         h.erase (remove (h.begin(), h.end(), p), h.end ());
1215
1216         h.insert (h.begin (), p);
1217         if (h.size() > HISTORY_SIZE) {
1218                 h.pop_back ();
1219         }
1220
1221         changed (HISTORY);
1222 }
1223
1224 void
1225 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1226 {
1227         auto old = h;
1228         h.clear ();
1229         for (auto i: old) {
1230                 try {
1231                         if (boost::filesystem::is_directory(i)) {
1232                                 h.push_back (i);
1233                         }
1234                 } catch (...) {
1235                         /* We couldn't find out if it's a directory for some reason; just ignore it */
1236                 }
1237         }
1238 }
1239
1240
1241 bool
1242 Config::have_existing (string file)
1243 {
1244         return boost::filesystem::exists (read_path(file));
1245 }
1246
1247
1248 void
1249 Config::read_cinemas (cxml::Document const & f)
1250 {
1251         _cinemas.clear ();
1252         for (auto i: f.node_children("Cinema")) {
1253                 /* Slightly grotty two-part construction of Cinema here so that we can use
1254                    shared_from_this.
1255                 */
1256                 auto cinema = make_shared<Cinema>(i);
1257                 cinema->read_screens (i);
1258                 _cinemas.push_back (cinema);
1259         }
1260 }
1261
1262 void
1263 Config::set_cinemas_file (boost::filesystem::path file)
1264 {
1265         if (file == _cinemas_file) {
1266                 return;
1267         }
1268
1269         _cinemas_file = file;
1270
1271         if (boost::filesystem::exists (_cinemas_file)) {
1272                 /* Existing file; read it in */
1273                 cxml::Document f ("Cinemas");
1274                 f.read_file (_cinemas_file);
1275                 read_cinemas (f);
1276         }
1277
1278         changed (OTHER);
1279 }
1280
1281
1282 void
1283 Config::read_dkdm_recipients (cxml::Document const & f)
1284 {
1285         _dkdm_recipients.clear ();
1286         for (auto i: f.node_children("DKDMRecipient")) {
1287                 _dkdm_recipients.push_back (make_shared<DKDMRecipient>(i));
1288         }
1289 }
1290
1291
1292 void
1293 Config::save_template (shared_ptr<const Film> film, string name) const
1294 {
1295         film->write_template (template_write_path(name));
1296 }
1297
1298
1299 list<string>
1300 Config::templates () const
1301 {
1302         if (!boost::filesystem::exists(read_path("templates"))) {
1303                 return {};
1304         }
1305
1306         list<string> n;
1307         for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1308                 n.push_back (i.path().filename().string());
1309         }
1310         return n;
1311 }
1312
1313 bool
1314 Config::existing_template (string name) const
1315 {
1316         return boost::filesystem::exists (template_read_path(name));
1317 }
1318
1319
1320 boost::filesystem::path
1321 Config::template_read_path (string name) const
1322 {
1323         return read_path("templates") / tidy_for_filename (name);
1324 }
1325
1326
1327 boost::filesystem::path
1328 Config::template_write_path (string name) const
1329 {
1330         return write_path("templates") / tidy_for_filename (name);
1331 }
1332
1333
1334 void
1335 Config::rename_template (string old_name, string new_name) const
1336 {
1337         boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name));
1338 }
1339
1340 void
1341 Config::delete_template (string name) const
1342 {
1343         boost::filesystem::remove (template_write_path(name));
1344 }
1345
1346 /** @return Path to the config.xml containing the actual settings, following a link if required */
1347 boost::filesystem::path
1348 config_file (boost::filesystem::path main)
1349 {
1350         cxml::Document f ("Config");
1351         if (!boost::filesystem::exists (main)) {
1352                 /* It doesn't exist, so there can't be any links; just return it */
1353                 return main;
1354         }
1355
1356         /* See if there's a link */
1357         try {
1358                 f.read_file (main);
1359                 auto link = f.optional_string_child("Link");
1360                 if (link) {
1361                         return *link;
1362                 }
1363         } catch (xmlpp::exception& e) {
1364                 /* There as a problem reading the main configuration file,
1365                    so there can't be a link.
1366                 */
1367         }
1368
1369         return main;
1370 }
1371
1372
1373 boost::filesystem::path
1374 Config::config_read_file ()
1375 {
1376         return config_file (read_path("config.xml"));
1377 }
1378
1379
1380 boost::filesystem::path
1381 Config::config_write_file ()
1382 {
1383         return config_file (write_path("config.xml"));
1384 }
1385
1386
1387 void
1388 Config::reset_cover_sheet ()
1389 {
1390         set_cover_sheet_to_default ();
1391         changed ();
1392 }
1393
1394 void
1395 Config::link (boost::filesystem::path new_file) const
1396 {
1397         xmlpp::Document doc;
1398         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1399         try {
1400                 doc.write_to_file_formatted(write_path("config.xml").string());
1401         } catch (xmlpp::exception& e) {
1402                 string s = e.what ();
1403                 trim (s);
1404                 throw FileError (s, write_path("config.xml"));
1405         }
1406 }
1407
1408 void
1409 Config::copy_and_link (boost::filesystem::path new_file) const
1410 {
1411         write ();
1412         boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1413         link (new_file);
1414 }
1415
1416 bool
1417 Config::have_write_permission () const
1418 {
1419         dcp::File f(config_write_file(), "r+");
1420         return static_cast<bool>(f);
1421 }
1422
1423 /** @param  output_channels Number of output channels in use.
1424  *  @return Audio mapping for this output channel count (may be a default).
1425  */
1426 AudioMapping
1427 Config::audio_mapping (int output_channels)
1428 {
1429         if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1430                 /* Set up a default */
1431                 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1432                 if (output_channels == 2) {
1433                         /* Special case for stereo output.
1434                            Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1435                            Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1436                         */
1437                         _audio_mapping->set (dcp::Channel::LEFT,   0, 1 / sqrt(2));  // L   -> Lt
1438                         _audio_mapping->set (dcp::Channel::RIGHT,  1, 1 / sqrt(2));  // R   -> Rt
1439                         _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0);      // C   -> Lt
1440                         _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0);      // C   -> Rt
1441                         _audio_mapping->set (dcp::Channel::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
1442                         _audio_mapping->set (dcp::Channel::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
1443                         _audio_mapping->set (dcp::Channel::LS,     0, 1 / sqrt(2));  // Ls  -> Lt
1444                         _audio_mapping->set (dcp::Channel::RS,     1, 1 / sqrt(2));  // Rs  -> Rt
1445                 } else {
1446                         /* 1:1 mapping */
1447                         for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1448                                 _audio_mapping->set (i, i, 1);
1449                         }
1450                 }
1451         }
1452
1453         return *_audio_mapping;
1454 }
1455
1456 void
1457 Config::set_audio_mapping (AudioMapping m)
1458 {
1459         _audio_mapping = m;
1460         changed (AUDIO_MAPPING);
1461 }
1462
1463 void
1464 Config::set_audio_mapping_to_default ()
1465 {
1466         DCPOMATIC_ASSERT (_audio_mapping);
1467         auto const ch = _audio_mapping->output_channels ();
1468         _audio_mapping = boost::none;
1469         _audio_mapping = audio_mapping (ch);
1470         changed (AUDIO_MAPPING);
1471 }
1472
1473
1474 void
1475 Config::add_custom_language (dcp::LanguageTag tag)
1476 {
1477         if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1478                 _custom_languages.push_back (tag);
1479                 changed ();
1480         }
1481 }
1482
1483
1484 optional<Config::BadReason>
1485 Config::check_certificates () const
1486 {
1487         optional<BadReason> bad;
1488
1489         for (auto const& i: _signer_chain->unordered()) {
1490                 if (i.has_utf8_strings()) {
1491                         bad = BAD_SIGNER_UTF8_STRINGS;
1492                 }
1493                 if ((i.not_after().year() - i.not_before().year()) > 15) {
1494                         bad = BAD_SIGNER_VALIDITY_TOO_LONG;
1495                 }
1496         }
1497
1498         if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
1499                 bad = BAD_SIGNER_INCONSISTENT;
1500         }
1501
1502         if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
1503                 bad = BAD_DECRYPTION_INCONSISTENT;
1504         }
1505
1506         return bad;
1507 }
1508
1509
1510 void
1511 save_all_config_as_zip (boost::filesystem::path zip_file)
1512 {
1513         Zipper zipper (zip_file);
1514
1515         auto config = Config::instance();
1516         zipper.add ("config.xml", dcp::file_to_string(config->config_read_file()));
1517         if (boost::filesystem::exists(config->cinemas_file())) {
1518                 zipper.add ("cinemas.xml", dcp::file_to_string(config->cinemas_file()));
1519         }
1520         if (boost::filesystem::exists(config->dkdm_recipients_file())) {
1521                 zipper.add ("dkdm_recipients.xml", dcp::file_to_string(config->dkdm_recipients_file()));
1522         }
1523
1524         zipper.close ();
1525 }
1526