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/>.
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"
36 #include <dcp/raw_convert.h>
37 #include <dcp/name_format.h>
38 #include <dcp/certificate_chain.h>
39 #include <libcxml/cxml.h>
41 #include <libxml++/libxml++.h>
42 #include <boost/filesystem.hpp>
43 #include <boost/algorithm/string.hpp>
44 #include <boost/thread.hpp>
59 using std::shared_ptr;
60 using std::make_shared;
61 using boost::optional;
62 using std::dynamic_pointer_cast;
63 using boost::algorithm::trim;
64 using dcp::raw_convert;
66 Config* Config::_instance = 0;
67 int const Config::_current_version = 3;
68 boost::signals2::signal<void ()> Config::FailedToLoad;
69 boost::signals2::signal<void (string)> Config::Warning;
70 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
72 /** Construct default configuration */
74 /* DKDMs are not considered a thing to reset on set_defaults() */
75 : _dkdms (new DKDMGroup ("root"))
81 Config::set_defaults ()
83 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
84 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
85 _server_port_base = 6192;
86 _use_any_servers = true;
88 _only_servers_encode = false;
89 _tms_protocol = FileTransferProtocol::SCP;
94 _allow_any_dcp_frame_rate = false;
95 _allow_any_container = false;
96 _show_experimental_audio_processors = false;
97 _language = optional<string> ();
98 _default_still_length = 10;
99 _default_container = Ratio::from_id ("185");
100 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
101 _default_dcp_audio_channels = 6;
102 _default_j2k_bandwidth = 150000000;
103 _default_audio_delay = 0;
104 _default_interop = false;
105 _default_metadata.clear ();
106 _upload_after_make_dcp = false;
109 _mail_protocol = EmailProtocol::AUTO;
115 _notification_from = "";
116 _notification_to = "";
117 _notification_cc.clear ();
118 _notification_bcc = "";
119 _check_for_updates = false;
120 _check_for_test_updates = false;
121 _maximum_j2k_bandwidth = 250000000;
122 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
123 _analyse_ebur128 = true;
124 _automatic_audio_analysis = false;
125 #ifdef DCPOMATIC_WINDOWS
126 _win32_console = false;
128 /* At the moment we don't write these files anywhere new after a version change, so they will be read from
129 * ~/.config/dcpomatic2 (or equivalent) and written back there.
131 _cinemas_file = read_path ("cinemas.xml");
132 _dkdm_recipients_file = read_path ("dkdm_recipients.xml");
133 _show_hints_before_make_dcp = true;
134 _confirm_kdm_email = true;
135 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
136 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
137 _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
138 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
139 _dcp_asset_filename_format = dcp::NameFormat ("%t");
140 _jump_to_selected = true;
141 for (int i = 0; i < NAG_COUNT; ++i) {
145 _sound_output = optional<string> ();
146 _last_kdm_write_type = KDM_WRITE_FLAT;
147 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
149 /* I think the scaling factor here should be the ratio of the longest frame
150 encode time to the shortest; if the thread count is T, longest time is L
151 and the shortest time S we could encode L/S frames per thread whilst waiting
152 for the L frame to encode so we might have to store LT/S frames.
154 However we don't want to use too much memory, so keep it a bit lower than we'd
155 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
156 use about 240Mb with 72 encoding threads.
158 _frames_in_memory_multiplier = 3;
159 _decode_reduction = optional<int>();
160 _default_notify = false;
161 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
162 _notification[i] = false;
164 _barco_username = optional<string>();
165 _barco_password = optional<string>();
166 _christie_username = optional<string>();
167 _christie_password = optional<string>();
168 _gdc_username = optional<string>();
169 _gdc_password = optional<string>();
170 _player_mode = PLAYER_MODE_WINDOW;
172 _video_view_type = VIDEO_VIEW_SIMPLE;
173 _respect_kdm_validity_periods = true;
174 _player_debug_log_file = boost::none;
175 _player_content_directory = boost::none;
176 _player_playlist_directory = boost::none;
177 _player_kdm_directory = boost::none;
178 _audio_mapping = boost::none;
179 _custom_languages.clear ();
180 _add_files_path = boost::none;
182 _allowed_dcp_frame_rates.clear ();
183 _allowed_dcp_frame_rates.push_back (24);
184 _allowed_dcp_frame_rates.push_back (25);
185 _allowed_dcp_frame_rates.push_back (30);
186 _allowed_dcp_frame_rates.push_back (48);
187 _allowed_dcp_frame_rates.push_back (50);
188 _allowed_dcp_frame_rates.push_back (60);
190 set_kdm_email_to_default ();
191 set_notification_email_to_default ();
192 set_cover_sheet_to_default ();
196 Config::restore_defaults ()
198 Config::instance()->set_defaults ();
199 Config::instance()->changed ();
202 shared_ptr<dcp::CertificateChain>
203 Config::create_certificate_chain ()
205 return make_shared<dcp::CertificateChain> (
207 CERTIFICATE_VALIDITY_PERIOD,
210 ".dcpomatic.smpte-430-2.ROOT",
211 ".dcpomatic.smpte-430-2.INTERMEDIATE",
212 "CS.dcpomatic.smpte-430-2.LEAF"
219 using namespace boost::filesystem;
221 auto copy_adding_number = [](path const& path_to_copy) {
223 auto add_number = [](path const& path, int number) {
224 return String::compose("%1.%2", path, number);
228 while (n < 100 && exists(add_number(path_to_copy, n))) {
231 boost::system::error_code ec;
232 copy_file(path_to_copy, add_number(path_to_copy, n), ec);
235 /* Make a backup copy of any config.xml, cinemas.xml, dkdm_recipients.xml that we might be about
236 * to write over. This is more intended for the situation where we have a corrupted config.xml,
237 * and decide to overwrite it with a new one (possibly losing important details in the corrupted
238 * file). But we might as well back up the other files while we're about it.
241 /* This uses the State::write_path stuff so, e.g. for a current version 2.16 we might copy
242 * ~/.config/dcpomatic2/2.16/config.xml to ~/.config/dcpomatic2/2.16/config.xml.1
244 copy_adding_number (config_write_file());
246 /* These do not use State::write_path, so whatever path is in the Config we will copy
249 copy_adding_number (_cinemas_file);
250 copy_adding_number (_dkdm_recipients_file);
257 cxml::Document f ("Config");
258 f.read_file (config_read_file());
260 auto version = f.optional_number_child<int> ("Version");
261 if (version && *version < _current_version) {
262 /* Back up the old config before we re-write it in a back-incompatible way */
266 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
267 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
269 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
270 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
273 _default_directory = f.optional_string_child ("DefaultDirectory");
274 if (_default_directory && _default_directory->empty ()) {
275 /* We used to store an empty value for this to mean "none set" */
276 _default_directory = boost::optional<boost::filesystem::path> ();
279 auto b = f.optional_number_child<int> ("ServerPort");
281 b = f.optional_number_child<int> ("ServerPortBase");
283 _server_port_base = b.get ();
285 auto u = f.optional_bool_child ("UseAnyServers");
286 _use_any_servers = u.get_value_or (true);
288 for (auto i: f.node_children("Server")) {
289 if (i->node_children("HostName").size() == 1) {
290 _servers.push_back (i->string_child ("HostName"));
292 _servers.push_back (i->content ());
296 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
297 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
298 _tms_ip = f.string_child ("TMSIP");
299 _tms_path = f.string_child ("TMSPath");
300 _tms_user = f.string_child ("TMSUser");
301 _tms_password = f.string_child ("TMSPassword");
303 _language = f.optional_string_child ("Language");
305 auto c = f.optional_string_child ("DefaultContainer");
307 _default_container = Ratio::from_id (c.get ());
310 if (_default_container && !_default_container->used_for_container()) {
311 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
312 _default_container = Ratio::from_id ("185");
315 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
316 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
318 if (f.optional_string_child ("DCPMetadataIssuer")) {
319 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
320 } else if (f.optional_string_child ("DCPIssuer")) {
321 _dcp_issuer = f.string_child ("DCPIssuer");
324 auto up = f.optional_bool_child("UploadAfterMakeDCP");
326 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
328 _upload_after_make_dcp = up.get_value_or (false);
329 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
330 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
331 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
332 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
333 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
335 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
336 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
337 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
338 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
340 for (auto const& i: f.node_children("DefaultMetadata")) {
341 _default_metadata[i->string_attribute("key")] = i->content();
344 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
346 /* Read any cinemas that are still lying around in the config file
347 * from an old version.
351 _mail_server = f.string_child ("MailServer");
352 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
355 /* Make sure this matches the code in write_config */
356 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
357 if (protocol == "Auto") {
358 _mail_protocol = EmailProtocol::AUTO;
359 } else if (protocol == "Plain") {
360 _mail_protocol = EmailProtocol::PLAIN;
361 } else if (protocol == "STARTTLS") {
362 _mail_protocol = EmailProtocol::STARTTLS;
363 } else if (protocol == "SSL") {
364 _mail_protocol = EmailProtocol::SSL;
368 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
369 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
371 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
372 _kdm_from = f.string_child ("KDMFrom");
373 for (auto i: f.node_children("KDMCC")) {
374 if (!i->content().empty()) {
375 _kdm_cc.push_back (i->content ());
378 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
379 _kdm_email = f.string_child ("KDMEmail");
381 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
382 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
383 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
384 for (auto i: f.node_children("NotificationCC")) {
385 if (!i->content().empty()) {
386 _notification_cc.push_back (i->content ());
389 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
390 if (f.optional_string_child("NotificationEmail")) {
391 _notification_email = f.string_child("NotificationEmail");
394 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
395 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
397 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
398 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
399 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
400 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
402 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
403 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
404 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
405 #ifdef DCPOMATIC_WINDOWS
406 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
409 for (auto i: f.node_children("History")) {
410 _history.push_back (i->content ());
413 for (auto i: f.node_children("PlayerHistory")) {
414 _player_history.push_back (i->content ());
417 auto signer = f.optional_node_child ("Signer");
419 auto c = make_shared<dcp::CertificateChain>();
420 /* Read the signing certificates and private key in from the config file */
421 for (auto i: signer->node_children ("Certificate")) {
422 c->add (dcp::Certificate (i->content ()));
424 c->set_key (signer->string_child ("PrivateKey"));
427 /* Make a new set of signing certificates and key */
428 _signer_chain = create_certificate_chain ();
431 auto decryption = f.optional_node_child ("Decryption");
433 auto c = make_shared<dcp::CertificateChain>();
434 for (auto i: decryption->node_children ("Certificate")) {
435 c->add (dcp::Certificate (i->content ()));
437 c->set_key (decryption->string_child ("PrivateKey"));
438 _decryption_chain = c;
440 _decryption_chain = create_certificate_chain ();
443 /* These must be done before we call Bad as that might set one
446 for (auto i: f.node_children("Nagged")) {
447 auto const id = i->number_attribute<int>("Id");
448 if (id >= 0 && id < NAG_COUNT) {
449 _nagged[id] = raw_convert<int>(i->content());
453 auto bad = check_certificates ();
455 auto const remake = Bad(*bad);
456 if (remake && *remake) {
458 case BAD_SIGNER_UTF8_STRINGS:
459 case BAD_SIGNER_INCONSISTENT:
460 case BAD_SIGNER_VALIDITY_TOO_LONG:
461 _signer_chain = create_certificate_chain ();
463 case BAD_DECRYPTION_INCONSISTENT:
464 _decryption_chain = create_certificate_chain ();
470 if (f.optional_node_child("DKDMGroup")) {
471 /* New-style: all DKDMs in a group */
472 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
474 /* Old-style: one or more DKDM nodes */
475 _dkdms.reset (new DKDMGroup ("root"));
476 for (auto i: f.node_children("DKDM")) {
477 _dkdms->add (DKDMBase::read (i));
480 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
481 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
482 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
483 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
484 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
485 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
486 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
487 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
488 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
489 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
490 /* The variable was renamed but not the XML tag */
491 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
492 _sound_output = f.optional_string_child("PreviewSoundOutput");
493 if (f.optional_string_child("CoverSheet")) {
494 _cover_sheet = f.optional_string_child("CoverSheet").get();
496 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
497 if (f.optional_string_child("LastKDMWriteType")) {
498 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
499 _last_kdm_write_type = KDM_WRITE_FLAT;
500 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
501 _last_kdm_write_type = KDM_WRITE_FOLDER;
502 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
503 _last_kdm_write_type = KDM_WRITE_ZIP;
506 if (f.optional_string_child("LastDKDMWriteType")) {
507 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
508 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
509 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
510 _last_dkdm_write_type = DKDM_WRITE_FILE;
513 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
514 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
515 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
517 for (auto i: f.node_children("Notification")) {
518 int const id = i->number_attribute<int>("Id");
519 if (id >= 0 && id < NOTIFICATION_COUNT) {
520 _notification[id] = raw_convert<int>(i->content());
524 _barco_username = f.optional_string_child("BarcoUsername");
525 _barco_password = f.optional_string_child("BarcoPassword");
526 _christie_username = f.optional_string_child("ChristieUsername");
527 _christie_password = f.optional_string_child("ChristiePassword");
528 _gdc_username = f.optional_string_child("GDCUsername");
529 _gdc_password = f.optional_string_child("GDCPassword");
531 auto pm = f.optional_string_child("PlayerMode");
532 if (pm && *pm == "window") {
533 _player_mode = PLAYER_MODE_WINDOW;
534 } else if (pm && *pm == "full") {
535 _player_mode = PLAYER_MODE_FULL;
536 } else if (pm && *pm == "dual") {
537 _player_mode = PLAYER_MODE_DUAL;
540 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
541 auto vc = f.optional_string_child("VideoViewType");
542 if (vc && *vc == "opengl") {
543 _video_view_type = VIDEO_VIEW_OPENGL;
544 } else if (vc && *vc == "simple") {
545 _video_view_type = VIDEO_VIEW_SIMPLE;
547 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
548 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
549 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
550 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
551 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
553 if (f.optional_node_child("AudioMapping")) {
554 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
557 for (auto i: f.node_children("CustomLanguage")) {
559 /* This will fail if it's called before dcp::init() as it won't recognise the
560 * tag. That's OK because the Config will be reloaded again later.
562 _custom_languages.push_back (dcp::LanguageTag(i->content()));
563 } catch (std::runtime_error& e) {}
566 _add_files_path = f.optional_string_child("AddFilesPath");
568 if (boost::filesystem::exists (_cinemas_file)) {
569 cxml::Document f ("Cinemas");
570 f.read_file (_cinemas_file);
574 if (boost::filesystem::exists (_dkdm_recipients_file)) {
575 cxml::Document f ("DKDMRecipients");
576 f.read_file (_dkdm_recipients_file);
577 read_dkdm_recipients (f);
581 if (have_existing("config.xml") || have_existing("cinemas.xml") || have_existing("dkdm_recipients.xml")) {
583 /* We have a config file but it didn't load */
587 /* Make a new set of signing certificates and key */
588 _signer_chain = create_certificate_chain ();
589 /* And similar for decryption of KDMs */
590 _decryption_chain = create_certificate_chain ();
594 /** @return Singleton instance */
598 if (_instance == 0) {
599 _instance = new Config;
606 /** Write our configuration to disk */
608 Config::write () const
612 write_dkdm_recipients ();
616 Config::write_config () const
619 auto root = doc.create_root_node ("Config");
621 /* [XML] Version The version number of the configuration file format. */
622 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
623 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
624 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
625 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
626 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
627 if (_default_directory) {
628 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
629 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
631 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
632 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
633 by the batch converter to listen for job requests.
635 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
636 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
637 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
639 for (auto i: _servers) {
640 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
643 root->add_child("Server")->add_child_text (i);
646 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
647 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
649 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
650 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
651 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
652 /* [XML] TMSIP IP address of TMS. */
653 root->add_child("TMSIP")->add_child_text (_tms_ip);
654 /* [XML] TMSPath Path on the TMS to copy files to. */
655 root->add_child("TMSPath")->add_child_text (_tms_path);
656 /* [XML] TMSUser Username to log into the TMS with. */
657 root->add_child("TMSUser")->add_child_text (_tms_user);
658 /* [XML] TMSPassword Password to log into the TMS with. */
659 root->add_child("TMSPassword")->add_child_text (_tms_password);
661 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
662 root->add_child("Language")->add_child_text (_language.get());
664 if (_default_container) {
665 /* [XML:opt] DefaultContainer ID of default container
666 to use when creating new films (<code>185</code>,<code>239</code> or
669 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
671 if (_default_dcp_content_type) {
672 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
673 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
674 <code>PSA</code> or <code>ADV</code>). */
675 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
677 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
678 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
679 /* [XML] DCPIssuer Issuer text to write into CPL files. */
680 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
681 /* [XML] DCPCreator Creator text to write into CPL files. */
682 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
683 /* [XML] Company name to write into MXF files. */
684 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
685 /* [XML] Product name to write into MXF files. */
686 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
687 /* [XML] Product version to write into MXF files. */
688 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
689 /* [XML] Comment to write into JPEG2000 data. */
690 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
691 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
692 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
694 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
695 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
696 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
697 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
698 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
699 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
700 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
701 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
702 for (auto const& i: _default_metadata) {
703 auto c = root->add_child("DefaultMetadata");
704 c->set_attribute("key", i.first);
705 c->add_child_text(i.second);
707 if (_default_kdm_directory) {
708 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
709 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
711 /* [XML] MailServer Hostname of SMTP server to use. */
712 root->add_child("MailServer")->add_child_text (_mail_server);
713 /* [XML] MailPort Port number to use on SMTP server. */
714 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
715 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
716 switch (_mail_protocol) {
717 case EmailProtocol::AUTO:
718 root->add_child("MailProtocol")->add_child_text("Auto");
720 case EmailProtocol::PLAIN:
721 root->add_child("MailProtocol")->add_child_text("Plain");
723 case EmailProtocol::STARTTLS:
724 root->add_child("MailProtocol")->add_child_text("STARTTLS");
726 case EmailProtocol::SSL:
727 root->add_child("MailProtocol")->add_child_text("SSL");
730 /* [XML] MailUser Username to use on SMTP server. */
731 root->add_child("MailUser")->add_child_text (_mail_user);
732 /* [XML] MailPassword Password to use on SMTP server. */
733 root->add_child("MailPassword")->add_child_text (_mail_password);
735 /* [XML] KDMSubject Subject to use for KDM emails. */
736 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
737 /* [XML] KDMFrom From address to use for KDM emails. */
738 root->add_child("KDMFrom")->add_child_text (_kdm_from);
739 for (auto i: _kdm_cc) {
740 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
741 root->add_child("KDMCC")->add_child_text (i);
743 /* [XML] KDMBCC BCC address to use for KDM emails. */
744 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
745 /* [XML] KDMEmail Text of KDM email. */
746 root->add_child("KDMEmail")->add_child_text (_kdm_email);
748 /* [XML] NotificationSubject Subject to use for notification emails. */
749 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
750 /* [XML] NotificationFrom From address to use for notification emails. */
751 root->add_child("NotificationFrom")->add_child_text (_notification_from);
752 /* [XML] NotificationFrom To address to use for notification emails. */
753 root->add_child("NotificationTo")->add_child_text (_notification_to);
754 for (auto i: _notification_cc) {
755 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
756 root->add_child("NotificationCC")->add_child_text (i);
758 /* [XML] NotificationBCC BCC address to use for notification emails. */
759 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
760 /* [XML] NotificationEmail Text of notification email. */
761 root->add_child("NotificationEmail")->add_child_text (_notification_email);
763 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
764 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
765 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
766 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
768 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
769 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
770 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
771 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
772 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
773 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
774 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
775 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
776 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
777 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
778 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
779 related to the player, 1024 debug information related to audio analyses.
781 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
782 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
783 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
784 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
785 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
786 #ifdef DCPOMATIC_WINDOWS
787 if (_win32_console) {
788 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
789 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
790 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
792 root->add_child("Win32Console")->add_child_text ("1");
796 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
797 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
799 auto signer = root->add_child ("Signer");
800 DCPOMATIC_ASSERT (_signer_chain);
801 for (auto const& i: _signer_chain->unordered()) {
802 signer->add_child("Certificate")->add_child_text (i.certificate (true));
804 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
806 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
807 auto decryption = root->add_child ("Decryption");
808 DCPOMATIC_ASSERT (_decryption_chain);
809 for (auto const& i: _decryption_chain->unordered()) {
810 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
812 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
814 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
817 for (auto i: _history) {
818 root->add_child("History")->add_child_text (i.string ());
821 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
824 for (auto i: _player_history) {
825 root->add_child("PlayerHistory")->add_child_text (i.string ());
828 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
829 or <code><DKDM></code> tags.
831 /* [XML] DKDM A DKDM as XML */
832 _dkdms->as_xml (root);
834 /* [XML] CinemasFile Filename of cinemas list file. */
835 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
836 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
837 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
838 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
839 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
840 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
841 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
842 /* [XML] KDMFilenameFormat Format for KDM filenames. */
843 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
844 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
845 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
846 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
847 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
848 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
849 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
850 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
851 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
852 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
853 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
854 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
855 for (int i = 0; i < NAG_COUNT; ++i) {
856 xmlpp::Element* e = root->add_child ("Nagged");
857 e->set_attribute ("Id", raw_convert<string>(i));
858 e->add_child_text (_nagged[i] ? "1" : "0");
860 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
861 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
863 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
864 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
866 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
867 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
868 if (_last_player_load_directory) {
869 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
871 /* [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. */
872 if (_last_kdm_write_type) {
873 switch (_last_kdm_write_type.get()) {
875 root->add_child("LastKDMWriteType")->add_child_text("flat");
877 case KDM_WRITE_FOLDER:
878 root->add_child("LastKDMWriteType")->add_child_text("folder");
881 root->add_child("LastKDMWriteType")->add_child_text("zip");
885 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
886 if (_last_dkdm_write_type) {
887 switch (_last_dkdm_write_type.get()) {
888 case DKDM_WRITE_INTERNAL:
889 root->add_child("LastDKDMWriteType")->add_child_text("internal");
891 case DKDM_WRITE_FILE:
892 root->add_child("LastDKDMWriteType")->add_child_text("file");
896 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
897 frames to be held in memory at once.
899 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
901 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
902 if (_decode_reduction) {
903 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
906 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
907 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
909 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
910 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
911 xmlpp::Element* e = root->add_child ("Notification");
912 e->set_attribute ("Id", raw_convert<string>(i));
913 e->add_child_text (_notification[i] ? "1" : "0");
916 if (_barco_username) {
917 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
918 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
920 if (_barco_password) {
921 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
922 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
925 if (_christie_username) {
926 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
927 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
929 if (_christie_password) {
930 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
931 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
935 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
936 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
939 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
940 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
943 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
944 with controls on another monitor.
946 switch (_player_mode) {
947 case PLAYER_MODE_WINDOW:
948 root->add_child("PlayerMode")->add_child_text("window");
950 case PLAYER_MODE_FULL:
951 root->add_child("PlayerMode")->add_child_text("full");
953 case PLAYER_MODE_DUAL:
954 root->add_child("PlayerMode")->add_child_text("dual");
958 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
959 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
960 switch (_video_view_type) {
961 case VIDEO_VIEW_SIMPLE:
962 root->add_child("VideoViewType")->add_child_text("simple");
964 case VIDEO_VIEW_OPENGL:
965 root->add_child("VideoViewType")->add_child_text("opengl");
968 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
969 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
970 if (_player_debug_log_file) {
971 /* [XML] PlayerLogFile Filename to use for player debug logs. */
972 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
974 if (_player_content_directory) {
975 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
976 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
978 if (_player_playlist_directory) {
979 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
980 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
982 if (_player_kdm_directory) {
983 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
984 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
986 if (_audio_mapping) {
987 _audio_mapping->as_xml (root->add_child("AudioMapping"));
989 for (auto const& i: _custom_languages) {
990 root->add_child("CustomLanguage")->add_child_text(i.to_string());
992 if (_add_files_path) {
993 /* [XML] AddFilesPath The default path that will be offered in the picker when adding files to a film. */
994 root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
997 auto target = config_write_file();
1000 auto const s = doc.write_to_string_formatted ();
1001 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1002 auto f = fopen_boost (tmp, "w");
1004 throw FileError (_("Could not open file for writing"), tmp);
1006 checked_fwrite (s.c_str(), s.bytes(), f, tmp);
1008 boost::filesystem::remove (target);
1009 boost::filesystem::rename (tmp, target);
1010 } catch (xmlpp::exception& e) {
1011 string s = e.what ();
1013 throw FileError (s, target);
1020 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1022 xmlpp::Document doc;
1023 auto root = doc.create_root_node (root_node);
1024 root->add_child("Version")->add_child_text(version);
1026 for (auto i: things) {
1027 i->as_xml (root->add_child(node));
1031 doc.write_to_file_formatted (file.string() + ".tmp");
1032 boost::filesystem::remove (file);
1033 boost::filesystem::rename (file.string() + ".tmp", file);
1034 } catch (xmlpp::exception& e) {
1035 string s = e.what ();
1037 throw FileError (s, file);
1043 Config::write_cinemas () const
1045 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1050 Config::write_dkdm_recipients () const
1052 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1056 boost::filesystem::path
1057 Config::default_directory_or (boost::filesystem::path a) const
1059 return directory_or (_default_directory, a);
1062 boost::filesystem::path
1063 Config::default_kdm_directory_or (boost::filesystem::path a) const
1065 return directory_or (_default_kdm_directory, a);
1068 boost::filesystem::path
1069 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1075 boost::system::error_code ec;
1076 auto const e = boost::filesystem::exists (*dir, ec);
1092 Config::changed (Property what)
1098 Config::set_kdm_email_to_default ()
1100 _kdm_subject = _("KDM delivery: $CPL_NAME");
1103 "Dear Projectionist\n\n"
1104 "Please find attached KDMs for $CPL_NAME.\n\n"
1105 "Cinema: $CINEMA_NAME\n"
1106 "Screen(s): $SCREENS\n\n"
1107 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1108 "Best regards,\nDCP-o-matic"
1113 Config::set_notification_email_to_default ()
1115 _notification_subject = _("DCP-o-matic notification");
1117 _notification_email = _(
1118 "$JOB_NAME: $JOB_STATUS"
1123 Config::reset_kdm_email ()
1125 set_kdm_email_to_default ();
1130 Config::reset_notification_email ()
1132 set_notification_email_to_default ();
1137 Config::set_cover_sheet_to_default ()
1142 "Format: $CONTAINER\n"
1144 "Audio Language: $AUDIO_LANGUAGE\n"
1145 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1152 Config::add_to_history (boost::filesystem::path p)
1154 add_to_history_internal (_history, p);
1157 /** Remove non-existant items from the history */
1159 Config::clean_history ()
1161 clean_history_internal (_history);
1165 Config::add_to_player_history (boost::filesystem::path p)
1167 add_to_history_internal (_player_history, p);
1170 /** Remove non-existant items from the player history */
1172 Config::clean_player_history ()
1174 clean_history_internal (_player_history);
1178 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1180 /* Remove existing instances of this path in the history */
1181 h.erase (remove (h.begin(), h.end(), p), h.end ());
1183 h.insert (h.begin (), p);
1184 if (h.size() > HISTORY_SIZE) {
1192 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1198 if (boost::filesystem::is_directory(i)) {
1202 /* We couldn't find out if it's a directory for some reason; just ignore it */
1209 Config::have_existing (string file)
1211 return boost::filesystem::exists (read_path(file));
1216 Config::read_cinemas (cxml::Document const & f)
1219 for (auto i: f.node_children("Cinema")) {
1220 /* Slightly grotty two-part construction of Cinema here so that we can use
1223 auto cinema = make_shared<Cinema>(i);
1224 cinema->read_screens (i);
1225 _cinemas.push_back (cinema);
1230 Config::set_cinemas_file (boost::filesystem::path file)
1232 if (file == _cinemas_file) {
1236 _cinemas_file = file;
1238 if (boost::filesystem::exists (_cinemas_file)) {
1239 /* Existing file; read it in */
1240 cxml::Document f ("Cinemas");
1241 f.read_file (_cinemas_file);
1250 Config::read_dkdm_recipients (cxml::Document const & f)
1252 _dkdm_recipients.clear ();
1253 for (auto i: f.node_children("DKDMRecipient")) {
1254 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1260 Config::save_template (shared_ptr<const Film> film, string name) const
1262 film->write_template (template_write_path(name));
1267 Config::templates () const
1269 if (!boost::filesystem::exists(read_path("templates"))) {
1274 for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1275 n.push_back (i.path().filename().string());
1281 Config::existing_template (string name) const
1283 return boost::filesystem::exists (template_read_path(name));
1287 boost::filesystem::path
1288 Config::template_read_path (string name) const
1290 return read_path("templates") / tidy_for_filename (name);
1294 boost::filesystem::path
1295 Config::template_write_path (string name) const
1297 return write_path("templates") / tidy_for_filename (name);
1302 Config::rename_template (string old_name, string new_name) const
1304 boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name));
1308 Config::delete_template (string name) const
1310 boost::filesystem::remove (template_write_path(name));
1313 /** @return Path to the config.xml containing the actual settings, following a link if required */
1314 boost::filesystem::path
1315 config_file (boost::filesystem::path main)
1317 cxml::Document f ("Config");
1318 if (!boost::filesystem::exists (main)) {
1319 /* It doesn't exist, so there can't be any links; just return it */
1323 /* See if there's a link */
1326 auto link = f.optional_string_child("Link");
1330 } catch (xmlpp::exception& e) {
1331 /* There as a problem reading the main configuration file,
1332 so there can't be a link.
1340 boost::filesystem::path
1341 Config::config_read_file ()
1343 return config_file (read_path("config.xml"));
1347 boost::filesystem::path
1348 Config::config_write_file ()
1350 return config_file (write_path("config.xml"));
1355 Config::reset_cover_sheet ()
1357 set_cover_sheet_to_default ();
1362 Config::link (boost::filesystem::path new_file) const
1364 xmlpp::Document doc;
1365 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1367 doc.write_to_file_formatted(write_path("config.xml").string());
1368 } catch (xmlpp::exception& e) {
1369 string s = e.what ();
1371 throw FileError (s, write_path("config.xml"));
1376 Config::copy_and_link (boost::filesystem::path new_file) const
1379 boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1384 Config::have_write_permission () const
1386 auto f = fopen_boost (config_write_file(), "r+");
1395 /** @param output_channels Number of output channels in use.
1396 * @return Audio mapping for this output channel count (may be a default).
1399 Config::audio_mapping (int output_channels)
1401 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1402 /* Set up a default */
1403 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1404 if (output_channels == 2) {
1405 /* Special case for stereo output.
1406 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1407 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1409 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1410 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1411 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1412 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1413 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1414 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1415 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1416 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1419 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1420 _audio_mapping->set (i, i, 1);
1425 return *_audio_mapping;
1429 Config::set_audio_mapping (AudioMapping m)
1432 changed (AUDIO_MAPPING);
1436 Config::set_audio_mapping_to_default ()
1438 DCPOMATIC_ASSERT (_audio_mapping);
1439 auto const ch = _audio_mapping->output_channels ();
1440 _audio_mapping = boost::none;
1441 _audio_mapping = audio_mapping (ch);
1442 changed (AUDIO_MAPPING);
1447 Config::add_custom_language (dcp::LanguageTag tag)
1449 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1450 _custom_languages.push_back (tag);
1456 optional<Config::BadReason>
1457 Config::check_certificates () const
1459 optional<BadReason> bad;
1461 for (auto const& i: _signer_chain->unordered()) {
1462 if (i.has_utf8_strings()) {
1463 bad = BAD_SIGNER_UTF8_STRINGS;
1465 if ((i.not_after().year() - i.not_before().year()) > 15) {
1466 bad = BAD_SIGNER_VALIDITY_TOO_LONG;
1470 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
1471 bad = BAD_SIGNER_INCONSISTENT;
1474 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
1475 bad = BAD_DECRYPTION_INCONSISTENT;