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/>.
26 #include "dcp_content_type.h"
27 #include "colour_conversion.h"
32 #include "dkdm_wrapper.h"
33 #include "compose.hpp"
35 #include "dkdm_recipient.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>
60 using std::shared_ptr;
61 using std::make_shared;
62 using boost::optional;
63 using std::dynamic_pointer_cast;
64 using boost::algorithm::trim;
65 using dcp::raw_convert;
67 Config* Config::_instance = 0;
68 int const Config::_current_version = 3;
69 boost::signals2::signal<void ()> Config::FailedToLoad;
70 boost::signals2::signal<void (string)> Config::Warning;
71 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
73 /** Construct default configuration */
75 /* DKDMs are not considered a thing to reset on set_defaults() */
76 : _dkdms (new DKDMGroup ("root"))
82 Config::set_defaults ()
84 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
85 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
86 _server_port_base = 6192;
87 _use_any_servers = true;
89 _only_servers_encode = false;
90 _tms_protocol = FileTransferProtocol::SCP;
95 _allow_any_dcp_frame_rate = false;
96 _allow_any_container = false;
97 _show_experimental_audio_processors = false;
98 _language = optional<string> ();
99 _default_still_length = 10;
100 _default_container = Ratio::from_id ("185");
101 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
102 _default_dcp_audio_channels = 6;
103 _default_j2k_bandwidth = 150000000;
104 _default_audio_delay = 0;
105 _default_interop = false;
106 _default_metadata.clear ();
107 _upload_after_make_dcp = false;
110 _mail_protocol = EmailProtocol::AUTO;
116 _notification_from = "";
117 _notification_to = "";
118 _notification_cc.clear ();
119 _notification_bcc = "";
120 _check_for_updates = false;
121 _check_for_test_updates = false;
122 _maximum_j2k_bandwidth = 250000000;
123 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
124 _analyse_ebur128 = true;
125 _automatic_audio_analysis = false;
126 #ifdef DCPOMATIC_WINDOWS
127 _win32_console = false;
129 /* At the moment we don't write these files anywhere new after a version change, so they will be read from
130 * ~/.config/dcpomatic2 (or equivalent) and written back there.
132 _cinemas_file = read_path ("cinemas.xml");
133 _dkdm_recipients_file = read_path ("dkdm_recipients.xml");
134 _show_hints_before_make_dcp = true;
135 _confirm_kdm_email = true;
136 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
137 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
138 _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
139 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
140 _dcp_asset_filename_format = dcp::NameFormat ("%t");
141 _jump_to_selected = true;
142 for (int i = 0; i < NAG_COUNT; ++i) {
146 _sound_output = optional<string> ();
147 _last_kdm_write_type = KDM_WRITE_FLAT;
148 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
150 /* I think the scaling factor here should be the ratio of the longest frame
151 encode time to the shortest; if the thread count is T, longest time is L
152 and the shortest time S we could encode L/S frames per thread whilst waiting
153 for the L frame to encode so we might have to store LT/S frames.
155 However we don't want to use too much memory, so keep it a bit lower than we'd
156 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
157 use about 240Mb with 72 encoding threads.
159 _frames_in_memory_multiplier = 3;
160 _decode_reduction = optional<int>();
161 _default_notify = false;
162 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
163 _notification[i] = false;
165 _barco_username = optional<string>();
166 _barco_password = optional<string>();
167 _christie_username = optional<string>();
168 _christie_password = optional<string>();
169 _gdc_username = optional<string>();
170 _gdc_password = optional<string>();
171 _player_mode = PLAYER_MODE_WINDOW;
173 _video_view_type = VIDEO_VIEW_SIMPLE;
174 _respect_kdm_validity_periods = true;
175 _player_debug_log_file = boost::none;
176 _player_content_directory = boost::none;
177 _player_playlist_directory = boost::none;
178 _player_kdm_directory = boost::none;
179 _audio_mapping = boost::none;
180 _custom_languages.clear ();
181 _add_files_path = boost::none;
182 _use_isdcf_name_by_default = true;
183 _write_kdms_to_disk = true;
185 _default_kdm_type = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
187 _allowed_dcp_frame_rates.clear ();
188 _allowed_dcp_frame_rates.push_back (24);
189 _allowed_dcp_frame_rates.push_back (25);
190 _allowed_dcp_frame_rates.push_back (30);
191 _allowed_dcp_frame_rates.push_back (48);
192 _allowed_dcp_frame_rates.push_back (50);
193 _allowed_dcp_frame_rates.push_back (60);
195 set_kdm_email_to_default ();
196 set_notification_email_to_default ();
197 set_cover_sheet_to_default ();
201 Config::restore_defaults ()
203 Config::instance()->set_defaults ();
204 Config::instance()->changed ();
207 shared_ptr<dcp::CertificateChain>
208 Config::create_certificate_chain ()
210 return make_shared<dcp::CertificateChain> (
212 CERTIFICATE_VALIDITY_PERIOD,
215 ".dcpomatic.smpte-430-2.ROOT",
216 ".dcpomatic.smpte-430-2.INTERMEDIATE",
217 "CS.dcpomatic.smpte-430-2.LEAF"
224 using namespace boost::filesystem;
226 auto copy_adding_number = [](path const& path_to_copy) {
228 auto add_number = [](path const& path, int number) {
229 return String::compose("%1.%2", path, number);
233 while (n < 100 && exists(add_number(path_to_copy, n))) {
236 boost::system::error_code ec;
237 copy_file(path_to_copy, add_number(path_to_copy, n), ec);
240 /* Make a backup copy of any config.xml, cinemas.xml, dkdm_recipients.xml that we might be about
241 * to write over. This is more intended for the situation where we have a corrupted config.xml,
242 * and decide to overwrite it with a new one (possibly losing important details in the corrupted
243 * file). But we might as well back up the other files while we're about it.
246 /* This uses the State::write_path stuff so, e.g. for a current version 2.16 we might copy
247 * ~/.config/dcpomatic2/2.16/config.xml to ~/.config/dcpomatic2/2.16/config.xml.1
249 copy_adding_number (config_write_file());
251 /* These do not use State::write_path, so whatever path is in the Config we will copy
254 copy_adding_number (_cinemas_file);
255 copy_adding_number (_dkdm_recipients_file);
262 cxml::Document f ("Config");
263 f.read_file (config_read_file());
265 auto version = f.optional_number_child<int> ("Version");
266 if (version && *version < _current_version) {
267 /* Back up the old config before we re-write it in a back-incompatible way */
271 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
272 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
274 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
275 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
278 _default_directory = f.optional_string_child ("DefaultDirectory");
279 if (_default_directory && _default_directory->empty ()) {
280 /* We used to store an empty value for this to mean "none set" */
281 _default_directory = boost::optional<boost::filesystem::path> ();
284 auto b = f.optional_number_child<int> ("ServerPort");
286 b = f.optional_number_child<int> ("ServerPortBase");
288 _server_port_base = b.get ();
290 auto u = f.optional_bool_child ("UseAnyServers");
291 _use_any_servers = u.get_value_or (true);
293 for (auto i: f.node_children("Server")) {
294 if (i->node_children("HostName").size() == 1) {
295 _servers.push_back (i->string_child ("HostName"));
297 _servers.push_back (i->content ());
301 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
302 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
303 _tms_ip = f.string_child ("TMSIP");
304 _tms_path = f.string_child ("TMSPath");
305 _tms_user = f.string_child ("TMSUser");
306 _tms_password = f.string_child ("TMSPassword");
308 _language = f.optional_string_child ("Language");
310 auto c = f.optional_string_child ("DefaultContainer");
312 _default_container = Ratio::from_id (c.get ());
315 if (_default_container && !_default_container->used_for_container()) {
316 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
317 _default_container = Ratio::from_id ("185");
320 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
321 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
323 if (f.optional_string_child ("DCPMetadataIssuer")) {
324 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
325 } else if (f.optional_string_child ("DCPIssuer")) {
326 _dcp_issuer = f.string_child ("DCPIssuer");
329 auto up = f.optional_bool_child("UploadAfterMakeDCP");
331 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
333 _upload_after_make_dcp = up.get_value_or (false);
334 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
335 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
336 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
337 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
338 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
340 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
341 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
342 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
343 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
345 for (auto const& i: f.node_children("DefaultMetadata")) {
346 _default_metadata[i->string_attribute("key")] = i->content();
349 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
351 /* Read any cinemas that are still lying around in the config file
352 * from an old version.
356 _mail_server = f.string_child ("MailServer");
357 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
360 /* Make sure this matches the code in write_config */
361 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
362 if (protocol == "Auto") {
363 _mail_protocol = EmailProtocol::AUTO;
364 } else if (protocol == "Plain") {
365 _mail_protocol = EmailProtocol::PLAIN;
366 } else if (protocol == "STARTTLS") {
367 _mail_protocol = EmailProtocol::STARTTLS;
368 } else if (protocol == "SSL") {
369 _mail_protocol = EmailProtocol::SSL;
373 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
374 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
376 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
377 _kdm_from = f.string_child ("KDMFrom");
378 for (auto i: f.node_children("KDMCC")) {
379 if (!i->content().empty()) {
380 _kdm_cc.push_back (i->content ());
383 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
384 _kdm_email = f.string_child ("KDMEmail");
386 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
387 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
388 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
389 for (auto i: f.node_children("NotificationCC")) {
390 if (!i->content().empty()) {
391 _notification_cc.push_back (i->content ());
394 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
395 if (f.optional_string_child("NotificationEmail")) {
396 _notification_email = f.string_child("NotificationEmail");
399 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
400 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
402 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
403 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
404 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
405 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
407 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
408 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
409 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
410 #ifdef DCPOMATIC_WINDOWS
411 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
414 for (auto i: f.node_children("History")) {
415 _history.push_back (i->content ());
418 for (auto i: f.node_children("PlayerHistory")) {
419 _player_history.push_back (i->content ());
422 auto signer = f.optional_node_child ("Signer");
424 auto c = make_shared<dcp::CertificateChain>();
425 /* Read the signing certificates and private key in from the config file */
426 for (auto i: signer->node_children ("Certificate")) {
427 c->add (dcp::Certificate (i->content ()));
429 c->set_key (signer->string_child ("PrivateKey"));
432 /* Make a new set of signing certificates and key */
433 _signer_chain = create_certificate_chain ();
436 auto decryption = f.optional_node_child ("Decryption");
438 auto c = make_shared<dcp::CertificateChain>();
439 for (auto i: decryption->node_children ("Certificate")) {
440 c->add (dcp::Certificate (i->content ()));
442 c->set_key (decryption->string_child ("PrivateKey"));
443 _decryption_chain = c;
445 _decryption_chain = create_certificate_chain ();
448 /* These must be done before we call Bad as that might set one
451 for (auto i: f.node_children("Nagged")) {
452 auto const id = i->number_attribute<int>("Id");
453 if (id >= 0 && id < NAG_COUNT) {
454 _nagged[id] = raw_convert<int>(i->content());
458 auto bad = check_certificates ();
460 auto const remake = Bad(*bad);
461 if (remake && *remake) {
463 case BAD_SIGNER_UTF8_STRINGS:
464 case BAD_SIGNER_INCONSISTENT:
465 case BAD_SIGNER_VALIDITY_TOO_LONG:
466 _signer_chain = create_certificate_chain ();
468 case BAD_DECRYPTION_INCONSISTENT:
469 _decryption_chain = create_certificate_chain ();
475 if (f.optional_node_child("DKDMGroup")) {
476 /* New-style: all DKDMs in a group */
477 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
479 /* Old-style: one or more DKDM nodes */
480 _dkdms.reset (new DKDMGroup ("root"));
481 for (auto i: f.node_children("DKDM")) {
482 _dkdms->add (DKDMBase::read (i));
485 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
486 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
487 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
488 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
489 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
490 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
491 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
492 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
493 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
494 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
495 /* The variable was renamed but not the XML tag */
496 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
497 _sound_output = f.optional_string_child("PreviewSoundOutput");
498 if (f.optional_string_child("CoverSheet")) {
499 _cover_sheet = f.optional_string_child("CoverSheet").get();
501 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
502 if (f.optional_string_child("LastKDMWriteType")) {
503 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
504 _last_kdm_write_type = KDM_WRITE_FLAT;
505 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
506 _last_kdm_write_type = KDM_WRITE_FOLDER;
507 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
508 _last_kdm_write_type = KDM_WRITE_ZIP;
511 if (f.optional_string_child("LastDKDMWriteType")) {
512 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
513 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
514 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
515 _last_dkdm_write_type = DKDM_WRITE_FILE;
518 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
519 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
520 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
522 for (auto i: f.node_children("Notification")) {
523 int const id = i->number_attribute<int>("Id");
524 if (id >= 0 && id < NOTIFICATION_COUNT) {
525 _notification[id] = raw_convert<int>(i->content());
529 _barco_username = f.optional_string_child("BarcoUsername");
530 _barco_password = f.optional_string_child("BarcoPassword");
531 _christie_username = f.optional_string_child("ChristieUsername");
532 _christie_password = f.optional_string_child("ChristiePassword");
533 _gdc_username = f.optional_string_child("GDCUsername");
534 _gdc_password = f.optional_string_child("GDCPassword");
536 auto pm = f.optional_string_child("PlayerMode");
537 if (pm && *pm == "window") {
538 _player_mode = PLAYER_MODE_WINDOW;
539 } else if (pm && *pm == "full") {
540 _player_mode = PLAYER_MODE_FULL;
541 } else if (pm && *pm == "dual") {
542 _player_mode = PLAYER_MODE_DUAL;
545 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
546 auto vc = f.optional_string_child("VideoViewType");
547 if (vc && *vc == "opengl") {
548 _video_view_type = VIDEO_VIEW_OPENGL;
549 } else if (vc && *vc == "simple") {
550 _video_view_type = VIDEO_VIEW_SIMPLE;
552 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
553 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
554 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
555 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
556 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
558 if (f.optional_node_child("AudioMapping")) {
559 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
562 for (auto i: f.node_children("CustomLanguage")) {
564 /* This will fail if it's called before dcp::init() as it won't recognise the
565 * tag. That's OK because the Config will be reloaded again later.
567 _custom_languages.push_back (dcp::LanguageTag(i->content()));
568 } catch (std::runtime_error& e) {}
571 _add_files_path = f.optional_string_child("AddFilesPath");
572 _use_isdcf_name_by_default = f.optional_bool_child("UseISDCFNameByDefault").get_value_or(true);
573 _write_kdms_to_disk = f.optional_bool_child("WriteKDMsToDisk").get_value_or(true);
574 _email_kdms = f.optional_bool_child("EmailKDMs").get_value_or(false);
575 _default_kdm_type = dcp::string_to_formulation(f.optional_string_child("DefaultKDMType").get_value_or("modified-transitional-1"));
577 if (boost::filesystem::exists (_cinemas_file)) {
578 cxml::Document f ("Cinemas");
579 f.read_file (_cinemas_file);
583 if (boost::filesystem::exists (_dkdm_recipients_file)) {
584 cxml::Document f ("DKDMRecipients");
585 f.read_file (_dkdm_recipients_file);
586 read_dkdm_recipients (f);
590 if (have_existing("config.xml") || have_existing("cinemas.xml") || have_existing("dkdm_recipients.xml")) {
592 /* We have a config file but it didn't load */
596 /* Make a new set of signing certificates and key */
597 _signer_chain = create_certificate_chain ();
598 /* And similar for decryption of KDMs */
599 _decryption_chain = create_certificate_chain ();
603 /** @return Singleton instance */
607 if (_instance == 0) {
608 _instance = new Config;
615 /** Write our configuration to disk */
617 Config::write () const
621 write_dkdm_recipients ();
625 Config::write_config () const
628 auto root = doc.create_root_node ("Config");
630 /* [XML] Version The version number of the configuration file format. */
631 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
632 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
633 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
634 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
635 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
636 if (_default_directory) {
637 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
638 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
640 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
641 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
642 by the batch converter to listen for job requests.
644 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
645 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
646 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
648 for (auto i: _servers) {
649 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
652 root->add_child("Server")->add_child_text (i);
655 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
656 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
658 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
659 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
660 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
661 /* [XML] TMSIP IP address of TMS. */
662 root->add_child("TMSIP")->add_child_text (_tms_ip);
663 /* [XML] TMSPath Path on the TMS to copy files to. */
664 root->add_child("TMSPath")->add_child_text (_tms_path);
665 /* [XML] TMSUser Username to log into the TMS with. */
666 root->add_child("TMSUser")->add_child_text (_tms_user);
667 /* [XML] TMSPassword Password to log into the TMS with. */
668 root->add_child("TMSPassword")->add_child_text (_tms_password);
670 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
671 root->add_child("Language")->add_child_text (_language.get());
673 if (_default_container) {
674 /* [XML:opt] DefaultContainer ID of default container
675 to use when creating new films (<code>185</code>,<code>239</code> or
678 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
680 if (_default_dcp_content_type) {
681 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
682 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
683 <code>PSA</code> or <code>ADV</code>). */
684 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
686 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
687 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
688 /* [XML] DCPIssuer Issuer text to write into CPL files. */
689 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
690 /* [XML] DCPCreator Creator text to write into CPL files. */
691 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
692 /* [XML] Company name to write into MXF files. */
693 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
694 /* [XML] Product name to write into MXF files. */
695 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
696 /* [XML] Product version to write into MXF files. */
697 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
698 /* [XML] Comment to write into JPEG2000 data. */
699 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
700 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
701 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
703 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
704 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
705 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
706 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
707 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
708 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
709 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
710 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
711 for (auto const& i: _default_metadata) {
712 auto c = root->add_child("DefaultMetadata");
713 c->set_attribute("key", i.first);
714 c->add_child_text(i.second);
716 if (_default_kdm_directory) {
717 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
718 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
720 /* [XML] MailServer Hostname of SMTP server to use. */
721 root->add_child("MailServer")->add_child_text (_mail_server);
722 /* [XML] MailPort Port number to use on SMTP server. */
723 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
724 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
725 switch (_mail_protocol) {
726 case EmailProtocol::AUTO:
727 root->add_child("MailProtocol")->add_child_text("Auto");
729 case EmailProtocol::PLAIN:
730 root->add_child("MailProtocol")->add_child_text("Plain");
732 case EmailProtocol::STARTTLS:
733 root->add_child("MailProtocol")->add_child_text("STARTTLS");
735 case EmailProtocol::SSL:
736 root->add_child("MailProtocol")->add_child_text("SSL");
739 /* [XML] MailUser Username to use on SMTP server. */
740 root->add_child("MailUser")->add_child_text (_mail_user);
741 /* [XML] MailPassword Password to use on SMTP server. */
742 root->add_child("MailPassword")->add_child_text (_mail_password);
744 /* [XML] KDMSubject Subject to use for KDM emails. */
745 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
746 /* [XML] KDMFrom From address to use for KDM emails. */
747 root->add_child("KDMFrom")->add_child_text (_kdm_from);
748 for (auto i: _kdm_cc) {
749 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
750 root->add_child("KDMCC")->add_child_text (i);
752 /* [XML] KDMBCC BCC address to use for KDM emails. */
753 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
754 /* [XML] KDMEmail Text of KDM email. */
755 root->add_child("KDMEmail")->add_child_text (_kdm_email);
757 /* [XML] NotificationSubject Subject to use for notification emails. */
758 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
759 /* [XML] NotificationFrom From address to use for notification emails. */
760 root->add_child("NotificationFrom")->add_child_text (_notification_from);
761 /* [XML] NotificationFrom To address to use for notification emails. */
762 root->add_child("NotificationTo")->add_child_text (_notification_to);
763 for (auto i: _notification_cc) {
764 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
765 root->add_child("NotificationCC")->add_child_text (i);
767 /* [XML] NotificationBCC BCC address to use for notification emails. */
768 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
769 /* [XML] NotificationEmail Text of notification email. */
770 root->add_child("NotificationEmail")->add_child_text (_notification_email);
772 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
773 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
774 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
775 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
777 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
778 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
779 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
780 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
781 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
782 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
783 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
784 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
785 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
786 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
787 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
788 related to the player, 1024 debug information related to audio analyses.
790 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
791 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
792 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
793 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
794 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
795 #ifdef DCPOMATIC_WINDOWS
796 if (_win32_console) {
797 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
798 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
799 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
801 root->add_child("Win32Console")->add_child_text ("1");
805 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
806 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
808 auto signer = root->add_child ("Signer");
809 DCPOMATIC_ASSERT (_signer_chain);
810 for (auto const& i: _signer_chain->unordered()) {
811 signer->add_child("Certificate")->add_child_text (i.certificate (true));
813 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
815 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
816 auto decryption = root->add_child ("Decryption");
817 DCPOMATIC_ASSERT (_decryption_chain);
818 for (auto const& i: _decryption_chain->unordered()) {
819 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
821 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
823 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
826 for (auto i: _history) {
827 root->add_child("History")->add_child_text (i.string ());
830 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
833 for (auto i: _player_history) {
834 root->add_child("PlayerHistory")->add_child_text (i.string ());
837 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
838 or <code><DKDM></code> tags.
840 /* [XML] DKDM A DKDM as XML */
841 _dkdms->as_xml (root);
843 /* [XML] CinemasFile Filename of cinemas list file. */
844 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
845 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
846 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
847 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
848 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
849 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
850 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
851 /* [XML] KDMFilenameFormat Format for KDM filenames. */
852 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
853 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
854 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
855 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
856 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
857 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
858 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
859 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
860 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
861 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
862 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
863 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
864 for (int i = 0; i < NAG_COUNT; ++i) {
865 xmlpp::Element* e = root->add_child ("Nagged");
866 e->set_attribute ("Id", raw_convert<string>(i));
867 e->add_child_text (_nagged[i] ? "1" : "0");
869 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
870 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
872 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
873 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
875 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
876 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
877 if (_last_player_load_directory) {
878 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
880 /* [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. */
881 if (_last_kdm_write_type) {
882 switch (_last_kdm_write_type.get()) {
884 root->add_child("LastKDMWriteType")->add_child_text("flat");
886 case KDM_WRITE_FOLDER:
887 root->add_child("LastKDMWriteType")->add_child_text("folder");
890 root->add_child("LastKDMWriteType")->add_child_text("zip");
894 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
895 if (_last_dkdm_write_type) {
896 switch (_last_dkdm_write_type.get()) {
897 case DKDM_WRITE_INTERNAL:
898 root->add_child("LastDKDMWriteType")->add_child_text("internal");
900 case DKDM_WRITE_FILE:
901 root->add_child("LastDKDMWriteType")->add_child_text("file");
905 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
906 frames to be held in memory at once.
908 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
910 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
911 if (_decode_reduction) {
912 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
915 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
916 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
918 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
919 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
920 xmlpp::Element* e = root->add_child ("Notification");
921 e->set_attribute ("Id", raw_convert<string>(i));
922 e->add_child_text (_notification[i] ? "1" : "0");
925 if (_barco_username) {
926 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
927 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
929 if (_barco_password) {
930 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
931 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
934 if (_christie_username) {
935 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
936 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
938 if (_christie_password) {
939 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
940 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
944 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
945 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
948 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
949 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
952 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
953 with controls on another monitor.
955 switch (_player_mode) {
956 case PLAYER_MODE_WINDOW:
957 root->add_child("PlayerMode")->add_child_text("window");
959 case PLAYER_MODE_FULL:
960 root->add_child("PlayerMode")->add_child_text("full");
962 case PLAYER_MODE_DUAL:
963 root->add_child("PlayerMode")->add_child_text("dual");
967 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
968 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
969 switch (_video_view_type) {
970 case VIDEO_VIEW_SIMPLE:
971 root->add_child("VideoViewType")->add_child_text("simple");
973 case VIDEO_VIEW_OPENGL:
974 root->add_child("VideoViewType")->add_child_text("opengl");
977 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
978 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
979 if (_player_debug_log_file) {
980 /* [XML] PlayerLogFile Filename to use for player debug logs. */
981 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
983 if (_player_content_directory) {
984 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
985 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
987 if (_player_playlist_directory) {
988 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
989 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
991 if (_player_kdm_directory) {
992 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
993 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
995 if (_audio_mapping) {
996 _audio_mapping->as_xml (root->add_child("AudioMapping"));
998 for (auto const& i: _custom_languages) {
999 root->add_child("CustomLanguage")->add_child_text(i.to_string());
1001 if (_add_files_path) {
1002 /* [XML] AddFilesPath The default path that will be offered in the picker when adding files to a film. */
1003 root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
1005 root->add_child("UseISDCFNameByDefault")->add_child_text(_use_isdcf_name_by_default ? "1" : "0");
1006 root->add_child("WriteKDMsToDisk")->add_child_text(_write_kdms_to_disk ? "1" : "0");
1007 root->add_child("EmailKDMs")->add_child_text(_email_kdms ? "1" : "0");
1008 root->add_child("DefaultKDMType")->add_child_text(dcp::formulation_to_string(_default_kdm_type));
1010 auto target = config_write_file();
1013 auto const s = doc.write_to_string_formatted ();
1014 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1015 auto f = fopen_boost (tmp, "w");
1017 throw FileError (_("Could not open file for writing"), tmp);
1019 checked_fwrite (s.c_str(), s.bytes(), f, tmp);
1021 boost::filesystem::remove (target);
1022 boost::filesystem::rename (tmp, target);
1023 } catch (xmlpp::exception& e) {
1024 string s = e.what ();
1026 throw FileError (s, target);
1033 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1035 xmlpp::Document doc;
1036 auto root = doc.create_root_node (root_node);
1037 root->add_child("Version")->add_child_text(version);
1039 for (auto i: things) {
1040 i->as_xml (root->add_child(node));
1044 doc.write_to_file_formatted (file.string() + ".tmp");
1045 boost::filesystem::remove (file);
1046 boost::filesystem::rename (file.string() + ".tmp", file);
1047 } catch (xmlpp::exception& e) {
1048 string s = e.what ();
1050 throw FileError (s, file);
1056 Config::write_cinemas () const
1058 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1063 Config::write_dkdm_recipients () const
1065 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1069 boost::filesystem::path
1070 Config::default_directory_or (boost::filesystem::path a) const
1072 return directory_or (_default_directory, a);
1075 boost::filesystem::path
1076 Config::default_kdm_directory_or (boost::filesystem::path a) const
1078 return directory_or (_default_kdm_directory, a);
1081 boost::filesystem::path
1082 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1088 boost::system::error_code ec;
1089 auto const e = boost::filesystem::exists (*dir, ec);
1105 Config::changed (Property what)
1111 Config::set_kdm_email_to_default ()
1113 _kdm_subject = _("KDM delivery: $CPL_NAME");
1116 "Dear Projectionist\n\n"
1117 "Please find attached KDMs for $CPL_NAME.\n\n"
1118 "Cinema: $CINEMA_NAME\n"
1119 "Screen(s): $SCREENS\n\n"
1120 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1121 "Best regards,\nDCP-o-matic"
1126 Config::set_notification_email_to_default ()
1128 _notification_subject = _("DCP-o-matic notification");
1130 _notification_email = _(
1131 "$JOB_NAME: $JOB_STATUS"
1136 Config::reset_kdm_email ()
1138 set_kdm_email_to_default ();
1143 Config::reset_notification_email ()
1145 set_notification_email_to_default ();
1150 Config::set_cover_sheet_to_default ()
1155 "Format: $CONTAINER\n"
1157 "Audio Language: $AUDIO_LANGUAGE\n"
1158 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1165 Config::add_to_history (boost::filesystem::path p)
1167 add_to_history_internal (_history, p);
1170 /** Remove non-existant items from the history */
1172 Config::clean_history ()
1174 clean_history_internal (_history);
1178 Config::add_to_player_history (boost::filesystem::path p)
1180 add_to_history_internal (_player_history, p);
1183 /** Remove non-existant items from the player history */
1185 Config::clean_player_history ()
1187 clean_history_internal (_player_history);
1191 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1193 /* Remove existing instances of this path in the history */
1194 h.erase (remove (h.begin(), h.end(), p), h.end ());
1196 h.insert (h.begin (), p);
1197 if (h.size() > HISTORY_SIZE) {
1205 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1211 if (boost::filesystem::is_directory(i)) {
1215 /* We couldn't find out if it's a directory for some reason; just ignore it */
1222 Config::have_existing (string file)
1224 return boost::filesystem::exists (read_path(file));
1229 Config::read_cinemas (cxml::Document const & f)
1232 for (auto i: f.node_children("Cinema")) {
1233 /* Slightly grotty two-part construction of Cinema here so that we can use
1236 auto cinema = make_shared<Cinema>(i);
1237 cinema->read_screens (i);
1238 _cinemas.push_back (cinema);
1243 Config::set_cinemas_file (boost::filesystem::path file)
1245 if (file == _cinemas_file) {
1249 _cinemas_file = file;
1251 if (boost::filesystem::exists (_cinemas_file)) {
1252 /* Existing file; read it in */
1253 cxml::Document f ("Cinemas");
1254 f.read_file (_cinemas_file);
1263 Config::read_dkdm_recipients (cxml::Document const & f)
1265 _dkdm_recipients.clear ();
1266 for (auto i: f.node_children("DKDMRecipient")) {
1267 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1273 Config::save_template (shared_ptr<const Film> film, string name) const
1275 film->write_template (template_write_path(name));
1280 Config::templates () const
1282 if (!boost::filesystem::exists(read_path("templates"))) {
1287 for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1288 n.push_back (i.path().filename().string());
1294 Config::existing_template (string name) const
1296 return boost::filesystem::exists (template_read_path(name));
1300 boost::filesystem::path
1301 Config::template_read_path (string name) const
1303 return read_path("templates") / tidy_for_filename (name);
1307 boost::filesystem::path
1308 Config::template_write_path (string name) const
1310 return write_path("templates") / tidy_for_filename (name);
1315 Config::rename_template (string old_name, string new_name) const
1317 boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name));
1321 Config::delete_template (string name) const
1323 boost::filesystem::remove (template_write_path(name));
1326 /** @return Path to the config.xml containing the actual settings, following a link if required */
1327 boost::filesystem::path
1328 config_file (boost::filesystem::path main)
1330 cxml::Document f ("Config");
1331 if (!boost::filesystem::exists (main)) {
1332 /* It doesn't exist, so there can't be any links; just return it */
1336 /* See if there's a link */
1339 auto link = f.optional_string_child("Link");
1343 } catch (xmlpp::exception& e) {
1344 /* There as a problem reading the main configuration file,
1345 so there can't be a link.
1353 boost::filesystem::path
1354 Config::config_read_file ()
1356 return config_file (read_path("config.xml"));
1360 boost::filesystem::path
1361 Config::config_write_file ()
1363 return config_file (write_path("config.xml"));
1368 Config::reset_cover_sheet ()
1370 set_cover_sheet_to_default ();
1375 Config::link (boost::filesystem::path new_file) const
1377 xmlpp::Document doc;
1378 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1380 doc.write_to_file_formatted(write_path("config.xml").string());
1381 } catch (xmlpp::exception& e) {
1382 string s = e.what ();
1384 throw FileError (s, write_path("config.xml"));
1389 Config::copy_and_link (boost::filesystem::path new_file) const
1392 boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1397 Config::have_write_permission () const
1399 auto f = fopen_boost (config_write_file(), "r+");
1408 /** @param output_channels Number of output channels in use.
1409 * @return Audio mapping for this output channel count (may be a default).
1412 Config::audio_mapping (int output_channels)
1414 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1415 /* Set up a default */
1416 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1417 if (output_channels == 2) {
1418 /* Special case for stereo output.
1419 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1420 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1422 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1423 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1424 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1425 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1426 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1427 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1428 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1429 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1432 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1433 _audio_mapping->set (i, i, 1);
1438 return *_audio_mapping;
1442 Config::set_audio_mapping (AudioMapping m)
1445 changed (AUDIO_MAPPING);
1449 Config::set_audio_mapping_to_default ()
1451 DCPOMATIC_ASSERT (_audio_mapping);
1452 auto const ch = _audio_mapping->output_channels ();
1453 _audio_mapping = boost::none;
1454 _audio_mapping = audio_mapping (ch);
1455 changed (AUDIO_MAPPING);
1460 Config::add_custom_language (dcp::LanguageTag tag)
1462 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1463 _custom_languages.push_back (tag);
1469 optional<Config::BadReason>
1470 Config::check_certificates () const
1472 optional<BadReason> bad;
1474 for (auto const& i: _signer_chain->unordered()) {
1475 if (i.has_utf8_strings()) {
1476 bad = BAD_SIGNER_UTF8_STRINGS;
1478 if ((i.not_after().year() - i.not_before().year()) > 15) {
1479 bad = BAD_SIGNER_VALIDITY_TOO_LONG;
1483 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
1484 bad = BAD_SIGNER_INCONSISTENT;
1487 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
1488 bad = BAD_DECRYPTION_INCONSISTENT;
1496 save_all_config_as_zip (boost::filesystem::path zip_file)
1498 Zipper zipper (zip_file);
1500 auto config = Config::instance();
1501 zipper.add ("config.xml", dcp::file_to_string(config->config_read_file()));
1502 if (boost::filesystem::exists(config->cinemas_file())) {
1503 zipper.add ("cinemas.xml", dcp::file_to_string(config->cinemas_file()));
1505 if (boost::filesystem::exists(config->dkdm_recipients_file())) {
1506 zipper.add ("dkdm_recipients.xml", dcp::file_to_string(config->dkdm_recipients_file()));