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 optional<BadReason> bad;
455 for (auto const& i: _signer_chain->unordered()) {
456 if (i.has_utf8_strings()) {
457 bad = BAD_SIGNER_UTF8_STRINGS;
459 if ((i.not_after().year() - i.not_before().year()) > 15) {
460 bad = BAD_SIGNER_VALIDITY_TOO_LONG;
464 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
465 bad = BAD_SIGNER_INCONSISTENT;
468 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
469 bad = BAD_DECRYPTION_INCONSISTENT;
473 auto const remake = Bad(*bad);
474 if (remake && *remake) {
476 case BAD_SIGNER_UTF8_STRINGS:
477 case BAD_SIGNER_INCONSISTENT:
478 case BAD_SIGNER_VALIDITY_TOO_LONG:
479 _signer_chain = create_certificate_chain ();
481 case BAD_DECRYPTION_INCONSISTENT:
482 _decryption_chain = create_certificate_chain ();
488 if (f.optional_node_child("DKDMGroup")) {
489 /* New-style: all DKDMs in a group */
490 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
492 /* Old-style: one or more DKDM nodes */
493 _dkdms.reset (new DKDMGroup ("root"));
494 for (auto i: f.node_children("DKDM")) {
495 _dkdms->add (DKDMBase::read (i));
498 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
499 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
500 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
501 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
502 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
503 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
504 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
505 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
506 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
507 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
508 /* The variable was renamed but not the XML tag */
509 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
510 _sound_output = f.optional_string_child("PreviewSoundOutput");
511 if (f.optional_string_child("CoverSheet")) {
512 _cover_sheet = f.optional_string_child("CoverSheet").get();
514 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
515 if (f.optional_string_child("LastKDMWriteType")) {
516 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
517 _last_kdm_write_type = KDM_WRITE_FLAT;
518 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
519 _last_kdm_write_type = KDM_WRITE_FOLDER;
520 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
521 _last_kdm_write_type = KDM_WRITE_ZIP;
524 if (f.optional_string_child("LastDKDMWriteType")) {
525 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
526 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
527 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
528 _last_dkdm_write_type = DKDM_WRITE_FILE;
531 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
532 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
533 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
535 for (auto i: f.node_children("Notification")) {
536 int const id = i->number_attribute<int>("Id");
537 if (id >= 0 && id < NOTIFICATION_COUNT) {
538 _notification[id] = raw_convert<int>(i->content());
542 _barco_username = f.optional_string_child("BarcoUsername");
543 _barco_password = f.optional_string_child("BarcoPassword");
544 _christie_username = f.optional_string_child("ChristieUsername");
545 _christie_password = f.optional_string_child("ChristiePassword");
546 _gdc_username = f.optional_string_child("GDCUsername");
547 _gdc_password = f.optional_string_child("GDCPassword");
549 auto pm = f.optional_string_child("PlayerMode");
550 if (pm && *pm == "window") {
551 _player_mode = PLAYER_MODE_WINDOW;
552 } else if (pm && *pm == "full") {
553 _player_mode = PLAYER_MODE_FULL;
554 } else if (pm && *pm == "dual") {
555 _player_mode = PLAYER_MODE_DUAL;
558 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
559 auto vc = f.optional_string_child("VideoViewType");
560 if (vc && *vc == "opengl") {
561 _video_view_type = VIDEO_VIEW_OPENGL;
562 } else if (vc && *vc == "simple") {
563 _video_view_type = VIDEO_VIEW_SIMPLE;
565 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
566 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
567 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
568 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
569 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
571 if (f.optional_node_child("AudioMapping")) {
572 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
575 for (auto i: f.node_children("CustomLanguage")) {
577 /* This will fail if it's called before dcp::init() as it won't recognise the
578 * tag. That's OK because the Config will be reloaded again later.
580 _custom_languages.push_back (dcp::LanguageTag(i->content()));
581 } catch (std::runtime_error& e) {}
584 _add_files_path = f.optional_string_child("AddFilesPath");
586 if (boost::filesystem::exists (_cinemas_file)) {
587 cxml::Document f ("Cinemas");
588 f.read_file (_cinemas_file);
592 if (boost::filesystem::exists (_dkdm_recipients_file)) {
593 cxml::Document f ("DKDMRecipients");
594 f.read_file (_dkdm_recipients_file);
595 read_dkdm_recipients (f);
599 if (have_existing("config.xml") || have_existing("cinemas.xml") || have_existing("dkdm_recipients.xml")) {
601 /* We have a config file but it didn't load */
605 /* Make a new set of signing certificates and key */
606 _signer_chain = create_certificate_chain ();
607 /* And similar for decryption of KDMs */
608 _decryption_chain = create_certificate_chain ();
612 /** @return Singleton instance */
616 if (_instance == 0) {
617 _instance = new Config;
624 /** Write our configuration to disk */
626 Config::write () const
630 write_dkdm_recipients ();
634 Config::write_config () const
637 auto root = doc.create_root_node ("Config");
639 /* [XML] Version The version number of the configuration file format. */
640 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
641 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
642 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
643 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
644 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
645 if (_default_directory) {
646 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
647 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
649 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
650 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
651 by the batch converter to listen for job requests.
653 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
654 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
655 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
657 for (auto i: _servers) {
658 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
661 root->add_child("Server")->add_child_text (i);
664 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
665 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
667 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
668 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
669 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
670 /* [XML] TMSIP IP address of TMS. */
671 root->add_child("TMSIP")->add_child_text (_tms_ip);
672 /* [XML] TMSPath Path on the TMS to copy files to. */
673 root->add_child("TMSPath")->add_child_text (_tms_path);
674 /* [XML] TMSUser Username to log into the TMS with. */
675 root->add_child("TMSUser")->add_child_text (_tms_user);
676 /* [XML] TMSPassword Password to log into the TMS with. */
677 root->add_child("TMSPassword")->add_child_text (_tms_password);
679 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
680 root->add_child("Language")->add_child_text (_language.get());
682 if (_default_container) {
683 /* [XML:opt] DefaultContainer ID of default container
684 to use when creating new films (<code>185</code>,<code>239</code> or
687 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
689 if (_default_dcp_content_type) {
690 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
691 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
692 <code>PSA</code> or <code>ADV</code>). */
693 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
695 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
696 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
697 /* [XML] DCPIssuer Issuer text to write into CPL files. */
698 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
699 /* [XML] DCPCreator Creator text to write into CPL files. */
700 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
701 /* [XML] Company name to write into MXF files. */
702 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
703 /* [XML] Product name to write into MXF files. */
704 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
705 /* [XML] Product version to write into MXF files. */
706 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
707 /* [XML] Comment to write into JPEG2000 data. */
708 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
709 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
710 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
712 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
713 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
714 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
715 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
716 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
717 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
718 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
719 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
720 for (auto const& i: _default_metadata) {
721 auto c = root->add_child("DefaultMetadata");
722 c->set_attribute("key", i.first);
723 c->add_child_text(i.second);
725 if (_default_kdm_directory) {
726 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
727 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
729 /* [XML] MailServer Hostname of SMTP server to use. */
730 root->add_child("MailServer")->add_child_text (_mail_server);
731 /* [XML] MailPort Port number to use on SMTP server. */
732 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
733 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
734 switch (_mail_protocol) {
735 case EmailProtocol::AUTO:
736 root->add_child("MailProtocol")->add_child_text("Auto");
738 case EmailProtocol::PLAIN:
739 root->add_child("MailProtocol")->add_child_text("Plain");
741 case EmailProtocol::STARTTLS:
742 root->add_child("MailProtocol")->add_child_text("STARTTLS");
744 case EmailProtocol::SSL:
745 root->add_child("MailProtocol")->add_child_text("SSL");
748 /* [XML] MailUser Username to use on SMTP server. */
749 root->add_child("MailUser")->add_child_text (_mail_user);
750 /* [XML] MailPassword Password to use on SMTP server. */
751 root->add_child("MailPassword")->add_child_text (_mail_password);
753 /* [XML] KDMSubject Subject to use for KDM emails. */
754 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
755 /* [XML] KDMFrom From address to use for KDM emails. */
756 root->add_child("KDMFrom")->add_child_text (_kdm_from);
757 for (auto i: _kdm_cc) {
758 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
759 root->add_child("KDMCC")->add_child_text (i);
761 /* [XML] KDMBCC BCC address to use for KDM emails. */
762 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
763 /* [XML] KDMEmail Text of KDM email. */
764 root->add_child("KDMEmail")->add_child_text (_kdm_email);
766 /* [XML] NotificationSubject Subject to use for notification emails. */
767 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
768 /* [XML] NotificationFrom From address to use for notification emails. */
769 root->add_child("NotificationFrom")->add_child_text (_notification_from);
770 /* [XML] NotificationFrom To address to use for notification emails. */
771 root->add_child("NotificationTo")->add_child_text (_notification_to);
772 for (auto i: _notification_cc) {
773 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
774 root->add_child("NotificationCC")->add_child_text (i);
776 /* [XML] NotificationBCC BCC address to use for notification emails. */
777 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
778 /* [XML] NotificationEmail Text of notification email. */
779 root->add_child("NotificationEmail")->add_child_text (_notification_email);
781 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
782 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
783 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
784 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
786 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
787 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
788 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
789 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
790 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
791 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
792 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
793 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
794 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
795 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
796 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
797 related to the player, 1024 debug information related to audio analyses.
799 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
800 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
801 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
802 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
803 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
804 #ifdef DCPOMATIC_WINDOWS
805 if (_win32_console) {
806 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
807 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
808 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
810 root->add_child("Win32Console")->add_child_text ("1");
814 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
815 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
817 auto signer = root->add_child ("Signer");
818 DCPOMATIC_ASSERT (_signer_chain);
819 for (auto const& i: _signer_chain->unordered()) {
820 signer->add_child("Certificate")->add_child_text (i.certificate (true));
822 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
824 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
825 auto decryption = root->add_child ("Decryption");
826 DCPOMATIC_ASSERT (_decryption_chain);
827 for (auto const& i: _decryption_chain->unordered()) {
828 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
830 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
832 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
835 for (auto i: _history) {
836 root->add_child("History")->add_child_text (i.string ());
839 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
842 for (auto i: _player_history) {
843 root->add_child("PlayerHistory")->add_child_text (i.string ());
846 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
847 or <code><DKDM></code> tags.
849 /* [XML] DKDM A DKDM as XML */
850 _dkdms->as_xml (root);
852 /* [XML] CinemasFile Filename of cinemas list file. */
853 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
854 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
855 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
856 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
857 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
858 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
859 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
860 /* [XML] KDMFilenameFormat Format for KDM filenames. */
861 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
862 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
863 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
864 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
865 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
866 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
867 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
868 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
869 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
870 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
871 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
872 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
873 for (int i = 0; i < NAG_COUNT; ++i) {
874 xmlpp::Element* e = root->add_child ("Nagged");
875 e->set_attribute ("Id", raw_convert<string>(i));
876 e->add_child_text (_nagged[i] ? "1" : "0");
878 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
879 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
881 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
882 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
884 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
885 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
886 if (_last_player_load_directory) {
887 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
889 /* [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. */
890 if (_last_kdm_write_type) {
891 switch (_last_kdm_write_type.get()) {
893 root->add_child("LastKDMWriteType")->add_child_text("flat");
895 case KDM_WRITE_FOLDER:
896 root->add_child("LastKDMWriteType")->add_child_text("folder");
899 root->add_child("LastKDMWriteType")->add_child_text("zip");
903 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
904 if (_last_dkdm_write_type) {
905 switch (_last_dkdm_write_type.get()) {
906 case DKDM_WRITE_INTERNAL:
907 root->add_child("LastDKDMWriteType")->add_child_text("internal");
909 case DKDM_WRITE_FILE:
910 root->add_child("LastDKDMWriteType")->add_child_text("file");
914 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
915 frames to be held in memory at once.
917 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
919 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
920 if (_decode_reduction) {
921 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
924 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
925 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
927 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
928 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
929 xmlpp::Element* e = root->add_child ("Notification");
930 e->set_attribute ("Id", raw_convert<string>(i));
931 e->add_child_text (_notification[i] ? "1" : "0");
934 if (_barco_username) {
935 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
936 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
938 if (_barco_password) {
939 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
940 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
943 if (_christie_username) {
944 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
945 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
947 if (_christie_password) {
948 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
949 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
953 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
954 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
957 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
958 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
961 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
962 with controls on another monitor.
964 switch (_player_mode) {
965 case PLAYER_MODE_WINDOW:
966 root->add_child("PlayerMode")->add_child_text("window");
968 case PLAYER_MODE_FULL:
969 root->add_child("PlayerMode")->add_child_text("full");
971 case PLAYER_MODE_DUAL:
972 root->add_child("PlayerMode")->add_child_text("dual");
976 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
977 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
978 switch (_video_view_type) {
979 case VIDEO_VIEW_SIMPLE:
980 root->add_child("VideoViewType")->add_child_text("simple");
982 case VIDEO_VIEW_OPENGL:
983 root->add_child("VideoViewType")->add_child_text("opengl");
986 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
987 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
988 if (_player_debug_log_file) {
989 /* [XML] PlayerLogFile Filename to use for player debug logs. */
990 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
992 if (_player_content_directory) {
993 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
994 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
996 if (_player_playlist_directory) {
997 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
998 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1000 if (_player_kdm_directory) {
1001 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1002 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1004 if (_audio_mapping) {
1005 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1007 for (auto const& i: _custom_languages) {
1008 root->add_child("CustomLanguage")->add_child_text(i.to_string());
1010 if (_add_files_path) {
1011 /* [XML] AddFilesPath The default path that will be offered in the picker when adding files to a film. */
1012 root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
1015 auto target = config_write_file();
1018 auto const s = doc.write_to_string_formatted ();
1019 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1020 auto f = fopen_boost (tmp, "w");
1022 throw FileError (_("Could not open file for writing"), tmp);
1024 checked_fwrite (s.c_str(), s.bytes(), f, tmp);
1026 boost::filesystem::remove (target);
1027 boost::filesystem::rename (tmp, target);
1028 } catch (xmlpp::exception& e) {
1029 string s = e.what ();
1031 throw FileError (s, target);
1038 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1040 xmlpp::Document doc;
1041 auto root = doc.create_root_node (root_node);
1042 root->add_child("Version")->add_child_text(version);
1044 for (auto i: things) {
1045 i->as_xml (root->add_child(node));
1049 doc.write_to_file_formatted (file.string() + ".tmp");
1050 boost::filesystem::remove (file);
1051 boost::filesystem::rename (file.string() + ".tmp", file);
1052 } catch (xmlpp::exception& e) {
1053 string s = e.what ();
1055 throw FileError (s, file);
1061 Config::write_cinemas () const
1063 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1068 Config::write_dkdm_recipients () const
1070 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1074 boost::filesystem::path
1075 Config::default_directory_or (boost::filesystem::path a) const
1077 return directory_or (_default_directory, a);
1080 boost::filesystem::path
1081 Config::default_kdm_directory_or (boost::filesystem::path a) const
1083 return directory_or (_default_kdm_directory, a);
1086 boost::filesystem::path
1087 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1093 boost::system::error_code ec;
1094 auto const e = boost::filesystem::exists (*dir, ec);
1110 Config::changed (Property what)
1116 Config::set_kdm_email_to_default ()
1118 _kdm_subject = _("KDM delivery: $CPL_NAME");
1121 "Dear Projectionist\n\n"
1122 "Please find attached KDMs for $CPL_NAME.\n\n"
1123 "Cinema: $CINEMA_NAME\n"
1124 "Screen(s): $SCREENS\n\n"
1125 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1126 "Best regards,\nDCP-o-matic"
1131 Config::set_notification_email_to_default ()
1133 _notification_subject = _("DCP-o-matic notification");
1135 _notification_email = _(
1136 "$JOB_NAME: $JOB_STATUS"
1141 Config::reset_kdm_email ()
1143 set_kdm_email_to_default ();
1148 Config::reset_notification_email ()
1150 set_notification_email_to_default ();
1155 Config::set_cover_sheet_to_default ()
1160 "Format: $CONTAINER\n"
1162 "Audio Language: $AUDIO_LANGUAGE\n"
1163 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1170 Config::add_to_history (boost::filesystem::path p)
1172 add_to_history_internal (_history, p);
1175 /** Remove non-existant items from the history */
1177 Config::clean_history ()
1179 clean_history_internal (_history);
1183 Config::add_to_player_history (boost::filesystem::path p)
1185 add_to_history_internal (_player_history, p);
1188 /** Remove non-existant items from the player history */
1190 Config::clean_player_history ()
1192 clean_history_internal (_player_history);
1196 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1198 /* Remove existing instances of this path in the history */
1199 h.erase (remove (h.begin(), h.end(), p), h.end ());
1201 h.insert (h.begin (), p);
1202 if (h.size() > HISTORY_SIZE) {
1210 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1216 if (boost::filesystem::is_directory(i)) {
1220 /* We couldn't find out if it's a directory for some reason; just ignore it */
1227 Config::have_existing (string file)
1229 return boost::filesystem::exists (read_path(file));
1234 Config::read_cinemas (cxml::Document const & f)
1237 for (auto i: f.node_children("Cinema")) {
1238 /* Slightly grotty two-part construction of Cinema here so that we can use
1241 auto cinema = make_shared<Cinema>(i);
1242 cinema->read_screens (i);
1243 _cinemas.push_back (cinema);
1248 Config::set_cinemas_file (boost::filesystem::path file)
1250 if (file == _cinemas_file) {
1254 _cinemas_file = file;
1256 if (boost::filesystem::exists (_cinemas_file)) {
1257 /* Existing file; read it in */
1258 cxml::Document f ("Cinemas");
1259 f.read_file (_cinemas_file);
1268 Config::read_dkdm_recipients (cxml::Document const & f)
1270 _dkdm_recipients.clear ();
1271 for (auto i: f.node_children("DKDMRecipient")) {
1272 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1278 Config::save_template (shared_ptr<const Film> film, string name) const
1280 film->write_template (template_write_path(name));
1285 Config::templates () const
1287 if (!boost::filesystem::exists(read_path("templates"))) {
1292 for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1293 n.push_back (i.path().filename().string());
1299 Config::existing_template (string name) const
1301 return boost::filesystem::exists (template_read_path(name));
1305 boost::filesystem::path
1306 Config::template_read_path (string name) const
1308 return read_path("templates") / tidy_for_filename (name);
1312 boost::filesystem::path
1313 Config::template_write_path (string name) const
1315 return write_path("templates") / tidy_for_filename (name);
1320 Config::rename_template (string old_name, string new_name) const
1322 boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name));
1326 Config::delete_template (string name) const
1328 boost::filesystem::remove (template_write_path(name));
1331 /** @return Path to the config.xml containing the actual settings, following a link if required */
1332 boost::filesystem::path
1333 config_file (boost::filesystem::path main)
1335 cxml::Document f ("Config");
1336 if (!boost::filesystem::exists (main)) {
1337 /* It doesn't exist, so there can't be any links; just return it */
1341 /* See if there's a link */
1344 auto link = f.optional_string_child("Link");
1348 } catch (xmlpp::exception& e) {
1349 /* There as a problem reading the main configuration file,
1350 so there can't be a link.
1358 boost::filesystem::path
1359 Config::config_read_file ()
1361 return config_file (read_path("config.xml"));
1365 boost::filesystem::path
1366 Config::config_write_file ()
1368 return config_file (write_path("config.xml"));
1373 Config::reset_cover_sheet ()
1375 set_cover_sheet_to_default ();
1380 Config::link (boost::filesystem::path new_file) const
1382 xmlpp::Document doc;
1383 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1385 doc.write_to_file_formatted(write_path("config.xml").string());
1386 } catch (xmlpp::exception& e) {
1387 string s = e.what ();
1389 throw FileError (s, write_path("config.xml"));
1394 Config::copy_and_link (boost::filesystem::path new_file) const
1397 boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1402 Config::have_write_permission () const
1404 auto f = fopen_boost (config_write_file(), "r+");
1413 /** @param output_channels Number of output channels in use.
1414 * @return Audio mapping for this output channel count (may be a default).
1417 Config::audio_mapping (int output_channels)
1419 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1420 /* Set up a default */
1421 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1422 if (output_channels == 2) {
1423 /* Special case for stereo output.
1424 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1425 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1427 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1428 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1429 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1430 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1431 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1432 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1433 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1434 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1437 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1438 _audio_mapping->set (i, i, 1);
1443 return *_audio_mapping;
1447 Config::set_audio_mapping (AudioMapping m)
1450 changed (AUDIO_MAPPING);
1454 Config::set_audio_mapping_to_default ()
1456 DCPOMATIC_ASSERT (_audio_mapping);
1457 auto const ch = _audio_mapping->output_channels ();
1458 _audio_mapping = boost::none;
1459 _audio_mapping = audio_mapping (ch);
1460 changed (AUDIO_MAPPING);
1465 Config::add_custom_language (dcp::LanguageTag tag)
1467 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1468 _custom_languages.push_back (tag);