2 Copyright (C) 2012-2021 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"
28 #include "dcp_content_type.h"
29 #include "dkdm_recipient.h"
30 #include "dkdm_wrapper.h"
38 #include <dcp/certificate_chain.h>
39 #include <dcp/name_format.h>
40 #include <dcp/raw_convert.h>
41 #include <libcxml/cxml.h>
43 #include <libxml++/libxml++.h>
44 #include <boost/filesystem.hpp>
45 #include <boost/algorithm/string.hpp>
46 #include <boost/thread.hpp>
55 using std::dynamic_pointer_cast;
58 using std::make_shared;
62 using std::shared_ptr;
65 using boost::algorithm::trim;
66 using boost::optional;
67 using dcp::raw_convert;
70 Config* Config::_instance = 0;
71 int const Config::_current_version = 3;
72 boost::signals2::signal<void ()> Config::FailedToLoad;
73 boost::signals2::signal<void (string)> Config::Warning;
74 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
77 /** Construct default configuration */
79 /* DKDMs are not considered a thing to reset on set_defaults() */
80 : _dkdms (new DKDMGroup ("root"))
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;
99 _allow_any_dcp_frame_rate = false;
100 _allow_any_container = false;
101 _allow_96khz_audio = false;
102 _show_experimental_audio_processors = false;
103 _language = optional<string> ();
104 _default_still_length = 10;
105 _default_container = Ratio::from_id ("185");
106 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
107 _default_dcp_audio_channels = 6;
108 _default_j2k_bandwidth = 150000000;
109 _default_audio_delay = 0;
110 _default_interop = false;
111 _default_metadata.clear ();
112 _upload_after_make_dcp = false;
115 _mail_protocol = EmailProtocol::AUTO;
121 _notification_from = "";
122 _notification_to = "";
123 _notification_cc.clear ();
124 _notification_bcc = "";
125 _check_for_updates = false;
126 _check_for_test_updates = false;
127 _maximum_j2k_bandwidth = 250000000;
128 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
129 _analyse_ebur128 = true;
130 _automatic_audio_analysis = false;
131 #ifdef DCPOMATIC_WINDOWS
132 _win32_console = false;
134 /* At the moment we don't write these files anywhere new after a version change, so they will be read from
135 * ~/.config/dcpomatic2 (or equivalent) and written back there.
137 _cinemas_file = read_path ("cinemas.xml");
138 _dkdm_recipients_file = read_path ("dkdm_recipients.xml");
139 _show_hints_before_make_dcp = true;
140 _confirm_kdm_email = true;
141 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
142 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
143 _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
144 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
145 _dcp_asset_filename_format = dcp::NameFormat ("%t");
146 _jump_to_selected = true;
147 for (int i = 0; i < NAG_COUNT; ++i) {
151 _sound_output = optional<string> ();
152 _last_kdm_write_type = KDM_WRITE_FLAT;
153 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
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 _add_files_path = boost::none;
187 _auto_crop_threshold = 0.1;
188 _use_isdcf_name_by_default = true;
189 _write_kdms_to_disk = true;
192 _allowed_dcp_frame_rates.clear ();
193 _allowed_dcp_frame_rates.push_back (24);
194 _allowed_dcp_frame_rates.push_back (25);
195 _allowed_dcp_frame_rates.push_back (30);
196 _allowed_dcp_frame_rates.push_back (48);
197 _allowed_dcp_frame_rates.push_back (50);
198 _allowed_dcp_frame_rates.push_back (60);
200 set_kdm_email_to_default ();
201 set_notification_email_to_default ();
202 set_cover_sheet_to_default ();
206 Config::restore_defaults ()
208 Config::instance()->set_defaults ();
209 Config::instance()->changed ();
212 shared_ptr<dcp::CertificateChain>
213 Config::create_certificate_chain ()
215 return make_shared<dcp::CertificateChain> (
217 CERTIFICATE_VALIDITY_PERIOD,
220 ".dcpomatic.smpte-430-2.ROOT",
221 ".dcpomatic.smpte-430-2.INTERMEDIATE",
222 "CS.dcpomatic.smpte-430-2.LEAF"
229 using namespace boost::filesystem;
231 auto copy_adding_number = [](path const& path_to_copy) {
233 auto add_number = [](path const& path, int number) {
234 return String::compose("%1.%2", path, number);
238 while (n < 100 && exists(add_number(path_to_copy, n))) {
241 boost::system::error_code ec;
242 copy_file(path_to_copy, add_number(path_to_copy, n), ec);
245 /* Make a backup copy of any config.xml, cinemas.xml, dkdm_recipients.xml that we might be about
246 * to write over. This is more intended for the situation where we have a corrupted config.xml,
247 * and decide to overwrite it with a new one (possibly losing important details in the corrupted
248 * file). But we might as well back up the other files while we're about it.
251 /* This uses the State::write_path stuff so, e.g. for a current version 2.16 we might copy
252 * ~/.config/dcpomatic2/2.16/config.xml to ~/.config/dcpomatic2/2.16/config.xml.1
254 copy_adding_number (config_write_file());
256 /* These do not use State::write_path, so whatever path is in the Config we will copy
259 copy_adding_number (_cinemas_file);
260 copy_adding_number (_dkdm_recipients_file);
267 cxml::Document f ("Config");
268 f.read_file (config_read_file());
270 auto version = f.optional_number_child<int> ("Version");
271 if (version && *version < _current_version) {
272 /* Back up the old config before we re-write it in a back-incompatible way */
276 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
277 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
279 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
280 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
283 _default_directory = f.optional_string_child ("DefaultDirectory");
284 if (_default_directory && _default_directory->empty ()) {
285 /* We used to store an empty value for this to mean "none set" */
286 _default_directory = boost::optional<boost::filesystem::path> ();
289 auto b = f.optional_number_child<int> ("ServerPort");
291 b = f.optional_number_child<int> ("ServerPortBase");
293 _server_port_base = b.get ();
295 auto u = f.optional_bool_child ("UseAnyServers");
296 _use_any_servers = u.get_value_or (true);
298 for (auto i: f.node_children("Server")) {
299 if (i->node_children("HostName").size() == 1) {
300 _servers.push_back (i->string_child ("HostName"));
302 _servers.push_back (i->content ());
306 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
307 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
308 _tms_ip = f.string_child ("TMSIP");
309 _tms_path = f.string_child ("TMSPath");
310 _tms_user = f.string_child ("TMSUser");
311 _tms_password = f.string_child ("TMSPassword");
313 _language = f.optional_string_child ("Language");
315 auto c = f.optional_string_child ("DefaultContainer");
317 _default_container = Ratio::from_id (c.get ());
320 if (_default_container && !_default_container->used_for_container()) {
321 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
322 _default_container = Ratio::from_id ("185");
325 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
326 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
328 if (f.optional_string_child ("DCPMetadataIssuer")) {
329 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
330 } else if (f.optional_string_child ("DCPIssuer")) {
331 _dcp_issuer = f.string_child ("DCPIssuer");
334 auto up = f.optional_bool_child("UploadAfterMakeDCP");
336 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
338 _upload_after_make_dcp = up.get_value_or (false);
339 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
340 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
341 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
342 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
343 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
345 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
346 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
347 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
348 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
350 for (auto const& i: f.node_children("DefaultMetadata")) {
351 _default_metadata[i->string_attribute("key")] = i->content();
354 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
356 /* Read any cinemas that are still lying around in the config file
357 * from an old version.
361 _mail_server = f.string_child ("MailServer");
362 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
365 /* Make sure this matches the code in write_config */
366 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
367 if (protocol == "Auto") {
368 _mail_protocol = EmailProtocol::AUTO;
369 } else if (protocol == "Plain") {
370 _mail_protocol = EmailProtocol::PLAIN;
371 } else if (protocol == "STARTTLS") {
372 _mail_protocol = EmailProtocol::STARTTLS;
373 } else if (protocol == "SSL") {
374 _mail_protocol = EmailProtocol::SSL;
378 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
379 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
381 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
382 _kdm_from = f.string_child ("KDMFrom");
383 for (auto i: f.node_children("KDMCC")) {
384 if (!i->content().empty()) {
385 _kdm_cc.push_back (i->content ());
388 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
389 _kdm_email = f.string_child ("KDMEmail");
391 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
392 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
393 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
394 for (auto i: f.node_children("NotificationCC")) {
395 if (!i->content().empty()) {
396 _notification_cc.push_back (i->content ());
399 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
400 if (f.optional_string_child("NotificationEmail")) {
401 _notification_email = f.string_child("NotificationEmail");
404 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
405 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
407 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
408 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
409 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
410 _allow_96khz_audio = f.optional_bool_child("Allow96kHzAudio").get_value_or(false);
411 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
413 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
414 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
415 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
416 #ifdef DCPOMATIC_WINDOWS
417 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
420 for (auto i: f.node_children("History")) {
421 _history.push_back (i->content ());
424 for (auto i: f.node_children("PlayerHistory")) {
425 _player_history.push_back (i->content ());
428 auto signer = f.optional_node_child ("Signer");
430 auto c = make_shared<dcp::CertificateChain>();
431 /* Read the signing certificates and private key in from the config file */
432 for (auto i: signer->node_children ("Certificate")) {
433 c->add (dcp::Certificate (i->content ()));
435 c->set_key (signer->string_child ("PrivateKey"));
438 /* Make a new set of signing certificates and key */
439 _signer_chain = create_certificate_chain ();
442 auto decryption = f.optional_node_child ("Decryption");
444 auto c = make_shared<dcp::CertificateChain>();
445 for (auto i: decryption->node_children ("Certificate")) {
446 c->add (dcp::Certificate (i->content ()));
448 c->set_key (decryption->string_child ("PrivateKey"));
449 _decryption_chain = c;
451 _decryption_chain = create_certificate_chain ();
454 /* These must be done before we call Bad as that might set one
457 for (auto i: f.node_children("Nagged")) {
458 auto const id = i->number_attribute<int>("Id");
459 if (id >= 0 && id < NAG_COUNT) {
460 _nagged[id] = raw_convert<int>(i->content());
464 auto bad = check_certificates ();
466 auto const remake = Bad(*bad);
467 if (remake && *remake) {
469 case BAD_SIGNER_UTF8_STRINGS:
470 case BAD_SIGNER_INCONSISTENT:
471 case BAD_SIGNER_VALIDITY_TOO_LONG:
472 _signer_chain = create_certificate_chain ();
474 case BAD_DECRYPTION_INCONSISTENT:
475 _decryption_chain = create_certificate_chain ();
481 if (f.optional_node_child("DKDMGroup")) {
482 /* New-style: all DKDMs in a group */
483 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
485 /* Old-style: one or more DKDM nodes */
486 _dkdms = make_shared<DKDMGroup>("root");
487 for (auto i: f.node_children("DKDM")) {
488 _dkdms->add (DKDMBase::read (i));
491 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
492 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
493 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
494 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
495 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
496 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
497 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
498 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
499 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
500 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
501 /* The variable was renamed but not the XML tag */
502 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
503 _sound_output = f.optional_string_child("PreviewSoundOutput");
504 if (f.optional_string_child("CoverSheet")) {
505 _cover_sheet = f.optional_string_child("CoverSheet").get();
507 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
508 if (f.optional_string_child("LastKDMWriteType")) {
509 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
510 _last_kdm_write_type = KDM_WRITE_FLAT;
511 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
512 _last_kdm_write_type = KDM_WRITE_FOLDER;
513 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
514 _last_kdm_write_type = KDM_WRITE_ZIP;
517 if (f.optional_string_child("LastDKDMWriteType")) {
518 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
519 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
520 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
521 _last_dkdm_write_type = DKDM_WRITE_FILE;
524 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
525 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
526 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
528 for (auto i: f.node_children("Notification")) {
529 int const id = i->number_attribute<int>("Id");
530 if (id >= 0 && id < NOTIFICATION_COUNT) {
531 _notification[id] = raw_convert<int>(i->content());
535 _barco_username = f.optional_string_child("BarcoUsername");
536 _barco_password = f.optional_string_child("BarcoPassword");
537 _christie_username = f.optional_string_child("ChristieUsername");
538 _christie_password = f.optional_string_child("ChristiePassword");
539 _gdc_username = f.optional_string_child("GDCUsername");
540 _gdc_password = f.optional_string_child("GDCPassword");
542 auto pm = f.optional_string_child("PlayerMode");
543 if (pm && *pm == "window") {
544 _player_mode = PLAYER_MODE_WINDOW;
545 } else if (pm && *pm == "full") {
546 _player_mode = PLAYER_MODE_FULL;
547 } else if (pm && *pm == "dual") {
548 _player_mode = PLAYER_MODE_DUAL;
551 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
552 auto vc = f.optional_string_child("VideoViewType");
553 if (vc && *vc == "opengl") {
554 _video_view_type = VIDEO_VIEW_OPENGL;
555 } else if (vc && *vc == "simple") {
556 _video_view_type = VIDEO_VIEW_SIMPLE;
558 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
559 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
560 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
561 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
562 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
564 if (f.optional_node_child("AudioMapping")) {
565 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
568 for (auto i: f.node_children("CustomLanguage")) {
570 /* This will fail if it's called before dcp::init() as it won't recognise the
571 * tag. That's OK because the Config will be reloaded again later.
573 _custom_languages.push_back (dcp::LanguageTag(i->content()));
574 } catch (std::runtime_error& e) {}
577 _add_files_path = f.optional_string_child("AddFilesPath");
578 _auto_crop_threshold = f.optional_number_child<double>("AutoCropThreshold").get_value_or(0.1);
579 _use_isdcf_name_by_default = f.optional_bool_child("UseISDCFNameByDefault").get_value_or(true);
580 _write_kdms_to_disk = f.optional_bool_child("WriteKDMsToDisk").get_value_or(true);
581 _email_kdms = f.optional_bool_child("EmailKDMs").get_value_or(false);
583 if (boost::filesystem::exists (_cinemas_file)) {
584 cxml::Document f ("Cinemas");
585 f.read_file (_cinemas_file);
589 if (boost::filesystem::exists (_dkdm_recipients_file)) {
590 cxml::Document f ("DKDMRecipients");
591 f.read_file (_dkdm_recipients_file);
592 read_dkdm_recipients (f);
596 if (have_existing("config.xml") || have_existing("cinemas.xml") || have_existing("dkdm_recipients.xml")) {
598 /* We have a config file but it didn't load */
602 /* Make a new set of signing certificates and key */
603 _signer_chain = create_certificate_chain ();
604 /* And similar for decryption of KDMs */
605 _decryption_chain = create_certificate_chain ();
609 /** @return Singleton instance */
613 if (_instance == nullptr) {
614 _instance = new Config;
621 /** Write our configuration to disk */
623 Config::write () const
627 write_dkdm_recipients ();
631 Config::write_config () const
634 auto root = doc.create_root_node ("Config");
636 /* [XML] Version The version number of the configuration file format. */
637 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
638 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
639 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
640 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
641 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
642 if (_default_directory) {
643 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
644 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
646 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
647 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
648 by the batch converter to listen for job requests.
650 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
651 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
652 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
654 for (auto i: _servers) {
655 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
658 root->add_child("Server")->add_child_text (i);
661 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
662 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
664 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
665 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
666 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
667 /* [XML] TMSIP IP address of TMS. */
668 root->add_child("TMSIP")->add_child_text (_tms_ip);
669 /* [XML] TMSPath Path on the TMS to copy files to. */
670 root->add_child("TMSPath")->add_child_text (_tms_path);
671 /* [XML] TMSUser Username to log into the TMS with. */
672 root->add_child("TMSUser")->add_child_text (_tms_user);
673 /* [XML] TMSPassword Password to log into the TMS with. */
674 root->add_child("TMSPassword")->add_child_text (_tms_password);
676 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
677 root->add_child("Language")->add_child_text (_language.get());
679 if (_default_container) {
680 /* [XML:opt] DefaultContainer ID of default container
681 to use when creating new films (<code>185</code>,<code>239</code> or
684 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
686 if (_default_dcp_content_type) {
687 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
688 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
689 <code>PSA</code> or <code>ADV</code>). */
690 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
692 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
693 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
694 /* [XML] DCPIssuer Issuer text to write into CPL files. */
695 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
696 /* [XML] DCPCreator Creator text to write into CPL files. */
697 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
698 /* [XML] Company name to write into MXF files. */
699 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
700 /* [XML] Product name to write into MXF files. */
701 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
702 /* [XML] Product version to write into MXF files. */
703 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
704 /* [XML] Comment to write into JPEG2000 data. */
705 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
706 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
707 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
709 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
710 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
711 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
712 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
713 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
714 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
715 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
716 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
717 for (auto const& i: _default_metadata) {
718 auto c = root->add_child("DefaultMetadata");
719 c->set_attribute("key", i.first);
720 c->add_child_text(i.second);
722 if (_default_kdm_directory) {
723 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
724 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
726 /* [XML] MailServer Hostname of SMTP server to use. */
727 root->add_child("MailServer")->add_child_text (_mail_server);
728 /* [XML] MailPort Port number to use on SMTP server. */
729 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
730 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
731 switch (_mail_protocol) {
732 case EmailProtocol::AUTO:
733 root->add_child("MailProtocol")->add_child_text("Auto");
735 case EmailProtocol::PLAIN:
736 root->add_child("MailProtocol")->add_child_text("Plain");
738 case EmailProtocol::STARTTLS:
739 root->add_child("MailProtocol")->add_child_text("STARTTLS");
741 case EmailProtocol::SSL:
742 root->add_child("MailProtocol")->add_child_text("SSL");
745 /* [XML] MailUser Username to use on SMTP server. */
746 root->add_child("MailUser")->add_child_text (_mail_user);
747 /* [XML] MailPassword Password to use on SMTP server. */
748 root->add_child("MailPassword")->add_child_text (_mail_password);
750 /* [XML] KDMSubject Subject to use for KDM emails. */
751 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
752 /* [XML] KDMFrom From address to use for KDM emails. */
753 root->add_child("KDMFrom")->add_child_text (_kdm_from);
754 for (auto i: _kdm_cc) {
755 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
756 root->add_child("KDMCC")->add_child_text (i);
758 /* [XML] KDMBCC BCC address to use for KDM emails. */
759 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
760 /* [XML] KDMEmail Text of KDM email. */
761 root->add_child("KDMEmail")->add_child_text (_kdm_email);
763 /* [XML] NotificationSubject Subject to use for notification emails. */
764 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
765 /* [XML] NotificationFrom From address to use for notification emails. */
766 root->add_child("NotificationFrom")->add_child_text (_notification_from);
767 /* [XML] NotificationFrom To address to use for notification emails. */
768 root->add_child("NotificationTo")->add_child_text (_notification_to);
769 for (auto i: _notification_cc) {
770 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
771 root->add_child("NotificationCC")->add_child_text (i);
773 /* [XML] NotificationBCC BCC address to use for notification emails. */
774 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
775 /* [XML] NotificationEmail Text of notification email. */
776 root->add_child("NotificationEmail")->add_child_text (_notification_email);
778 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
779 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
780 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
781 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
783 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
784 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
785 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
786 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
787 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
788 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
789 /* [XML] Allow96kHzAudio 1 to allow users to make DCPs with 96kHz audio, 0 to always make 48kHz DCPs */
790 root->add_child("Allow96kHzAudio")->add_child_text(_allow_96khz_audio ? "1" : "0");
791 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
792 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
793 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
794 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
795 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
796 related to the player, 1024 debug information related to audio analyses.
798 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
799 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
800 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
801 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
802 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
803 #ifdef DCPOMATIC_WINDOWS
804 if (_win32_console) {
805 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
806 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
807 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
809 root->add_child("Win32Console")->add_child_text ("1");
813 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
814 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
816 auto signer = root->add_child ("Signer");
817 DCPOMATIC_ASSERT (_signer_chain);
818 for (auto const& i: _signer_chain->unordered()) {
819 signer->add_child("Certificate")->add_child_text (i.certificate (true));
821 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
823 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
824 auto decryption = root->add_child ("Decryption");
825 DCPOMATIC_ASSERT (_decryption_chain);
826 for (auto const& i: _decryption_chain->unordered()) {
827 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
829 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
831 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
834 for (auto i: _history) {
835 root->add_child("History")->add_child_text (i.string ());
838 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
841 for (auto i: _player_history) {
842 root->add_child("PlayerHistory")->add_child_text (i.string ());
845 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
846 or <code><DKDM></code> tags.
848 /* [XML] DKDM A DKDM as XML */
849 _dkdms->as_xml (root);
851 /* [XML] CinemasFile Filename of cinemas list file. */
852 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
853 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
854 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
855 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
856 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
857 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
858 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
859 /* [XML] KDMFilenameFormat Format for KDM filenames. */
860 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
861 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
862 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
863 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
864 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
865 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
866 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
867 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
868 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
869 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
870 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
871 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
872 for (int i = 0; i < NAG_COUNT; ++i) {
873 xmlpp::Element* e = root->add_child ("Nagged");
874 e->set_attribute ("Id", raw_convert<string>(i));
875 e->add_child_text (_nagged[i] ? "1" : "0");
877 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
878 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
880 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
881 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
883 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
884 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
885 if (_last_player_load_directory) {
886 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
888 /* [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. */
889 if (_last_kdm_write_type) {
890 switch (_last_kdm_write_type.get()) {
892 root->add_child("LastKDMWriteType")->add_child_text("flat");
894 case KDM_WRITE_FOLDER:
895 root->add_child("LastKDMWriteType")->add_child_text("folder");
898 root->add_child("LastKDMWriteType")->add_child_text("zip");
902 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
903 if (_last_dkdm_write_type) {
904 switch (_last_dkdm_write_type.get()) {
905 case DKDM_WRITE_INTERNAL:
906 root->add_child("LastDKDMWriteType")->add_child_text("internal");
908 case DKDM_WRITE_FILE:
909 root->add_child("LastDKDMWriteType")->add_child_text("file");
913 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
914 frames to be held in memory at once.
916 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
918 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
919 if (_decode_reduction) {
920 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
923 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
924 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
926 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
927 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
928 xmlpp::Element* e = root->add_child ("Notification");
929 e->set_attribute ("Id", raw_convert<string>(i));
930 e->add_child_text (_notification[i] ? "1" : "0");
933 if (_barco_username) {
934 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
935 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
937 if (_barco_password) {
938 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
939 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
942 if (_christie_username) {
943 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
944 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
946 if (_christie_password) {
947 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
948 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
952 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
953 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
956 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
957 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
960 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
961 with controls on another monitor.
963 switch (_player_mode) {
964 case PLAYER_MODE_WINDOW:
965 root->add_child("PlayerMode")->add_child_text("window");
967 case PLAYER_MODE_FULL:
968 root->add_child("PlayerMode")->add_child_text("full");
970 case PLAYER_MODE_DUAL:
971 root->add_child("PlayerMode")->add_child_text("dual");
975 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
976 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
977 switch (_video_view_type) {
978 case VIDEO_VIEW_SIMPLE:
979 root->add_child("VideoViewType")->add_child_text("simple");
981 case VIDEO_VIEW_OPENGL:
982 root->add_child("VideoViewType")->add_child_text("opengl");
985 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
986 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
987 if (_player_debug_log_file) {
988 /* [XML] PlayerLogFile Filename to use for player debug logs. */
989 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
991 if (_player_content_directory) {
992 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
993 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
995 if (_player_playlist_directory) {
996 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
997 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
999 if (_player_kdm_directory) {
1000 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1001 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1003 if (_audio_mapping) {
1004 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1006 for (auto const& i: _custom_languages) {
1007 root->add_child("CustomLanguage")->add_child_text(i.to_string());
1009 if (_add_files_path) {
1010 /* [XML] AddFilesPath The default path that will be offered in the picker when adding files to a film. */
1011 root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
1013 root->add_child("AutoCropThreshold")->add_child_text(raw_convert<string>(_auto_crop_threshold));
1014 root->add_child("UseISDCFNameByDefault")->add_child_text(_use_isdcf_name_by_default ? "1" : "0");
1015 root->add_child("WriteKDMsToDisk")->add_child_text(_write_kdms_to_disk ? "1" : "0");
1016 root->add_child("EmailKDMs")->add_child_text(_email_kdms ? "1" : "0");
1018 auto target = config_write_file();
1021 auto const s = doc.write_to_string_formatted ();
1022 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1023 auto f = fopen_boost (tmp, "w");
1025 throw FileError (_("Could not open file for writing"), tmp);
1027 checked_fwrite (s.c_str(), s.bytes(), f, tmp);
1029 boost::filesystem::remove (target);
1030 boost::filesystem::rename (tmp, target);
1031 } catch (xmlpp::exception& e) {
1032 string s = e.what ();
1034 throw FileError (s, target);
1041 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1043 xmlpp::Document doc;
1044 auto root = doc.create_root_node (root_node);
1045 root->add_child("Version")->add_child_text(version);
1047 for (auto i: things) {
1048 i->as_xml (root->add_child(node));
1052 doc.write_to_file_formatted (file.string() + ".tmp");
1053 boost::filesystem::remove (file);
1054 boost::filesystem::rename (file.string() + ".tmp", file);
1055 } catch (xmlpp::exception& e) {
1056 string s = e.what ();
1058 throw FileError (s, file);
1064 Config::write_cinemas () const
1066 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1071 Config::write_dkdm_recipients () const
1073 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1077 boost::filesystem::path
1078 Config::default_directory_or (boost::filesystem::path a) const
1080 return directory_or (_default_directory, a);
1083 boost::filesystem::path
1084 Config::default_kdm_directory_or (boost::filesystem::path a) const
1086 return directory_or (_default_kdm_directory, a);
1089 boost::filesystem::path
1090 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1096 boost::system::error_code ec;
1097 auto const e = boost::filesystem::exists (*dir, ec);
1113 Config::changed (Property what)
1119 Config::set_kdm_email_to_default ()
1121 _kdm_subject = _("KDM delivery: $CPL_NAME");
1124 "Dear Projectionist\n\n"
1125 "Please find attached KDMs for $CPL_NAME.\n\n"
1126 "Cinema: $CINEMA_NAME\n"
1127 "Screen(s): $SCREENS\n\n"
1128 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1129 "Best regards,\nDCP-o-matic"
1134 Config::set_notification_email_to_default ()
1136 _notification_subject = _("DCP-o-matic notification");
1138 _notification_email = _(
1139 "$JOB_NAME: $JOB_STATUS"
1144 Config::reset_kdm_email ()
1146 set_kdm_email_to_default ();
1151 Config::reset_notification_email ()
1153 set_notification_email_to_default ();
1158 Config::set_cover_sheet_to_default ()
1162 "CPL Filename: $CPL_FILENAME\n"
1164 "Format: $CONTAINER\n"
1166 "Audio Language: $AUDIO_LANGUAGE\n"
1167 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1174 Config::add_to_history (boost::filesystem::path p)
1176 add_to_history_internal (_history, p);
1179 /** Remove non-existant items from the history */
1181 Config::clean_history ()
1183 clean_history_internal (_history);
1187 Config::add_to_player_history (boost::filesystem::path p)
1189 add_to_history_internal (_player_history, p);
1192 /** Remove non-existant items from the player history */
1194 Config::clean_player_history ()
1196 clean_history_internal (_player_history);
1200 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1202 /* Remove existing instances of this path in the history */
1203 h.erase (remove (h.begin(), h.end(), p), h.end ());
1205 h.insert (h.begin (), p);
1206 if (h.size() > HISTORY_SIZE) {
1214 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1220 if (boost::filesystem::is_directory(i)) {
1224 /* We couldn't find out if it's a directory for some reason; just ignore it */
1231 Config::have_existing (string file)
1233 return boost::filesystem::exists (read_path(file));
1238 Config::read_cinemas (cxml::Document const & f)
1241 for (auto i: f.node_children("Cinema")) {
1242 /* Slightly grotty two-part construction of Cinema here so that we can use
1245 auto cinema = make_shared<Cinema>(i);
1246 cinema->read_screens (i);
1247 _cinemas.push_back (cinema);
1252 Config::set_cinemas_file (boost::filesystem::path file)
1254 if (file == _cinemas_file) {
1258 _cinemas_file = file;
1260 if (boost::filesystem::exists (_cinemas_file)) {
1261 /* Existing file; read it in */
1262 cxml::Document f ("Cinemas");
1263 f.read_file (_cinemas_file);
1272 Config::read_dkdm_recipients (cxml::Document const & f)
1274 _dkdm_recipients.clear ();
1275 for (auto i: f.node_children("DKDMRecipient")) {
1276 _dkdm_recipients.push_back (make_shared<DKDMRecipient>(i));
1282 Config::save_template (shared_ptr<const Film> film, string name) const
1284 film->write_template (template_write_path(name));
1289 Config::templates () const
1291 if (!boost::filesystem::exists(read_path("templates"))) {
1296 for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1297 n.push_back (i.path().filename().string());
1303 Config::existing_template (string name) const
1305 return boost::filesystem::exists (template_read_path(name));
1309 boost::filesystem::path
1310 Config::template_read_path (string name) const
1312 return read_path("templates") / tidy_for_filename (name);
1316 boost::filesystem::path
1317 Config::template_write_path (string name) const
1319 return write_path("templates") / tidy_for_filename (name);
1324 Config::rename_template (string old_name, string new_name) const
1326 boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name));
1330 Config::delete_template (string name) const
1332 boost::filesystem::remove (template_write_path(name));
1335 /** @return Path to the config.xml containing the actual settings, following a link if required */
1336 boost::filesystem::path
1337 config_file (boost::filesystem::path main)
1339 cxml::Document f ("Config");
1340 if (!boost::filesystem::exists (main)) {
1341 /* It doesn't exist, so there can't be any links; just return it */
1345 /* See if there's a link */
1348 auto link = f.optional_string_child("Link");
1352 } catch (xmlpp::exception& e) {
1353 /* There as a problem reading the main configuration file,
1354 so there can't be a link.
1362 boost::filesystem::path
1363 Config::config_read_file ()
1365 return config_file (read_path("config.xml"));
1369 boost::filesystem::path
1370 Config::config_write_file ()
1372 return config_file (write_path("config.xml"));
1377 Config::reset_cover_sheet ()
1379 set_cover_sheet_to_default ();
1384 Config::link (boost::filesystem::path new_file) const
1386 xmlpp::Document doc;
1387 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1389 doc.write_to_file_formatted(write_path("config.xml").string());
1390 } catch (xmlpp::exception& e) {
1391 string s = e.what ();
1393 throw FileError (s, write_path("config.xml"));
1398 Config::copy_and_link (boost::filesystem::path new_file) const
1401 boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1406 Config::have_write_permission () const
1408 auto f = fopen_boost (config_write_file(), "r+");
1417 /** @param output_channels Number of output channels in use.
1418 * @return Audio mapping for this output channel count (may be a default).
1421 Config::audio_mapping (int output_channels)
1423 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1424 /* Set up a default */
1425 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1426 if (output_channels == 2) {
1427 /* Special case for stereo output.
1428 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1429 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1431 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1432 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1433 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1434 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1435 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1436 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1437 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1438 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1441 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1442 _audio_mapping->set (i, i, 1);
1447 return *_audio_mapping;
1451 Config::set_audio_mapping (AudioMapping m)
1454 changed (AUDIO_MAPPING);
1458 Config::set_audio_mapping_to_default ()
1460 DCPOMATIC_ASSERT (_audio_mapping);
1461 auto const ch = _audio_mapping->output_channels ();
1462 _audio_mapping = boost::none;
1463 _audio_mapping = audio_mapping (ch);
1464 changed (AUDIO_MAPPING);
1469 Config::add_custom_language (dcp::LanguageTag tag)
1471 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1472 _custom_languages.push_back (tag);
1479 save_all_config_as_zip (boost::filesystem::path zip_file)
1481 Zipper zipper (zip_file);
1483 auto config = Config::instance();
1484 zipper.add ("config.xml", dcp::file_to_string(config->config_read_file()));
1485 if (boost::filesystem::exists(config->cinemas_file())) {
1486 zipper.add ("cinemas.xml", dcp::file_to_string(config->cinemas_file()));
1488 if (boost::filesystem::exists(config->dkdm_recipients_file())) {
1489 zipper.add ("dkdm_recipients.xml", dcp::file_to_string(config->dkdm_recipients_file()));
1496 optional<Config::BadReason>
1497 Config::check_certificates () const
1499 optional<BadReason> bad;
1501 for (auto const& i: _signer_chain->unordered()) {
1502 if (i.has_utf8_strings()) {
1503 bad = BAD_SIGNER_UTF8_STRINGS;
1505 if ((i.not_after().year() - i.not_before().year()) > 15) {
1506 bad = BAD_SIGNER_VALIDITY_TOO_LONG;
1510 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
1511 bad = BAD_SIGNER_INCONSISTENT;
1514 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
1515 bad = BAD_DECRYPTION_INCONSISTENT;