2 Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
23 #include "colour_conversion.h"
24 #include "compose.hpp"
26 #include "constants.h"
28 #include "dcp_content_type.h"
29 #include "dkdm_recipient.h"
30 #include "dkdm_wrapper.h"
36 #include <dcp/certificate_chain.h>
37 #include <dcp/name_format.h>
38 #include <dcp/raw_convert.h>
39 #include <libcxml/cxml.h>
41 #include <libxml++/libxml++.h>
42 #include <boost/filesystem.hpp>
43 #include <boost/algorithm/string.hpp>
44 #include <boost/thread.hpp>
53 using std::dynamic_pointer_cast;
56 using std::make_shared;
60 using std::shared_ptr;
63 using boost::algorithm::trim;
64 using boost::optional;
65 using dcp::raw_convert;
68 Config* Config::_instance = 0;
69 int const Config::_current_version = 3;
70 boost::signals2::signal<void (Config::LoadFailure)> Config::FailedToLoad;
71 boost::signals2::signal<void (string)> Config::Warning;
72 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
75 /** Construct default configuration */
77 /* DKDMs are not considered a thing to reset on set_defaults() */
78 : _dkdms (new DKDMGroup ("root"))
79 , _default_kdm_duration (1, RoughDuration::Unit::WEEKS)
86 Config::set_defaults ()
88 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
89 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
90 _server_port_base = 6192;
91 _use_any_servers = true;
93 _only_servers_encode = false;
94 _tms_protocol = FileTransferProtocol::SCP;
100 _allow_any_dcp_frame_rate = false;
101 _allow_any_container = false;
102 _allow_96khz_audio = false;
103 _use_all_audio_channels = false;
104 _show_experimental_audio_processors = false;
105 _language = optional<string> ();
106 _default_still_length = 10;
107 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
108 _default_dcp_audio_channels = 8;
109 _default_j2k_bandwidth = 150000000;
110 _default_audio_delay = 0;
111 _default_interop = false;
112 _default_metadata.clear ();
113 _upload_after_make_dcp = false;
116 _mail_protocol = EmailProtocol::AUTO;
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;
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.
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) {
152 _sound_output = optional<string> ();
153 _last_kdm_write_type = KDM_WRITE_FLAT;
154 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
155 _default_add_file_location = DefaultAddFileLocation::SAME_AS_LAST_TIME;
157 /* I think the scaling factor here should be the ratio of the longest frame
158 encode time to the shortest; if the thread count is T, longest time is L
159 and the shortest time S we could encode L/S frames per thread whilst waiting
160 for the L frame to encode so we might have to store LT/S frames.
162 However we don't want to use too much memory, so keep it a bit lower than we'd
163 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
164 use about 240Mb with 72 encoding threads.
166 _frames_in_memory_multiplier = 3;
167 _decode_reduction = optional<int>();
168 _default_notify = false;
169 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
170 _notification[i] = false;
172 _barco_username = optional<string>();
173 _barco_password = optional<string>();
174 _christie_username = optional<string>();
175 _christie_password = optional<string>();
176 _gdc_username = optional<string>();
177 _gdc_password = optional<string>();
178 _player_mode = PLAYER_MODE_WINDOW;
180 _video_view_type = VIDEO_VIEW_SIMPLE;
181 _respect_kdm_validity_periods = true;
182 _player_debug_log_file = boost::none;
183 _player_content_directory = boost::none;
184 _player_playlist_directory = boost::none;
185 _player_kdm_directory = boost::none;
186 _audio_mapping = boost::none;
187 _custom_languages.clear ();
188 _initial_paths.clear();
189 _initial_paths["AddFilesPath"] = boost::none;
190 _initial_paths["AddKDMPath"] = boost::none;
191 _initial_paths["AddDKDMPath"] = boost::none;
192 _initial_paths["SelectCertificatePath"] = boost::none;
193 _initial_paths["AddCombinerInputPath"] = boost::none;
194 _use_isdcf_name_by_default = true;
195 _write_kdms_to_disk = true;
197 _default_kdm_type = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
198 _default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
199 _auto_crop_threshold = 0.1;
200 _last_release_notes_version = boost::none;
201 _allow_smpte_bv20 = false;
202 _isdcf_name_part_length = 14;
204 _allowed_dcp_frame_rates.clear ();
205 _allowed_dcp_frame_rates.push_back (24);
206 _allowed_dcp_frame_rates.push_back (25);
207 _allowed_dcp_frame_rates.push_back (30);
208 _allowed_dcp_frame_rates.push_back (48);
209 _allowed_dcp_frame_rates.push_back (50);
210 _allowed_dcp_frame_rates.push_back (60);
212 set_kdm_email_to_default ();
213 set_notification_email_to_default ();
214 set_cover_sheet_to_default ();
216 _main_divider_sash_position = {};
217 _main_content_divider_sash_position = {};
219 _export.set_defaults();
223 Config::restore_defaults ()
225 Config::instance()->set_defaults ();
226 Config::instance()->changed ();
229 shared_ptr<dcp::CertificateChain>
230 Config::create_certificate_chain ()
232 return make_shared<dcp::CertificateChain> (
234 CERTIFICATE_VALIDITY_PERIOD,
237 ".dcpomatic.smpte-430-2.ROOT",
238 ".dcpomatic.smpte-430-2.INTERMEDIATE",
239 "CS.dcpomatic.smpte-430-2.LEAF"
246 using namespace boost::filesystem;
248 auto copy_adding_number = [](path const& path_to_copy) {
250 auto add_number = [](path const& path, int number) {
251 return String::compose("%1.%2", path, number);
255 while (n < 100 && exists(add_number(path_to_copy, n))) {
258 boost::system::error_code ec;
259 copy_file(path_to_copy, add_number(path_to_copy, n), ec);
262 /* Make a backup copy of any config.xml, cinemas.xml, dkdm_recipients.xml that we might be about
263 * to write over. This is more intended for the situation where we have a corrupted config.xml,
264 * and decide to overwrite it with a new one (possibly losing important details in the corrupted
265 * file). But we might as well back up the other files while we're about it.
268 /* This uses the State::write_path stuff so, e.g. for a current version 2.16 we might copy
269 * ~/.config/dcpomatic2/2.16/config.xml to ~/.config/dcpomatic2/2.16/config.xml.1
271 copy_adding_number (config_write_file());
273 /* These do not use State::write_path, so whatever path is in the Config we will copy
276 copy_adding_number (_cinemas_file);
277 copy_adding_number (_dkdm_recipients_file);
285 read_dkdm_recipients();
290 Config::read_config()
293 cxml::Document f ("Config");
294 f.read_file(config_read_file());
296 auto version = f.optional_number_child<int> ("Version");
297 if (version && *version < _current_version) {
298 /* Back up the old config before we re-write it in a back-incompatible way */
302 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
303 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
305 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
306 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
309 _default_directory = f.optional_string_child ("DefaultDirectory");
310 if (_default_directory && _default_directory->empty ()) {
311 /* We used to store an empty value for this to mean "none set" */
312 _default_directory = boost::optional<boost::filesystem::path> ();
315 auto b = f.optional_number_child<int> ("ServerPort");
317 b = f.optional_number_child<int> ("ServerPortBase");
319 _server_port_base = b.get ();
321 auto u = f.optional_bool_child ("UseAnyServers");
322 _use_any_servers = u.get_value_or (true);
324 for (auto i: f.node_children("Server")) {
325 if (i->node_children("HostName").size() == 1) {
326 _servers.push_back (i->string_child ("HostName"));
328 _servers.push_back (i->content ());
332 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
333 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
334 _tms_passive = f.optional_bool_child("TMSPassive").get_value_or(true);
335 _tms_ip = f.string_child ("TMSIP");
336 _tms_path = f.string_child ("TMSPath");
337 _tms_user = f.string_child ("TMSUser");
338 _tms_password = f.string_child ("TMSPassword");
340 _language = f.optional_string_child ("Language");
342 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
343 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
345 if (f.optional_string_child ("DCPMetadataIssuer")) {
346 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
347 } else if (f.optional_string_child ("DCPIssuer")) {
348 _dcp_issuer = f.string_child ("DCPIssuer");
351 auto up = f.optional_bool_child("UploadAfterMakeDCP");
353 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
355 _upload_after_make_dcp = up.get_value_or (false);
356 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
357 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
358 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
359 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
360 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
362 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
363 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
364 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
365 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
368 auto al = f.optional_string_child("DefaultAudioLanguage");
370 _default_audio_language = dcp::LanguageTag(*al);
372 } catch (std::runtime_error&) {}
375 auto te = f.optional_string_child("DefaultTerritory");
377 _default_territory = dcp::LanguageTag::RegionSubtag(*te);
379 } catch (std::runtime_error&) {}
381 for (auto const& i: f.node_children("DefaultMetadata")) {
382 _default_metadata[i->string_attribute("key")] = i->content();
385 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
387 /* Read any cinemas that are still lying around in the config file
388 * from an old version.
392 _mail_server = f.string_child ("MailServer");
393 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
396 /* Make sure this matches the code in write_config */
397 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
398 if (protocol == "Auto") {
399 _mail_protocol = EmailProtocol::AUTO;
400 } else if (protocol == "Plain") {
401 _mail_protocol = EmailProtocol::PLAIN;
402 } else if (protocol == "STARTTLS") {
403 _mail_protocol = EmailProtocol::STARTTLS;
404 } else if (protocol == "SSL") {
405 _mail_protocol = EmailProtocol::SSL;
409 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
410 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
412 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
413 _kdm_from = f.string_child ("KDMFrom");
414 for (auto i: f.node_children("KDMCC")) {
415 if (!i->content().empty()) {
416 _kdm_cc.push_back (i->content ());
419 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
420 _kdm_email = f.string_child ("KDMEmail");
422 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
423 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
424 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
425 for (auto i: f.node_children("NotificationCC")) {
426 if (!i->content().empty()) {
427 _notification_cc.push_back (i->content ());
430 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
431 if (f.optional_string_child("NotificationEmail")) {
432 _notification_email = f.string_child("NotificationEmail");
435 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
436 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
438 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
439 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
440 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
441 _allow_96khz_audio = f.optional_bool_child("Allow96kHzAudio").get_value_or(false);
442 _use_all_audio_channels = f.optional_bool_child("UseAllAudioChannels").get_value_or(false);
443 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
445 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
446 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
447 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
448 #ifdef DCPOMATIC_WINDOWS
449 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
452 for (auto i: f.node_children("History")) {
453 _history.push_back (i->content ());
456 for (auto i: f.node_children("PlayerHistory")) {
457 _player_history.push_back (i->content ());
460 auto signer = f.optional_node_child ("Signer");
462 auto c = make_shared<dcp::CertificateChain>();
463 /* Read the signing certificates and private key in from the config file */
464 for (auto i: signer->node_children ("Certificate")) {
465 c->add (dcp::Certificate (i->content ()));
467 c->set_key (signer->string_child ("PrivateKey"));
470 /* Make a new set of signing certificates and key */
471 _signer_chain = create_certificate_chain ();
474 auto decryption = f.optional_node_child ("Decryption");
476 auto c = make_shared<dcp::CertificateChain>();
477 for (auto i: decryption->node_children ("Certificate")) {
478 c->add (dcp::Certificate (i->content ()));
480 c->set_key (decryption->string_child ("PrivateKey"));
481 _decryption_chain = c;
483 _decryption_chain = create_certificate_chain ();
486 /* These must be done before we call Bad as that might set one
489 for (auto i: f.node_children("Nagged")) {
490 auto const id = i->number_attribute<int>("Id");
491 if (id >= 0 && id < NAG_COUNT) {
492 _nagged[id] = raw_convert<int>(i->content());
496 auto bad = check_certificates ();
498 auto const remake = Bad(*bad);
499 if (remake && *remake) {
501 case BAD_SIGNER_UTF8_STRINGS:
502 case BAD_SIGNER_INCONSISTENT:
503 case BAD_SIGNER_VALIDITY_TOO_LONG:
504 _signer_chain = create_certificate_chain ();
506 case BAD_DECRYPTION_INCONSISTENT:
507 _decryption_chain = create_certificate_chain ();
513 if (f.optional_node_child("DKDMGroup")) {
514 /* New-style: all DKDMs in a group */
515 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
517 /* Old-style: one or more DKDM nodes */
518 _dkdms = make_shared<DKDMGroup>("root");
519 for (auto i: f.node_children("DKDM")) {
520 _dkdms->add (DKDMBase::read (i));
523 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
524 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
525 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
526 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
527 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
528 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
529 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
530 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
531 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
532 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
533 /* The variable was renamed but not the XML tag */
534 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
535 _sound_output = f.optional_string_child("PreviewSoundOutput");
536 if (f.optional_string_child("CoverSheet")) {
537 _cover_sheet = f.optional_string_child("CoverSheet").get();
539 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
540 if (f.optional_string_child("LastKDMWriteType")) {
541 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
542 _last_kdm_write_type = KDM_WRITE_FLAT;
543 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
544 _last_kdm_write_type = KDM_WRITE_FOLDER;
545 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
546 _last_kdm_write_type = KDM_WRITE_ZIP;
549 if (f.optional_string_child("LastDKDMWriteType")) {
550 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
551 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
552 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
553 _last_dkdm_write_type = DKDM_WRITE_FILE;
556 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
557 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
558 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
560 for (auto i: f.node_children("Notification")) {
561 int const id = i->number_attribute<int>("Id");
562 if (id >= 0 && id < NOTIFICATION_COUNT) {
563 _notification[id] = raw_convert<int>(i->content());
567 _barco_username = f.optional_string_child("BarcoUsername");
568 _barco_password = f.optional_string_child("BarcoPassword");
569 _christie_username = f.optional_string_child("ChristieUsername");
570 _christie_password = f.optional_string_child("ChristiePassword");
571 _gdc_username = f.optional_string_child("GDCUsername");
572 _gdc_password = f.optional_string_child("GDCPassword");
574 auto pm = f.optional_string_child("PlayerMode");
575 if (pm && *pm == "window") {
576 _player_mode = PLAYER_MODE_WINDOW;
577 } else if (pm && *pm == "full") {
578 _player_mode = PLAYER_MODE_FULL;
579 } else if (pm && *pm == "dual") {
580 _player_mode = PLAYER_MODE_DUAL;
583 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
584 auto vc = f.optional_string_child("VideoViewType");
585 if (vc && *vc == "opengl") {
586 _video_view_type = VIDEO_VIEW_OPENGL;
587 } else if (vc && *vc == "simple") {
588 _video_view_type = VIDEO_VIEW_SIMPLE;
590 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
591 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
592 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
593 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
594 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
596 if (f.optional_node_child("AudioMapping")) {
597 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
600 for (auto i: f.node_children("CustomLanguage")) {
602 /* This will fail if it's called before dcp::init() as it won't recognise the
603 * tag. That's OK because the Config will be reloaded again later.
605 _custom_languages.push_back (dcp::LanguageTag(i->content()));
606 } catch (std::runtime_error& e) {}
609 for (auto& initial: _initial_paths) {
610 initial.second = f.optional_string_child(initial.first);
612 _use_isdcf_name_by_default = f.optional_bool_child("UseISDCFNameByDefault").get_value_or(true);
613 _write_kdms_to_disk = f.optional_bool_child("WriteKDMsToDisk").get_value_or(true);
614 _email_kdms = f.optional_bool_child("EmailKDMs").get_value_or(false);
615 _default_kdm_type = dcp::string_to_formulation(f.optional_string_child("DefaultKDMType").get_value_or("modified-transitional-1"));
616 if (auto duration = f.optional_node_child("DefaultKDMDuration")) {
617 _default_kdm_duration = RoughDuration(duration);
619 _default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
621 _auto_crop_threshold = f.optional_number_child<double>("AutoCropThreshold").get_value_or(0.1);
622 _last_release_notes_version = f.optional_string_child("LastReleaseNotesVersion");
623 _main_divider_sash_position = f.optional_number_child<int>("MainDividerSashPosition");
624 _main_content_divider_sash_position = f.optional_number_child<int>("MainContentDividerSashPosition");
626 if (auto loc = f.optional_string_child("DefaultAddFileLocation")) {
627 if (*loc == "last") {
628 _default_add_file_location = DefaultAddFileLocation::SAME_AS_LAST_TIME;
629 } else if (*loc == "project") {
630 _default_add_file_location = DefaultAddFileLocation::SAME_AS_PROJECT;
634 _allow_smpte_bv20 = f.optional_bool_child("AllowSMPTEBv20").get_value_or(false);
635 _isdcf_name_part_length = f.optional_number_child<int>("ISDCFNamePartLength").get_value_or(14);
637 _export.read(f.optional_node_child("Export"));
640 if (have_existing("config.xml")) {
642 /* We have a config file but it didn't load */
643 FailedToLoad(LoadFailure::CONFIG);
646 /* Make a new set of signing certificates and key */
647 _signer_chain = create_certificate_chain ();
648 /* And similar for decryption of KDMs */
649 _decryption_chain = create_certificate_chain ();
657 Config::read_cinemas()
659 if (dcp::filesystem::exists(_cinemas_file)) {
661 cxml::Document f("Cinemas");
662 f.read_file(dcp::filesystem::fix_long_path(_cinemas_file));
666 FailedToLoad(LoadFailure::CINEMAS);
674 Config::read_dkdm_recipients()
676 if (dcp::filesystem::exists(_dkdm_recipients_file)) {
678 cxml::Document f("DKDMRecipients");
679 f.read_file(dcp::filesystem::fix_long_path(_dkdm_recipients_file));
680 read_dkdm_recipients(f);
683 FailedToLoad(LoadFailure::DKDM_RECIPIENTS);
684 write_dkdm_recipients();
690 /** @return Singleton instance */
694 if (_instance == nullptr) {
695 _instance = new Config;
702 /** Write our configuration to disk */
704 Config::write () const
708 write_dkdm_recipients ();
712 Config::write_config () const
715 auto root = doc.create_root_node ("Config");
717 /* [XML] Version The version number of the configuration file format. */
718 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
719 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
720 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
721 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
722 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
723 if (_default_directory) {
724 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
725 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
727 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
728 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
729 by the batch converter to listen for job requests.
731 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
732 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
733 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
735 for (auto i: _servers) {
736 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
739 root->add_child("Server")->add_child_text (i);
742 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
743 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
745 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
746 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
747 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
748 /* [XML] TMSPassive True to use PASV mode with TMS FTP connections. */
749 root->add_child("TMSPassive")->add_child_text(_tms_passive ? "1" : "0");
750 /* [XML] TMSIP IP address of TMS. */
751 root->add_child("TMSIP")->add_child_text (_tms_ip);
752 /* [XML] TMSPath Path on the TMS to copy files to. */
753 root->add_child("TMSPath")->add_child_text (_tms_path);
754 /* [XML] TMSUser Username to log into the TMS with. */
755 root->add_child("TMSUser")->add_child_text (_tms_user);
756 /* [XML] TMSPassword Password to log into the TMS with. */
757 root->add_child("TMSPassword")->add_child_text (_tms_password);
759 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
760 root->add_child("Language")->add_child_text (_language.get());
762 if (_default_dcp_content_type) {
763 /* [XML:opt] DefaultDCPContentType Default content type to use when creating new films (<code>FTR</code>, <code>SHR</code>,
764 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
765 <code>PSA</code> or <code>ADV</code>). */
766 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
768 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
769 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
770 /* [XML] DCPIssuer Issuer text to write into CPL files. */
771 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
772 /* [XML] DCPCreator Creator text to write into CPL files. */
773 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
774 /* [XML] Company name to write into MXF files. */
775 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
776 /* [XML] Product name to write into MXF files. */
777 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
778 /* [XML] Product version to write into MXF files. */
779 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
780 /* [XML] Comment to write into JPEG2000 data. */
781 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
782 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
783 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
785 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
786 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
787 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
788 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
789 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
790 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
791 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
792 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
793 if (_default_audio_language) {
794 /* [XML] DefaultAudioLanguage Default audio language to use for new films */
795 root->add_child("DefaultAudioLanguage")->add_child_text(_default_audio_language->to_string());
797 if (_default_territory) {
798 /* [XML] DefaultTerritory Default territory to use for new films */
799 root->add_child("DefaultTerritory")->add_child_text(_default_territory->subtag());
801 for (auto const& i: _default_metadata) {
802 auto c = root->add_child("DefaultMetadata");
803 c->set_attribute("key", i.first);
804 c->add_child_text(i.second);
806 if (_default_kdm_directory) {
807 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
808 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
810 _default_kdm_duration.as_xml(root->add_child("DefaultKDMDuration"));
811 /* [XML] MailServer Hostname of SMTP server to use. */
812 root->add_child("MailServer")->add_child_text (_mail_server);
813 /* [XML] MailPort Port number to use on SMTP server. */
814 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
815 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
816 switch (_mail_protocol) {
817 case EmailProtocol::AUTO:
818 root->add_child("MailProtocol")->add_child_text("Auto");
820 case EmailProtocol::PLAIN:
821 root->add_child("MailProtocol")->add_child_text("Plain");
823 case EmailProtocol::STARTTLS:
824 root->add_child("MailProtocol")->add_child_text("STARTTLS");
826 case EmailProtocol::SSL:
827 root->add_child("MailProtocol")->add_child_text("SSL");
830 /* [XML] MailUser Username to use on SMTP server. */
831 root->add_child("MailUser")->add_child_text (_mail_user);
832 /* [XML] MailPassword Password to use on SMTP server. */
833 root->add_child("MailPassword")->add_child_text (_mail_password);
835 /* [XML] KDMSubject Subject to use for KDM emails. */
836 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
837 /* [XML] KDMFrom From address to use for KDM emails. */
838 root->add_child("KDMFrom")->add_child_text (_kdm_from);
839 for (auto i: _kdm_cc) {
840 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
841 root->add_child("KDMCC")->add_child_text (i);
843 /* [XML] KDMBCC BCC address to use for KDM emails. */
844 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
845 /* [XML] KDMEmail Text of KDM email. */
846 root->add_child("KDMEmail")->add_child_text (_kdm_email);
848 /* [XML] NotificationSubject Subject to use for notification emails. */
849 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
850 /* [XML] NotificationFrom From address to use for notification emails. */
851 root->add_child("NotificationFrom")->add_child_text (_notification_from);
852 /* [XML] NotificationFrom To address to use for notification emails. */
853 root->add_child("NotificationTo")->add_child_text (_notification_to);
854 for (auto i: _notification_cc) {
855 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
856 root->add_child("NotificationCC")->add_child_text (i);
858 /* [XML] NotificationBCC BCC address to use for notification emails. */
859 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
860 /* [XML] NotificationEmail Text of notification email. */
861 root->add_child("NotificationEmail")->add_child_text (_notification_email);
863 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
864 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
865 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
866 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
868 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
869 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
870 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
871 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
872 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
873 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
874 /* [XML] Allow96kHzAudio 1 to allow users to make DCPs with 96kHz audio, 0 to always make 48kHz DCPs */
875 root->add_child("Allow96kHzAudio")->add_child_text(_allow_96khz_audio ? "1" : "0");
876 /* [XML] UseAllAudioChannels 1 to allow users to map audio to all 16 DCP channels, 0 to limit to the channels used in standard DCPs */
877 root->add_child("UseAllAudioChannels")->add_child_text(_use_all_audio_channels ? "1" : "0");
878 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
879 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
880 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
881 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
882 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
883 related to the player, 1024 debug information related to audio analyses.
885 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
886 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
887 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
888 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
889 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
890 #ifdef DCPOMATIC_WINDOWS
891 if (_win32_console) {
892 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
893 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
894 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
896 root->add_child("Win32Console")->add_child_text ("1");
900 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
901 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
903 auto signer = root->add_child ("Signer");
904 DCPOMATIC_ASSERT (_signer_chain);
905 for (auto const& i: _signer_chain->unordered()) {
906 signer->add_child("Certificate")->add_child_text (i.certificate (true));
908 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
910 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
911 auto decryption = root->add_child ("Decryption");
912 DCPOMATIC_ASSERT (_decryption_chain);
913 for (auto const& i: _decryption_chain->unordered()) {
914 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
916 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
918 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
921 for (auto i: _history) {
922 root->add_child("History")->add_child_text (i.string ());
925 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
928 for (auto i: _player_history) {
929 root->add_child("PlayerHistory")->add_child_text (i.string ());
932 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
933 or <code><DKDM></code> tags.
935 /* [XML] DKDM A DKDM as XML */
936 _dkdms->as_xml (root);
938 /* [XML] CinemasFile Filename of cinemas list file. */
939 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
940 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
941 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
942 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
943 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
944 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
945 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
946 /* [XML] KDMFilenameFormat Format for KDM filenames. */
947 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
948 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
949 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
950 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
951 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
952 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
953 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
954 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
955 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
956 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
957 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
958 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
959 for (int i = 0; i < NAG_COUNT; ++i) {
960 xmlpp::Element* e = root->add_child ("Nagged");
961 e->set_attribute ("Id", raw_convert<string>(i));
962 e->add_child_text (_nagged[i] ? "1" : "0");
964 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
965 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
967 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
968 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
970 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
971 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
972 if (_last_player_load_directory) {
973 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
975 /* [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. */
976 if (_last_kdm_write_type) {
977 switch (_last_kdm_write_type.get()) {
979 root->add_child("LastKDMWriteType")->add_child_text("flat");
981 case KDM_WRITE_FOLDER:
982 root->add_child("LastKDMWriteType")->add_child_text("folder");
985 root->add_child("LastKDMWriteType")->add_child_text("zip");
989 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
990 if (_last_dkdm_write_type) {
991 switch (_last_dkdm_write_type.get()) {
992 case DKDM_WRITE_INTERNAL:
993 root->add_child("LastDKDMWriteType")->add_child_text("internal");
995 case DKDM_WRITE_FILE:
996 root->add_child("LastDKDMWriteType")->add_child_text("file");
1000 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
1001 frames to be held in memory at once.
1003 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
1005 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
1006 if (_decode_reduction) {
1007 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
1010 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
1011 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
1013 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
1014 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
1015 xmlpp::Element* e = root->add_child ("Notification");
1016 e->set_attribute ("Id", raw_convert<string>(i));
1017 e->add_child_text (_notification[i] ? "1" : "0");
1020 if (_barco_username) {
1021 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
1022 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
1024 if (_barco_password) {
1025 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
1026 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
1029 if (_christie_username) {
1030 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
1031 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
1033 if (_christie_password) {
1034 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
1035 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
1038 if (_gdc_username) {
1039 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
1040 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
1042 if (_gdc_password) {
1043 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
1044 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
1047 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
1048 with controls on another monitor.
1050 switch (_player_mode) {
1051 case PLAYER_MODE_WINDOW:
1052 root->add_child("PlayerMode")->add_child_text("window");
1054 case PLAYER_MODE_FULL:
1055 root->add_child("PlayerMode")->add_child_text("full");
1057 case PLAYER_MODE_DUAL:
1058 root->add_child("PlayerMode")->add_child_text("dual");
1062 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
1063 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
1064 switch (_video_view_type) {
1065 case VIDEO_VIEW_SIMPLE:
1066 root->add_child("VideoViewType")->add_child_text("simple");
1068 case VIDEO_VIEW_OPENGL:
1069 root->add_child("VideoViewType")->add_child_text("opengl");
1072 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
1073 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
1074 if (_player_debug_log_file) {
1075 /* [XML] PlayerLogFile Filename to use for player debug logs. */
1076 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
1078 if (_player_content_directory) {
1079 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
1080 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
1082 if (_player_playlist_directory) {
1083 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
1084 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1086 if (_player_kdm_directory) {
1087 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1088 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1090 if (_audio_mapping) {
1091 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1093 for (auto const& i: _custom_languages) {
1094 root->add_child("CustomLanguage")->add_child_text(i.to_string());
1096 for (auto const& initial: _initial_paths) {
1097 if (initial.second) {
1098 root->add_child(initial.first)->add_child_text(initial.second->string());
1101 root->add_child("UseISDCFNameByDefault")->add_child_text(_use_isdcf_name_by_default ? "1" : "0");
1102 root->add_child("WriteKDMsToDisk")->add_child_text(_write_kdms_to_disk ? "1" : "0");
1103 root->add_child("EmailKDMs")->add_child_text(_email_kdms ? "1" : "0");
1104 root->add_child("DefaultKDMType")->add_child_text(dcp::formulation_to_string(_default_kdm_type));
1105 root->add_child("AutoCropThreshold")->add_child_text(raw_convert<string>(_auto_crop_threshold));
1106 if (_last_release_notes_version) {
1107 root->add_child("LastReleaseNotesVersion")->add_child_text(*_last_release_notes_version);
1109 if (_main_divider_sash_position) {
1110 root->add_child("MainDividerSashPosition")->add_child_text(raw_convert<string>(*_main_divider_sash_position));
1112 if (_main_content_divider_sash_position) {
1113 root->add_child("MainContentDividerSashPosition")->add_child_text(raw_convert<string>(*_main_content_divider_sash_position));
1116 root->add_child("DefaultAddFileLocation")->add_child_text(
1117 _default_add_file_location == DefaultAddFileLocation::SAME_AS_LAST_TIME ? "last" : "project"
1120 /* [XML] AllowSMPTEBv20 1 to allow the user to choose SMPTE (Bv2.0 only) as a standard, otherwise 0 */
1121 root->add_child("AllowSMPTEBv20")->add_child_text(_allow_smpte_bv20 ? "1" : "0");
1122 /* [XML] ISDCFNamePartLength Maximum length of the "name" part of an ISDCF name, which should be 14 according to the standard */
1123 root->add_child("ISDCFNamePartLength")->add_child_text(raw_convert<string>(_isdcf_name_part_length));
1125 _export.write(root->add_child("Export"));
1127 auto target = config_write_file();
1130 auto const s = doc.write_to_string_formatted ();
1131 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1132 dcp::File f(tmp, "w");
1134 throw FileError (_("Could not open file for writing"), tmp);
1136 f.checked_write(s.c_str(), s.bytes());
1138 dcp::filesystem::remove(target);
1139 dcp::filesystem::rename(tmp, target);
1140 } catch (xmlpp::exception& e) {
1141 string s = e.what ();
1143 throw FileError (s, target);
1150 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1152 xmlpp::Document doc;
1153 auto root = doc.create_root_node (root_node);
1154 root->add_child("Version")->add_child_text(version);
1156 for (auto i: things) {
1157 i->as_xml (root->add_child(node));
1161 doc.write_to_file_formatted (file.string() + ".tmp");
1162 dcp::filesystem::remove(file);
1163 dcp::filesystem::rename(file.string() + ".tmp", file);
1164 } catch (xmlpp::exception& e) {
1165 string s = e.what ();
1167 throw FileError (s, file);
1173 Config::write_cinemas () const
1175 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1180 Config::write_dkdm_recipients () const
1182 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1186 boost::filesystem::path
1187 Config::default_directory_or (boost::filesystem::path a) const
1189 return directory_or (_default_directory, a);
1192 boost::filesystem::path
1193 Config::default_kdm_directory_or (boost::filesystem::path a) const
1195 return directory_or (_default_kdm_directory, a);
1198 boost::filesystem::path
1199 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1205 boost::system::error_code ec;
1206 auto const e = dcp::filesystem::exists(*dir, ec);
1222 Config::changed (Property what)
1228 Config::set_kdm_email_to_default ()
1230 _kdm_subject = _("KDM delivery: $CPL_NAME");
1233 "Dear Projectionist\n\n"
1234 "Please find attached KDMs for $CPL_NAME.\n\n"
1235 "Cinema: $CINEMA_NAME\n"
1236 "Screen(s): $SCREENS\n\n"
1237 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1238 "Best regards,\nDCP-o-matic"
1243 Config::set_notification_email_to_default ()
1245 _notification_subject = _("DCP-o-matic notification");
1247 _notification_email = _(
1248 "$JOB_NAME: $JOB_STATUS"
1253 Config::reset_kdm_email ()
1255 set_kdm_email_to_default ();
1260 Config::reset_notification_email ()
1262 set_notification_email_to_default ();
1267 Config::set_cover_sheet_to_default ()
1271 "CPL Filename: $CPL_FILENAME\n"
1273 "Format: $CONTAINER\n"
1275 "Audio Language: $AUDIO_LANGUAGE\n"
1276 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1283 Config::add_to_history (boost::filesystem::path p)
1285 add_to_history_internal (_history, p);
1288 /** Remove non-existent items from the history */
1290 Config::clean_history ()
1292 clean_history_internal (_history);
1296 Config::add_to_player_history (boost::filesystem::path p)
1298 add_to_history_internal (_player_history, p);
1301 /** Remove non-existent items from the player history */
1303 Config::clean_player_history ()
1305 clean_history_internal (_player_history);
1309 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1311 /* Remove existing instances of this path in the history */
1312 h.erase (remove (h.begin(), h.end(), p), h.end ());
1314 h.insert (h.begin (), p);
1315 if (h.size() > HISTORY_SIZE) {
1323 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1329 if (dcp::filesystem::is_directory(i)) {
1333 /* We couldn't find out if it's a directory for some reason; just ignore it */
1340 Config::have_existing (string file)
1342 return dcp::filesystem::exists(read_path(file));
1347 Config::read_cinemas (cxml::Document const & f)
1350 for (auto i: f.node_children("Cinema")) {
1351 /* Slightly grotty two-part construction of Cinema here so that we can use
1354 auto cinema = make_shared<Cinema>(i);
1355 cinema->read_screens (i);
1356 _cinemas.push_back (cinema);
1361 Config::set_cinemas_file (boost::filesystem::path file)
1363 if (file == _cinemas_file) {
1367 _cinemas_file = file;
1369 if (dcp::filesystem::exists(_cinemas_file)) {
1370 /* Existing file; read it in */
1371 cxml::Document f ("Cinemas");
1372 f.read_file(dcp::filesystem::fix_long_path(_cinemas_file));
1382 Config::read_dkdm_recipients (cxml::Document const & f)
1384 _dkdm_recipients.clear ();
1385 for (auto i: f.node_children("DKDMRecipient")) {
1386 _dkdm_recipients.push_back (make_shared<DKDMRecipient>(i));
1392 Config::save_template (shared_ptr<const Film> film, string name) const
1394 film->write_template (template_write_path(name));
1399 Config::templates () const
1401 if (!dcp::filesystem::exists(read_path("templates"))) {
1406 for (auto const& i: dcp::filesystem::directory_iterator(read_path("templates"))) {
1407 n.push_back (i.path().filename().string());
1413 Config::existing_template (string name) const
1415 return dcp::filesystem::exists(template_read_path(name));
1419 boost::filesystem::path
1420 Config::template_read_path (string name) const
1422 return read_path("templates") / tidy_for_filename (name);
1426 boost::filesystem::path
1427 Config::template_write_path (string name) const
1429 return write_path("templates") / tidy_for_filename (name);
1434 Config::rename_template (string old_name, string new_name) const
1436 dcp::filesystem::rename(template_read_path(old_name), template_write_path(new_name));
1440 Config::delete_template (string name) const
1442 dcp::filesystem::remove(template_write_path(name));
1445 /** @return Path to the config.xml containing the actual settings, following a link if required */
1446 boost::filesystem::path
1447 config_file (boost::filesystem::path main)
1449 cxml::Document f ("Config");
1450 if (!dcp::filesystem::exists(main)) {
1451 /* It doesn't exist, so there can't be any links; just return it */
1455 /* See if there's a link */
1457 f.read_file(dcp::filesystem::fix_long_path(main));
1458 auto link = f.optional_string_child("Link");
1462 } catch (xmlpp::exception& e) {
1463 /* There as a problem reading the main configuration file,
1464 so there can't be a link.
1472 boost::filesystem::path
1473 Config::config_read_file ()
1475 return config_file (read_path("config.xml"));
1479 boost::filesystem::path
1480 Config::config_write_file ()
1482 return config_file (write_path("config.xml"));
1487 Config::reset_cover_sheet ()
1489 set_cover_sheet_to_default ();
1494 Config::link (boost::filesystem::path new_file) const
1496 xmlpp::Document doc;
1497 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1499 doc.write_to_file_formatted(write_path("config.xml").string());
1500 } catch (xmlpp::exception& e) {
1501 string s = e.what ();
1503 throw FileError (s, write_path("config.xml"));
1508 Config::copy_and_link (boost::filesystem::path new_file) const
1511 dcp::filesystem::copy_file(config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1516 Config::have_write_permission () const
1518 dcp::File f(config_write_file(), "r+");
1519 return static_cast<bool>(f);
1522 /** @param output_channels Number of output channels in use.
1523 * @return Audio mapping for this output channel count (may be a default).
1526 Config::audio_mapping (int output_channels)
1528 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1529 /* Set up a default */
1530 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1531 if (output_channels == 2) {
1532 /* Special case for stereo output.
1533 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1534 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1536 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1537 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1538 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1539 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1540 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1541 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1542 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1543 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1546 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1547 _audio_mapping->set (i, i, 1);
1552 return *_audio_mapping;
1556 Config::set_audio_mapping (AudioMapping m)
1559 changed (AUDIO_MAPPING);
1563 Config::set_audio_mapping_to_default ()
1565 DCPOMATIC_ASSERT (_audio_mapping);
1566 auto const ch = _audio_mapping->output_channels ();
1567 _audio_mapping = boost::none;
1568 _audio_mapping = audio_mapping (ch);
1569 changed (AUDIO_MAPPING);
1574 Config::add_custom_language (dcp::LanguageTag tag)
1576 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1577 _custom_languages.push_back (tag);
1583 optional<Config::BadReason>
1584 Config::check_certificates () const
1586 optional<BadReason> bad;
1588 for (auto const& i: _signer_chain->unordered()) {
1589 if (i.has_utf8_strings()) {
1590 bad = BAD_SIGNER_UTF8_STRINGS;
1592 if ((i.not_after().year() - i.not_before().year()) > 15) {
1593 bad = BAD_SIGNER_VALIDITY_TOO_LONG;
1597 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
1598 bad = BAD_SIGNER_INCONSISTENT;
1601 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
1602 bad = BAD_DECRYPTION_INCONSISTENT;
1610 save_all_config_as_zip (boost::filesystem::path zip_file)
1612 Zipper zipper (zip_file);
1614 auto config = Config::instance();
1615 zipper.add ("config.xml", dcp::file_to_string(config->config_read_file()));
1616 if (dcp::filesystem::exists(config->cinemas_file())) {
1617 zipper.add ("cinemas.xml", dcp::file_to_string(config->cinemas_file()));
1619 if (dcp::filesystem::exists(config->dkdm_recipients_file())) {
1620 zipper.add ("dkdm_recipients.xml", dcp::file_to_string(config->dkdm_recipients_file()));
1628 Config::set_initial_path(string id, boost::filesystem::path path)
1630 auto iter = _initial_paths.find(id);
1631 DCPOMATIC_ASSERT(iter != _initial_paths.end());
1632 iter->second = path;
1637 optional<boost::filesystem::path>
1638 Config::initial_path(string id) const
1640 auto iter = _initial_paths.find(id);
1641 DCPOMATIC_ASSERT(iter != _initial_paths.end());
1642 return iter->second;