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"
29 #include "dcp_content_type.h"
30 #include "dkdm_recipient.h"
31 #include "dkdm_wrapper.h"
37 #include <dcp/certificate_chain.h>
38 #include <dcp/name_format.h>
39 #include <dcp/raw_convert.h>
40 #include <libcxml/cxml.h>
42 #include <libxml++/libxml++.h>
43 #include <boost/filesystem.hpp>
44 #include <boost/algorithm/string.hpp>
45 #include <boost/thread.hpp>
54 using std::dynamic_pointer_cast;
57 using std::make_shared;
61 using std::shared_ptr;
64 using boost::algorithm::trim;
65 using boost::optional;
66 using dcp::raw_convert;
69 Config* Config::_instance = 0;
70 int const Config::_current_version = 3;
71 boost::signals2::signal<void (Config::LoadFailure)> Config::FailedToLoad;
72 boost::signals2::signal<void (string)> Config::Warning;
73 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
76 /** Construct default configuration */
78 /* DKDMs are not considered a thing to reset on set_defaults() */
79 : _dkdms (new DKDMGroup ("root"))
80 , _default_kdm_duration (1, RoughDuration::Unit::WEEKS)
87 Config::set_defaults ()
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;
94 _only_servers_encode = false;
95 _tms_protocol = FileTransferProtocol::SCP;
101 _allow_any_dcp_frame_rate = false;
102 _allow_any_container = false;
103 _allow_96khz_audio = false;
104 _use_all_audio_channels = false;
105 _show_experimental_audio_processors = false;
106 _language = optional<string> ();
107 _default_still_length = 10;
108 _default_audio_delay = 0;
109 _default_interop = false;
110 _default_metadata.clear ();
111 _upload_after_make_dcp = false;
114 _mail_protocol = EmailProtocol::AUTO;
120 _notification_from = "";
121 _notification_to = "";
122 _notification_cc.clear ();
123 _notification_bcc = "";
124 _check_for_updates = false;
125 _check_for_test_updates = false;
126 _maximum_j2k_bandwidth = 250000000;
127 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
128 _analyse_ebur128 = true;
129 _automatic_audio_analysis = false;
130 #ifdef DCPOMATIC_WINDOWS
131 _win32_console = false;
133 /* At the moment we don't write these files anywhere new after a version change, so they will be read from
134 * ~/.config/dcpomatic2 (or equivalent) and written back there.
136 _cinemas_file = read_path ("cinemas.xml");
137 _dkdm_recipients_file = read_path ("dkdm_recipients.xml");
138 _show_hints_before_make_dcp = true;
139 _confirm_kdm_email = true;
140 _kdm_container_name_format = dcp::NameFormat("KDM_%f_%c");
141 _kdm_filename_format = dcp::NameFormat("KDM_%f_%c_%s");
142 _dkdm_filename_format = dcp::NameFormat("DKDM_%f_%c_%s");
143 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
144 _dcp_asset_filename_format = dcp::NameFormat ("%t");
145 _jump_to_selected = true;
146 for (int i = 0; i < NAG_COUNT; ++i) {
150 _sound_output = optional<string> ();
151 _last_kdm_write_type = KDM_WRITE_FLAT;
152 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
153 _default_add_file_location = DefaultAddFileLocation::SAME_AS_LAST_TIME;
155 /* I think the scaling factor here should be the ratio of the longest frame
156 encode time to the shortest; if the thread count is T, longest time is L
157 and the shortest time S we could encode L/S frames per thread whilst waiting
158 for the L frame to encode so we might have to store LT/S frames.
160 However we don't want to use too much memory, so keep it a bit lower than we'd
161 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
162 use about 240Mb with 72 encoding threads.
164 _frames_in_memory_multiplier = 3;
165 _decode_reduction = optional<int>();
166 _default_notify = false;
167 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
168 _notification[i] = false;
170 _barco_username = optional<string>();
171 _barco_password = optional<string>();
172 _christie_username = optional<string>();
173 _christie_password = optional<string>();
174 _gdc_username = optional<string>();
175 _gdc_password = optional<string>();
176 _player_mode = PLAYER_MODE_WINDOW;
178 _video_view_type = VIDEO_VIEW_SIMPLE;
179 _respect_kdm_validity_periods = true;
180 _player_debug_log_file = boost::none;
181 _player_content_directory = boost::none;
182 _player_playlist_directory = boost::none;
183 _player_kdm_directory = boost::none;
184 _audio_mapping = boost::none;
185 _custom_languages.clear ();
186 _initial_paths.clear();
187 _initial_paths["AddFilesPath"] = boost::none;
188 _initial_paths["AddDKDMPath"] = boost::none;
189 _initial_paths["SelectCertificatePath"] = boost::none;
190 _initial_paths["AddCombinerInputPath"] = boost::none;
191 _use_isdcf_name_by_default = true;
192 _write_kdms_to_disk = true;
194 _default_kdm_type = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
195 _default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
196 _auto_crop_threshold = 0.1;
197 _last_release_notes_version = boost::none;
198 _allow_smpte_bv20 = false;
199 _isdcf_name_part_length = 14;
201 _allowed_dcp_frame_rates.clear ();
202 _allowed_dcp_frame_rates.push_back (24);
203 _allowed_dcp_frame_rates.push_back (25);
204 _allowed_dcp_frame_rates.push_back (30);
205 _allowed_dcp_frame_rates.push_back (48);
206 _allowed_dcp_frame_rates.push_back (50);
207 _allowed_dcp_frame_rates.push_back (60);
209 set_kdm_email_to_default ();
210 set_notification_email_to_default ();
211 set_cover_sheet_to_default ();
213 _main_divider_sash_position = {};
214 _main_content_divider_sash_position = {};
216 _export.set_defaults();
220 Config::restore_defaults ()
222 Config::instance()->set_defaults ();
223 Config::instance()->changed ();
226 shared_ptr<dcp::CertificateChain>
227 Config::create_certificate_chain ()
229 return make_shared<dcp::CertificateChain> (
231 CERTIFICATE_VALIDITY_PERIOD,
234 ".dcpomatic.smpte-430-2.ROOT",
235 ".dcpomatic.smpte-430-2.INTERMEDIATE",
236 "CS.dcpomatic.smpte-430-2.LEAF"
243 using namespace boost::filesystem;
245 auto copy_adding_number = [](path const& path_to_copy) {
247 auto add_number = [](path const& path, int number) {
248 return String::compose("%1.%2", path, number);
252 while (n < 100 && exists(add_number(path_to_copy, n))) {
255 boost::system::error_code ec;
256 copy_file(path_to_copy, add_number(path_to_copy, n), ec);
259 /* Make a backup copy of any config.xml, cinemas.xml, dkdm_recipients.xml that we might be about
260 * to write over. This is more intended for the situation where we have a corrupted config.xml,
261 * and decide to overwrite it with a new one (possibly losing important details in the corrupted
262 * file). But we might as well back up the other files while we're about it.
265 /* This uses the State::write_path stuff so, e.g. for a current version 2.16 we might copy
266 * ~/.config/dcpomatic2/2.16/config.xml to ~/.config/dcpomatic2/2.16/config.xml.1
268 copy_adding_number (config_write_file());
270 /* These do not use State::write_path, so whatever path is in the Config we will copy
273 copy_adding_number (_cinemas_file);
274 copy_adding_number (_dkdm_recipients_file);
282 read_dkdm_recipients();
287 Config::read_config()
290 cxml::Document f ("Config");
291 f.read_file (config_read_file());
293 auto version = f.optional_number_child<int> ("Version");
294 if (version && *version < _current_version) {
295 /* Back up the old config before we re-write it in a back-incompatible way */
299 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
300 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
302 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
303 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
306 _default_directory = f.optional_string_child ("DefaultDirectory");
307 if (_default_directory && _default_directory->empty ()) {
308 /* We used to store an empty value for this to mean "none set" */
309 _default_directory = boost::optional<boost::filesystem::path> ();
312 auto b = f.optional_number_child<int> ("ServerPort");
314 b = f.optional_number_child<int> ("ServerPortBase");
316 _server_port_base = b.get ();
318 auto u = f.optional_bool_child ("UseAnyServers");
319 _use_any_servers = u.get_value_or (true);
321 for (auto i: f.node_children("Server")) {
322 if (i->node_children("HostName").size() == 1) {
323 _servers.push_back (i->string_child ("HostName"));
325 _servers.push_back (i->content ());
329 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
330 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
331 _tms_passive = f.optional_bool_child("TMSPassive").get_value_or(true);
332 _tms_ip = f.string_child ("TMSIP");
333 _tms_path = f.string_child ("TMSPath");
334 _tms_user = f.string_child ("TMSUser");
335 _tms_password = f.string_child ("TMSPassword");
337 _language = f.optional_string_child ("Language");
339 if (f.optional_string_child ("DCPMetadataIssuer")) {
340 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
341 } else if (f.optional_string_child ("DCPIssuer")) {
342 _dcp_issuer = f.string_child ("DCPIssuer");
345 auto up = f.optional_bool_child("UploadAfterMakeDCP");
347 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
349 _upload_after_make_dcp = up.get_value_or (false);
350 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
351 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
352 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
353 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
354 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
356 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
357 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
358 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
361 auto al = f.optional_string_child("DefaultAudioLanguage");
363 _default_audio_language = dcp::LanguageTag(*al);
365 } catch (std::runtime_error&) {}
368 auto te = f.optional_string_child("DefaultTerritory");
370 _default_territory = dcp::LanguageTag::RegionSubtag(*te);
372 } catch (std::runtime_error&) {}
374 for (auto const& i: f.node_children("DefaultMetadata")) {
375 _default_metadata[i->string_attribute("key")] = i->content();
378 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
380 /* Read any cinemas that are still lying around in the config file
381 * from an old version.
385 _mail_server = f.string_child ("MailServer");
386 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
389 /* Make sure this matches the code in write_config */
390 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
391 if (protocol == "Auto") {
392 _mail_protocol = EmailProtocol::AUTO;
393 } else if (protocol == "Plain") {
394 _mail_protocol = EmailProtocol::PLAIN;
395 } else if (protocol == "STARTTLS") {
396 _mail_protocol = EmailProtocol::STARTTLS;
397 } else if (protocol == "SSL") {
398 _mail_protocol = EmailProtocol::SSL;
402 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
403 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
405 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
406 _kdm_from = f.string_child ("KDMFrom");
407 for (auto i: f.node_children("KDMCC")) {
408 if (!i->content().empty()) {
409 _kdm_cc.push_back (i->content ());
412 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
413 _kdm_email = f.string_child ("KDMEmail");
415 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
416 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
417 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
418 for (auto i: f.node_children("NotificationCC")) {
419 if (!i->content().empty()) {
420 _notification_cc.push_back (i->content ());
423 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
424 if (f.optional_string_child("NotificationEmail")) {
425 _notification_email = f.string_child("NotificationEmail");
428 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
429 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
431 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
432 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
433 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
434 _allow_96khz_audio = f.optional_bool_child("Allow96kHzAudio").get_value_or(false);
435 _use_all_audio_channels = f.optional_bool_child("UseAllAudioChannels").get_value_or(false);
436 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
438 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
439 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
440 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
441 #ifdef DCPOMATIC_WINDOWS
442 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
445 for (auto i: f.node_children("History")) {
446 _history.push_back (i->content ());
449 for (auto i: f.node_children("PlayerHistory")) {
450 _player_history.push_back (i->content ());
453 auto signer = f.optional_node_child ("Signer");
455 auto c = make_shared<dcp::CertificateChain>();
456 /* Read the signing certificates and private key in from the config file */
457 for (auto i: signer->node_children ("Certificate")) {
458 c->add (dcp::Certificate (i->content ()));
460 c->set_key (signer->string_child ("PrivateKey"));
463 /* Make a new set of signing certificates and key */
464 _signer_chain = create_certificate_chain ();
467 auto decryption = f.optional_node_child ("Decryption");
469 auto c = make_shared<dcp::CertificateChain>();
470 for (auto i: decryption->node_children ("Certificate")) {
471 c->add (dcp::Certificate (i->content ()));
473 c->set_key (decryption->string_child ("PrivateKey"));
474 _decryption_chain = c;
476 _decryption_chain = create_certificate_chain ();
479 /* These must be done before we call Bad as that might set one
482 for (auto i: f.node_children("Nagged")) {
483 auto const id = number_attribute<int>(i, "Id", "id");
484 if (id >= 0 && id < NAG_COUNT) {
485 _nagged[id] = raw_convert<int>(i->content());
489 auto bad = check_certificates ();
491 auto const remake = Bad(*bad);
492 if (remake && *remake) {
494 case BAD_SIGNER_UTF8_STRINGS:
495 case BAD_SIGNER_INCONSISTENT:
496 case BAD_SIGNER_VALIDITY_TOO_LONG:
497 _signer_chain = create_certificate_chain ();
499 case BAD_DECRYPTION_INCONSISTENT:
500 _decryption_chain = create_certificate_chain ();
506 if (f.optional_node_child("DKDMGroup")) {
507 /* New-style: all DKDMs in a group */
508 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
510 /* Old-style: one or more DKDM nodes */
511 _dkdms = make_shared<DKDMGroup>("root");
512 for (auto i: f.node_children("DKDM")) {
513 _dkdms->add (DKDMBase::read (i));
516 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
517 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
518 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
519 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
520 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
521 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
522 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
523 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
524 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
525 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
526 /* The variable was renamed but not the XML tag */
527 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
528 _sound_output = f.optional_string_child("PreviewSoundOutput");
529 if (f.optional_string_child("CoverSheet")) {
530 _cover_sheet = f.optional_string_child("CoverSheet").get();
532 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
533 if (f.optional_string_child("LastKDMWriteType")) {
534 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
535 _last_kdm_write_type = KDM_WRITE_FLAT;
536 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
537 _last_kdm_write_type = KDM_WRITE_FOLDER;
538 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
539 _last_kdm_write_type = KDM_WRITE_ZIP;
542 if (f.optional_string_child("LastDKDMWriteType")) {
543 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
544 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
545 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
546 _last_dkdm_write_type = DKDM_WRITE_FILE;
549 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
550 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
551 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
553 for (auto i: f.node_children("Notification")) {
554 int const id = number_attribute<int>(i, "Id", "id");
555 if (id >= 0 && id < NOTIFICATION_COUNT) {
556 _notification[id] = raw_convert<int>(i->content());
560 _barco_username = f.optional_string_child("BarcoUsername");
561 _barco_password = f.optional_string_child("BarcoPassword");
562 _christie_username = f.optional_string_child("ChristieUsername");
563 _christie_password = f.optional_string_child("ChristiePassword");
564 _gdc_username = f.optional_string_child("GDCUsername");
565 _gdc_password = f.optional_string_child("GDCPassword");
567 auto pm = f.optional_string_child("PlayerMode");
568 if (pm && *pm == "window") {
569 _player_mode = PLAYER_MODE_WINDOW;
570 } else if (pm && *pm == "full") {
571 _player_mode = PLAYER_MODE_FULL;
572 } else if (pm && *pm == "dual") {
573 _player_mode = PLAYER_MODE_DUAL;
576 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
577 auto vc = f.optional_string_child("VideoViewType");
578 if (vc && *vc == "opengl") {
579 _video_view_type = VIDEO_VIEW_OPENGL;
580 } else if (vc && *vc == "simple") {
581 _video_view_type = VIDEO_VIEW_SIMPLE;
583 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
584 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
585 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
586 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
587 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
589 if (f.optional_node_child("AudioMapping")) {
590 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
593 for (auto i: f.node_children("CustomLanguage")) {
595 /* This will fail if it's called before dcp::init() as it won't recognise the
596 * tag. That's OK because the Config will be reloaded again later.
598 _custom_languages.push_back (dcp::LanguageTag(i->content()));
599 } catch (std::runtime_error& e) {}
602 for (auto& initial: _initial_paths) {
603 initial.second = f.optional_string_child(initial.first);
605 _use_isdcf_name_by_default = f.optional_bool_child("UseISDCFNameByDefault").get_value_or(true);
606 _write_kdms_to_disk = f.optional_bool_child("WriteKDMsToDisk").get_value_or(true);
607 _email_kdms = f.optional_bool_child("EmailKDMs").get_value_or(false);
608 _default_kdm_type = dcp::string_to_formulation(f.optional_string_child("DefaultKDMType").get_value_or("modified-transitional-1"));
609 if (auto duration = f.optional_node_child("DefaultKDMDuration")) {
610 _default_kdm_duration = RoughDuration(duration);
612 _default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
614 _auto_crop_threshold = f.optional_number_child<double>("AutoCropThreshold").get_value_or(0.1);
615 _last_release_notes_version = f.optional_string_child("LastReleaseNotesVersion");
616 _main_divider_sash_position = f.optional_number_child<int>("MainDividerSashPosition");
617 _main_content_divider_sash_position = f.optional_number_child<int>("MainContentDividerSashPosition");
619 if (auto loc = f.optional_string_child("DefaultAddFileLocation")) {
620 if (*loc == "last") {
621 _default_add_file_location = DefaultAddFileLocation::SAME_AS_LAST_TIME;
622 } else if (*loc == "project") {
623 _default_add_file_location = DefaultAddFileLocation::SAME_AS_PROJECT;
627 _allow_smpte_bv20 = f.optional_bool_child("AllowSMPTEBv20").get_value_or(false);
628 _isdcf_name_part_length = f.optional_number_child<int>("ISDCFNamePartLength").get_value_or(14);
630 _export.read(f.optional_node_child("Export"));
633 if (have_existing("config.xml")) {
635 /* We have a config file but it didn't load */
636 FailedToLoad(LoadFailure::CONFIG);
639 /* Make a new set of signing certificates and key */
640 _signer_chain = create_certificate_chain ();
641 /* And similar for decryption of KDMs */
642 _decryption_chain = create_certificate_chain ();
648 Config::read_cinemas()
650 if (boost::filesystem::exists (_cinemas_file)) {
652 cxml::Document f("Cinemas");
653 f.read_file(_cinemas_file);
657 FailedToLoad(LoadFailure::CINEMAS);
665 Config::read_dkdm_recipients()
667 if (boost::filesystem::exists (_dkdm_recipients_file)) {
669 cxml::Document f("DKDMRecipients");
670 f.read_file(_dkdm_recipients_file);
671 read_dkdm_recipients(f);
674 FailedToLoad(LoadFailure::DKDM_RECIPIENTS);
675 write_dkdm_recipients();
681 /** @return Singleton instance */
685 if (_instance == nullptr) {
686 _instance = new Config;
693 /** Write our configuration to disk */
695 Config::write () const
699 write_dkdm_recipients ();
703 Config::write_config () const
706 auto root = doc.create_root_node ("Config");
708 /* [XML] Version The version number of the configuration file format. */
709 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
710 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
711 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
712 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
713 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
714 if (_default_directory) {
715 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
716 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
718 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
719 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
720 by the batch converter to listen for job requests.
722 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
723 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
724 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
726 for (auto i: _servers) {
727 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
730 root->add_child("Server")->add_child_text (i);
733 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
734 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
736 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
737 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
738 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
739 /* [XML] TMSPassive True to use PASV mode with TMS FTP connections. */
740 root->add_child("TMSPassive")->add_child_text(_tms_passive ? "1" : "0");
741 /* [XML] TMSIP IP address of TMS. */
742 root->add_child("TMSIP")->add_child_text (_tms_ip);
743 /* [XML] TMSPath Path on the TMS to copy files to. */
744 root->add_child("TMSPath")->add_child_text (_tms_path);
745 /* [XML] TMSUser Username to log into the TMS with. */
746 root->add_child("TMSUser")->add_child_text (_tms_user);
747 /* [XML] TMSPassword Password to log into the TMS with. */
748 root->add_child("TMSPassword")->add_child_text (_tms_password);
750 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
751 root->add_child("Language")->add_child_text (_language.get());
753 /* [XML] DCPIssuer Issuer text to write into CPL files. */
754 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
755 /* [XML] DCPCreator Creator text to write into CPL files. */
756 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
757 /* [XML] Company name to write into MXF files. */
758 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
759 /* [XML] Product name to write into MXF files. */
760 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
761 /* [XML] Product version to write into MXF files. */
762 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
763 /* [XML] Comment to write into JPEG2000 data. */
764 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
765 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
766 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
768 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
769 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
770 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
771 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
772 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
773 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
774 if (_default_audio_language) {
775 /* [XML] DefaultAudioLanguage Default audio language to use for new films */
776 root->add_child("DefaultAudioLanguage")->add_child_text(_default_audio_language->to_string());
778 if (_default_territory) {
779 /* [XML] DefaultTerritory Default territory to use for new films */
780 root->add_child("DefaultTerritory")->add_child_text(_default_territory->subtag());
782 for (auto const& i: _default_metadata) {
783 auto c = root->add_child("DefaultMetadata");
784 c->set_attribute("key", i.first);
785 c->add_child_text(i.second);
787 if (_default_kdm_directory) {
788 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
789 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
791 _default_kdm_duration.as_xml(root->add_child("DefaultKDMDuration"));
792 /* [XML] MailServer Hostname of SMTP server to use. */
793 root->add_child("MailServer")->add_child_text (_mail_server);
794 /* [XML] MailPort Port number to use on SMTP server. */
795 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
796 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
797 switch (_mail_protocol) {
798 case EmailProtocol::AUTO:
799 root->add_child("MailProtocol")->add_child_text("Auto");
801 case EmailProtocol::PLAIN:
802 root->add_child("MailProtocol")->add_child_text("Plain");
804 case EmailProtocol::STARTTLS:
805 root->add_child("MailProtocol")->add_child_text("STARTTLS");
807 case EmailProtocol::SSL:
808 root->add_child("MailProtocol")->add_child_text("SSL");
811 /* [XML] MailUser Username to use on SMTP server. */
812 root->add_child("MailUser")->add_child_text (_mail_user);
813 /* [XML] MailPassword Password to use on SMTP server. */
814 root->add_child("MailPassword")->add_child_text (_mail_password);
816 /* [XML] KDMSubject Subject to use for KDM emails. */
817 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
818 /* [XML] KDMFrom From address to use for KDM emails. */
819 root->add_child("KDMFrom")->add_child_text (_kdm_from);
820 for (auto i: _kdm_cc) {
821 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
822 root->add_child("KDMCC")->add_child_text (i);
824 /* [XML] KDMBCC BCC address to use for KDM emails. */
825 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
826 /* [XML] KDMEmail Text of KDM email. */
827 root->add_child("KDMEmail")->add_child_text (_kdm_email);
829 /* [XML] NotificationSubject Subject to use for notification emails. */
830 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
831 /* [XML] NotificationFrom From address to use for notification emails. */
832 root->add_child("NotificationFrom")->add_child_text (_notification_from);
833 /* [XML] NotificationFrom To address to use for notification emails. */
834 root->add_child("NotificationTo")->add_child_text (_notification_to);
835 for (auto i: _notification_cc) {
836 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
837 root->add_child("NotificationCC")->add_child_text (i);
839 /* [XML] NotificationBCC BCC address to use for notification emails. */
840 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
841 /* [XML] NotificationEmail Text of notification email. */
842 root->add_child("NotificationEmail")->add_child_text (_notification_email);
844 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
845 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
846 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
847 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
849 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
850 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
851 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
852 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
853 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
854 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
855 /* [XML] Allow96kHzAudio 1 to allow users to make DCPs with 96kHz audio, 0 to always make 48kHz DCPs */
856 root->add_child("Allow96kHzAudio")->add_child_text(_allow_96khz_audio ? "1" : "0");
857 /* [XML] UseAllAudioChannels 1 to allow users to map audio to all 16 DCP channels, 0 to limit to the channels used in standard DCPs */
858 root->add_child("UseAllAudioChannels")->add_child_text(_use_all_audio_channels ? "1" : "0");
859 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
860 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
861 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
862 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
863 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
864 related to the player, 1024 debug information related to audio analyses.
866 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
867 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
868 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
869 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
870 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
871 #ifdef DCPOMATIC_WINDOWS
872 if (_win32_console) {
873 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
874 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
875 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
877 root->add_child("Win32Console")->add_child_text ("1");
881 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
882 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
884 auto signer = root->add_child ("Signer");
885 DCPOMATIC_ASSERT (_signer_chain);
886 for (auto const& i: _signer_chain->unordered()) {
887 signer->add_child("Certificate")->add_child_text (i.certificate (true));
889 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
891 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
892 auto decryption = root->add_child ("Decryption");
893 DCPOMATIC_ASSERT (_decryption_chain);
894 for (auto const& i: _decryption_chain->unordered()) {
895 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
897 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
899 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
902 for (auto i: _history) {
903 root->add_child("History")->add_child_text (i.string ());
906 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
909 for (auto i: _player_history) {
910 root->add_child("PlayerHistory")->add_child_text (i.string ());
913 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
914 or <code><DKDM></code> tags.
916 /* [XML] DKDM A DKDM as XML */
917 _dkdms->as_xml (root);
919 /* [XML] CinemasFile Filename of cinemas list file. */
920 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
921 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
922 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
923 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
924 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
925 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
926 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
927 /* [XML] KDMFilenameFormat Format for KDM filenames. */
928 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
929 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
930 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
931 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
932 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
933 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
934 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
935 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
936 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
937 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
938 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
939 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
940 for (int i = 0; i < NAG_COUNT; ++i) {
941 xmlpp::Element* e = root->add_child ("Nagged");
942 e->set_attribute("id", raw_convert<string>(i));
943 e->add_child_text (_nagged[i] ? "1" : "0");
945 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
946 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
948 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
949 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
951 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
952 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
953 if (_last_player_load_directory) {
954 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
956 /* [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. */
957 if (_last_kdm_write_type) {
958 switch (_last_kdm_write_type.get()) {
960 root->add_child("LastKDMWriteType")->add_child_text("flat");
962 case KDM_WRITE_FOLDER:
963 root->add_child("LastKDMWriteType")->add_child_text("folder");
966 root->add_child("LastKDMWriteType")->add_child_text("zip");
970 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
971 if (_last_dkdm_write_type) {
972 switch (_last_dkdm_write_type.get()) {
973 case DKDM_WRITE_INTERNAL:
974 root->add_child("LastDKDMWriteType")->add_child_text("internal");
976 case DKDM_WRITE_FILE:
977 root->add_child("LastDKDMWriteType")->add_child_text("file");
981 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
982 frames to be held in memory at once.
984 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
986 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
987 if (_decode_reduction) {
988 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
991 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
992 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
994 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
995 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
996 xmlpp::Element* e = root->add_child ("Notification");
997 e->set_attribute("id", raw_convert<string>(i));
998 e->add_child_text (_notification[i] ? "1" : "0");
1001 if (_barco_username) {
1002 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
1003 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
1005 if (_barco_password) {
1006 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
1007 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
1010 if (_christie_username) {
1011 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
1012 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
1014 if (_christie_password) {
1015 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
1016 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
1019 if (_gdc_username) {
1020 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
1021 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
1023 if (_gdc_password) {
1024 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
1025 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
1028 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
1029 with controls on another monitor.
1031 switch (_player_mode) {
1032 case PLAYER_MODE_WINDOW:
1033 root->add_child("PlayerMode")->add_child_text("window");
1035 case PLAYER_MODE_FULL:
1036 root->add_child("PlayerMode")->add_child_text("full");
1038 case PLAYER_MODE_DUAL:
1039 root->add_child("PlayerMode")->add_child_text("dual");
1043 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
1044 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
1045 switch (_video_view_type) {
1046 case VIDEO_VIEW_SIMPLE:
1047 root->add_child("VideoViewType")->add_child_text("simple");
1049 case VIDEO_VIEW_OPENGL:
1050 root->add_child("VideoViewType")->add_child_text("opengl");
1053 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
1054 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
1055 if (_player_debug_log_file) {
1056 /* [XML] PlayerLogFile Filename to use for player debug logs. */
1057 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
1059 if (_player_content_directory) {
1060 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
1061 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
1063 if (_player_playlist_directory) {
1064 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
1065 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1067 if (_player_kdm_directory) {
1068 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1069 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1071 if (_audio_mapping) {
1072 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1074 for (auto const& i: _custom_languages) {
1075 root->add_child("CustomLanguage")->add_child_text(i.to_string());
1077 for (auto const& initial: _initial_paths) {
1078 if (initial.second) {
1079 root->add_child(initial.first)->add_child_text(initial.second->string());
1082 root->add_child("UseISDCFNameByDefault")->add_child_text(_use_isdcf_name_by_default ? "1" : "0");
1083 root->add_child("WriteKDMsToDisk")->add_child_text(_write_kdms_to_disk ? "1" : "0");
1084 root->add_child("EmailKDMs")->add_child_text(_email_kdms ? "1" : "0");
1085 root->add_child("DefaultKDMType")->add_child_text(dcp::formulation_to_string(_default_kdm_type));
1086 root->add_child("AutoCropThreshold")->add_child_text(raw_convert<string>(_auto_crop_threshold));
1087 if (_last_release_notes_version) {
1088 root->add_child("LastReleaseNotesVersion")->add_child_text(*_last_release_notes_version);
1090 if (_main_divider_sash_position) {
1091 root->add_child("MainDividerSashPosition")->add_child_text(raw_convert<string>(*_main_divider_sash_position));
1093 if (_main_content_divider_sash_position) {
1094 root->add_child("MainContentDividerSashPosition")->add_child_text(raw_convert<string>(*_main_content_divider_sash_position));
1097 root->add_child("DefaultAddFileLocation")->add_child_text(
1098 _default_add_file_location == DefaultAddFileLocation::SAME_AS_LAST_TIME ? "last" : "project"
1101 /* [XML] AllowSMPTEBv20 1 to allow the user to choose SMPTE (Bv2.0 only) as a standard, otherwise 0 */
1102 root->add_child("AllowSMPTEBv20")->add_child_text(_allow_smpte_bv20 ? "1" : "0");
1103 /* [XML] ISDCFNamePartLength Maximum length of the "name" part of an ISDCF name, which should be 14 according to the standard */
1104 root->add_child("ISDCFNamePartLength")->add_child_text(raw_convert<string>(_isdcf_name_part_length));
1106 _export.write(root->add_child("Export"));
1108 auto target = config_write_file();
1111 auto const s = doc.write_to_string_formatted ();
1112 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1113 dcp::File f(tmp, "w");
1115 throw FileError (_("Could not open file for writing"), tmp);
1117 f.checked_write(s.c_str(), s.bytes());
1119 boost::filesystem::remove (target);
1120 boost::filesystem::rename (tmp, target);
1121 } catch (xmlpp::exception& e) {
1122 string s = e.what ();
1124 throw FileError (s, target);
1131 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1133 xmlpp::Document doc;
1134 auto root = doc.create_root_node (root_node);
1135 root->add_child("Version")->add_child_text(version);
1137 for (auto i: things) {
1138 i->as_xml (root->add_child(node));
1142 doc.write_to_file_formatted (file.string() + ".tmp");
1143 boost::filesystem::remove (file);
1144 boost::filesystem::rename (file.string() + ".tmp", file);
1145 } catch (xmlpp::exception& e) {
1146 string s = e.what ();
1148 throw FileError (s, file);
1154 Config::write_cinemas () const
1156 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1161 Config::write_dkdm_recipients () const
1163 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1167 boost::filesystem::path
1168 Config::default_directory_or (boost::filesystem::path a) const
1170 return directory_or (_default_directory, a);
1173 boost::filesystem::path
1174 Config::default_kdm_directory_or (boost::filesystem::path a) const
1176 return directory_or (_default_kdm_directory, a);
1179 boost::filesystem::path
1180 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1186 boost::system::error_code ec;
1187 auto const e = boost::filesystem::exists (*dir, ec);
1203 Config::changed (Property what)
1209 Config::set_kdm_email_to_default ()
1211 _kdm_subject = _("KDM delivery: $CPL_NAME");
1214 "Dear Projectionist\n\n"
1215 "Please find attached KDMs for $CPL_NAME.\n\n"
1216 "Cinema: $CINEMA_NAME\n"
1217 "Screen(s): $SCREENS\n\n"
1218 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1219 "Best regards,\nDCP-o-matic"
1224 Config::set_notification_email_to_default ()
1226 _notification_subject = _("DCP-o-matic notification");
1228 _notification_email = _(
1229 "$JOB_NAME: $JOB_STATUS"
1234 Config::reset_kdm_email ()
1236 set_kdm_email_to_default ();
1241 Config::reset_notification_email ()
1243 set_notification_email_to_default ();
1248 Config::set_cover_sheet_to_default ()
1252 "CPL Filename: $CPL_FILENAME\n"
1254 "Format: $CONTAINER\n"
1256 "Audio Language: $AUDIO_LANGUAGE\n"
1257 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1264 Config::add_to_history (boost::filesystem::path p)
1266 add_to_history_internal (_history, p);
1269 /** Remove non-existent items from the history */
1271 Config::clean_history ()
1273 clean_history_internal (_history);
1277 Config::add_to_player_history (boost::filesystem::path p)
1279 add_to_history_internal (_player_history, p);
1282 /** Remove non-existent items from the player history */
1284 Config::clean_player_history ()
1286 clean_history_internal (_player_history);
1290 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1292 /* Remove existing instances of this path in the history */
1293 h.erase (remove (h.begin(), h.end(), p), h.end ());
1295 h.insert (h.begin (), p);
1296 if (h.size() > HISTORY_SIZE) {
1304 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1310 if (boost::filesystem::is_directory(i)) {
1314 /* We couldn't find out if it's a directory for some reason; just ignore it */
1321 Config::have_existing (string file)
1323 return boost::filesystem::exists (read_path(file));
1328 Config::read_cinemas (cxml::Document const & f)
1331 for (auto i: f.node_children("Cinema")) {
1332 /* Slightly grotty two-part construction of Cinema here so that we can use
1335 auto cinema = make_shared<Cinema>(i);
1336 cinema->read_screens (i);
1337 _cinemas.push_back (cinema);
1342 Config::set_cinemas_file (boost::filesystem::path file)
1344 if (file == _cinemas_file) {
1348 _cinemas_file = file;
1350 if (boost::filesystem::exists (_cinemas_file)) {
1351 /* Existing file; read it in */
1352 cxml::Document f ("Cinemas");
1353 f.read_file (_cinemas_file);
1363 Config::read_dkdm_recipients (cxml::Document const & f)
1365 _dkdm_recipients.clear ();
1366 for (auto i: f.node_children("DKDMRecipient")) {
1367 _dkdm_recipients.push_back (make_shared<DKDMRecipient>(i));
1373 Config::save_template (shared_ptr<const Film> film, string name) const
1375 film->write_template (template_write_path(name));
1380 Config::templates () const
1382 if (!boost::filesystem::exists(read_path("templates"))) {
1387 for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1388 n.push_back (i.path().filename().string());
1391 /* Make sure that the default exists, and is the first thing on the list */
1392 n.erase(std::remove(n.begin(), n.end(), default_template_name()), n.end());
1393 n.insert(n.begin(), default_template_name());
1400 Config::existing_template (string name) const
1402 return name == default_template_name() || template_read_path(name);
1406 optional<boost::filesystem::path>
1407 Config::template_read_path (string name) const
1409 auto const path = read_path("templates") / tidy_for_filename(name);
1410 if (!boost::filesystem::exists(path)) {
1418 boost::filesystem::path
1419 Config::template_write_path (string name) const
1421 return write_path("templates") / tidy_for_filename (name);
1426 Config::rename_template (string old_name, string new_name) const
1428 if (auto read_path = template_read_path(old_name)) {
1429 boost::filesystem::rename(*read_path, template_write_path(new_name));
1434 Config::delete_template (string name) const
1436 boost::filesystem::remove (template_write_path(name));
1439 /** @return Path to the config.xml containing the actual settings, following a link if required */
1440 boost::filesystem::path
1441 config_file (boost::filesystem::path main)
1443 cxml::Document f ("Config");
1444 if (!boost::filesystem::exists (main)) {
1445 /* It doesn't exist, so there can't be any links; just return it */
1449 /* See if there's a link */
1452 auto link = f.optional_string_child("Link");
1456 } catch (xmlpp::exception& e) {
1457 /* There as a problem reading the main configuration file,
1458 so there can't be a link.
1466 boost::filesystem::path
1467 Config::config_read_file ()
1469 return config_file (read_path("config.xml"));
1473 boost::filesystem::path
1474 Config::config_write_file ()
1476 return config_file (write_path("config.xml"));
1481 Config::reset_cover_sheet ()
1483 set_cover_sheet_to_default ();
1488 Config::link (boost::filesystem::path new_file) const
1490 xmlpp::Document doc;
1491 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1493 doc.write_to_file_formatted(write_path("config.xml").string());
1494 } catch (xmlpp::exception& e) {
1495 string s = e.what ();
1497 throw FileError (s, write_path("config.xml"));
1502 Config::copy_and_link (boost::filesystem::path new_file) const
1505 boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1510 Config::have_write_permission () const
1512 dcp::File f(config_write_file(), "r+");
1513 return static_cast<bool>(f);
1516 /** @param output_channels Number of output channels in use.
1517 * @return Audio mapping for this output channel count (may be a default).
1520 Config::audio_mapping (int output_channels)
1522 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1523 /* Set up a default */
1524 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1525 if (output_channels == 2) {
1526 /* Special case for stereo output.
1527 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1528 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1530 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1531 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1532 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1533 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1534 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1535 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1536 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1537 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1540 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1541 _audio_mapping->set (i, i, 1);
1546 return *_audio_mapping;
1550 Config::set_audio_mapping (AudioMapping m)
1553 changed (AUDIO_MAPPING);
1557 Config::set_audio_mapping_to_default ()
1559 DCPOMATIC_ASSERT (_audio_mapping);
1560 auto const ch = _audio_mapping->output_channels ();
1561 _audio_mapping = boost::none;
1562 _audio_mapping = audio_mapping (ch);
1563 changed (AUDIO_MAPPING);
1568 Config::add_custom_language (dcp::LanguageTag tag)
1570 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1571 _custom_languages.push_back (tag);
1577 optional<Config::BadReason>
1578 Config::check_certificates () const
1580 optional<BadReason> bad;
1582 for (auto const& i: _signer_chain->unordered()) {
1583 if (i.has_utf8_strings()) {
1584 bad = BAD_SIGNER_UTF8_STRINGS;
1586 if ((i.not_after().year() - i.not_before().year()) > 15) {
1587 bad = BAD_SIGNER_VALIDITY_TOO_LONG;
1591 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
1592 bad = BAD_SIGNER_INCONSISTENT;
1595 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
1596 bad = BAD_DECRYPTION_INCONSISTENT;
1604 save_all_config_as_zip (boost::filesystem::path zip_file)
1606 Zipper zipper (zip_file);
1608 auto config = Config::instance();
1609 zipper.add ("config.xml", dcp::file_to_string(config->config_read_file()));
1610 if (boost::filesystem::exists(config->cinemas_file())) {
1611 zipper.add ("cinemas.xml", dcp::file_to_string(config->cinemas_file()));
1613 if (boost::filesystem::exists(config->dkdm_recipients_file())) {
1614 zipper.add ("dkdm_recipients.xml", dcp::file_to_string(config->dkdm_recipients_file()));
1622 Config::set_initial_path(string id, boost::filesystem::path path)
1624 auto iter = _initial_paths.find(id);
1625 DCPOMATIC_ASSERT(iter != _initial_paths.end());
1626 iter->second = path;
1631 optional<boost::filesystem::path>
1632 Config::initial_path(string id) const
1634 auto iter = _initial_paths.find(id);
1635 DCPOMATIC_ASSERT(iter != _initial_paths.end());
1636 return iter->second;