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 _cinemas_file = read_path ("cinemas.xml");
129 _dkdm_recipients_file = read_path ("dkdm_recipients.xml");
130 _show_hints_before_make_dcp = true;
131 _confirm_kdm_email = true;
132 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
133 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
134 _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
135 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
136 _dcp_asset_filename_format = dcp::NameFormat ("%t");
137 _jump_to_selected = true;
138 for (int i = 0; i < NAG_COUNT; ++i) {
142 _sound_output = optional<string> ();
143 _last_kdm_write_type = KDM_WRITE_FLAT;
144 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
146 /* I think the scaling factor here should be the ratio of the longest frame
147 encode time to the shortest; if the thread count is T, longest time is L
148 and the shortest time S we could encode L/S frames per thread whilst waiting
149 for the L frame to encode so we might have to store LT/S frames.
151 However we don't want to use too much memory, so keep it a bit lower than we'd
152 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
153 use about 240Mb with 72 encoding threads.
155 _frames_in_memory_multiplier = 3;
156 _decode_reduction = optional<int>();
157 _default_notify = false;
158 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
159 _notification[i] = false;
161 _barco_username = optional<string>();
162 _barco_password = optional<string>();
163 _christie_username = optional<string>();
164 _christie_password = optional<string>();
165 _gdc_username = optional<string>();
166 _gdc_password = optional<string>();
167 _player_mode = PLAYER_MODE_WINDOW;
169 _video_view_type = VIDEO_VIEW_SIMPLE;
170 _respect_kdm_validity_periods = true;
171 _player_activity_log_file = boost::none;
172 _player_debug_log_file = boost::none;
173 _player_content_directory = boost::none;
174 _player_playlist_directory = boost::none;
175 _player_kdm_directory = boost::none;
176 _audio_mapping = boost::none;
177 _custom_languages.clear ();
178 _add_files_path = boost::none;
180 _allowed_dcp_frame_rates.clear ();
181 _allowed_dcp_frame_rates.push_back (24);
182 _allowed_dcp_frame_rates.push_back (25);
183 _allowed_dcp_frame_rates.push_back (30);
184 _allowed_dcp_frame_rates.push_back (48);
185 _allowed_dcp_frame_rates.push_back (50);
186 _allowed_dcp_frame_rates.push_back (60);
188 set_kdm_email_to_default ();
189 set_notification_email_to_default ();
190 set_cover_sheet_to_default ();
194 Config::restore_defaults ()
196 Config::instance()->set_defaults ();
197 Config::instance()->changed ();
200 shared_ptr<dcp::CertificateChain>
201 Config::create_certificate_chain ()
203 return make_shared<dcp::CertificateChain> (
207 ".dcpomatic.smpte-430-2.ROOT",
208 ".dcpomatic.smpte-430-2.INTERMEDIATE",
209 "CS.dcpomatic.smpte-430-2.LEAF"
216 /* Make a copy of the configuration */
219 while (n < 100 && boost::filesystem::exists(write_path(String::compose("config.xml.%1", n)))) {
223 boost::filesystem::copy_file(read_path("config.xml"), write_path(String::compose("config.xml.%1", n)));
224 boost::filesystem::copy_file(read_path("cinemas.xml"), write_path(String::compose("cinemas.xml.%1", n)));
225 boost::filesystem::copy_file(read_path("dkdm_recipients.xml"), write_path(String::compose("dkdm_recipients.xml.%1", n)));
233 cxml::Document f ("Config");
234 f.read_file (config_read_file());
236 auto version = f.optional_number_child<int> ("Version");
237 if (version && *version < _current_version) {
238 /* Back up the old config before we re-write it in a back-incompatible way */
242 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
243 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
245 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
246 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
249 _default_directory = f.optional_string_child ("DefaultDirectory");
250 if (_default_directory && _default_directory->empty ()) {
251 /* We used to store an empty value for this to mean "none set" */
252 _default_directory = boost::optional<boost::filesystem::path> ();
255 auto b = f.optional_number_child<int> ("ServerPort");
257 b = f.optional_number_child<int> ("ServerPortBase");
259 _server_port_base = b.get ();
261 auto u = f.optional_bool_child ("UseAnyServers");
262 _use_any_servers = u.get_value_or (true);
264 for (auto i: f.node_children("Server")) {
265 if (i->node_children("HostName").size() == 1) {
266 _servers.push_back (i->string_child ("HostName"));
268 _servers.push_back (i->content ());
272 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
273 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
274 _tms_ip = f.string_child ("TMSIP");
275 _tms_path = f.string_child ("TMSPath");
276 _tms_user = f.string_child ("TMSUser");
277 _tms_password = f.string_child ("TMSPassword");
279 _language = f.optional_string_child ("Language");
281 auto c = f.optional_string_child ("DefaultContainer");
283 _default_container = Ratio::from_id (c.get ());
286 if (_default_container && !_default_container->used_for_container()) {
287 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
288 _default_container = Ratio::from_id ("185");
291 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
292 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
294 if (f.optional_string_child ("DCPMetadataIssuer")) {
295 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
296 } else if (f.optional_string_child ("DCPIssuer")) {
297 _dcp_issuer = f.string_child ("DCPIssuer");
300 auto up = f.optional_bool_child("UploadAfterMakeDCP");
302 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
304 _upload_after_make_dcp = up.get_value_or (false);
305 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
306 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
307 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
308 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
309 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
311 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
312 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
313 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
314 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
316 for (auto const& i: f.node_children("DefaultMetadata")) {
317 _default_metadata[i->string_attribute("key")] = i->content();
320 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
322 /* Read any cinemas that are still lying around in the config file
323 * from an old version.
327 _mail_server = f.string_child ("MailServer");
328 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
331 /* Make sure this matches the code in write_config */
332 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
333 if (protocol == "Auto") {
334 _mail_protocol = EmailProtocol::AUTO;
335 } else if (protocol == "Plain") {
336 _mail_protocol = EmailProtocol::PLAIN;
337 } else if (protocol == "STARTTLS") {
338 _mail_protocol = EmailProtocol::STARTTLS;
339 } else if (protocol == "SSL") {
340 _mail_protocol = EmailProtocol::SSL;
344 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
345 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
347 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
348 _kdm_from = f.string_child ("KDMFrom");
349 for (auto i: f.node_children("KDMCC")) {
350 if (!i->content().empty()) {
351 _kdm_cc.push_back (i->content ());
354 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
355 _kdm_email = f.string_child ("KDMEmail");
357 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
358 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
359 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
360 for (auto i: f.node_children("NotificationCC")) {
361 if (!i->content().empty()) {
362 _notification_cc.push_back (i->content ());
365 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
366 if (f.optional_string_child("NotificationEmail")) {
367 _notification_email = f.string_child("NotificationEmail");
370 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
371 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
373 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
374 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
375 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
376 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
378 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
379 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
380 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
381 #ifdef DCPOMATIC_WINDOWS
382 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
385 for (auto i: f.node_children("History")) {
386 _history.push_back (i->content ());
389 for (auto i: f.node_children("PlayerHistory")) {
390 _player_history.push_back (i->content ());
393 auto signer = f.optional_node_child ("Signer");
395 auto c = make_shared<dcp::CertificateChain>();
396 /* Read the signing certificates and private key in from the config file */
397 for (auto i: signer->node_children ("Certificate")) {
398 c->add (dcp::Certificate (i->content ()));
400 c->set_key (signer->string_child ("PrivateKey"));
403 /* Make a new set of signing certificates and key */
404 _signer_chain = create_certificate_chain ();
407 auto decryption = f.optional_node_child ("Decryption");
409 auto c = make_shared<dcp::CertificateChain>();
410 for (auto i: decryption->node_children ("Certificate")) {
411 c->add (dcp::Certificate (i->content ()));
413 c->set_key (decryption->string_child ("PrivateKey"));
414 _decryption_chain = c;
416 _decryption_chain = create_certificate_chain ();
419 /* These must be done before we call Bad as that might set one
422 for (auto i: f.node_children("Nagged")) {
423 auto const id = i->number_attribute<int>("Id");
424 if (id >= 0 && id < NAG_COUNT) {
425 _nagged[id] = raw_convert<int>(i->content());
429 optional<BadReason> bad;
431 for (auto const& i: _signer_chain->unordered()) {
432 if (i.has_utf8_strings()) {
433 bad = BAD_SIGNER_UTF8_STRINGS;
437 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
438 bad = BAD_SIGNER_INCONSISTENT;
441 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
442 bad = BAD_DECRYPTION_INCONSISTENT;
446 auto const remake = Bad(*bad);
447 if (remake && *remake) {
449 case BAD_SIGNER_UTF8_STRINGS:
450 case BAD_SIGNER_INCONSISTENT:
451 _signer_chain = create_certificate_chain ();
453 case BAD_DECRYPTION_INCONSISTENT:
454 _decryption_chain = create_certificate_chain ();
460 if (f.optional_node_child("DKDMGroup")) {
461 /* New-style: all DKDMs in a group */
462 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
464 /* Old-style: one or more DKDM nodes */
465 _dkdms.reset (new DKDMGroup ("root"));
466 for (auto i: f.node_children("DKDM")) {
467 _dkdms->add (DKDMBase::read (i));
470 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string());
471 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string());
472 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
473 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
474 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
475 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
476 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
477 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
478 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
479 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
480 /* The variable was renamed but not the XML tag */
481 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
482 _sound_output = f.optional_string_child("PreviewSoundOutput");
483 if (f.optional_string_child("CoverSheet")) {
484 _cover_sheet = f.optional_string_child("CoverSheet").get();
486 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
487 if (f.optional_string_child("LastKDMWriteType")) {
488 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
489 _last_kdm_write_type = KDM_WRITE_FLAT;
490 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
491 _last_kdm_write_type = KDM_WRITE_FOLDER;
492 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
493 _last_kdm_write_type = KDM_WRITE_ZIP;
496 if (f.optional_string_child("LastDKDMWriteType")) {
497 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
498 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
499 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
500 _last_dkdm_write_type = DKDM_WRITE_FILE;
503 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
504 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
505 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
507 for (auto i: f.node_children("Notification")) {
508 int const id = i->number_attribute<int>("Id");
509 if (id >= 0 && id < NOTIFICATION_COUNT) {
510 _notification[id] = raw_convert<int>(i->content());
514 _barco_username = f.optional_string_child("BarcoUsername");
515 _barco_password = f.optional_string_child("BarcoPassword");
516 _christie_username = f.optional_string_child("ChristieUsername");
517 _christie_password = f.optional_string_child("ChristiePassword");
518 _gdc_username = f.optional_string_child("GDCUsername");
519 _gdc_password = f.optional_string_child("GDCPassword");
521 auto pm = f.optional_string_child("PlayerMode");
522 if (pm && *pm == "window") {
523 _player_mode = PLAYER_MODE_WINDOW;
524 } else if (pm && *pm == "full") {
525 _player_mode = PLAYER_MODE_FULL;
526 } else if (pm && *pm == "dual") {
527 _player_mode = PLAYER_MODE_DUAL;
530 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
531 auto vc = f.optional_string_child("VideoViewType");
532 if (vc && *vc == "opengl") {
533 _video_view_type = VIDEO_VIEW_OPENGL;
534 } else if (vc && *vc == "simple") {
535 _video_view_type = VIDEO_VIEW_SIMPLE;
537 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
538 /* PlayerLogFile is old name */
539 _player_activity_log_file = f.optional_string_child("PlayerLogFile");
540 if (!_player_activity_log_file) {
541 _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
543 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
544 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
545 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
546 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
548 if (f.optional_node_child("AudioMapping")) {
549 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
552 for (auto i: f.node_children("CustomLanguage")) {
554 /* This will fail if it's called before dcp::init() as it won't recognise the
555 * tag. That's OK because the Config will be reloaded again later.
557 _custom_languages.push_back (dcp::LanguageTag(i->content()));
558 } catch (std::runtime_error& e) {}
561 _add_files_path = f.optional_string_child("AddFilesPath");
563 if (boost::filesystem::exists (_cinemas_file)) {
564 cxml::Document f ("Cinemas");
565 f.read_file (_cinemas_file);
569 if (boost::filesystem::exists (_dkdm_recipients_file)) {
570 cxml::Document f ("DKDMRecipients");
571 f.read_file (_dkdm_recipients_file);
572 read_dkdm_recipients (f);
576 if (have_existing ("config.xml")) {
578 /* We have a config file but it didn't load */
582 /* Make a new set of signing certificates and key */
583 _signer_chain = create_certificate_chain ();
584 /* And similar for decryption of KDMs */
585 _decryption_chain = create_certificate_chain ();
589 /** @return Singleton instance */
593 if (_instance == 0) {
594 _instance = new Config;
601 /** Write our configuration to disk */
603 Config::write () const
607 write_dkdm_recipients ();
611 Config::write_config () const
614 auto root = doc.create_root_node ("Config");
616 /* [XML] Version The version number of the configuration file format. */
617 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
618 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
619 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
620 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
621 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
622 if (_default_directory) {
623 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
624 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
626 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
627 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
628 by the batch converter to listen for job requests.
630 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
631 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
632 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
634 for (auto i: _servers) {
635 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
638 root->add_child("Server")->add_child_text (i);
641 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
642 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
644 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
645 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
646 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
647 /* [XML] TMSIP IP address of TMS. */
648 root->add_child("TMSIP")->add_child_text (_tms_ip);
649 /* [XML] TMSPath Path on the TMS to copy files to. */
650 root->add_child("TMSPath")->add_child_text (_tms_path);
651 /* [XML] TMSUser Username to log into the TMS with. */
652 root->add_child("TMSUser")->add_child_text (_tms_user);
653 /* [XML] TMSPassword Password to log into the TMS with. */
654 root->add_child("TMSPassword")->add_child_text (_tms_password);
656 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
657 root->add_child("Language")->add_child_text (_language.get());
659 if (_default_container) {
660 /* [XML:opt] DefaultContainer ID of default container
661 to use when creating new films (<code>185</code>,<code>239</code> or
664 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
666 if (_default_dcp_content_type) {
667 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
668 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
669 <code>PSA</code> or <code>ADV</code>). */
670 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
672 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
673 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
674 /* [XML] DCPIssuer Issuer text to write into CPL files. */
675 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
676 /* [XML] DCPCreator Creator text to write into CPL files. */
677 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
678 /* [XML] Company name to write into MXF files. */
679 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
680 /* [XML] Product name to write into MXF files. */
681 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
682 /* [XML] Product version to write into MXF files. */
683 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
684 /* [XML] Comment to write into JPEG2000 data. */
685 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
686 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
687 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
689 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
690 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
691 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
692 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
693 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
694 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
695 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
696 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
697 for (auto const& i: _default_metadata) {
698 auto c = root->add_child("DefaultMetadata");
699 c->set_attribute("key", i.first);
700 c->add_child_text(i.second);
702 if (_default_kdm_directory) {
703 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
704 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
706 /* [XML] MailServer Hostname of SMTP server to use. */
707 root->add_child("MailServer")->add_child_text (_mail_server);
708 /* [XML] MailPort Port number to use on SMTP server. */
709 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
710 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
711 switch (_mail_protocol) {
712 case EmailProtocol::AUTO:
713 root->add_child("MailProtocol")->add_child_text("Auto");
715 case EmailProtocol::PLAIN:
716 root->add_child("MailProtocol")->add_child_text("Plain");
718 case EmailProtocol::STARTTLS:
719 root->add_child("MailProtocol")->add_child_text("STARTTLS");
721 case EmailProtocol::SSL:
722 root->add_child("MailProtocol")->add_child_text("SSL");
725 /* [XML] MailUser Username to use on SMTP server. */
726 root->add_child("MailUser")->add_child_text (_mail_user);
727 /* [XML] MailPassword Password to use on SMTP server. */
728 root->add_child("MailPassword")->add_child_text (_mail_password);
730 /* [XML] KDMSubject Subject to use for KDM emails. */
731 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
732 /* [XML] KDMFrom From address to use for KDM emails. */
733 root->add_child("KDMFrom")->add_child_text (_kdm_from);
734 for (auto i: _kdm_cc) {
735 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
736 root->add_child("KDMCC")->add_child_text (i);
738 /* [XML] KDMBCC BCC address to use for KDM emails. */
739 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
740 /* [XML] KDMEmail Text of KDM email. */
741 root->add_child("KDMEmail")->add_child_text (_kdm_email);
743 /* [XML] NotificationSubject Subject to use for notification emails. */
744 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
745 /* [XML] NotificationFrom From address to use for notification emails. */
746 root->add_child("NotificationFrom")->add_child_text (_notification_from);
747 /* [XML] NotificationFrom To address to use for notification emails. */
748 root->add_child("NotificationTo")->add_child_text (_notification_to);
749 for (auto i: _notification_cc) {
750 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
751 root->add_child("NotificationCC")->add_child_text (i);
753 /* [XML] NotificationBCC BCC address to use for notification emails. */
754 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
755 /* [XML] NotificationEmail Text of notification email. */
756 root->add_child("NotificationEmail")->add_child_text (_notification_email);
758 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
759 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
760 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
761 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
763 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
764 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
765 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
766 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
767 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
768 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
769 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
770 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
771 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
772 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
773 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
774 related to the player, 1024 debug information related to audio analyses.
776 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
777 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
778 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
779 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
780 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
781 #ifdef DCPOMATIC_WINDOWS
782 if (_win32_console) {
783 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
784 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
785 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
787 root->add_child("Win32Console")->add_child_text ("1");
791 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
792 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
794 auto signer = root->add_child ("Signer");
795 DCPOMATIC_ASSERT (_signer_chain);
796 for (auto const& i: _signer_chain->unordered()) {
797 signer->add_child("Certificate")->add_child_text (i.certificate (true));
799 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
801 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
802 auto decryption = root->add_child ("Decryption");
803 DCPOMATIC_ASSERT (_decryption_chain);
804 for (auto const& i: _decryption_chain->unordered()) {
805 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
807 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
809 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
812 for (auto i: _history) {
813 root->add_child("History")->add_child_text (i.string ());
816 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
819 for (auto i: _player_history) {
820 root->add_child("PlayerHistory")->add_child_text (i.string ());
823 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
824 or <code><DKDM></code> tags.
826 /* [XML] DKDM A DKDM as XML */
827 _dkdms->as_xml (root);
829 /* [XML] CinemasFile Filename of cinemas list file. */
830 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
831 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
832 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
833 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
834 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
835 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
836 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
837 /* [XML] KDMFilenameFormat Format for KDM filenames. */
838 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
839 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
840 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
841 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
842 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
843 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
844 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
845 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
846 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
847 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
848 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
849 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
850 for (int i = 0; i < NAG_COUNT; ++i) {
851 xmlpp::Element* e = root->add_child ("Nagged");
852 e->set_attribute ("Id", raw_convert<string>(i));
853 e->add_child_text (_nagged[i] ? "1" : "0");
855 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
856 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
858 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
859 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
861 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
862 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
863 if (_last_player_load_directory) {
864 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
866 /* [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. */
867 if (_last_kdm_write_type) {
868 switch (_last_kdm_write_type.get()) {
870 root->add_child("LastKDMWriteType")->add_child_text("flat");
872 case KDM_WRITE_FOLDER:
873 root->add_child("LastKDMWriteType")->add_child_text("folder");
876 root->add_child("LastKDMWriteType")->add_child_text("zip");
880 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
881 if (_last_dkdm_write_type) {
882 switch (_last_dkdm_write_type.get()) {
883 case DKDM_WRITE_INTERNAL:
884 root->add_child("LastDKDMWriteType")->add_child_text("internal");
886 case DKDM_WRITE_FILE:
887 root->add_child("LastDKDMWriteType")->add_child_text("file");
891 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
892 frames to be held in memory at once.
894 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
896 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
897 if (_decode_reduction) {
898 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
901 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
902 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
904 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
905 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
906 xmlpp::Element* e = root->add_child ("Notification");
907 e->set_attribute ("Id", raw_convert<string>(i));
908 e->add_child_text (_notification[i] ? "1" : "0");
911 if (_barco_username) {
912 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
913 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
915 if (_barco_password) {
916 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
917 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
920 if (_christie_username) {
921 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
922 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
924 if (_christie_password) {
925 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
926 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
930 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
931 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
934 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
935 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
938 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
939 with controls on another monitor.
941 switch (_player_mode) {
942 case PLAYER_MODE_WINDOW:
943 root->add_child("PlayerMode")->add_child_text("window");
945 case PLAYER_MODE_FULL:
946 root->add_child("PlayerMode")->add_child_text("full");
948 case PLAYER_MODE_DUAL:
949 root->add_child("PlayerMode")->add_child_text("dual");
953 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
954 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
955 switch (_video_view_type) {
956 case VIDEO_VIEW_SIMPLE:
957 root->add_child("VideoViewType")->add_child_text("simple");
959 case VIDEO_VIEW_OPENGL:
960 root->add_child("VideoViewType")->add_child_text("opengl");
963 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
964 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
965 if (_player_activity_log_file) {
966 /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
967 root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
969 if (_player_debug_log_file) {
970 /* [XML] PlayerLogFile Filename to use for player debug logs */
971 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
973 if (_player_content_directory) {
974 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
975 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
977 if (_player_playlist_directory) {
978 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
979 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
981 if (_player_kdm_directory) {
982 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
983 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
985 if (_audio_mapping) {
986 _audio_mapping->as_xml (root->add_child("AudioMapping"));
988 for (auto const& i: _custom_languages) {
989 root->add_child("CustomLanguage")->add_child_text(i.to_string());
991 if (_add_files_path) {
992 /* [XML] The default path that will be offered in the picker when adding files to a film */
993 root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
996 auto target = config_write_file();
999 auto const s = doc.write_to_string_formatted ();
1000 boost::filesystem::path tmp (string(target.string()).append(".tmp"));
1001 auto f = fopen_boost (tmp, "w");
1003 throw FileError (_("Could not open file for writing"), tmp);
1005 checked_fwrite (s.c_str(), s.bytes(), f, tmp);
1007 boost::filesystem::remove (target);
1008 boost::filesystem::rename (tmp, target);
1009 } catch (xmlpp::exception& e) {
1010 string s = e.what ();
1012 throw FileError (s, target);
1019 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1021 xmlpp::Document doc;
1022 auto root = doc.create_root_node (root_node);
1023 root->add_child("Version")->add_child_text(version);
1025 for (auto i: things) {
1026 i->as_xml (root->add_child(node));
1030 doc.write_to_file_formatted (file.string() + ".tmp");
1031 boost::filesystem::remove (file);
1032 boost::filesystem::rename (file.string() + ".tmp", file);
1033 } catch (xmlpp::exception& e) {
1034 string s = e.what ();
1036 throw FileError (s, file);
1042 Config::write_cinemas () const
1044 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1049 Config::write_dkdm_recipients () const
1051 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1055 boost::filesystem::path
1056 Config::default_directory_or (boost::filesystem::path a) const
1058 return directory_or (_default_directory, a);
1061 boost::filesystem::path
1062 Config::default_kdm_directory_or (boost::filesystem::path a) const
1064 return directory_or (_default_kdm_directory, a);
1067 boost::filesystem::path
1068 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1074 boost::system::error_code ec;
1075 auto const e = boost::filesystem::exists (*dir, ec);
1091 Config::changed (Property what)
1097 Config::set_kdm_email_to_default ()
1099 _kdm_subject = _("KDM delivery: $CPL_NAME");
1102 "Dear Projectionist\n\n"
1103 "Please find attached KDMs for $CPL_NAME.\n\n"
1104 "Cinema: $CINEMA_NAME\n"
1105 "Screen(s): $SCREENS\n\n"
1106 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1107 "Best regards,\nDCP-o-matic"
1112 Config::set_notification_email_to_default ()
1114 _notification_subject = _("DCP-o-matic notification");
1116 _notification_email = _(
1117 "$JOB_NAME: $JOB_STATUS"
1122 Config::reset_kdm_email ()
1124 set_kdm_email_to_default ();
1129 Config::reset_notification_email ()
1131 set_notification_email_to_default ();
1136 Config::set_cover_sheet_to_default ()
1141 "Format: $CONTAINER\n"
1143 "Audio Language: $AUDIO_LANGUAGE\n"
1144 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1151 Config::add_to_history (boost::filesystem::path p)
1153 add_to_history_internal (_history, p);
1156 /** Remove non-existant items from the history */
1158 Config::clean_history ()
1160 clean_history_internal (_history);
1164 Config::add_to_player_history (boost::filesystem::path p)
1166 add_to_history_internal (_player_history, p);
1169 /** Remove non-existant items from the player history */
1171 Config::clean_player_history ()
1173 clean_history_internal (_player_history);
1177 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1179 /* Remove existing instances of this path in the history */
1180 h.erase (remove (h.begin(), h.end(), p), h.end ());
1182 h.insert (h.begin (), p);
1183 if (h.size() > HISTORY_SIZE) {
1191 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1197 if (boost::filesystem::is_directory(i)) {
1201 /* We couldn't find out if it's a directory for some reason; just ignore it */
1208 Config::have_existing (string file)
1210 return boost::filesystem::exists (read_path(file));
1215 Config::read_cinemas (cxml::Document const & f)
1218 for (auto i: f.node_children("Cinema")) {
1219 /* Slightly grotty two-part construction of Cinema here so that we can use
1222 auto cinema = make_shared<Cinema>(i);
1223 cinema->read_screens (i);
1224 _cinemas.push_back (cinema);
1229 Config::set_cinemas_file (boost::filesystem::path file)
1231 if (file == _cinemas_file) {
1235 _cinemas_file = file;
1237 if (boost::filesystem::exists (_cinemas_file)) {
1238 /* Existing file; read it in */
1239 cxml::Document f ("Cinemas");
1240 f.read_file (_cinemas_file);
1249 Config::read_dkdm_recipients (cxml::Document const & f)
1251 _dkdm_recipients.clear ();
1252 for (auto i: f.node_children("DKDMRecipient")) {
1253 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1259 Config::save_template (shared_ptr<const Film> film, string name) const
1261 film->write_template (template_write_path(name));
1266 Config::templates () const
1268 if (!boost::filesystem::exists(read_path("templates"))) {
1273 for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
1274 n.push_back (i.path().filename().string());
1280 Config::existing_template (string name) const
1282 return boost::filesystem::exists (template_read_path(name));
1286 boost::filesystem::path
1287 Config::template_read_path (string name) const
1289 return read_path("templates") / tidy_for_filename (name);
1293 boost::filesystem::path
1294 Config::template_write_path (string name) const
1296 return write_path("templates") / tidy_for_filename (name);
1301 Config::rename_template (string old_name, string new_name) const
1303 boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name));
1307 Config::delete_template (string name) const
1309 boost::filesystem::remove (template_write_path(name));
1312 /** @return Path to the config.xml containing the actual settings, following a link if required */
1313 boost::filesystem::path
1314 config_file (boost::filesystem::path main)
1316 cxml::Document f ("Config");
1317 if (!boost::filesystem::exists (main)) {
1318 /* It doesn't exist, so there can't be any links; just return it */
1322 /* See if there's a link */
1325 auto link = f.optional_string_child("Link");
1329 } catch (xmlpp::exception& e) {
1330 /* There as a problem reading the main configuration file,
1331 so there can't be a link.
1339 boost::filesystem::path
1340 Config::config_read_file ()
1342 return config_file (read_path("config.xml"));
1346 boost::filesystem::path
1347 Config::config_write_file ()
1349 return config_file (write_path("config.xml"));
1354 Config::reset_cover_sheet ()
1356 set_cover_sheet_to_default ();
1361 Config::link (boost::filesystem::path new_file) const
1363 xmlpp::Document doc;
1364 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1366 doc.write_to_file_formatted(write_path("config.xml").string());
1367 } catch (xmlpp::exception& e) {
1368 string s = e.what ();
1370 throw FileError (s, write_path("config.xml"));
1375 Config::copy_and_link (boost::filesystem::path new_file) const
1378 boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1383 Config::have_write_permission () const
1385 auto f = fopen_boost (config_write_file(), "r+");
1394 /** @param output_channels Number of output channels in use.
1395 * @return Audio mapping for this output channel count (may be a default).
1398 Config::audio_mapping (int output_channels)
1400 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1401 /* Set up a default */
1402 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1403 if (output_channels == 2) {
1404 /* Special case for stereo output.
1405 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1406 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1408 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1409 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1410 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1411 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1412 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1413 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1414 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1415 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1418 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1419 _audio_mapping->set (i, i, 1);
1424 return *_audio_mapping;
1428 Config::set_audio_mapping (AudioMapping m)
1431 changed (AUDIO_MAPPING);
1435 Config::set_audio_mapping_to_default ()
1437 DCPOMATIC_ASSERT (_audio_mapping);
1438 auto const ch = _audio_mapping->output_channels ();
1439 _audio_mapping = boost::none;
1440 _audio_mapping = audio_mapping (ch);
1441 changed (AUDIO_MAPPING);
1446 Config::add_custom_language (dcp::LanguageTag tag)
1448 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1449 _custom_languages.push_back (tag);